summaryrefslogtreecommitdiff
path: root/docs/index.md
diff options
context:
space:
mode:
authorjannfis <jann@mistrust.net>2020-08-09 20:28:48 +0200
committerGitHub <noreply@github.com>2020-08-09 20:28:48 +0200
commitd1014208246d40c139fafdf2ef7e6ac4e4b0d7cf (patch)
tree9fe06682718f4900299d4371db62807d0e075181 /docs/index.md
parente2aeb7fbfef6eb0d82ec1445bbf3dba725abece4 (diff)
docs: Rename "ArgoCD" to "Argo CD" (#24)
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md34
1 files changed, 17 insertions, 17 deletions
diff --git a/docs/index.md b/docs/index.md
index 87a806e..db9c0a6 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,11 +1,11 @@
-# ArgoCD Image Updater
+# Argo CD Image Updater
A tool to automatically update the container images of Kubernetes workloads
that are managed by
-[ArgoCD](https://github.com/argoproj/argo-cd).
+[Argo CD](https://github.com/argoproj/argo-cd).
!!!warning "A note on the current status"
- ArgoCD Image Updater was born just recently. It is not suitable for
+ Argo CD Image Updater was born just recently. It is not suitable for
production use yet, and it might break things in unexpected ways.
You are welcome to test it out on non-critical environments, and to
@@ -19,25 +19,25 @@ that are managed by
## Overview
-The ArgoCD Image Updater can check for new versions of the container images
+The Argo CD Image Updater can check for new versions of the container images
that are deployed with your Kubernetes workloads and automatically update them
-to their latest allowed version using ArgoCD. It works by setting appropriate
-application parameters for ArgoCD applications, i.e. similar to
+to their latest allowed version using Argo CD. It works by setting appropriate
+application parameters for Argo CD applications, i.e. similar to
`argocd app set --helm-set image.tag=v1.0.1` - but in a fully automated
manner.
-Usage is simple: You annotate your ArgoCD `Application` resources with a list
+Usage is simple: You annotate your Argo CD `Application` resources with a list
of images to be considered for update, along with a version constraint to
-restrict the maximum allowed new version for each image. ArgoCD Image Updater
-then regulary polls the configured applications from ArgoCD and queries the
+restrict the maximum allowed new version for each image. Argo CD Image Updater
+then regulary polls the configured applications from Argo CD and queries the
corresponding container registry for possible new versions. If a new version of
-the image is found in the registry, and the version constraint is met, ArgoCD
-Image Updater instructs ArgoCD to update the application with the new image.
+the image is found in the registry, and the version constraint is met, Argo CD
+Image Updater instructs Argo CD to update the application with the new image.
-Depending on your Automatic Sync Policy for the Application, ArgoCD will either
+Depending on your Automatic Sync Policy for the Application, Argo CD will either
automatically deploy the new image version or mark the Application as Out Of
Sync, and you can trigger the image update manually by syncing the Application.
-Due to the tight integration with ArgoCD, advanced features like Sync Windows,
+Due to the tight integration with Argo CD, advanced features like Sync Windows,
RBAC authorization on Application resources etc. are fully supported.
## Limitations
@@ -49,19 +49,19 @@ Please make sure to understand these limitations, and do not send enhancement
requests or bug reports related to the following:
* The applications you want container images to be updated **must** be managed
- using ArgoCD. There is no support for workloads not managed using ArgoCD.
+ using Argo CD. There is no support for workloads not managed using Argo CD.
-* ArgoCD Image Updater can only update container images for applications whose
+* Argo CD Image Updater can only update container images for applications whose
manifests are rendered using either *Kustomize* or *Helm* and - especially
in the case of Helm - the templates need to support specifying the image's
tag (and possibly name) using a parameter (i.e. `image.tag`).
-* Your images' tags need to follow the semantic versioning scheme. ArgoCD
+* Your images' tags need to follow the semantic versioning scheme. Argo CD
Image Updater will not be able to update images that are just made from
arbitrary strings, or consist solely of Git SHA strings.
Otherwise, current known limitations are:
-* Image pull secrets must exist in the same Kubernetes cluster where ArgoCD
+* Image pull secrets must exist in the same Kubernetes cluster where Argo CD
Image Updater is running in (or has accesst to). It is currently not possible
to fetch those secrets from other clusters.