docs: Update chart values documentation (#177)

Signed-off-by: Marco Maurer <mkilchhofer@users.noreply.github.com>
jetstack · Apr 15, 2024 · a7d0f6c · a7d0f6c
1 parent 4975d5e
commit a7d0f6c
Show file tree

Hide file tree

Showing 2 changed files with 72 additions and 54 deletions.
diff --git a/deploy/charts/version-checker/README.md b/deploy/charts/version-checker/README.md
@@ -1,6 +1,6 @@
 # version-checker
 
-![Version: v0.5.2](https://img.shields.io/badge/Version-v0.5.2-informational?style=flat-square) ![AppVersion: v0.5.2](https://img.shields.io/badge/AppVersion-v0.5.2-informational?style=flat-square)
+![Version: v0.5.4](https://img.shields.io/badge/Version-v0.5.4-informational?style=flat-square) ![AppVersion: v0.5.4](https://img.shields.io/badge/AppVersion-v0.5.4-informational?style=flat-square)
 
 A Helm chart for version-checker
 
@@ -16,43 +16,48 @@ A Helm chart for version-checker
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| acr | object | `{"password":null,"refreshToken":null,"username":null}` | Azure Container Registry Credentials Configuration |
-| acr.password | string | `nil` |  |
-| acr.refreshToken | string | `nil` |  |
-| acr.username | string | `nil` |  |
-| additionalAnnotations | object | `{}` |  |
-| additionalLabels | object | `{}` |  |
-| docker.password | string | `nil` |  |
-| docker.token | string | `nil` |  |
-| docker.username | string | `nil` |  |
-| ecr.accessKeyID | string | `nil` |  |
+| acr.password | string | `nil` | Password to authenticate with azure container registry |
+| acr.refreshToken | string | `nil` | Refresh token to authenticate with azure container registry. Cannot be used with `acr.username` / `acr.password`. |
+| acr.username | string | `nil` | Username to authenticate with azure container registry |
+| additionalAnnotations | object | `{}` | Additional Annotations to apply to Service and Deployment/Pod Objects |
+| additionalLabels | object | `{}` | Additional Labels to apply to Service and Deployment/Pod Objects |
+| docker.password | string | `nil` | Password to authenticate with docker registry |
+| docker.token | string | `nil` | Token to authenticate with docker registry. Cannot be used with `docker.username` / `docker.password`. |
+| docker.username | string | `nil` | Username to authenticate with docker registry |
+| ecr.accessKeyID | string | `nil` | ECR access key ID for read access to private registries |
 | ecr.iamRoleArn | string | `nil` | Provide AWS EKS Iam Role ARN following: [Specify A ServiceAccount Role](https://docs.aws.amazon.com/eks/latest/userguide/specify-service-account-role.html) |
-| ecr.secretAccessKey | string | `nil` |  |
-| ecr.sessionToken | string | `nil` |  |
+| ecr.secretAccessKey | string | `nil` | ECR secret access key for read access to private registries |
+| ecr.sessionToken | string | `nil` | ECR session token for read access to private registries |
 | env | object | `{}` | Can be used to provide custom environment variables e.g. proxy settings |
-| gcr.token | string | `nil` |  |
-| ghcr.token | string | `nil` |  |
+| gcr.token | string | `nil` | Access token for read access to private GCR registries |
+| ghcr.token | string | `nil` | Personal Access token for read access to GHCR releases |
 | image.pullPolicy | string | `"IfNotPresent"` | Set the Image Pull Policy |
-| image.repository | string | `"quay.io/jetstack/version-checker"` |  |
-| image.tag | string | `nil` | Override the chart version |
-| livenessProbe | object | `{"enabled":true,"httpGet":{"path":"/readyz","port":8080},"initialDelaySeconds":3,"periodSeconds":3}` | Configure the healthcheck probe for version-checker |
+| image.repository | string | `"quay.io/jetstack/version-checker"` | Repository of the container image |
+| image.tag | string | `""` | Override the chart version. Defaults to `appVersion` of the helm chart. |
 | livenessProbe.enabled | bool | `true` | Enable/Disable the setting of a livenessProbe |
+| livenessProbe.httpGet.path | string | `"/readyz"` | Path to use for the livenessProbe |
+| livenessProbe.httpGet.port | int | `8080` | Port to use for the livenessProbe |
+| livenessProbe.initialDelaySeconds | int | `3` | Number of seconds after the container has started before liveness probes are initiated. |
+| livenessProbe.periodSeconds | int | `3` | How often (in seconds) to perform the livenessProbe. |
 | nodeSelector | object | `{}` | Configure nodeSelector |
-| prometheus | object | `{"enabled":false,"replicas":1,"serviceAccountName":"prometheus"}` | Prometheus Operator |
 | prometheus.enabled | bool | `false` | Deploy a Prometheus-Operator Prometheus Object to collect version-checker metrics |
+| prometheus.replicas | int | `1` | Number of Prometheus replicas to create |
 | prometheus.serviceAccountName | string | `"prometheus"` | ServiceAccount for new Prometheus Object |
-| quay.token | string | `nil` |  |
-| readinessProbe | object | `{"enabled":true,"httpGet":{"path":"/readyz","port":8080},"initialDelaySeconds":3,"periodSeconds":3}` | Configure the readiness probe for version-checker |
+| quay.token | string | `nil` | Access token for read access to private Quay registries |
 | readinessProbe.enabled | bool | `true` | Enable/Disable the setting of a readinessProbe |
+| readinessProbe.httpGet.path | string | `"/readyz"` | Path to use for the readinessProbe |
+| readinessProbe.httpGet.port | int | `8080` | Port to use for the readinessProbe |
+| readinessProbe.initialDelaySeconds | int | `3` | Number of seconds after the container has started before readiness probes are initiated. |
+| readinessProbe.periodSeconds | int | `3` | How often (in seconds) to perform the readinessProbe. |
 | replicaCount | int | `1` | Replica Count for version-checker |
 | resources | object | `{}` | Setup version-checkers resource requests/limits |
 | selfhosted | []{name: "", host: "", username:"", password:"", token:""}] | `[]` | Setup a number of SelfHosted Repositories and their credentials |
-| service | object | `{"annotations":{},"labels":{},"port":8080}` | Configure version-checkers Service |
+| service.annotations | object | `{}` | Additional annotations to add to the service |
+| service.labels | object | `{}` | Additional labels to add to the service |
 | service.port | int | `8080` | Port to expose within the service |
-| serviceMonitor | object | `{"additionalLabels":{},"enabled":false}` | Configure a Prometheus-Operator ServiceMonitor object |
+| serviceMonitor.additionalLabels | object | `{}` | Additional labels to add to the ServiceMonitor |
 | serviceMonitor.enabled | bool | `false` | Disable/Enable ServiceMonitor Object |
 | tolerations | list | `[]` | Configure tolerations |
-| versionChecker | object | `{"imageCacheTimeout":"30m","logLevel":"info","metricsServingAddress":"0.0.0.0:8080","testAllContainers":true}` | Configure version-checkers behaviour |
 | versionChecker.imageCacheTimeout | string | `"30m"` | How long to hold on to image tags and their versions |
 | versionChecker.logLevel | string | `"info"` | Configure version-checkers logging, valid options are: debug, info, warn, error, fatal, panic |
 | versionChecker.metricsServingAddress | string | `"0.0.0.0:8080"` | Port/interface to which version-checker should bind too |

diff --git a/deploy/charts/version-checker/values.yaml b/deploy/charts/version-checker/values.yaml
@@ -5,15 +5,16 @@
 # -- Replica Count for version-checker
 replicaCount: 1
 
-#  -- Additional Labels to apply to Service and Deployment/Pod Objects
+# -- Additional Labels to apply to Service and Deployment/Pod Objects
 additionalLabels: {}
-#  -- Additional Annotations to apply to Service and Deployment/Pod Objects
+# -- Additional Annotations to apply to Service and Deployment/Pod Objects
 additionalAnnotations: {}
 
 image:
+  # -- Repository of the container image
   repository: quay.io/jetstack/version-checker
-  # -- Override the chart version
-  tag:
+  # -- Override the chart version. Defaults to `appVersion` of the helm chart.
+  tag: ""
   # -- Set the Image Pull Policy
   pullPolicy: IfNotPresent
 
@@ -23,67 +24,69 @@ tolerations: []
 # -- Configure nodeSelector
 nodeSelector: {}
 
-# -- Configure version-checkers Service
+# Configure version-checkers Service
 service:
+  # -- Additional labels to add to the service
   labels: {}
+  # -- Additional annotations to add to the service
   annotations: {}
   # -- Port to expose within the service
   port: 8080
 
-# -- Configure version-checkers behaviour
+# Configure version-checkers behaviour
 versionChecker:
-  # versionChecker.imageCacheTimeout -- How long to hold on to image tags and their versions
+  # -- How long to hold on to image tags and their versions
   imageCacheTimeout: 30m
-  # versionChecker.logLevel -- Configure version-checkers logging, valid options are: debug, info, warn, error, fatal, panic
+  # -- Configure version-checkers logging, valid options are: debug, info, warn, error, fatal, panic
   logLevel: info
-  # versionChecker.metricsServingAddress -- Port/interface to which version-checker should bind too
+  # -- Port/interface to which version-checker should bind too
   metricsServingAddress: 0.0.0.0:8080
-  # versionChecker.testAllContainers -- Enable/Disable the requirement for an enable.version-checker.io annotation on pods.
+  # -- Enable/Disable the requirement for an enable.version-checker.io annotation on pods.
   testAllContainers: true
 
-# -- Azure Container Registry Credentials Configuration
+# Azure Container Registry Credentials Configuration
 acr:
-  # acr.username -- (string)
+  # -- (string) Username to authenticate with azure container registry
   username:
-  # acr.password -- (string)
+  # -- (string) Password to authenticate with azure container registry
   password:
-  # acr.refreshToken -- (string)
+  # -- (string) Refresh token to authenticate with azure container registry. Cannot be used with `acr.username` / `acr.password`.
   refreshToken:
 
 # Docker Hub Credentials Configuration
 docker:
-  # docker.username -- (string)
+  # -- (string) Username to authenticate with docker registry
   username:
-  # docker.password -- (string)
+  # -- (string) Password to authenticate with docker registry
   password:
-  # docker.token -- (string)
+  # -- (string) Token to authenticate with docker registry. Cannot be used with `docker.username` / `docker.password`.
   token:
 
 # Amazon Elastic Container Registry Credentials Configuration
 ecr:
   # -- (string) Provide AWS EKS Iam Role ARN following: [Specify A ServiceAccount Role](https://docs.aws.amazon.com/eks/latest/userguide/specify-service-account-role.html)
   iamRoleArn:
 
-  # -- (string)
+  # -- (string) ECR access key ID for read access to private registries
   accessKeyID:
-  # -- (string)
+  # -- (string) ECR secret access key for read access to private registries
   secretAccessKey:
-  # -- (string)
+  # -- (string) ECR session token for read access to private registries
   sessionToken:
 
 # Google Container Registry Credentials Configuration
 gcr:
-  # gcr.token -- (string)
+  # -- (string) Access token for read access to private GCR registries
   token:
 
 # Google Artifact Registry Credentials Configuration
 ghcr:
-  # ghcr.token -- (string)
+  # -- (string) Personal Access token for read access to GHCR releases
   token:
 
 # Quay.io Registry Credentials Configuration
 quay:
-  # quay.token -- (string)
+  # -- (string) Access token for read access to private Quay registries
   token:
 
 # -- Can be used to provide custom environment variables e.g. proxy settings
@@ -115,36 +118,46 @@ resources:
   #   memory: 128Mi
   #
 
-# -- Configure the readiness probe for version-checker
+# Configure the readiness probe for version-checker
 readinessProbe:
-  # readinessProbe.enabled -- Enable/Disable the setting of a readinessProbe
+  # -- Enable/Disable the setting of a readinessProbe
   enabled: true
   httpGet:
+    # -- Path to use for the readinessProbe
     path: /readyz
+    # -- Port to use for the readinessProbe
     port: 8080
+  # -- Number of seconds after the container has started before readiness probes are initiated.
   initialDelaySeconds: 3
+  # -- How often (in seconds) to perform the readinessProbe.
   periodSeconds: 3
 
-# -- Configure the healthcheck probe for version-checker
+# Configure the healthcheck probe for version-checker
 livenessProbe:
-  # livenessProbe.enabled -- Enable/Disable the setting of a livenessProbe
+  # -- Enable/Disable the setting of a livenessProbe
   enabled: true
   httpGet:
+    # -- Path to use for the livenessProbe
     path: /readyz
+    # -- Port to use for the livenessProbe
     port: 8080
+  # -- Number of seconds after the container has started before liveness probes are initiated.
   initialDelaySeconds: 3
+  # -- How often (in seconds) to perform the livenessProbe.
   periodSeconds: 3
 
-# -- Prometheus Operator
+# Prometheus Operator
 prometheus:
   # -- Deploy a Prometheus-Operator Prometheus Object to collect version-checker metrics
   enabled: false
+  # -- Number of Prometheus replicas to create
   replicas: 1
   # -- ServiceAccount for new Prometheus Object
   serviceAccountName: prometheus
 
-# -- Configure a Prometheus-Operator ServiceMonitor object
+# Configure a Prometheus-Operator ServiceMonitor object
 serviceMonitor:
-  # serviceMonitor.enabled -- Disable/Enable ServiceMonitor Object
+  # -- Disable/Enable ServiceMonitor Object
   enabled: false
+  # -- Additional labels to add to the ServiceMonitor
   additionalLabels: {}