Self-serve overview

Self-Serve is a general term to capture all forms of users being able to Chainguard products (images etc.) on their own without any direct help or involvement of Chainguard employees.

Catalog Starter refers to a specific plan that enables users to self-serve up to 5 images for free.

The Catalog Starter plan has the following restrictions:

You must be authenticated with a business email address using one of the following:

• Email and password
• Google (only if your business uses a Google Workspace account)

Other limitations include:

• Only a maximum of 5 Chainguard Images can be used
• Only images from the following tiers are available:
  • AI
  • APPLICATION
  • BASE
• No access to nested UIDP image repos, such as Helm charts

Manage Catalog Starter plans in the Chainguard Console

Sign up and manage a Catalog Starter plan using the Chainguard Console. If you prefer, you can instead use chainctl.

Sign up with the Chainguard Console

To sign up, use this console link or click Get Started on the main login screen.

Manage image selections in the Chainguard Console

To add images in the console:

1. Browse to Settings > Plan and Subscription, which shows your current account status and currently selected images.
2. Click Select images.
3. Use the checkboxes to select or deselect images.
4. Click Review and confirm.

Note: Changes made to image selections can take up to a few hours to process before the images become accessible to you.

Manage Catalog Starter plans using chainctl

Sign up and manage a Catalog Starter plan using chainctl. If you prefer, you can instead use the Chainguard Console.

Sign up with chainctl

The current method for signing up is with chainctl.

To begin, sign up with a brand new account (identity) using the following interactive command:

chainctl starter init

This will require selection of a valid authentication option:

    Choose an identity provider to login to Chainguard

  > Email and password
    Google

Use the arrow keys and click ‘Enter’ to select either, which will launch a browser window to the Chainguard console to complete sign-up.

Add images with chainctl

You can see which images are available using the Chainguard Directory, but remember the images available are limited to the tiers mentioned above.

To add one or more images with chainctl, run the following command, substituting the desired image names for the variables:

chainctl starter add-images $IMAGE1 [$IMAGE2]

After the Chainguard system has processed your request, the image(s) will be accessible. This can take up to a few hours. When available, you will be able to pull the images like this, replacing $ORGANIZATION with your organization’s name and $IMAGE with the desired image’s name.

docker pull cgr.dev/$ORGANIZATION/$IMAGE:latest

Find status with chainctl

To show the status of your catalog starter organization, including the registry path, account provisioning status, image quota usage, and per-image readiness, use:

chainctl starter status

Add additional users to your Catalog Starter plan

To request access for additional users for your organization, use:

chainctl starter request-access