Skip to content

Commit 25db2cc

Browse files
committed
Improve alternative-registry example clarity per review feedback
1 parent e6ded22 commit 25db2cc

2 files changed

Lines changed: 19 additions & 15 deletions

File tree

examples/alternative-registry/README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ The image selection follows this precedence order (highest to lowest):
2626

2727
See [spicedb-cluster.yaml](spicedb-cluster.yaml) for a complete example.
2828

29+
Unlike `spec.config.image`, using `baseImage` preserves the update graph — the operator still selects the correct version and handles migration safety based on your channel, but pulls from your registry.
30+
2931
```yaml
3032
apiVersion: authzed.com/v1alpha1
3133
kind: SpiceDBCluster
@@ -34,14 +36,14 @@ metadata:
3436
spec:
3537
# Specify your alternative registry here (NO TAG!)
3638
baseImage: "my-registry.company.com/authzed/spicedb"
37-
38-
# The operator will append the appropriate tag based on the version/channel
39-
version: "v1.33.0"
40-
39+
40+
# Use a channel to get automatic updates from the update graph
41+
channel: "stable"
42+
4143
config:
4244
datastoreEngine: postgres
4345
# ... other config
44-
46+
4547
# If using a private registry, use patches to add imagePullSecrets
4648
patches:
4749
- kind: Deployment
@@ -58,15 +60,17 @@ spec:
5860
When you specify a `baseImage`, the operator will:
5961

6062
1. Use your specified registry as the base
61-
2. Append the appropriate tag or digest based on the `version` or `channel` you specify
63+
2. Resolve the appropriate tag or digest from the update graph based on your `channel`
6264
3. The final image will be: `<baseImage>:<tag>` or `<baseImage>@<digest>`
6365

6466
For example, if you specify:
6567

6668
- `baseImage: "my-registry.company.com/authzed/spicedb"`
67-
- `version: "v1.33.0"`
69+
- `channel: "stable"`
70+
71+
The operator resolves the latest version in the `stable` channel and uses e.g.: `my-registry.company.com/authzed/spicedb:v1.33.0`
6872

69-
The operator will use: `my-registry.company.com/authzed/spicedb:v1.33.0`
73+
You can also pin a specific version with `version: "v1.33.0"` instead of `channel`. Use `spec.config.image` only if you need to use an image that is not present in the update graph (this bypasses migration safety checks).
7074

7175
## Private Registry Authentication
7276

examples/alternative-registry/spicedb-cluster.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ metadata:
1010
namespace: spicedb-custom-registry
1111
spec:
1212
# Use an alternative container registry
13-
# The operator will append the appropriate tag based on version/channel
13+
# The operator will resolve the tag from the update graph based on your channel
1414
# NOTE: Do NOT include a tag here - just the registry and image name
1515
baseImage: "my-registry.company.com/authzed/spicedb"
16-
17-
# Specify the version to use
18-
version: "v1.33.0"
19-
20-
# Alternatively, use a channel for automatic updates within that channel
21-
# channel: "stable"
16+
17+
# Use a channel to get automatic updates from the update graph
18+
channel: "stable"
19+
20+
# Alternatively, pin a specific version while still using the update graph
21+
# version: "v1.33.0"
2222

2323
config:
2424
datastoreEngine: postgres

0 commit comments

Comments
 (0)