Installing the WebSphere Automation operator

You can install your operator by using the Red Hat OpenShift console or the Red Hat OpenShift CLI. Operators span all of your clusters. As such, cluster admin access is required to deploy operators.

Before you begin

Note: IBM Cloud Pak foundational services are deployed to the ibm-common-services namespace by default. However, you can install them in a different namespace. The installation must be done before the WebSphere Automation installation. For more information, see Installing IBM Cloud Pak foundational services in a custom namespace. After a different namespace is set up, you must indicate your chosen namespace within the WebSphereAutomation custom resource, specifically by using the .spec.commonServices.registryNamespace field.

Option 1: Installing the WebSphere Automation operator with the Red Hat OpenShift console

  1. Log in to the Red Hat OpenShift console of your cluster.
  2. Click Operators > OperatorHub. The OperatorHub page is displayed.
  3. In the All Items field, enter websphere auto. The operator is displayed.
    Search for websphere auto in the OperatorHub of the Red Hat OpenShift console
  4. Click the WebSphere Automation tile. The window with WebSphere Automation is displayed.
  5. Click Install. The Install Operator page is displayed.
  6. Enter the following values:
    • Set Update Channel to the default setting (v1.10).
    • Set the Installation mode to A specific namespace on the cluster, which is the best choice for most needs. To learn more about this choice, see Preparing for installation of WebSphere Automation
      Note: Select the installation mode for the WebSphere Automation operator that corresponds with the choice that is made during the execution of the WebSphere Automation script. The WebSphere Automation operator can be installed in two different modes.
      • AllNamespaces installation mode: Install the operator inside the openshift-operators namespace. This mode makes the operator available across all namespaces, allowing you to deploy WebSphere Automation instances in any namespace within the cluster. If you are installing the WebSphere Automation operator with AllNamespaces installation mode, you must declare --all-namespaces flag.
      • OwnNamespace installation mode: Install both the operator and the WebSphere Automation instance within the same namespace, referred to as WSA_INSTANCE_NAMESPACE.

      Use the OwnNamespace installation mode if you plan to install multiple instances of WebSphere Automation in the same Red Hat OpenShift Container Platform cluster, or if you plan to install other IBM Cloud Paks in the same cluster. For more information, see the installation documentation for the other IBM Cloud Paks that you want to install in the same cluster.

    • Set the Namespace to the project (namespace) value that you want to install the operator into.
      Note: When using the console to install the operator, you can either use an existing namespace, the default namespace that is provided by the operator, or create a new namespace. If you want to create a new namespace, you can create it from this form. If you want to create a namespace before installing, from the Project list, select Create Project, specify the Name of the project that you want to create, and click Create.
    • Set Approval Strategy to Automatic. This setting keeps the default ensures your software remains up to date with the most recent security fixes and capability updates.
  7. Click Install and wait for the your operator to install.
    Install Operator page for WebSphere Automation with an Install button in the Red Hat OpenShift console

    Red Hat OpenShift informs you that the installation is complete. You can verify that installation by navigating to Operators > Installed Operators, and selecting your project from the Projects menu. The operator that you have just installed and all of its dependent operators in the project are listed with a status of Succeeded.

    This second image is of the Installed Operators page with the WebSphere Automation operator ready for use in the Red Hat OpenShift console

Option 2: Installing the WebSphere Automation operator with the Red Hat OpenShift CLI

  1. Set the WSA_OPERATOR_NAMESPACE and WSA_INSTANCE_NAMESPACE shell variables.

    For the AllNamespaces installation mode, set WSA_OPERATOR_NAMESPACE to openshift-operators. Set WSA_INSTANCE_NAMESPACE to the wanted instance namespace, for example, websphere-automation. For SingleNamespace, use different namespace values. For OwnNamespace mode, set WSA_OPERATOR_NAMESPACE to the same value as WSA_INSTANCE_NAMESPACE.

    WSA_OPERATOR_NAMESPACE=openshift-operators
    WSA_INSTANCE_NAMESPACE=websphere-automation
  2. Create the namespaces, if needed.

    For AllNamespaces installation mode, the openshift-operators namespace exists.

    oc create namespace $WSA_OPERATOR_NAMESPACE
    oc create namespace $WSA_INSTANCE_NAMESPACE
    Note: For security considerations applicable at the namespace level, see Using the ResourceQuota resource.
  3. For either OwnNamespace or SingleNamespace mode, create an OperatorGroup.
    Note: For the default AllNamespaces mode, skip this step.
    cat <<EOF | oc apply -f -
    apiVersion: operators.coreos.com/v1alpha2
    kind: OperatorGroup
    metadata:
      name: ibm-websphere-automation
      namespace: $WSA_OPERATOR_NAMESPACE
    spec:
      targetNamespaces:
      - $WSA_INSTANCE_NAMESPACE
    EOF
  4. Create a Subscription to install WebSphere Automation operator.
    cat <<EOF | oc apply -f -
    apiVersion: operators.coreos.com/v1alpha1
    kind: Subscription
    metadata:
      name: ibm-websphere-automation
      namespace: $WSA_OPERATOR_NAMESPACE
    spec:
      channel: v1.10
      installPlanApproval: Automatic
      name: ibm-websphere-automation
      source: ibm-operator-catalog
      sourceNamespace: openshift-marketplace
    EOF

What to do next

Proceed to the next step, Creating the entitlement key secret or updating the global pull secret.