refactor: Renaming function in chart and adding doc

Author: ViBiOh

infra/templates/_helpers.tpl

@@ -1,16 +1,16 @@
-{{/*
+{{ /*
 Expand the name of the chart.
-*/}}
-{{- define "goweb.name" -}}
+*/ }}
+{{- define "app.name" -}}
   {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
 {{- end }}
 
-{{/*
+{{ /*
 Create a default fully qualified app name.
 We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
 If release name contains chart name it will be used as a full name.
-*/}}
-{{- define "goweb.fullname" -}}
+*/ }}
+{{- define "app.fullname" -}}
   {{- if .Values.fullnameOverride }}
     {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
   {{- else }}
@@ -23,39 +23,39 @@ If release name contains chart name it will be used as a full name.
   {{- end }}
 {{- end }}
 
-{{/*
+{{ /*
 Create chart name and version as used by the chart label.
-*/}}
-{{- define "goweb.chart" -}}
+*/ }}
+{{- define "app.chart" -}}
   {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
 {{- end }}
 
-{{/*
+{{ /*
 Ingress hosts
-*/}}
+*/ }}
 {{- define "ingress.hosts" -}}
   {{ range $count, $e := .Values.ingress.hosts -}}
     {{- if gt $count 0 }} || {{ end -}}
     Host(`{{ $e }}`)
   {{- end }}
 {{- end }}
 
-{{/*
+{{ /*
 Common labels
-*/}}
-{{- define "goweb.labels" -}}
-helm.sh/chart: {{ include "goweb.chart" . }}
-{{ include "goweb.selectorLabels" . }}
+*/ }}
+{{- define "app.labels" -}}
+helm.sh/chart: {{ include "app.chart" . }}
+{{ include "app.selectorLabels" . }}
 {{- if .Chart.AppVersion }}
 app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
 {{- end }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{- end }}
 
-{{/*
+{{ /*
 Selector labels
-*/}}
-{{- define "goweb.selectorLabels" -}}
-app.kubernetes.io/name: {{ include "goweb.name" . }}
+*/ }}
+{{- define "app.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "app.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end }}

infra/templates/config_map.yaml

@@ -3,10 +3,10 @@
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: {{ include "goweb.fullname" . }}
+  name: {{ include "app.fullname" . }}
   namespace: {{ .Values.namespace }}
   labels:
-    {{- include "goweb.labels" . | nindent 4 }}
+    {{- include "app.labels" . | nindent 4 }}
 data:
   {{- toYaml .Values.Config | nindent 2 }}
 {{ end }}

infra/templates/deployment.yaml

@@ -2,14 +2,14 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: {{ include "goweb.fullname" . }}
+  name: {{ include "app.fullname" . }}
   namespace: {{ .Values.namespace }}
   labels:
-    {{- include "goweb.labels" . | nindent 4 }}
+    {{- include "app.labels" . | nindent 4 }}
 spec:
   selector:
     matchLabels:
-      {{- include "goweb.selectorLabels" . | nindent 6 }}
+      {{- include "app.selectorLabels" . | nindent 6 }}
   template:
     metadata:
       {{- with .Values.podAnnotations }}
@@ -20,12 +20,17 @@ spec:
         checksum/config: {{ toYaml . | sha256sum }}
       {{- end }}
       labels:
-        {{- include "goweb.selectorLabels" . | nindent 8 }}
+        {{- include "app.selectorLabels" . | nindent 8 }}
     spec:
       containers:
         - name: {{ .Chart.Name }}
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
+          {{- if .Values.config }}
+          envFrom:
+            - configMapRef:
+                name: {{ include "app.fullname" . }}
+          {{- end }}
           ports:
             - name: http
               containerPort: 1080

infra/templates/hpa.yaml

@@ -3,15 +3,15 @@
 apiVersion: autoscaling/v1
 kind: HorizontalPodAutoscaler
 metadata:
-  name: {{ include "goweb.fullname" . }}
+  name: {{ include "app.fullname" . }}
   namespace: {{ .Values.namespace }}
   labels:
-    {{- include "goweb.labels" . | nindent 4 }}
+    {{- include "app.labels" . | nindent 4 }}
 spec:
   scaleTargetRef:
     apiVersion: apps/v1
     kind: Deployment
-    name: {{ include "goweb.fullname" . }}
+    name: {{ include "app.fullname" . }}
   minReplicas: {{ .Values.autoscaling.minReplicas }}
   maxReplicas: {{ .Values.autoscaling.maxReplicas }}
   targetCPUUtilizationPercentage: {{ .Values.autoscaling.targetCPUUtilizationPercentage }}

