Preparing to install and upgrade services
After the IBM® Cloud Pak for Data control plane is installed, a Red Hat® OpenShift® project administrator can install the services that support your business needs on the platform. Use the guidance in the following sections to ensure that you have the required tools and information before you install or upgrade any services on your cluster.
Preparing your installation node
You can install or upgrade Cloud Pak for Data services from a machine that resides outside of your Red Hat OpenShift Container Platform cluster.
- Mac OS
- Linux®
- IBM Power® Systems
- IBM Z®
In addition, the machine from which you run the commands must meet the appropriate requirements for your environment.
Requirements for the machine | Cluster is connected to the internet | Cluster is air-gapped |
---|---|---|
Can connect to the cluster. | ✓ | ✓ |
Is connected to the internet. | ✓ | |
Has the oc command-line interface.You can download the appropriate
client tools for your operating system from Red Hat OpenShift:
Ensure that the version is compatible with the version of Red Hat OpenShift on your cluster. |
✓ | ✓ |
Has the Cloud Pak for Data command-line
interface. See Obtaining the installation files. Use the same version of the command-line interface each time you run the commands. |
✓ | ✓ |
Has the updated repo.yaml file in the same directory as the Cloud Pak for Data command-line interface. | ✓ | |
Has the cpd-cli-workspace directory, which contains the required files. | ✓ |
Ensuring you have access to the required images
The images for Cloud Pak for Data services are stored in your registry server. How you obtain the images depends on your installation environment:
- Clusters connected to the internet
- The repo.yaml file that is shipped with the Cloud Pak for Data installer includes information about the default repository where many of the services are available. However, some services are not in the default repository. Review the information in Obtaining the installation files to determine whether you need to include any additional entries in your repo.yaml file.
- Air-gapped clusters
- If you are running Cloud Pak for Data on an
air-gapped cluster, ensure that a Red Hat OpenShift
administrator has completed the appropriate task to download the required files for the service:
- If you are installing the service, ensure that a cluster administrator has completed the steps in Preparing for air-gapped installations.
- If you are upgrading the service, ensure that a cluster administrator has completed the steps in Preparing for air-gapped upgrades.
Ensuring that the required storage classes exist
Each service has specific storage requirements. Work with your administrator to ensure that the required storage exists for the services that you plan to install.
- For information about the storage that each service supports, see System requirements for services.
- For information about how to set up storage for your cluster, see Storage considerations.
Collecting information about your cluster from your administrator
To successfully install or upgrade Cloud Pak for Data services, you must have information about your Red Hat OpenShift cluster.
Ensure that you collect the following information from your Red Hat OpenShift cluster administrator:
Required information | Description |
---|---|
OpenShift_URL:port | The URL and port number to use when logging in to your
Red Hat OpenShift cluster. Ensure that you have
the appropriate credentials to log into the cluster using Value: Your cluster administrator should tell you whether your cluster is connected to the internet or is air-gapped. |
Assembly_version | The version of the assembly to
install. Value: |
Cluster_architecture | The architecture of the cluster hardware. Valid values include:
Value: |
Project | The project (namespace) where the Cloud Pak for Data control plane is installed. Value: |
Tethered_project_name | The tethered project where you want to install the service.
Value: |
Storage_class_name | The name of the storage class to use to provision storage
for the service. For information about the types of storage that the service supports, see System requirements for services. If your cluster is not set up to use dynamic storage provisioning, work with an IBM Support representative to determine how you can specify persistent volume claims when you install the service. For upgrade, specify the name of the storage class that was used when the service was installed. The storage class will be used for any new persistent volumes. Value: |
Registry_location | The location to store the images in the registry
server. If you are running the installation or upgrade from a cluster that is connected to the internet, ensure that you have the appropriate credentials to push images to the registry server. For upgrade, unless you changed the location of the registry server after you installed the service, use the same value that you specified when you installed the service. You can run the following command to find the route to the
registry:
Value: Guidance for Red Hat OpenShift registry users:
|
Registry_from_cluster | The location from which pods on the cluster
can pull images. For upgrade, unless you changed the location of the registry server after you installed the service, use the same value that you specified when you installed the service. Value: Guidance for Red Hat OpenShift registry users: You can run the
following command to get the internal name of the Red Hat OpenShift registry
service:
|
Image_directory_location | The location of the cpd-cli-workspace directory.
The cpd-cli-workspace directory is created when a cluster administrator
runs the command to download the images. By default, the directory is created within the directory
that contains the Cloud Pak for Data command-line
interface. For details, see:
If you are installing the service from the same machine, the change to the directory indicated by the administrator. If you are installing the service from a different machine, transfer the files from the machine where the download command was run. Value: |