4.3. Reference values#

Use this reference to look up values and defaults for the SCIM Client Helm Chart. The version shown below is the Helm Chart version used to generate the reference.

Name:

scim-client

Version:

0.55.4

Description:

A Helm chart for the Nubus SCIM client

You find the configuration options for scim-client in the following sections.

4.3.1. additionalAnnotations#

scim-client:additionalAnnotations#

Note

scim-client is a prefix to avoid name clashes for documentation cross-references. In your values.yaml file, use the key additionalAnnotations.

Additional custom annotations to add to all deployed objects.

Default value: {}

4.3.2. additionalLabels#

scim-client:additionalLabels#

Note

scim-client is a prefix to avoid name clashes for documentation cross-references. In your values.yaml file, use the key additionalLabels.

Additional custom labels to add to all deployed objects.

Default value: {}

4.3.3. containerSecurityContext#

containerSecurityContext.allowPrivilegeEscalation#

Enable container privileged escalation.

Default value: false

containerSecurityContext.capabilities.drop#

Default value: ["ALL"]

containerSecurityContext.enabled#

Enable security context.

Default value: true

containerSecurityContext.privileged#

Default value: false

containerSecurityContext.readOnlyRootFilesystem#

Mounts the container’s root file system as read-only.

Default value: true

containerSecurityContext.runAsGroup#

Process group id.

Default value: 1000

containerSecurityContext.runAsNonRoot#

Run container as a user.

Default value: true

containerSecurityContext.runAsUser#

Process user id.

Default value: 1000

containerSecurityContext.seccompProfile.type#

Disallow custom Seccomp profile by setting it to RuntimeDefault.

Default value: "RuntimeDefault"

4.3.4. extraEnvVars#

extraEnvVars#

Array with extra environment variables to add to containers. # extraEnvVars: - name: FOO value: “bar”

Default value: []

4.3.5. extraVolumeMounts#

extraVolumeMounts#

Optionally specify an extra list of additional volumeMounts.

Default value: []

4.3.6. extraVolumes#

extraVolumes#

Optionally specify an extra list of additional volumes.

Default value: []

4.3.7. global#

global.imagePullPolicy#

Define an ImagePullPolicy. # Ref.: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy #

Default value: null

global.imagePullSecrets#

Credentials to fetch images from private registry. Ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ # imagePullSecrets: - “docker-registry”

Default value: []

global.imageRegistry#

Container registry address.

Default value:

"artifacts.software-univention.de"
scim-client:global.secrets.masterPassword#

Note

scim-client is a prefix to avoid name clashes for documentation cross-references. In your values.yaml file, use the key global.secrets.masterPassword.

Default value: null

4.3.8. ldap#

ldap.auth.bindDn#

Bind distinguished name to authenticate with the LDAP Server.

Default value: null

ldap.auth.existingSecret.keyMapping.password#

The key to retrieve the password from. Setting this value allows to use a key with a different name.

Default value: null

ldap.auth.existingSecret.name#

The name of an existing Secret to use for retrieving the password to authenticate with the source LDAP directory. # “udm.auth.password” will be ignored if this value is set.

Default value: null

ldap.auth.password#

The password used to authenticate with the LDAP Server. Either this value or an existing Secret has to be specified.

Default value: null

ldap.connection.host#

LDAP Server hostname (e.g. “nubus-ldap-server”)

Default value: null

4.3.9. podSecurityContext#

podSecurityContext.enabled#

Enable security context.

Default value: true

podSecurityContext.fsGroup#

If specified, all processes of the container are also part of the supplementary group.

Default value: 1000

podSecurityContext.fsGroupChangePolicy#

Change ownership and permission of the volume before being exposed inside a Pod.

Default value: "Always"

podSecurityContext.sysctls#

Allow binding to ports below 1024 without root access.

Default value:

[{"name": "net.ipv4.ip_unprivileged_port_start", "value": "1"}]

4.3.10. provisioningApi#

provisioningApi.auth.existingSecret.keyMapping.password#

The key to retrieve the password from. Setting this value allows to use a key with a different name.

Default value: null

provisioningApi.auth.existingSecret.name#

The name of an existing Secret to use for retrieving the password to authenticate with the Provisioning API. # “provisioningApi.auth.password” will be ignored if this value is set.

Default value: null

provisioningApi.auth.password#

The password used to authenticate with the Provisioning API. Either this value or an existing Secret has to be specified.

Default value: null

provisioningApi.auth.username#

