Migrate to readme-generator for helm maintained by bitnami (#431)

Co-authored-by: Krishnakumar Venkataraman <[email protected]>
Co-authored-by: Marco Franssen <[email protected]>

charts/spire/charts/tornjak-frontend/values.yaml

@@ -1,38 +1,53 @@
-# Default values for Tornjak UI (Frontend).
-# This is a YAML-formatted file.
-# Declare variables to be passed into your templates.
+# Default configuration for Tornjak UI (Frontend)
+# SPDX-License-Identifier: APACHE-2.0
 
-# @ignored
+## @skip global
 global: {}
 
+## @section Chart parameters
+##
+## @param image.registry The OCI registry to pull the image from
+## @param image.repository The repository within the registry
+## @param image.pullPolicy The image pull policy
+## @param image.version This value is deprecated in favor of tag. (Will be removed in a future release)
+## @param image.tag Overrides the image tag whose default is the chart appVersion
+##
 image:
   registry: ghcr.io
   repository: spiffe/tornjak-frontend
   pullPolicy: IfNotPresent
-  # -- This value is deprecated in favor of tag. (Will be removed in a future release)
   version: ""
-  # -- Overrides the image tag whose default is the chart appVersion.
   tag: ""
 
+## @param imagePullSecrets [array] Pull secrets for images
 imagePullSecrets: []
+
+## @param nameOverride Name override 
 nameOverride: ""
+
+## @param namespaceOverride Namespace override 
 namespaceOverride: ""
+
+## @param fullnameOverride Fullname override 
 fullnameOverride: ""
 
+## @param serviceAccount.create Specifies whether a service account should be created
+## @param serviceAccount.annotations [object] Annotations to add to the service account
+## @param serviceAccount.name The name of the service account to use. If not set and create is true, a name is generated.
+##
 serviceAccount:
-  # -- Specifies whether a service account should be created
   create: true
-  # -- Annotations to add to the service account
   annotations: {}
-  # -- The name of the service account to use.
-  # If not set and create is true, a name is generated using the fullname template
   name: ""
 
+## @param labels [object] Labels for tornjak frontend pods
 labels: {}
 
+## @param podSecurityContext [object] Pod security context
 podSecurityContext: {}
   # fsGroup: 2000
 
+## @param securityContext [object] Security context
 securityContext: {}
   # capabilities:
   #   drop:
@@ -41,22 +56,30 @@ securityContext: {}
   # runAsNonRoot: true
   # runAsUser: 1000
 
+## @param service.type Service type
+## @param service.port Service port
+## @param service.annotations Annotations for service resource
+##
 service:
   type: ClusterIP
   port: 3000
   annotations: {}
 
-# -- Select specific nodes to run on (currently only amd64 is supported by Tornjak)
+## @extra nodeSelector Select specific nodes to run on (currently only amd64 is supported by Tornjak)
 nodeSelector:
+  ## @skip nodeSelector.kubernetes.io/arch
   kubernetes.io/arch: amd64
 
+## @param affinity [object] Affinity rules
 affinity: {}
 
+## @param tolerations [array] List of tolerations
 tolerations: []
 
+## @param topologySpreadConstraints [array] List of topology spread constraints for resilience
 topologySpreadConstraints: []
 
-# -- Provide minimal resources to prevent accidental crashes due to resource exhaustion
+## Provide minimal resources to prevent accidental crashes due to resource exhaustion
 # resources:
 #   requests:
 #     cpu: 50m
@@ -65,44 +88,42 @@ topologySpreadConstraints: []
 #     cpu: 100m
 #     memory: 512Mi
 
-# -- URL of the Tornjak APIs (backend)
-# Since Tornjak Frontend runs in the browser, this URL must be accessible from
-# the machine running a browser.
+## @param apiServerURL URL of the Tornjak APIs (backend). Since Tornjak Frontend runs in the browser, this URL must be accessible from the machine running a browser.
 apiServerURL: "http://localhost:10000/"  # 👈 Use it for minikube or kind
 
 # SPIRE Healthchecker indicator
 spireHealthCheck:
-  # -- Enables the SPIRE Healthchecker indicator
+  ## @param spireHealthCheck.enabled Enables the SPIRE Healthchecker indicator
   enabled: true
 
 ## Configure extra options for Tornjak frontend container's startup probe
 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-startup-probes
+## @param startupProbe.enabled Enable startupProbe on Tornjak frontend container
+## @param startupProbe.initialDelaySeconds Initial delay seconds for startupProbe
+## @param startupProbe.periodSeconds Period seconds for startupProbe
+## @param startupProbe.timeoutSeconds Timeout seconds for startupProbe
+## @param startupProbe.failureThreshold Failure threshold count for startupProbe
+## @param startupProbe.successThreshold Success threshold count for startupProbe
 ##
 startupProbe:
-  # -- Enable startupProbe on Tornjak frontend container
   enabled: true
-  # -- Initial delay seconds for startupProbe
   initialDelaySeconds: 5
-  # -- Period seconds for startupProbe
   periodSeconds: 10
-  # -- Timeout seconds for startupProbe
   timeoutSeconds: 5
-  # -- Failure threshold count for startupProbe
   failureThreshold: 6
-  # -- Success threshold count for startupProbe
   successThreshold: 1
 
-# @ignored
 tests:
   bash:
+    ## @param tests.bash.image.registry The OCI registry to pull the image from
+    ## @param tests.bash.image.repository The repository within the registry
+    ## @param tests.bash.image.pullPolicy The image pull policy
+    ## @param tests.bash.image.version This value is deprecated in favor of tag. (Will be removed in a future release)
+    ## @param tests.bash.image.tag Overrides the image tag whose default is the chart appVersion
+    ##
     image:
-      # -- The OCI registry to pull the image from
       registry: cgr.dev
-      # -- The repository within the registry
       repository: chainguard/bash
-      # -- The image pull policy
       pullPolicy: IfNotPresent
-      # -- This value is deprecated in favor of tag. (Will be removed in a future release)
       version: ""
-      # -- Overrides the image tag
       tag: latest@sha256:96ab1600d945b4a99c8610b5c8b31e346da63dc20573a26bb0777dd0190db5d4