Helm: improve image options documentation

Signed-off-by: Tim Ramlot <42113979+inteon@users.noreply.github.com>
cert-manager · Feb 14, 2024 · 5c3c8b3 · 5c3c8b3
1 parent 7b71e41
commit 5c3c8b3
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 28 deletions.
diff --git a/deploy/charts/istio-csr/README.md b/deploy/charts/istio-csr/README.md
@@ -13,39 +13,36 @@
 > ```
 
 Number of replicas of istio-csr to run.
+#### **image.registry** ~ `string`
+
+Target image registry. This value is prepended to the target image repository, if set.  
+For example:
+
+```yaml
+registry: quay.io
+repository: jetstack/cert-manager-istio-csr
+```
+
 #### **image.repository** ~ `string`
 > Default value:
 > ```yaml
 > quay.io/jetstack/cert-manager-istio-csr
 > ```
 
 Target image repository.
-#### **image.registry** ~ `unknown`
-> Default value:
-> ```yaml
-> null
-> ```
+#### **image.tag** ~ `string`
 
-Target image registry. Will be prepended to the target image repository if set.
-#### **image.tag** ~ `unknown`
-> Default value:
-> ```yaml
-> null
-> ```
+Override the image tag to deploy by setting this variable. If no value is set, the chart's appVersion is used.
 
-Target image version tag. Defaults to the chart's appVersion.
-#### **image.digest** ~ `unknown`
-> Default value:
-> ```yaml
-> null
-> ```
+#### **image.digest** ~ `string`
 
-Target image digest. Will override any tag if set.  
+Target image digest. Override any tag, if set.  
 For example:
 
 ```yaml
 digest: sha256:0e072dddd1f7f8fc8909a2ca6f65e76c5f0d2fcfb8be47935ae3457e8bbceb20
 ```
+
 #### **image.pullPolicy** ~ `string`
 > Default value:
 > ```yaml

diff --git a/deploy/charts/istio-csr/values.schema.json b/deploy/charts/istio-csr/values.schema.json
@@ -466,23 +466,26 @@
       "type": "object"
     },
     "helm-values.image.digest": {
-      "description": "Target image digest. Will override any tag if set.\nFor example:\ndigest: sha256:0e072dddd1f7f8fc8909a2ca6f65e76c5f0d2fcfb8be47935ae3457e8bbceb20"
+      "description": "Target image digest. Override any tag, if set.\nFor example:\ndigest: sha256:0e072dddd1f7f8fc8909a2ca6f65e76c5f0d2fcfb8be47935ae3457e8bbceb20",
+      "type": "string"
     },
     "helm-values.image.pullPolicy": {
       "default": "IfNotPresent",
       "description": "Kubernetes imagePullPolicy on Deployment.",
       "type": "string"
     },
     "helm-values.image.registry": {
-      "description": "Target image registry. Will be prepended to the target image repository if set."
+      "description": "Target image registry. This value is prepended to the target image repository, if set.\nFor example:\nregistry: quay.io\nrepository: jetstack/cert-manager-istio-csr",
+      "type": "string"
     },
     "helm-values.image.repository": {
       "default": "quay.io/jetstack/cert-manager-istio-csr",
       "description": "Target image repository.",
       "type": "string"
     },
     "helm-values.image.tag": {
-      "description": "Target image version tag. Defaults to the chart's appVersion."
+      "description": "Override the image tag to deploy by setting this variable. If no value is set, the chart's appVersion is used.",
+      "type": "string"
     },
     "helm-values.imagePullSecrets": {
       "default": [],

diff --git a/deploy/charts/istio-csr/values.yaml b/deploy/charts/istio-csr/values.yaml
@@ -2,18 +2,26 @@
 replicaCount: 1
 
 image:
+  # Target image registry. This value is prepended to the target image repository, if set.
+  # For example:
+  #   registry: quay.io
+  #   repository: jetstack/cert-manager-istio-csr
+  # +docs:property
+  # registry: quay.io
+
   # Target image repository.
   repository: quay.io/jetstack/cert-manager-istio-csr
-  # Target image registry. Will be prepended to the target image repository if set.
-  registry:
 
-  # Target image version tag. Defaults to the chart's appVersion.
-  tag:
+  # Override the image tag to deploy by setting this variable.
+  # If no value is set, the chart's appVersion is used.
+  # +docs:property
+  # tag: vX.Y.Z
 
-  # Target image digest. Will override any tag if set.
+  # Target image digest. Override any tag, if set.
   # For example:
-  # digest: sha256:0e072dddd1f7f8fc8909a2ca6f65e76c5f0d2fcfb8be47935ae3457e8bbceb20
-  digest:
+  #   digest: sha256:0e072dddd1f7f8fc8909a2ca6f65e76c5f0d2fcfb8be47935ae3457e8bbceb20
+  # +docs:property
+  # digest: sha256:...
 
   # Kubernetes imagePullPolicy on Deployment.
   pullPolicy: IfNotPresent