×

与Central服务相关的命令。

用法
$ roxctl central [command] [flags]
表1. 可用命令
命令 描述

backup

创建Red Hat Advanced Cluster Security for Kubernetes (RHACS) 数据库和证书的备份。

cert

下载Central服务的证书链。

db

控制数据库操作。

debug

调试Central服务。

generate

生成包含用于部署Central的协调器对象的必需YAML配置文件。

init-bundles

初始化Central的bundles。

login

登录到Central实例以获取令牌。

userpki

管理用户证书授权提供程序。

whoami

显示关于当前用户及其身份验证方法的信息。

从父命令继承的roxctl central命令选项

roxctl central 命令支持从父命令 roxctl 继承的以下选项

选项 描述

--ca string

指定用于安全连接的自定义CA证书文件路径。或者,您可以使用ROX_CA_CERT_FILE环境变量指定文件路径。

--direct-grpc

设置--direct-grpc以提高连接性能。或者,通过将ROX_DIRECT_GRPC_CLIENT环境变量设置为true,您可以启用直接gRPC。默认值为false

-e, --endpoint string

设置要联系的服务的端点。或者,您可以使用ROX_ENDPOINT环境变量设置端点。默认值为localhost:8443

--force-http1

强制对所有连接使用HTTP/1。或者,通过将ROX_CLIENT_FORCE_HTTP1环境变量设置为true,您可以强制使用HTTP/1。默认值为false

--insecure

启用不安全连接选项。或者,通过将ROX_INSECURE_CLIENT环境变量设置为true,您可以启用不安全连接选项。默认值为false

--insecure-skip-tls-verify

跳过TLS证书验证。或者,通过将ROX_INSECURE_CLIENT_SKIP_TLS_VERIFY环境变量设置为true,您可以跳过TLS证书验证。默认值为false

--no-color

禁用彩色输出。或者,通过将ROX_NO_COLOR环境变量设置为true,您可以禁用彩色输出。默认值为false

-p, --password string

指定基本身份验证的密码。或者,您可以使用ROX_ADMIN_PASSWORD环境变量设置密码。

--plaintext

使用未加密的连接。或者,通过将ROX_PLAINTEXT环境变量设置为true,您可以启用未加密的连接。默认值为false

-s, --server-name string

设置用于SNI的TLS服务器名称。或者,您可以使用ROX_SERVER_NAME环境变量设置服务器名称。

--token-file string

使用指定文件中提供的API令牌进行身份验证。或者,您可以使用ROX_API_TOKEN环境变量设置令牌。

这些选项适用于roxctl central命令的所有子命令。

roxctl central backup

创建RHACS数据库和证书的备份。

用法
$ roxctl central backup [flags]
表2. 选项
选项 描述

--certs-only

指定仅备份证书。使用外部数据库时,此选项用于生成包含证书的备份包。默认值为false

--output string

指定要保存备份的位置。行为取决于指定的路径

  • 如果路径是文件路径,则备份将写入文件,如果文件已存在则覆盖它。目录必须存在。

  • 如果路径是目录,则备份将保存在此目录下,文件名由服务器指定。

  • 如果省略此参数,则备份将保存在当前工作目录下,文件名由服务器指定。

-t, --timeout duration

指定API请求的超时时间。它表示请求的最大持续时间。默认值为1h0m0s

roxctl central cert

下载Central服务的证书链。

用法
$ roxctl central cert [flags]
表3. 选项
选项 描述

--output string

指定要将PEM证书保存到的文件名。您可以使用-生成标准输出。默认值为-

--retry-timeout duration

指定API请求重试之前的超时时间。值为零表示等待整个请求持续时间而不重试。默认值为20s

-t, --timeout duration

指定API请求的超时时间,表示请求的最大持续时间。默认值为1m0s

roxctl central login

登录到Central实例以获取令牌。

用法
$ roxctl central login [flags]
表4. 选项
选项 描述

-t, --timeout duration

指定API请求的超时时间,表示请求的最大持续时间。默认值为5m0s

roxctl central whoami

显示关于当前用户及其身份验证方法的信息。

用法
$ roxctl central whoami [flags]
表5. 选项
选项 描述

--retry-timeout duration

指定API请求重试之前的超时时间。值为零表示等待整个请求持续时间而不重试。默认值为20s

