Creating an image pull secret

Create an image pull secret named ibm-entitlement-key in the namespace where the OMEnvironment is configured, to pull the Sterling Order Management System Software container images from the IBM® Entitled Registry and then push those images to the cluster.

If the images are present in any other registry, ensure to create image pull secrets for all such registries, and provide the names of the image pull secrets in the OMEnvironment manifest as shown in the following example.

image:
  imagePullSecrets:
  - name: <image-Pull-Secret1> 
  - name: <image-Pull-Secret2>

Procedure

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 Container software library on your left.
Click Copy key to copy the generated entitlement key and save the entitlement key to a safe location for later use.
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 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 Sterling Order Management System Software. In this case, the entitlement key is not valid for installing the software.
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.
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"
Run the following command to pull the container images from IBM Entitled Registry:
```
<containerization_tool> pull cp.icr.io/cp/ibm-oms-<edition>/<image_name>:<image_tag>-<cpu_architecture>
```
Here,
- <containerization_tool> refers to buildah, docker, or podman based on your platform.
- <edition> refers to the Sterling Order Management System Software professional or enterprise edition.
- <image_name> refers to om-app, om-agent, or om-base. For more information, see Registry image names for Sterling Order Management System Software Professional and Enterprise editions.
- <image_tag> refers to the supported image tags. 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.
  For example, buildah pull cp.icr.io/cp/ibm-oms-professional/om-base:10.0.0.21-amd64

Optional. Run the following command to create Docker pull secret for pulling the container images from IBM Entitled Registry:

kubectl create secret docker-registry <secret name> --docker-username="iamapikey" --docker-password="<Entitled registry API key>" --docker-email="<email address" --docker-server="cp.icr.io" -n service