IBM Cloud Pak® CLI (cloudctl) catalog commands (catalog)

Learn about the cloudctl catalog commands that you can run to manage your Helm charts.

Commands

cloudctl catalog add-repo

Add a Helm repository.

Example:

cloudctl catalog add-repo --name <repo-name> --url <repo-url>

OPTIONS:
   --name value  Name of the Helm repository
   --url value   URL of the Helm repository

cloudctl catalog charts

List Helm charts from the cluster Helm repositories.

Example:

cloudctl catalog charts [--repo HELM_REPO_NAME]

OPTIONS:
   --json                  Display output in JSON format
   --repo value, -r value  The name of the target Helm repository. Run 'cloudctl catalog repos' to list the repositories.
   -s                      Do not show the column headers in the output

cloudctl catalog create-archive

Create an archive file that contains Docker images and Helm charts for distribution to clusters without Internet access.

Example:

cloudctl catalog create-archive --archive ARCHIVE_TO_CREATE [--chart CHART_ARCHIVE_OR_DIR | --spec SPEC_FILE]] [--values VALUES_YAML_FILE]
    Before you create the archive, you must set up Docker. <!--See https://www.ibm.com/support/knowledgecenter/SSBS6K_3.2.1/manage_images/using_docker_cli.html-->

OPTIONS:
   --architectures value            The result only includes images for the architectures specified [amd64, ppc64le, s390x, etc].
   --archive value, -a value        The path to write the archive tgz.
   --batch-images, -b               Save images in batch. All images are saved together, which saves space through the de-duplication of shared layers of images. By default, Docker images are saved to separate files. WARNING: This flag cannot be used if the version of the cluster to load the archive into is version 3.1.0 or earlier.
   --chart value, -c value          The path to the Helm chart tgz archive or chart directory.
   --pak-extension value, -p value  The path to the Pak extension tgz archive or directory.
   --skip-cleanup                   Do not delete images pulled to the local Docker repository during archive creation.
   --skip-pull                      Do not pull images. Images should be in the local Docker repository.
   --spec value, -s value           The path to a spec file to create an archive of charts.
   --values value, -f value         The path to an optional values.yaml file containing values to override in the chart values.yaml file.

cloudctl catalog delete-chart

Delete a Helm chart from the internal registry.

Example:

cloudctl catalog delete-chart --name HELM_CHART_NAME [--repo HELM_REPO_NAME] [--version HELM_CHART_VERSION]

OPTIONS:
   --name value, -n value     The name of the Helm chart to delete
   --repo value, -r value     The name of the target Helm repository. Run 'cloudctl catalog repos' to list the repositories.
                              If not specified, the 'local-charts' repository is used.
   --version value, -v value  The version of the Helm chart to delete

cloudctl catalog delete-repo

Delete a Helm repository.

Example:

cloudctl catalog delete-repo NAME [-f]

OPTIONS:
   -f  Delete a Helm repository with force without any user prompts

cloudctl catalog load-archive

Load Docker images and Helm charts from a catalog archive file or an expanded archive path.

Example:

cloudctl catalog load-archive --archive ARCHIVE [--registry REGISTRY] [--repo HELM_REPO_NAME]
    Before you load the archive, you must set up Docker. <!--See https://www.ibm.com/support/knowledgecenter/SSBS6K_3.2.1/manage_images/using_docker_cli.html-->

OPTIONS:
   --archive value, -a value  The path to a catalog archive tgz file or a path to an expanded archive.
   --password value           Docker password. This is required if you are using macOS and can also be set in the environment as DOCKER_PWD.
   --registry value           The registry that the docker image will be pushed to. Example: 'mycluster.icp:8500/namespace'.
                              If not specified, images are uploaded to the registry associated with the default cluster CA domain and the current targeted namespace.
                              Run 'cloudctl target' to see the current targeted namespace.
   --repo value, -r value     The name of the target Helm repository. Run 'cloudctl catalog repos' to list the repositories.
                              If not specified, the 'local-charts' repository is used.
   --username value           Docker username. This is required if you are using macOS and can also be set in the environment as DOCKER_USER.

cloudctl catalog load-chart

Load a Helm chart archive to a cluster.

Example:

cloudctl catalog load-chart --archive HELM_CHART_ARCHIVE [--repo HELM_REPO_NAME]
    Before you load a Helm chart, you may need to push your images to the private registry. <!--See https://www.ibm.com/support/knowledgecenter/SSBS6K_3.2.1/manage_images/using_docker_cli.html-->

OPTIONS:
   --archive value, -a value  The path to the Helm chart tgz archive or chart directory
   --registry value           If the chart images are loaded into a private registry, use this flag to specify the registry and the load will modify the values.yaml of the chart to reference the private registry, example: 'mycluster.icp:8500/namespace'
   --repo value, -r value     The name of the target Helm repository; run 'cloudctl catalog repos' to list the repositories
                              If not specified, the 'local-charts' repository is used
   --trim-images              If using --registry, this option will first remove any registry or namespaces from images in the chart; with a --registry of 'mycluster.icp:8500/default', an image value of 'ibmcom/icp-image:latest' becomes 'mycluster.icp:8500/default/icp-image:latest'

cloudctl catalog load-images

Load Docker images to your product internal Docker registry.

Example:

cloudctl catalog load-images --registry REGISTRY [--repo IMAGE_REPO_NAME] [--repo-pattern IMAGE_REPO_REGEXP] [--tag IMAGE_TAG_NAME] [--tag-pattern IMAGE_TAG_REGEXP] [-f]

OPTIONS:
   -f                    Force the load of images with no user prompts
   --registry value      The host name of the registry to load the images too
   --repo value          The exact name of the repository of the images to load
   --repo-pattern value  The pattern to match the repository of the images to load
   --tag value           The exact tag name of the images to load
   --tag-pattern value   The pattern to match the tag of the images to load

cloudctl catalog repos

List all catalog Helm repositories.

Example:

cloudctl catalog repos

OPTIONS:
   --json  Display output in JSON format
   -s      Do not show the column headers in the output

cloudctl catalog sync

Synchronize charts across all Helm repositories in a cluster.

Example:

cloudctl catalog sync

OPTIONS:
   --repo value, -r value  The name of the target Helm repository. Run 'cloudctl catalog repos' to list the repositories.