health runcommand

Run a combination of commands as one command. For example, the cluster, nodes, operands, and operators commands can be started together.

Syntax and command options

The following example shows the syntax that you must use when you run the runcommand command:

guardcenter-cli health runcommand \
[--all=true|false] \
[--preinstall]
[--commands=<cluster,network-connectivity,network-performance,nodes,operands,operators,storage-performance,storageclass-validation,security-context,certs,registry,kube-version,airgap>] \
[--control_plane_ns=<instance-controlplane-list>] \
[--include-ns=<instance-namespace-list>] \
[--log-level=debug|trace] \
[--operator_ns=<operator-namespace-list>] \
[--param <path of param.yml file>] \
[--registry-user=<username>] \
[--registry-password=<entitlement-key>] \
[--domain=<domain>] \
[--namespace=<namespace>] \
[--secret=<secret>] \
[--cloud_env={aws|azure|ibm-classic|ibm-vpc}] \
[--host=<local-registry-host>] \
[--username=<local-registry-username>] \ 
[--password=<local-registry-password>] \ 
[--version=<guardium-version>] \
[--save] \
[--verbose]
Configure the following command options when you run the runcommand command:
Table 1. runcommand command options
Option Description
--all Runs all guardcenter-cli health commands.
Tip: The results from the storage-performance command are not included in the results of the --save option. This command produces a separate TAR file when you use the --all option with runcommand.
Status
Optional
If you don't want to run all health commands, use the --commands option to specify a list of commands to run.
Syntax
--all=true|false
Default value
false
Valid values
true
false
Important: Do not use both the --all and --commands options at the same time.
--preinstall Runs the guardcenter-cli preinstall validation commands, which include certs, security-context,storageclass-validation, registry, kube-version, and storage-performance.
Status
Required

The certs, storage-performance, and registry command options are required.

Syntax
--preinstall -d <domain> -n <namespace> --registry-password=<entitlement-key> --param=<path-to-params.yml-file>
Default value
Not applicable
Valid values
The domain and namespace command options from the certs command, the –-registry-password command option in the registry command, and the --param command option in the storage-performance command.
--commands A comma-separated list of commands to run.
Status
Optional
If you want to run all health commands, use the --all option.
Syntax
--commands=<cluster, network-connectivity, network-performance, nodes, operands, operators, storage-performance>
Default value
No default.
Valid values
A comma-separated list of commands to run.
Important: Do not use both the --all and --commands options at the same time.
--control_plane_ns The Guardium Data Security Center control plane namespace.
Status
Required
Syntax
--control_plane_ns=
Default value
${PROJECT_GSP_INST_OPERANDS}
Valid values
The Guardium Data Security Center control plane namespace.

--help

-h

 Display command help.
Status
Optional
Syntax
--help
Default value
Not applicable
Valid values
Not applicable
--image-prefix Specify the image registry prefix.
Status
Required only when the image is pulled from a private Container Registry. Otherwise, this prefix is optional.
Syntax
--image-prefix=
Default value
icr.io/cpopen/cpd
Valid values
icr.io/cpopen/cpd
${PRIVATE_REGISTRY_LOCATION}
--image-tag Specify an image tag for the image that you specified in the --image-prefix option.
Status
Optional
Syntax
--image-tag=
Default value
The default tag of the image that you specified in the --image-prefix option.
Valid values
The --image-prefix is the image registry. The --image-tag is the specific image tag for an image in a registry. Provide this option if you are using a local mirrored image where the full location of an image is []"/:".
Example
--image-prefix=${PRIVATE_REGISTRY_SERVER}/cpopen/cpd --image-tag=${VERSION}-x86_64
--include-ns Enter a comma-separated list of instance namespaces to gather guardcenter-cli health information from.
Status
Optional
Syntax
--include-ns=
Default value
Not applicable
Valid values
Any comma-separated list of instance namespaces.
--log-level The command log level.
Status
Optional
Syntax
--log-level=debug|trace
Default value
Not applicable
Valid values
debug - debug messages are written to the log.
trace - trace messages are written to the log.
--operator_ns Enter a comma-separated list of operator namespaces.
Status
Required
Syntax
--operator_ns=
Default value
Not applicable
Valid values
Any comma-separated list of operator namespaces.
--param The path of the param.yml file that includes more parameters for storage validation and storage performance.
Status
Required
Syntax
--param
Default value
No default.
Valid values
Not applicable.

--minbandwidth

-b

 The minimum amount of bandwidth that is accepted between nodes. The value is in MB per second.
Status
Optional
Syntax
--minbandwidth=<MB per second>
Default value
350
Valid values
A value greater than or equal to 350 MB per second. If you enter a smaller amount, the command defaults to 350.
--registry-user The username that you use to access cp.icr.io.
Status
Optional when using the all or registry commands.
Syntax
--registry-user=
Default value
cp
Valid values
Not applicable

--registry-password

 The entitlement key that you use to access cp.icr.io.
Status
Required when using the all or registry commands.
Syntax
--registry-password=
Default value
Not applicable
Valid values
Not applicable

--domain

-d

 The name of the domain that the TLS certificate is issued for.
Status
Required when using the all or certs commands.
Syntax
--domain
Default value
Not applicable
Valid values
Not applicable

--namespace

-n

 The Kubernetes namespace where Guardium Data Security Center is installed.
Status
Required when using the all or certs commands.
Syntax
--namespace
Default value
Not applicable
Valid values
Not applicable

--secret

-s

 The name of the Kubernetes secret that contains the certificates that are to be validated.
Status
Optional when using the all or certs commands.
Syntax
--secret
Default value
insights-ingressca
Valid values
Not applicable
--cloud_env The cloud environment for your cluster. Use this option for more specific information based on your cloud environment.
Status
Optional when using the storageclass-validation command.
Syntax
--cloud_env=
Default value
Not applicable
Valid values
aws, azure, ibm-classic, ibm-vpc

--host

 The host of the private registry. This value can be the host IP address or the FQDN and listening port, which is formatted as <FQDN:Listening_port>.
Status
Required when using the airgap command.
Syntax
--host=
Default value
Not applicable
Valid values
Not applicable
--username The username that you use to log in to the private registry.
Status
Required when using the airgap command.
Syntax
--username=
Default value
Not applicable
Valid values
Not applicable
--password The password that you use to log in to the private registry.
Status
Required when using the airgap command.
Syntax
--password=
Default value
Not applicable
Valid values
Not applicable
--version

-v

 The version of Guardium Data Security Center that you want to use.
Status
Optional when using the airgap or kube-version command.
Syntax
--version=
Default value
The latest version of Guardium Data Security Center.
Valid values
Any Guardium Data Security Center version.
--save Save the output and resource YAML files to the local file system.
Status
Optional
Syntax
--save
Default value
false
Valid values
true
false
--verbose Display detailed information about resources in table format.
Status
Optional
Syntax
--verbose
Default value
false
Valid values
true
false

Example

The following example runs the cluster, nodes, operators, and operands commands as one command:
guardcenter-cli health runcommand \
--commands=cluster,nodes,operators,operands \
--control_plane_ns=<instance-controlplane-list> \
--operator_ns=<operator-namespace-list> \
--verbose \
--save