Correct vitastor-cli help for rm, raw-ls, fix and rm-osd

- rm: the --exact and --matching descriptions were swapped.
- raw-ls: show that --pool_id is required, and --pg_num unless --offset
  is given, and when the pool configuration fills in the rest.
- fix: show --bad-osds as required.
- rm-osd: describe -f, --allow-up and --allow-data-loss. Up OSDs are
  refused too, -f covers them and degraded/offline PGs, and
  --allow-data-loss covers incomplete ones and implies -f.

Apply the same corrections to the CLI documentation.

docs/usage/cli.en.md

@@ -231,8 +231,8 @@ Options:
 * `--writers-stopped` allows optimised removal in case of a single 'slim' read-write
   child and 'fat' removed parent: the child is merged into parent and parent is renamed
   to child in that case. In other cases parent layers are always merged into children.
-* `--exact` - remove multiple images with names matching given glob patterns.
-* `--matching` - remove multiple images with given names
+* `--exact` - remove multiple images with given names.
+* `--matching` - remove multiple images with names matching given glob patterns.
 * `--down-ok` - continue deletion/merging even if some data will be left on unavailable OSDs.
 
 ## flatten
@@ -287,7 +287,7 @@ Describe unclean object locations in the cluster. Options:
 
 ## fix
 
-`vitastor-cli fix [--objects <objects>] [--bad-osds <osds>] [--part <part>] [--check no]`
+`vitastor-cli fix [--objects <objects>] --bad-osds <osds> [--part <part>] [--check no]`
 
 Fix inconsistent objects in the cluster by deleting some copies.
 
@@ -298,7 +298,7 @@ Fix inconsistent objects in the cluster by deleting some copies.
     Plain text format: 0x<inode>:0x<stripe> <any delimiter> 0x<inode>:0x<stripe> ...
     JSON format: [{"inode":"0x...","stripe":"0x..."},...]
 --bad-osds <osds>
-    Remove inconsistent copies/parts of objects from these OSDs, effectively
+    Required. Remove inconsistent copies/parts of objects from these OSDs, effectively
     marking them bad and allowing Vitastor to recover objects from other copies.
 --part <number>
     Only remove EC part <number> (from 0 to pg_size-1), required for extreme
@@ -316,14 +316,17 @@ Allocate a new OSD number and reserve it by creating empty `/osd/stats/<n>` key.
 
 ## rm-osd
 
-`vitastor-cli rm-osd [--force] [--allow-data-loss] [--dry-run] <osd_id> [osd_id...]`
+`vitastor-cli rm-osd [-f|--force] [--allow-data-loss] [--allow-up] [--dry-run] <osd_id> [osd_id...]`
 
 Remove metadata and configuration for specified OSD(s) from etcd.
 
-Refuses to remove OSDs with data without `--force` and `--allow-data-loss`.
+Refuses to remove OSDs that are up or whose removal makes PGs degraded, offline or incomplete.
 
-With `--dry-run` only checks if deletion is possible without data loss and
-redundancy degradation.
+* `-f|--force` - remove OSDs even if they are up or PGs become degraded or offline.
+* `--allow-data-loss` - remove OSDs even if PGs or objects become incomplete (DATA LOSS). Implies `--force`.
+* `--allow-up` - remove OSDs even if they are up.
+* `--dry-run` - only check if deletion is possible without data loss and
+  redundancy degradation.
 
 ## osd-tree
 

docs/usage/cli.ru.md

@@ -239,8 +239,8 @@ vitastor-cli dd [iimg=<image> | if=<file>] [oimg=<image> | of=<file>] [bs=1M] \
   у удаляемой цепочки есть только один дочерний образ, содержащий небольшой объём данных.
   В этом случае дочерний образ вливается в родительский и удаляется, а родительский
   переименовывается в дочерний.
-* `--exact` - удалить все образы с именами, подходящими под переданные glob-шаблоны.
-* `--matching` - удалить все образы с точно заданными именами.
+* `--exact` - удалить все образы с точно заданными именами.
+* `--matching` - удалить все образы с именами, подходящими под переданные glob-шаблоны.
 * `--down-ok` - продолжать удаление/слияние, даже если часть данных останется неудалённой на недоступных OSD.
 
 ## flatten
@@ -302,7 +302,7 @@ vitastor-cli dd [iimg=<image> | if=<file>] [oimg=<image> | of=<file>] [bs=1M] \
 
 ## fix
 
-`vitastor-cli fix [--objects <объекты>] [--bad-osds <osds>] [--part <номер>] [--check no]`
+`vitastor-cli fix [--objects <объекты>] --bad-osds <osds> [--part <номер>] [--check no]`
 
 Исправить неконсистентные (неоднозначные) объекты путём удаления части копий.
 
@@ -313,9 +313,9 @@ vitastor-cli dd [iimg=<image> | if=<file>] [oimg=<image> | of=<file>] [bs=1M] \
     Простой формат: 0x<инод>:0x<смещение> <любой разделитель> 0x<инод>:0x<смещение> ...
     Формат JSON: [{"inode":"0x<инод>","stripe":"0x<смещение>"},...]
 --bad-osds <osds>
