Preparing for air-gapped installations

If you plan to install IBM® Cloud Pak for Data or a service on an air-gapped cluster, a cluster administrator must make the required files available to the cluster before installation.

Before you begin

Required role: To complete this task, you must be a cluster administrator.

Ensure that the Mac OS or Linux machine from which you will run the commands is connected to the internet.

Download the Cloud Pak for Data command-line interface to the machine from which you will run the commands. See Obtaining the installation files.

If you are using the internal registry server on Red Hat® OpenShift®, create the project (namespace) where you will deploy the software. The project must exist before you push the images to the registry server.

About this task

You will download the required files for the software that you want to install and then transfer the files to a machine that is accessible from the cluster.

If you are installing multiple services on Cloud Pak for Data, you must repeat this task for each service that you want to install.

Procedure

  1. Change to the directory where you extracted the Cloud Pak for Data installation command-line interface.
  2. Run the following command to download the required files to your local machine:
    ./cpd-Operating_System preloadImages --repo repo.yaml \
    --assembly Assembly_name \
    --arch Processor_architecture
    --action download \
    Replace the following values:
    Variable Replace with
    Operating_System For Linux, specify linux. For Mac OS, specify darwin.
    Assembly_name For the Cloud Pak for Data control plane, specify lite. For a service, specify the assembly name of the service.
    Processor_architecture For x86-64, remove this flag or specify x86_64. For POWER, specify ppc64le.

    Not all services are offered on POWER. For information about which services run on POWER, see System requirements for services.

    The files are saved to the cpd-Operating_System-workspace directory, which is created in the directory that contains the Cloud Pak for Data command-line interface.

    The directory contains the images, assembly manifest files, module manifest files, charts, and other artifacts that are required for installation.

    Depending on the assembly that you specify, the directory might contain one or more directories that contain YAML files that describe the changes that must be made to the cluster. When you set up the cluster, you can optionally use these files to automatically apply the changes to your cluster. (These files will be used only if you run the cpd adm command with the --apply parameter.)

  3. Transfer the following items to a machine that can connect to the cluster and to the registry server:
    • The cpd-Operating_System-workspace directory. Ensure that the directory structure remains unchanged.
    • A copy of the Cloud Pak for Data installation command-line interface. Ensure that the command-line interface is compatible with the machine that you are transferring the files to and that it is the same version as the command-line interface that you ran in the preceding steps.
  4. From the machine that can connect to the cluster, run the following command to push the images to the registry server.
    Important: If you are using the internal registry server on Red Hat OpenShift:
    • Log in to the oc command-line interface before you push the images:
      oc login
    • If you are using the default self-signed certificate, specify the --insecure-skip-tls-verify parameter to prevent x509 errors.
    ./cpd-Operating_System preloadImages \  
    --assembly Assembly_name \
    --arch Processor_architecture
    --version Assembly_version \
    --action push \
    --ask-push-registry-credentials \
    --load-from Image_Directory_Location \
    --transfer-image-to Registry_location \ 
    Replace the following values:
    Variable Replace with
    Operating_System Use the value that you specified when you ran the cpd preloadImages command with the --action download parameter.
    Assembly_name Use the value that you specified when you ran the cpd preloadImages command with the --action download parameter.
    Processor_architecture Use the value that you specified when you ran the cpd preloadImages command with the --action download parameter.
    Assembly_version The version of the assembly that is specified in the cpd-Operating_System-workspace/assembly/Assembly_name/arch/versions.yaml file.
    Image_Directory_Location The location of the cpd-Operating_System-workspace directory.
    Registry_location The location where you want to place the images on the registry server.

What to do next

Provide the following information to the person who will install the software.
Required information Description
OpenShift_URL:port The URL to use when logging in to the OpenShift cluster.
Assembly_name The name of the assembly to install.
Processor_architecture The processor architecture. If you downloaded the x86-64 images, you can omit this information. If the processor architecture is not specified, the x86-64 images are used by default.
Assembly_version The version of the assembly to install.
Project The project where the software will be installed.
Storage_class_name The storage class to use for the software.
Registry_location The location of the images that you pushed to the registry server.
Registry_from_cluster The location from which pods on the cluster can pull images.

To install the Cloud Pak for Data control plane, follow the instructions in Installing Cloud Pak for Data on a Red Hat OpenShift cluster.

To install a service, follow the appropriate instructions for the service. For services provided by IBM, you can find the installation instructions for each service in the Services in the catalog section of the documentation.