50 Helm Template Cheatsheets

Basic Template Functions: link

1. Access a Value from values.yaml:

     replicas: {{ .Values.replicaCount }}
     

2. Access Release Information:

     releaseName: {{ .Release.Name }}
   releaseNamespace: {{ .Release.Namespace }}
     

3. Access Chart Information:

     chartName: {{ .Chart.Name }}
   chartVersion: {{ .Chart.Version }}
     

4. Port Configuration:

     containerPort: {{ .Values.containerPort }}
     

Conditional Blocks: link

5. Conditional Rendering:

     {{- if .Values.enableFeature }}
   featureEnabled: true
   {{- end }}
     

6. Conditional Rendering with Else Block:

     {{- if .Values.enableFeature }}
   featureEnabled: true
   {{- else }}
   featureEnabled: false
   {{- end }}
     

Loops: link

7. Loop Over a List:

     {{- range .Values.ingress.hosts }}
   - host: {{ . }}
   {{- end }}
     

8. Loop Over a Map:

     {{- range $key, $value := .Values.labels }}
   {{ $key }}: {{ $value }}
   {{- end }}
     

Accessing Values: link

9. Access Nested Values:

     username: {{ .Values.database.credentials.username }}
     

10. Quoting a Value:

      message: {{ .Values.message | quote }}
      

Including Partial Templates: link

11. Include a Partial Template:

      {{- include "partials.common" . | indent 2 }}
      

Template Functions: link

12. Convert to YAML:

      {{- toYaml .Values.config | nindent 4 }}
      

13. Convert to JSON:

      jsonData: {{ toJson .Values.data }}
      

14. Using Sprig Functions:

      password: {{ randAlphaNum 10 | quote }}
      

Helm Hook Templates: link

15. Pre-install Hook:

      {{- if .Values.preInstallJob }}
    # pre-install job definition
    {{- end }}
      

16. Post-install Hook:

      {{- if .Values.postInstallJob }}
    # post-install job definition
    {{- end }}
      

Advanced Examples: link

17. Creating a Kubernetes Secret:

      apiVersion: v1
    kind: Secret
    metadata:
      name: {{ .Release.Name }}-secret
    type: Opaque
    data:
      password: {{ .Values.secret.password | b64enc }}
      

18. Creating a Service:

      apiVersion: v1
    kind: Service
    metadata:
      name: {{ include "mychart.fullname" . }}
      

19. Defining a ConfigMap:

      apiVersion: v1
    kind: ConfigMap
    metadata:
      name: {{ include "mychart.fullname" . }}
    data:
      config.yaml: |
        {{ .Files.Get "config.yaml" | indent 4 }}
      

20. Creating an Ingress:

      apiVersion: networking.k8s.io/v1
    kind: Ingress
    metadata:
      name: {{ include "mychart.fullname" . }}
    spec:
      rules:
        - host: {{ .Values.ingress.host }}
      

21. Defining a PersistentVolumeClaim:

      apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: {{ include "mychart.fullname" . }}-data
      

22. Setting Resource Limits:

      resources:
      limits:
        cpu: {{ .Values.resources.cpu | quote }}
        memory: {{ .Values.resources.memory | quote }}
      

23. Creating a Job:

      apiVersion: batch/v1
    kind: Job
    metadata:
      name: {{ .Release.Name }}-job
    spec:
      template:
        spec:
          containers:
          - name: {{ .Chart.Name }}-job
            image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
            command: ["{{ .Values.command }}"]
      

24. Creating a CronJob:

      apiVersion: batch/v1beta1
    kind: CronJob
    metadata:
      name: {{ .Release.Name }}-cronjob
    spec:
      schedule: "*/1 * * * *"
      jobTemplate:
        spec:
          template:
            spec:
              containers:
              - name: {{ .Chart.Name }}-cronjob
                image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
                command: ["{{ .Values.command }}"]
      

25. Creating a StatefulSet:

      apiVersion: apps/v1
    kind: StatefulSet
    metadata:
      name: {{ .Release.Name }}-statefulset
      

26. Creating a Deployment with Liveness and Readiness Probes:

      apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: {{ .Release.Name }}-deployment
    spec:
      template:
        spec:
          containers:
          - name: {{ .Chart.Name }}-container
            image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
            livenessProbe:
              httpGet:
                path: /healthz
                port: 80
              initialDelaySeconds: 30
            readinessProbe:
              httpGet:
                path: /readyz
                port: 80
              initialDelaySeconds: 5
      

