1. Documentation
    2. history bug_report picture_as_pdf
×

roxctl helm

Commands related to Red Hat Advanced Cluster Security for Kubernetes (RHACS) Helm Charts.

Usage
$ roxctl helm [command] [flags]
Table 1. Available commands
Command Description

derive-local-values

Derive local Helm values from the cluster configuration.

output

Output a Helm chart.

roxctl helm command options inherited from the parent command

The roxctl helm command supports the following options inherited from the parent roxctl command:

Option Description

--ca string

Specify a custom CA certificate file path for secure connections. Alternatively, you can specify the file path by using the ROX_CA_CERT_FILE environment variable.

--direct-grpc

Set --direct-grpc for improved connection performance. Alternatively, by setting the ROX_DIRECT_GRPC_CLIENT environment variable to true, you can enable direct gRPC . The default value is false.

-e, --endpoint string

Set the endpoint for the service to contact. Alternatively, you can set the endpoint by using the ROX_ENDPOINT environment variable. The default value is localhost:8443.

--force-http1

Force the use of HTTP/1 for all connections. Alternatively, by setting the ROX_CLIENT_FORCE_HTTP1 environment variable to true, you can force the use of HTTP/1. The default value is false.

--insecure

Enable insecure connection options. Alternatively, by setting the ROX_INSECURE_CLIENT environment variable to true, you can enable insecure connection options. The default value is false.

--insecure-skip-tls-verify

Skip the TLS certificate validation. Alternatively, by setting the ROX_INSECURE_CLIENT_SKIP_TLS_VERIFY environment variable to true, you can skip the TLS certificate validation. The default value is false.

--no-color

Disable the color output. Alternatively, by setting the ROX_NO_COLOR environment variable to true, you can disable the color output. The default value is false.

-p, --password string

Specify the password for basic authentication. Alternatively, you can set the password by using the ROX_ADMIN_PASSWORD environment variable.

--plaintext

Use an unencrypted connection. Alternatively, by setting the ROX_PLAINTEXT environment variable to true, you can enable an unencrypted connection. The default value is false.

-s, --server-name string

Set the TLS server name to use for SNI. Alternatively, you can set the server name by using the ROX_SERVER_NAME environment variable.

--token-file string

Use the API token provided in the specified file for authentication. Alternatively, you can set the token by using the ROX_API_TOKEN environment variable.

These options are applicable to all the sub-commands of the roxctl helm command.

roxctl helm output

Output a Helm chart.

Usage
$ roxctl helm output <central_services or secured_cluster_services> [flags] (1)
1 For <central_services or secured_cluster_services>, specify the path to either the central services or the secured cluster services to generate a Helm chart output.
Table 2. Options
Option Description

--debug

Read templates from the local filesystem. The default value is false.

--debug-path string

Specify the path to the Helm templates on your local filesystem. For more details, run the roxctl helm output --help command.

--image-defaults string

Set the default container image settings. Image settings include development_build, stackrox.io, rhacs, and opensource. It influences repositories for image downloads, image names, and tag formats. The default value is development_build.

--output-dir string

Define the path to the output directory for the Helm chart. The default path is ./stackrox-<chart name>-chart.

--remove

Remove the output directory if it already exists. The default value is false.

roxctl helm derive-local-values

Derive local Helm values from the cluster configuration.

Usage
$ roxctl helm derive-local-values --output <path> \(1)
<central_services> [flags] (2)
1 For the <path>, specify the path where you want to save the generated local values file.
2 For the <central_services>, specify the path to the central services configuration file.
Table 3. Options
Option Description

--input string

Specify the path to the file or directory containing the YAML input.

--output string

Define the path to the output file.

--output-dir string

Define the path to the output directory.

--retry-timeout duration

Set the timeout after which API requests are retried. The timeout value indicates that the entire request duration is waited for without retrying. The default value is 20s.

-t, --timeout duration

Set the timeout for API requests representing the maximum duration of a request. The default value is 1m0s.