OpenShift installation

To deploy Containerized Masking engine via Openshift, ensure you have access to a running OpenShift cluster and the oc command-line interface for cluster interactions.

Requirements Recommended version
Oc 4.11.3 or above
Openshift Cluster 4.12 or above

Install the oc CLI using the official Red Hat documentation: Getting Started. Make sure your system has the required network permissions to authenticate and connect to the OpenShift cluster.

Procedure

  1. Log in to OpenShift

    Authenticate the OpenShift CLI with your cluster:

    Copy 
    oc login https://openshift1.example.com -u=<<user_name>> -p=<<password>>

  2. Verify KubeConfig

    Confirm that the cluster context is correctly added and active. This ensures the CLI is pointing to the appropriate OpenShift cluster before deployment.

    Copy 
    oc config current-context

  3. Create a new project

    Provision and use a new OpenShift project (namespace) for the deployment:

    Copy 
    oc new-project <<project_name>> --description="optional" --display-name="<<display_name>>"
    oc project <<project_name>>

  4. Deploy the Containerized Masking Engine configuration

    Copy 
    oc apply -f <file_name>

    The pod configuration and deployment workflow align with the standard Kubernetes-based setup. Refer to the main Containerized Masking Installation page for the required configuration files and additional implementation details.

Accessing the Containerized Masking UI via browser

For streamlined access, configure the service exposing the masking engine as a NodePort. Once the pods are in a running state, the containerized masking UI can be accessed using the following URL patterns:

  • Application UI

    Copy 
    https://<Internal IP of the node>:<https port>/masking/app

  • API Client

    Copy 
    https://<Internal IP of the node>:<https port>/masking/api-client

To retrieve the internal IP address of the node, run:

Copy 
oc get nodes -o wide

Containerized Masking engine logs

All containerized masking engine components emit logs to stdout and stderr, enabling native log collection and processing within OpenShift.

To view logs for any running pod, use:

Copy 
oc logs <pod_name>