Installing IBM Cloud Pak foundational services by using the OpenShift console

The following instructions are for installing foundational services by using the OpenShift Container Platform console.

Procedure

  1. Creating a namespace for foundational services
  2. Installing the operators from OperatorHub
  3. Setting the hardware profile and accepting the licenses
  4. Configuring namespace permissions
  5. Configuring the services

For post installation options, see Enabling or disabling foundational services after installation.

Creating a namespace for foundational services

Ensure that your IBM Cloud Pak namespace exists in your cluster. The namespace is needed for the <span data-key-file="/home/jenkins/workspace/workspace/dita-converter/git_repo/conrefs.yml" data-conkeyref="conrefs/keyword.cs" data-variable="keyword.cs" class="md-conref">keyword.cs</span> operator.

Usually, the <span data-key-file="/home/jenkins/workspace/workspace/dita-converter/git_repo/conrefs.yml" data-conkeyref="conrefs/keyword.cs" data-variable="keyword.cs" class="md-conref">keyword.cs</span> operator is automatically installed in your IBM Cloud Pak namespace when you install your IBM Cloud Pak. If you see the operator in your IBM Cloud Pak namespace, you do not need to manually install it. The Operand Deployment Lifecycle Manager and the foundational services are then by default, installed in the <span data-key-file="/home/jenkins/workspace/workspace/dita-converter/git_repo/conrefs.yml" data-conkeyref="conrefs/keyword.cs_ns" data-variable="keyword.cs_ns" class="md-conref">keyword.cs_ns</span> namespace.

If you need to create a namespace, complete the following steps:

  1. From your Red Hat OpenShift cluster console, click Home > Projects. The Projects page is displayed.
  2. Click Create Project. A Create Project area is displayed.
  3. Enter details of the namespace that you are creating. You can specify your IBM Cloud Pak namespace as the name.
  4. Click Create. The namespace for your <span data-key-file="/home/jenkins/workspace/workspace/dita-converter/git_repo/conrefs.yml" data-conkeyref="conrefs/keyword.cs" data-variable="keyword.cs" class="md-conref">keyword.cs</span> operator is created.

Installing the operators from OperatorHub

Complete these tasks from your Red Hat OpenShift cluster console > Project: All Projects > Operators > OperatorHub page.

  1. If you are using License Service, see Installing License Service.

  2. If you are using License Service Reporter, see Installing License Service Reporter with the OpenShift console .

  3. If you are using the foundational services certificate manager, see Installing IBM Cert Manager with the OpenShift console .

  4. If the <span data-key-file="/home/jenkins/workspace/workspace/dita-converter/git_repo/conrefs.yml" data-conkeyref="conrefs/keyword.cs" data-variable="keyword.cs" class="md-conref">keyword.cs</span> operator is not already installed in your IBM Cloud Pak namespace, install it now.

    The <span data-key-file="/home/jenkins/workspace/workspace/dita-converter/git_repo/conrefs.yml" data-conkeyref="conrefs/keyword.cs" data-variable="keyword.cs" class="md-conref">keyword.cs</span> operator installs the Operand Deployment Lifecycle Manager operator in the namespace.

    1. In the All Items field, enter <span data-key-file="/home/jenkins/workspace/workspace/dita-converter/git_repo/conrefs.yml" data-conkeyref="conrefs/keyword.cs" data-variable="keyword.cs" class="md-conref">keyword.cs</span>. The IBM Cloud Pak foundational services operator is displayed.
    2. Click the IBM Cloud Pak foundational services tile. The IBM Cloud Pak foundational services window is displayed.
    3. Click Install. You see the Install Operator page.
    4. Set Update Channel to the <span data-key-file="/home/jenkins/workspace/workspace/dita-converter/git_repo/conrefs.yml" data-conkeyref="conrefs/keyword.cs_channel" data-variable="keyword.cs_channel" class="md-conref">keyword.cs_channel</span> version.
    5. Set Installation Mode to A specific namespace on the cluster. Select your IBM Cloud Pak namespace from the Installed Namespace drop-down list.
    6. Set Update approval to Automatic.
    7. Click Install.

    See the following notes:

    • You can set the approval strategy to either Automatic or Manual, as required. By default, the approval strategy is set to Automatic, which automatically installs or upgrades the operator when a new version is available. If you set the strategy to Manual, the operator is not automatically installed or upgraded. Instead, you get an install plan that needs to be manually approved before an upgrade.

    • When you set the approval strategy for the IBM Cloud Pak foundational services operator, it applies to all foundational services that are installed with this operator.

    • If you install the IBM Cloud Pak foundational services operator in a namespace where another operator is installed with the installPlanApproval: Manual set in its subscription, then the foundational services operator inherits the setting: the approval plan for the IBM Cloud Pak foundational services operator is automatically set to Manual. For more information, see Approval strategy.

After a few minutes, you can see all the operators on the Installed Operators page.

Setting the hardware profile and accepting the licenses

  • Hardware profile: Set the hardware requirements profile based on the workloads in your cluster. For more information about the profiles, see Hardware requirements and recommendations for foundational services.

    • The default profile is starterset. You can change the profile to starter, small, medium, production, or large, if required.

    • You can scale up a profile anytime after installation. If you change the profile to large or medium, you cannot scale down the profile to small after installation. However, scaling down a profile can be done only if no other Cloud Pak has requested for a larger (production) size.

      For example, if you install with a medium profile and another Cloud Pak specifies a medium or large (production) profile, and then you attempt to scale down to size small, the profile remains as medium. You can be able to scale down to small only if there is no other Cloud Pak with medium or large (production) size. You can be able to scale down to starterset (starter) profile with three common-service-db replicasets.

    • If you are using the foundational services certificate manager service, see Setting the hardware profile and accepting the license.

  • License: Accept the licenses for the following services by adding spec.license.accept: true in the spec section.

Complete the following steps:

  1. From the navigation pane, click Home > Search.

  2. From the Project drop-down list, select <span data-key-file="/home/jenkins/workspace/workspace/dita-converter/git_repo/conrefs.yml" data-conkeyref="conrefs/keyword.cs_ns" data-variable="keyword.cs_ns" class="md-conref">keyword.cs_ns</span>.

  3. From the Resources drop-down list, select CommonService.

  4. Click the common-service resource.

  5. Select the YAML tab.

  6. Update the spec.size parameter to set the hardware profile, and update the spec.license.accept parameter from false to true to accept the license.

    apiVersion: operator.ibm.com/v3
kind: CommonService
metadata:
  name: common-service
  namespace: <your-foundational-services-namespace>
spec:
  license:
    accept: true
  size: starterset

  7. Click Save.

Configuring the services

Before you deploy foundational services instance, you can customize the configuration of the foundational services that you are installing.

For more information, see Configuring foundational services .

Note: The ibm-im-operator creates a default cluster administrator by the name cpadmin during installation. If you already have a user by the name cpadmin in your cluster, you must set the defaultAdminUser parameter before you install foundational services. This setting is to avoid your cpadmin user from being removed if you uninstall foundational services later. For more information about setting this parameter, see Changing the default admin username.

What to do next

You installed the foundational services operators, and now you can apply your entitlement key for online installation. For more information, see Applying your entitlement key for online installation.

If you are using an air-gapped cluster, your entitlement key is already applied as a part of the air-gapped image mirroring process. You do not need to apply your entitlement key again. You can now deploy the foundational services instances. For more information, see Deploying the foundational services instances.