Skip to content
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

Documentation Error: Incorrect Usage of <image_name> in Annotations #581

Merged
merged 1 commit into from
Jul 6, 2023
Merged

Documentation Error: Incorrect Usage of <image_name> in Annotations #581

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
10 changes: 5 additions & 5 deletions docs/configuration/images.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ You can define the update strategy for each image independently by setting the
following annotation to an appropriate value:

```yaml
argocd-image-updater.argoproj.io/<image_name>.update-strategy: <strategy>
argocd-image-updater.argoproj.io/<image_alias>.update-strategy: <strategy>
```

If no update strategy is given, or an invalid value was used, the default
Expand All @@ -151,7 +151,7 @@ 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>.allow-tags: <match_func>
argocd-image-updater.argoproj.io/<image_alias>.allow-tags: <match_func>
```

The following match functions are currently available:
Expand All @@ -175,7 +175,7 @@ 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>, ...]
argocd-image-updater.argoproj.io/<image_alias>.ignore-tags: <pattern1>[, <pattern2>, ...]
```

You can use glob patterns as described in this
Expand All @@ -187,7 +187,7 @@ preventing the image updater to consider any of the tags returned from the
registry:

```yaml
argocd-image-updater.argoproj.io/<image_name>.ignore-tags: "*"
argocd-image-updater.argoproj.io/<image_alias>.ignore-tags: "*"
```

Please note that regular expressions are not supported to be used for patterns.
Expand Down Expand Up @@ -231,7 +231,7 @@ container registry (as described [here](../registries/)), or you can specify
the pull secret to use for a given image using the annotation

```yaml
argocd-image-updater.argoproj.io/<image_name>.pull-secret: <secret_ref>
argocd-image-updater.argoproj.io/<image_alias>.pull-secret: <secret_ref>
```

A configuration for an image will override what is configured for the registry,
Expand Down