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>
argoproj · Jan 5, 2024 · 51bb7f9 · 51bb7f9
1 parent 107bd3b
commit 51bb7f9
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 29 deletions.
diff --git a/charts/argocd-image-updater/Chart.yaml b/charts/argocd-image-updater/Chart.yaml
@@ -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
diff --git a/charts/argocd-image-updater/README.md b/charts/argocd-image-updater/README.md
@@ -14,17 +14,17 @@ 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
 
 * 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).
+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 ArgoCD instance is setup, are set in the `config.argocd` values block. For instance:
+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:
@@ -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.
 
-### ArgoCD API key
+### 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,15 +52,15 @@ 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
 - 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. 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.
 
@@ -74,16 +74,16 @@ The `config.registries` value can be used exactly as it looks in the documentati
 | config.applicationsAPIKind | string | `""` | API kind that is used to manage Argo CD applications (`kubernetes` or `argocd`) |
 | 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.plaintext | bool | `false` | If specified, use an unencrypted HTTP connection to the Argo CD API instead of TLS. |
 | config.argocd.serverAddress | string | `""` | Connect to the Argo CD API server at server address |
-| config.argocd.token | string | `""` | If specified, the secret with ArgoCD API key will be created. |
+| config.argocd.token | string | `""` | If specified, the secret with Argo CD API key will be created. |
 | config.disableKubeEvents | bool | `false` | Disable kubernetes events |
 | config.gitCommitMail | string | `""` | E-Mail address to use for Git commits |
 | config.gitCommitTemplate | string | `""` | Changing the Git commit message |
 | config.gitCommitUser | string | `""` | Username to use for Git commits |
-| 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/) |
-| config.sshConfig | object | `{}` | ArgoCD Image Updater ssh client parameter configuration. |
+| config.logLevel | string | `"info"` | Argo CD Image Update log level |
+| config.registries | list | `[]` | Argo CD Image Updater registries list configuration. More information [here](https://argocd-image-updater.readthedocs.io/en/stable/configuration/registries/) |
+| config.sshConfig | object | `{}` | Argo CD Image Updater ssh client parameter configuration. |
 | extraArgs | list | `[]` | Extra arguments for argocd-image-updater not defined in `config.argocd`. If a flag contains both key and value, they need to be split to a new entry |
 | extraEnv | list | `[]` | Extra environment variables for argocd-image-updater |
 | fullnameOverride | string | `""` | Global fullname (argocd-image-updater.fullname in _helpers.tpl) override |
@@ -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
diff --git a/charts/argocd-image-updater/README.md.gotmpl b/charts/argocd-image-updater/README.md.gotmpl
@@ -14,17 +14,17 @@ 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
 
 * 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).
+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 ArgoCD instance is setup, are set in the `config.argocd` values block. For instance:
+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:
@@ -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.
 
-### ArgoCD API key
+### 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,15 +52,15 @@ 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
 - 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. 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
diff --git a/charts/argocd-image-updater/values.yaml b/charts/argocd-image-updater/values.yaml
@@ -77,9 +77,9 @@ config:
     serverAddress: ""
     # -- If specified, the certificate of the Argo CD API server is not verified.
     insecure: false
-    # -- If specified, use an unencrypted HTTP connection to the ArgoCD API instead of TLS.
+    # -- If specified, use an unencrypted HTTP connection to the Argo CD API instead of TLS.
     plaintext: false
-    # -- If specified, the secret with ArgoCD API key will be created.
+    # -- If specified, the secret with Argo CD API key will be created.
     token: ""
 
   # -- Disable kubernetes events
@@ -94,10 +94,10 @@ config:
   # -- Changing the Git commit message
   gitCommitTemplate: ""
 
-  # -- ArgoCD Image Update log level
+  # -- Argo CD Image Update log level
   logLevel: "info"
 
-  # -- ArgoCD Image Updater registries list configuration. More information [here](https://argocd-image-updater.readthedocs.io/en/stable/configuration/registries/)
+  # -- Argo CD Image Updater registries list configuration. More information [here](https://argocd-image-updater.readthedocs.io/en/stable/configuration/registries/)
   registries: []
     # - name: Docker Hub
     #   api_url: https://registry-1.docker.io
@@ -122,7 +122,7 @@ config:
     #   credentials: ext:/scripts/auth1.sh
     #   credsexpire: 10h
 
-  # -- ArgoCD Image Updater ssh client parameter configuration.
+  # -- Argo CD Image Updater ssh client parameter configuration.
   sshConfig:
     {}
     #  config: |