Skip to content

Commit 7342dfd

Browse files
committed
chore: update README.md with requirements for a custom canary image
1 parent cdc70ed commit 7342dfd

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -642,6 +642,27 @@ cluster name, by setting `awsPodIdentityAssociationCluster` in the helm chart. I
642642
be installed or the operator will fail to start. Then, you may provide `awsPodIdentityAssociationRoleArn` in
643643
the `RestateCluster` spec.
644644

645+
### Canary Image
646+
647+
Both EKS Pod Identity and GCP Workload Identity use a canary job to validate that credentials are available before
648+
starting the Restate cluster. By default, this uses the `busybox:uclibc` image from Docker Hub. In environments where
649+
nodes cannot pull from Docker Hub (e.g. air-gapped or restricted registries), you can override this with the
650+
`canaryImage` Helm value:
651+
652+
```yaml
653+
canaryImage: my-private-registry.example.com/busybox:uclibc
654+
```
655+
656+
The simplest approach is to mirror the default image:
657+
658+
```bash
659+
docker pull busybox:uclibc
660+
docker tag busybox:uclibc my-private-registry.example.com/busybox:uclibc
661+
docker push my-private-registry.example.com/busybox:uclibc
662+
```
663+
664+
If using a different base image, it must provide `grep` and `wget`.
665+
645666
### EKS Security Groups for Pods
646667

647668
[EKS Security Groups for Pods](https://docs.aws.amazon.com/eks/latest/userguide/security-groups-for-pods.html) allows

0 commit comments

Comments
 (0)