8.6. roxctl declarative-config


管理声明性配置。

使用方法

$ roxctl declarative-config [command] [flags]
Copy to Clipboard Toggle word wrap

Expand
表 8.41. 可用命令
命令描述

create

创建声明配置。

lint

lint 现有声明性配置 YAML 文件。

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

Expand
选项描述

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

8.6.2. roxctl declarative-config lint

lint 现有声明性配置 YAML 文件。

使用方法

$ roxctl declarative-config lint [flags]
Copy to Clipboard Toggle word wrap

Expand
表 8.42. 选项
选项描述

--config-map 字符串

从- -config-map字符串中读取 声明性配置。如果没有指定,则从使用-file 标志指定的 YAML 文件中读取 配置。

-f,--file 字符串

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

--namespace string

从配置映射的- -namespace 字符串 中读取声明性配置。如果没有指定,则使用当前 Kubernetes 配置上下文中指定的命名空间。

--secret string

从指定的-- secret 字符串 中读取 声明配置。如果没有指定,则从使用-file 标志指定的 YAML 文件中读取 配置。

8.6.3. roxctl declarative-config create

创建声明配置。

使用方法

$ roxctl declarative-config create [flags]
Copy to Clipboard Toggle word wrap

Expand
表 8.43. 选项
选项描述

--config-map 字符串

在配置映射中编写声明性配置 YAML。如果没有指定,并且未指定-- secret 标志,则生成的 YAML 以标准输出格式打印。

--namespace string

如果要将声明性配置 YAML 写入配置映射或 secret,则需要此项。如果没有指定,则使用当前 Kubernetes 配置中的 default 命名空间。

--secret string

在 Secret 中编写声明性配置 YAML。您必须使用 secret 进行敏感数据。如果没有指定,并且未指定 -config-map 标志,则生成的 YAML 以标准输出格式打印。

8.6.3.1. roxctl declarative-config create role

为角色创建声明配置。

使用方法

$ roxctl declarative-config create role [flags]
Copy to Clipboard Toggle word wrap

Expand
表 8.44. 选项
选项描述

--access-scope string

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

--description 字符串

为角色设置描述。

--name string

指定角色的名称。

--permission-set string

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

8.6.3.2. roxctl declarative-config create notifier

为通知程序创建声明配置。

使用方法

$ roxctl declarative-config create notifier [flags]
Copy to Clipboard Toggle word wrap

Expand
表 8.45. 选项
选项描述

--name string

指定通知程序的名称。

8.6.3.3. roxctl declarative-config create access-scope

为访问范围创建声明配置。

使用方法

$ roxctl declarative-config create access-scope [flags]
Copy to Clipboard Toggle word wrap

Expand
表 8.46. 选项
选项描述

--cluster-label-selector requirement

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

--description 字符串

为访问范围设置描述。

--included included-object

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

--name string

指定访问范围的名称。

--namespace-label-selector requirement

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

8.6.3.4. roxctl declarative-config create auth-provider

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

使用方法

$ roxctl declarative-config create auth-provider [flags]
Copy to Clipboard Toggle word wrap

Expand
表 8.47. 选项
选项描述

--extra-ui-endpoints strings

指定使用身份验证供应商的额外用户界面(UI)端点。预期的格式是 < endpoint>:<port>

--groups-key string

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

--groups-role 字符串

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

--groups-value 字符串

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

--minimum-access-role string

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

--name string

指定身份验证供应商的名称。

--required-attributes stringToString

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

--ui-endpoint string

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

8.6.3.5. roxctl declarative-config create permission-set

为权限集创建声明配置。

使用方法

$ roxctl declarative-config create permission-set [flags]
Copy to Clipboard Toggle word wrap

Expand
表 8.48. 选项
选项描述

--description 字符串

设置权限集的描述。

--name string

指定权限集的名称。

--resource-with-access stringToString

设置具有各自访问级别的资源列表。默认值为 []。如需了解更多详细信息,请运行 roxctl declarative-config create permission-set --help 命令。

8.6.3.6. roxctl declarative-config create notifier mvapich

为 mvapich 通知程序创建声明配置。

使用方法

$ roxctl declarative-config create notifier splunk [flags]
Copy to Clipboard Toggle word wrap

Expand
表 8.49. 选项
选项描述

--audit-logging

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

--source-types stringToString

将 Splunk 源类型指定为用逗号分开的 key=value 对。默认值为 []

--splunk-endpoint string

指定 Splunk HTTP 端点。这是强制选项。

--splunk-skip-tls-verify

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

--Splunk-token 字符串

指定 Splunk HTTP 令牌。这是强制选项。

--truncate int

指定 Splunk truncate 限制。默认值为 10000

8.6.3.7. roxctl declarative-config create notifier generic

为通用通知程序创建声明配置。

使用方法

$ roxctl declarative-config create notifier generic [flags]
Copy to Clipboard Toggle word wrap

Expand
表 8.50. 选项
选项描述

--audit-logging

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

--extra-fields stringToString

以逗号分隔的 key=value 对形式指定其他字段。默认值为 []

--headers stringToString

将标头指定为用逗号分开的 key=value 对。默认值为 []

--webhook-cacert-file string

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

--webhook-endpoint string

指定 Webhook 端点的 URL。

--webhook-password string

指定 webhook 端点基本身份验证的密码。如果没有指定身份验证,则不会进行身份验证。requires --webhook-username

--webhook-skip-tls-verify

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

--webhook-username string

指定 webhook 端点基本身份验证的用户名。如果没有指定身份验证,则不会进行身份验证。requires --webhook-password.

8.6.3.8. roxctl declarative-config create auth-provider iap

使用身份感知代理(IAP)标识符为身份验证供应商创建声明配置。

使用方法

$ roxctl declarative-config create auth-provider iap [flags]
Copy to Clipboard Toggle word wrap

Expand
表 8.51. 选项
选项描述

--audience string

指定您要验证的目标组。

为 OpenID Connect (OIDC)身份验证供应商创建声明配置。

使用方法

$ roxctl declarative-config create auth-provider oidc [flags]
Copy to Clipboard Toggle word wrap

Expand
表 8.52. 选项
选项描述

--claim-mappings stringToString

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

--client-id string

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

--client-secret string

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

--disable-offline-access

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

--issuer string

指定 OIDC 客户端的签发者。

--mode string

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

为 SAML 身份验证提供程序创建声明配置。

使用方法

$ roxctl declarative-config create auth-provider saml [flags]
Copy to Clipboard Toggle word wrap

Expand
表 8.53. 选项
选项描述

--idp-cert string

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

--IdP-issuer string

指定 IdP 的签发者。

--metadata-url string

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

--name-id-format string

指定名称 ID 的格式。

--SP-issuer 字符串

指定服务供应商的签发者。

--SSO-url 字符串

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

为用户 PKI 身份验证提供程序创建声明配置。

使用方法

$ roxctl declarative-config create auth-provider userpki [flags]
Copy to Clipboard Toggle word wrap

Expand
表 8.54. 选项
选项描述

--ca-file string

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

为 OpenShift Container Platform OAuth 身份验证供应商创建声明配置。

使用方法

$ roxctl declarative-config create auth-provider openshift-auth [flags]
Copy to Clipboard Toggle word wrap

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

Theme

© 2025 Red Hat