summaryrefslogtreecommitdiff
path: root/docs/install
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/install
parente2aeb7fbfef6eb0d82ec1445bbf3dba725abece4 (diff)
docs: Rename "ArgoCD" to "Argo CD" (#24)
Diffstat (limited to 'docs/install')
-rw-r--r--docs/install/start.md62
1 files changed, 31 insertions, 31 deletions
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