fix(argocd-image-updater): Update outdated link on README (#2414)
* 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>
This commit is contained in:
Aikawa
GitHub
parent
107bd3bc53
commit
51bb7f9806
4 changed files with 39 additions and 29 deletions
|
|
@ -2,7 +2,7 @@ apiVersion: v2
|
|||
name: argocd-image-updater
|
||||
description: 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
|
||||
type: application
|
||||
version: 0.9.1
|
||||
version: 0.9.2
|
||||
appVersion: v0.12.2
|
||||
home: https://github.com/argoproj-labs/argocd-image-updater
|
||||
icon: https://argocd-image-updater.readthedocs.io/en/stable/assets/logo.png
|
||||
|
|
@ -18,5 +18,7 @@ annotations:
|
|||
fingerprint: 2B8F22F57260EFA67BE1C5824B11F800CD9D2252
|
||||
url: https://argoproj.github.io/argo-helm/pgp_keys.asc
|
||||
artifacthub.io/changes: |
|
||||
- kind: added
|
||||
description: Introduce chart signing
|
||||
- kind: fixed
|
||||
description: Update outdated link on README
|
||||
- kind: changed
|
||||
description: Refactor README
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ 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).
|
||||
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
|
||||
|
||||
|
|
@ -22,7 +22,7 @@ You will also need to run through the [secret setup documentation](https://argoc
|
|||
|
||||
## 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).
|
||||
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:
|
||||
|
||||
|
|
@ -35,12 +35,12 @@ config:
|
|||
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.
|
||||
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 [the documentation](https://argocd-image-updater.readthedocs.io/en/stable/configuration/registries/).
|
||||
Please also read [Configuration of Container Registries].
|
||||
|
||||
```yaml
|
||||
config:
|
||||
|
|
@ -52,7 +52,7 @@ If you specify a token value the secret will be created.
|
|||
|
||||
### Registries
|
||||
|
||||
ArgoCD Image Updater natively supports the following registries (as mentioned in [the documentation](https://argocd-image-updater.readthedocs.io/en/stable/configuration/registries/)):
|
||||
Argo CD Image Updater natively supports the following registries (as mentioned in [Configuration of Container Registries]):
|
||||
|
||||
- Docker Hub
|
||||
- Google Container Registry
|
||||
|
|
@ -60,7 +60,7 @@ ArgoCD Image Updater natively supports the following registries (as mentioned in
|
|||
- 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. You can use the `authScripts` values to configure the scripts that are needed to authenticate with ECR.
|
||||
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.
|
||||
|
||||
|
|
@ -125,3 +125,7 @@ Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/
|
|||
|
||||
[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
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ 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).
|
||||
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
|
||||
|
||||
|
|
@ -22,7 +22,7 @@ You will also need to run through the [secret setup documentation](https://argoc
|
|||
|
||||
## 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).
|
||||
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:
|
||||
|
||||
|
|
@ -35,12 +35,12 @@ config:
|
|||
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.
|
||||
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 [the documentation](https://argocd-image-updater.readthedocs.io/en/stable/configuration/registries/).
|
||||
Please also read [Configuration of Container Registries].
|
||||
|
||||
```yaml
|
||||
config:
|
||||
|
|
@ -52,7 +52,7 @@ If you specify a token value the secret will be created.
|
|||
|
||||
### Registries
|
||||
|
||||
ArgoCD Image Updater natively supports the following registries (as mentioned in [the documentation](https://argocd-image-updater.readthedocs.io/en/stable/configuration/registries/)):
|
||||
Argo CD Image Updater natively supports the following registries (as mentioned in [Configuration of Container Registries]):
|
||||
|
||||
- Docker Hub
|
||||
- Google Container Registry
|
||||
|
|
@ -60,7 +60,7 @@ ArgoCD Image Updater natively supports the following registries (as mentioned in
|
|||
- 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. You can use the `authScripts` values to configure the scripts that are needed to authenticate with ECR.
|
||||
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.
|
||||
|
||||
|
|
@ -71,3 +71,7 @@ Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/
|
|||
|
||||
[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
|
||||
|
|
|
|||
Loading…
Reference in a new issue