From 93292e92ca2a0143f31ff2599cefe8bfa1e2d62d Mon Sep 17 00:00:00 2001
From: Matheus Moraes <matheusfaria.moraes@gmail.com>
Date: Fri, 4 Mar 2022 12:35:15 -0300
Subject: [PATCH] add parameters description as comment

---
 values.yaml | 38 +++++++++++++++++++++++++++++---------
 1 file changed, 29 insertions(+), 9 deletions(-)

diff --git a/values.yaml b/values.yaml
index 9ad17b4..ca49511 100644
--- a/values.yaml
+++ b/values.yaml
@@ -2,32 +2,40 @@
 # This is a YAML-formatted file.
 # Declare variables to be passed into your templates.
 
+# -- Number of replicas desired
 replicaCount: 1
 
 image:
+  # -- Image repository
   repository: mccutchen/go-httpbin
+  # -- Image pull policy
   pullPolicy: IfNotPresent
-  # Overrides the image tag whose default is the chart appVersion.
+  # -- Image tag
+  # @default -- chart appVersion
   tag: ""
 
+# -- Specify docker-registry secret names as an array
 imagePullSecrets: []
+# -- String to partially override fullname template with a string (will prepend the release name)
 nameOverride: ""
+# -- String to fully override fullname template with a string
 fullnameOverride: ""
 
 serviceAccount:
-  # Specifies whether a service account should be created
+  # -- Specifies whether a service account should be created
   create: true
-  # Annotations to add to the service account
+  # -- Annotations to add to the service account
   annotations: {}
-  # The name of the service account to use.
+  # -- The name of the service account to use.
   # If not set and create is true, a name is generated using the fullname template
   name: ""
 
+# -- Annotations to be added to pods
 podAnnotations: {}
-
+# -- [Security Context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context) to add to the pod
 podSecurityContext: {}
   # fsGroup: 2000
-
+# -- [Security Context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context) to add to the container
 securityContext: {}
   # capabilities:
   #   drop:
@@ -37,12 +45,17 @@ securityContext: {}
   # runAsUser: 1000
 
 service:
+  # -- Service type
   type: ClusterIP
+  # -- Service port
   port: 80
 
 ingress:
+  # -- Specifies whether the ingress should be created
   enabled: false
+  # -- Ingress class name
   className: ""
+  # -- Annotations to add to the ingress
   annotations: {}
     # kubernetes.io/ingress.class: nginx
     # kubernetes.io/tls-acme: "true"
@@ -56,6 +69,7 @@ ingress:
   #    hosts:
   #      - chart-example.local
 
+# -- [Resources](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers) to add to the container
 resources: {}
   # We usually recommend not to specify default resources and to leave this as a conscious
   # choice for the user. This also increases chances charts run on environments with little
@@ -69,14 +83,20 @@ resources: {}
   #   memory: 128Mi
 
 autoscaling:
+  # -- Enable replica autoscaling settings
   enabled: false
+  # -- Minimum replicas for the pod autoscaling
   minReplicas: 1
+  # -- Maximum replicas for the pod autoscaling
   maxReplicas: 100
+  # -- Percentage of CPU to consider when autoscaling
   targetCPUUtilizationPercentage: 80
-  # targetMemoryUtilizationPercentage: 80
+  # -- Percentage of Memory to consider when autoscaling
+  targetMemoryUtilizationPercentage: ""
 
+# -- [Node selection](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node) to constrain a Pod to only be able to run on particular Node(s)
 nodeSelector: {}
-
+# -- [Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration) for pod assignment
 tolerations: []
-
+# -- Map of node/pod [affinities](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration)
 affinity: {}