Installer

This section provides all the details to install and validate, uninstall, and upgrade your installation.

If you are using foundational services as part of an IBM Cloud Pak®, see the documentation for that IBM Cloud Pak® to learn more about how to install and use the services. For more information about IBM Cloud Paks, see IBM Cloud Paks that use IBM Cloud Pak foundational services.

What's new for the Installer

The installer version sections are listed based on when the installer was released, from the newest to the oldest release.

Installer version 3.23.x

OpenShift Container Platform 4.12: Support for OpenShift Container Platform 4.12 is added. For more information, see Supported OpenShift versions and platforms.
Custom configurations are not overwritten: The ibm-common-service-operator and operand-deployment-lifecycle-manager operators no longer overwrite custom configurations that you make in the .spec.config section of any foundational services operator subscription.
Numeric namespace: You can now install foundational services in a namespace that has a numeric name. For example, a namespace with the name 123.

Installer version 3.22.x

IBM Catalog Management Plug-in (ibm-pak plugin):
1. The ibm-pak plug-in now generates a component-set-config.yaml file per CASE retrieval that can be used to pin a specific version downloaded. The component-set-config.yaml can be specified as input on future CASE retrievals to ensure a repeatable install.
2. The list command now shows you the Application Version in addition to the CASE version for both available CASEs, including the one you have already downloaded.
3. Colored plug-in console output can be enabled by running the command, oc ibm-pak config color --enable true, to highlight success or error messages.
cloudctl case command deprecation: In foundational services version 3.22, the cloudctl case command is deprecated and replaced with ibm-pak plug-in. Support for the cloudctl case command will be removed in a future release.
Foundational services backup and restore (technology preview): Back up and restore foundational services by using the OADP (OpenShift API for Data Protection) operator. For more information, see IBM Cloud Pak foundational services backup and restore.
IBM Namespace Scope Operator permissions: Cluster permissions of the IBM Namespace Scope Operator are reduced. For more information, see IBM Namespace Scope Operator.
IBM Crossplane operators: If you want to uninstall the IBM Crossplane operators, you can add the crossplaneProviderRemoval: true configuration to the CommonService CR. For more information, see Crossplane service.

Installer version 3.21.x

IBM Catalog Management Plug-in (ibm-pak plugin): The following enhancements are introduced:
- Support for PowerPC 64-bit, little-endian, and IBM Z architecture.
- Enhanced describe command to view the top-level namespaces where images will be mirrored.
Convert a single-namespace foundational services installation to a multiple-namespaces installation: If you installed IBM Cloud Pak foundational services in a single namespace in your cluster, and you now want to install foundational services in multiple namespaces, you can run a script to do so. For more information, see Converting a single-namespace installation to a multiple-namespaces installation.
Catalog sources available only in icr.io: Catalog sources of all foundational services operators are now available only in icr.io. The images and catalog sources in quay.io and docker.io are no longer used.

Installer version 3.20.x

Installing IBM Cloud Pak foundational services in multiple namespaces: In IBM Cloud Pak foundational services version 3.20, multiple foundational services instances capability is now generally available. For more information, see Installing IBM Cloud Pak foundational services in multiple namespaces
IBM Catalog Management Plug-in (ibm-pak plugin): The following enhancements are introduced:
- You can download CASEs from icr.io, an OCI compliance registry that stores CASEs as OCI artifacts.
- You can list all available CASEs to download, as well as list the versions and the latest versions available for CASEs that you already downloaded.
- You can get command outputs in json or yaml.
OpenShift Container Platform 4.11: Support for OpenShift Container Platform 4.11 is added. For more information, see Supported OpenShift versions and platforms.

Installer version 3.19.x

Long Term Service Release (LTSR) and release cycle changes: IBM Cloud Pak foundational services 3.19 release is a Continuous Delivery (CD) release and a Long Term Service Release (LTSR). The LTSR release delivers new features as well as security vulnerability and critical fixes. For more information about a CD and LTSR release, see Release types.
- Starting from now, the v3 channel becomes the LTSR channel. The fixes and patches for LTSR will be delivered through this channel.
- The upcoming CD releases will be delivered through multiple OLM channels. To make sure that you continuously deliver new foundational services versions that contain newly delivered features, make sure your upgrade procedures get updated when the next version of foundational services releases.
IBM Catalog Management Plug-in (ibm-pak plugin): In foundational services version 3.19, IBM Catalog Management Plug-in for IBM Cloud Paks is now generally available. For more information, see IBM Catalog Management Plug-in.
Configmap watcher removed from cert-manager: In foundational services version 3.19, configmap-watcher is removed from cert-manager.

Installer version 3.18.x

Multiple foundational services instances (technology preview): You can install multiple foundational services instances in your cluster. For more information, see Installing IBM Cloud Pak foundational services in multiple namespaces.
License parameter: A spec.license parameter is added in the CommonService custom resource. For more information, see License.

Installer version 3.17.x

