Skip to content

Commit 45989b0

Browse files
committed
chore(helm): warn about caching images of the storage backend
1 parent 6fc6d7a commit 45989b0

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ In v1.3.0, we removed the finalizer `pod.kuik.enix.io/finalizer` from pods that
1919
To avoid having these pods stuck in `Terminating` state after a delete action or a rolling update, you will need to manually remove the finalizer from these pods once you upgrade to 1.3.0.
2020
This can be achieved using the following command:
2121

22-
```
22+
```bash
2323
kubectl get pods --all-namespaces -l kuik.enix.io/images-rewritten=true -o json | jq '.items[].metadata.finalizers=null' | kubectl replace -f -
2424
```
2525

@@ -80,6 +80,7 @@ One **controller** watches pods, and when it notices new images, it creates `Cac
8080
Another **controller** watches these `CachedImage` custom resources, and copies images from source registries to kuik's caching registry accordingly.
8181

8282
Here is what our images look like when using kuik:
83+
8384
```bash
8485
$ kubectl get pods -o custom-columns=NAME:metadata.name,IMAGES:spec.containers[*].image
8586
NAME IMAGES
@@ -131,7 +132,6 @@ kube-image-keeper-proxy-54lzk 1m 19Mi
131132

132133
Refer to the [dedicated documentation](https://github.com/enix/kube-image-keeper/blob/main/docs/metrics.md).
133134

134-
135135
## Installation
136136

137137
1. Make sure that you have cert-manager installed. If not, check its [installation page](https://cert-manager.io/docs/installation/) (it's fine to use the `kubectl apply` one-liner, and no further configuration is required).
@@ -148,6 +148,8 @@ That's it!
148148

149149
Our container images are available across multiple registries for reliability. You can find them on [Github Container Registry](https://github.com/enix/kube-image-keeper/pkgs/container/kube-image-keeper), [Quay](https://quay.io/repository/enix/kube-image-keeper) and [DockerHub](https://hub.docker.com/r/enix/kube-image-keeper).
150150

151+
CAUTION: If you use a storage backend that runs in the same cluster as kuik but in a different namespace, ensure you filter-out the storage backend's pods. Failure to do so may lead to interdependency issues, making it impossible to start both kuik and its storage backend if either encounters an issue.
152+
151153
<!-- VALUES -->
152154

153155
## Installation with plain YAML files
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CAUTION: If you use a storage backend that runs in the same cluster as kuik but in a different namespace, ensure you filter-out the storage backend's pods. Failure to do so may lead to interdependency issues, making it impossible to start both kuik and its storage backend if either encounters an issue.

0 commit comments

Comments
 (0)