51bb7f9806
* fixed(argocd-image-updater): Update outdated link on README Signed-off-by: yu-croco <yu.croco@gmail.com> * fix: correct "ArgoCD" to "Argo CD" Signed-off-by: yu-croco <yu.croco@gmail.com> --------- Signed-off-by: yu-croco <yu.croco@gmail.com>
77 lines
3 KiB
Go Template
77 lines
3 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] so Argo CD Image Updater can talk to the Argo CD API (until its automated in this chart).
|
|
|
|
## Prerequisites
|
|
|
|
* Helm v3.0.0+
|
|
|
|
## Configuration options
|
|
|
|
In order for your deployment of Argo CD 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].
|
|
|
|
All of the `argocd-` prefixed flags, which tell `argocd-image-updater` how your Argo CD 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] can be configured using the `extraArgs` value, like so.
|
|
|
|
### Argo CD API key
|
|
|
|
If you are unable to install Argo CD Image Updater into the same Kubernetes cluster you might configure it to use API of your Argo CD installation.
|
|
Please also read [Configuration of Container Registries].
|
|
|
|
```yaml
|
|
config:
|
|
argocd:
|
|
token: <your_secret_here>
|
|
```
|
|
|
|
If you specify a token value the secret will be created.
|
|
|
|
### Registries
|
|
|
|
Argo CD Image Updater natively supports the following registries (as mentioned in [Configuration of Container 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, [Support ECR authentication], for configuration. You can use the `authScripts` values to configure the scripts that are needed to authenticate with ECR.
|
|
|
|
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" . }}
|
|
|
|
----------------------------------------------
|
|
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
|
|
|
|
[MetricRelabelConfigs]: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
|
|
[RelabelConfigs]: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
|
|
[secret setup documentation]: https://argocd-image-updater.readthedocs.io/en/stable/install/installation/#method-2-connect-using-argo-cd-api-server
|
|
[argocd-image-updater flags page]: https://argocd-image-updater.readthedocs.io/en/stable/install/reference/#flags
|
|
[Configuration of Container Registries]: https://argocd-image-updater.readthedocs.io/en/stable/configuration/registries/
|
|
[Support ECR authentication]: https://github.com/argoproj-labs/argocd-image-updater/issues/112
|