Prepare Your Environment

  1. Check the Kubernetes cluster is ready
  2. Obtain the OUD container image
  3. Create a persistent volume directory
  4. Setup the code repository to deploy OUD

Check the Kubernetes cluster is ready

As per the Prerequisites a Kubernetes cluster should have already been configured.

  1. Run the following command on the master node to check the cluster and worker nodes are running:

    $ kubectl get nodes,pods -n kube-system

    The output will look similar to the following:

    NAME                  STATUS   ROLES                  AGE   VERSION
node/worker-node1     Ready    <none>                 17h   v1.28.3+3.el8
node/worker-node2     Ready    <none>                 17h   v1.28.3+3.el8
node/master-node      Ready    control-plane,master   23h   v1.28.3+3.el8

NAME                                     READY   STATUS    RESTARTS   AGE
pod/coredns-66bff467f8-fnhbq             1/1     Running   0          23h
pod/coredns-66bff467f8-xtc8k             1/1     Running   0          23h
pod/etcd-master                          1/1     Running   0          21h
pod/kube-apiserver-master-node           1/1     Running   0          21h
pod/kube-controller-manager-master-node  1/1     Running   0          21h
pod/kube-flannel-ds-amd64-lxsfw          1/1     Running   0          17h
pod/kube-flannel-ds-amd64-pqrqr          1/1     Running   0          17h
pod/kube-flannel-ds-amd64-wj5nh          1/1     Running   0          17h
pod/kube-proxy-2kxv2                     1/1     Running   0          17h
pod/kube-proxy-82vvj                     1/1     Running   0          17h
pod/kube-proxy-nrgw9                     1/1     Running   0          23h
pod/kube-scheduler-master                1/1     Running   0          21h

Obtain the OUD container image

The OUD Kubernetes deployment requires access to an OUD container image. The image can be obtained in the following ways:

  • Prebuilt OUD container image
  • Build your own OUD container image using WebLogic Image Tool

Prebuilt OUD container image

The prebuilt OUD July 2024 container image can be downloaded from Oracle Container Registry. This image is prebuilt by Oracle and includes Oracle Unified Directory 12.2.1.4.0, the July Patch Set Update (PSU) and other fixes released with the Critical Patch Update (CPU) program..

Note: Before using this image you must login to Oracle Container Registry, navigate to Middleware > oud_cpu and accept the license agreement.

You can use this image in the following ways:

  • Pull the container image from the Oracle Container Registry automatically during the OUD Kubernetes deployment.
  • Manually pull the container image from the Oracle Container Registry and then upload it to your own container registry.
  • Manually pull the container image from the Oracle Container Registry and manually stage it on the master node and each worker node.

Build your own OUD container image using WebLogic Image Tool

You can build your own OUD container image using the WebLogic Image Tool. This is recommended if you need to apply one off patches to a Prebuilt OUD container image. For more information about building your own container image with WebLogic Image Tool, see Create or update image.

You can use an image built with WebLogic Image Tool in the following ways:

  • Manually upload them to your own container registry.
  • Manually stage them on the master node and each worker node.

Note: This documentation does not tell you how to pull or push the above images into a private container registry, or stage them on the master and worker nodes. Details of this can be found in the Enterprise Deployment Guide.

Create a persistent volume directory

Note: This section should not be followed if using block storage.

As referenced in Prerequisites the nodes in the Kubernetes cluster must have access to a persistent volume such as a Network File System (NFS) mount or a shared file system.

In this example /scratch/shared/ is a shared directory accessible from all nodes.

  1. On the master node run the following command to create a user_projects directory:

    $ cd <persistent_volume>
$ mkdir oud_user_projects   
$ sudo chown -R 1000:0 oud_user_projects

    For example:

    $ cd /scratch/shared
$ mkdir oud_user_projects   
$ sudo chown -R 1000:0 oud_user_projects

  2. On the master node run the following to ensure it is possible to read and write to the persistent volume:

    $ cd <persistent_volume>/oud_user_projects
$ touch file.txt
$ ls filemaster.txt

    For example:

    $ cd /scratch/shared/oud_user_projects
$ touch filemaster.txt
$ ls filemaster.txt

    On the first worker node run the following to ensure it is possible to read and write to the persistent volume:

    $ cd /scratch/shared/oud_user_projects
$ ls filemaster.txt
$ touch fileworker1.txt
$ ls fileworker1.txt

    Repeat the above for any other worker nodes e.g fileworker2.txt etc. Once proven that it’s possible to read and write from each node to the persistent volume, delete the files created.

Setup the code repository to deploy OUD

Oracle Unified Directory deployment on Kubernetes leverages deployment scripts provided by Oracle for creating Oracle Unified Directory containers using the Helm charts provided. To deploy Oracle Unified Directory on Kubernetes you should set up the deployment scripts as below:

  1. Create a working directory to setup the source code.

    $ mkdir <workdir>

    For example:

    $ mkdir /scratch/shared/OUDContainer

  2. Download the latest OUD deployment scripts from the OUD repository:

    $ cd <workdir>
$ git clone https://github.com/oracle/fmw-kubernetes.git --branch release/24.3.1

    For example:

    $ cd /scratch/shared/OUDContainer
$ git clone https://github.com/oracle/fmw-kubernetes.git --branch release/24.3.1

  3. Set the $WORKDIR environment variable as follows:

    $ export WORKDIR=<workdir>/fmw-kubernetes/OracleUnifiedDirectory

    For example:

    $ export WORKDIR=/scratch/shared/OUDContainer/fmw-kubernetes/OracleUnifiedDirectory

    You are now ready to create the OUD deployment as per Create OUD instances.