summaryrefslogtreecommitdiff
path: root/docs/configuration
diff options
context:
space:
mode:
authorJan Pieper <kontakt@jan-pieper.info>2022-01-29 18:17:46 +0100
committerGitHub <noreply@github.com>2022-01-29 18:17:46 +0100
commite46a206038282c41bdbab06fce3f84ce9fe33173 (patch)
treea924c9ddbfb83032ca30f9e9dcc8398ecf7e2710 /docs/configuration
parent113d8e74e5346132803605512bfac97bb0d84ae6 (diff)
feat: Support app-wide update-strategy annotations (#338)
* feat: support app-wide update-strategy annotations * refactor: rename constants for pull-secret annotations
Diffstat (limited to 'docs/configuration')
-rw-r--r--docs/configuration/images.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/configuration/images.md b/docs/configuration/images.md
index af08962..b291434 100644
--- a/docs/configuration/images.md
+++ b/docs/configuration/images.md
@@ -402,3 +402,21 @@ must be prefixed with `argocd-image-updater.argoproj.io`.
|`<image_alias>.helm.image-name`|`image.name`|Name of the Helm parameter used for specifying the image name, i.e. holds `image/name`|
|`<image_alias>.helm.image-tag`|`image.tag`|Name of the Helm parameter used for specifying the image tag, i.e. holds `1.0`|
|`<image_alias>.kustomize.image-name`|*original name of image*|Name of Kustomize image parameter to set during updates|
+
+### Application-wide defaults
+
+If you want to update multiple images in an Application, that all share common
+settings (such as, update strategy, allowed tags, etc), you can define common
+options. These options are valid for all images, unless an image overrides it
+with specific configuration.
+
+The following annotations are available. Please note, all annotations must be
+prefixed with `argocd-image-updater.argoproj.io/`.
+
+|Annotation name|Description|
+|---------------|-----------|
+|`update-strategy`|The update strategy to be used for all images|
+|`force-update`|If set to "true" (with quotes), even images that are not currently deployed will be updated|
+|`allow-tags`|A function to match tag names from registry against to be considered for update|
+|`ignore-tags`|A comma-separated list of glob patterns that when match ignore a certain tag from the registry|
+|`pull-secret`|A reference to a secret to be used as registry credentials for this image|