Installing and validating the Engineering Lifecycle Management operator

OperatorHub is a user interface for discovering operators, and with the proper permissions, you can install an Operator in OperatorHub by using the following methods Red Hat® OpenShift® Container Platform web console or CLI method. After successful installation, you can also validate the installation of the Engineering Lifecycle Management operator.

Before you begin

  1. Ensure that the Red Hat OpenShift is configured. For more information, see Configuring Red Hat OpenShift.
  2. Ensure that you have the cluster-admin role so that you can install the Engineering Lifecycle Management operator. For more information about the user roles in the Red Hat OpenShift, see User roles mapping in Engineering Lifecycle Management on Hybrid Cloud.

About this task

The Operator Lifecycle Manager is used to install the operator to the Red Hat OpenShift. The Operator Lifecycle Manager helps users install, update, and manage the lifecycle of an operator and its associated services that run across the cluster. For more information about installing operators in the Red Hat OpenShift, see Installing Operators in your namespace.
The Engineering Lifecycle Management operator can be installed by using the web console method or the CLI method.

Install and validate ELM operator using web-console method

Procedure

  1. Log in to the Red Hat OpenShift Container Platform web console.
  2. From the side navigation menu, click Operators > OperatorHub.
  3. On the OperatorHub page, enter Engineering Lifecycle Management in the search box to search for the IBM® Engineering Lifecycle Management operator.
  4. Click the IBM Engineering Lifecycle Management tile to open it and then click Install.
  5. On the Install Operator page, install the operator.
    1. In the Update channel field, select the appropriate channel that you want to subscribe to. For more information, see Release channels
    2. In the Installation mode field, A specific namespace on the cluster is selected by default.
    3. From the Installed Namespace list, select the project where you want to install the Engineering Lifecycle Management operator.
    4. Select an approval strategy
      Automatic
      The Engineering Lifecycle Management operator is automatically upgraded to a new version by the Operator Lifecycle Manager.
      Manual
      The Operator Lifecycle Manager creates an approval request. After you approve the request, the Engineering Lifecycle Management operator is installed.
    5. To install the Engineering Lifecycle Management operator to the project that you selected, click Install. The installation process takes a couple of minutes to complete.
  6. Verify the Engineering Lifecycle Management operator installation.
    1. From the side navigation menu, click Operators > Installed Operators.The Engineering Lifecycle Management operator is listed on the Installed Operators page.
    2. To see the detailed information of the Engineering Lifecycle Management operator, click IBM Engineering Lifecycle Management

Install and validate ELM operator using the CLI method

Procedure

  1. Log in to cluster and create a new project for installing the Engineering Lifecycle Management operator by using the following command:
    oc login
    oc new-project <project_name>
    Example:
    oc new-project my-ocp-project
    Note: The Red Hat OpenShift project my-ocp-project is not an Engineering Lifecycle Management project. Engineering Lifecycle Management applications are installed into this project
  2. Switch to the project where you want to install the Engineering Lifecycle Management operator by using the following command:
    oc project <project_name>
    Example:
    oc project my-ocp-project
  3. Create an OperatorGroup.
    1. Create a YAML file that is similar to the following example:
      apiVersion: operators.coreos.com/v1 
      kind: OperatorGroup 
      metadata: 
        name: ibm-elm-operatorgroup 
        namespace: <namespace_name> 
      spec: 
        targetNamespaces:
          - <namespace_name>

      Replace the placeholder namespace_name by using the namespace that you want the operator to be installed.

    2. Save the YAML as a file that is named elm-operator-group.yaml
    3. To apply the file, run the following command:
      oc apply -f elm-operator-group.yaml
  4. Create a subscription for the Engineering Lifecycle Management operator.
    1. Create a YAML file that is similar to the following example:
      apiVersion: operators.coreos.com/v1alpha1 
      kind: Subscription 
      metadata: 
        name: ibm-elm-operator-sub 
        namespace: <namespace_name>  
      spec: 
        channel: release-elm7.1
        installPlanApproval: Automatic 
        name: ibm-elm-operator 
        source: <catalog_source_name> 
        sourceNamespace: openshift-marketplace
      Replace the following placeholders, for <catalog_source_name>, <channel_name>, <namespace_name> with the name of the catalog source, channel name and namespace name that was created for this operator. For more information on channels, see Release channels
    2. To get the catalog source names on your cluster, run the following command:
      oc get catalogsource -n openshift-marketplace
    3. Save as a file that is named subscription.yaml
    4. To apply the change, run the following command:
      oc apply -f subscription.yaml
  5. To validate the correct installation of the operator, run the following command:
    oc get csv -n <namespace_name>
    The command returns a list that is similar to the following example.
    NAME                      DISPLAY                                                VERSION   REPLACES   PHASE
    ibm-elm-operator.v1.0.0   IBM Engineering Lifecycle Management on Hybrid Cloud   1.0.0                Succeeded

What to do next

  1. Create the Engineering Lifecycle Management instance. For more information, see Creating Engineering Lifecycle Management instance on Hybrid Cloud
  2. After the operator is successfully installed, you can deploy the instances that operator manages.