diff options
| author | jannfis <jann@mistrust.net> | 2020-09-27 14:24:30 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-27 14:24:30 +0200 |
| commit | 330fa57fd51331b911901d5a31b6956cb080ba0e (patch) | |
| tree | 4251a3459449b8f1444147c7ed91344297089719 /docs | |
| parent | 02d580fc6805963e89632fbad3782cf5bfa1e80e (diff) | |
feat: Allow ignoring set of tags (#101)
* feat: Allow ignoring set of tags
* Fix a typo in symbol name
* Rename symbol
* err must be nil; also print trace message
* Update documentation
* Update documentation
* String is already trimmed
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration/images.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/configuration/images.md b/docs/configuration/images.md index 6284d53..52212a7 100644 --- a/docs/configuration/images.md +++ b/docs/configuration/images.md @@ -144,6 +144,30 @@ to prevent considering (and possibly update to) the wrong tags by accident. If the annotation is not specified, a match function `any` will be used to match the tag names, effectively performing no filtering at all. +## Ignoring certain tags + +If you want to ignore certain tags from the registry for any given image, you +can define a comma separated list of glob-like patterns using the following +annotation: + +```yaml +argocd-image-updater.argoproj.io/<image_name>.ignore-tags: <pattern1>[, <pattern2>, ...] +``` + +You can use glob patterns as described in this +[documentation](https://golang.org/pkg/path/filepath/#Match) + +If you want to disable updating an image temporarily, without removing all of +the configuration, you can do so by just ignoring all tags, effectively +preventing the image updater to consider any of the tags returned from the +registry: + +```yaml +argocd-image-updater.argoproj.io/<image_name>.ignore-tags: "*" +``` + +Please note that regular expressions are not supported to be used for patterns. + ## Specifying pull secrets There are generally two ways on how to specify pull secrets for Argo CD Image @@ -318,6 +342,7 @@ must be prefixed with `argocd-image-updater.argoproj.io`. |`image-list`|*none*|Comma separated list of images to consider for update| |`<image_alias>.update-strategy`|`semver`|The update strategy to be used for the image| |`<image_alias>.tag-match`|*any*|A function to match tag names from registry against to be considered for update| +|`<image_alias>.ignore-tags`|*none*|A comma-separated list of glob patterns that when match ignore a certain tag from the registry| |`<image_alias>.pull-secret`|*none*|A reference to a secret to be used as registry credentials for this image| |`<image_alias>.helm.image-spec`|*none*|Name of the Helm parameter to specify the canonical name of the image, i.e. holds `image/name:1.0`. If this is set, other Helm parameter related options will be ignored.| |`<image_alias>.helm.image-name`|`image.name`|Name of the Helm parameter used for specifying the image name, i.e. holds `image/name`| |