16.3. Declarative configuration examples
You can create declarative configurations by using the following examples as a guide. Use the roxctl declarative-config lint command to verify that your configurations are valid.
16.3.1. Declarative configuration authentication provider example
링크 복사링크가 클립보드에 복사되었습니다!
Declarative configuration authentication provider example
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: truewhere:
minimumRole-
Specifies the minimum role that will be assigned by default to any user logging in. If left blank, the value is
None. uiEndpoint- Specifies the user interface endpoint of your Central instance.
extraUIEndpoints- Specifies whether your Central instance is exposed to different endpoints.
groups- Specifies the specific roles to map users based on their attributes.
groups.key- Specifies the key that can be any claim returned from the authentication provider.
groups.role- Specifies the role that the users are given. You can use a default role or a declaratively-created role.
requiredAttributes- Specifies whether the attributes returned from the authentication provider are required, for example, if the audience is limited to a specific organization or group. This is optional.
claimMappings- Specifies whether the claims returned from the identity provider should be mapped to custom claims. This is optional.
oidc- Specifies whether the system is configured to use OpenID Connect (OIDC) as an authentication method.
oidc.issuer- Specifies the expected issuer for the token.
oidc.mode-
Specifies the OIDC callback mode. Possible values are
auto,post,query, andfragment. The preferred value isauto. iap- Specifies whether the system is configured to use Google Identity-Aware Proxy (IAP) as an authentication method.
saml- Specifies whether the system is configured to use Security Assertion Markup Language (SAML) 2.0 dynamic or static configuration as an authentication method.
saml.cert- Specifies the certificate in Privacy Enhanced Mail (PEM) format.
userpki.certificateAuthorities- Specifies whether the system is configured for authentication with user certificates.
userpki.certificate- Specifies the certificate in PEM format.
openshift- Specifies whether the system is configured for OpenShift Auth authentication providers.
16.3.2. Declarative configuration short-lived token example
링크 복사링크가 클립보드에 복사되었습니다!
Declarative configuration short-lived token example
issuer: https://token.actions.githubusercontent.com
type: GITHUB_ACTION
tokenExpirationDuration: 20m
mappings:
- key: sub
value: repos:stackrox:stackrox
role: Analystwhere:
issuer- Specifies the expected issuer for the token to exchange against a short-lived one.
type- Specifies the configuration type. See "Configuring short-lived access" and "Integrating RHACS using short-lived access tokens" for more information.
tokenExpirationDuration- Specifies the token lifetime in the XhYmZs format. The lifetime cannot be longer than 24 hours.
mappings- Specifies the roles to which users are mapped, based on their attributes.
mappings.key- Specifies that the key can be any claim returned from the issuer.
mappings.role- Specifies the role that the users are given. You can use a default role or a declaratively-created one.
16.3.3. Declarative configuration permission set example
링크 복사링크가 클립보드에 복사되었습니다!
Declarative configuration permission set example
name: A sample permission set
description: A sample permission set created declaratively
resources:
- resource: Integration
access: READ_ACCESS
- resource: Administration
access: READ_WRITE_ACCESSwhere:
resources.resource-
Specifies a full list of supported resources. For more information, go to Access Control
Permission Sets. resources.access-
Specifies that the access can be either
READ_ACCESSorREAD_WRITE_ACCESS.
16.3.4. Declarative configuration access scope example
링크 복사링크가 클립보드에 복사되었습니다!
Declarative configuration access scope example
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
- environmentwhere:
rules.included.cluster- Specifies a cluster where only specific namespaces are included within the access scope.
rules.included.cluster- Specifies a cluster where all namespaces are included within the access scope.
rules.clusterLabelSelectors.requirements.operator-
Specifies the Operator to use for the label selection. Valid values are
IN,NOT_IN,EXISTS, andNOT_EXISTS.
16.3.5. Declarative configuration role example
링크 복사링크가 클립보드에 복사되었습니다!
Declarative configuration role example
name: A sample role
description: A sample role created declaratively
permissionSet: A sample permission set
accessScope: Unrestrictedwhere:
permissionSet- Specifies the name of the permission set; can be either one of the system permission sets or a declaratively-created permission set.
accessScope- Specifies the name of the access scope; can be either one of the system access scopes or a declaratively-created access scope.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}