IBM Cloud Docs
Setting up the internal image registry for Satellite clusters

Setting up the internal image registry for Satellite clusters

Satellite

By default, the internal registry does not run in your Satellite cluster because no backing storage is set up for the internal registry. Complete the following tutorial to configure the internal image registry in your Satellite cluster with IBM Cloud Object Storage as the backing storage.

This tutorial covers setting up the image registry by using IBM Cloud Object Storage. However, you can also use non-persistent storage on the worker node. For more information, see Storing images in the worker node empty directory.

Create an IBM Cloud Object Storage instance that meets the requirements

  1. In the IBM Cloud console, navigate to the Resources menu and list your storage instances.
  2. Identify your Object Storage instances and find the Location column. If an instance was created in IBM Cloud, its location is listed as Global.
  3. If you do not have a Global instance that meets the requirements, follow the steps to create one.
    1. From the IBM Cloud Object Storage, click Create Instance.
    2. Under Choose an Infrastructure, select the IBM Cloud option.
    3. Select a pricing plan and a service name.
    4. Choose the resource group where your Satellite components are stored.
    5. Click Create. Note that it might take several minutes for your instance to provision.

Create a bucket to use for your image registry

Create a bucket to use when you set up your image registry. Your bucket must be configured with regional resiliency. For more information about creating a bucket, see Setting up IBM Cloud Object Storage.

  1. Click on your Object Storage instance.
  2. Click Create a bucket.
  3. Select the option to Customize your bucket.
  4. Under Resiliency, select Regional.
  5. From the Location drop down menu, choose the region that is closest to where your location is managed from. For example, if your location is managed from wdc (Washington, DC), choose the us-east region. To check where a Satellite location is managed from, run ibmcloud sat location ls in the CLI.
  6. Under Storage class, select Standard.
  7. Configure the remaining categories to your preferences.
  8. Click Create bucket.
  9. Create service credentials that enable your cluster to communicate with your Object Storage instance.
  10. In the navigation pane, click Service credentials, then click New credential.
  11. Enter a name for the new credential.
  12. From the drop down menu, choose the Writer role.
  13. Click Advanced options, then select the option to Include HMAC Credential.
  14. Click Add.
  15. In the Service Credentials table, expand your new credential. Note the access_key_id and the secret_access_key_id. Do not share these credentials with anyone. Example credentials to save.
    "cos_hmac_keys": {
    "access_key_id": "1111111a1111111a11aa1a111111111a11aa1a111a11a1a1",
    "secret_access_key": "222222b222222b22bb2b22222222b22bb2b222b22b2b2"
}

Create a secret that contains your COS service credentials

In the CLI, create a secret with the service credentials you created and saved.

  1. Log in to your account. If applicable, target the appropriate resource group. Set the context for your cluster.
  2. Create the secret.
    oc create secret generic image-registry-private-configuration-user --from-literal=REGISTRY_STORAGE_S3_ACCESSKEY=<access_key_id> --from-literal=REGISTRY_STORAGE_S3_SECRETKEY=<secret_access_key> --namespace openshift-image-registry

Update the Red Hat OpenShift Registry operator CRDs

  1. Change the management state of the Red Hat OpenShift Register operator.
    oc patch configs.imageregistry.operator.openshift.io cluster --type merge --patch '{"spec":{"managementState":"Managed"}}'
  2. Edit the configuration storage attributes to store images in your Object Storage bucket.
    1. Find and save your Satellite location's regional link endpoint. In the output, the endpoint is listed under the Address column.
      ibmcloud sat endpoint ls --location <location_name> | grep satellite-cosRegional
      Example output
      ID                           Name                                              Destination Type   Address       
cavvku1p1h1gcfgk1kn1_uwokw   satellite-cosRegional-cavvku1p1h1gcfgk1kn1        cloud              TLS   i11aa11a1a1a11a11-1a11a1aaa1a1a1a1a-c000.us-east.satellite.appdomian.cloud:11111
    2. Open the file editor in the CLI.
      oc edit configs.imageregistry.operator.openshift.io/cluster
    3. Find the following section to edit.
      storage:
    emptyDir: {}
    managementState: Managed
storageManaged: true
    4. Replace emptyDir: {} with your bucket information and location endpoints.
      s3:
  bucket: <bucket_name>
  region: <bucket_region>
  regionEndpoint: <location_link_endpoint>
  virtualHostedStyle: false
      Example section after adding the bucket and location information.
        storage:
    managementState: Managed
    s3:
      bucket: my_bucket
      region: us-east
      regionEndpoint: https://i11aa11a1a1a11a11-1a11a1aaa1a1a1a1a-c000.us-east.satellite.appdomian.cloud:11111
      virtualHostedStyle: false
  storageManaged: true
    5. Save and apply the changes.

Verify your changes

Verify that the image registry was configured by checking for a pod that begins with image-registry- in the openshift-image-registry namespace.

  1. Run the following command.

    oc get pod -n openshift-image-registry

  2. Review the output and confirm that the registry pod is Running.

    Example output

    NAME                                               READY   STATUS      RESTARTS      AGE
image-registry-63p54b8add-vkjju                    1/1      Running      0              16m