Command options
The health checks can be performed by using the following command:
kubectl cloudscale health-check
You can run the health checker command using multiple options. The following table describes each available option and its function.
Table: Health checker command options
Command options | Function | Notes |
|---|---|---|
--list-all Short form: -l | Lists all available health checks and the categories they belong to. | Discover which checks exist before running. |
--test Short form: -t | Runs health checks by name. Accepts a single name, a comma-separated list (for example, test1, test2), or all to execute every check. | Run specific checks or all checks by name. Use -t -h or -t help for detailed help. |
--test-category Short form: -c | Runs all checks in a category:
| Run a full set of checks for a given phase. Use -c -h or -c help for detailed help. |
--namespace Short form: -n | Specifies the Kubernetes namespace where health checks run. |
|
--help Short form: -h | Shows help for the health-check command or, when used with a flag value (for example, -t -h), help for that specific flag. | Get usage instructions and examples. |
Note:
The -t and -c command options cannot be used together.
The following table lists the examples for the various functions of the command options.
Table: Example for health checker command options
Functions | Short form of the command | Long form of the command |
|---|---|---|
Help (main) | kubectl-cloudscale health-check -h | kubectl-cloudscale health-check --help |
List all checks and categories | kubectl-cloudscale health-check -l | kubectl-cloudscale health-check --list-all |
Test flag help | kubectl-cloudscale health-check -t -h | kubectl-cloudscale health-check --test help |
Category flag help | kubectl-cloudscale health-check -c -h | kubectl-cloudscale health-check --test-category help |
Namespace flag help | kubectl-cloudscale health-check -n -h | kubectl-cloudscale health-check --namespace help |
Single test by name | kubectl-cloudscale health-check -t SecretsValidation -n netbackup | kubectl-cloudscale health-check --test SecretsValidation --namespace netbackup |
Multiple tests (comma-separated) | kubectl-cloudscale health-check -t SecretsValidation,ServiceImageTagCheck -n netbackup | kubectl-cloudscale health-check --test SecretsValidation,ServiceImageTagCheck --namespace netbackup |
All tests | kubectl-cloudscale health-check -t all -n netbackup | kubectl-cloudscale health-check --test all --namespace netbackup |
By category (pre-deployment) | kubectl-cloudscale health-check -c pre-deployment | kubectl-cloudscale health-check --test-category pre-deployment |
By category (post-deployment) | kubectl-cloudscale health-check -c post-deployment -n netbackup | kubectl-cloudscale health-check --test-category post-deployment --namespace netbackup |
By category (pre-upgrade) | kubectl-cloudscale health-check -c pre-upgrade -n netbackup | kubectl-cloudscale health-check --test-category pre-upgrade --namespace netbackup |
Note:
Some health checks require user input (yes/no or text) and must be run in an interactive terminal.