16.3. 宣言的な設定例
次の例をガイドとして使用して、宣言型設定を作成できます。roxctl declarative-config lint
コマンドを使用して、設定が有効であることを確認します。
16.3.1. 宣言型設定認証プロバイダーの例
宣言型設定認証プロバイダーの例
name: A sample auth provider minimumRole: Analyst uiEndpoint: central.custom-domain.com:443 extraUIEndpoints: - central-alt.custom-domain.com:443 groups: - key: email value: example@example.com role: Admin - key: groups value: reviewers role: Analyst requiredAttributes: - key: org_id value: "12345" claimMappings: - path: org_id value: my_org_id oidc: issuer: sample.issuer.com mode: auto clientID: CLIENT_ID clientSecret: CLIENT_SECRET clientSecret: CLIENT_SECRET iap: audience: audience saml: spIssuer: sample.issuer.com metadataURL: sample.provider.com/metadata saml: spIssuer: sample.issuer.com cert: | ssoURL: saml.provider.com idpIssuer: idp.issuer.com userpki: certificateAuthorities: | certificate openshift: enable: true
name: A sample auth provider
minimumRole: Analyst
uiEndpoint: central.custom-domain.com:443
extraUIEndpoints:
- central-alt.custom-domain.com:443
groups:
- key: email
value: example@example.com
role: Admin
- key: groups
value: reviewers
role: Analyst
requiredAttributes:
- key: org_id
value: "12345"
claimMappings:
- path: org_id
value: my_org_id
oidc:
issuer: sample.issuer.com
mode: auto
clientID: CLIENT_ID
clientSecret: CLIENT_SECRET
clientSecret: CLIENT_SECRET
iap:
audience: audience
saml:
spIssuer: sample.issuer.com
metadataURL: sample.provider.com/metadata
saml:
spIssuer: sample.issuer.com
cert: |
ssoURL: saml.provider.com
idpIssuer: idp.issuer.com
userpki:
certificateAuthorities: |
certificate
openshift:
enable: true
- 1
- ログインしているユーザーにデフォルトで割り当てられる最小限のロールを指定します。空白のままにすると、値は
None
になります。 - 2
- Central インスタンスのユーザーインターフェイスエンドポイントを使用します。
- 3
- Central インスタンスが別のエンドポイントに公開されている場合は、ここで指定します。
- 4
- これらのフィールドは、属性に基づいてユーザーを特定のロールにマップします。
- 5
- キーには、認証プロバイダーから返された任意のクレームを指定できます。
- 6
- ユーザーに与えられるロールを識別します。デフォルトのロールまたは宣言的に作成されたロールを使用できます。
- 7
- オプション: 認証プロバイダーから返された属性が必要な場合は、これらのフィールドを使用します。たとえば、対象者が特定の組織やグループに限定されている場合などです。
- 8
- オプション: アイデンティティープロバイダーから返されたクレームをカスタムクレームにマップする必要がある場合は、これらのフィールドを使用します。
- 9
- このセクションは、OpenID Connect (OIDC) 認証プロバイダーの場合にのみ必要です。
- 10
- トークンの予想される発行者を識別します。
- 11
- OIDC コールバックモードを識別します。可能な値は、
auto
、post
、query
、およびfragment
です。推奨される値はauto
です。 - 12
- このセクションは、Google Identity-Aware Proxy (IAP) 認証プロバイダーの場合にのみ必要です。
- 13
- このセクションは、Security Assertion Markup Language (SAML) 2.0 動的設定認証プロバイダーの場合にのみ必要です。
- 14
- このセクションは、SAML 2.0 静的設定認証プロバイダーの場合にのみ必要です。
- 15
- 証明書を Privacy Enhanced Mail (PEM) 形式で含めます。
- 16
- このセクションは、ユーザー証明書による認証の場合にのみ必要です。
- 17
- PEM 形式の証明書を含めます。
- 18
- このセクションは、OpenShift Auth 認証プロバイダーにのみ必要です。
16.3.2. 宣言的な設定権限セットの例
宣言的な設定権限セットの例
name: A sample permission set description: A sample permission set created declaratively resources: - resource: Integration access: READ_ACCESS - resource: Administration access: READ_WRITE_ACCESS
name: A sample permission set
description: A sample permission set created declaratively
resources:
- resource: Integration
access: READ_ACCESS
- resource: Administration
access: READ_WRITE_ACCESS
16.3.3. 宣言型設定のアクセス範囲の例
宣言型設定のアクセス範囲の例
name: A sample access scope description: A sample access scope created declaratively rules: included: - cluster: secured-cluster-A namespaces: - namespaceA - cluster: secured-cluster-B clusterLabelSelectors: - requirements: - requirements: - key: kubernetes.io/metadata.name operator: IN values: - production - staging - environment
name: A sample access scope
description: A sample access scope created declaratively
rules:
included:
- cluster: secured-cluster-A
namespaces:
- namespaceA
- cluster: secured-cluster-B
clusterLabelSelectors:
- requirements:
- requirements:
- key: kubernetes.io/metadata.name
operator: IN
values:
- production
- staging
- environment
16.3.4. 宣言型設定ロールの例
宣言型設定ロールの例
name: A sample role description: A sample role created declaratively permissionSet: A sample permission set accessScope: Unrestricted
name: A sample role
description: A sample role created declaratively
permissionSet: A sample permission set
accessScope: Unrestricted