Aller au contenu

Documentation d'infrastructure ADEME

Documentation technique à destination de l'équipe infogérance. Elle couvre les services mutualisés, les procédures opérationnelles et les choix d'architecture du cluster Kubernetes ADEME.

Contribuer

Mise en place

# Créer et activer un environnement virtuel
python3 -m venv .venv
source .venv/bin/activate

# Installer les dépendances
pip install -r requirements.txt

# Activer les hooks pre-commit
pre-commit install

# Lancer le serveur local
mkdocs serve

La documentation est ensuite accessible sur http://127.0.0.1:8000. Toute modification des fichiers .md est rechargée automatiquement.

Workflow

# 1. Créer une branche depuis main
git checkout main && git pull
git checkout -b docs/ma-modification

# 2. Faire les modifications, puis vérifier avant de commiter
mkdocs build --strict        # simule le job CI
pre-commit run --all-files   # vérifie les secrets

# 3. Commiter et pousser
git add .
git commit -m "docs: description de la modification"
git push origin docs/ma-modification

Puis ouvrir une Merge Request vers main sur GitLab. La MR doit :

  • Passer le job CI validate (mkdocs build --strict)
  • Être approuvée par au moins une personne
  • Ne pas avoir de push direct sur main

Sécurité

Ce repo utilise gitleaks via pre-commit pour détecter les secrets accidentels (tokens, clés API, mots de passe) avant chaque commit.

# Installer pre-commit (une fois)
pip install pre-commit

# Activer le hook dans le repo
pre-commit install

Le hook s'exécute ensuite automatiquement à chaque git commit. Pour lancer une vérification manuelle :

# Sur les fichiers stagés uniquement
pre-commit run gitleaks

# Sur l'ensemble du repo
pre-commit run gitleaks --all-files

Historique git

Le hook ne protège que les nouveaux commits. Pour scanner l'historique existant : 

gitleaks detect --source . --log-opts="HEAD"