Skip to content

Commit 9321f9c

Browse files
authored
docs: fix grammatical errors (#807)
Signed-off-by: Dan Plamadeala <[email protected]>
1 parent 959ceaf commit 9321f9c

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

docs/configuration/images.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ is used:
1010
argocd-image-updater.argoproj.io/image-list: <image_spec_list>
1111
```
1212
13-
The `<image_spec_list>` is a comma separated list of image specifications. Each
13+
The `<image_spec_list>` is a comma-separated list of image specifications. Each
1414
image specification is composed of mandatory and optional information, and is
15-
used to specify the image, its version constraint and a few meta data.
15+
used to specify the image, its version constraint, and a few metadata.
1616

1717
An image specification could be formally described as:
1818

@@ -55,7 +55,7 @@ of the [Semver library](https://github.com/Masterminds/semver) we're using.
5555
!!!note
5656
If you use an
5757
[update strategy](#update-strategies)
58-
other than `semver` or `digest`, the `version_constraint` will not be have any effect
58+
other than `semver` or `digest`, the `version_constraint` will not have any effect
5959
and all tags returned from the registry will be considered for update. If
6060
you need to further restrict the list of tags to consider, see
6161
[filtering tags](#filtering-tags)
@@ -82,7 +82,7 @@ be unique within the same application. Re-using an alias name across different
8282
applications is allowed.
8383

8484
An alias name is assigned during image specification in the `image-list`
85-
annotation, for example the following would assign the alias `myalias` to the
85+
annotation, for example, the following would assign the alias `myalias` to the
8686
image `some/image`:
8787

8888
```yaml
@@ -129,7 +129,7 @@ following annotation to an appropriate value:
129129
argocd-image-updater.argoproj.io/<image_alias>.update-strategy: <strategy>
130130
```
131131

132-
If no update strategy is given, or an invalid value was used, the default
132+
If no update strategy is given, or an invalid value is used, the default
133133
strategy `semver` will be used.
134134

135135
!!!warning
@@ -171,7 +171,7 @@ the tag names, effectively performing no filtering at all.
171171
## Ignoring certain tags
172172

173173
If you want to ignore certain tags from the registry for any given image, you
174-
can define a comma separated list of glob-like patterns using the following
174+
can define a comma-separated list of glob-like patterns using the following
175175
annotation:
176176

177177
```yaml
@@ -183,7 +183,7 @@ You can use glob patterns as described in this
183183

184184
If you want to disable updating an image temporarily, without removing all of
185185
the configuration, you can do so by just ignoring all tags, effectively
186-
preventing the image updater to consider any of the tags returned from the
186+
preventing the image updater from considering any of the tags returned from the
187187
registry:
188188

189189
```yaml
@@ -208,7 +208,7 @@ need to let Argo CD Image Updater know:
208208
argocd-image-updater.argoproj.io/<image_alias>.platforms: linux/arm64
209209
```
210210

211-
You can specify multiple allowed platforms as a comma separated list of allowed
211+
You can specify multiple allowed platforms as a comma-separated list of allowed
212212
platforms:
213213

214214
```yaml
@@ -219,7 +219,7 @@ The correct image to execute will be chosen by Kubernetes.
219219

220220
!!!note
221221
The `platforms` annotation only has effect for images that use an update
222-
strategy which fetches meta-data. Currently, these are the `latest` and
222+
strategy that fetches meta-data. Currently, these are the `latest` and
223223
`digest` strategies. For `semver` and `name` strategies, the `platforms`
224224
setting has no effect.
225225

@@ -239,15 +239,15 @@ for that certain image.
239239

240240
The `secret_ref` can either be a reference to a secret or a reference to an
241241
environment variable. If a secret is referenced, the secret must exist in the
242-
cluster where Argo CD Image Updater is running in (or has access to).
242+
cluster where Argo CD Image Updater is running (or has access to).
243243

244244
Valid values for `secret_ref` are:
245245

246246
* `secret:<namespace>/<secret_name>#<field>` - Use credentials stored in the
247247
field `field` from secret `secret_name` in namespace `namespace`.
248248

249249
* `pullsecret:<namespace>/<secret_name>` - Use credentials stored in the secret
250-
`secret_name` in namespace `namespace`. The secret is treated as Docker pull
250+
`secret_name` in namespace `namespace`. The secret is treated as a Docker pull
251251
secret, that is, it must have a valid Docker config in JSON format in the
252252
field `.dockerconfigjson`.
253253

@@ -259,7 +259,7 @@ Valid values for `secret_ref` are:
259259
to execute must be specified using an absolute path, and must have the
260260
executable bit set. The script is supposed to output the credentials to be
261261
used as a single line to stdout, in the format `<username>:<password>`.
262-
Please note that the script will be executed every time Argo CD Image
262+
Please note that the script will be executed every time the Argo CD Image
263263
Updater goes to find a new version, and credentials will not be cached. If
264264
you want it to execute only once and cache credentials, you should configure
265265
this secret on the registry level instead.
@@ -284,7 +284,7 @@ In this case, `image_name` should be the name of the image that you want to
284284
update to, rather than the currently running image.
285285

286286
To provide the original image name, you need to set the `kustomize.image-name`
287-
annotation to the original image's name, like follows:
287+
annotation to the original image's name, as follows:
288288

289289
```yaml
290290
argocd-image-updater.argoproj.io/<image_alias>.kustomize.image-name: <original_image_name>
@@ -308,15 +308,15 @@ kustomize edit set image quay.io/argoproj/argocd=ghcr.io/argoproj/argocd
308308

309309
Finally, if you have not yet overridden the image name in your manifests (i.e.
310310
there's no image `ghcr.io/argoproj/argocd` running in your application, you
311-
may need to tell Image Updater to force the update despite no image is running:
311+
may need to tell Image Updater to force the update despite no image running:
312312

313313
```yaml
314314
argocd-image-updater.argoproj.io/argocd.force-update: true
315315
```
316316

317317
## Specifying Helm parameter names
318318

319-
In case of Helm applications which contain more than one image in the manifests
319+
In the case of Helm applications that contain more than one image in the manifests
320320
or use another set of parameters than `image.name` and `image.tag` to define
321321
which image to render in the manifests, you need to set an `<image_alias>`
322322
in the image specification to define an alias for that image, and then
@@ -335,7 +335,7 @@ argocd-image-updater.argoproj.io/dex.helm.image-tag: dex.image.tag
335335
336336
```
337337

338-
The general syntax for the two Helm specific annotations is:
338+
The general syntax for the two Helm-specific annotations is:
339339

340340
```yaml
341341
argocd-image-updater.argoproj.io/<image_alias>.helm.image-name: <name of helm parameter to set for the image name>
@@ -346,7 +346,7 @@ If the chart uses a parameter for the canonical name of the image (i.e. image
346346
name and tag combined), a third option can be used:
347347

348348
```yaml
349-
argocd-image-updater.argoproj.io/<image_alias>.helm.image-spec: <name of helm parameter to set for canonical name of image>
349+
argocd-image-updater.argoproj.io/<image_alias>.helm.image-spec: <name of helm parameter to set for the canonical name of image>
350350
```
351351

352352
If the `<image_alias>.helm.image-spec` annotation is set, the two other
@@ -453,29 +453,29 @@ must be prefixed with `argocd-image-updater.argoproj.io/`.
453453
|`image-list`|*none*|Comma separated list of images to consider for update|
454454
|`<image_alias>.update-strategy`|`semver`|The update strategy to be used for the image|
455455
|`<image_alias>.force-update`|`"false"`|If set to "true" (with quotes), even images that are not currently deployed will be updated|
456-
|`<image_alias>.allow-tags`|*any*|A function to match tag names from registry against to be considered for update|
457-
|`<image_alias>.ignore-tags`|*none*|A comma-separated list of glob patterns that when match ignore a certain tag from the registry|
456+
|`<image_alias>.allow-tags`|*any*|A function to match tag names from the registry against to be considered for update|
457+
|`<image_alias>.ignore-tags`|*none*|A comma-separated list of glob patterns that when matched, ignore a certain tag from the registry|
458458
|`<image_alias>.pull-secret`|*none*|A reference to a secret to be used as registry credentials for this image|
459-
|`<image_alias>.platform`|*none*|Only update to images for given platform(s). Comma separated list, e.g. `linux/amd64,linux/arm64`|
460-
|`<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.|
459+
|`<image_alias>.platform`|*none*|Only update to images for given platform(s). Comma-separated list, e.g. `linux/amd64,linux/arm64`|
460+
|`<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.|
461461
|`<image_alias>.helm.image-name`|`image.name`|Name of the Helm parameter used for specifying the image name, i.e. holds `image/name`|
462462
|`<image_alias>.helm.image-tag`|`image.tag`|Name of the Helm parameter used for specifying the image tag, i.e. holds `1.0`|
463463
|`<image_alias>.kustomize.image-name`|*original name of image*|Name of Kustomize image parameter to set during updates|
464464

465465
### <a name="appendix-defaults"></a>Application-wide defaults
466466

467467
If you want to update multiple images in an Application, that all share common
468-
settings (such as, update strategy, allowed tags, etc), you can define common
468+
settings (such as update strategy, allowed tags, etc), you can define common
469469
options. These options are valid for all images, unless an image overrides it
470-
with specific configuration.
470+
with a specific configuration.
471471

472-
The following annotations are available. Please note, all annotations must be
472+
The following annotations are available. Please note that all annotations must be
473473
prefixed with `argocd-image-updater.argoproj.io/`.
474474

475475
|Annotation name|Description|
476476
|---------------|-----------|
477477
|`update-strategy`|The update strategy to be used for all images|
478478
|`force-update`|If set to "true" (with quotes), even images that are not currently deployed will be updated|
479-
|`allow-tags`|A function to match tag names from registry against to be considered for update|
480-
|`ignore-tags`|A comma-separated list of glob patterns that when match ignore a certain tag from the registry|
479+
|`allow-tags`|A function to match tag names from the registry against to be considered for update|
480+
|`ignore-tags`|A comma-separated list of glob patterns that when matched, ignore a certain tag from the registry|
481481
|`pull-secret`|A reference to a secret to be used as registry credentials for this image|

0 commit comments

Comments
 (0)