7.9. roxctl 镜像


您可以在特定镜像上运行的命令。

使用方法

$ roxctl image [command] [flags]

表 7.61. 可用命令
命令描述

check

检查镜像是否有构建策略违反情况,并报告它们。

sbom

从镜像扫描生成 SPDX 2.3 SBOM。您必须具有 Image 资源的写入权限。

scan

扫描指定的镜像,并返回扫描结果。

表 7.62. 选项
-t,--timeout 持续时间为代表请求最长持续时间的 API 请求设置超时。默认值为 10m0s

7.9.1. roxctl image 命令选项从父命令继承

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

选项描述

--ca string

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

--direct-grpc

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

-e,--endpoint 字符串

设置要联系的服务的端点。另外,您可以使用 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 字符串

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

--plaintext

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

-S,--server-name 字符串

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

--token-file string

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

注意

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

7.9.2. roxctl image sbom

从镜像扫描生成 SPDX 2.3 SBOM。您必须具有 Image 资源的写入权限。

使用方法

$ roxctl image sbom [flags]

表 7.63. 选项
选项描述

-f, --force

绕过镜像的 Central 缓存,并强制从扫描程序进行新的拉取。默认值为 false

-d, --retry-delay integer

设置重试之间等待的时间(以秒为单位)。默认值为 3。

-i, --image string

镜像名称和引用,如 nginx:latestnginx@sha256:…​

-r, --retries integer

设置 Scanner V4 在退出并显示错误前应重试的次数。默认值为 3。

7.9.3. roxctl 镜像扫描

扫描指定的镜像,并返回扫描结果。

使用方法

$ roxctl image scan [flags]

表 7.64. 选项
选项描述

--cluster string

指定要委派镜像扫描的集群名称或 ID。

--compact-output

以紧凑格式打印 JSON 输出。默认值为 false

--fail

如果发现漏洞,失败。默认值为 false

-f,--force

忽略 Central 的缓存,并强制从 Scanner 中重新拉取。默认值为 false

--headers 字符串

指定要在表格输出中打印的标头。默认值包括 COMPONENTVERSIONCVE、VSEER ITY 和 LINK

--headers-as-comments

在 CSV 表格输出中将标头作为注释打印。默认值为 false

-i,--image 字符串

指定镜像名称并引用扫描。例如: nginx:latestnginx@sha256:…​

-a,--include-snoozed

在扫描结果中包括 snoozed 和 unsnoozed CVE。默认值为 false

--merge-output

在表格输出中合并重复的单元。默认值为 true

--no-header

不要打印表格输出的标头。默认值为 false

-o,--output string

指定输出格式。输出格式包括 csvjsonsarif

-r,--retries int

指定在退出作为错误前重试次数。默认值为 3

-d,--retry-delay int

设置重试之间等待的时间(以秒为单位)。默认值为 3

--row-jsonpath-expressions string

指定 JSON 路径表达式,以从 JSON 对象创建行。如需了解更多详细信息,请运行 roxctl image scan --help 命令。

--severity string

输出中要包含的严重性列表。使用它来过滤特定严重性。默认值包括 LOWMODERATEIMPORTANTCRITICAL

7.9.4. roxctl 镜像检查

检查镜像是否有构建策略违反情况,并报告它们。

使用方法

$ roxctl image check [flags]

表 7.65. 选项
选项描述

-c,--categories 字符串

要执行的策略类别列表。默认情况下使用所有策略类别。

--cluster string

定义您要用作评估上下文的集群名称或 ID。

--compact-output

以紧凑格式打印 JSON 输出。默认值为 false

-f,--force

绕过镜像的 Central 缓存,并强制从 Scanner 中进行新的拉取。默认值为 false

--headers 字符串

定义要在表格输出中打印的标头。默认值包括 POLICY、SESEER ITY、BREAKS BUILDDESCRIPTIONVIOLATIONREMEDIATION

--headers-as-comments

在 CSV 表格输出中将标头作为注释打印。默认值为 false

-i,--image 字符串

指定镜像名称和引用。例如: nginx:latestnginx@sha256:…​)

--jUnit-suite-name string

设置 JUnit 测试套件的名称。默认值为 image-check

--merge-output

在表格输出中合并重复的单元。默认值为 false

--no-header

不要打印表格输出的标头。默认值为 false

-o,--output string

选择输出格式。输出格式包括 junitsariftablecsvjson。默认值为 table

-r,--retries int

在退出作为错误前设置重试次数。默认值为 3

-d,--retry-delay int

设置重试之间等待的时间(以秒为单位)。默认值为 3

--row-jsonpath-expressions string

使用 JSON 路径表达式从 JSON 对象创建一个行。如需了解更多详细信息,请运行 roxctl image check --help 命令。

--send-notifications

定义是否在违反事件中发送通知。默认值为 false

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat, Inc.