4.4. Configuration for Nubus for Kubernetes#

Use this reference to configure the OX Connector on Nubus for Kubernetes. This page uses the published OX Connector Helm Chart to provide the Helm Chart values reference.

4.4.1. Configure a database#

Added in version v0.41.0: Add in OX Connector for Kubernetes version v.0.41.0.

To support the shared accounts feature, the OX Connector requires a PostgreSQL database to store account references. PostgreSQL is the only tested and supported database for the OX Connector. The database isn’t part of the OX App Suite packaged and the OX Connector integration. You need to provide it separately.

Before you install or upgrade to a version ≥ 0.41.0, ensure the following requirements for the database for the OX Connector in PostgreSQL:

  • You have created an empty database for the OX Connector.

  • You have created a dedicated database user for the OX Connector with the ALL PRIVILEGES privilege.

For information about how to configure the database connection, see openXchange.oxDbConnectionString in Prepare the OX Consumer configuration.

4.4.2. Delete or disable users#

Added in version v0.47.0.

The Helm Chart value openXchange.deleteNonOxUsers changes how the OX Connector handles the unchecked checkbox Activate User in OX. Set one of the following values:

true

Delete the user. When a user was previously provisioned as an OX user, the user is now deleted. This may delete user data such as calendars.

false

Disable the user. When a user was previously provisioned as an OX user, the user is kept, but disabled. The OX Connector will only delete a user in OX if the user is actually deleted in UDM.

The default value is true.

4.4.3. Helm Chart references values#

Name:

ox-connector

Version:

0.48.0

Description:

A Helm chart for the ox-connector

You find the configuration options for ox-connector in the following sections.

4.4.4. affinity#

affinity#

Pod affinity rules for the OX Connector workload.

Default value: {}

4.4.5. environment#

environment#

Additional environment variables for deployment templates.

Default value: {}

4.4.6. extraVolumeMounts#

extraVolumeMounts#

Optionally specify an extra list of additional volumeMounts.

Default value: []

4.4.7. extraVolumes#

extraVolumes#

Optionally specify an extra list of additional volumes.

Default value: []

4.4.8. fullnameOverride#

fullnameOverride#

Override the fully qualified chart name.

Default value: ""

4.4.9. global#

global.imagePullPolicy#

Image pull policy for all container images that don’t define their own pull policy. For details, see https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy.

Default value: null

global.imagePullSecrets#

Credentials to fetch images from a private registry. For details, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/.

Default value: []

global.imageRegistry#

Container registry address.

Default value:

"artifacts.software-univention.de"

4.4.10. nameOverride#

nameOverride#

Override the chart name.

Default value: ""

4.4.11. nodeSelector#

nodeSelector#

Node selector for scheduling the OX Connector pod.

Default value: {}

4.4.12. openXchange#

openXchange.auth.existingSecret.keyMapping.password#

Key in the existing Secret that contains the OX Admin password. Set this value to use a key with a different name.

Default value: null

openXchange.auth.existingSecret.name#

Name of an existing Secret that contains the OX Admin password. The value in “openXchange.auth.password” is ignored if this value is set.

Default value: null

openXchange.auth.password#

Password of the OX Admin user.

Default value: null

openXchange.auth.username#

Username of the OX Admin user. The OX Admin user can create, modify, and delete contexts and must already exist.

Default value: "oxadminmaster"

openXchange.database.existingSecret.keyMapping.OX_CONNECTOR_DB#

Key in the existing Secret that holds the connection URL. Defaults to the key the chart uses in its own Secret.

Default value: null

openXchange.database.existingSecret.name#

Name of an existing Secret that contains the SQLAlchemy DB connection URL. The value in “openXchange.oxDbConnectionString” is ignored if this value is set. Providing the URL this way keeps the database password out of the rendered manifests.

Default value: null

openXchange.deleteNonOxUsers#

Delete users from OX when “Activate User in OX” is unchecked. When disabled, the user is deactivated (if it existed) instead.

Default value: true

openXchange.domainName#

OX mail domain that the connector uses to generate email addresses.

Default value: null

openXchange.logLevel#

OX Connector log level. Choose from “DEBUG”, “INFO”, “WARNING”, and “ERROR”.

Default value: "INFO"

openXchange.mappings.groupIdentifier#

UDM group property that the connector uses as the unique group identifier in OX.

Default value: "name"

openXchange.mappings.sharedAccountIdentifier#

