Prerequisites to install Operator online

Based on whether you install the Operator with or without Operator Lifecycle Manager (OLM), install the necessary command-line tools - oc, kubectl, Operator SDK, and yq.

About this task

The following procedure lists down the prerequisites that are required for installation with or without OLM.

Procedure

  • Prerequisites to installation with OLM
    • If you are connected to a Red Hat® OpenShift® Container Platform cluster, install the oc command-line tool. For more information, see Installing the OpenShift CLI.
    • If you are connected to a Kubernetes cluster, install the kubectl command-line tool. For more information, see kubectl.
      Note: The oc commands are interchangeable with kubectl. Hence, if you are connected to a Kubernetes cluster, ensure to replace the oc commands with kubectl counterparts.
    • Ensure that you hold administrator authority or the necessary role-based access control (RBAC) permissions to manage the cluster before you install the OLM. For more information, see role-based access control good practices.
    • The OLM is not included in the out-of-the-box offering. For inquiries about OLM, contact the OLM product team.
    • If you are using Red Hat OpenShift Container Platform, the OLM is installed by default, so you do not need to install the Operator SDK command-line tool.
    • Install the Operator SDK only if you are installing the Operator on a Kubernetes cluster. In the following steps to install Operator SDK and OLM on a Kubernetes platform, you are navigated to the respective website outside of IBM®. For more information, see Operator Lifecycle Manger.
      1. Install the Operator SDK. For more information, see Install the Operator SDK.
      2. Ensure that you are logged in to your Kubernetes environment.
      3. Run the following command to install OLM in your cluster:
        operator-sdk olm install
      The output is shown in the Installing OLM in your cluster page.
  • Prerequisites to installation without OLM
    • Install yq command-line tool to automate the setup process. For more information, see yq usage guide.
    • If you prefer to not install yq, manually set the required environment variables- OPERATOR_VERSION, OPERATOR_DIGEST, ODS_DIGEST. You can locate the necessary values for these variables from the case.
    • To set the variables manually, use the following commands.
      export OPERATOR_VERSION=<version_value>
export OPERATOR_DIGEST=<digest_value>
export ODS_DIGEST=<digest_value>