Aller au contenu

Operations

Objectif

Ce document décrit les opérations courantes permettant d'administrer le homelab.


Vérifier l'état du système

Exécuter :

./scripts/doctor.sh

Le diagnostic vérifie :

  • Docker
  • Docker Compose
  • Réseau Docker
  • Fichiers Compose
  • Variables d'environnement
  • Conteneurs
  • Healthchecks

Le résultat attendu est :

OK    : XX
WARN  : 0
FAIL  : 0

[ OK ] Homelab en bonne santé.

Démarrer tous les services

./scripts/start-all.sh

Les services sont démarrés dans l'ordre défini par le framework.


Arrêter tous les services

./scripts/stop-all.sh

Les services sont arrêtés proprement.


Redémarrer tous les services

./scripts/restart-all.sh

Équivalent à :

stop-all
↓
start-all

Déployer un seul service

Exemple :

./scripts/deploy.sh homepage

Ou :

./scripts/deploy.sh vaultwarden

Seul le service demandé est redéployé.


Consulter l'état des services

./scripts/status-all.sh

Permet de vérifier rapidement quels services sont actifs.


Sauvegarder le homelab

Créer une sauvegarde :

./scripts/backup.sh

Les sauvegardes sont stockées dans :

/opt/homelab/backups

Restaurer une sauvegarde

Lister les sauvegardes disponibles :

ls -lh backups/

Puis restaurer :

./scripts/restore.sh backups/homelab-YYYYMMDD-HHMMSS.tar.gz

Ajouter un nouveau service

Créer la structure :

./scripts/create-service.sh nom-du-service

Compléter ensuite :

  • compose.yaml
  • .env
  • documentation

Enfin démarrer :

./scripts/deploy.sh nom-du-service

Après une modification

Après toute modification importante :

./scripts/doctor.sh

Le diagnostic doit être entièrement valide avant de considérer l'opération terminée.


Bonnes pratiques

  • Toujours vérifier le système avec doctor.sh avant une intervention importante.
  • Sauvegarder avant une mise à jour majeure.
  • Déployer un seul service lorsque cela est possible.
  • Utiliser start-all.sh uniquement après un redémarrage complet ou une reconstruction.
  • Conserver le framework et les services synchronisés dans le dépôt Git.