Need to add description of healthcheck statuses in `--help` control command #962

New issue

Open

opened 2024-02-06 07:31:00 +00:00 by anikeev-yadro · 1 comment

anikeev-yadro commented

2024-02-06 07:31:00 +00:00

Member

The meaning of healthcheck status is not clear

root@frostfs-v15-failover-node2:~# sudo frostfs-cli --endpoint 127.0.0.1:8091 -w /etc/frostfs/storage/wallet.json control healthcheck --config /tmp/storage.yaml
Network status: OFFLINE
Health status: READY

Describe the solution you'd like

Need to add description of healthcheck statuses in --help control command

root@frostfs-v15-failover-node2:~# sudo frostfs-cli --endpoint 127.0.0.1:8091 -w /etc/frostfs/storage/wallet.json control healthcheck --config /tmp/storage.yaml --help
Health check for FrostFS storage nodes.

Usage:
  frostfs-cli control healthcheck [flags]

Flags:
      --address string     Address of wallet account
      --endpoint string    Remote node control address (as 'multiaddr' or '<host>:<port>')
  -h, --help               help for healthcheck
  -t, --timeout duration   Timeout for an operation (default 15s)
  -w, --wallet string      Path to the wallet or binary key

Global Flags:
  -c, --config string       Config file (default is $HOME/.config/frostfs-cli/config.yaml)
      --config-dir string   Config directory
  -v, --verbose             Verbose output

## Is your feature request related to a problem? Please describe. The meaning of healthcheck status is not clear ``` root@frostfs-v15-failover-node2:~# sudo frostfs-cli --endpoint 127.0.0.1:8091 -w /etc/frostfs/storage/wallet.json control healthcheck --config /tmp/storage.yaml Network status: OFFLINE Health status: READY ``` ## Describe the solution you'd like Need to add description of healthcheck statuses in `--help` control command ``` root@frostfs-v15-failover-node2:~# sudo frostfs-cli --endpoint 127.0.0.1:8091 -w /etc/frostfs/storage/wallet.json control healthcheck --config /tmp/storage.yaml --help Health check for FrostFS storage nodes. Usage: frostfs-cli control healthcheck [flags] Flags: --address string Address of wallet account --endpoint string Remote node control address (as 'multiaddr' or '<host>:<port>') -h, --help help for healthcheck -t, --timeout duration Timeout for an operation (default 15s) -w, --wallet string Path to the wallet or binary key Global Flags: -c, --config string Config file (default is $HOME/.config/frostfs-cli/config.yaml) --config-dir string Config directory -v, --verbose Verbose output ```