-t, --timeout duration

指定API请求的超时时间,表示请求的最大持续时间。默认值为1m0s

roxctl central db

控制数据库操作。

用法
$ roxctl central db [flags]
表6. 选项
选项 描述

-t, --timeout duration

指定API请求的超时时间,表示请求的最大持续时间。默认值为1h0m0s

roxctl central db restore

从之前的备份还原RHACS数据库。

用法
$ roxctl central db restore <file> [flags] (1)
1 对于<file>,指定要还原的数据库备份文件。
表7. 选项
选项 描述

-f, --force

如果设置为true,则无需确认即可执行还原。默认值为false

--interrupt

如果设置为true,它将中断正在运行的还原过程以允许其继续。默认值为false

roxctl central db generate

生成Central数据库包。

用法
$ roxctl central db generate [flags]
表8. 选项
选项 描述

--debug

如果设置为true,则从本地文件系统读取模板。默认值为false

--debug-path string

指定本地文件系统中Helm模板的路径。有关更多详细信息,请运行roxctl central db generate命令。

--enable-pod-security-policies

如果设置为true,则创建PodSecurityPolicy资源。默认值为true

roxctl central db generate k8s

生成用于部署Central数据库组件的Kubernetes YAML文件。

用法
$ roxctl central db generate k8s [flags]
表9. 选项
选项 描述

--central-db-image string

指定要使用的Central数据库镜像。如果未指定,则使用与--image-defaults对应的默认值。

--image-defaults string

指定容器镜像的默认设置。它控制从中下载镜像的存储库、镜像名称和标签格式。默认值为development_build

--output-dir output directory

指定要保存部署包的目录。默认值为central-db-bundle

roxctl central db restore cancel

取消正在进行的Central数据库还原过程。

用法
$ roxctl central db restore cancel [flags]
表10. 选项
选项 描述

f, --force

如果设置为true,则无需确认即可继续取消。默认值为false

roxctl central db restore status

显示正在进行的数据库恢复过程信息。

用法
$ roxctl central db restore status [flags]

roxctl central db generate k8s pvc

生成 Central 中持久卷声明 (PVC) 的 Kubernetes YAML 文件。

用法
$ roxctl central db generate k8s pvc [flags]
表 11. 选项
选项 描述

--name string

指定 Central 数据库的外部卷名称。默认值为 central-db

--size uint32

指定 Central 数据库的外部卷大小(以 GB 为单位)。默认值为 100

--storage-class string

指定 Central 数据库的存储类名称。如果您已配置默认存储类,则此选项可选。

roxctl central db generate openshift

生成用于在 Red Hat OpenShift 集群上部署 Central 数据库实例的 OpenShift YAML 清单。

用法
$ roxctl central db generate openshift [flags]
表 12. 选项
选项 描述

--central-db-image string

指定要使用的Central数据库镜像。如果未指定,则使用与--image-defaults对应的默认值。

--image-defaults string

指定容器镜像的默认设置。它控制从中下载镜像的存储库、镜像名称和标签格式。默认值为development_build

--openshift-version int

指定部署的 Red Hat OpenShift 主版本 3 或 4。默认值为 3

--output-dir output-directory

指定要保存部署包的目录。默认值为central-db-bundle

roxctl central db generate k8s hostpath

生成具有 Central 中主机路径卷类型的数据库部署的 Kubernetes YAML 清单。

用法
$ roxctl central db generate k8s hostpath [flags]
表 13. 选项
选项 描述

--hostpath string

指定主机上的路径。默认值为 /var/lib/stackrox-central-db

--node-selector-key string

指定节点选择器键。有效值包括 kubernetes.iohostname

--node-selector-value string

指定节点选择器值。

roxctl central db generate openshift pvc

生成具有 Central 中持久卷声明 (PVC) 的数据库部署的 OpenShift YAML 清单。

用法
$ roxctl central db generate openshift pvc [flags]
表 14. 选项
选项 描述

--name string

指定 Central 数据库的外部卷名称。默认值为 central-db

--size uint32

指定 Central 数据库的外部卷大小(以 GB 为单位)。默认值为 100

--storage-class string

指定 Central 数据库的存储类名称。如果您已配置默认存储类,则此选项可选。

