Chapter 3. JWS Operator for OpenShift

Procedure

1. Open the web console and navigate to the Operators tab.

   The OpenShift OperatorHub opens.

2. Search for JWS and select the JWS Operator.

   A new menu displays.

3. Select the Capacity Level that you want to use.
4. To install the Operator, at the start of the console, click Install.

5. To set up the Operator installation, perform the following steps:

   1. Specify the installation mode by specifying the namespace on your cluster where you want to install the Operator.

      Note

      If you do not specify a namespace, the Operator is installed to all namespaces on your cluster by default.

   2. Specify the update channel where the JWS Operator is available.

      Note

      The JWS Operator is currently available only through one channel.

   3. Specify the approval strategy by selecting Automatic or Manual updates.

      Note

      If you select Automatic updates, when a new version of the Operator is available, the Operator Lifecycle Manager (OLM) upgrades the running instance of your Operator automatically.

      If you select Manual updates, when a newer version of the Operator is available, the OLM creates an update request. As a cluster administrator, you must then manually approve the update request to ensure that the Operator is updated to the new version.

6. Click Install.

   Note

   If you have selected a Manual approval strategy, you must approve the install plan before the installation is complete. The JWS Operator now appears in the Installed Operators section of the Operators tab.

Procedure

1. To inspect the JWS Operator, perform the following steps:

   1. To verify the supported installation modes for the JWS Operator, enter the following command:

      $ oc get packagemanifests -n openshift-marketplace | grep jws

      Copy to Clipboard Toggle word wrap

      The preceding command produces the following type of output:

      jws-operator    Red Hat Operators   16h

      Copy to Clipboard Toggle word wrap

   2. To verify the available channels for the JWS Operator, enter the following command:

      $ oc describe packagemanifests jws-operator -n openshift-marketplace | grep "Catalog Source"

      Copy to Clipboard Toggle word wrap

      The preceding command produces the following type of output:

      Catalog Source:     redhat-operators

      Copy to Clipboard Toggle word wrap

2. To create an Operator group, perform the following steps:

   1. To check the actual list of Operator groups, enter the following command:

      $ oc get operatorgroups -n <project_name>

      Copy to Clipboard Toggle word wrap
      Note

      In the preceding example, replace <project_name> with your OpenShift project name.

      The preceding command produces the following type of output:

      NAME       AGE
      mygroup    17h

      Copy to Clipboard Toggle word wrap

   2. Create a YAML file for the OperatorGroup object.

      For example:

      apiVersion: operators.coreos.com/v1
      kind: OperatorGroup
      metadata:
        name: <operatorgroup_name>
        namespace: <project_name>
      spec:
        targetNamespaces:
        - <project_name>

      Copy to Clipboard Toggle word wrap
      Note

      In the preceding example, replace <project_name> with the namespace of the project where you want to install the Operator (oc project -q). and replace `<operatorgroup_name> with the name of the OperatorGroup object.

   3. Create the OperatorGroup object from the YAML file:

      $ oc apply -f <filename>.yaml

      Copy to Clipboard Toggle word wrap
      Note

      In the preceding example, replace <filename>.yaml with the name of the YAML file that you have created for the OperatorGroup object.

3. To create a Subscription object, perform the following steps:

   1. Create a YAML file for the Subscription object.

      For example:

      apiVersion: operators.coreos.com/v1alpha1
      kind: Subscription
      metadata:
          name: jws-operator
          namespace: <project_name>
      spec:
          channel: alpha
          name: jws-operator
          source: redhat-operators
          sourceNamespace: openshift-marketplace

      Copy to Clipboard Toggle word wrap
      Note

      In the preceding example, replace <project_name> with the namespace of the project where you want to install the Operator (oc project -q). If the Operator is using AllNamespaces mode, replace <project_name> with openshift-operators.

      Ensure that the source setting matches the Catalog source value based on the command-line output when you verified the available channels for the Operator (for example, redhat-operators).

   2. Create the Subscription object from the YAML file:

      $ oc apply -f <filename>.yaml

      Copy to Clipboard Toggle word wrap
      Note

      In the preceding example, replace <filename>.yaml with the name of the YAML file that you have created for the Subscription object.

Procedure

1. Open the web console and click Operators > Installed Operators.

2. Select the Actions menu and click Uninstall Operator.

   Note

   The Uninstall Operator option automatically removes the Operator, any Operator deployments, and Pods.

   Deleting the Operator does not remove any custom resource definitions or custom resources for the Operator, including CRDs or CRs. If the Operator has deployed applications on the cluster, or if the Operator has configured off-cluster resources, you must clean up these applications and resources manually.

Procedure

1. Check the current version of the subscribed Operator:

   $ oc get subscription jws-operator -n <project_name> -o yaml | grep currentCSV

   Copy to Clipboard Toggle word wrap
   Note

   In the preceding command, replace <project_name> with the namespace of the project where you installed the Operator. If your Operator was installed to all namespaces, replace <project_name> with openshift-operators.

   The preceding command produces the following output, where v<version> refers to the Operator version (for example, v1.1.0):

   f:currentCSV: {}
   currentCSV: jws-operator.v<version>

   Copy to Clipboard Toggle word wrap

2. Delete the subscription for the Operator:

   $ oc delete subscription jws-operator -n <project_name>

   Copy to Clipboard Toggle word wrap
   Note

   In the preceding command, replace <project_name> with the namespace of the project where you installed the Operator. If your operator was installed to all namespaces, replace <project_name> with openshift-operators.

3. Delete the CSV for the Operator in the target namespace by using the currentCSV value that you obtained from the previous steps:

   $ oc delete clusterserviceversion <currentCSV> -n <project_name>

   Copy to Clipboard Toggle word wrap
   Note

   In the preceding command, replace <project_name> with the namespace of the project where you installed the Operator, and replace <currentCSV> with the currentCSV value that you obained in the preceding steps (for example, jws-operator.v<version>).

   The preceding command produces the following type of output:

   clusterserviceversion.operators.coreos.com "jws-operator.v<version>" deleted

   Copy to Clipboard Toggle word wrap
   Note

   In the preceding command, <project_name> refers to the namespace of the project where you installed the operator, and v<version> refers to the operator version (for example, v1.1.0). If your operator was installed to all namespaces, use openshift-operators in place of <project_name>.