diff options
| author | jannfis <jann@mistrust.net> | 2020-08-13 10:44:41 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-13 10:44:41 +0200 |
| commit | d136072d408f6918788c00afe7810b81b9ca0aec (patch) | |
| tree | e93b06810ac99b2207df4026ec7d58c59389d1d3 | |
| parent | dc416f27e282c8fdb31cbdcad80fbf57421610e3 (diff) | |
docs: Update docs to include new tag filter feature (#50)
* docs: Update docs to include new tag filter feature
* Allow "misconfigured" in spell checker
| -rw-r--r-- | .github/actions/spelling/allow.txt | 1 | ||||
| -rw-r--r-- | CHANGELOG.md | 4 | ||||
| -rw-r--r-- | docs/configuration/images.md | 28 |
3 files changed, 33 insertions, 0 deletions
diff --git a/.github/actions/spelling/allow.txt b/.github/actions/spelling/allow.txt index 19ebbad..ae7afd8 100644 --- a/.github/actions/spelling/allow.txt +++ b/.github/actions/spelling/allow.txt @@ -104,6 +104,7 @@ loglevel logrus memcache metadata +misconfigured mkdir mkdocs mktemp diff --git a/CHANGELOG.md b/CHANGELOG.md index c6f01fb..4fc21ef 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,8 +12,12 @@ handling on your side. ### New features +* feat: Allow filtering of tags using built-in filter functions + ### Other changes +* refactor: Lots of refactoring "under the hood" + ## 2020-08-11 - Release v0.3.1 ### Upgrade notes (no really, you MUST read this) diff --git a/docs/configuration/images.md b/docs/configuration/images.md index e869494..c11d714 100644 --- a/docs/configuration/images.md +++ b/docs/configuration/images.md @@ -107,6 +107,34 @@ argocd-image-updater.argoproj.io/<image_name>.update-strategy: <strategy> If no update strategy is given, or an invalid value was used, the default strategy `semver` will be used. +## Filtering tags + +You can specify an expression that is matched against each tag returned from +the registry. On a positive match, the tag will be included in the list of tags +that will be considered to update the image to. If the expression does not +match the tag, the tag will not be included in the list. This allows you to +only consider tags that you are generally interested in. + +You can define a tag filter by using the following annotation: + +```yaml +argocd-image-updater.argoproj.io/<image_name>.tag-match: <match_func> +``` + +The following match functions are currently available: + +|Function|Description| +|--------|-----------| +|`regexp:<expression>`|Matches the tag name against the regular expression `<expression>`| +|`any`|Will match any tag| + +If you specify an invalid match function, or the match function is misconfigured +(i.e. an invalid regular expression is supplied), no tag will be matched at all +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. + ## Custom images with Kustomize In Kustomize, if you want to use an image from another registry or a completely |