UDM shared account property that the connector uses as the unique shared account identifier in OX.

Default value: "name"

openXchange.mappings.userIdentifier#

UDM user property that the connector uses as the unique user identifier in OX.

Default value: "username"

openXchange.oxDbConnectionString#

SQLAlchemy DB connection URL for the OX connector. Ignored if “openXchange.database.existingSecret.name” is set.

Default value: null

openXchange.oxDefaultContext#

Default OX context for users. The context must already exist.

Default value: "10"

openXchange.oxDeputyPermissions#

Enable provisioning of OX deputy permissions.

Default value: false

openXchange.oxImapServer#

Default IMAP server for new users if no IMAP server is set on the user object.

Default value: null

openXchange.oxLanguage#

Default language for new users.

Default value: "de_DE"

openXchange.oxLocalTimezone#

Default time zone for new users.

Default value: "Europe/Berlin"

openXchange.oxSharedAccount#

Enable provisioning of OX shared accounts.

Default value: true

openXchange.oxSmtpServer#

Default SMTP server for new users if no SMTP server is set on the user object.

Default value: null

openXchange.oxSoapServer#

Server where OX App Suite is installed.

Default value: null

openXchange.stopOnError#

OX Connector error handling behavior. When activated, the connector stops processing on the first error instead of continuing.

Default value: false

4.4.13. oxConnector#

oxConnector.extraEnvVars#

Array with extra environment variables to add to containers.

Default value: []

oxConnector.image.pullPolicy#

Image pull policy for the OX Connector container image.

Default value: null

oxConnector.image.registry#

Container registry for the OX Connector image.

Default value: null

oxConnector.image.repository#

Repository of the OX Connector image.

Default value:

"nubus/images/ox-connector-standalone"
oxConnector.image.tag#

Tag of the OX Connector image.

Default value:

"0.48.0@sha256:a116062a743cb2b4ba014e36fa0f4966e3ada94d529f5c123b7e8c39dc037a57"

4.4.14. persistence#

persistence.size#

Persistent volume claim size.

Default value: "1Gi"

persistence.storageClass#

Storage class name. Leave empty to use the default storage class.

Default value: ""

4.4.15. podAnnotations#

podAnnotations#

Additional annotations for the OX Connector pod.

Default value: {}

4.4.16. podSecurityContext#

podSecurityContext.fsGroup#

File system group ID for mounted volumes.

Default value: 1000

podSecurityContext.runAsGroup#

Group ID for the OX Connector pod.

Default value: 1000

podSecurityContext.runAsNonRoot#

Require the OX Connector pod to run as a non-root user.

Default value: true

podSecurityContext.runAsUser#

User ID for the OX Connector pod.

Default value: 1000

podSecurityContext.seccompProfile.type#

Seccomp profile type for the OX Connector pod.

Default value: "RuntimeDefault"

4.4.17. probes#

probes.liveness.exec.command#

Command for the liveness probe.

Default value: ["/bin/sh", "-c", "exit 0\n"]

probes.liveness.failureThreshold#

Number of failed liveness probes before Kubernetes restarts the container.

Default value: 3

probes.liveness.initialDelaySeconds#

Initial delay in seconds before the liveness probe starts.

Default value: 120

probes.liveness.periodSeconds#

Interval in seconds between liveness probe executions.

Default value: 30

probes.liveness.successThreshold#

Number of successful liveness probes required to mark the container healthy.

Default value: 1

probes.liveness.timeoutSeconds#

Timeout in seconds for the liveness probe.

Default value: 3

probes.readiness.exec.command#

Command for the readiness probe.

Default value: ["/bin/sh", "-c", "exit 0\n"]

probes.readiness.failureThreshold#

Number of failed readiness probes before Kubernetes marks the container not ready.

Default value: 30

probes.readiness.initialDelaySeconds#

Initial delay in seconds before the readiness probe starts.

Default value: 30

probes.readiness.periodSeconds#

Interval in seconds between readiness probe executions.

Default value: 15

probes.readiness.successThreshold#

Number of successful readiness probes required to mark the container ready.

Default value: 1

probes.readiness.timeoutSeconds#

Timeout in seconds for the readiness probe.

Default value: 3

4.4.18. provisioningApi#

provisioningApi.auth.existingSecret.keyMapping.password#

Key in the existing Secret that contains the password. Set this value to use a key with a different name.

