diff options
| author | jannfis <jann@mistrust.net> | 2020-08-09 20:28:48 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-09 20:28:48 +0200 |
| commit | d1014208246d40c139fafdf2ef7e6ac4e4b0d7cf (patch) | |
| tree | 9fe06682718f4900299d4371db62807d0e075181 /docs | |
| parent | e2aeb7fbfef6eb0d82ec1445bbf3dba725abece4 (diff) | |
docs: Rename "ArgoCD" to "Argo CD" (#24)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration/applications.md | 12 | ||||
| -rw-r--r-- | docs/configuration/images.md | 6 | ||||
| -rw-r--r-- | docs/configuration/registries.md | 8 | ||||
| -rw-r--r-- | docs/contributing/development.md | 2 | ||||
| -rw-r--r-- | docs/contributing/start.md | 6 | ||||
| -rw-r--r-- | docs/index.md | 34 | ||||
| -rw-r--r-- | docs/install/start.md | 62 |
7 files changed, 65 insertions, 65 deletions
diff --git a/docs/configuration/applications.md b/docs/configuration/applications.md index cc7165e..e22e385 100644 --- a/docs/configuration/applications.md +++ b/docs/configuration/applications.md @@ -1,22 +1,22 @@ # Application configuration -In order for ArgoCD Image Updater to know which applications it should inspect +In order for Argo CD Image Updater to know which applications it should inspect for updating the workloads' container images, the corresponding Kubernetes -resource needs to be correctly annotated. ArgoCD Image Updater will inspect -only resources of kind `application.argoproj.io`, that is, your ArgoCD +resource needs to be correctly annotated. Argo CD Image Updater will inspect +only resources of kind `application.argoproj.io`, that is, your Argo CD `Application` resources. Annotations on other kinds of resources will have no effect and will not be considered. -For its annotations, ArgoCD Image Updater uses the following prefix: +For its annotations, Argo CD Image Updater uses the following prefix: ```yaml argocd-image-updater.argoproj.io ``` -As explained earlier, your ArgoCD applications must be of either `Kustomize` +As explained earlier, your Argo CD applications must be of either `Kustomize` or `Helm` type. Other types of applications will be ignored. -So, in order for ArgoCD Image Updater to consider your application for the +So, in order for Argo CD Image Updater to consider your application for the update of its images, at least the following criteria must be met: * Your `Application` resource is annotated with the mandatory annotation of diff --git a/docs/configuration/images.md b/docs/configuration/images.md index 74c62c5..8ceab3f 100644 --- a/docs/configuration/images.md +++ b/docs/configuration/images.md @@ -77,8 +77,8 @@ specification as follows: `<image_path>:<image_path>` will be the value used when rendering the manifests. -Let's take ArgoCD's Kustomize base as an example: The original image used by -ArgoCD is `argoproj/argocd`, pulled from the Docker Hub container registry. If +Let's take Argo CD's Kustomize base as an example: The original image used by +Argo CD is `argoproj/argocd`, pulled from the Docker Hub container registry. If you are about to follow the latest builds, as published on the GitHub registry, you could override the image specification in Kustomize as follows: @@ -104,7 +104,7 @@ that should get set if an image gets updated. For example, if you have an image `quay.io/dexidp/dex` that is configured in your helm chart using the `dex.image.name` and `dex.image.tag` Helm parameters, you can set the following annotations on your `Application` resource so that -ArgoCD Image Updater will know which Helm parameters to set: +Argo CD Image Updater will know which Helm parameters to set: ```yaml argocd-image-updater.argoproj.io/image-list: dex=quay.io/dexidp/dex diff --git a/docs/configuration/registries.md b/docs/configuration/registries.md index 9d1dab9..dc378bf 100644 --- a/docs/configuration/registries.md +++ b/docs/configuration/registries.md @@ -1,6 +1,6 @@ # Configuring Container Registries -ArgoCD Image Updater comes with support for the following registries out of the +Argo CD Image Updater comes with support for the following registries out of the box: * Docker Hub Registry @@ -8,9 +8,9 @@ box: * RedHat Quay Registry Adding additional (and custom) container registries is supported by means of a -configuration file. If you run ArgoCD Image Updater within Kubernetes, you can +configuration file. If you run Argo CD Image Updater within Kubernetes, you can edit the registries in a ConfigMap resource, which will get mounted to the pod -running ArgoCD Image Updater. +running Argo CD Image Updater. ## Configuring a custom container registry @@ -72,7 +72,7 @@ data: ``` !!!note - ArgoCD Image Updater pod must be restarted for changes to the registries + Argo CD Image Updater pod must be restarted for changes to the registries configuration to take effect. There are plans to change this behaviour so that changes will be reload automatically in a future release. diff --git a/docs/contributing/development.md b/docs/contributing/development.md index 3ff1123..331a4f9 100644 --- a/docs/contributing/development.md +++ b/docs/contributing/development.md @@ -2,7 +2,7 @@ ## Requirements -Getting started to develop ArgoCD Image Updater shouldn't be too hard. All that +Getting started to develop Argo CD Image Updater shouldn't be too hard. All that is required is a simple build toolchain, consisting of: * Golang v1.14 diff --git a/docs/contributing/start.md b/docs/contributing/start.md index 604e89f..b50e6ec 100644 --- a/docs/contributing/start.md +++ b/docs/contributing/start.md @@ -1,10 +1,10 @@ -# Contributing to ArgoCD Image Updater +# Contributing to Argo CD Image Updater -Contributing to ArgoCD Image Updater is easy! You can contribute in a number of +Contributing to Argo CD Image Updater is easy! You can contribute in a number of ways, e.g. * raise bug reports in the issue tracker, -* send your ideas for enhancing ArgoCD Image Update, +* send your ideas for enhancing Argo CD Image Update, * participate with your knowledge in existing issues, * vote for existing feature requests, * send Pull Requests for the docs, for the code, for the build toolchain, etc 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. diff --git a/docs/install/start.md b/docs/install/start.md index 5fccbce..4477c8b 100644 --- a/docs/install/start.md +++ b/docs/install/start.md @@ -2,25 +2,25 @@ ## Runtime environment -It is recommend to run ArgoCD Image Updater in the same Kubernetes cluster that -ArgoCD is running in, however, this is not a requirement. In fact, it is not -even a requirement to run ArgoCD Image Updater within a Kubernetes cluster or +It is recommend to run Argo CD Image Updater in the same Kubernetes cluster that +Argo CD is running in, however, this is not a requirement. In fact, it is not +even a requirement to run Argo CD Image Updater within a Kubernetes cluster or with access to any Kubernetes cluster at all. However, some features might not work without accessing Kubernetes. ## Prerequisites -ArgoCD Image Updater will need access to the API of your ArgoCD installation. -If you chose to install the ArgoCD Image Updater outside of the cluster where -ArgoCD is running in, the API must be exposed externally (i.e. using Ingress). -If you have network policies in place, make sure that ArgoCD Image Updater will -be allowed to communicate with the ArgoCD API, which is usually the service +Argo CD Image Updater will need access to the API of your Argo CD installation. +If you chose to install the Argo CD Image Updater outside of the cluster where +Argo CD is running in, the API must be exposed externally (i.e. using Ingress). +If you have network policies in place, make sure that Argo CD Image Updater will +be allowed to communicate with the Argo CD API, which is usually the service `argocd-server` in namespace `argocd` on port 443 and port 80. -### Create a local user within ArgoCD +### Create a local user within Argo CD -ArgoCD Image Updater needs credential for accessing the ArgoCD API. Using a +Argo CD Image Updater needs credential for accessing the Argo CD API. Using a [local user](https://argoproj.github.io/argo-cd/operator-manual/user-management/) is recommended, but a *project token* will work as well (although, this will limit updating to the applications of the given project obviously). @@ -45,14 +45,14 @@ argocd account generate-token --account image-updater --id image-updater Copy the token's value somewhere, you will need it later on. -### Granting RBAC permissions in ArgoCD +### Granting RBAC permissions in Argo CD The technical user `image-updater` we have configured in the previous step now -needs appropriate RBAC permissions within ArgoCD. ArgoCD Image Updater needs +needs appropriate RBAC permissions within Argo CD. Argo CD Image Updater needs the `update` and `get` permissions on the applications you want to manage. A most basic version that grants `get` and `update` permissions on all of the -applications managed by ArgoCD might look as follows: +applications managed by Argo CD might look as follows: ```text p, role:image-updater, applications, get, */*, allow @@ -63,7 +63,7 @@ g, image-updater, role:image-updater You might want to strip that down to apps in a specific project, or to specific apps, however. -Put the RBAC permissions to ArgoCD's `argocd-rbac-cm` ConfigMap and ArgoCD will +Put the RBAC permissions to Argo CD's `argocd-rbac-cm` ConfigMap and Argo CD will pick them up automatically. ## Installing as Kubernetes workload @@ -77,7 +77,7 @@ will not start messing with your workloads yet. configuration on top of it. The remote base's URL is `https://github.com/argoproj-labs/argocd-image-updater/manifests/base` -### Create a dedicated namespace for ArgoCD Image Updater +### Create a dedicated namespace for Argo CD Image Updater ```shell kubectl create ns argocd-image-updater` @@ -90,15 +90,15 @@ kubectl apply -n argocd-image-updater -f manifests/install.yaml ``` !!!note "A word on high availabilty" - It is not advised to run multiple replicas of the same ArgoCD Image Updater + It is not advised to run multiple replicas of the same Argo CD Image Updater instance. Just leave the number of replicas at 1, otherwise weird side effects could occur. -### Configure ArgoCD endpoint +### Configure Argo CD endpoint -If you run ArgoCD Image Updater in another cluster than ArgoCD, or if your -ArgoCD installation is not in namespace `argocd` or if you use a default or -otherwise self-signed TLS certificate for ArgoCD API endpoint, you probably +If you run Argo CD Image Updater in another cluster than Argo CD, or if your +Argo CD installation is not in namespace `argocd` or if you use a default or +otherwise self-signed TLS certificate for Argo CD API endpoint, you probably need to divert from the default connection values. Edit the `argocd-image-updater-config` ConfigMap and add the following keys @@ -106,17 +106,17 @@ Edit the `argocd-image-updater-config` ConfigMap and add the following keys ```yaml data: - # The address of ArgoCD API endpoint - defaults to argocd-server.argocd - argocd.server_addr: <FQDN or IP of your ArgoCD server> + # The address of Argo CD API endpoint - defaults to argocd-server.argocd + argocd.server_addr: <FQDN or IP of your Argo CD server> # Whether to use GRPC-web protocol instead of GRPC over HTTP/2 argocd.grpc_web: true - # Whether to ignore invalid TLS cert from ArgoCD API endpoint + # Whether to ignore invalid TLS cert from Argo CD API endpoint argocd.insecure: false # Whether to use plain text connection (http) instead of TLS (https) argocd.plaintext: false ``` -After changing values in the ConfigMap, ArgoCD Image Updater needs to be +After changing values in the ConfigMap, Argo CD Image Updater needs to be restarted for the changes to take effect, i.e. ```shell @@ -125,8 +125,8 @@ kubectl -n argocd-image-updater rollout restart deployment argocd-image-updater ### Configure API access token secret -When installed from the manifests into a Kubernetes cluster, the ArgoCD Image -Updater reads the token required for accessing ArgoCD API from an environment +When installed from the manifests into a Kubernetes cluster, the Argo CD Image +Updater reads the token required for accessing Argo CD API from an environment variable named `ARGOCD_TOKEN`, which is set from a a field named `argocd.token` in a secret named `argocd-image-updater-secret`. @@ -151,8 +151,8 @@ Kubernetes automatically. ## Running locally -As long as you have access to the ArgoCD API and your Kubernetes cluster from -your workstation, running ArgoCD Image Updater is simple. Make sure that you +As long as you have access to the Argo CD API and your Kubernetes cluster from +your workstation, running Argo CD Image Updater is simple. Make sure that you have your API token noted and that your Kubernetes client configuration points to the correct K8s cluster. @@ -174,14 +174,14 @@ consult the appropriate section of the documentation. ## Running multiple instances -Generally, multiple instances of ArgoCD Image Updater can be run within the same +Generally, multiple instances of Argo CD Image Updater can be run within the same Kubernetes cluster, however they should not operate on the same set of applications. This allows for multiple application teams to manage their own set of applications. If opting for such an approach, you should make sure that: -* Each instance of ArgoCD Image Updater runs in its own namespace -* Each instance has a dedicated user in ArgoCD, with dedicated RBAC permissions +* Each instance of Argo CD Image Updater runs in its own namespace +* Each instance has a dedicated user in Argo CD, with dedicated RBAC permissions * RBAC permissions are set-up so that instances cannot interfere with each others managed resources |
