$ roxctl declarative-config [command] [flags]
管理声明式配置。
$ roxctl declarative-config [command] [flags]
命令 (Command) | 描述 (Description) |
---|---|
|
创建声明式配置。 |
|
检查现有的声明式配置 YAML 文件。 |
roxctl declarative-config
命令支持从父 roxctl
命令继承的以下选项
选项 (Option) | 描述 (Description) |
---|---|
|
指定用于安全连接的自定义 CA 证书文件路径。或者,您可以使用 `ROX_CA_CERT_FILE` 环境变量指定文件路径。 |
|
设置 `--direct-grpc` 以提高连接性能。或者,通过将 `ROX_DIRECT_GRPC_CLIENT` 环境变量设置为 `true`,您可以启用直接 gRPC。默认值为 `false`。 |
|
设置要联系的服务的端点。或者,您可以使用 `ROX_ENDPOINT` 环境变量设置端点。默认值为 `localhost:8443`。 |
|
强制所有连接使用 HTTP/1。或者,通过将 |
|
启用不安全连接选项。或者,通过将 |
|
跳过 TLS 证书验证。或者,通过将 |
|
禁用彩色输出。或者,通过将 |
|
指定基本身份验证的密码。或者,您可以使用 |
|
使用未加密的连接。或者,通过将 |
|
设置用于 SNI 的 TLS 服务器名称。或者,您可以使用 |
|
使用指定文件中提供的 API 令牌进行身份验证。或者,您可以使用 |
这些选项适用于 |
检查现有的声明式配置 YAML 文件。
$ roxctl declarative-config lint [flags]
选项 (Option) | 描述 (Description) |
---|---|
|
从 |
|
包含 YAML 格式声明式配置的文件。 |
|
从配置映射的 |
|
从指定的 |
创建声明式配置。
$ roxctl declarative-config create [flags]
选项 (Option) | 描述 (Description) |
---|---|
|
将声明式配置 YAML 写入配置映射中。如果未指定且 |
|
如果您想将声明式配置 YAML 写入配置映射或密钥中,则这是必需的。如果未指定,则使用当前 Kubernetes 配置中的默认命名空间。 |
|
将声明式配置 YAML 写入 Secret 中。对于敏感数据,必须使用密钥。如果未指定且 |
创建角色的声明式配置。
$ roxctl declarative-config create role [flags]
选项 (Option) | 描述 (Description) |
---|---|
|
通过提供名称,您可以指定引用的访问范围。 |
|
为角色设置描述。 |
|
指定角色的名称。 |
|
通过提供名称,您可以指定引用的权限集。 |
创建通知器的声明式配置。
$ roxctl declarative-config create notifier [flags]
选项 (Option) | 描述 (Description) |
---|---|
|
指定通知器的名称。 |
创建访问范围的声明式配置。
$ roxctl declarative-config create access-scope [flags]
选项 (Option) | 描述 (Description) |
---|---|
|
指定基于集群标签创建标签选择器的条件。键值对表示需求,您可以多次使用此标志来创建需求组合。默认值为 |
|
为访问范围设置描述。 |
|
指定要在访问范围中包含的集群及其命名空间列表。默认值为 |
|
指定访问范围的名称。 |
|
指定基于命名空间标签创建标签选择器的条件。与 cluster-label-selector 类似,您可以多次使用此标志来创建需求组合。有关更多详细信息,请运行 |
创建身份验证提供程序的声明式配置。
$ roxctl declarative-config create auth-provider [flags]
选项 (Option) | 描述 (Description) |
---|---|
|
指定身份验证提供程序使用的其他用户界面 (UI) 端点。预期格式为 |
|
设置要在身份验证提供程序中添加的组的键。键、值和角色的元组应具有相同的长度。有关更多详细信息,请运行 |
|
设置要在身份验证提供程序中添加的组的角色。键、值和角色的元组应具有相同的长度。有关更多详细信息,请运行 |
|
设置要在身份验证提供程序中添加的组的值。键、值和角色的元组应具有相同的长度。有关更多详细信息,请运行 |
|
设置身份验证提供程序的最低访问角色。如果您不想使用声明式配置来配置最低访问角色,则可以将此字段留空。 |
|
指定身份验证提供程序的名称。 |
|
设置身份验证提供程序必须在身份验证期间返回的属性列表。默认值为 |
|
设置使用身份验证提供程序的 UI 端点。这通常是 RHACS 可用的公共端点。预期格式为 |
创建权限集的声明式配置。
$ roxctl declarative-config create permission-set [flags]
选项 (Option) | 描述 (Description) |
---|---|
|
设置权限集的描述。 |
|
指定权限集的名称。 |
|
设置资源列表及其相应的访问级别。默认值为 |
创建一个用于Splunk通知器的声明式配置。
$ roxctl declarative-config create notifier splunk [flags]
选项 (Option) | 描述 (Description) |
---|---|
|
启用审计日志记录。默认值为 |
|
指定Splunk源类型,以逗号分隔的 |
|
指定Splunk HTTP端点。这是必填选项。 |
|
使用非安全连接到Splunk。默认值为 |
|
指定Splunk HTTP令牌。这是必填选项。 |
|
指定Splunk截断限制。默认值为 |
创建一个用于通用通知器的声明式配置。
$ roxctl declarative-config create notifier generic [flags]
选项 (Option) | 描述 (Description) |
---|---|
|
启用审计日志记录。默认值为 |
|
指定附加字段,以逗号分隔的 |
|
指定报头,以逗号分隔的 |
|
指定端点CA证书的PEM格式文件名。 |
|
指定Webhook端点的URL。 |
|
指定Webhook端点基本身份验证的密码。如果未指定,则无需身份验证。需要 |
|
跳过Webhook TLS验证。默认值为 |
|
指定Webhook端点基本身份验证的用户名。如果未指定,则无需身份验证。需要 |
创建一个使用身份感知代理(IAP)标识符的身份验证提供程序的声明式配置。
$ roxctl declarative-config create auth-provider iap [flags]
选项 (Option) | 描述 (Description) |
---|---|
|
指定要验证的目标组。 |
创建一个用于OpenID Connect (OIDC)身份验证提供程序的声明式配置。
$ roxctl declarative-config create auth-provider oidc [flags]
选项 (Option) | 描述 (Description) |
---|---|
|
指定要包含在身份验证提供程序规则中的一组来自身份提供者(IdP)令牌的非标准声明。默认值为 |
|
指定OIDC客户端的客户端ID。 |
|
指定OIDC客户端的客户端密钥。 |
|
禁用对OIDC IdP的offline_access请求。如果OIDC IdP限制了具有 |
|
指定OIDC客户端的发行者。 |
|
指定要使用的回调模式。有效值包括 |
创建一个用于SAML身份验证提供程序的声明式配置。
$ roxctl declarative-config create auth-provider saml [flags]
选项 (Option) | 描述 (Description) |
---|---|
|
指定包含PEM格式SAML身份提供者(IdP)证书的文件。 |
|
指定IdP的发行者。 |
|
指定服务提供商的元数据URL。 |
|
指定名称ID的格式。 |
|
指定服务提供商的发行者。 |
|
指定IdP用于单点登录(SSO)的URL。 |