Obtaining container images from IBM Entitled Registry

Obtaining container images involves securing an entitlement key, configuring the entitlement information, and then pulling the images from the IBM Entitled Registry.

Procedure

  1. Obtain an entitlement key from IBM Container Software Library by using your IBMid and password that are associated with the entitled software.

    If you are not directed to the Entitlement page, click View library and click Get entitlement key.

  2. Click Copy key to copy the generated entitlement key and save the entitlement key to a safe location for later use.
  3. Optional: Click View library to verify the validity of the entitlement key.

    You can view the list of products that you are entitled to. If IBM® Sterling Order Management System Software is not listed or if the View library link is disabled it indicates that the identity with which you are logged in to the container library does not have an entitlement for IBM Sterling Order Management System Software. In this case, the entitlement key is not valid for installing the software.

  4. Configure the entitled registry information by completing the following steps:
    1. Run export commands to set ENTITLED_REGISTRY to cp.icr.io.
    2. Set ENTITLED_REGISTRY_USER to cp.
    3. Set ENTITLED_REGISTRY_KEY to the entitlement key that you have saved.
  5. Run the following command to log in to IBM Entitled Registry: 
    <containerization_tool> login "$ENTITLED_REGISTRY" -u "$ENTITLED_REGISTRY_USER" -p "$ENTITLED_REGISTRY_KEY"

    Here, <containerization_tool> refers to buildah, docker, or podman based on your platform.

    For example, buildah login "$ENTITLED_REGISTRY" -u "$ENTITLED_REGISTRY_USER" -p "$ENTITLED_REGISTRY_KEY"

  6. Run the following pull command to obtain the container images from IBM Entitled Registry:
     
    <containerization_tool> pull cp.icr.io/cp/ibm-oms-enterprise/<image_name>:<image_tag>-<cpu_architecture>
    Where:
    <containerization_tool>
    Refers to buildah, docker, or podman based on your platform.
    <image_name>
    Refers to name of the application image. For more information about the list of images, see Registry image names for IBM Sterling Intelligent Promising Standard package.
    <image_tag>
    Refers to the supported image tag for the release. For the supported Operator and container image versions, see Software Product Compatibility Reports.
    <cpu_architecture>
    Refers to the supported CPU architectures namely amd64 or ppc64le.
    Example:
    buildah pull cp.icr.io/cp/ibm-oms-enterprise/sip-iv-audit:10.0.2309.1-amd64
    Note: From August 10.0.2406.2 release, to deploy IBM Sterling Intelligent Promising, you no longer need to obtain ubi-minimal, openjdk-11, or openssl images, as these images are replaced by the sip-utils image. For more information, see sipUtils parameter.