infra/templates/ingress.yaml

@@ -3,10 +3,10 @@
 apiVersion: traefik.containo.us/v1alpha1
 kind: IngressRoute
 metadata:
-  name: {{ include "goweb.fullname" . }}-http
+  name: {{ include "app.fullname" . }}-http
   namespace: {{ .Values.namespace }}
   labels:
-    {{- include "goweb.labels" . | nindent 4 }}
+    {{- include "app.labels" . | nindent 4 }}
 spec:
   entryPoints:
     - http
@@ -16,18 +16,18 @@ spec:
       middlewares:
         - name: redirect
       services:
-        - name: {{ include "goweb.fullname" . }}
+        - name: {{ include "app.fullname" . }}
           namespace: {{ .Values.namespace }}
           port: {{ .Values.service.port }}
 
 ---
 apiVersion: traefik.containo.us/v1alpha1
 kind: IngressRoute
 metadata:
-  name: {{ include "goweb.fullname" . }}-https
+  name: {{ include "app.fullname" . }}-https
   namespace: {{ .Values.namespace }}
   labels:
-    {{- include "goweb.labels" . | nindent 4 }}
+    {{- include "app.labels" . | nindent 4 }}
 spec:
   entryPoints:
     - https
@@ -38,7 +38,7 @@ spec:
         - name: compress
         - name: ratelimit
       services:
-        - name: {{ include "goweb.fullname" . }}
+        - name: {{ include "app.fullname" . }}
           namespace: {{ .Values.namespace }}
           port: {{ .Values.service.port }}
   tls:

infra/templates/pdb.yaml

@@ -3,13 +3,13 @@
 apiVersion: policy/v1beta1
 kind: PodDisruptionBudget
 metadata:
-  name: {{ include "goweb.fullname" . }}
+  name: {{ include "app.fullname" . }}
   namespace: {{ .Values.namespace }}
   labels:
-    {{- include "goweb.labels" . | nindent 4 }}
+    {{- include "app.labels" . | nindent 4 }}
 spec:
   minAvailable: {{ .Values.pod_disruption.minAvailable }}
   selector:
     matchLabels:
-      {{- include "goweb.selectorLabels" . | nindent 6 }}
+      {{- include "app.selectorLabels" . | nindent 6 }}
 {{- end -}}

infra/templates/service.yaml

@@ -2,10 +2,10 @@
 apiVersion: v1
 kind: Service
 metadata:
-  name: {{ include "goweb.fullname" . }}
+  name: {{ include "app.fullname" . }}
   namespace: {{ .Values.namespace }}
   labels:
-    {{- include "goweb.labels" . | nindent 4 }}
+    {{- include "app.labels" . | nindent 4 }}
 spec:
   type: {{ .Values.service.type }}
   ports:
@@ -14,4 +14,4 @@ spec:
       targetPort: http
       protocol: TCP
   selector:
-    {{- include "goweb.selectorLabels" . | nindent 4 }}
+    {{- include "app.selectorLabels" . | nindent 4 }}

infra/values.yaml

@@ -1,20 +1,29 @@
 ---
+
+# namespace is the namespace of every object created
 namespace: default
 
+# image is the configuration of image management
 image:
   repository: vibioh/goweb
   pullPolicy: Always
 
+# podAnnotations is the map of annotations placed on the pod
 podAnnotations:
   prometheus.io/scrape: "true"
   prometheus.io/scheme: http
   prometheus.io/port: "1080"
 
+# livenessProbePath is the path of liveness
 livenessProbePath: /health
+
+# readinessProbePath is the path of readiness
 readinessProbePath: /health
 
+# config is the map of env var passed to the pod
 config: {}
 
+# resources are the requests and limits for defining the QoS
 resources:
   limits:
     cpu: 100m
@@ -23,19 +32,23 @@ resources:
     cpu: 100m
     memory: 64M
 
+# service is the configuration map for the service
 service:
   type: ClusterIP
   port: 80
 
+# ingress is the configuration of the Traefik's ingress, in any
 ingress:
   enabled: true
   hosts:
     - goweb.vibioh.fr
 
+# pod_disruption is the configuration of the pod_disruption_budget, in any
 pod_disruption:
   enabled: true
   minAvailable: 1
 
+# autoscaling is the configuration of the horizontal pod autoscaler, in any
 autoscaling:
   enabled: true
   minReplicas: 1