docs(cert-manager-webhook-hetzner): 📝 added readme metadata to values…

….yaml Signed-off-by: Mario-F <github@fritschen.net>
Mario-F · Mar 22, 2022 · c7cf412 · c7cf412
1 parent 06fc57a
commit c7cf412
Show file tree

Hide file tree

Showing 3 changed files with 89 additions and 11 deletions.
diff --git a/charts/cert-manager-webhook-hetzner/Chart.yaml b/charts/cert-manager-webhook-hetzner/Chart.yaml
@@ -2,5 +2,5 @@ apiVersion: v2
 name: cert-manager-webhook-hetzner
 description: A chart to deploy cert-manager-webhook-hetzner
 type: application
-version: 1.2.1
+version: 1.2.2
 appVersion: "v1.0.0-mr9"
diff --git a/charts/cert-manager-webhook-hetzner/README.md b/charts/cert-manager-webhook-hetzner/README.md
@@ -20,6 +20,45 @@ helm install cert-manager-webhook-hetzner \
   mariof-charts/cert-manager-webhook-hetzner
 ```
 
+## Parameters
+
+### Common parameters
+
+| Name               | Description                                        | Value |
+| ------------------ | -------------------------------------------------- | ----- |
+| `nameOverride`     | String to partially override common.names.fullname | `""`  |
+| `fullnameOverride` | String to fully override common.names.fullname     | `""`  |
+
+
+### Cert-Manager-Webhook-Hetzner Configuration parameters
+
+| Name                             | Description                                                            | Value                                            |
+| -------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------ |
+| `groupName`                      | Cert-Manager groupName                                                 | `acme.default.hetzner.webhook`                   |
+| `hetzner.token`                  | Hetzner DNS api token                                                  | `""`                                             |
+| `hetzner.email`                  | E-Mail presented to lets-encrypt                                       | `""`                                             |
+| `hetzner.acmeServer`             | lets-encrypt api to use                                                | `https://acme-v02.api.letsencrypt.org/directory` |
+| `certManager.namespace`          | Namespace cert-manager is deployed                                     | `cert-manager`                                   |
+| `certManager.serviceAccountName` | ServiceAccountname of cert-manager access this webhook                 | `cert-manager`                                   |
+| `image.repository`               | cert-manager-webhook-hetzner image repository                          | `mariof2002/cert-manager-webhook-hetzner`        |
+| `image.tag`                      | cert-manager-webhook-hetzner image tag (default to AppVersion)         | `""`                                             |
+| `image.pullPolicy`               | cert-manager-webhook-hetzner image pull policy                         | `IfNotPresent`                                   |
+| `service.type`                   | Service type                                                           | `ClusterIP`                                      |
+| `service.port`                   | Service HTTP port                                                      | `443`                                            |
+| `resources.limits`               | The resources limits for the cert-manager-webhook-hetzner container    | `{}`                                             |
+| `resources.requests`             | The requested resources for the cert-manager-webhook-hetzner container | `{}`                                             |
+| `nodeSelector`                   | Node labels for pod assignment.                                        | `{}`                                             |
+| `tolerations`                    | Tolerations for pod assignment.                                        | `[]`                                             |
+| `affinity`                       | Affinity for pod assignment                                            | `{}`                                             |
+
+
+### Additional features parameters
+
+| Name        | Description                           | Value |
+| ----------- | ------------------------------------- | ----- |
+| `templates` | See templates section for explanation | `[]`  |
+
+
 ## Templates
 
 This chart provides a template render mechanism for rendering additional ressources bound to this release.

diff --git a/charts/cert-manager-webhook-hetzner/values.yaml b/charts/cert-manager-webhook-hetzner/values.yaml
@@ -1,39 +1,78 @@
+## @section Common parameters
+
+## @param nameOverride String to partially override common.names.fullname
+##
+nameOverride: ""
+## @param fullnameOverride String to fully override common.names.fullname
+##
+fullnameOverride: ""
+
+## @section Cert-Manager-Webhook-Hetzner Configuration parameters
+
+## @param groupName Cert-Manager groupName
 groupName: acme.default.hetzner.webhook
 
+## @param hetzner.token [string] Hetzner DNS api token
+## @param hetzner.email [string] E-Mail presented to lets-encrypt
+## @param hetzner.acmeServer lets-encrypt api to use
 hetzner: # set token and email activate the default cluster isser
   # token: "my_api_token"
   # email: my@acme.mail
   acmeServer: https://acme-v02.api.letsencrypt.org/directory
 
+## @param certManager.namespace Namespace cert-manager is deployed
+## @param certManager.serviceAccountName ServiceAccountname of cert-manager access this webhook
 certManager:
   namespace: cert-manager
   serviceAccountName: cert-manager
 
+## cert-manager-webhook-hetzner Image version
+## ref: https://github.com/Mario-F/cert-manager-webhook-hetzner
+## @param image.repository cert-manager-webhook-hetzner image repository
+## @param image.tag [string] cert-manager-webhook-hetzner image tag (default to AppVersion)
+## @param image.pullPolicy cert-manager-webhook-hetzner image pull policy
 image:
   repository: mariof2002/cert-manager-webhook-hetzner
   pullPolicy: IfNotPresent
 
-nameOverride: ""
-fullnameOverride: ""
-
+## cert-manager-webhook-hetzner service properties
+## @param service.type Service type
+## @param service.port Service HTTP port
 service:
   type: ClusterIP
   port: 443
 
-resources: {}
-  # limits:
-  #  cpu: 100m
-  #  memory: 128Mi
-  # requests:
-  #  cpu: 100m
-  #  memory: 128Mi
+## cert-manager-webhook-hetzner containers' resource requests and limits
+## ref: https://kubernetes.io/docs/user-guide/compute-resources/
+## @param resources.limits The resources limits for the cert-manager-webhook-hetzner container
+## @param resources.requests The requested resources for the cert-manager-webhook-hetzner container
+resources:
+  ## Example:
+  ## limits:
+  ##    cpu: 100m
+  ##    memory: 128Mi
+  limits: {}
+  ## Examples:
+  ## requests:
+  ##    cpu: 100m
+  ##    memory: 128Mi
+  requests: {}
 
+## @param nodeSelector Node labels for pod assignment.
+## Ref: https://kubernetes.io/docs/user-guide/node-selection/
 nodeSelector: {}
 
+## @param tolerations Tolerations for pod assignment.
+## Ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
 tolerations: []
 
+## @param affinity Affinity for pod assignment
+## Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
 affinity: {}
 
+## @section Additional features parameters
+
+## @param templates [array] See templates section for explanation
 templates: []
   # - enabled: true
   #   content: |