Skip to content

Commit

Permalink
chore: update chart's README
Browse files Browse the repository at this point in the history
  • Loading branch information
donch committed Sep 6, 2023
1 parent 5e39f36 commit cff7f7b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ helm upgrade --install \

### From 1.2.0 to 1.3.0

In v1.3.0, we removed the finalizer `pod.kuik.enix.io/finalizer` from pods that were rewritten by Kuik.
In v1.3.0, we removed the finalizer `pod.kuik.enix.io/finalizer` from pods that were rewritten by kuik.

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.
This can be achieved using the following command:
Expand Down
21 changes: 17 additions & 4 deletions helm/kube-image-keeper/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,11 @@ kube-image-keeper-controllers-5b5cc9fcc6-tjl7t 3m 24Mi
kube-image-keeper-proxy-54lzk 1m 19Mi
```

![Architecture](./docs/architecture.jpg)
![Architecture](https://raw.githubusercontent.com/enix/kube-image-keeper/main/docs/architecture.jpg)

### Metrics

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


## Installation
Expand Down Expand Up @@ -148,7 +148,7 @@ kubectl apply -f /tmp/kuik.yaml --namespace kuik-system

If you want to change e.g. the expiration delay, the port number used by the proxy, enable persistence (with a PVC) for the registry cache... You can do that with standard Helm values.

You can see the full list of parameters (along with their meaning and default values) in the chart's [values.yaml](/helm/kube-image-keeper/values.yaml) file, or on [kuik's page on the Artifact Hub](https://artifacthub.io/packages/helm/enix/kube-image-keeper).
You can see the full list of parameters (along with their meaning and default values) in the chart's [values.yaml](https://github.com/enix/kube-image-keeper/blob/main/helm/kube-image-keeper/values.yaml) file, or on [kuik's page on the Artifact Hub](https://artifacthub.io/packages/helm/enix/kube-image-keeper).

For instance, to extend the expiration delay to 3 months (90 days), you can deploy kuik like this:

Expand All @@ -160,6 +160,19 @@ helm upgrade --install \
--set cachedImagesExpiryDelay=90
```

## Upgrading

### From 1.2.0 to 1.3.0

In v1.3.0, we removed the finalizer `pod.kuik.enix.io/finalizer` from pods that were rewritten by kuik.

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.
This can be achieved using the following command:

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

## Advanced usage

### Pod filtering
Expand All @@ -176,7 +189,7 @@ Keep in mind that kuik will ignore pods scheduled into its own namespace.

### Cache persistence & garbage collection

Persistence is disabled by default. You can enable it by setting the Helm value `registry.persistence.enabled=true`. This will create a PersistentVolumeClaim with a default size of 20 GiB. You can change that size by setting the value `registry.persistence.size`. Keep in mind that enabling persistence isn't enough to provide high availability of the registry! If you want kuik to be highly available, please refer to the [high availability guide](./docs/high-availability.md).
Persistence is disabled by default. You can enable it by setting the Helm value `registry.persistence.enabled=true`. This will create a PersistentVolumeClaim with a default size of 20 GiB. You can change that size by setting the value `registry.persistence.size`. Keep in mind that enabling persistence isn't enough to provide high availability of the registry! If you want kuik to be highly available, please refer to the [high availability guide](https://github.com/enix/kube-image-keeper/blob/main/docs/high-availability.md).

Note that persistence requires your cluster to have some PersistentVolumes. If you don't have PersistentVolumes, kuik's registry Pod will remain `Pending` and your images won't be cached (but they will still be served transparently by kuik's image proxy).

Expand Down

0 comments on commit cff7f7b

Please sign in to comment.