This documentation is for a release that is no longer maintained.
You can select a different version or view all RHACS documentation.8.2. roxctl central
与 Central 服务相关的命令。
使用方法
roxctl central [command] [flags]
$ roxctl central [command] [flags]
| 命令 | 描述 |
|---|---|
|
| 创建 Red Hat Advanced Cluster Security for Kubernetes (RHACS)数据库和证书的备份。 |
|
| 下载中央服务的证书链。 |
|
| 控制数据库操作。 |
|
| 调试中央服务。 |
|
| 生成所需的 YAML 配置文件,其中包含用于部署 Central 的编配器对象。 |
|
| 为 Central 初始化捆绑包。 |
|
| 登录 Central 实例以获取令牌。 |
|
| 管理用户证书授权提供程序。 |
|
| 显示有关当前用户及其身份验证方法的信息。 |
8.2.1. roxctl central 命令选项从父命令继承 复制链接链接已复制到粘贴板!
roxctl central 命令支持从父 roxctl 命令继承的以下选项:
| 选项 | 描述 |
|---|---|
|
|
为安全连接指定自定义 CA 证书文件路径。或者,您可以使用 |
|
|
设置 |
|
|
将服务的端点设置为 contact。或者,您可以使用 |
|
|
强制将 HTTP/1 用于所有连接。或者,通过将 |
|
|
启用不安全的连接选项。或者,通过将 |
|
|
跳过 TLS 证书验证。或者,通过将 |
|
|
禁用颜色输出。或者,通过将 |
|
|
指定基本身份验证的密码。或者,您可以使用 |
|
|
使用未加密的连接。或者,通过将 |
|
|
设置用于 SNI 的 TLS 服务器名称。或者,您可以使用 |
|
|
使用指定文件中提供的 API 令牌进行身份验证。另外,您可以使用 |
这些选项适用于 roxctl central 命令的所有子命令。
8.2.2. roxctl 中央备份 复制链接链接已复制到粘贴板!
创建 RHACS 数据库和证书的备份。
使用方法
roxctl central backup [flags]
$ roxctl central backup [flags]
| 选项 | 描述 |
|---|---|
|
|
指定仅备份证书。在使用外部数据库时,这个选项用于生成带有证书的备份捆绑包。默认值为 |
|
| 指定您要保存备份的位置。此行为取决于指定的路径:
|
|
|
指定 API 请求的超时时间。它代表请求的最长持续时间。默认值为 |
8.2.3. roxctl central cert 复制链接链接已复制到粘贴板!
下载中央服务的证书链。
使用方法
roxctl central cert [flags]
$ roxctl central cert [flags]
| 选项 | 描述 |
|---|---|
|
|
指定要保存 PEM 证书的文件名。您可以使用 |
|
|
指定重试 API 请求超时。值为零表示整个请求持续时间都在不重试的情况下等待。默认值为 |
|
|
指定代表请求最长持续时间的 API 请求超时。默认值为 |
8.2.4. roxctl central login 复制链接链接已复制到粘贴板!
登录 Central 实例以获取令牌。
使用方法
roxctl central login [flags]
$ roxctl central login [flags]
| 选项 | 描述 |
|---|---|
|
|
指定代表请求最长持续时间的 API 请求超时。默认值为 |
8.2.5. roxctl central whoami 复制链接链接已复制到粘贴板!
显示有关当前用户及其身份验证方法的信息。
使用方法
roxctl central whoami [flags]
$ roxctl central whoami [flags]
| 选项 | 描述 |
|---|---|
|
|
指定重试 API 请求超时。值为零表示整个请求持续时间都在不重试的情况下等待。默认值为 |
|
|
指定代表请求最长持续时间的 API 请求超时。默认值为 |
8.2.6. roxctl central db 复制链接链接已复制到粘贴板!
控制数据库操作。
使用方法
roxctl central db [flags]
$ roxctl central db [flags]
| 选项 | 描述 |
|---|---|
|
|
指定代表请求最长持续时间的 API 请求超时。默认值为 |
8.2.6.1. roxctl central db restore 复制链接链接已复制到粘贴板!
从以前的备份中恢复 RHACS 数据库。
使用方法
roxctl central db restore <file> [flags]
$ roxctl central db restore <file> [flags]
- 1
- 对于
<file>,请指定您要恢复的数据库备份文件。
| 选项 | 描述 |
|---|---|
|
|
如果设置为 |
|
|
如果设置为 |
8.2.6.2. roxctl central db generate 复制链接链接已复制到粘贴板!
生成 Central 数据库捆绑包。
使用方法
roxctl central db generate [flags]
$ roxctl central db generate [flags]
| 选项 | 描述 |
|---|---|
|
|
如果设置为 |
|
|
指定本地文件系统中的 Helm 模板路径。如需了解更多详细信息,请运行 |
|
|
如果设置为 |
8.2.6.3. roxctl central db generate k8s 复制链接链接已复制到粘贴板!
生成用于部署 Central 数据库组件的 Kubernetes YAML 文件。
使用方法
roxctl central db generate k8s [flags]
$ roxctl central db generate k8s [flags]
| 选项 | 描述 |
|---|---|
|
|
指定您要使用的 Central 数据库镜像。如果没有指定,则使用与 |
|
|
指定容器镜像的默认设置。它控制从中下载镜像的存储库、镜像名称和标签格式。默认值为 |
|
|
指定要保存部署捆绑包的目录。默认值为 |
8.2.6.4. roxctl central db restore cancel 复制链接链接已复制到粘贴板!
取消持续的 Central 数据库恢复过程。
使用方法
roxctl central db restore cancel [flags]
$ roxctl central db restore cancel [flags]
| 选项 | 描述 |
|---|---|
|
|
如果设置为 |
8.2.6.5. roxctl central db restore status 复制链接链接已复制到粘贴板!
显示有关持续数据库恢复过程的信息。
使用方法
roxctl central db restore status [flags]
$ roxctl central db restore status [flags]
8.2.6.6. roxctl central db generate k8s pvc 复制链接链接已复制到粘贴板!
为 Central 中的持久性卷声明(PVC)生成 Kubernetes YAML 文件。
使用方法
roxctl central db generate k8s pvc [flags]
$ roxctl central db generate k8s pvc [flags]
| 选项 | 描述 |
|---|---|
|
|
指定 Central 数据库的外部卷名称。默认值为 |
|
|
为 Central 数据库指定外部卷大小(以 GB 为单位)。默认值为 |
|
| 指定 Central 数据库的存储类名称。如果您配置了默认存储类,则这是可选的。 |
8.2.6.7. roxctl central db generate openshift 复制链接链接已复制到粘贴板!
生成 OpenShift YAML 清单,用于在 Red Hat OpenShift 集群上部署中央数据库实例。
使用方法
roxctl central db generate openshift [flags]
$ roxctl central db generate openshift [flags]
| 选项 | 描述 |
|---|---|
|
|
指定您要使用的 Central 数据库镜像。如果没有指定,则使用与 |
|
|
指定容器镜像的默认设置。它控制从中下载镜像的存储库、镜像名称和标签格式。默认值为 |
|
|
为部署指定 Red Hat OpenShift 主版本 3 或 4。默认值为 |
|
|
指定要保存部署捆绑包的目录。默认值为 |
8.2.6.8. roxctl central db generate k8s hostpath 复制链接链接已复制到粘贴板!
为在 Central 中带有 hostpath 卷类型的数据库部署生成 Kubernetes YAML 清单。
使用方法
roxctl central db generate k8s hostpath [flags]
$ roxctl central db generate k8s hostpath [flags]
| 选项 | 描述 |
|---|---|
|
|
指定主机上的路径。默认值为 |
|
|
指定节点选择器键。有效值包括 |
|
| 指定节点选择器值。 |
8.2.6.9. roxctl central db generate openshift pvc 复制链接链接已复制到粘贴板!
使用 Central 中的持久性卷声明(PVC)为数据库部署生成 OpenShift YAML 清单。
使用方法
roxctl central db generate openshift pvc [flags]
$ roxctl central db generate openshift pvc [flags]
| 选项 | 描述 |
|---|---|
| --name string |
指定 Central 数据库的外部卷名称。默认值为 |
| --size uint32 |
为 Central 数据库指定外部卷大小(以 GB 为单位)。默认值为 |
| --storage-class string | 指定 Central 数据库的存储类名称。如果您配置了默认存储类,则这是可选的。 |
8.2.6.10. roxctl central db generate openshift hostpath 复制链接链接已复制到粘贴板!
将 hostpath 外部卷添加到 Central 数据库。
使用方法
roxctl central db generate openshift hostpath [flags]
$ roxctl central db generate openshift hostpath [flags]
| 选项 | 描述 |
|---|---|
|
|
指定主机上的路径。默认值为 |
|
|
指定节点选择器键。有效值包括 |
|
| 指定节点选择器值。 |
8.2.7. roxctl central debug 复制链接链接已复制到粘贴板!
调试中央服务。
使用方法
roxctl central debug [flags]
$ roxctl central debug [flags]
8.2.7.1. roxctl central debug db 复制链接链接已复制到粘贴板!
控制数据库的调试。
使用方法
roxctl central debug db [flags]
$ roxctl central debug db [flags]
| 选项 | 描述 |
|---|---|
|
|
指定代表请求最长持续时间的 API 请求超时。默认值为 |
8.2.7.2. roxctl central debug log 复制链接链接已复制到粘贴板!
检索当前的日志级别。
使用方法
roxctl central debug log [flags]
$ roxctl central debug log [flags]
| 选项 | 描述 |
|---|---|
|
|
指定要设置模块的日志级别。有效值包括 |
|
| 指定要应用命令的模块。 |
|
|
指定重试 API 请求超时。值为零表示整个请求持续时间都在不重试的情况下等待。默认值为 |
|
|
指定 API 请求的超时时间,这是请求的最长持续时间。默认值为 |
8.2.7.3. roxctl central debug dump 复制链接链接已复制到粘贴板!
下载包含 Central 的调试信息的捆绑包。
使用方法
roxctl central debug dump [flags]
$ roxctl central debug dump [flags]
| 选项 | 描述 |
|---|---|
|
|
如果设置为 |
|
| 指定捆绑包内容的输出目录。默认值是当前目录中自动生成的目录名称。 |
|
|
指定 API 请求的超时时间,这是请求的最长持续时间。默认值为 |
8.2.7.4. roxctl central debug db stats 复制链接链接已复制到粘贴板!
控制 Central 数据库的统计信息。
使用方法
roxctl central debug db stats [flags]
$ roxctl central debug db stats [flags]
8.2.7.5. roxctl central debug authz-trace 复制链接链接已复制到粘贴板!
在 Central 中启用或禁用授权追踪以进行调试。
使用方法
roxctl central debug authz-trace [flags]
$ roxctl central debug authz-trace [flags]
| 选项 | 描述 |
|---|---|
|
|
指定代表请求最长持续时间的 API 请求超时。默认值为 |
8.2.7.6. roxctl central debug db stats reset 复制链接链接已复制到粘贴板!
重置 Central 数据库的统计信息。
使用方法
roxctl central debug db stats reset [flags]
$ roxctl central debug db stats reset [flags]
8.2.7.7. roxctl central debug download-diagnostics 复制链接链接已复制到粘贴板!
下载包含平台诊断信息的快照的捆绑包。
使用方法
roxctl central debug download-diagnostics [flags]
$ roxctl central debug download-diagnostics [flags]
| 选项 | 描述 |
|---|---|
|
| 指定您要从中收集日志的 Sensor 集群的逗号分隔列表。 |
|
| 指定要保存诊断捆绑包的输出目录。 |
|
| 指定您要从 Sensor 集群收集日志的时间戳。 |
|
|
指定 API 请求的超时时间,指定请求的最长持续时间。默认值为 |
8.2.8. roxctl central generate 复制链接链接已复制到粘贴板!
生成所需的 YAML 配置文件,其中包含用于部署 Central 的编配器对象。
使用方法
roxctl central generate [flags]
$ roxctl central generate [flags]
| 选项 | 描述 |
|---|---|
|
| 指定要恢复密钥和证书的备份捆绑包的路径。 |
|
|
如果设置为 |
|
|
指定本地文件系统中的 Helm 模板路径。如需了解更多详细信息,请运行 |
|
| 指定您要用作默认值的 PEM 证书捆绑包文件。 |
|
| 指定您要用作默认值的 PEM 私钥文件。 |
|
|
如果设置为 |
|
| 指定管理员密码。默认值会自动生成。 |
|
| 指定您要用于未加密的暴露的端口或端点,作为逗号分隔的列表。 |
8.2.8.1. roxctl central generate k8s 复制链接链接已复制到粘贴板!
生成所需的 YAML 配置文件,以将 Central 部署到 Kubernetes 集群中。
使用方法
roxctl central generate k8s [flags]
$ roxctl central generate k8s [flags]
| 选项 | 描述 |
|---|---|
|
|
指定您要使用的 Central 数据库镜像。如果没有指定,则使用与 |
|
| 指定您要添加为 Central 中的声明性配置挂载的配置映射列表。 |
|
| 指定您要作为声明性配置挂载添加到 Central 中的 secret 列表。 |
|
|
指定是否要启用遥测。默认值为 |
|
|
指定容器镜像的默认设置。指定设置控制从中下载镜像的存储库、镜像名称和标签格式。默认值为 |
|
|
生成支持指定 Istio 版本的部署文件。有效值包括 1.0, |
|
|
指定要暂停 Central 的方法。有效值包括 |
|
|
指定您要使用的主镜像。如果没有指定,则使用与 |
|
|
指定是否要以离线模式运行 RHACS,避免连接到互联网。默认值为 |
|
|
指定要保存部署捆绑包的目录。默认值为 |
|
|
指定您要使用的部署工具。有效值包括 |
|
|
指定您要使用的 Scanner 数据库镜像。如果没有指定,则使用与 |
|
| 指定您要使用的 Scanner 镜像。如果没有指定,则使用与 '--image-defaults" 对应的默认值。 |
8.2.8.2. roxctl central generate k8s pvc 复制链接链接已复制到粘贴板!
为 Central 中的持久性卷声明(PVC)生成 Kubernetes YAML 文件。
使用方法
roxctl central generate k8s pvc [flags]
$ roxctl central generate k8s pvc [flags]
| 选项 | 描述 |
|---|---|
|
|
指定 Central 数据库的外部卷名称。默认值为 |
|
|
为 Central 数据库指定外部卷大小(以 GB 为单位)。默认值为 |
|
| 指定 Central 数据库的存储类名称。如果您配置了默认存储类,则这是可选的。 |
|
|
指定 Central 的外部卷名称。默认值为 |
|
|
为 Central 指定外部卷大小(以 GB 为单位)。默认值为 |
|
| 指定 Central 的存储类名称。如果您配置了默认存储类,则这是可选的。 |
8.2.8.3. roxctl central generate openshift 复制链接链接已复制到粘贴板!
生成所需的 YAML 配置文件以在 Red Hat OpenShift 集群中部署 Central。
使用方法
roxctl central generate openshift [flags]
$ roxctl central generate openshift [flags]
| 选项 | 描述 |
|---|---|
|
|
指定您要使用的 Central 数据库镜像。如果没有指定,则会创建一个与 |
|
| 指定您要添加为 Central 中的声明性配置挂载的配置映射列表。 |
|
| 指定您要作为声明性配置挂载添加到 Central 中的 secret 列表。 |
|
|
指定是否要启用遥测。默认值为 |
|
|
指定容器镜像的默认设置。它控制从中下载镜像的存储库、镜像名称和标签格式。默认值为 |
|
|
生成支持指定 Istio 版本的部署文件。有效值包括 1.0, |
|
|
指定公开 Central 的方法。有效值包括 |
|
|
指定您要使用的主镜像。如果没有指定,则使用与 |
|
|
指定是否要以离线模式运行 RHACS,避免连接到互联网。默认值为 |
|
|
指定与 Red Hat OpenShift 4 监控的集成。默认值为 |
|
| 为部署指定 Red Hat OpenShift 主版本 3 或 4。 |
|
|
指定要保存部署捆绑包的目录。默认值为 |
|
|
指定您要使用的部署工具。有效值包括 |
|
|
指定您要使用的 Scanner 数据库镜像。如果没有指定,则使用与 |
|
|
指定您要使用的 Scanner 镜像。如果没有指定,则使用与 |
8.2.8.4. roxctl central generate interactive 复制链接链接已复制到粘贴板!
在 Central 中生成交互式资源。
使用方法
roxctl central generate interactive [flags]
$ roxctl central generate interactive [flags]
8.2.8.5. roxctl central generate k8s hostpath 复制链接链接已复制到粘贴板!
使用 hostpath 卷类型,生成 Kubernetes YAML 清单以部署 Central 实例。
使用方法
roxctl central generate k8s hostpath [flags]
$ roxctl central generate k8s hostpath [flags]
| 选项 | 描述 |
|---|---|
|
|
指定中央数据库主机上的路径。默认值为 |
|
|
指定 Central 数据库的节点选择器键。有效值包括 |
|
| 指定 Central 数据库的节点选择器值。 |
|
|
指定主机上的路径。默认值为 |
|
|
指定节点选择器键。有效值包括 |
|
| 指定节点选择器值。 |
8.2.8.6. roxctl central generate openshift pvc 复制链接链接已复制到粘贴板!
生成 OpenShift YAML 清单,以在 Central 中部署持久性卷声明(PVC)。
使用方法
roxctl central generate openshift pvc [flags]
$ roxctl central generate openshift pvc [flags]
| 选项 | 描述 |
|---|---|
|
|
指定 Central 数据库的外部卷名称。默认值为 |
|
|
为 Central 数据库指定外部卷大小(以 GB 为单位)。默认值为 |
|
| 指定 Central 数据库的存储类名称。如果您配置了默认存储类,则这是可选的。 |
|
|
指定 Central 的外部卷名称。默认值为 |
|
|
为 Central 指定外部卷大小(以 GB 为单位)。默认值为 |
|
| 指定 Central 的存储类名称。如果您配置了默认存储类,则这是可选的。 |
8.2.8.7. roxctl central generate openshift hostpath 复制链接链接已复制到粘贴板!
将 hostpath 外部卷添加到 Red Hat OpenShift 中的部署定义中。
使用方法
roxctl central generate openshift hostpath [flags]
$ roxctl central generate openshift hostpath [flags]
| 选项 | 描述 |
|---|---|
|
|
指定中央数据库主机上的路径。默认值为 |
|
|
指定节点选择器键。有效值包括 Central 数据库的 |
|
| 指定 Central 数据库的节点选择器值。 |
|
|
指定主机上的路径。默认值为 |
|
|
指定节点选择器键。有效值包括 |
|
| 指定节点选择器值。 |
8.2.9. roxctl central init-bundles 复制链接链接已复制到粘贴板!
在 Central 中初始化捆绑包。
使用方法
roxctl central init-bundles [flag]
$ roxctl central init-bundles [flag]
| 选项 | 描述 |
|---|---|
|
|
指定重试 API 请求超时。值 |
|
|
指定代表请求最长持续时间的 API 请求超时。默认值为 |
8.2.9.1. roxctl central init-bundles list 复制链接链接已复制到粘贴板!
列出 Central 中的可用初始化捆绑包。
使用方法
roxctl central init-bundles list [flags]
$ roxctl central init-bundles list [flags]
8.2.9.2. roxctl central init-bundles revoke 复制链接链接已复制到粘贴板!
在 Central 中撤销一个或多个集群初始化捆绑包。
使用方法
roxctl central init-bundles revoke <init_bundle_ID or name> [<init_bundle_ID or name> ...] [flags]
$ roxctl central init-bundles revoke <init_bundle_ID or name> [<init_bundle_ID or name> ...] [flags]
- 1
- 对于
<init_bundle_ID 或 name>,请指定您要撤销的初始化捆绑包的 ID 或名称。您可以使用空格提供多个 ID 或名称。
8.2.9.3. roxctl central init-bundles fetch-ca 复制链接链接已复制到粘贴板!
从 Central 获取证书颁发机构(CA)捆绑包。
使用方法
roxctl central init-bundles fetch-ca [flags]
$ roxctl central init-bundles fetch-ca [flags]
| 选项 | 描述 |
|---|---|
|
| 指定您要用来存储 CA 配置的文件。 |
8.2.9.4. roxctl central init-bundles generate 复制链接链接已复制到粘贴板!
生成新的集群初始化捆绑包。
使用方法
roxctl central init-bundles generate <init_bundle_name> [flags]
$ roxctl central init-bundles generate <init_bundle_name> [flags]
- 1
- 对于
<init_bundle_name>,请指定您要生成的初始化捆绑包的名称。
| 选项 | 描述 |
|---|---|
|
|
指定您要用来以 Helm 配置的形式存储新生成的初始化捆绑包的文件。您可以使用 |
|
|
指定您要用来以 Kubernetes secret 格式存储新生成的初始化捆绑包的文件。您可以使用 |
8.2.10. roxctl central userpki 复制链接链接已复制到粘贴板!
管理用户证书授权提供程序。
使用方法
roxctl central userpki [flags]
$ roxctl central userpki [flags]
8.2.10.1. roxctl central userpki list 复制链接链接已复制到粘贴板!
显示所有用户证书身份验证提供程序。
使用方法
roxctl central userpki list [flags]
$ roxctl central userpki list [flags]
| 选项 | 描述 |
|---|---|
|
|
启用 JSON 输出。默认值为 |
|
|
指定重试 API 请求超时。值为零表示整个请求持续时间都在不重试的情况下等待。默认值为 |
|
|
指定代表请求最长持续时间的 API 请求超时。默认值为 |
8.2.10.2. roxctl central userpki create 复制链接链接已复制到粘贴板!
创建新用户证书身份验证提供程序。
使用方法
roxctl central userpki create name [flags]
$ roxctl central userpki create name [flags]
| 选项 | 描述 |
|---|---|
|
| 指定 root CA 证书的 PEM 文件。您可以指定几个证书文件。 |
|
|
指定重试 API 请求超时。值为零表示整个请求持续时间都在不重试的情况下等待。默认值为 |
|
| 指定此提供程序用户的最小访问角色。 |
|
|
指定代表请求最长持续时间的 API 请求超时。默认值为 |
8.2.10.3. roxctl central userpki delete 复制链接链接已复制到粘贴板!
删除用户证书身份验证提供程序。
使用方法
roxctl central userpki delete id|name [flags]
$ roxctl central userpki delete id|name [flags]
| 选项 | 描述 |
|---|---|
|
|
如果设置为 |
|
|
指定重试 API 请求超时。值为零表示整个请求持续时间都在不重试的情况下等待。默认值为 |
|
|
指定代表请求最长持续时间的 API 请求超时。默认值为 |