ibm-pak plug-in technology preview: The ibm-pak plug-in simplifies the delivery of air-gapped function with a single oc plug-in. For more information, see ibm-pak plug-in technology preview.

Installer version 3.16.0

Support for OpenShift Container Platform 4.10 is added. For more information, see Supported OpenShift versions and platforms.
Information about supported deployment scenarios is added. For more information, see Supported cloud providers.
Installer versions 1.1.0, 3.4.x, and 3.5.x are deprecated. You cannot upgrade to these versions.
You can now use the CommonService custom resource to add your own certificate authority (CA) certificate. For more information, see Bring your own CA Certificate.

Installer version 3.15.0

Version 3.15 introduces the following updates:

Previewing install command outputs and files to be mirrored: The air-gapped install scripts have been updated so that you can preview the output of the install commands and list of files to be mirrored, to a file, before the commands are run.
Setting up proxy environment variables: If your bastion host, portable compute device, or portable storage device must connect to the internet via a proxy, you must set environment variables on the machine that accesses the internet via the proxy server. Note that the proxy environment variables are supported only on cloudctl version 3.12.1 and higher.
Redis and Analytics Engine powered by Apache Spark are no longer supported: You can no longer install Redis (ibm-cloud-databases-redis-operator) or Analytics Engine powered by Apache Spark (ibm-cpd-ae-operator) during foundational services installation. These operators are not supported from foundational services installer version 3.15 onwards.
Importing and installing network policies: You can import and install foundational services network policies if you have deny-all policy in place. For more information, see Installing network policies for foundational services.
Support of Network File System (NFS) for production: NFS is supported for production environments. For more information, see NFS support and configuration in IBM Cloud Pak foundational services.

Installer version 3.14.0

In version 3.14.0, the following update has been introduced to the air-gapped installation documentation:

Setting up a repeatable air-gap process: Once you complete a CASE save, you can mirror the CASE as many times as you want to. This approach allows you to air gap a specific version of the Cloud Pak into development, test, and production stages. You can now save the CASE to multiple registries (per environment) once and be able to run the CASE in the future without repeating the CASE save process.

Installer version 3.13.0

No significant changes are introduced in installer version 3.13.0.

Installer version 3.12.0

IBM Cloud Pak foundational services 3.12.0 supports OpenShift 4.9.
IBM Cloud Pak foundational services introduces support for POWER10® with OpenShift Container Platform 4.8 and 4.9.

To learn more, see Supported OpenShift versions and platforms.

Installer version 3.11.0

Installer version 3.11.0 is the September, 2021 release. IBM Cloud Pak solutions use this version to install foundational services in their Cloud Paks. The IBM Cloud Pak foundational services operator is the installer. For more information, see Installer v3.x.x.

For more information about the installer-related changes, see What's new in the foundational services.

Installer version 3.10.0

Installer version 3.10.0 is the August, 2021 release. IBM Cloud Pak solutions use this version to install foundational services in their Cloud Paks. The IBM Cloud Pak foundational services operator is the installer. For more information, see Installer v3.x.x.

For more information about the installer-related changes, see What's new in the foundational services.

Installer version 3.9.0

Installer version 3.9.0 is the July, 2021 release. IBM Cloud Pak solutions use this version to install foundational services in their Cloud Paks. The IBM Cloud Pak foundational services operator is the installer. For more information, see Installer v3.x.x.

For more information about the installer-related changes, see What's new in the foundational services.

Installer version 3.8.0

Installer version 3.8.0 is the June, 2021 release. IBM Cloud Pak solutions use this version to install foundational services in their Cloud Paks. The IBM Cloud Pak foundational services operator is the installer. For more information, see Installer v3.x.x.

For more information about the installer-related changes, see What's new in the foundational services.

Each foundational service has an operator. The IBM Cloud Pak foundational services operator installs the Operand Deployment Lifecycle Manager Operator and the IBM NamespaceScope Operator. The Operand Deployment Lifecycle Manager installs the foundational services by using the service operators.

For the documentation of a foundational service that you install, see the documents that are in the operator version of the service. For example, if you install the Identity and Access Management (IAM) service, which is installed by using the ibm-iam-operator version 3.10.x, you must follow the documents that are in IAM (operator) section.

The foundational service operator versions are listed in IBM Cloud Pak foundational services Operators and versions.

You can upgrade from installer version 1.1.0 to installer version 3.6.x, then upgrade from 3.6.x to 3.7.x. You can upgrade from installer version 3.4.x, 3.5.x, 3.6.x, or 3.7.x to version 3.8.0. For more information, see Upgrading foundational services from an operator release.

Installer version 3.7.x

Installer version 3.7.x is the February, 2021 release. IBM Cloud Paks use this version to install foundational services in their Cloud Paks. The IBM Cloud Pak foundational services operator is the installer. For more information, see Installer v3.x.x.

For more information about the installer-related changes, see What's new in the foundational services.

For the documentation of a foundational service that you install, see the documents that are in the operator version of the service. For example, if you install the Identity and Access Management (IAM) service, which is installed by using the ibm-iam-operator version 3.9.x, you must follow the documents that are in IAM (operator) section.

