×

roxctl declarative-config 命令选项继承自父命令

roxctl declarative-config 命令支持从父 roxctl 命令继承的以下选项

选项 (Option) 描述 (Description)

--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 declarative-config命令的所有子命令。

roxctl declarative-config lint

检查现有的声明式配置 YAML 文件。

用法 (Usage)
$ roxctl declarative-config lint [flags]
表 2. 选项
选项 (Option) 描述 (Description)

--config-map string

--config-map string读取声明式配置。如果未指定,则从使用--file标志指定的 YAML 文件中读取配置。

-f, --file string

包含 YAML 格式声明式配置的文件。

--namespace string

从配置映射的--namespace string读取声明式配置。如果未指定,则使用当前 Kubernetes 配置上下文中的命名空间。

--secret string

从指定的--secret string读取声明式配置。如果未指定,则从使用--file标志指定的 YAML 文件中读取配置。

roxctl declarative-config create

创建声明式配置。

用法 (Usage)
$ roxctl declarative-config create [flags]
表 3. 选项
选项 (Option) 描述 (Description)

--config-map string

将声明式配置 YAML 写入配置映射中。如果未指定且--secret标志也未指定,则生成的 YAML 将以标准输出格式打印。

--namespace string

如果您想将声明式配置 YAML 写入配置映射或密钥中,则这是必需的。如果未指定,则使用当前 Kubernetes 配置中的默认命名空间。

--secret string

将声明式配置 YAML 写入 Secret 中。对于敏感数据,必须使用密钥。如果未指定且--config-map标志也未指定,则生成的 YAML 将以标准输出格式打印。

roxctl declarative-config create role

创建角色的声明式配置。

用法 (Usage)
$ roxctl declarative-config create role [flags]
表 4. 选项
选项 (Option) 描述 (Description)

--access-scope string

通过提供名称,您可以指定引用的访问范围。

--description string

为角色设置描述。

--name string

指定角色的名称。

--permission-set string

通过提供名称,您可以指定引用的权限集。

roxctl declarative-config create notifier

创建通知器的声明式配置。

用法 (Usage)
$ roxctl declarative-config create notifier [flags]
表 5. 选项
选项 (Option) 描述 (Description)

--name string

指定通知器的名称。

roxctl declarative-config create access-scope

创建访问范围的声明式配置。

用法 (Usage)
$ roxctl declarative-config create access-scope [flags]
表 6. 选项
选项 (Option) 描述 (Description)

--cluster-label-selector requirement

指定基于集群标签创建标签选择器的条件。键值对表示需求,您可以多次使用此标志来创建需求组合。默认值为[ [ ] ]。有关更多详细信息,请运行roxctl declarative-config create access-scope --help命令。

--description string

为访问范围设置描述。

--included included-object

指定要在访问范围中包含的集群及其命名空间列表。默认值为[null]

--name string

指定访问范围的名称。

--namespace-label-selector requirement

指定基于命名空间标签创建标签选择器的条件。与 cluster-label-selector 类似,您可以多次使用此标志来创建需求组合。有关更多详细信息,请运行roxctl declarative-config create access-scope --help命令。

roxctl declarative-config create auth-provider

创建身份验证提供程序的声明式配置。

用法 (Usage)
$ roxctl declarative-config create auth-provider [flags]
表 7. 选项
选项 (Option) 描述 (Description)

--extra-ui-endpoints strings

指定身份验证提供程序使用的其他用户界面 (UI) 端点。预期格式为<endpoint>:<port>

--groups-key strings

设置要在身份验证提供程序中添加的组的键。键、值和角色的元组应具有相同的长度。有关更多详细信息,请运行roxctl declarative-config create auth-provider --help命令。

--groups-role strings

设置要在身份验证提供程序中添加的组的角色。键、值和角色的元组应具有相同的长度。有关更多详细信息,请运行roxctl declarative-config create auth-provider --help命令。

--groups-value strings

设置要在身份验证提供程序中添加的组的值。键、值和角色的元组应具有相同的长度。有关更多详细信息,请运行roxctl declarative-config create auth-provider --help命令。

--minimum-access-role string

设置身份验证提供程序的最低访问角色。如果您不想使用声明式配置来配置最低访问角色,则可以将此字段留空。

--name string

指定身份验证提供程序的名称。

--required-attributes stringToString

设置身份验证提供程序必须在身份验证期间返回的属性列表。默认值为[]

--ui-endpoint string

设置使用身份验证提供程序的 UI 端点。这通常是 RHACS 可用的公共端点。预期格式为<endpoint>:<port>

