Skip to content

Commit 4b6aef1

Browse files
donchplaffitt
authored andcommitted
docs(readme): mention the fact that kuik ignore its own namespace
1 parent c18626f commit 4b6aef1

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Another **controller** watches these `CachedImage` custom resources, and copies
6464

6565
Here is what our images look like when using kuik:
6666
```bash
67-
$ kubectl get pods -o custom-columns=NAME:metadata.name,IMAGES:spec.containers[*].image
67+
$ kubectl get pods -o custom-columns=NAME:metadata.name,IMAGES:spec.containers[*].image
6868
NAME IMAGES
6969
debugger localhost:7439/registrish.s3.amazonaws.com/alpine
7070
factori-0 localhost:7439/factoriotools/factorio:1.1
@@ -101,11 +101,11 @@ The image cache will obviously require a bit of disk space to run (see [Garbage
101101

102102
```bash
103103
$ kubectl top pods
104-
NAME CPU(cores) MEMORY(bytes)
105-
kube-image-keeper-0 1m 86Mi
106-
kube-image-keeper-controllers-5b5cc9fcc6-bv6cp 1m 16Mi
107-
kube-image-keeper-controllers-5b5cc9fcc6-tjl7t 3m 24Mi
108-
kube-image-keeper-proxy-54lzk 1m 19Mi
104+
NAME CPU(cores) MEMORY(bytes)
105+
kube-image-keeper-0 1m 86Mi
106+
kube-image-keeper-controllers-5b5cc9fcc6-bv6cp 1m 16Mi
107+
kube-image-keeper-controllers-5b5cc9fcc6-tjl7t 3m 24Mi
108+
kube-image-keeper-proxy-54lzk 1m 19Mi
109109
```
110110

111111
![Architecture](./docs/architecture.jpg)
@@ -158,7 +158,7 @@ helm upgrade --install \
158158
--set cachedImagesExpiryDelay=90
159159
```
160160

161-
## Advanced usage
161+
## Advanced usage
162162

163163
### Pod filtering
164164

@@ -170,6 +170,8 @@ There are 3 ways to tell kuik which pods it should manage (or, conversely, which
170170

171171
This logic isn't implemented by the kuik controllers or webhook directly, but through Kubernetes' standard webhook object selectors. In other words, these parameters end up in the `MutatingWebhookConfiguration` template to filter which pods get presented to kuik's webhook. When the webhook rewrites the images for a pod, it adds a label to that pod, and the kuik controllers then rely on that label to know which `CachedImages` resources to create.
172172

173+
Keep in mind that kuik will ignore pods scheduled into its own namespace.
174+
173175
### Cache persistence & garbage collection
174176

175177
Persistence is disabled by default. You can enable it by setting the Helm value `registry.persistence.enabled=true` and setting `registry.persistence.size` to the desired size (20 GiB by default). Be aware that this don't allow for high availability of the registry, to enable HA please refer to our related guide [./docs/high-availability.md](./docs/high-availability.md).

0 commit comments

Comments
 (0)