2.3. Provisioning subscription#
The SCIM Client receives user and user group changes from the Nubus Provisioning Service through a subscription. Configure a separate client and subscription for each SCIM target. For an example with two targets, see Multiple SCIM targets.
In the setup described in this manual, the SCIM Client Helm Chart creates a secret with the registration data for its subscription. The Nubus deployment uses this data to register the client with the Provisioning Service.
2.3.1. Configure a subscription#
To configure a provisioning subscription,
you need to register the consumer.
Add the configuration in Listing 2.5
to the nubus-values.yaml file for your existing Nubus deployment.
If nubusProvisioning.registerConsumers.createUsers already exists,
add the scimClient entry to it and keep the existing entries.
The configuration references the registration entry in the scim-client-provisioning secret.
This entry contains the subscription name, topics, prefill setting, and password.
nubusProvisioning:
registerConsumers:
createUsers:
scimClient:
existingSecret:
name: scim-client-provisioning
keyMapping:
registration: "registration"
After you have prepared the Helm Chart files nubus-values.yaml
and scim-client-values.yaml, continue with Installation.
Important
Enabling scimClient.config.groupSync adds the groups/group topic
to the provisioning subscription.
If the client is already registered for users only,
create a subscription with a different subscription name.
Set provisioningApi.auth.username to an unused name,
for example scim-client-groups, in scim-client-values.yaml.
To register the subscription for both users and user groups, apply both Helm updates in Installation through Helm. The previous subscription remains registered and can accumulate unprocessed messages.
After you have verified the new subscription for users and user groups, remove the previous subscription after the SCIM Client has processed its pending messages or the subscription is no longer needed. To delete a subscription, use DELETE /v1/subscriptions/{name} in Nubus - Customization and Modification Manual 1.x [2]. The documentation also explains API access and administrative credentials. Deleting a subscription discards its remaining queued messages.
2.3.2. Multiple SCIM targets#
This section describes how you set up SCIM Client for multiple SCIM targets. For each additional SCIM target, prepare a separate client values file as described in Prepare the client configuration. Configure the target’s URL and authentication credentials, and use a separate PostgreSQL database for each client. The clients can share the same LDAP connection and existing LDAP secret.
Use a different Helm release name for each client in the Nubus namespace.
The following example uses the releases scim-client-a and scim-client-b.
It uses the chart’s default resource names
and creates registration secrets from provisioningApi.auth.password.
Leave nameOverride, fullnameOverride,
and provisioningApi.auth.existingSecret.name unset for this example.
Define the subscription credentials in
scim-client-a-values.yamlandscim-client-b-values.yaml, as shown in Listing 2.6 and Listing 2.7. Subscription names must be unique within the Nubus deployment.Replace the following placeholders, including the angle brackets:
SUBSCRIPTION_PASSWORD_Awith the subscription password for client A.SUBSCRIPTION_PASSWORD_Bwith the subscription password for client B.
These release names produce the registration secrets
scim-client-a-provisioningandscim-client-b-provisioning.provisioningApi: auth: username: "scim-client-a" password: "<SUBSCRIPTION_PASSWORD_A>"
provisioningApi: auth: username: "scim-client-b" password: "<SUBSCRIPTION_PASSWORD_B>"
Add a separate consumer entry for each secret in
nubus-values.yaml, as shown in Listing 2.8. Keep all existing consumer entries. The entry namesscimClientAandscimClientBmust also be distinct.nubusProvisioning: registerConsumers: createUsers: scimClientA: existingSecret: name: "scim-client-a-provisioning" keyMapping: registration: "registration" scimClientB: existingSecret: name: "scim-client-b-provisioning" keyMapping: registration: "registration"
Prepare the environment variables in Installation through Helm. Then install both client releases with their respective values files, as shown in Listing 2.9.
$ helm upgrade \ --install \ scim-client-a \ --namespace "$NUBUS_NAMESPACE" \ oci://artifacts.software-univention.de/nubus/charts/scim-client \ --version "$SCIM_CLIENT_HELM_VERSION" \ --values scim-client-a-values.yaml $ helm upgrade \ --install \ scim-client-b \ --namespace "$NUBUS_NAMESPACE" \ oci://artifacts.software-univention.de/nubus/charts/scim-client \ --version "$SCIM_CLIENT_HELM_VERSION" \ --values scim-client-b-values.yaml
After you install both clients, apply the Nubus update in Listing 2.12 once to register both subscriptions. Retain any additional Nubus values files as described in those instructions. To verify the deployment status of each client, follow Verify deployment status and use the corresponding release name in place of
scim-client.