Downloading the component scaling guidance PDF from the IBM Entitled Registry

Detailed component sizing guidance is available in a PDF file that you can download from the IBM Entitled Registry.

Before you begin

To complete this task, you need:
  • Your IBM Entitlement API key.
    If you do not have an installation environment variables script, run the following command to set the IBM_ENTITLEMENT_KEY environment variable:
    export IBM_ENTITLEMENT_KEY=<your-api-key>
  • A workstation that meets the following requirements:
    • Can access the IBM Entitled Registry.

      To validate that you can connect to the IBM Entitled Registry, run the following command:

      curl -v https://icr.io
      The command returns a message similar to: 
      * Connected to icr.io (169.60.98.86) port 443 (#0)

      The IP address might be different.

    • Has Docker or Podman installed.

      For details, see Client workstation requirements.

About this task

The PDF is available in the IBM Entitled Registry.

The PDF provides compute estimates based on testing with representative workloads. It is intended to provide a starting point for scaling existing IBM Software Hub deployments based on your workload changes and requirements.

Important: Workload requirements are implementation-specific and can vary based on your use cases. Work with your IBM Support or IBM Sales representative to size your cluster based on your workloads and the monitoring data from your IBM Software Hub cluster.

Procedure

To pull the PDF from the IBM Entitled Registry:

  1. Ensure that Docker or Podman is running on the workstation.
  2. Log in to the IBM Entitled Registry:
    • Docker
      docker login cp.icr.io -u cp -p ${IBM_ENTITLEMENT_KEY}
    • Podman
      podman login cp.icr.io -u cp -p ${IBM_ENTITLEMENT_KEY}
  3. Set the VERSION environment variable to the version of the PDF that you want to download.
    The following command assumes that you want to download the PDF for the latest version of IBM Software Hub.
    export VERSION=5.3.1
  4. Pull the image that contains the PDF from the IBM Entitled Registry:
    • Docker
      docker pull cp.icr.io/cp/cpd/cpd-sizing:${VERSION}
    • Podman
      podman pull cp.icr.io/cp/cpd/cpd-sizing:${VERSION}
  5. Create a container from the image:
    • Docker
      docker create --name cpd-sizing cp.icr.io/cp/cpd/cpd-sizing:${VERSION} /bin/bash
    • Podman
      podman create --name cpd-sizing cp.icr.io/cp/cpd/cpd-sizing:${VERSION} /bin/bash
  6. Copy the PDF from the image:
    • Docker
      docker cp cpd-sizing:/sizing-pdf.pdf .
    • Podman
      podman cp cpd-sizing:/sizing-pdf.pdf .
    The PDF file, sizing-pdf.pdf, is downloaded to the working directory.