Introduction to the Kubernetes Operator

Note

• The CTE for Kubernetes feature is supported with CTE for Kubernetes v1.2.0 and subsequent versions.

• CTE for Kubernetes is certified with Redhat and supported for Openshift Container Platform for CTE for Kubernetes v1.2.0 and subsequent versions.

Kubernetes has various default resources like Pod, Deployment, DaemonSet, etc. When you define a manifest for instantiating one of those resources, you must specify the Kind as Pod/Deployment/DaemonSet etc. Kubernetes provides a default set of controllers that understand the resource definitions and know how to manage their life cycle. For instance, the Deployment Controller manages the Create/Update/Delete of the Deployment resource.

Kubernetes architecture allows users to extend the API server in a way that users can create their own custom resource (CR) and write their own controller to manage the custom resource. An operator bundles a CR and the Controller that manages the CR. An operator can watch resources across the cluster and take actions when required. For more information on how to use operators to manage other applications, refer to the Kubernetes Operator pattern.

The CTE for Kubernetes Operator can deploy, monitor, upgrade and delete CTE for Kubernetes. When the CTE for Kubernetes Operator is deployed, its controller deploys the CTE for Kubernetes driver on the OpenShift cluster. The manifests required to deploy the CTE-K8s driver are bundled with the operator.

CTE for Kubernetes Operator

The CTE for Kubernetes Operator is an Openshift operator that Thales created for CTE for Kubernetes. This operator contains a CR, an API for managing a CR, and a custom controller that manages this resource. When you install the CTE for Kubernetes Operator on an OpenShift cluster, the operator registers the new CR and the controller with the Kubernetes API server. Whenever the API server receives a request to create a resource, where Kind=CTEK8sOperator, it passes on the request CTE for Kubernetes Operator’s Custom Controller. The controller contains all of the logic needed to complete tasks before, during or after the deployment of the CTE for Kubernetes driver.

You can deploy CTE for Kubernetes using a Custom Resource Definition (CRD). The following displays a sample CRD used to create an instance of the CTE for Kubernetes:

CTE-K8S-Operator-crd.yaml

apiVersion: cte-k8s-operator.csi.cte.cpl.thalesgroup.com/v1
kind: CteK8sOperator
metadata:
    labels:
        app.kubernetes.io/name: ctek8soperator
        app.kubernetes.io/instance: ctek8soperator
        app.kubernetes.io/part-of: cte-k8s-operator
        app.kubernetes.io/managed-by: kustomize
        app.kubernetes.io/created-by: cte-k8s-operator
    name: ctek8soperator
spec:
    replicas: 1
    image: "docker.io/thalesciphertrust/ciphertrust-transparent-encryption-kubernetes"
    version: "1.2.0-latest"
    imagePullPolicy: Always
    logLevel: 5
    apiburst: 300
    apiqps: 200
    imagePullSecrets:
        - name: cte-csi-secret
    registrationCleanupInterval: 10
    pauseimage: "k8s.gcr.io/pause:latest"

Applying a CRD

To apply the CRD, type:

kubectl apply –f `<path to\cte-k8s-operator.yaml>`

Installing the CTE for Kubernetes Operator | CLI Method

Warning

• Do not uninstall CTE for Kubernetes and the operator from the CLI, if they were installed using the GUI.

• Similarly, do not uninstall CTE for Kubernetes and the operator from the GUI, if it was installed using the CLI.

Note

You can install CTE for Kubernetes and the Operator only in the Openshift-operators namespace. If you want to install in other namespaces, use the CLI option.

The CTE for Kubernetes Operator can be installed using one of two methods:

• CLI

• Cluster Console GUI

CLI Method Prerequisites

1. Install the Operator Lifecycle Manager (OLM) on the cluster. Refer to Installing OLM for instructions on how to install OLM on the cluster.

   

   Note

   The latest version of Openshift is installed by default.

2. Install OC (Openshift CLI command for Openshift cluster) on the cluster.

   

   Note

   The user installing the Operator must have Cluster Admin permissions.

3. Download the Deploy Scripts.

4. Execute the deploy.sh script from the deploy directory, type:

   # ./deploy.sh --operator --operator-ns=<namespace-in-which-to-deploy-the-operator> --cte-ns=<namespace-in-which-to-deploy-cte-4-k8s>

   Copy

   If either of the namespace options is not specified, the script sets kube-system as the default namespace for deployment.

   

   Note

   Ensure that the namespace passed to the deployment script exists before initiating deployment. This prevents the script from prompting for creation of namespace during deployment. For example, if the deployment script is invoked as:

   # ./deploy.sh --operator --operator-ns=my-ns1 --cte-ns=my-ns2

   Copy

   where both namespaces my-ns1 and my-ns2, do not exist, the script would prompt with the following:

   # ./deploy.sh --operator --operator-ns=my-ns1 --cte-ns=my-ns2

   Copy

   Response

   Starting the cte-csi containers
   NAMESPACE my-ns1 not found!!!!!!
   Namespace my-ns1 not found. Do you want to create it now? [N/y]

   Copy

   Once the namespace information is available, the script proceeds to create the objects required and installs the operator. After installing the operator, the script deploys ctek8soperator CRD. This deploys CTE for Kubernetes on the cluster in the namespace specified.

