From e79fa3fe027cc596b5ef4093d22e7ad3b42d8f5a Mon Sep 17 00:00:00 2001 From: Jim Martens Date: Sun, 20 Aug 2023 18:51:00 +0200 Subject: [PATCH] Added template library helm chart --- helm/template/.helmignore | 27 ++++ helm/template/Chart.yaml | 10 ++ helm/template/_templates/NOTES.txt | 22 ++++ helm/template/_templates/deployment.yaml | 1 + helm/template/_templates/hpa.yaml | 1 + helm/template/_templates/ingress.yaml | 1 + helm/template/_templates/secret.yaml | 1 + helm/template/_templates/service.yaml | 1 + helm/template/_templates/serviceaccount.yaml | 1 + .../_templates/tests/test-connection.yaml | 15 +++ helm/template/_values.yaml | 115 ++++++++++++++++++ helm/template/templates/_deployment.yaml | 108 ++++++++++++++++ helm/template/templates/_helpers.tpl | 76 ++++++++++++ helm/template/templates/_hpa.yaml | 34 ++++++ helm/template/templates/_ingress.yaml | 47 +++++++ helm/template/templates/_secret.yaml | 14 +++ helm/template/templates/_service.yaml | 23 ++++ helm/template/templates/_serviceaccount.yaml | 14 +++ 18 files changed, 511 insertions(+) create mode 100644 helm/template/.helmignore create mode 100644 helm/template/Chart.yaml create mode 100644 helm/template/_templates/NOTES.txt create mode 100644 helm/template/_templates/deployment.yaml create mode 100644 helm/template/_templates/hpa.yaml create mode 100644 helm/template/_templates/ingress.yaml create mode 100644 helm/template/_templates/secret.yaml create mode 100644 helm/template/_templates/service.yaml create mode 100644 helm/template/_templates/serviceaccount.yaml create mode 100644 helm/template/_templates/tests/test-connection.yaml create mode 100644 helm/template/_values.yaml create mode 100644 helm/template/templates/_deployment.yaml create mode 100644 helm/template/templates/_helpers.tpl create mode 100644 helm/template/templates/_hpa.yaml create mode 100644 helm/template/templates/_ingress.yaml create mode 100644 helm/template/templates/_secret.yaml create mode 100644 helm/template/templates/_service.yaml create mode 100644 helm/template/templates/_serviceaccount.yaml diff --git a/helm/template/.helmignore b/helm/template/.helmignore new file mode 100644 index 0000000..52f2291 --- /dev/null +++ b/helm/template/.helmignore @@ -0,0 +1,27 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# environment values +environments/ +_values.yaml +_templates/ diff --git a/helm/template/Chart.yaml b/helm/template/Chart.yaml new file mode 100644 index 0000000..96679e3 --- /dev/null +++ b/helm/template/Chart.yaml @@ -0,0 +1,10 @@ +apiVersion: v2 +name: template +description: A Helm library chart containing common templates, keeping application templates short +type: library +version: 0.1.3 +maintainers: + - name: Jim Martens + url: https://2martens.de +sources: + - https://git.2martens.de/2martens/cloud-configuration diff --git a/helm/template/_templates/NOTES.txt b/helm/template/_templates/NOTES.txt new file mode 100644 index 0000000..238e58c --- /dev/null +++ b/helm/template/_templates/NOTES.txt @@ -0,0 +1,22 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range $host := .Values.ingress.hosts }} + {{- range .paths }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} + {{- end }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "template.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "template.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "template.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "template.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT +{{- end }} diff --git a/helm/template/_templates/deployment.yaml b/helm/template/_templates/deployment.yaml new file mode 100644 index 0000000..0cce0d1 --- /dev/null +++ b/helm/template/_templates/deployment.yaml @@ -0,0 +1 @@ +{{- include "template.deployment" . -}} diff --git a/helm/template/_templates/hpa.yaml b/helm/template/_templates/hpa.yaml new file mode 100644 index 0000000..9660d8f --- /dev/null +++ b/helm/template/_templates/hpa.yaml @@ -0,0 +1 @@ +{{- include "template.hpa" . -}} diff --git a/helm/template/_templates/ingress.yaml b/helm/template/_templates/ingress.yaml new file mode 100644 index 0000000..a76eb95 --- /dev/null +++ b/helm/template/_templates/ingress.yaml @@ -0,0 +1 @@ +{{- include "template.ingress" . -}} diff --git a/helm/template/_templates/secret.yaml b/helm/template/_templates/secret.yaml new file mode 100644 index 0000000..3946eca --- /dev/null +++ b/helm/template/_templates/secret.yaml @@ -0,0 +1 @@ +{{- include "template.secret" . -}} diff --git a/helm/template/_templates/service.yaml b/helm/template/_templates/service.yaml new file mode 100644 index 0000000..11147a6 --- /dev/null +++ b/helm/template/_templates/service.yaml @@ -0,0 +1 @@ +{{- include "template.service" . -}} diff --git a/helm/template/_templates/serviceaccount.yaml b/helm/template/_templates/serviceaccount.yaml new file mode 100644 index 0000000..05b1a1e --- /dev/null +++ b/helm/template/_templates/serviceaccount.yaml @@ -0,0 +1 @@ +{{- include "template.serviceAccount" . -}} diff --git a/helm/template/_templates/tests/test-connection.yaml b/helm/template/_templates/tests/test-connection.yaml new file mode 100644 index 0000000..2ac6104 --- /dev/null +++ b/helm/template/_templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "template.fullname" . }}-test-connection" + labels: + {{- include "template.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "template.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/helm/template/_values.yaml b/helm/template/_values.yaml new file mode 100644 index 0000000..4b2f780 --- /dev/null +++ b/helm/template/_values.yaml @@ -0,0 +1,115 @@ +# Default values for template. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: 2martens/template + pullPolicy: IfNotPresent + # Overrides the image tag whose default is latest + tag: "" + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +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: "" + +podAnnotations: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} +# capabilities: +# drop: +# - ALL +# readOnlyRootFilesystem: true +# runAsNonRoot: true +# runAsUser: 1000 + +application: + port: 8080 + actuatorPort: 8081 + profile: prod + isSpring: true + +environment: [] + +enableServiceLinks: false + +secrets: {} + +service: + type: ClusterIP + port: 8080 + actuatorPort: 8081 + +livenessProbe: + enabled: true + path: /actuator/health/liveness + port: http-actuator + initialDelaySeconds: 30 + periodSeconds: 120 + +readinessProbe: + enabled: true + path: /actuator/health/readiness + port: http-actuator + initialDelaySeconds: 30 + periodSeconds: 10 + timeoutSeconds: 2 + +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: + - path: / + pathType: ImplementationSpecific + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +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 + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +nodeSelector: {} + +tolerations: [] + +affinity: {} + +# podSpec: will be added at the bottom of the pod template in the deployment +podSpec: {} +# containerSpec: will be added at the bottom of the container specification in the pod template +containerSpec: {} diff --git a/helm/template/templates/_deployment.yaml b/helm/template/templates/_deployment.yaml new file mode 100644 index 0000000..71bdab6 --- /dev/null +++ b/helm/template/templates/_deployment.yaml @@ -0,0 +1,108 @@ +{{- define "template.deployment" -}} +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "template.fullname" . }} + labels: + {{- include "template.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "template.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "template.selectorLabels" . | nindent 8 }} + spec: + enableServiceLinks: {{ .Values.enableServiceLinks }} + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "template.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default "latest" }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + {{- if .Values.secrets }} + envFrom: + - secretRef: + name: {{ include "template.fullname" . }} + {{- end }} + env: + {{- if .Values.application.isSpring }} + - name: SPRING_PROFILES_ACTIVE + value: {{ .Values.application.profile }} + {{- end}} + {{- range .Values.environment }} + - name: {{ .name }} + value: {{ .value | quote }} + {{- end }} + ports: + - name: http + containerPort: {{ .Values.application.port }} + protocol: TCP + {{- if .Values.application.isSpring }} + - name: http-actuator + containerPort: {{ .Values.application.actuatorPort }} + protocol: TCP + {{- end }} + {{- if .Values.livenessProbe.enabled }} + livenessProbe: + httpGet: + path: {{ .Values.livenessProbe.path }} + port: {{ .Values.livenessProbe.port }} + initialDelaySeconds: {{ .Values.livenessProbe.initialDelaySeconds }} + periodSeconds: {{ .Values.livenessProbe.periodSeconds }} + {{- end }} + {{- if .Values.readinessProbe.enabled }} + readinessProbe: + httpGet: + path: {{ .Values.readinessProbe.path }} + port: {{ .Values.readinessProbe.port }} + initialDelaySeconds: {{ .Values.readinessProbe.initialDelaySeconds }} + periodSeconds: {{ .Values.readinessProbe.periodSeconds }} + timeoutSeconds: {{ .Values.readinessProbe.timeoutSeconds }} + {{- end }} + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- with .Values.containerSpec }} + {{- toYaml . | nindent 10 }} + {{- end }} + {{/* + Due to the asynchronous way Kubernetes shuts down applications there is a period of + time when requests can be sent to the application while an application is being terminated. + To deal with this we can configure a pre-stop sleep to allow enough time for requests to + stop being routed to the application before it is terminated. + */}} + lifecycle: + preStop: + exec: + command: [ "sh", "-c", "sleep 10" ] + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.podSpec }} + {{- toYaml . | nindent 6 }} + {{- end }} +{{- end }} diff --git a/helm/template/templates/_helpers.tpl b/helm/template/templates/_helpers.tpl new file mode 100644 index 0000000..bc60ae6 --- /dev/null +++ b/helm/template/templates/_helpers.tpl @@ -0,0 +1,76 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "template.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 "template.fullname" -}} +{{- if .Values.fullnameOverride }} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- $name := default .Chart.Name .Values.nameOverride }} +{{- if contains $name .Release.Name }} +{{- .Release.Name | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} +{{- end }} +{{- end }} +{{- end }} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "template.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "template.labels" -}} +helm.sh/chart: {{ include "template.chart" . }} +{{ include "template.selectorLabels" . }} +{{- if or .Chart.AppVersion .Values.image.tag }} +app.kubernetes.io/version: {{ .Values.image.tag | default .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "template.selectorLabels" -}} +app.kubernetes.io/name: {{ include "template.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "template.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "template.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} + +{{- /* +template.util.merge will merge two YAML templates and output the result. +This takes an array of three values: +- the top context +- the template name of the overrides (destination) +- the template name of the base (source) +*/}} +{{- define "template.util.merge" -}} +{{- $top := first . -}} +{{- $overrides := fromYaml (include (index . 1) $top) | default (dict ) -}} +{{- $tpl := fromYaml (include (index . 2) $top) | default (dict ) -}} +{{- toYaml (merge $overrides $tpl) -}} +{{- end -}} diff --git a/helm/template/templates/_hpa.yaml b/helm/template/templates/_hpa.yaml new file mode 100644 index 0000000..745db5f --- /dev/null +++ b/helm/template/templates/_hpa.yaml @@ -0,0 +1,34 @@ +{{- define "template.hpa" -}} +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "template.fullname" . }} + labels: + {{- include "template.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "template.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} +{{- end }} diff --git a/helm/template/templates/_ingress.yaml b/helm/template/templates/_ingress.yaml new file mode 100644 index 0000000..313c582 --- /dev/null +++ b/helm/template/templates/_ingress.yaml @@ -0,0 +1,47 @@ +{{- define "template.ingress" -}} +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "template.fullname" . -}} +{{- $svcPort := .Values.service.port -}} +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: {{ $fullName }} + labels: + {{- include "template.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- if .Values.ingress.className }} + ingressClassName: {{ .Values.ingress.className }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + {{- if and .pathType }} + pathType: {{ .pathType }} + {{- end }} + backend: + service: + name: {{ $fullName }} + port: + number: {{ $svcPort }} + {{- end }} + {{- end }} +{{- end }} +{{- end }} diff --git a/helm/template/templates/_secret.yaml b/helm/template/templates/_secret.yaml new file mode 100644 index 0000000..0a8246e --- /dev/null +++ b/helm/template/templates/_secret.yaml @@ -0,0 +1,14 @@ +{{- define "template.secret" -}} +{{- if .Values.secrets }} +apiVersion: v1 +kind: Secret +metadata: + name: {{ include "template.fullname" . }} + labels: + {{- include "template.labels" . | nindent 4 }} +stringData: + {{- with .Values.secrets }} + {{- toYaml . | nindent 2 }} + {{- end}} +{{- end }} +{{- end }} diff --git a/helm/template/templates/_service.yaml b/helm/template/templates/_service.yaml new file mode 100644 index 0000000..efa077b --- /dev/null +++ b/helm/template/templates/_service.yaml @@ -0,0 +1,23 @@ +{{- define "template.service" -}} +apiVersion: v1 +kind: Service +metadata: + name: {{ include "template.fullname" . }} + labels: + {{- include "template.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - name: http + protocol: TCP + port: {{ .Values.service.port }} + targetPort: http + {{- if .Values.application.isSpring }} + - name: http-actuator + protocol: TCP + port: {{ .Values.service.actuatorPort }} + targetPort: http-actuator + {{- end }} + selector: + {{- include "template.selectorLabels" . | nindent 4 }} +{{- end }} diff --git a/helm/template/templates/_serviceaccount.yaml b/helm/template/templates/_serviceaccount.yaml new file mode 100644 index 0000000..16a7d6b --- /dev/null +++ b/helm/template/templates/_serviceaccount.yaml @@ -0,0 +1,14 @@ +{{- define "template.serviceAccount" -}} +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "template.serviceAccountName" . }} + labels: + {{- include "template.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} +{{- end }}