This is a cache of https://docs.openshift.com/acs/4.5/cli/command-reference/roxctl-sensor.html. It is a snapshot of the page at 2024-11-27T18:12:49.225+0000.
roxctl sensor - roxctl CLI command reference | roxctl CLI | Red Hat Advanced Cluster Security for Kubernetes 4.5
×

Deploy Red Hat Advanced Cluster Security for Kubernetes (RHACS) services in secured clusters.

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

generate

Generate files to deploy RHACS services in secured clusters.

generate-certs

Download a YAML file with renewed certificates for Sensor, Collector, and Admission controller.

get-bundle

Download a bundle with the files to deploy RHACS services in a cluster.

Table 2. Options
Option Description

--retry-timeout duration

Set the timeout after which API requests are retried. A value of zero means 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.

roxctl sensor command options inherited from the parent command

The roxctl sensor 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 sensor command.

roxctl sensor generate

Generate files to deploy RHACS services in secured clusters.

Usage
$ roxctl sensor generate [flags]
Table 3. Options
Option Description

--admission-controller-disable-bypass

Disable the bypass annotations for the admission controller. The default value is false.

--admission-controller-enforce-on-creates

Dynamic enable for enforcing on object creation in the admission controller. The default value is false.

--admission-controller-enforce-on-updates

Enable dynamic enforcement of object updates in the admission controller. The default value is false.

--admission-controller-listen-on-creates

Configure the admission controller webhook to listen to deployment creation. The default value is false.

--admission-controller-listen-on-updates

Configure the admission controller webhook to listen to deployment updates. The default value is false.

--admission-controller-scan-inline

Get scans inline when using the admission controller. The default value is false.

--admission-controller-timeout int32

Set the timeout in seconds for the admission controller. The default value is 3.

--central string

Set the endpoint to which you want to connect Sensor. The default value is central.stackrox:443.

--collection-method collection method

Specify the collection method that you want to use for runtime support. Collection methods include none, default, ebpf and core_bpf. The default value is default.

--collector-image-repository string

Set the image repository that you want to use to deploy Collector. If not specified, a default value corresponding to the effective --main-image repository value is derived.

--continue-if-exists

Continue with downloading the sensor bundle even if the cluster already exists. The default value is false.

--create-upgrader-sa

Decide whether to create the upgrader service account with cluster-admin privileges to facilitate automated sensor upgrades. The default value is true.

--disable-tolerations

Disable tolerations for tainted nodes. The default value is false.

--enable-pod-security-policies

Create PodSecurityPolicy resources. The default value is true.

--istio-support string

Generate deployment files that support the specified Istio version. Valid versions include 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7.

--main-image-repository string

Specify the image repository that you want to use to deploy Sensor. If not specified, a default value is used.

--name string

Set the cluster name to identify the cluster.

--output-dir string

Set the output directory for the bundle contents. The default value is an automatically generated directory name inside the current directory.

--slim-collector string[="true"]

Use Collector-slim in the deployment bundle. Valid values include auto, true, and false. The default value is auto.

-t, --timeout duration

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

roxctl sensor generate k8s

Generate the required files to deploy RHACS services in a Kubernetes cluster.

Usage
$ roxctl sensor generate k8s [flags]
Table 4. Options
Option Description

--admission-controller-listen-on-events

Enable admission controller webhook to listen to Kubernetes events. The default value is true.

roxctl sensor generate openshift

Generate the required files to deploy RHACS services in a Red Hat OpenShift cluster.

Usage
$ roxctl sensor generate openshift [flags]
Table 5. Options
Option Description

`--admission-controller-listen-on-events false

true

auto[=true]`

Enable or disable the admission controller webhook to listen to Kubernetes events. The default value is auto.

`--disable-audit-logs false

true

auto[=true]`

Enable or disable audit log collection for runtime detection. The default value is auto.

--openshift-version int

Specify the Red Hat OpenShift major version for which you want to generate the deployment files.

roxctl sensor get-bundle

Download a bundle with the files to deploy RHACS services into a cluster.

Usage
$ roxctl sensor get-bundle <cluster_details> [flags] (1)
1 For <cluster_details>, specify the cluster name or ID.
Table 6. Options
Option Description

--create-upgrader-sa

Specify whether to create the upgrader service account with cluster-admin privileges for automated Sensor upgrades. The default value is true.

--istio-support string

Generate deployment files that support the specified Istio version. Valid versions include 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, and 1.7.

--output-dir string

Specify the output directory for the bundle contents. The default value is an automatically generated directory name inside the current directory.

--slim-collector string[="true"]

Use Collector-slim in the deployment bundle. Valid values include auto, true and false. The default value is auto.

-t, --timeout duration

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

roxctl sensor generate-certs

Download a YAML file with renewed certificates for Sensor, Collector, and Admission controller.

Usage
$ roxctl sensor generate-certs <cluster_details> [flags] (1)
1 For <cluster_details>, specify the cluster name or ID.
Table 7. Options
Option Description

--output-dir string

Specify the output directory for the YAML file. The default value is ..