Preparing to install foundational services

Check all foundational services ClusterServiceVersions(CSV) in the cluster and confirm if foundational services CSVs' version are greater than 3.19.9.

oc get csv -A | grep ibm-common-service-operator.v
 

Example output:

ibm-common-services                                ibm-common-service-operator.v3.19.20            IBM Cloud Pak foundational services    3.19.20          ibm-common-service-operator.v3.19.19            Succeeded
foundational-serivces-v4                           ibm-common-service-operator.v4.4.0              IBM Cloud Pak foundational services    4.4.0                                                           Succeeded
 

Check the common-service-maps ConfigMap under the kube-public namespace and confirm if a dedicated controlNamespace is specified in the ConfigMap. Check the namespaces of the foundational services version 3.x.x instance is listed in the ConfigMap:

apiVersion: v1
kind: ConfigMap
metadata:
  name: common-service-maps
  namespace: kube-public
data:
  common-service-maps.yaml: |
    controlNamespace: cs-control     <------------- controlNamespace
    namespaceMapping:
    - requested-from-namespace:
      - cloudpakns1
      - cloudpakns2
      - cloudpakns3
      map-to-common-service-namespace: ibm-common-services    <---------- Foundational services v3.x instance
 

If a cluster with an existing instance of foundational services version 3.19.9 or newer is not under multiple-namespaces installation, you must convert it to a multiple-namespaces installation before installing a new instance of foundational services version 4.x.x by completing Step 1: Isolate and migrate. For more information, see Isolated migration.

For the hardware requirements, see Hardware requirements and recommendations for foundational services.

For more information about the supported versions, see Supported OpenShift versions and platforms.

If there are no OpenShift Container Platform CLI tools on the boot node, you need to download, decompress, and install the OpenShift Container Platform CLI tools oc from OpenShift Container Platform client binaries .

• To ensure that the OpenShift Container Platform cluster is set up correctly, access the web console.

  • The web console URL can be found by running following command:

    oc -n openshift-console get route
     

  • Example output:

    openshift-console    console    console-openshift-console.apps.new-coral.purple-chesterfield.com    console    https    reencrypt/Redirect    None
     

  The console URL in this example is https://console-openshift-console.apps.new-coral.purple-chesterfield.com. Open the URL in your browser and check the OpenShift Container Platform cluster status.

• For a Red Hat OpenShift on IBM Cloud cluster, you must install a supported version of OpenShift Container Platform by using IBM Cloud Kubernetes Service so that the managed OpenShift Container Platform service is supported. For more information, see Tutorial: Creating Red Hat OpenShift on IBM Cloud clusters .

• If you are installing your cluster on a public cloud, such as Red Hat OpenShift on IBM Cloud, authentication with Red Hat OpenShift is enabled by default. For more information, see Delegating authentication to OpenShift (ibm-im-operator).

Ensure that you have a pre-configured storage class in OpenShift Container Platform that can be used for creating storage for IBM Cloud Pak foundational services. You need persistent storage for some of the service pods.

You can use the following command to get the storage classes that are configured in your cluster. Pick a storage class that provides block storage.

oc get storageclasses
 

Following is a sample output:

NAME                                  PROVISIONER                     AGE
rook-ceph-block-internal              rook-ceph.rbd.csi.ceph.com      42d
rook-ceph-cephfs-internal (default)   rook-ceph.cephfs.csi.ceph.com   42d
rook-ceph-delete-bucket-internal      ceph.rook.io/bucket             42d
 

For an OpenShift cluster that runs on IBM Cloud®, ibmc-block-gold is always available. For installing IBM Cloud Pak foundational services on IBM Cloud®, you might need to use the ibmc-block-gold storage class. For more information, see Deciding on the block storage configuration.

oc get sc
 

Example output:

NAME                          PROVISIONER         AGEdefault                       ibm.io/ibmc-file    4h
ibmc-block-bronze (default)   ibm.io/ibmc-block   4h
ibmc-block-custom             ibm.io/ibmc-block   4h
ibmc-block-gold               ibm.io/ibmc-block   4h
ibmc-block-retain-bronze      ibm.io/ibmc-block   4h
ibmc-block-retain-custom      ibm.io/ibmc-block   4h
ibmc-block-retain-gold        ibm.io/ibmc-block   4h
ibmc-block-retain-silver      ibm.io/ibmc-block   4h
ibmc-block-silver             ibm.io/ibmc-block   4h
ibmc-file-bronze              ibm.io/ibmc-file    4h
ibmc-file-custom              ibm.io/ibmc-file    4h
ibmc-file-gold                ibm.io/ibmc-file    4h
ibmc-file-retain-bronze       ibm.io/ibmc-file    4h
ibmc-file-retain-custom       ibm.io/ibmc-file    4h
ibmc-file-retain-gold         ibm.io/ibmc-file    4h
ibmc-file-retain-silver       ibm.io/ibmc-file    4h
ibmc-file-silver              ibm.io/ibmc-file    4h
 

The default storage class is marked as (default).

The foundational services installer uses the default storage class to install PostgreSQL common-service-db and Keycloak services. If you want to set the default storage class or update the default storage class in your OpenShift Container Platform, see Change the default StorageClass . If you want to set a different storage class for PostgreSQL common-service-db and Keycloak services, you can set the storage class in the CommonService CR, see Configuring IBM Cloud Pak foundational services .

The storage class provisioner is defined in the PROVISIONER list. To enable dynamic volume provisioning, see Enabling Dynamic Provisioning .

mountOptions:
- dir_mode=0777
- file_mode=0777
- uid=1000630000
 

The following prerequisites are applicable if you are installing foundational services in a cluster that has multiple zones.

allowVolumeExpansion: true
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
  labels:
    app: ibmcloud-block-storage-plugin
  name: ibmc-block-wffc
parameters:
  billingType: hourly
  classVersion: "2"
  fsType: ext4
  iopsPerGB: "10"
  sizeRange: '[20-4000]Gi'
  type: Endurance
provisioner: ibm.io/ibmc-block
reclaimPolicy: Delete
volumeBindingMode: WaitForFirstConsumer
 

• The port number 9555 is required to be open on every node in the OS environment for the node exporter in the monitoring service. This port is configurable and 9555 is the default value.
• Allow access to the following sites and ports if you have firewall that manages the access to public networks:

Table 1. Sites and ports that must be accessible

Site	Description
cr.io cp.icr.io dd0.icr.io dd2.icr.io dd4.icr.io dd6.icr.io	Allow access to these hosts on port 443 to enable access to the IBM Cloud Container Registry and foundational services catalog source.