Installing CTE for Kubernetes

To install CTE for Kubernetes (when CTE for Kubernetes Operator is already installed):

1. Navigate to the deploy directory that was downloaded for operator install.

2. Ensure the file ctek8soperator-crd.yaml has correct values.

3. Type:

   # oc apply -f <path to>/ctek8soperator-crd.yaml

   Copy

Updating CTE for Kubernetes

To update CTE for Kubernetes:

1. Stop any application that is using CTE for Kubernetes volumes.

2. Navigate to the deploy directory that was downloaded for operator install.

3. Edit the ctek8soperator-crd.yaml file.

4. Update the version field in the spec section to the latest version of CTE for Kubernetes.

5. Apply the change with the command:

   # oc apply -f <path to>/ctek8soperator-crd.yaml

   Copy

Deleting CTE for Kubernetes

To delete CTE for Kubernetes:

1. Stop any application that is using CTE for Kubernetes volumes.

2. Navigate to the deploy directory that was downloaded for operator install.

3. Type:

   # oc delete -f <path to>/ctek8soperator-crd.yaml

   Copy

Uninstalling CTE for Kubernetes Operator

To uninstall the CTE for Kubernetes Operator:

1. Stop any application that is using CTE for Kubernetes volumes.

2. Navigate to the deploy directory that was downloaded for operator install, type:

   # ./deploy.sh --operator --operator-ns=<namespace-in-which-ctek8soperator-is-deployed> --cte-ns=<namespace-in-which-ctek8s-is-deployed> --remove

   Copy

   This removes both CTE for Kubernetes and the operator.

Using the Cluster Console Web GUI

The CTE for Kubernetes Operator is certified with Red Hat for the Openshift platform. It is integrated with OperatorHub. The operator can be discovered on the OperatorHub page.

1. Open a browser and navigate to the Operators > OperatorHub link, in the left navigation panel on the console GUI. Type CTE in the search field under All Items to find the CTE for Kubernetes Operator.

2. Click on the tile to access the install option.

3. Ensure that all prerequisites are met before installing the operator.

4. Click Install to install the operator. Do not change the default values on the install page.

Deploying the CTE for Kubernetes Operator after installation

Once the operator is installed, the Kubernetes API servers becomes aware of the Kubernetes customer resource (CR). The installation process registers the:

• CR

• API for managing the CR

• Controller that handles the requests, for the CR, from the API Server

To instantiate the CR:

1. Click View Operator on the page displayed immediately after the operator is installed.

2. Alternatively:

   1. Expand “Operators” section and click Installed Operators page from the left hand bar on the page.

   2. Click on the Name of the operator installed.

   3. Click Create Instance link on the page displayed.

   4. Click Create to deploy CTE for Kubernetes.

Upgrading CTE for Kubernetes

1. Check the Docker site for a new version of CTE for Kubernetes:

2. Stop any application that is using CTE for Kubernetes volumes.

3. Expand “Operators” section and click Installed Operators page from the left hand bar on the page.

4. Click on the Name of the operator installed.

5. On the next page, select the YAML tab. This displays the manifest of CTE for Kubernetes instances installed on the cluster.

6. Update the version parameter in the CRD spec with the updated CTE-K8s version.

7. Click Save.

   The upgrade process terminates all of the CTE for Kubernetes pods running the previous version, while activating new pods running the new version. Once the cte-csi-node-XXXX pods are running on all of the nodes of the cluster, the application that uses the CTE for Kubernetes volume can be re-deployed.

8. If any of the other parameters in CTE-K8s-Operator.yaml, like logLevel, apiburst, apqps, etc. need to be updated, follow the same process as above to update the relevant parameter.

Uninstalling CTE for Kubernetes Operator

To uninstall CTE for Kubernetes Operator:

1. Stop any application that is using CTE for Kubernetes volumes.

2. Expand “Operators” section and click Installed Operators page from the left hand bar on the page.

3. Click on the Name of the operator installed.

4. On the next page, select the Actions tab.

5. Click Uninstall Operator in the list of actions displayed.

6. Click Uninstall on the confirmation pop-up to uninstall CTE for Kubernetes.

Upgrading CTE for Kubernetes Operator

The operator is designed to upgrade to a newer version automatically as soon as a new version is published by Thales. The Operator Lifecycle Manager, or OLM, constantly polls for updates and upgrades the operator whenever an update is available.