27. Creating a Horizontal Pod Autoscaler (HPA):

      apiVersion: autoscaling/v2beta2
    kind: HorizontalPodAutoscaler
    metadata:
      name: {{ .Release.Name }}-hpa
    spec:
      scaleTargetRef:
        apiVersion: apps/v1
        kind: Deployment
        name: {{ .Release.Name }}-deployment
      minReplicas: 1
      maxReplicas: 10
      metrics:
      - type: Resource
        resource:
          name: cpu
          targetAverageUtilization: 50
      

Accessing Values: link

28. Accessing Values from Dependencies:

      dependencyValue: {{ .Values.dependencies.subchart.value }}
      

29. Accessing Values with Default:

      port: {{ .Values.port | default 8080 }}
      

Advanced Conditional Blocks: link

30. Conditional Block with Nested Conditions:

      {{- if and .Values.condition1 .Values.condition2 }}
    # Block content
    {{- end }}
      

31. Conditional Block with OR Operator:

      {{- if or .Values.condition1 .Values.condition2 }}
    # Block content
    {{- end }}
      

Advanced Loops: link

32. Loop with Index:

      {{- range $index, $element := .Values.list }}
    - index: {{ $index }}, value: {{ $element }}
    {{- end }}
      

33. Loop with Sorting:

      {{- range sort .Values.list }}
    - value: {{ . }}
    {{- end }}
      

Advanced Template Functions: link

34. Using tpl Function for Advanced Template Rendering:

      renderedTemplate: {{ tpl (.Files.Get "template.yaml") . | indent 4 }}
      

35. Using include with Dynamic Name:

      {{- include (printf "%s-config" .Values.serviceName) . | indent 2 }}
      

External Template Files: link

36. Including External Template File:

      {{- include "external-template.tpl" . | indent 2 }}
      

Debugging: link

37. Printing Values for Debugging:

      {{- printf "%#v" .Values | nindent 2 }}
      

Naming Conventions: link

38. Using Release Name and Chart Name for Naming Resources:

      metadata:
      name: {{ .Release.Name }}-{{ .Chart.Name }}
      

Comments: link

39. Adding Comments in Templates:

      # This is a comment
      

External Resources: link

40. Mounting External Files as ConfigMaps:

      apiVersion: v1
    kind: ConfigMap
    metadata:
      name: my-configmap
    data:
      {{ .Files.Get "config-file.yaml" | indent 2 }}
      

Combining Functions: link

41. Combining Functions for Complex Operations:

      combinedValue: {{ trimPrefix "prefix-" (upper .Values.value) }}
      

Advanced StatefulSet Configuration: link

42. StatefulSet with Persistent Volume Claim:

      volumeClaimTemplates:
      - metadata:
          name: data
        spec:
          accessModes: [ "ReadWriteOnce" ]
          resources:
            requests:
              storage: 1Gi
      

External Secrets: link

43. Referencing External Secrets:

      apiVersion: v1
    kind: Secret
    metadata:
      name: my-secret
      annotations:
        "helm.sh/resource-policy": keep
    type: Opaque
    data:
      password: {{ .Values.externalSecret.password | b64enc }}
      

Helm Release Specifics: link

44. Accessing Release Timestamp:

      releaseDate: {{ .Release.Timestamp }}
      

Debugging with printf: link

45. Debugging with printf:

      {{ printf "%#v" .Values | nindent 2 }}
      

Using quote and unquote Functions: link

46. Quoting and Unquoting Values:

      quotedValue: {{ .Values.someValue | quote }}
    unquotedValue: {{ .Values.quotedValue | unquote }}
      

Advanced Resource Definitions: link

47. Advanced Pod Annotations:

      annotations:
      myAnnotation: {{ .Values.annotations.myAnnotation | quote }}
      

Configurable Labels: link

48. Configurable Labels:

      labels:
      myLabel: {{ .Values.labels.myLabel | quote }}
      

Conditional Pod Disruption Budget: link

49. Conditional Pod Disruption Budget:

      {{- if .Values.enablePodDisruptionBudget }}
    apiVersion: policy/v1beta1
    kind: PodDisruptionBudget
    metadata:
      name: {{ include "mychart.fullname" . }}
    spec:
      # PDB specification
    {{- end }}
      

Helm Template Debugging: link

50. Template Debugging with required Function:

      requiredValue: {{ required "Value is required" .Values.requiredValue }}
      

Multiple pipelines: link

51. Manipulate value with multiple pipelines:

      domain: {{ .Values.domain | lower | trunc 9 | quote}}