Default value: null

provisioningApi.auth.existingSecret.name#

Name of an existing Secret that contains the Provisioning API password. The value in “provisioningApi.auth.password” is ignored if this value is set.

Default value: null

provisioningApi.auth.password#

Password for authenticating to the Provisioning API.

Default value: null

provisioningApi.auth.username#

Username for authenticating to the Provisioning API.

Default value: "ox-consumer"

provisioningApi.config.maxAcknowledgementRetries#

Maximum number of retries for acknowledging a message.

Default value: 3

provisioningApi.connection.baseUrl#

Base URL where the Provisioning API is reachable, for example “https://provisioning-api”.

Default value: ""

provisioningApi.resync.auth.existingSecret.keyMapping.password#

Key in the existing Secret that contains the admin password. Set this value to use a key with a different name.

Default value: null

provisioningApi.resync.auth.existingSecret.name#

Name of an existing Secret that contains the Provisioning API admin password. The value in “provisioningApi.resync.auth.password” is ignored if this value is set.

Default value: null

provisioningApi.resync.auth.password#

Admin password for authenticating to the Provisioning API during resync.

Default value: null

provisioningApi.resync.auth.username#

Admin username for authenticating to the Provisioning API during resync.

Default value: "admin"

provisioningApi.resync.enabled#

Enable database resync on the first startup if the database is empty.

Default value: true

4.4.19. replicaCount#

replicaCount#

Number of OX Connector replicas.

Default value: 1

4.4.20. resources#

resources.limits.cpu#

CPU limit for the OX Connector container.

Default value: "4"

resources.limits.memory#

Memory limit for the OX Connector container.

Default value: "4Gi"

resources.requests.cpu#

Requested CPU for the OX Connector container.

Default value: "250m"

resources.requests.memory#

Requested memory for the OX Connector container.

Default value: "512Mi"

4.4.21. resourcesWaitForDependency#

resourcesWaitForDependency.limits.cpu#

CPU limit for dependency waiter containers.

Default value: "200m"

resourcesWaitForDependency.limits.memory#

Memory limit for dependency waiter containers.

Default value: "128Mi"

resourcesWaitForDependency.requests.cpu#

Requested CPU for dependency waiter containers.

Default value: "100m"

resourcesWaitForDependency.requests.memory#

Requested memory for dependency waiter containers.

Default value: "64Mi"

4.4.22. securityContext#

securityContext.allowPrivilegeEscalation#

Allow privilege escalation in the OX Connector container.

Default value: false

securityContext.capabilities.drop#

Linux capabilities to drop from the OX Connector container.

Default value: ["ALL"]

securityContext.privileged#

Run the OX Connector container in privileged mode.

Default value: false

securityContext.readOnlyRootFilesystem#

Mount the OX Connector container root filesystem as read-only.

Default value: true

securityContext.runAsGroup#

Group ID for the OX Connector container.

Default value: 1000

securityContext.runAsNonRoot#

Require the OX Connector container to run as a non-root user.

Default value: true

securityContext.runAsUser#

User ID for the OX Connector container.

Default value: 1000

securityContext.seccompProfile.type#

Seccomp profile type for the OX Connector container.

Default value: "RuntimeDefault"

4.4.23. serviceAccount#

serviceAccount.annotations#

Additional annotations for the service account.

Default value: {}

serviceAccount.automountServiceAccountToken#

Allow automatic mounting of the service account token.

Default value: false

serviceAccount.create#

Create a service account for the OX Connector.

Default value: true

serviceAccount.labels#

Additional custom labels for the ServiceAccount.

Default value: {}

serviceAccount.name#

Service account name. If this value is empty and “serviceAccount.create” is true, the chart generates a name from the fullname template.

Default value: ""

4.4.24. tolerations#

tolerations#

Tolerations for scheduling the OX Connector pod.

Default value: []

4.4.25. waitForDependency#

waitForDependency.image.pullPolicy#

Image pull policy for the dependency waiter image.

Default value: null

waitForDependency.image.registry#

Container registry for the dependency waiter image.

Default value: null

waitForDependency.image.repository#

Repository of the dependency waiter image.

Default value:

"nubus/images/wait-for-dependency"
waitForDependency.image.tag#

Tag of the dependency waiter image.

Default value:

"0.36.17@sha256:7bd68c29709d7519967fe507c47ebd88434ba8125a0793e0f77a55af0367da0d"