roxctl central db generate openshift hostpath

向 Central 数据库添加主机路径外部卷。

用法
$ roxctl central db generate openshift hostpath [flags]
表 15. 选项
选项 描述

--hostpath string

指定主机上的路径。默认值为 /var/lib/stackrox-central-db

--node-selector-key string

指定节点选择器键。有效值包括 kubernetes.iohostname

--node-selector-value string

指定节点选择器值。

roxctl central debug

调试Central服务。

用法
$ roxctl central debug [flags]

roxctl central debug db

控制数据库的调试。

用法
$ roxctl central debug db [flags]
表 16. 选项
选项 描述

-t, --timeout duration

指定API请求的超时时间,表示请求的最大持续时间。默认值为1m0s

roxctl central debug log

检索当前日志级别。

用法
$ roxctl central debug log [flags]
表 17. 选项
选项 描述

-l, --level string

指定要将模块设置为的日志级别。有效值包括 DebugInfoWarnErrorPanicFatal

-m, --modules strings

指定要应用命令的模块。

--retry-timeout duration

指定API请求重试之前的超时时间。值为零表示等待整个请求持续时间而不重试。默认值为20s

-t, --timeout duration

指定 API 请求的超时时间,即请求的最大持续时间。默认值为 1m0s

roxctl central debug dump

下载包含 Central 调试信息的包。

用法
$ roxctl central debug dump [flags]
表 18. 选项
选项 描述

--logs

如果设置为 true,则日志包含在 Central 转储中。默认值为 false

--output-dir string

指定包内容的输出目录。默认值为当前目录中的自动生成的目录名称。

-t, --timeout duration

指定 API 请求的超时时间,即请求的最大持续时间。默认值为 5m0s

roxctl central debug db stats

控制 Central 数据库的统计信息。

用法
$ roxctl central debug db stats [flags]

roxctl central debug authz-trace

出于调试目的,启用或禁用 Central 中的授权跟踪。

用法
$ roxctl central debug authz-trace [flags]
表 19. 选项
选项 描述

-t, --timeout duration

指定 API 请求的超时时间,表示请求的最大持续时间。默认值为 20m0s

roxctl central debug db stats reset

重置 Central 数据库的统计信息。

用法
$ roxctl central debug db stats reset [flags]

roxctl central debug download-diagnostics

下载包含平台诊断信息快照的包。

用法
$ roxctl central debug download-diagnostics [flags]
表 20. 选项
选项 描述

--clusters strings

指定要从中收集日志的 Sensor 集群的逗号分隔列表。

--output-dir string

指定要保存诊断包的输出目录。

--since string

指定要从 Sensor 集群收集日志的时间戳。

-t, --timeout duration

指定 API 请求的超时时间,指定请求的最大持续时间。默认值为 5m0s

roxctl central generate

生成包含要部署 Central 的编排器对象的必需 YAML 配置文件。

用法
$ roxctl central generate [flags]
表 21. 选项
选项 描述

--backup-bundle string

指定要从中恢复密钥和证书的备份包的路径。

--debug

如果设置为true,则从本地文件系统读取模板。默认值为false

--debug-path string

指定本地文件系统上 Helm 模板的路径。有关更多详细信息,请运行 roxctl central generate --help 命令。

--default-tls-certfile

指定要作为默认值使用的 PEM 证书包文件。

--default-tls-keyfile

指定要作为默认值使用的 PEM 私钥文件。

--enable-pod-security-policies

如果设置为true,则创建PodSecurityPolicy资源。默认值为true

-p, --password string

指定管理员密码。默认值会自动生成。

--plaintext-endpoints string

指定要用于未加密公开的端口或端点,以逗号分隔列表形式表示。

roxctl central generate k8s

生成将 Central 部署到 Kubernetes 集群所需的 YAML 配置文件。

用法
$ roxctl central generate k8s [flags]
表 22. 选项
选项 描述

--central-db-image string

指定要使用的 Central 数据库镜像。如果未指定,则使用与 --image-defaults 对应的默认值。

--declarative-config-config-maps strings

指定要作为声明性配置挂载添加到 Central 的配置映射列表。

--declarative-config-secrets strings

指定要作为声明性配置挂载添加到 Central 的密钥列表。

--enable-telemetry

