Skip to content

Commit 147b2f5

Browse files
Haaroleangitbook-bot
authored andcommitted
GITBOOK-22: Add info on image registries. Resolves #44
1 parent c8e51c8 commit 147b2f5

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

overview/getting-started.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,31 @@ Then, access the web UI at [http://localhost:8080](http://localhost:8080)
1212

1313
The command is sufficient to try things out. When you're done trying these things out, you can proceed with a [persistent installation](getting-started.md#persistent-installation)
1414

15+
### Image distribution & Available Container Registries
16+
17+
#### Image types
18+
19+
There are two types of images we publish:
20+
21+
* **Release** images, tagged with `latest` and simultaneously semver tags like `v1.0.0` 
22+
* **Snapshot** images for every commit pushed to the main branch, named as the respective commit's short SHA, like `b241abe`. The latest build of the main branch is always tagged as `main` as well
23+
24+
Sometimes, for people who require recent changes that are not yet released, we suggest pulling snapshot images. These are usually safe to use, breaking changes happen rarely. To prevent pulling new versions, you can pin the version using the sha-named tag rather than `main` .
25+
26+
#### Image distribution channels
27+
28+
We publish our container images to these registries:
29+
30+
* GHCR (Github Container Registry) — `ghcr.io/kafbat/kafka-ui:latest`
31+
* AWS ECR (Elastic Container Registry) — `public.ecr.aws/kafbat/kafka-ui:latest`
32+
* Docker Hub — `kafbat/kafka-ui:latest`
33+
34+
GHCR is considered the main registry for various reasons, the rest are treated as mirrors. You can use these registries to avoid being ratioed by these services (GHCR requires authentication to pull images, Docker Hub is known to have pull limits).
35+
36+
GHCR contains all our images (release and snapshots), while the others store only release versions.
37+
38+
In the future, we will consider distributing snapshots to all the registries as a separate package.
39+
1540
### Persistent installation
1641

1742
```yaml

0 commit comments

Comments
 (0)