-
Notifications
You must be signed in to change notification settings - Fork 112
Add self-serve to docs #3317
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add self-serve to docs #3317
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| title : "Self-serve" | ||
| lead: "" | ||
| 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 | ||
| draft: false | ||
| weight: 005 | ||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| --- | ||
| 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. | ||
|
|
||
| **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 starter init | ||
| ``` | ||
|
|
||
| This will require selection of a valid authentication option: | ||
|
|
||
| ```shell | ||
| Choose an identity provider to login to Chainguard | ||
|
|
||
| > Email and password | ||
| ``` | ||
|
|
||
| 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 | ||
|
|
||
| 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 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. | ||
|
|
||
| ```shell | ||
| 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 starter request-access | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.