指定是否要启用遥测。默认值为 false

--image-defaults string

指定容器镜像的默认设置。指定的设置控制从哪些存储库下载镜像、镜像名称以及标签的格式。默认值为 development_build

--istio-support version

生成支持指定 Istio 版本的部署文件。有效值包括 1.01.11.21.31.41.51.61.7

--lb-type load balancer type

指定要暂停 Central 的方法。有效值包括 lbnpnone。默认值为 none

-i, --main-image string

指定要使用的主镜像。如果未指定,则使用与 --image-defaults 对应的默认值。

--offline

指定是否要在脱机模式下运行 RHACS,避免连接到互联网。默认值为 false

--output-dir output directory

指定要保存部署包的目录。默认值为 central-bundle

--output-format output format

指定要使用的部署工具。有效值包括 kubectlhelmhelm-values。默认值为 kubectl

--scanner-db-image string

指定要使用的 Scanner 数据库镜像。如果未指定,则使用与 --image-defaults 对应的默认值。

--scanner-image string

指定要使用的 Scanner 镜像。如果未指定,则使用与 --image-defaults 对应的默认值。

roxctl central generate k8s pvc

生成 Central 中持久卷声明 (PVC) 的 Kubernetes YAML 文件。

用法
$ roxctl central generate k8s pvc [flags]
表 23. 选项
选项 描述

--db-name string

指定 Central 数据库的外部卷名称。默认值为 central-db

--db-size uint32

指定 Central 数据库的外部卷大小(以 GB 为单位)。默认值为 100

--db-storage-class string

指定 Central 数据库的存储类名称。如果您已配置默认存储类,则此选项可选。

roxctl central generate openshift

生成在 Red Hat OpenShift 集群中部署 Central 所需的 YAML 配置文件。

用法
$ roxctl central generate openshift [flags]
表 24. 选项
选项 描述

--central-db-image string

指定要使用的 Central 数据库镜像。如果未指定,则会创建一个与--image-defaults对应的默认值。

--declarative-config-config-maps strings

指定要作为声明性配置挂载添加到 Central 的配置映射列表。

--declarative-config-secrets strings

指定要作为声明性配置挂载添加到 Central 的密钥列表。

--enable-telemetry

指定是否要启用遥测。默认值为 false

--image-defaults string

指定容器镜像的默认设置。它控制从中下载镜像的存储库、镜像名称和标签格式。默认值为development_build

--istio-support version

生成支持指定 Istio 版本的部署文件。有效值包括 1.01.11.21.31.41.51.61.7

--lb-type load balancer type

指定 Central 的暴露方式。有效值为routelbnpnone。默认值为none

-i, --main-image string

指定要使用的主镜像。如果未指定,则使用与--image-defaults对应的默认值。

--offline

指定是否要在脱机模式下运行 RHACS,避免连接到互联网。默认值为 false

--openshift-monitoring false|true|auto[=true]

指定与 Red Hat OpenShift 4 监控的集成。默认值为auto

--openshift-version int

指定部署的 Red Hat OpenShift 主版本 3 或 4。

--output-dir output directory

指定要保存部署包的目录。默认值为 central-bundle

--output-format output format

指定要使用的部署工具。有效值为kubectlhelmhelm-values。默认值为kubectl

--scanner-db-image string

指定要使用的 Scanner 数据库镜像。如果未指定,则使用与 --image-defaults 对应的默认值。

--scanner-image string

指定要使用的 Scanner 镜像。如果未指定,则使用与--image-defaults对应的默认值。

roxctl central generate interactive

在 Central 中生成交互式资源。

用法
$ roxctl central generate interactive [flags]

roxctl central generate k8s hostpath

使用 hostpath 卷类型生成用于部署 Central 实例的 Kubernetes YAML 清单。

用法
$ roxctl central generate k8s hostpath [flags]
表 25. 选项
选项 描述

--db-hostpath string

指定主机上 Central 数据库的路径。默认值为/var/lib/stackrox-central

--db-node-selector-key string

指定 Central 数据库的节点选择器键。有效值为kubernetes.iohostname

--db-node-selector-value string

指定 Central 数据库的节点选择器值。

roxctl central generate openshift pvc

生成用于在 Central 中部署持久卷声明 (PVC) 的 OpenShift YAML 清单。