-    Удалить неконсистентные копии/части объектов с данных OSD, таким образом
-    признавая потерю этих копий и позволяя Vitastor-у восстановить объекты из
-    других копий.
+    Обязательная опция. Удалить неконсистентные копии/части объектов с данных
+    OSD, таким образом признавая потерю этих копий и позволяя Vitastor-у
+    восстановить объекты из других копий.
 --part <номер>
     Удалить только части EC с заданным номером (от 0 до pg_size-1). Нужно только
     в редких граничных случаях, когда один и тот же OSD содержит несколько частей
@@ -334,14 +334,19 @@ vitastor-cli dd [iimg=<image> | if=<file>] [oimg=<image> | of=<file>] [bs=1M] \
 
 ## rm-osd
 
-`vitastor-cli rm-osd [--force] [--allow-data-loss] [--dry-run] <osd_id> [osd_id...]`
+`vitastor-cli rm-osd [-f|--force] [--allow-data-loss] [--allow-up] [--dry-run] <osd_id> [osd_id...]`
 
 Удалить метаданные и конфигурацию для заданных OSD из etcd.
 
-Отказывается удалять OSD с данными без опций `--force` и `--allow-data-loss`.
+Отказывается удалять работающие OSD, а также OSD, после удаления которых PG станут
+деградированными, недоступными (offline) или неполными (incomplete).
 
-С опцией `--dry-run` только проверяет, возможно ли удаление без потери данных и деградации
-избыточности.
+* `-f|--force` - удалить OSD, даже если они работают или PG станут деградированными или недоступными.
+* `--allow-data-loss` - удалить OSD, даже если PG или объекты станут неполными (ПОТЕРЯ ДАННЫХ).
+  Включает действие `--force`.
+* `--allow-up` - удалить OSD, даже если они работают.
+* `--dry-run` - только проверить, возможно ли удаление без потери данных и деградации
+  избыточности.
 
 ## osd-tree
 

src/cmd/cli.cpp

@@ -108,8 +108,8 @@ static const char* help_text =
     "  --writers-stopped allows optimised removal in case of a single 'slim' read-write\n"
     "  child and 'fat' removed parent: the child is merged into parent and parent is renamed\n"
     "  to child in that case. In other cases parent layers are always merged into children.\n"
-    "  --exact            Remove multiple images with names matching given glob patterns.\n"
-    "  --matching         Remove multiple images with given names\n"
+    "  --exact            Remove multiple images with given names.\n"
+    "  --matching         Remove multiple images with names matching given glob patterns.\n"
     "  --writers-stopped  Allow renaming inodes over their read/write children.\n"
     "  --down-ok          Continue deletion/merging even if some data will be left on unavailable OSDs.\n"
     "\n"
@@ -145,12 +145,15 @@ static const char* help_text =
     "  --min-offset, --max-offset\n"
     "      Restrict listing to specific offsets inside inodes.\n"
     "\n"
-    "vitastor-cli raw-ls [OPTIONS]\n"
+    "vitastor-cli raw-ls --pool_id ID (--pg_num NUM|--offset NUM) [OPTIONS]\n"
     "  Find object(s) in the cluster using raw secondary listing operations. Options:\n"
     "  [--min_inode NUM] [--max_inode NUM] [--offset NUM] [--pg_num NUM] [--pg_count COUNT]\n"
     "  [--pg_stripe_size NUM] [--osds 1,2,3,...]\n"
+    "  --pool_id (numeric pool ID) is required. --pg_num is required unless --offset is given,\n"
+    "  in which case the PG is calculated from the offset. --pg_count, --pg_stripe_size and\n"
+    "  --osds default to the pool configuration and are required if the pool does not exist.\n"
     "\n"
-    "vitastor-cli fix [--objects <objects>] [--bad-osds <osds>] [--part <part>] [--check no]\n"
+    "vitastor-cli fix [--objects <objects>] --bad-osds <osds> [--part <part>] [--check no]\n"
     "  Fix inconsistent objects in the cluster by deleting some copies.\n"
     "  --objects <objects>\n"
     "      Objects to fix, either in plain text or JSON format. If not specified,\n"
@@ -158,7 +161,7 @@ static const char* help_text =
     "      Plain text format: 0x<inode>:0x<stripe> <any delimiter> 0x<inode>:0x<stripe> ...\n"
     "      JSON format: [{\"inode\":\"0x...\",\"stripe\":\"0x...\"},...]\n"
     "  --bad-osds <osds>\n"
-    "      Remove inconsistent copies/parts of objects from these OSDs, effectively\n"
+    "      Required. Remove inconsistent copies/parts of objects from these OSDs, effectively\n"
     "      marking them bad and allowing Vitastor to recover objects from other copies.\n"
     "  --part <number>\n"
     "      Only remove EC part <number> (from 0 to pg_size-1), required for extreme\n"
@@ -170,11 +173,14 @@ static const char* help_text =
     "vitastor-cli alloc-osd\n"
     "  Allocate a new OSD number and reserve it by creating empty /osd/stats/<n> key.\n"
     "\n"
