2.4. Installation#

This page describes how to install and update the SCIM Client. Before you start, make sure that you completed the following sections:

The SCIM Client and Nubus for Kubernetes use separate Helm releases. Install the SCIM Client in the same Kubernetes namespace as Nubus for Kubernetes.

Use the scim-client-values.yaml and nubus-values.yaml files prepared in the previous sections. For an example with multiple SCIM targets, see Multiple SCIM targets.

The SCIM Client has its own Helm Chart, separate from your existing Nubus deployment. Before you install the client, prepare the settings for both charts in Helm Chart values files. Helm uses these files when installing or updating the components.

The installation consists of the following steps:

  1. Prepare the scim-client-values.yaml file with connection and authentication details for the following systems:

    • SCIM target

    • Provisioning API

    • LDAP Server

    • PostgreSQL database

    For the required settings, see Mandatory values.

  2. Add the subscription configuration to the nubus-values.yaml file for your existing Nubus deployment so that the client can receive user changes. If you enable group synchronization, the client can also receive user group changes. For more information, see Provisioning subscription.

  3. Install the client first, then update Nubus to register the subscription, as described in Installation through Helm. The commands in those instructions apply the values files prepared in the previous steps.

2.4.1. Installation through Helm#

To install the SCIM Client through Helm, use the following steps.

  1. Prepare the environment variables with the commands in Listing 2.10:

    • For your existing Nubus for Kubernetes deployment, set the following environment variables to their respective values:

      NUBUS_NAMESPACE:

      the namespace

      RELEASE_NAME_FOR_NUBUS:

      the Helm release name

      NUBUS_HELM_VERSION:

      the Helm Chart version

    • Set SCIM_CLIENT_HELM_VERSION to the version of the SCIM Client Helm Chart that you want to install.

    Tip

    You can find the installed chart version in the CHART column of helm list --namespace <namespace>.

    When you use the same Nubus Helm Chart version, Helm applies the subscription configuration without upgrading Nubus to a different version.

    Listing 2.10 Prepare environment variables for the installation#
    $ export NUBUS_NAMESPACE="<Your Nubus for Kubernetes namespace>"
    $ export RELEASE_NAME_FOR_NUBUS="<The release name of your Nubus installation>"
    $ export SCIM_CLIENT_HELM_VERSION="<The SCIM Client Helm Chart version to install>"
    $ export NUBUS_HELM_VERSION="<The Helm Chart version of your Nubus installation>"
    
  2. To install or update the SCIM Client, run the commands in Listing 2.11.

    Listing 2.11 Install or update the SCIM Client#
    $ helm upgrade \
        --install \
        scim-client \
        --namespace "$NUBUS_NAMESPACE" \
        oci://artifacts.software-univention.de/nubus/charts/scim-client \
        --version "$SCIM_CLIENT_HELM_VERSION" \
        --values scim-client-values.yaml
    
  3. To register the subscription in Nubus for Kubernetes, run the commands in Listing 2.12.

    If you don’t configure an existing provisioning secret, the client chart creates the registration secret needed for the Nubus update. The --install option installs Nubus if the specified Nubus Helm release doesn’t exist.

    Important

    If your Nubus deployment uses additional values files, repeat --values for each file, for example --values nubus-values.yaml --values prod_values.yaml. Keep the files in the same order.

    Listing 2.12 Update Nubus and register the subscription#
    $ helm upgrade \
        --install \
        "$RELEASE_NAME_FOR_NUBUS" \
        --namespace "$NUBUS_NAMESPACE" \
        oci://artifacts.software-univention.de/nubus/charts/nubus \
        --version "$NUBUS_HELM_VERSION" \
        --values nubus-values.yaml
    

2.4.2. Verify deployment status#

To verify the deployment status of the SCIM Client, run the command in Listing 2.13.

Expect READY to show 1/1 and AVAILABLE to show 1. This confirms that Kubernetes reports an available client instance. It doesn’t verify data synchronization with the SCIM target.

The client may need a few minutes to start, for example while Kubernetes downloads the container image. If READY shows 0/1 or AVAILABLE shows 0, wait a few minutes and run the command again. If the client remains unavailable, see Troubleshooting.

To also verify the synchronization with the SCIM target, follow the optional test-user check in Check provisioning.

Listing 2.13 Check the SCIM Client deployment (example output)#
$ kubectl get deployment scim-client --namespace "$NUBUS_NAMESPACE"

NAME          READY   UP-TO-DATE   AVAILABLE   AGE
scim-client   1/1     1            1           2m