用法
$ roxctl central generate openshift pvc [flags]
表 26. 选项
选项 描述

--db-name string

指定 Central 数据库的外部卷名称。默认值为 central-db

--db-size uint32

指定 Central 数据库的外部卷大小(以 GB 为单位)。默认值为 100

--db-storage-class string

指定 Central 数据库的存储类名称。如果您已配置默认存储类,则此选项可选。

roxctl central generate openshift hostpath

将 hostpath 外部卷添加到 Red Hat OpenShift 中的部署定义。

用法
$ roxctl central generate openshift hostpath [flags]
表 27. 选项
选项 描述

--db-hostpath string

指定主机上 Central 数据库的路径。默认值为/var/lib/stackrox-central

--db-node-selector-key string

指定节点选择器键。有效值为 Central 数据库的kubernetes.iohostname

--db-node-selector-value string

指定 Central 数据库的节点选择器值。

roxctl central init-bundles

初始化 Central 中的捆绑包。

用法
$ roxctl central init-bundles [flag]
表 28. 选项
选项 描述

--retry-timeout duration

指定 API 请求重试后的超时时间。值为0s 表示等待整个请求持续时间而无需重试。默认值为20s

-t, --timeout duration

指定API请求的超时时间,表示请求的最大持续时间。默认值为1m0s

roxctl central init-bundles list

列出 Central 中可用的初始化捆绑包。

用法
$ roxctl central init-bundles list [flags]

roxctl central init-bundles revoke

撤销 Central 中的一个或多个集群初始化捆绑包。

用法
$ roxctl central init-bundles revoke <init_bundle_ID or name> [<init_bundle_ID or name> ...] [flags] (1)
1 对于<init_bundle_ID or name>,指定要撤销的初始化捆绑包的 ID 或名称。您可以使用空格分隔提供多个 ID 或名称。

roxctl central init-bundles fetch-ca

从 Central 获取证书颁发机构 (CA) 捆绑包。

用法
$ roxctl central init-bundles fetch-ca [flags]
表 29. 选项
选项 描述

--output string

指定要用于存储 CA 配置的文件。

roxctl central init-bundles generate

生成新的集群初始化捆绑包。

用法
$ roxctl central init-bundles generate <init_bundle_name> [flags] (1)
1 对于<init_bundle_name>,指定要生成的初始化捆绑包的名称。
表 30. 选项
选项 描述

--output string

指定要用于以 Helm 配置形式存储新生成的初始化捆绑包的文件。您可以使用-生成标准输出。

--output-secrets string

指定要用于以 Kubernetes secret 形式存储新生成的初始化捆绑包的文件。您可以使用-生成标准输出。

roxctl central userpki

管理用户证书授权提供程序。

用法
$ roxctl central userpki [flags]

roxctl central userpki list

显示所有用户证书身份验证提供程序。

用法
$ roxctl central userpki list [flags]
表 31. 选项
选项 描述

-j, --json

启用 JSON 输出。默认值为false

--retry-timeout duration

指定API请求重试之前的超时时间。值为零表示等待整个请求持续时间而不重试。默认值为20s

-t, --timeout duration

指定API请求的超时时间,表示请求的最大持续时间。默认值为1m0s

roxctl central userpki create

创建一个新的用户证书身份验证提供程序。

用法
$ roxctl central userpki create name [flags]
表 32. 选项
选项 描述

-c, --cert strings

指定根 CA 证书的 PEM 文件。您可以指定多个证书文件。

--retry-timeout duration

指定API请求重试之前的超时时间。值为零表示等待整个请求持续时间而不重试。默认值为20s

-r, --role string

指定此提供程序用户的最低访问角色。

-t, --timeout duration

指定API请求的超时时间,表示请求的最大持续时间。默认值为1m0s

roxctl central userpki delete

删除用户证书身份验证提供程序。

用法
$ roxctl central userpki delete id|name [flags]
表 33. 选项
选项 描述

-f, --force

如果设置为true,则无需确认即可继续删除。默认值为false

--retry-timeout duration

指定API请求重试之前的超时时间。值为零表示等待整个请求持续时间而不重试。默认值为20s

-t, --timeout duration

指定API请求的超时时间,表示请求的最大持续时间。默认值为1m0s