argocd-helm/charts/argocd-image-updater/README.md.gotmpl
Wylie Hobbs 879453808c
feat(argo-cd): Add argocd image updater (#477)
* Add argocd-image-updater chart

Signed-off-by: Wylie Hobbs <wylie-hobbs@pluralsight.com>

* Add maintainers

Signed-off-by: Wylie Hobbs <wylie-hobbs@pluralsight.com>

* update rbac and chart metadata

Signed-off-by: Wylie Hobbs <wylie@wyliehobbs.com>

* fix chompstyle

Signed-off-by: Wylie Hobbs <wylie@wyliehobbs.com>

* add README/template with helm-docs

Signed-off-by: Wylie Hobbs <wylie@wyliehobbs.com>

* Use correct icon url and use a generic maintainer section

Signed-off-by: Marco Kilchhofer <mkilchhofer@users.noreply.github.com>

Co-authored-by: Marco Kilchhofer <mkilchhofer@users.noreply.github.com>
2021-08-16 17:23:02 +02:00

58 lines
2.2 KiB
Go Template

{{ template "chart.header" . }}
{{ template "chart.description" . }}
To regenerate this document, from the root of this chart directory run:
```shell
docker run --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest
```
## Installation
```console
helm repo add argo https://argoproj.github.io/argo-helm
helm install argocd-image-updater argo/argocd-image-updater
```
You will also need to run through the [secret setup documentation](https://argocd-image-updater.readthedocs.io/en/stable/install/start/#connect-using-argo-cd-api-server) so ArgoCD ImageUpdater can talk to the ArgoCD API (until its automated in this chart).
## TODO
- Automate setting up the ArgoCD API Authentication user/secret using a Helm Hook or something.
## Prerequisites
* Helm v3.0.0+
## Configuration options
In order for your deployment of ArgoCD Image Updater to be successful, you will need to make sure you set the correct configuration options described in detail on the [argocd-image-updater flags page](https://argocd-image-updater.readthedocs.io/en/stable/install/running/#flags).
All of the `argocd-` prefixed flags, which tell `argocd-image-updater` how your ArgoCD instance is setup, are set in the `config.argocd` values block. For instance:
```yaml
config:
argocd:
grpcWeb: false
serverAddress: "http://argocd.argo"
insecure: true
plaintext: true
```
Any additional arguments mentioned on the [argocd-image-updater flags page](https://argocd-image-updater.readthedocs.io/en/stable/install/running/#flags) can be configured using the `extraArgs` value, like so.
### Registries
ArgoCD Image Updater natively supports the following registries (as mentioned in [the documentation](https://argocd-image-updater.readthedocs.io/en/stable/configuration/registries/)):
- Docker Hub
- Google Container Registry
- RedHat Quay
- GitHub Container Registry
- GitHub Docker Packages
If you need support for ECR, you can reference [this issue](https://github.com/argoproj-labs/argocd-image-updater/issues/112) for configuration.
The `config.registries` value can be used exactly as it looks in the documentation as it gets dumped directly into a configmap in this chart.
{{ template "chart.valuesSection" . }}