87 lines
4.7 KiB
Markdown
87 lines
4.7 KiB
Markdown
|
# argocd-image-updater
|
||
|
|
|
||
|
|
A Helm chart for Argo CD Image Updater, a tool to automatically update the container images of Kubernetes workloads which are managed by Argo CD
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
## Values
|
||
|
|
|
||
|
|
| Key | Type | Default | Description |
|
||
|
|
|-----|------|---------|-------------|
|
||
|
|
| affinity | object | `{}` | Kubernetes affinity settings for the deployment |
|
||
|
|
| config.argocd.grpcWeb | bool | `true` | Use the gRPC-web protocol to connect to the Argo CD API |
|
||
|
|
| config.argocd.insecure | bool | `false` | If specified, the certificate of the Argo CD API server is not verified. |
|
||
|
|
| config.argocd.plaintext | bool | `false` | If specified, use an unencrypted HTTP connection to the ArgoCD API instead of TLS. |
|
||
|
|
| config.argocd.serverAddress | string | `""` | Connect to the Argo CD API server at server address |
|
||
|
|
| config.logLevel | string | `"info"` | ArgoCD Image Update log level |
|
||
|
|
| config.registries | list | `[]` | ArgoCD Image Updater registries list configuration. More information [here](https://argocd-image-updater.readthedocs.io/en/stable/configuration/registries/) |
|
||
|
|
| extraArgs | list | `[]` | Extra arguments for argocd-image-updater not defined in config.argocd |
|
||
|
|
| fullnameOverride | string | `""` | Global fullname (argocd-image-updater.fullname in _helpers.tpl) override |
|
||
|
|
| image.pullPolicy | string | `"Always"` | Default image pull policy |
|
||
|
|
| image.repository | string | `"argoprojlabs/argocd-image-updater"` | Default image repository |
|
||
|
|
| image.tag | string | `"v0.10.1"` | Default image tag |
|
||
|
|
| imagePullSecrets | list | `[]` | ImagePullSecrets for the image updater deployment |
|
||
|
|
| nameOverride | string | `""` | Global name (argocd-image-updater.name in _helpers.tpl) override |
|
||
|
|
| nodeSelector | object | `{}` | Kubernetes nodeSelector settings for the deployment |
|
||
|
|
| podAnnotations | object | `{}` | Pod Annotations for the deployment |
|
||
|
|
| podSecurityContext | object | `{}` | Pod security context settings for the deployment |
|
||
|
|
| rbac.enabled | bool | `true` | Enable RBAC creation |
|
||
|
|
| replicaCount | int | `1` | Replica count for the deployment. It is not advised to run more than one replica. |
|
||
|
|
| resources | object | `{}` | Pod memory and cpu resource settings for the deployment |
|
||
|
|
| securityContext | object | `{}` | Security context settings for the deployment |
|
||
|
|
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
|
||
|
|
| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
|
||
|
|
| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
|
||
|
|
| tolerations | list | `[]` | Kubernetes toleration settings for the deployment |
|