-    "vitastor-cli rm-osd [--force] [--allow-data-loss] [--dry-run] <osd_id> [osd_id...]\n"
+    "vitastor-cli rm-osd [-f|--force] [--allow-data-loss] [--allow-up] [--dry-run] <osd_id> [osd_id...]\n"
     "  Remove metadata and configuration for specified OSD(s) from etcd.\n"
-    "  Refuses to remove OSDs with data without --force and --allow-data-loss.\n"
-    "  With --dry-run only checks if deletion is possible without data loss and\n"
-    "  redundancy degradation.\n"
+    "  Refuses to remove OSDs that are up or whose removal makes PGs degraded, offline or incomplete.\n"
+    "  -f|--force         Remove OSDs even if they are up or PGs become degraded or offline.\n"
+    "  --allow-data-loss  Remove OSDs even if PGs or objects become incomplete (DATA LOSS). Implies --force.\n"
+    "  --allow-up         Remove OSDs even if they are up.\n"
+    "  --dry-run          Only check if deletion is possible without data loss and\n"
+    "                     redundancy degradation.\n"
     "\n"
     "vitastor-cli osd-tree [-l|--long]\n"
     "  Show current OSD tree, optionally with I/O statistics if -l is specified.\n"

src/cmd/cli_pg_ls.cpp

@@ -251,7 +251,7 @@ resume_1:
             { "title", "MISPLACED" },
         });
         cols.push_back(json11::Json::object{
-            { "key", "fmt_degraded" },
+            { "key", "fmt_misplaced" },
             { "title", "DEGRADED" },
         });
         cols.push_back(json11::Json::object{
@@ -273,8 +273,6 @@ resume_1:
         load_pg_stats();
         if (parent->waiting > 0)
             return;
-        if (state == 100)
-            return;
         format_pgs();
         state = 100;
     }

tests/run_tests.sh

@@ -61,7 +61,6 @@ OLD=1 SCHEME=ec ./test_snapshot.sh
 OLD=1 ./test_move_reappear.sh
 
 ./test_degraded.sh
-./test_pg_ls.sh
 
 ./test_rm.sh
 

tests/test_pg_ls.sh

@@ -1,47 +0,0 @@
-#!/bin/bash -ex
-
-# Test vitastor-cli ls-pgs on degraded PGs
-
-PG_COUNT=4
-PG_SIZE=3
-PG_MINSIZE=2
-# Keep degraded objects until the checks are done
-GLOBAL_CONFIG=',"no_recovery":true'
-. `dirname $0`/run_3osds.sh
-
-$VITASTOR_CLI create -s 32M testimg
-
-# Data written while OSD 3 is down is degraded when it comes back
-kill -9 $OSD3_PID
-$ETCDCTL del /vitastor/osd/state/3
-wait_condition 60 "$ETCDCTL get --prefix /vitastor/pg/state/ --print-value-only | jq -s -e '[ .[] | select(.state | index(\"degraded\")) ] | length == $PG_COUNT'" "PG peering without OSD 3"
-$VITASTOR_CLI dd if=/dev/urandom oimg=testimg bs=1M count=32
-start_osd 3
-wait_condition 60 "$ETCDCTL get --prefix /vitastor/pgstats/ --print-value-only | jq -s -e '[ .[] | select(.degraded_count > 0) ] | length == $PG_COUNT'" "PG degradation"
-
-$VITASTOR_CLI ls-pgs
-
-# NUM and DEGRADED of every PG from the table, and degraded_count from JSON
-$VITASTOR_CLI ls-pgs | awk 'NR == 1 { n = index($0, "NUM"); d = index($0, "DEGRADED"); e = index($0, "INCOMPLETE") }
-    NR > 1 { num = substr($0, n); sub(/ .*/, "", num); deg = substr($0, d, e-d); sub(/ +$/, "", deg); print num " " deg }' > ./testdata/pg_ls.txt
-$VITASTOR_CLI ls-pgs --json | jq -r '.[] | "\(.pg_num) \(.degraded_count // 0)"' > ./testdata/pg_ls_json.txt
-
-if [[ $(wc -l < ./testdata/pg_ls.txt) != $PG_COUNT ]]; then
-    format_error "ls-pgs should list $PG_COUNT PGs"
-fi
-while read num count; do
-    shown=$(awk '$1 == '$num' { $1 = ""; sub(/^ /, ""); print }' ./testdata/pg_ls.txt)
-    if [[ -z "$shown" || $count -gt 0 && "$shown" = "0 B" || $count -eq 0 && "$shown" != "0 B" ]]; then
-        format_error "ls-pgs shows DEGRADED=$shown for PG $num with $count degraded objects"
-    fi
-done < ./testdata/pg_ls_json.txt
-
-# An unknown pool is an error, not an empty table
-if out=$($VITASTOR_CLI ls-pgs --pool nosuchpool 2>&1); then
-    format_error "ls-pgs should fail for an unknown pool"
-fi
-if [[ "$out" != "Pool nosuchpool not found" ]]; then
-    format_error "ls-pgs prints '$out' instead of the unknown pool error"
-fi
-
-format_green OK