summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorjannfis <jann@mistrust.net>2020-09-26 13:50:49 +0200
committerGitHub <noreply@github.com>2020-09-26 13:50:49 +0200
commit02d580fc6805963e89632fbad3782cf5bfa1e80e (patch)
tree9fe866767a812906fe6f05ac2ecb29d476ca86c7 /docs
parentef5c2099efc434947b82242eaf0b91ca275ab622 (diff)
feat: Allow setting log level from configmap (and environment) (#100)
* feat: Allow setting log level from configmap (and environment) Also, updates getting started docs. * Update manifests
Diffstat (limited to 'docs')
-rw-r--r--docs/install/running.md2
-rw-r--r--docs/install/start.md36
2 files changed, 38 insertions, 0 deletions
diff --git a/docs/install/running.md b/docs/install/running.md
index 04c37b7..6f05e5c 100644
--- a/docs/install/running.md
+++ b/docs/install/running.md
@@ -106,6 +106,8 @@ to the Kubernetes cluster.
Set the log level to *level*, where *level* can be one of `trace`, `debug`,
`info`, `warn` or `error`.
+Can also be set using the *IMAGE_UPDATER_LOGLEVEL* environment variable.
+
**--match-application-name *pattern* **
Only process applications that have a valid annotation and matches the given
diff --git a/docs/install/start.md b/docs/install/start.md
index 4379615..41a8c57 100644
--- a/docs/install/start.md
+++ b/docs/install/start.md
@@ -94,6 +94,42 @@ kubectl apply -n argocd-image-updater -f manifests/install.yaml
instance. Just leave the number of replicas at 1, otherwise weird side
effects could occur.
+### Minimum mandatory configuration
+
+Even if you don't plan to use private registries, you will need to configure at
+least an empty `registries.conf`, because the `argocd-image-updater` pod will
+volume mount this entry from the config map.
+
+Edit the `argocd-image-updater-config` ConfigMap and add the following entry:
+
+```yaml
+data:
+ registries.conf: ""
+```
+
+Without this entry, the `argocd-image-updater` pod will not be able to start.
+
+If you are going to use private container registries, this is also a good time
+to
+[configure them](../../configuration/registries/#configuring-a-custom-container-registry)
+
+### Configure the desired log level
+
+While this step is optional, we recommend to set the log level explicitly.
+During your first steps with the Argo CD Image Updater, a more verbose logging
+can help greatly in troubleshooting things.
+
+Edit the `argocd-image-updater-config` ConfigMap and add the following keys
+(the values are dependent upon your environment)
+
+```yaml
+data:
+ # log.level can be one of trace, debug, info, warn or error
+ log.level: debug
+```
+
+If you omit the `log.level` setting, the default `info` level will be used.
+
### Configure Argo CD endpoint
If you run Argo CD Image Updater in another cluster than Argo CD, or if your