Skip to content

Commit

Permalink
docs: replace <image_name> by <image_alias> (#581)
Browse files Browse the repository at this point in the history 
Co-authored-by: Abdellah Derfoufi <[email protected]>
  • Loading branch information
@geekloper
geekloper and Abdellah Derfoufi authored Jul 6, 2023
1 parent f6c4fe3 commit 568e6b9
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/configuration/images.md
View file
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

1 comment on commit 568e6b9

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

🔴 Please review

See the 📜action log for details.

Unrecognized words (1)

wildcards

Previously acknowledged words that are now absent mypass myuser otherapp wildcard wohoo :arrow_right:
To accept ✔️ these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands

... in a clone of the [email protected]:argoproj-labs/argocd-image-updater.git repository
on the master branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/prerelease/apply.pl' |
perl - 'https://github.com/argoproj-labs/argocd-image-updater/actions/runs/5470490220/attempts/1'
Available 📚 dictionaries could cover words (expected and unrecognized) not in the 📘 dictionary

This includes both expected items (25) from .github/actions/spelling/expect.txt and unrecognized words (1)

Dictionary Entries Covers Uniquely
cspell:cpp/src/template-strings.txt 8 1
cspell:typescript/dict/typescript.txt 1098 1
cspell:software-terms/dict/softwareTerms.txt 1288 1
cspell:python/src/python/python-lib.txt 2417 1

Consider adding them (in .github/workflows/spelling.yml):

      with:
        extra_dictionaries:
          cspell:cpp/src/template-strings.txt
          cspell:typescript/dict/typescript.txt
          cspell:software-terms/dict/softwareTerms.txt
          cspell:python/src/python/python-lib.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling.yml):

check_extra_dictionaries: ''
Errors (1)

See the 📜action log for details.

❌ Errors Count
❌ ignored-expect-variant 3

See ❌ Event descriptions for more information.

Please sign in to comment.