The foundational service operator versions are listed in IBM Cloud Pak foundational services Operators and versions.

You can upgrade from installer version 1.1.0 to installer version 3.7.x, and from installer version 3.4.x, 3.5.x, or 3.6.x to version 3.7.x. For more information, see Upgrading foundational services from an operator release.

Installer version 3.6.x

Installer version 3.6.x is the December, 2020 release. IBM Cloud Paks use this version to install foundational services in their Cloud Paks. The IBM Cloud Pak foundational services operator is the installer. For more information, see Installer v3.x.x.

For the documentation of a foundational service that you install, see the documents that are in the operator version of the service. For example, if you install the Identity and Access Management (IAM) service, which is installed by using the ibm-iam-operator version 3.8.x, you must follow the documents that are in IAM (operator) section.

The foundational service operator versions are listed in IBM Cloud Pak foundational services Operators and versions.

You can upgrade from installer version 1.1.0 to installer version 3.6.x, and from installer version 3.4.x or 3.5.x to 3.6.x. For more information, see Upgrading foundational services from an operator release.

Installer version 3.5.x

Installer version 3.5.x is the September, 2020 release. IBM Cloud Paks use this version to install foundational services in their Cloud Paks. The IBM Common Service Operator is the installer. For more information, see Installer v3.5.x.

Each foundational service has an operator. The IBM Common Service Operator installs the Operand Deployment Lifecycle Manager Operator, which installs the foundational services by using the service operators.

For the documentation of a foundational service that you install, see the documents that are in the operator version of the service. For example, if you install the audit logging service, which is installed by using the ibm-auditlogging-operator version 3.7.x, you must follow the documents that are in Audit logging (operator) section.

All foundational service operators have a higher version. However, the version change is minor. For the September, 2020 release operator versions, see IBM Cloud Pak foundational services Operators and versions.

You can upgrade from installer version 1.1.0 to installer version 3.5.x, and from installer version 3.4.x to 3.5.x. For more information, see Upgrading foundational services from an operator release.

You can upgrade from installer version 3.2.x to installer version 3.4.x. For more information, see Upgrading foundational services from a Helm release.

Installer version 3.4.x

Installer version 3.4.x is the June, 2020 release. This release is the second operator-based installation. IBM Cloud Paks use this version to install foundational services in their Cloud Paks. Thus, the installer version is reset to 3.4.x as the previous version that the Cloud Paks used was 3.3.0. The IBM Common Service Operator is the installer. For more information, see Installer v3.4.x.

For the documentation of a foundational service that you install, see the documents that are in the operator version of the service. For example, if you install the audit logging service, which is installed by using the ibm-auditlogging-operator version 3.6.0, you must follow the documents that are in Audit logging guide 3.5.0.

All foundational service operator versions have a higher version. However, the version change is minor. For the June, 2020 release operator versions, see IBM Cloud Pak foundational services Operators and versions. The service documentation continues to use the March, 2020 release version for the June, 2020 release.

You can upgrade from installer version 1.1.0 to installer version 3.4.x. For more information, see Upgrading foundational services from an operator release.

You can upgrade from installer version 3.2.x to installer version 3.4.x. For more information, see Upgrading foundational services from a Helm release.

Installer version 1.1.0

Installer version 1.1.0 is the March, 2020 release. This release is the first operator-based installation. Thus, the installer version is reset to 1.1.0. The Operand Deployment Lifecycle Manager Operator is the installer. For more information, see Installer v1.1.0.

Each foundational service has an operator. The Operand Deployment Lifecycle Manager Operator installs the foundational services by using the service operators.

For the documentation of a foundational service that you install with the Operand Deployment Lifecycle Manager Operator, see the documents that are in the operator version of the service. For example, if you install the audit logging service, which is installed by using the ibm-auditlogging-operator Version 3.5.0, you must follow the documents that are in Audit logging guide 3.5.0.

For the service operator names and their versions, see IBM Cloud Pak foundational services Operators and versions.

Upgrade from previous releases to installer version 1.1.0 is not supported.

Installer version 3.2.4

Installer version 3.2.4 uses an inception image for installing foundational services. The foundational services are installed as Helm charts.

Available versions

How to check which service version you are using

You can check the installer version in the configmap by running the following command:

oc -n kube-public get ConfigMap ibmcloud-cluster-info -o jsonpath=’{.data.version}’

3.6.0

You can check the Common service operator full version and deployed namespace by running the following command:

oc get csv --all-namespaces | grep common-service-

common-service        IBM Cloud Platform Common Services     3.6.3                   ibm-common-service-operator.v3.5.6             Succeeded
ibm-common-services  IBM Cloud Platform Common Services     3.6.3                   ibm-common-service-operator.v3.5.6             Succeeded

If there is no ibmcloud-cluster-info configmap in your cluster, it means that the service was installed by installer version 1.1.0. You can check the Installed Operators tab in the Red Hat OpenShift Container Platform console to find the accurate version.