Chapter 3. JWS Operator installation from OperatorHub

Procedure

1. Open the web console and select Operators > OperatorHub.
2. In the Filter by keyword search field, type "JWS".
3. Select the JWS Operator.
4. On the JBoss Web Server Operator menu, select the Capability level that you want to use and click Install.

5. On the Install Operator page, perform the following steps:

   1. Select the Update channel where the JWS Operator is available.

      Note

      The JWS Operator is currently available through one channel only.

   2. Select the Installation mode for the Operator.

      You can install the Operator to all namespaces or to a specific namespace on the cluster. If you select the specific namespace option, use the Installed Namespace field to specify the namespace where you want to install the Operator.

      Note

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

   3. Select the Approval strategy for the Operator.

      Consider the following guidelines:

      • If you select Automatic updates, when a new version of the Operator is available, the 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 then appears in the Installed Operators section of the Operators tab.

Procedure

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

   1. View the list of JWS Operators that are available to the cluster from OperatorHub:

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

      Copy to Clipboard Toggle word wrap

      The preceding command displays the name, catalog, and age of each available Operator.

      For example:

      NAME            CATALOG             AGE
      jws-operator    Red Hat Operators   16h

      Copy to Clipboard Toggle word wrap

   2. Inspect the JWS Operator to verify the supported installation modes and available channels for the Operator:

      $ oc describe packagemanifests jws-operator -n openshift-marketplace

      Copy to Clipboard Toggle word wrap

2. Check the actual list of Operator groups:

   $ oc get operatorgroups -n <project_name>

   Copy to Clipboard Toggle word wrap

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

   The preceding command displays the name and age of each available Operator group.

   For example:

   NAME       AGE
   mygroup    17h

   Copy to Clipboard Toggle word wrap

3. If you need to create an Operator group, perform the following steps:

   Note

   If the Operator you want to install uses SingleNamespace installation mode and you do not already have an appropriate Operator group in place, you must complete this step to create an Operator group. You must ensure that you create only one Operator group in the specified namespace.

   If the Operator you want to install uses AllNamespaces installation mode or you already have an appropriate Operator group in place, you can ignore this step.

   1. 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

      In the preceding example, replace <operatorgroup_name> with the name of the Operator group that you want to create, and replace <project_name> with the name of the project where you want to install the Operator. To view the project name, you can run the oc project -q command.

   2. Create the OperatorGroup object from the YAML file:

      $ oc apply -f <filename>.yaml

      Copy to Clipboard Toggle word wrap

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

4. 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

      In the preceding example, replace <project_name> with the name of the project where you want to install the Operator. To view the project name, you can run the oc project -q command.

      The namespace that you specify must have an OperatorGroup object that has the same installation mode setting as the Operator. If the Operator uses AllNamespaces installation mode, replace <project_name> with openshift-operators, which already provides an appropriate Operator group. If the Operator uses SingleNamespace installation mode, ensure that this namespace has only one OperatorGroup object.

      Ensure that the source setting matches the Catalog Source value that was displayed 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

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