Skip to content

docs: improve readme #274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: improve readme #274

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,25 @@ spec:

The operator listens for pod events and detects when a pod is created, but the image is not found in the registry. In such cases, it assumes the image is not present in the target registry and that it needs to be copied from Dockerhub (or another registry). Based on this detection, the operator attempts to determine the correct image to copy and creates a job to perform the transfer.

For instance, you use postgres image from your private repository, copied from Dockerhub. Let's take a real use case.

1. You are running Renovate and it upgrades an image from `your-registry.com/postgres:17.1` to `your-registry.com/postgres:17.2`.
2. Your favorite gitops tool synchronizes the change and deploy the new container.
3. Kubernetes pulls the new image from the registry but triggers an error: `image not found`
4. Image Operator detects this erreur and tries to find the original image: `your-registry.com/postgres:17.2` becomes `postgres:17.2`.
5. Image Operator finds `postgres:17.2` and automatically creates a resource `Image` to launch the copy of this image.
6. After few seconds/minutes, Kubernetes restarts the pod and finally finds the image. The pod runs without issue.

To activate this feature:
- Provide `FEATURE_COPY_ON_THE_FLY` as `true`
- With helm chart, set `.Values.config.features.copyOnTheFly.enabled` to `true`

> [!NOTE]
> Author's Note: I personally host and run this project in my cluster at home. Renovate run several time a day to upgrade all project to their latest version. Sometimes I'm happy to see the latest version of a project is running and then I realize that the image comes from my private registry. It forgot it was the case and I forgot this operator, but it did the job.
\
\
Renovate + ArgoCD + Image Operator are awesome ❤️

🚨 Namespace scope 🚨

On large cluster, there are many pods to listen. In this case, operator might require lot of memory to run (between 1G and 2G for average of 1500 pods). If you do not care about it, it's OK.
Expand Down