roxctl declarative-config create permission-set

创建权限集的声明式配置。

用法 (Usage)
$ roxctl declarative-config create permission-set [flags]
表 8. 选项
选项 (Option) 描述 (Description)

--description string

设置权限集的描述。

--name string

指定权限集的名称。

--resource-with-access stringToString

设置资源列表及其相应的访问级别。默认值为[]。更多详情,请运行roxctl declarative-config create permission-set --help命令。

roxctl declarative-config create notifier splunk

创建一个用于Splunk通知器的声明式配置。

用法 (Usage)
$ roxctl declarative-config create notifier splunk [flags]
表9. 选项
选项 (Option) 描述 (Description)

--audit-logging

启用审计日志记录。默认值为false

--source-types stringToString

指定Splunk源类型,以逗号分隔的key=value键值对形式。默认值为[]

--splunk-endpoint string

指定Splunk HTTP端点。这是必填选项。

--splunk-skip-tls-verify

使用非安全连接到Splunk。默认值为false

--splunk-token string

指定Splunk HTTP令牌。这是必填选项。

--truncate int

指定Splunk截断限制。默认值为10000

roxctl declarative-config create notifier generic

创建一个用于通用通知器的声明式配置。

用法 (Usage)
$ roxctl declarative-config create notifier generic [flags]
表10. 选项
选项 (Option) 描述 (Description)

--audit-logging

启用审计日志记录。默认值为false

--extra-fields stringToString

指定附加字段,以逗号分隔的key=value键值对形式。默认值为[]

--headers stringToString

指定报头,以逗号分隔的key=value键值对形式。默认值为[]

--webhook-cacert-file string

指定端点CA证书的PEM格式文件名。

--webhook-endpoint string

指定Webhook端点的URL。

--webhook-password string

指定Webhook端点基本身份验证的密码。如果未指定,则无需身份验证。需要--webhook-username

--webhook-skip-tls-verify

跳过Webhook TLS验证。默认值为false

--webhook-username string

指定Webhook端点基本身份验证的用户名。如果未指定,则无需身份验证。需要--webhook-password

roxctl declarative-config create auth-provider iap

创建一个使用身份感知代理(IAP)标识符的身份验证提供程序的声明式配置。

用法 (Usage)
$ roxctl declarative-config create auth-provider iap [flags]
表11. 选项
选项 (Option) 描述 (Description)

--audience string

指定要验证的目标组。

roxctl declarative-config create auth-provider oidc

创建一个用于OpenID Connect (OIDC)身份验证提供程序的声明式配置。

用法 (Usage)
$ roxctl declarative-config create auth-provider oidc [flags]
表12. 选项
选项 (Option) 描述 (Description)

--claim-mappings stringToString

指定要包含在身份验证提供程序规则中的一组来自身份提供者(IdP)令牌的非标准声明。默认值为[]

--client-id string

指定OIDC客户端的客户端ID。

--client-secret string

指定OIDC客户端的客户端密钥。

--disable-offline-access

禁用对OIDC IdP的offline_access请求。如果OIDC IdP限制了具有offline_access范围的会话数量,则需要使用此选项。默认值为false

--issuer string

指定OIDC客户端的发行者。

--mode string

指定要使用的回调模式。有效值包括autopostqueryfragment。默认值为auto

roxctl declarative-config create auth-provider saml

创建一个用于SAML身份验证提供程序的声明式配置。

用法 (Usage)
$ roxctl declarative-config create auth-provider saml [flags]
表13. 选项
选项 (Option) 描述 (Description)

--idp-cert string

指定包含PEM格式SAML身份提供者(IdP)证书的文件。

--idp-issuer string

指定IdP的发行者。

--metadata-url string

指定服务提供商的元数据URL。

--name-id-format string

指定名称ID的格式。

--sp-issuer string

指定服务提供商的发行者。

--sso-url string

指定IdP用于单点登录(SSO)的URL。

roxctl declarative-config create auth-provider userpki

创建一个用于用户PKI身份验证提供程序的声明式配置。

用法 (Usage)
$ roxctl declarative-config create auth-provider userpki [flags]
表14. 选项
选项 (Option) 描述 (Description)

--ca-file string

指定包含PEM格式证书颁发机构的文件。

roxctl declarative-config create auth-provider openshift-auth

创建一个用于OpenShift Container Platform OAuth身份验证提供程序的声明式配置。

用法 (Usage)
$ roxctl declarative-config create auth-provider openshift-auth [flags]