Username of the nubus provisioning subscription / this client For a given nubus deployment, all provisioning subscription names must be unique.

Default value: null

provisioningApi.config.maxAcknowledgementRetries#

The maximum number of retries for acknowledging a message

Default value: 3

provisioningApi.connection.url#

The base URL the provisioning API is reachable at. (e.g. “http://provisioning-api”)

Default value: null

4.3.11. resources#

resources.limits.cpu#

Default value: "4"

resources.limits.memory#

Default value: "4Gi"

resources.requests.cpu#

Default value: "250m"

resources.requests.memory#

Default value: "512Mi"

4.3.12. scimClient#

scimClient.config.dbConnectionString#

SQLAlchemy connection string for the SQL bookkeeping database.

Default value: ""

scimClient.config.externalIdGroupMapping#

Define external_id UDM attribute for groups

Default value: "univentionObjectIdentifier"

scimClient.config.externalIdUserMapping#

Define external_id UDM attribute for users

Default value: "univentionObjectIdentifier"

scimClient.config.groupSync#

Toggle experimental group provisioning support.

Default value: false

scimClient.config.logLevel#

The log level for the SCIM client. valid values are: ERROR WARNING, INFO, DEBUG

Default value: "INFO"

scimClient.config.prefill#

Toggle prefill for the provisioning subscription If activated, the client will receive a synthetic “create” event for all existing objects in the Domain before receiving live events.

Default value: true

scimClient.config.usernameMapping#

Define UDM attribute to use as SCIM userName (overrides default ‘username’)

Default value: "username"

scimClient.extraEnvVars#

Array with extra environment variables to add to containers. # extraEnvVars: - name: FOO value: “bar”

Default value: []

scimClient.image.pullPolicy#

Default value: ""

scimClient.image.registry#

Default value: ""

scimClient.image.repository#

Default value: "nubus/images/scim-client"

scimClient.image.sha256#

Define image sha256 as an alternative to tag

Default value: null

scimClient.image.tag#

Default value:

"0.55.4@sha256:a300912e9f77460fdc632f685e75dacfb43f9015d810b1b0f3cb3f182fcdd821"

4.3.13. scimServer#

scimServer.auth.basic.username#

The username used to authenticate with the SCIM Server via HTTP Basic Auth. Only used when “scimServer.auth.method” is “basic”.

Default value: null

scimServer.auth.existingSecret.keyMapping.password#

The key to retrieve the password from. Setting this value allows to use a key with a different name.

Default value: null

scimServer.auth.existingSecret.name#

The name of an existing Secret to use for retrieving the password to authenticate with the SCIM Server. # “scimServer.auth.password” will be ignored if this value is set.

Default value: null

scimServer.auth.method#

Authentication method to use against the downstream SCIM server. One of: “none”, “oidc”, “basic”, “bearer”.

Default value: null

scimServer.auth.oidc.clientId#

Service account client ID (username). Only used when “scimServer.auth.method” is “oidc”.

Default value: null

scimServer.auth.oidc.oidcTokenUrl#

URL to obtain an OIDC access token from the Identity Provider using the client-credentials-flow. Only used when “scimServer.auth.method” is “oidc”.

Default value: null

scimServer.auth.oidc.scopes#

List of additional scopes to send when requesting an OIDC authentication token. The scope openid will always be added even if the value is null. Only used when “scimServer.auth.method” is “oidc”.

Default value: null

scimServer.auth.password#

The secret used to authenticate with the SCIM Server: the OIDC client secret when method is “oidc”, the password when method is “basic”, or the static token when method is “bearer”. Not used when method is “none”. Either this value or an existing Secret has to be specified.

Default value: null

scimServer.connection.url#

The base URL the SCIM server is reachable at. (e.g. “http://scim-server”)

Default value: null

4.3.14. serviceAccount#

serviceAccount.annotations#

Annotations to add to the service account

Default value: {}

serviceAccount.automountServiceAccountToken#

#@param serviceAccount.automountServiceAccountToken Allows auto mount of ServiceAccountToken on the serviceAccount created #Can be set to false if pods using this serviceAccount do not need to use K8s API ##

Default value: false

serviceAccount.create#

Specifies whether a service account should be created

Default value: true

serviceAccount.labels#

Additional custom labels for the ServiceAccount.

Default value: {}

serviceAccount.name#

The name of the service account to use. If not set and create is true, a name is generated using the full name template

Default value: ""

4.3.15. tolerations#

tolerations#

Default value: []