Skip to content

Commit f1a5d49

Browse files
Add self-serve to docs (#3317)
We are enabling users to sign up for Chainguard as customers themselves and are calling it "self-serve". Because it will eventually cover many (all?) of our products, I have put the new page at the top of the product section of the documentation. There will eventually be a need for images in the page, which requires that the page be in a directory, so that's how that happened. This is rudimentary at the moment as the only way this can be done is via some new `chainctl` commands. This is also a pretty urgent request, so it isn't yet refined. This is truly the traditional open source MVP that will evolve and improve over time. Fixes chainguard-dev/internal#5842 but there will certainly be a newer issue created next week once Matthew meets with people working on the project and we move forward. This is baby step number one.
1 parent 67222b5 commit f1a5d49

2 files changed

Lines changed: 97 additions & 0 deletions

File tree

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title : "Self-serve"
3+
lead: ""
4+
description: "How to sign yourself up for Chainguard products"
5+
type: "article"
6+
date: 2026-05-12T01:00:01+00:00
7+
lastmod: 2026-05-12T01:00:01+00:00
8+
draft: false
9+
weight: 005
10+
---
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
title : "Self-serve overview"
3+
lead: ""
4+
description: "Signing yourself up for Chainguard products"
5+
type: "article"
6+
date: 2026-05-12T01:00:01+00:00
7+
lastmod: 2026-05-12T01:00:01+00:00
8+
draft: false
9+
weight: 010
10+
---
11+
12+
**Self-Serve** is a general term to capture all forms of users
13+
being able to Chainguard products (images etc.) on their own
14+
without any direct help or involvement of Chainguard employees.
15+
16+
**Catalog Starter** refers to a specific plan that enables users
17+
to self-serve up to 5 images for free.
18+
19+
The Catalog Starter plan has the following restrictions:
20+
21+
You must be authenticated with a business email address using one of the following:
22+
23+
- Email and password
24+
- Google (only if your business uses a Google Workspace account)
25+
26+
Other limitations include:
27+
28+
- Only a maximum of 5 Chainguard Images can be used
29+
- Only images from the following tiers are available:
30+
- AI
31+
- APPLICATION
32+
- BASE
33+
- No access to nested UIDP image repos, such as Helm charts
34+
35+
## Sign up with `chainctl`
36+
37+
The current method for signing up is with `chainctl`.
38+
39+
To begin, sign up with a brand new account (identity)
40+
using the following interactive command:
41+
42+
```shell
43+
chainctl starter init
44+
```
45+
46+
This will require selection of a valid authentication option:
47+
48+
```shell
49+
Choose an identity provider to login to Chainguard
50+
51+
> Email and password
52+
Google
53+
```
54+
55+
Use the arrow keys and click 'Enter' to select either, which will launch a browser window to the Chainguard console to complete sign-up.
56+
57+
## Add images
58+
59+
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.
60+
61+
To add one or more images, run the following command, substituting the desired image names for the variables:
62+
63+
```shell
64+
chainctl starter add-images $IMAGE1 [$IMAGE2]
65+
```
66+
67+
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.
68+
69+
```shell
70+
docker pull cgr.dev/$ORGANIZATION/$IMAGE:latest
71+
```
72+
73+
## Find status
74+
75+
To show the status of your catalog starter organization, including the registry path, account provisioning status, image quota usage, and per-image readiness, use:
76+
77+
```shell
78+
chainctl starter status
79+
```
80+
81+
## Add additional users
82+
83+
To request access for additional users for your organization, use:
84+
85+
```shell
86+
chainctl starter request-access
87+
```

0 commit comments

Comments
 (0)