8.6. roxctl declarative-config


宣言型設定を管理します。

使用方法

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

Expand
表8.41 利用可能なコマンド
コマンド説明

create

宣言型設定を作成します。

lint

既存の宣言型設定 YAML ファイルを lint します。

8.6.1. 親コマンドから継承された roxctl declarative-config コマンドオプション

roxctl declarative-config コマンドは、roxctl の親コマンドから継承された次のオプションをサポートします。

Expand
オプション説明

--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

Basic 認証のパスワードを指定します。あるいは、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 コマンドのすべてのサブコマンドに適用されます。

8.6.2. roxctl declarative-config lint

既存の宣言型設定 YAML ファイルを lint します。

使用方法

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

Expand
表8.42 オプション
オプション説明

--config-map string

--config-map string から宣言型設定を読み取ります。指定しない場合、設定は --file フラグを使用して指定された YAML ファイルから読み取られます。

-f, --file string

YAML 形式の宣言型設定を含むファイル。

--namespace string

設定マップの --namespace string から宣言型設定を読み取ります。指定しない場合、現在の Kubernetes 設定コンテキストで指定された namespace が使用されます。

--secret string

指定された --secret string から、宣言型設定を読み取ります。指定しない場合、設定は --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 string

設定マップに宣言型設定 YAML を書き込みます。指定されず、--secret フラグも指定されていない場合、生成された YAML は標準出力形式で出力されます。

--namespace string

宣言型設定 YAML を設定マップまたはシークレットに書き込む場合は必須です。指定しない場合は、現在の Kubernetes 設定のデフォルトの namespace が使用されます。

--secret string

Secret に宣言型設定 YAML を記述します。機密データにはシークレットを使用する必要があります。指定されず、--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 string

ロールの説明を設定します。

--name string

ロールの名前を指定します。

--permission-set string

名前を指定すると、参照される権限セットを指定できます。

8.6.3.2. roxctl declarative-config create notifier

Notifier の宣言型設定を作成します。

使用方法

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

Expand
表8.45 オプション
オプション説明

--name string

Notifier の名前を指定します。

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 string

アクセススコープの説明を設定します。

--included included-object

アクセススコープに含めるクラスターとその namespace のリストを指定します。デフォルト値は [null] です。

--name string

アクセススコープの名前を指定します。

--namespace-label-selector requirement

namespace のラベルに基づいてラベルセレクターを作成するための基準を指定します。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 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> です。

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 string

権限セットの説明を設定します。

--name string

権限セットの名前を指定します。

--resource-with-access stringToString

リソースのリストとそれぞれのアクセスレベルを設定します。デフォルト値は [] です。詳細は、roxctl declarative-config create permission-set --help コマンドを実行してください。

8.6.3.6. roxctl declarative-config create notifier splunk

Splunk Notifier の宣言型設定を作成します。

使用方法

$ 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 string

Splunk HTTP トークンを指定します。これは必須のオプションです。

--truncate int

Splunk の切り捨て制限を指定します。デフォルト値は 10000 です。

8.6.3.7. roxctl declarative-config create notifier generic

汎用 Notifier の宣言型設定を作成します。

使用方法

$ 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

エンドポイント CA 証明書のファイル名を PEM 形式で指定します。

--webhook-endpoint string

Webhook エンドポイントの URL を指定します。

--webhook-password string

Webhook エンドポイントの Basic 認証用のパスワードを指定します。指定されない場合、認証は行われません。--webhook-username が必要です。

--webhook-skip-tls-verify

Webhook TLS 検証をスキップします。デフォルト値は false です。

--webhook-username string

Webhook エンドポイントの Basic 認証のユーザー名を指定します。指定しない場合、認証は行われません。--webhook-password が必要です。

8.6.3.8. roxctl declarative-config create auth-provider iap

Identity-Aware Proxy (IAP) 識別子を使用して、認証プロバイダーの宣言型設定を作成します。

使用方法

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

Expand
表8.51 オプション
オプション説明

--audience string

検証するターゲットグループを指定します。

8.6.3.9. roxctl declarative-config create auth-provider oidc

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 クライアントのクライアントシークレットを指定します。

--disable-offline-access

OIDC IdP からの offline_access のリクエストを無効にします。OIDC IdP が offline_access スコープのセッション数を制限する場合は、このオプションを使用する必要があります。デフォルト値は false です。

--issuer string

OIDC クライアントの発行者を指定します。

--mode string

使用するコールバックモードを指定します。有効な値には、autopostquery、および fragment が含まれます。デフォルト値は auto です。

8.6.3.10. roxctl declarative-config create auth-provider saml

SAML 認証プロバイダーの宣言型設定を作成します。

使用方法

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

Expand
表8.53 オプション
オプション説明

--idp-cert string

SAML アイデンティティープロバイダー (IdP) 証明書を含むファイルを PEM 形式で指定します。

--idp-issuer string

IdP の発行者を指定します。

--metadata-url string

サービスプロバイダーのメタデータ URL を指定します。

--name-id-format string

名前 ID の形式を指定します。

--sp-issuer string

サービスプロバイダーの発行者を指定します。

--sso-url string

シングルサインオン (SSO) 用の IdP の URL を指定します。

8.6.3.11. roxctl declarative-config create auth-provider userpki

ユーザー PKI 認証プロバイダーの宣言型設定を作成します。

使用方法

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

Expand
表8.54 オプション
オプション説明

--ca-file string

認証局を含むファイルを PEM 形式で指定します。

8.6.3.12. roxctl declarative-config create auth-provider openshift-auth

OpenShift Container Platform OAuth 認証プロバイダーの宣言型設定を作成します。

使用方法

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

Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2026 Red Hat
トップに戻る