Creating the image pull secret in the cluster

Edit online

The Rhapsody Systems Engineering images are stored in IBM Entitled Registry. They are pulled from the registry and used to install the Rhapsody Systems Engineering application in the supported cluster.

About this task

An image pull secret must be created to pull the container image in the pod. The entitlement key that is obtained from the registry is used to create the image pull secret. The administrator can create a new image pull secret. It is used to add the image pull secret to grant access for pods to pull images from your registry.

Procedure

  1. To obtain the entitlement key from the registry, complete the following substeps:
    1. Go to the IBM container software library link.
    2. Click View library. The Access your container software page opens.
    3. To copy the entitlement key in the clipboard, on the Entitlement key section, click Copy key.
    4. Paste the entitlement key in a text editor that you use. You are required to provide the entitlement key when you create the image pull secret.
  2. To add Rhapsody Systems Engineering to the entitlement key, complete the following susbteps:
    1. Go to https://myibm.ibm.com/products-services/containerlibrary.
    2. Log in by using your IBM ID.
    3. Click Container software library.
    4. Click the Self-Nominate form, and then fill the form with required details.
    5. Search for Rhapsody Systems Engineering and add it.
    6. Select the entitlement keys.
    7. Click Add key, and copy the key to use it for creating the secret.
  3. You can create the image by using the supported cluster or by using command line inputs.
    • To create the image pull secret in the Red Hat® OpenShift® cluster by using the console, complete the following substeps:
      1. Log in to the Red Hat OpenShift cluster platform by using the Red Hat OpenShift administrator credentials.
      2. Go to Projects, and select the project where you want to install the Rhapsody Systems Engineering instance.
      3. Go to Workloads > Secrets.
      4. Select Image Pull Secret from the Create list.
      5. On the Create Image Pull Secret page, enter the following details:
        1. In the Secret Name field, enter ibm-entitlement-key.
        2. From the Authentication Type list, select Image registry credentials.
        3. In the Registry Server Address field, enter cp.icr.io/cp.
        4. In the Username field, enter cp.
        5. In the Password field, enter the <entitlement-key> from the text editor.
        6. In the Email field, enter <your-email-address>.
    • To create the secret by using command line, run the commands for Red Hat OpenShift or Kubernetes cluster:
      Red Hat OpenShift
      1. To select the project where you want to the Rhapsody Systems Engineering instance, run the following command:
        oc project <project name>
      2. Run the following command:
        oc create secret docker-registry ibm-entitlement-key --docker-server = <registry_server> --docker-username = <user_name>--docker-password = <password> --docker-email = <email>
      For more information, see Using image secrets in Red Hat OpenShift.
      Kubernetes
      kubectl create secret docker-registry ibm-entitlement-key --docker-server=<your-registry-server> --docker-username=<your-name>--docker-password=<your-password>  --docker-email=<your-email>
      where
      • <your-name> = username. Enter cp as username.
      • <your-password> = <entitlement-key-token>
      • <your-email> = <your-email-address>
      • <your-registry-server> = <your-registry-server>. By default, the registry server uses cp.icr.io/cp.