Update values.yaml

application/values.yaml

@@ -8,7 +8,8 @@ componentOverride: ""
 partOfOverride: ""
 
 # -- Name of the application.
-applicationName: "application"
+# @default uses "{chart.name}" if not set 
+applicationName: ""
 
 cronJob:
   # -- Deploy CronJobs
@@ -337,35 +338,42 @@ deployment:
 
 # -- Add Storage volumes to the pods
 persistence:
+  # -- Enable persistence
   enabled: false
+  # -- Whether to mount the created PVC to the deployment
   mountPVC: false
+  # -- If `persistence.mountPVC` is enabled, where to mount the volume in the containers
   mountPath: "/"
+  # -- Name of the PVC
+  # @default will be computed to "{applicationName}-data"
   name: ""
+  # -- Access mode for volume
   accessMode: ReadWriteOnce
-  ## If defined, storageClass: <storageClass>
-  ## If set to "-", storageClass: "", which disables dynamic provisioning
-  ## If undefined (the default) or set to null, no storageClass spec is
-  ##   set, choosing the default provisioner.  (gp2 on AWS, standard on
-  ##   GKE, AWS & OpenStack)
-  ##
-  storageClass: "-"
+  # -- Storage class for volume
+  # If defined, use that value
+  # If set to "-" or "", disable dynamic provisioning
+  # If undefined or set to null (the default), no storageClass spec is
+  #   set, choosing the default provisioner.
+  storageClass: null
+  # -- Additional labels for persistent volume
   additionalLabels:
-    # key: "value"
+    # key: value
+  # -- Annotations for persistent volume
   annotations:
-  #  "helm.sh/resource-policy": keep
+    # "helm.sh/resource-policy": keep
+  # -- Size of the persistent volume
   storageSize: 8Gi
+  # -- PVC Volume Mode
   volumeMode: ""
+  # -- Name of the volume
   volumeName: ""
 
-
-##########################################################
-# Service object for servicing pods
-##########################################################
 service:
+  # -- Enable Service
   enabled: true
+  # -- Additional labels for service
   additionalLabels:
-    # expose: "true"
-
+  # -- Annotations for service
   annotations:
     # config.xposer.stakater.com/Domain: stakater.com
     # config.xposer.stakater.com/IngressNameTemplate: '{{ "{{.Service}}-{{.Namespace}}" }}'
@@ -377,52 +385,49 @@ service:
     #   kubernetes.io/ingress.class: external-ingress
     #   ingress.kubernetes.io/rewrite-target: /
     #   ingress.kubernetes.io/force-ssl-redirect: true
-
+  # -- Ports for applications service
   ports:
     - port: 8080
       name: http
       protocol: TCP
       targetPort: 8080
+  # -- Type of service
   type: ClusterIP
-
-  # Set to 'None' will make this service headless
+  # -- Fixed IP for a ClusterIP service
+  # Set to `None` for an headless service
   clusterIP:
 
-##########################################################
-# Ingress object for exposing services
-##########################################################
 ingress:
+  # -- Enable Ingress 
   enabled: false
-
-  # Name of the ingress class
+  # -- Name of the ingress class
   ingressClassName: ''
-
-  # Port of the service that serves pods
-  servicePort: http
-
-  #Set pathType: default is ImplementationSpecific; Options: Exact, Prefix
-  pathType: ImplementationSpecific
-
-  # List of host addresses to be exposed by this Ingress
   hosts:
-    - host: chart-example.local
+    - # -- Hostname (templated field)
+      host: chart-example.local
       paths:
-      - path: /
-      #  pathType: ''
-      #  serviceName: ''
-      #  servicePort: ''
-  # Additional labels for this Ingress
+      - # -- Path
+        path: /
+        # -- Path type
+        # @default `ImplementationSpecific`
+        pathType:
+        # -- Service name
+        # @default `{applicationName}`
+        serviceName:
+        # -- Service port
+        # @default `http`
+        servicePort:
+
+  # -- Additional labels for ingress
   additionalLabels:
-
-  # Add annotations to this Ingress
+  # -- Annotations for Ingress
   annotations:
     # kubernetes.io/ingress.class: external-ingress
     # ingress.kubernetes.io/rewrite-target: /
     # ingress.kubernetes.io/force-ssl-redirect: true
-
-  # TLS details for this Ingress
+  # -- TLS configuration for ingress
+  #  Secrets must be manually created in the namespace
   tls:
-    # Secrets must be manually created in the namespace.
     # - secretName: chart-example-tls
     #   hosts:
     #     - chart-example.local