From 8ad42878fbb077f33d2d831d9e296c0466e1b06d Mon Sep 17 00:00:00 2001 From: Matthew Helmke Date: Tue, 12 May 2026 14:38:38 -0500 Subject: [PATCH 1/4] Add self-serve to docs --- content/chainguard/self-serve/_index.md | 10 +++ content/chainguard/self-serve/overview.md | 81 +++++++++++++++++++++++ 2 files changed, 91 insertions(+) create mode 100644 content/chainguard/self-serve/_index.md create mode 100644 content/chainguard/self-serve/overview.md diff --git a/content/chainguard/self-serve/_index.md b/content/chainguard/self-serve/_index.md new file mode 100644 index 0000000000..54a306a5aa --- /dev/null +++ b/content/chainguard/self-serve/_index.md @@ -0,0 +1,10 @@ +--- +title : "Self-serve" +lead: "" +description: "Signing yourself up for Chainguard products" +type: "article" +date: 2026-05-12T01:00:01+00:00 +lastmod: 2026-05-12T01:00:01+00:00 +draft: false +weight: 005 +--- diff --git a/content/chainguard/self-serve/overview.md b/content/chainguard/self-serve/overview.md new file mode 100644 index 0000000000..c988a30ae8 --- /dev/null +++ b/content/chainguard/self-serve/overview.md @@ -0,0 +1,81 @@ +--- +title : "Self-serve overview" +lead: "" +description: "Signing yourself up for Chainguard products" +type: "article" +date: 2026-05-12T01:00:01+00:00 +lastmod: 2026-05-12T01:00:01+00:00 +draft: false +weight: 010 +--- + +**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. + +This applies to both paying customers/prospects, as well +as *free-tier* users who have not formally engaged with us (yet). + +**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 + +## 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: + +```shell +chainctl catalog-starter create +``` + +This will require selection of a valid authentication option: + +```shell + Choose an identity provider to login to Chainguard + + > Google + Email and password +``` + +Click 'Enter' for either, which will launch a browser window to the Chainguard console to complete sign-up. + +## Add images + +You can see which images are available [using the Chainguard Directory](chainguard/chainguard-images/how-to-use/chainguard-directory/), but remember the images available are limited to the tiers mentioned above. + +To add one or more images, run the following command, substituting the desired image names for the variables: + +```shell +chainctl image entitlements add-images $IMAGE1 $IMAGE2 +``` + +After the Chainguard system has processed your request, the image(s) will be accessible. This will take anywhere from a few minutes (best case) 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. + +```shell +docker pull cgr.dev/$ORGANIZATION/$IMAGE:latest +``` + +## Add additional users + +To request access for additional users for your organization, use: + +```shell +chainctl catalog-starter request-access +``` From 869652c5919d04f8d7bf838b4f1b3985ff1641ca Mon Sep 17 00:00:00 2001 From: Matthew Helmke Date: Tue, 12 May 2026 14:46:17 -0500 Subject: [PATCH 2/4] Adjust description of section page --- content/chainguard/self-serve/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/chainguard/self-serve/_index.md b/content/chainguard/self-serve/_index.md index 54a306a5aa..294c55756d 100644 --- a/content/chainguard/self-serve/_index.md +++ b/content/chainguard/self-serve/_index.md @@ -1,7 +1,7 @@ --- title : "Self-serve" lead: "" -description: "Signing yourself up for Chainguard products" +description: "How to sign yourself up for Chainguard products" type: "article" date: 2026-05-12T01:00:01+00:00 lastmod: 2026-05-12T01:00:01+00:00 From 07f9e61426e53b7281bfd3d0a03d80fc78a76be0 Mon Sep 17 00:00:00 2001 From: Matthew Helmke Date: Tue, 12 May 2026 15:00:24 -0500 Subject: [PATCH 3/4] edits from review --- content/chainguard/self-serve/overview.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/content/chainguard/self-serve/overview.md b/content/chainguard/self-serve/overview.md index c988a30ae8..34bfc0eec3 100644 --- a/content/chainguard/self-serve/overview.md +++ b/content/chainguard/self-serve/overview.md @@ -14,14 +14,15 @@ being able to Chainguard products (images etc.) on their own without any direct help or involvement of Chainguard employees. This applies to both paying customers/prospects, as well -as *free-tier* users who have not formally engaged with us (yet). +as *Free-tier* users who have not formally engaged with us (yet). **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: +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) @@ -66,7 +67,7 @@ To add one or more images, run the following command, substituting the desired i chainctl image entitlements add-images $IMAGE1 $IMAGE2 ``` -After the Chainguard system has processed your request, the image(s) will be accessible. This will take anywhere from a few minutes (best case) 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. +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. ```shell docker pull cgr.dev/$ORGANIZATION/$IMAGE:latest From 9d43a707125d42997ffe1adeb8a84748fc330a77 Mon Sep 17 00:00:00 2001 From: Matthew Helmke Date: Wed, 13 May 2026 05:33:31 -0500 Subject: [PATCH 4/4] edits from review --- content/chainguard/self-serve/overview.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/content/chainguard/self-serve/overview.md b/content/chainguard/self-serve/overview.md index 34bfc0eec3..fdadf19e8c 100644 --- a/content/chainguard/self-serve/overview.md +++ b/content/chainguard/self-serve/overview.md @@ -13,9 +13,6 @@ weight: 010 being able to Chainguard products (images etc.) on their own without any direct help or involvement of Chainguard employees. -This applies to both paying customers/prospects, as well -as *Free-tier* users who have not formally engaged with us (yet). - **Catalog Starter** refers to a specific plan that enables users to self-serve up to 5 images for free. @@ -43,7 +40,7 @@ To begin, sign up with a brand new account (identity) using the following interactive command: ```shell -chainctl catalog-starter create +chainctl starter init ``` This will require selection of a valid authentication option: @@ -51,11 +48,11 @@ This will require selection of a valid authentication option: ```shell Choose an identity provider to login to Chainguard - > Google - Email and password + > Email and password + Google ``` -Click 'Enter' for either, which will launch a browser window to the Chainguard console to complete sign-up. +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 @@ -64,7 +61,7 @@ You can see which images are available [using the Chainguard Directory](chaingua To add one or more images, run the following command, substituting the desired image names for the variables: ```shell -chainctl image entitlements add-images $IMAGE1 $IMAGE2 +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. @@ -73,10 +70,18 @@ After the Chainguard system has processed your request, the image(s) will be acc docker pull cgr.dev/$ORGANIZATION/$IMAGE:latest ``` +## Find status + +To show the status of your catalog starter organization, including the registry path, account provisioning status, image quota usage, and per-image readiness, use: + +```shell +chainctl starter status +``` + ## Add additional users To request access for additional users for your organization, use: ```shell -chainctl catalog-starter request-access +chainctl starter request-access ```