Pular para o conteúdo principal

Capítulo 10.3 - Templates Avançados e Hooks

Objetivos de Aprendizagem​

Ao final deste capítulo, você será capaz de:

  • Utilizar funções avançadas dos templates Go
  • Implementar condições e loops
  • Utilizar os Hooks do Helm
  • Gerenciar dependências entre recursos
  • Criar templates reutilizáveis
  • Otimizar Charts

Introdução​

Os templates Helm permitem criar configurações Kubernetes dinâmicas e reutilizáveis. Os Hooks permitem executar ações em momentos específicos do ciclo de vida.

Funções Avançadas dos Templates​

Condições​

{{- if .Values.ingress.enabled }}
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: {{ .Release.Name }}-ingress
spec:
  ...
{{- end }}

Loops​

{{- range .Values.env }}
- name: {{ .name }}
  value: {{ .value }}
{{- end }}

Valores Padrão​

replicas: {{ .Values.replicaCount | default 3 }}
image: {{ .Values.image.repository | default "nginx" }}

Concatenação​

name: {{ printf "%s-%s" .Release.Name .Chart.Name }}

Include​

{{- include "my-chart.labels" . | nindent 4 }}

Hooks Helm​

Os Hooks permitem executar Jobs ou Pods em momentos específicos.

Tipos de Hooks​

  • pre-install: Antes da instalação
  • post-install: Após a instalação
  • pre-upgrade: Antes da atualização
  • post-upgrade: Após a atualização
  • pre-delete: Antes da exclusão
  • post-delete: Após a exclusão
  • pre-rollback: Antes do rollback
  • post-rollback: Após o rollback

Exemplo: Pre-install Hook​

apiVersion: batch/v1
kind: Job
metadata:
  name: {{ .Release.Name }}-pre-install
  annotations:
    "helm.sh/hook": pre-install
    "helm.sh/hook-weight": "-5"
    "helm.sh/hook-delete-policy": before-hook-creation
spec:
  template:
    spec:
      containers:
      - name: pre-install
        image: busybox:1.35
        command: ["/bin/sh", "-c", "echo 'Pre-install hook'"]
      restartPolicy: Never

Exemplo: Post-install Hook​

apiVersion: batch/v1
kind: Job
metadata:
  name: {{ .Release.Name }}-post-install
  annotations:
    "helm.sh/hook": post-install
    "helm.sh/hook-weight": "5"
spec:
  template:
    spec:
      containers:
      - name: post-install
        image: busybox:1.35
        command: ["/bin/sh", "-c", "echo 'Post-install hook'"]
      restartPolicy: Never

Anotações de Hooks​

hook-weight​

Controla a ordem de execução:

"helm.sh/hook-weight": "-5"  # Executado primeiro
"helm.sh/hook-weight": "5"   # Executado por último

hook-delete-policy​

Quando remover o Hook:

  • before-hook-creation: Antes da criação de um novo hook
  • hook-succeeded: Se o hook for bem-sucedido
  • hook-failed: Se o hook falhar
"helm.sh/hook-delete-policy": "before-hook-creation,hook-succeeded"

Exemplo Completo: Migração de Banco de Dados​

Pre-upgrade Hook: Backup​

apiVersion: batch/v1
kind: Job
metadata:
  name: {{ .Release.Name }}-pre-upgrade-backup
  annotations:
    "helm.sh/hook": pre-upgrade
    "helm.sh/hook-weight": "-10"
spec:
  template:
    spec:
      containers:
      - name: backup
        image: postgres:14
        command:
        - /bin/bash
        - -c
        - |
          pg_dump -h {{ .Release.Name }}-postgres mydb > /backup/backup-$(date +%Y%m%d).sql
          aws s3 cp /backup/backup-$(date +%Y%m%d).sql s3://backups/
        env:
        - name: PGPASSWORD
          valueFrom:
            secretKeyRef:
              name: {{ .Release.Name }}-postgres-secret
              key: password
        volumeMounts:
        - name: backup
          mountPath: /backup
      volumes:
      - name: backup
        emptyDir: {}
      restartPolicy: Never

Post-upgrade Hook: Migração​

apiVersion: batch/v1
kind: Job
metadata:
  name: {{ .Release.Name }}-post-upgrade-migrate
  annotations:
    "helm.sh/hook": post-upgrade
    "helm.sh/hook-weight": "10"
spec:
  template:
    spec:
      containers:
      - name: migrate
        image: my-app:{{ .Values.appVersion }}
        command: ["/app/migrate.sh"]
        env:
        - name: DATABASE_URL
          value: postgresql://postgres:5432/mydb
      restartPolicy: OnFailure

Templates Reutilizáveis​

_helpers.tpl Avançado​

{{/*
Labels comuns
*/}}
{{- define "my-chart.labels" -}}
app.kubernetes.io/name: {{ include "my-chart.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
{{- end }}

{{/*
Selector labels
*/}}
{{- define "my-chart.selectorLabels" -}}
app.kubernetes.io/name: {{ include "my-chart.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
{{- end }}

{{/*
Nome do Chart
*/}}
{{- define "my-chart.name" -}}
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
{{- end }}

{{/*
Nome completo
*/}}
{{- define "my-chart.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 }}

Boas Práticas​

1. Utilizar Helpers​

Crie helpers reutilizáveis no _helpers.tpl.

2. Condições Apropriadas​

Utilize condições para tornar os templates flexíveis.

3. Hooks com Critério​

Use hooks apenas quando necessário (migrações, backups).

4. Documentação​

Documente os hooks e seus objetivos.

5. Testes​

Teste os hooks com --dry-run.

Resumo​

Neste capítulo, você aprendeu:

Funções avançadas: Condições, loops, valores padrão, concatenação
Hooks: Pre/post install/upgrade/delete/rollback
Anotações: hook-weight, hook-delete-policy
Casos de uso: Migrações, backups, inicialização
Templates reutilizáveis: Helpers no _helpers.tpl
Boas práticas: Helpers, condições, hooks criteriosos, testes

Próximos Passos​

Módulo 11: Monitoramento e Observabilidade
Lab 10.4: Helmfile e Multiambientes

Capítulo criado em: Dezembro 2024