diff --git a/cli/command-reference/roxctl-sensor.adoc b/cli/command-reference/roxctl-sensor.adoc index 1424f5681f64..bc948bc30f5f 100644 --- a/cli/command-reference/roxctl-sensor.adoc +++ b/cli/command-reference/roxctl-sensor.adoc @@ -6,41 +6,17 @@ include::modules/common-attributes.adoc[] toc::[] -Deploy {rh-rhacs-first} services in secured clusters. +[role="_abstract"] +Use the `roxctl sensor` command to deploy {rh-rhacs-first} services in secured clusters. This reference covers the command syntax, available subcommands, and configuration options. -.Usage -[source,terminal] ----- -$ roxctl sensor [command] [flags] ----- +//roxctl sensor overview +include::modules/roxctl-sensor-overview.adoc[leveloffset=+1] -.Available commands -[cols="2,2",options="header"] -|=== -|Command |Description +include::modules/roxctl-sensor-usage.adoc[leveloffset=+2] -|`generate` -|Generate files to deploy {product-title-short} services in secured clusters. +include::modules/roxctl-sensor-available-commands.adoc[leveloffset=+2] -|`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 {product-title-short} services in a cluster. -|=== - - -.Options -[cols="2,2",options="header"] -|=== -|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`. -|=== +include::modules/roxctl-sensor-options.adoc[leveloffset=+2] //Options inherited from the parent command :commandname: roxctl sensor @@ -50,12 +26,32 @@ include::modules/options-inherited-from-the-parent-command.adoc[leveloffset=+1] //roxctl sensor generate include::modules/roxctl-sensor-generate.adoc[leveloffset=+1] +include::modules/roxctl-sensor-generate-usage.adoc[leveloffset=+2] + +include::modules/roxctl-sensor-generate-options.adoc[leveloffset=+2] + include::modules/roxctl-sensor-generate-k8s.adoc[leveloffset=+2] +include::modules/roxctl-sensor-generate-k8s-usage.adoc[leveloffset=+3] + +include::modules/roxctl-sensor-generate-k8s-options.adoc[leveloffset=+3] + include::modules/roxctl-sensor-generate-openshift.adoc[leveloffset=+2] +include::modules/roxctl-sensor-generate-openshift-usage.adoc[leveloffset=+3] + +include::modules/roxctl-sensor-generate-openshift-options.adoc[leveloffset=+3] + //roxctl sensor get-bundle include::modules/roxctl-sensor-get-bundle.adoc[leveloffset=+1] +include::modules/roxctl-sensor-get-bundle-usage.adoc[leveloffset=+2] + +include::modules/roxctl-sensor-get-bundle-options.adoc[leveloffset=+2] + //roxctl sensor generate-certs -include::modules/roxctl-sensor-generate-certs.adoc[leveloffset=+1] \ No newline at end of file +include::modules/roxctl-sensor-generate-certs.adoc[leveloffset=+1] + +include::modules/roxctl-sensor-generate-certs-usage.adoc[leveloffset=+2] + +include::modules/roxctl-sensor-generate-certs-options.adoc[leveloffset=+2] \ No newline at end of file diff --git a/modules/roxctl-sensor-available-commands.adoc b/modules/roxctl-sensor-available-commands.adoc new file mode 100644 index 000000000000..f81c86c400d9 --- /dev/null +++ b/modules/roxctl-sensor-available-commands.adoc @@ -0,0 +1,24 @@ +// Module included in the following assemblies: +// +// * cli/command-reference/roxctl-sensor.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-sensor-available-commands_{context}"] += Available commands + +[role="_abstract"] +Available commands for the `roxctl sensor` command. + +[cols="2,2",options="header"] +|=== +|Command |Description + +|`generate` +|Generate files to deploy {product-title-short} 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 {product-title-short} services in a cluster. +|=== diff --git a/modules/roxctl-sensor-generate-certs-options.adoc b/modules/roxctl-sensor-generate-certs-options.adoc new file mode 100644 index 000000000000..c44c3bf585ce --- /dev/null +++ b/modules/roxctl-sensor-generate-certs-options.adoc @@ -0,0 +1,19 @@ +// Module included in the following assemblies: +// +// * cli/command-reference/roxctl-sensor.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-sensor-generate-certs-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl sensor generate-certs` command. + +.Options +[cols="2,2",options="header"] +|=== +|Option |Description + +|`--output-dir string` +|Specify the output directory for the YAML file. The default value is `.` (the current working directory). +|=== diff --git a/modules/roxctl-sensor-generate-certs-usage.adoc b/modules/roxctl-sensor-generate-certs-usage.adoc new file mode 100644 index 000000000000..f3bbd5dfeccc --- /dev/null +++ b/modules/roxctl-sensor-generate-certs-usage.adoc @@ -0,0 +1,22 @@ +// Module included in the following assemblies: +// +// * cli/command-reference/roxctl-sensor.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-sensor-generate-certs-usage_{context}"] += roxctl sensor generate-certs usage + +[role="_abstract"] +Usage syntax for the `roxctl sensor generate-certs` command. + +.Usage +[source,terminal] +---- +$ roxctl sensor generate-certs [flags] +---- + +where: + +-- +``:: Specifies the cluster name or ID. +-- diff --git a/modules/roxctl-sensor-generate-certs.adoc b/modules/roxctl-sensor-generate-certs.adoc index 6106e3bc63c7..9c4e3e005785 100644 --- a/modules/roxctl-sensor-generate-certs.adoc +++ b/modules/roxctl-sensor-generate-certs.adoc @@ -1,30 +1,10 @@ // Module included in the following assemblies: // -// * command-reference/roxctl-sensor.adoc +// * cli/command-reference/roxctl-sensor.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-sensor-generate-certs_{context}"] = roxctl sensor generate-certs -Download a YAML file with renewed certificates for Sensor, Collector, and Admission controller. - -.Usage -[source,terminal] ----- -$ roxctl sensor generate-certs [flags] ----- - -where: - --- -``:: Specifies the cluster name or ID. --- - -.Options -[cols="2,2",options="header"] -|=== -|Option |Description - -|`--output-dir string` -|Specify the output directory for the YAML file. The default value is `.`. -|=== \ No newline at end of file +[role="_abstract"] +Download a YAML file with renewed certificates for Sensor, Collector, and Admission controller. \ No newline at end of file diff --git a/modules/roxctl-sensor-generate-k8s-options.adoc b/modules/roxctl-sensor-generate-k8s-options.adoc new file mode 100644 index 000000000000..7bde2ff2a7a9 --- /dev/null +++ b/modules/roxctl-sensor-generate-k8s-options.adoc @@ -0,0 +1,19 @@ +// Module included in the following assemblies: +// +// * cli/command-reference/roxctl-sensor.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-sensor-generate-k8s-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl sensor generate k8s` command. + +.Options +[cols="6,3",options="header"] +|=== +|Option |Description + +|`--admission-controller-listen-on-events` +|Enable admission controller webhook to listen to Kubernetes events. The default value is `true`. +|=== diff --git a/modules/roxctl-sensor-generate-k8s-usage.adoc b/modules/roxctl-sensor-generate-k8s-usage.adoc new file mode 100644 index 000000000000..8cc872c35cf9 --- /dev/null +++ b/modules/roxctl-sensor-generate-k8s-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * cli/command-reference/roxctl-sensor.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-sensor-generate-k8s-usage_{context}"] += roxctl sensor generate k8s usage + +[role="_abstract"] +Usage syntax for the `roxctl sensor generate k8s` command. + +.Usage +[source,terminal] +---- +$ roxctl sensor generate k8s [flags] +---- diff --git a/modules/roxctl-sensor-generate-k8s.adoc b/modules/roxctl-sensor-generate-k8s.adoc index dd043e6871bb..3610c438b1e7 100644 --- a/modules/roxctl-sensor-generate-k8s.adoc +++ b/modules/roxctl-sensor-generate-k8s.adoc @@ -1,24 +1,10 @@ // Module included in the following assemblies: // -// * command-reference/roxctl-sensor.adoc +// * cli/command-reference/roxctl-sensor.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-sensor-generate-k8s_{context}"] = roxctl sensor generate k8s -Generate the required files to deploy {product-title-short} services in a Kubernetes cluster. - -.Usage -[source,terminal] ----- -$ roxctl sensor generate k8s [flags] ----- - -.Options -[cols="6,3",options="header"] -|=== -|Option |Description - -|`--admission-controller-listen-on-events` -|Enable admission controller webhook to listen to Kubernetes events. The default value is `true`. -|=== \ No newline at end of file +[role="_abstract"] +Generate the required files to deploy {product-title-short} services in a Kubernetes cluster. \ No newline at end of file diff --git a/modules/roxctl-sensor-generate-openshift-options.adoc b/modules/roxctl-sensor-generate-openshift-options.adoc new file mode 100644 index 000000000000..2c6e0748f3ea --- /dev/null +++ b/modules/roxctl-sensor-generate-openshift-options.adoc @@ -0,0 +1,25 @@ +// Module included in the following assemblies: +// +// * cli/command-reference/roxctl-sensor.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-sensor-generate-openshift-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl sensor generate openshift` command. + +.Options +[cols="6,3",options="header"] +|=== +|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 {osp} major version for which you want to generate the deployment files. +|=== diff --git a/modules/roxctl-sensor-generate-openshift-usage.adoc b/modules/roxctl-sensor-generate-openshift-usage.adoc new file mode 100644 index 000000000000..f4b978c7a4a1 --- /dev/null +++ b/modules/roxctl-sensor-generate-openshift-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * cli/command-reference/roxctl-sensor.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-sensor-generate-openshift-usage_{context}"] += roxctl sensor generate openshift usage + +[role="_abstract"] +Usage syntax for the `roxctl sensor generate openshift` command. + +.Usage +[source,terminal] +---- +$ roxctl sensor generate openshift [flags] +---- diff --git a/modules/roxctl-sensor-generate-openshift.adoc b/modules/roxctl-sensor-generate-openshift.adoc index cfce7c9e8190..77d95199cced 100644 --- a/modules/roxctl-sensor-generate-openshift.adoc +++ b/modules/roxctl-sensor-generate-openshift.adoc @@ -1,30 +1,10 @@ // Module included in the following assemblies: // -// * command-reference/roxctl-sensor.adoc +// * cli/command-reference/roxctl-sensor.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-sensor-generate-openshift_{context}"] = roxctl sensor generate openshift -Generate the required files to deploy {product-title-short} services in a {osp} cluster. - -.Usage -[source,terminal] ----- -$ roxctl sensor generate openshift [flags] ----- - -.Options -[cols="6,3",options="header"] -|=== -|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 {osp} major version for which you want to generate the deployment files. -|=== \ No newline at end of file +[role="_abstract"] +Generate the required files to deploy {product-title-short} services in a {osp} cluster. \ No newline at end of file diff --git a/modules/roxctl-sensor-generate-options.adoc b/modules/roxctl-sensor-generate-options.adoc new file mode 100644 index 000000000000..04b39da29ba7 --- /dev/null +++ b/modules/roxctl-sensor-generate-options.adoc @@ -0,0 +1,82 @@ +// Module included in the following assemblies: +// +// * cli/command-reference/roxctl-sensor.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-sensor-generate-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl sensor generate` command. + +.Options +[cols="6,3",options="header"] +|=== +|Option |Description + +|`--admission-controller-disable-bypass` +|Disable the bypass annotations for the admission controller. The default value is `false`. + +|`--admission-controller-enforcement` +|Valid values are `true` and `false`. The default value is `true`. When set to `true`, the admission controller enforces policies by rejecting creation or update attempts that are in violation of an enabled policy. When set to `false`, the admission controller does not enforce policies. + +|`--admission-controller-enforce-on-creates` +|This field is deprecated and has no effect. Use the `--admission-controller-enforcement` option to configure enforcement. + +|`--admission-controller-enforce-on-updates` +|This field is deprecated and has no effect. Use the `--admission-controller-enforcement` option to configure enforcement. + +|`--admission-controller-fail-on-error` +| This parameter determines whether the API server request is allowed (fail open) or blocked (fail closed) if an error or timeout happens in the {product-title-short} validating webhook's evaluation. Valid values are `true` and `false`. The default value is `false`, which allows the request. When set to `true`, the request is blocked. + +|`--admission-controller-listen-on-creates` +|This field is deprecated. The `sensor generate` command behaves as if this flag has been specified. + +|`--admission-controller-listen-on-updates` +|This field is deprecated. The `sensor generate` command behaves as if this flag has been specified. + +|`--admission-controller-scan-inline` +|This field is deprecated. The `sensor generate` command behaves as if this flag has been specified. + +|`--admission-controller-timeout int32` +|This field is deprecated and using it has no effect. + +|`--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`. +|=== diff --git a/modules/roxctl-sensor-generate-usage.adoc b/modules/roxctl-sensor-generate-usage.adoc new file mode 100644 index 000000000000..d843a610fda5 --- /dev/null +++ b/modules/roxctl-sensor-generate-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * cli/command-reference/roxctl-sensor.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-sensor-generate-usage_{context}"] += roxctl sensor generate usage + +[role="_abstract"] +Usage syntax for the `roxctl sensor generate` command. + +.Usage +[source,terminal] +---- +$ roxctl sensor generate [flags] +---- diff --git a/modules/roxctl-sensor-generate.adoc b/modules/roxctl-sensor-generate.adoc index 57f5352b183b..5c223d7294a1 100644 --- a/modules/roxctl-sensor-generate.adoc +++ b/modules/roxctl-sensor-generate.adoc @@ -1,87 +1,10 @@ // Module included in the following assemblies: // -// * command-reference/roxctl-sensor.adoc +// * cli/command-reference/roxctl-sensor.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-sensor-generate_{context}"] = roxctl sensor generate -Generate files to deploy {product-title-short} services in secured clusters. - -.Usage -[source,terminal] ----- -$ roxctl sensor generate [flags] ----- - -.Options -[cols="6,3",options="header"] -|=== -|Option |Description - -|`--admission-controller-disable-bypass` -|Disable the bypass annotations for the admission controller. The default value is `false`. - -|`--admission-controller-enforcement` -|Valid values are `true` and `false`. The default value is `true`. When set to `true`, the admission controller enforces policies by rejecting creation or update attempts that are in violation of an enabled policy. When set to `false`, the admission controller does not enforce policies. - -|`--admission-controller-enforce-on-creates` -|This field is deprecated and has no effect. Use the `--admission-controller-enforcement` option to configure enforcement. - -|`--admission-controller-enforce-on-updates` -|This field is deprecated and has no effect. Use the `--admission-controller-enforcement` option to configure enforcement. - -|`--admission-controller-fail-on-error` -| This parameter determines whether the API server request is allowed (fail open) or blocked (fail closed) if an error or timeout happens in the {product-title-short} validating webhook's evaluation. Valid values are `true` and `false`. The default value is `false`, which allows the request. When set to `true`, the request is blocked. - -|`--admission-controller-listen-on-creates` -|This field is deprecated. The `sensor generate` command behaves as if this flag has been specified. - -|`--admission-controller-listen-on-updates` -|This field is deprecated. The `sensor generate` command behaves as if this flag has been specified. - -|`--admission-controller-scan-inline` -|This field is deprecated. The `sensor generate` command behaves as if this flag has been specified. - -|`--admission-controller-timeout int32` -|This field is deprecated and using it has no effect. - -|`--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`. -|=== \ No newline at end of file +[role="_abstract"] +Generate files to deploy {product-title-short} services in secured clusters. \ No newline at end of file diff --git a/modules/roxctl-sensor-get-bundle-options.adoc b/modules/roxctl-sensor-get-bundle-options.adoc new file mode 100644 index 000000000000..f9f741b29e3c --- /dev/null +++ b/modules/roxctl-sensor-get-bundle-options.adoc @@ -0,0 +1,31 @@ +// Module included in the following assemblies: +// +// * cli/command-reference/roxctl-sensor.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-sensor-get-bundle-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl sensor get-bundle` command. + +.Options +[cols="6,3",options="header"] +|=== +|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`. +|=== diff --git a/modules/roxctl-sensor-get-bundle-usage.adoc b/modules/roxctl-sensor-get-bundle-usage.adoc new file mode 100644 index 000000000000..66910962fb1a --- /dev/null +++ b/modules/roxctl-sensor-get-bundle-usage.adoc @@ -0,0 +1,22 @@ +// Module included in the following assemblies: +// +// * cli/command-reference/roxctl-sensor.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-sensor-get-bundle-usage_{context}"] += roxctl sensor get-bundle usage + +[role="_abstract"] +Usage syntax for the `roxctl sensor get-bundle` command. + +.Usage +[source,terminal] +---- +$ roxctl sensor get-bundle [flags] +---- + +where: + +-- +``:: Specifies the cluster name or ID. +-- diff --git a/modules/roxctl-sensor-get-bundle.adoc b/modules/roxctl-sensor-get-bundle.adoc index d0dd4cb97ffa..c6460966eb5d 100644 --- a/modules/roxctl-sensor-get-bundle.adoc +++ b/modules/roxctl-sensor-get-bundle.adoc @@ -1,42 +1,10 @@ // Module included in the following assemblies: // -// * command-reference/roxctl-sensor.adoc +// * cli/command-reference/roxctl-sensor.adoc -:_mod-docs-content-type: REFERENCE +:_mod-docs-content-type: CONCEPT [id="roxctl-sensor-get-bundle_{context}"] = roxctl sensor get-bundle -Download a bundle with the files to deploy {product-title-short} services into a cluster. - -.Usage -[source,terminal] ----- -$ roxctl sensor get-bundle [flags] ----- - -where: - --- -``:: Specifies the cluster name or ID. --- - -.Options -[cols="6,3",options="header"] -|=== -|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`. -|=== \ No newline at end of file +[role="_abstract"] +Download a bundle with the files to deploy {product-title-short} services into a cluster. \ No newline at end of file diff --git a/modules/roxctl-sensor-options.adoc b/modules/roxctl-sensor-options.adoc new file mode 100644 index 000000000000..ddacde37eb14 --- /dev/null +++ b/modules/roxctl-sensor-options.adoc @@ -0,0 +1,21 @@ +// Module included in the following assemblies: +// +// * cli/command-reference/roxctl-sensor.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-sensor-options_{context}"] += Options + +[role="_abstract"] +Options for the `roxctl sensor` command. + +[cols="2,2",options="header"] +|=== +|Option |Description + +|`--retry-timeout duration` +|Set the timeout before retrying API requests. A value of zero disables retries and waits for the entire request duration. 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`. +|=== diff --git a/modules/roxctl-sensor-overview.adoc b/modules/roxctl-sensor-overview.adoc new file mode 100644 index 000000000000..54f78bc1a21b --- /dev/null +++ b/modules/roxctl-sensor-overview.adoc @@ -0,0 +1,10 @@ +// Module included in the following assemblies: +// +// * cli/command-reference/roxctl-sensor.adoc + +:_mod-docs-content-type: CONCEPT +[id="roxctl-sensor-overview_{context}"] += roxctl sensor + +[role="_abstract"] +Deploy {rh-rhacs-first} services in secured clusters. diff --git a/modules/roxctl-sensor-usage.adoc b/modules/roxctl-sensor-usage.adoc new file mode 100644 index 000000000000..6c5273ef7774 --- /dev/null +++ b/modules/roxctl-sensor-usage.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * cli/command-reference/roxctl-sensor.adoc + +:_mod-docs-content-type: REFERENCE +[id="roxctl-sensor-usage_{context}"] += roxctl sensor usage + +[role="_abstract"] +Usage syntax for the `roxctl sensor` command. + +.Usage +[source,terminal] +---- +$ roxctl sensor [command] [flags] +----