Kafka: 2. O script de ciclo de vida
Esta documentação faz parte do guia GitHub Actions & GitLab CI. Consulte o guia completo aqui: Inicie um serviço real de Kafka a partir do seu pipeline do GitHub Actions ou GitLab CI, execute os seus testes sobre ele e elimine-o automaticamente.
👋 Bem-vindo à documentação da Stackhero!
A Stackhero oferece-lhe um ambiente Kafka cloud totalmente gerido, pronto em poucos minutos. Eis o que pode esperar:
- Sem limites no tamanho ou transferência de mensagens: escale os seus dados sem preocupações com restrições.
- Atualizações simples, com um clique, mantêm a sua plataforma atualizada sem interrupções ou trabalho manual.
- Desempenho elevado e segurança robusta de forma consistente, na sua própria infraestrutura privada e dedicada.
Se pretende acelerar processos e reduzir a carga operacional, a Stackhero disponibiliza alojamento Kafka cloud para o ajudar. Pode ter um cluster pronto para produção em cerca de 5 minutos.
Segue-se um exemplo completo de script que gere todo o ciclo de vida do serviço. Demonstra como a configuração é simples, bastando apenas alguns comandos. Pode copiar o YAML pronto para a sua plataforma nas secções abaixo.
#!/bin/bash
set -euo pipefail
# STACKHERO_TOKEN é fornecido pelo segredo CI, o CLI deteta-o automaticamente.
stackName="ci-kafka-$$" # Nome único da stack para cada execução
serviceStore="kafka" # O serviço store de Kafka
instance="10G" # Altere se necessário (ver passo 3)
region="europe" # Nome da região (ver stackhero regions-list)
# 1. Instalar o CLI no runner
curl -fsSL https://www.stackhero.io/install.sh | sh
# 2. Instalar o cliente necessário para o smoke test (jq + curl são o mínimo)
apt-get update && apt-get install -y --no-install-recommends jq curl netcat-openbsd
# 3. Criar uma stack dedicada para esta execução
stackId=$(stackhero --format=script stack-create --name="$stackName")
echo "Stack criada: $stackId"
# 4. Adicionar Kafka e obter o id do serviço
serviceId=$(stackhero --format=script service-add \
--stack="$stackId" \
--service-store="$serviceStore" \
--instance="$instance" \
--region="$region")
echo "Serviço adicionado: $serviceId"
# 5. Esperar até o serviço estar operacional (pode demorar alguns minutos)
stackhero service-wait-for --service="$serviceId"
# 6. Ler a configuração (contém as credenciais geradas)
config=$(stackhero service-configuration-get --service="$serviceId" --format=json)
# 7. Extrair as credenciais necessárias
host=$(echo "$config" | jq -r '.configuration.domain')
# 8. Smoke test: Open a TCP connection to the broker port.
nc -z -w 5 "$host" 9092
echo "✅ Kafka está acessível a partir do CI."
O passo de teardown, que elimina o serviço, aguarda a sua remoção e depois elimina a stack, é detalhado nas secções específicas de cada plataforma abaixo. Este método garante que a limpeza é sempre realizada, mesmo que um smoke test falhe.
Uma stack só pode ser eliminada quando estiver vazia. Elimine sempre o serviço primeiro e aguarde a sua remoção, depois elimine a stack. O comando
service-wait-forgarante que o serviço está em execução ou já foi eliminado antes de prosseguir, sendo a ferramenta adequada também para aguardar pela eliminação.