Installing and configuring IBM z/OS Package Manager

Follow the steps in this task to install IBM z/OS Package Manager 2.0.0 or later versions. Before installing IBM z/OS Package Manager, see Getting started with IBM z/OS Cloud Broker and z/OS Package Manager.

Note: If you need to change state or installation directories that are already installed, you must uninstall IBM z/OS Package Manager, as well as the products installed and reinstalled.

The following checklist summarizes the key steps for a successful installation.

Before importing

Go to Importing operator collections to create an endpoint, import the IBM z/OS Package Manager Operator collection, map the z/OS endpoint, and map the namespace.

You need to complete the prerequisites within that page, which includes ensuring that an SSH key has been generated and that the public key has been copied to the z/OS endpoint. The SSH key is used to authenticate connections to the specified endpoints.

When you import the IBM z/OS Package Manager Operator collection through the Ansible® galaxy collection installation URL or manual upload, you must have either a local copy of the operator collection to be imported by z/OS Cloud Broker or the Ansible galaxy URL of the operator collection.

Note: If you are using z/OS Package Manager version 1.0.x or older, see Installing and configuring z/OS Package Manager 1.0.x topic.

Before creating the z/OS Package Manager instance

As part of the IBM z/OS Package Manager installation process, a product-related OCI artifact is pulled from a specified registry. By default, the z/OS Package Manager pulls software from the IBM container registry. If you want to use your own enterprise registry instead, enter the registry and namespace during the installation of the IBM z/OS Package Manager.

You can also set up a registry proxy server if needed, to pull and install the OCI artifacts. You can specify the registry proxy credentials during IBM z/OS Package Manager instance creation.

To create an encrypted credential (secret) in your namespace, download and install the zoscb-encrypt CLI tool. Choose one of the folowing methods to invoke the zoscb-encrypt CLI tool.

Method 1: Create an encrypted registry credential secret by using environment variables.

  1. Run the following command to generate encrypted credentials in your namespace.

    export SECURED_SECRET_PROPERTIES="registry-user=<user> registry-password=<password>" && zoscb-encrypt credential-secret -n <credential-name> -l --namespace <namespace> && unset SECURED_SECRET_PROPERTIES
    

Method 2: Create an encrypted registry credential secret by using the CLI prompt.

  1. Run the following command to start a prompt where the password can be provided without displaying any of the characters.

    zoscb-encrypt  credential-secret -n <credential-name> --secret-properties="registry-user=<user>" --secure-secret-properties --namespace <namespace>.
    
  2. When prompted for property name, specify registry-password and hit Enter.

  3. When prompted for the value of registry-password, specify the password (characters are hidden) and hit Enter.

  4. When prompted for another property name, type in f to finish and exit the prompt.

To view the encrypted credential secret that is generated, go to the OpenShift namespace, click on Workloads and then Secrets. The secret can be viewed in any credential secret variable. For example, Registry User Credential drop-down on the z/OS Package Manager instance creation page.

Alternatively, you can navigate to Workloads>Pods and click the z/OS Package Manager pod. Click Terminal and invoke the zoscb-encrypt CLI with a set of arguments to create a secret.

Install z/OS Package Manager on z/OS

Take the following steps to create an IBM z/OS Package Manager instance. These steps are to be completed on the Red Hat OpenShift Container Platform web console.

  1. In the Installation Operators view, navigate to IBM Z and Cloud Modernization Stack- IBM z/OS Package Manager Operator and click its name.

  2. Click Create instance in the IBM z/OS Package Manager section from the Details tab.

  3. You can configure the instance with Form view option selected.

    a. Enter the instance name, which is required.

    b. Optional: Fill the box under Labels. Labels can be used to view all of your resources by a specific label or name when on the Red Hat OpenShift Platform web console.

    c. Enter the z/OS endpoint to be used. This is the endpoint that you want to install the IBM z/OS Package Manager on to. d. Check accept under License.

    e. Enter the directory where you want to install IBM z/OS Package Manager on the z/OS endpoint. The default is /usr/lpp/zpm.

    f. Enter the directory where you want to save configuration and state data for the IBM z/OS Package manager on the z/OS endpoint. The default is /var/zpm.

    g. Enter the directory path for the Java™ 8 (64-bit) SDK on the z/OS endpoint. The default is /usr/lpp/java/J8.0_64.

    h. Optional: Enter the registry location that you want the IBM z/OS Package Manager to use to pull software to install on the z/OS endpoint. This information can also be provided while installing a product. If the registry requires authentication, a credential containing username and password must be provided. The default is icr.io/zpm, the IBM Cloud Container Registry where officially supported IBM product OCI Artifacts are available.

    i. Optional: This variable is available in z/OS Package Manager 2.1.0 and later. Select the registry user credential (secret) that IBM z/OS Package Manager will use to authenticate and pull software from the registry location. The credential must contain registry-user and registry-password key values in the secret. For instructions, see Before creating the z/OS Package Manager instance section.

    j. Optional: Enter a proxy registry hostname.

    k. Optional: Enter a proxy port for registry access.

    l. This variable is available in z/OS Package Manager 2.1.0 and later. Select the registry proxy user credential (secret) that IBM z/OS Package Manager will use to authenticate and pull software from the registry location. The credential must contain registry-user and registry-password key values in the secret. For instructions, see Before creating the z/OS Package Manager instance section.

    m. Enter the high-level qualifier for any product data sets that are created during product installations. The default is ZPM.

    n. Click Create to create the IBM z/OS Package Manager instance.

You can return to the Details tab to check the instance creation status under Conditions section.

The Succeeded status indicates that the IBM z/OS Package Manager instance is successfully installed.