Kafka: 2. Le script de cycle de vie

Cette documentation fait partie du guide GitHub Actions & GitLab CI. Consultez le guide complet ici : Lancez un vrai service Kafka à partir de votre pipeline GitHub Actions ou GitLab CI, exécutez vos tests dessus, puis supprimez-le automatiquement.

👋 Bienvenue dans la documentation Stackhero !

Stackhero vous propose un environnement Kafka cloud entièrement géré, prêt en quelques minutes. Voici ce que vous pouvez attendre :

• Aucune limite sur la taille ou le transfert des messages : faites évoluer vos données sans vous soucier des plafonds.
• Mises à jour simples, en un clic pour garder votre plateforme à jour sans interruption ni intervention manuelle.
• Performance élevée constante et sécurité renforcée sur votre propre infrastructure privée et dédiée.

Si vous souhaitez accélérer vos projets et réduire la charge opérationnelle, Stackhero propose l'hébergement Kafka cloud pour vous accompagner. Vous pouvez disposer d'un cluster prêt pour la production en environ 5 minutes.

Voici un exemple complet de script qui gère tout le cycle de vie du service. Il montre à quel point la configuration est simple, avec seulement quelques commandes. Vous pouvez copier le YAML prêt à l'emploi pour votre plateforme dans les sections ci-dessous.

#!/bin/bash
set -euo pipefail

# STACKHERO_TOKEN est fourni par le secret CI, le CLI le détecte automatiquement.

stackName="ci-kafka-$$"          # Nom de stack unique pour chaque exécution
serviceStore="kafka"             # Le store du service Kafka
instance="10G"        # Modifiez si besoin (voir étape 3)
region="europe"                         # Nom de la région (voir stackhero regions-list)

# 1. Installer le CLI sur le runner
curl -fsSL https://www.stackhero.io/install.sh | sh

# 2. Installer le client nécessaire pour le smoke test (jq + curl sont la base)
apt-get update && apt-get install -y --no-install-recommends jq curl netcat-openbsd

# 3. Créer une stack dédiée pour cette exécution
stackId=$(stackhero --format=script stack-create --name="$stackName")
echo "Stack créée : $stackId"

# 4. Ajouter Kafka et récupérer son service id
serviceId=$(stackhero --format=script service-add \
  --stack="$stackId" \
  --service-store="$serviceStore" \
  --instance="$instance" \
  --region="$region")
echo "Service ajouté : $serviceId"

# 5. Attendre que le service soit opérationnel (cela peut prendre quelques minutes)
stackhero service-wait-for --service="$serviceId"

# 6. Lire la configuration (contient les identifiants générés)
config=$(stackhero service-configuration-get --service="$serviceId" --format=json)

# 7. Extraire les identifiants nécessaires
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 accessible depuis la CI."

L'étape de suppression, qui efface le service, attend sa suppression puis supprime la stack, est détaillée dans les sections spécifiques à chaque plateforme ci-dessous. Cette méthode garantit que le nettoyage est toujours effectué, même si un smoke test échoue.

Une stack ne peut être supprimée que si elle est vide. Supprimez toujours le service en premier et attendez sa suppression, puis supprimez la stack. La commande service-wait-for garantit que le service est bien en cours d'exécution ou supprimé avant de continuer, c'est donc l'outil adapté pour attendre la suppression.