Backup & Restore

attention

GitGuardian chiffre toutes les informations sensibles dans la base à l'aide d'une clé de chiffrement des données (aussi appelée Django Secret Key). En cas de sinistre, cette clé sera essentielle pour restaurer vos données.

Quelle que soit la méthode d'installation (KOTS ou Helm), veillez à ce que la clé de chiffrement soit stockée en toute sécurité et accessible.

Utilisez la commande suivante pour afficher la clé :

kubectl get secrets gim-secrets --namespace=<namespace> -o jsonpath='{.data.DJANGO_SECRET_KEY}' | base64 -d

Sauvegarde

Pour sauvegarder entièrement l'application GitGuardian, vous devez :

• Sauvegarder la base PostgreSQL (⚠️ et la clé de chiffrement des données).
• Sauvegarder la config KOTS (pour les installations KOTS sur cluster existant).
• Sauvegarder le fichier de values Helm (pour les installations Helm sur cluster existant).

Nous recommandons fortement d'utiliser des bases et data stores externes managés, ainsi qu'une stratégie robuste de snapshots et de sauvegardes. Une installation cluster embedded avec une base PostgreSQL embedded n'est pas recommandée pour les déploiements en production et est destinée uniquement à des fins PoC/test. Pour plus d'informations, consultez la page Choisir votre méthode d'installation.

Installation via Helm

Veillez à sauvegarder le fichier de values que vous avez créé durant l'installation.

Installation via KOTS

Pour sauvegarder les fichiers de config KOTS, utilisez :

kubectl kots get config \
    --namespace gitguardian \
    --decrypt \
    --appslug gitguardian > config.yaml

attention

La configuration de sauvegarde contient des secrets. Veillez à ce qu'elle soit stockée en toute sécurité et que l'accès soit strictement contrôlé.

Si nécessaire, précisez le namespace Kubernetes avec --namespace (le namespace par défaut est utilisé sinon).

KOTS offre un mécanisme pour simplifier les sauvegardes de votre application GitGuardian. Pour des informations détaillées sur la sauvegarde et la restauration, y compris la compatibilité de version Velero, consultez le site web Replicated.

Restauration

La restauration de l'instance GitGuardian dépend de la situation. Voulez-vous simplement revenir à une sauvegarde de base précédente ? Cherchez-vous à revenir à une version précédente de l'application ? Avez-vous perdu votre base et/ou cluster Kubernetes et avez besoin de restaurer l'application et la base depuis zéro ?

Restauration de base uniquement

Pour restaurer la base PostgreSQL, suivez ces étapes :

1. Arrêtez l'application.
2. Videz le cache Redis.
3. Restaurez la base PostgreSQL.
4. Redémarrez l'application.

Rollback de version applicative

danger

Ne faites pas de rollback ni de downgrade sans consulter notre équipe support d'abord. Certains scénarios peuvent nécessiter de restaurer la base depuis une sauvegarde pré-mise-à-niveau en raison de la complexité d'inverser certaines migrations de base.

Reprise après sinistre

Dans le cas où vous devez réinstaller l'application depuis zéro pour une reprise après sinistre, suivez la procédure d'installation appropriée selon votre configuration :

• KOTS cluster existant
• KOTS cluster embedded
• Helm

Installation via Helm

1. Utilisez votre fichier de values précédemment sauvegardé.
2. Veillez à spécifier la clé de chiffrement par :
   • Le paramètre inline miscEncryption.djangoSecretKey, ou
   • La référence à un secret existant via miscEncryption.existingSecret.

Installation via KOTS

1. Suivez la procédure d'installation pour votre configuration KOTS.
2. Configurez l'installation avec les paramètres essentiels.
3. Une fois l'installation terminée, restaurez les fichiers de configuration KOTS via la commande suivante :

   kubectl kots install gitguardian \
       --namespace gitguardian \
       --use-minimal-rbac \
       --shared-password <set_new_password> \
       --license-file license.yaml \
       --config-values config.yaml

   • Remplacez <set_new_password> par votre mot de passe souhaité (utilisé pour accéder à la console d'administration KOTS).
   • Ajustez le namespace si nécessaire.
   • Veillez à utiliser le fichier config.yaml de votre sauvegarde.
   • Cette commande doit être exécutée sur un namespace inexistant ou vide (c.-à-d. sans installation KOTS antérieure).
4. Dans la console d'administration KOTS, vérifiez que la configuration est correcte et déployez l'application.