summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDavid Flores <dmousex@gmail.com>2023-06-08 12:51:36 -0600
committerGitHub <noreply@github.com>2023-06-08 14:51:36 -0400
commit5366cc14ee80fe432d1f94e961a02a4a662f70f3 (patch)
tree92e3f0e26ef8e7f8c70fc1f0e6cd9286a1f77860 /docs
parent7b181bd3e46562d2ef19df7d77a98450e10ba9d5 (diff)
docs: Examples for semver and digest update strategy (#507)
Proposal examples to use semver and digest update strategy
Diffstat (limited to 'docs')
-rw-r--r--docs/examples/index.md49
1 files changed, 45 insertions, 4 deletions
diff --git a/docs/examples/index.md b/docs/examples/index.md
index 2eddaf9..15ab78b 100644
--- a/docs/examples/index.md
+++ b/docs/examples/index.md
@@ -1,7 +1,48 @@
# Examples
-This chapter contains community contributed examples on how to configure Argo
-CD Image Updater for a certain registry or environment.
+## Digest
+Using `digest` sha configuration for `image-list`
-Feel free to submit your own examples or guides to the documentation, as we do
-not have access to all the registries and cloud platforms out there.
+```
+apiVersion: argoproj.io/v1alpha1
+kind: Application
+metadata:
+ name: dev
+ annotations:
+ argocd-image-updater.argoproj.io/write-back-method: argocd
+ argocd-image-updater.argoproj.io/image-list: api=registry.com/vendor/api:latest,front=registry.com/vendor/front:latest
+ argocd-image-updater.argoproj.io/update-strategy: digest
+---
+apiVersion: apps/v1
+kind: Deployment
+spec:
+ template:
+ spec:
+ containers:
+ - name: app
+ image: registry.com/vendor/api@sha256:38089... # Initial sha
+```
+
+## semver
+Using `semver` defining the `update-strategy` per `image-list`
+
+```
+apiVersion: argoproj.io/v1alpha1
+kind: Application
+metadata:
+ name: prod
+ annotations:
+ argocd-image-updater.argoproj.io/write-back-method: argocd
+ argocd-image-updater.argoproj.io/image-list: api=registry.com/vendor/api:1.x,front=registry.com/vendor/front:1.x
+ #argocd-image-updater.argoproj.io/update-strategy: semver # to apply for all the images
+ argocd-image-updater.argoproj.io/api.update-strategy: semver
+ argocd-image-updater.argoproj.io/front.update-strategy: semver
+---
+apiVersion: apps/v1
+kind: Deployment
+spec:
+ template:
+ spec:
+ containers:
+ image: registry.com/vendor/api:1.0
+```