Installer sur un cluster Embedded

Introduction

⚠️ Notez que les installations embedded ne sont pas recommandées pour la production et conviennent davantage à un essai ou un Proof of Concept (PoC). Plus d'informations ici.

GitGuardian peut être installé avec une distribution Kubernetes embedded packagée avec lui ; il prend en charge le déploiement sur bare metal, cloud privé ou public.

Prérequis

Infrastructure requise

1. Machine virtuelle Linux : voir les prérequis système pour les spécifications matérielles et OS détaillées.

   Exemples d'instances VM répondant aux prérequis minimaux :

   • AWS : m7a.2xlarge (8 vCPU, 32 Gio de RAM)
   • GCP : n2-standard-8 (8 vCPU, 32 Go de RAM)
   • Azure : Standard_D8s_v5 (8 vCPU, 32 Gio de RAM)

Prérequis supplémentaires

2. Fichier de licence : téléchargez votre licence GitGuardian depuis le portail. Voir Gestion de la licence.

3. Accès réseau : assurez-vous que votre cluster respecte les prérequis réseau.

4. Nom de domaine : un Fully Qualified Domain Name (FQDN) pour accéder à l'application. Voir les prérequis système.

Prérequis

Examinez les prérequis système et réseau complets avant de continuer.

Installation

Cluster embedded

Contactez l'équipe GitGuardian à support@gitguardian.com pour obtenir votre identifiant de licence. La licence est intégrée directement dans le bundle d'installation, éliminant le besoin de télécharger un fichier de licence séparé.

Pour lancer l'installation, exécutez les commandes suivantes sur votre système hôte. L'installation prend environ 5 minutes. Pensez à utiliser un terminal multiplexer comme screen ou tmux pour éviter une interruption due à une perte de connexion. Remplacez your_license par l'identifiant de licence fourni par l'équipe GitGuardian.

LICENSE_ID=your_license
curl -f "https://replicated.app/embedded/gitguardian/stable" -H "Authorization: $LICENSE_ID" -o gitguardian.tgz
tar -xvzf gitguardian.tgz
sudo ./gitguardian install --license license.yaml

info

Airgap

Pour utiliser en mode airgap, utilisez plutôt :

LICENSE_ID=your_license
curl -f https://replicated.app/embedded/gitguardian/stable?airgap=true -H "Authorization: $LICENSE_ID" -o gitguardian.tgz
tar -xvzf gitguardian.tgz
sudo ./gitguardian install --license license.yaml --airgap-bundle gitguardian.airgap

Proxy HTTP

Pour utiliser un proxy HTTP, utilisez plutôt :

LICENSE_ID=your_license
curl -f https://replicated.app/embedded/gitguardian/stable -H "Authorization: $LICENSE_ID" -o gitguardian.tgz
tar -xvzf gitguardian.tgz
sudo ./gitguardian install --license license.yaml \
  --http-proxy http://proxy.example.com:8080 \
  --https-proxy http://proxy.example.com:8080

Pour les proxys avec authentification, incluez les identifiants dans l'URL :

sudo ./gitguardian install --license license.yaml \
  --http-proxy http://username:password@proxy.example.com:8080 \
  --https-proxy http://username:password@proxy.example.com:8080

Pour des instructions détaillées sur la configuration du proxy, y compris le dépannage des proxys authentifiés, consultez la documentation Proxy HTTP.

Vous serez invité à saisir le mot de passe de la console d'administration. Ce mot de passe sert à gérer l'application GitGuardian et est différent du mot de passe du tableau de bord GitGuardian que vous configurerez plus tard.

Si plusieurs interfaces réseau vous sont proposées, choisissez celle connectée à votre réseau privé.

Cela installera un cluster Kubernetes géré sur un seul nœud avec tout ce dont il a besoin pour exécuter l'application GitGuardian.

Une fois l'installation terminée, des instructions s'afficheront pour accéder à la console d'administration.

remarque

Le namespace de déploiement pour KOTS (et GitGuardian) ne peut pas être modifié pour le moment.

Application

Avec le cluster Kubernetes embedded désormais en place, passons à l'installation de l'application GitGuardian.

1. Accédez à la console d'administration via le lien fourni et configurez TLS. Vous pouvez téléverser vos certificats TLS ou en utiliser des auto-signés.

2. Saisissez le mot de passe fourni à la fin de l'installation du cluster.

3. Vous pouvez voir l'état du cluster (avec un nœud actuellement). Cliquez ensuite sur Continuer.

4. Configurez l'application en remplissant tous les champs obligatoires :

   • Application Hostname : saisissez le Fully Qualified Domain Name (FQDN) de l'application GitGuardian.
   • Champs administrateur : ces champs servent à créer le premier utilisateur GitGuardian. Vous devrez changer le mot de passe lors de la première connexion.

Les options de configuration supplémentaires incluent :

• Scaling : ajustez le nombre de réplicas pour chaque composant. Voir la page Scaling.
• Prometheus : activez un exporter pour Prometheus.
• Certificat TLS : pour l'application GitGuardian. Vous pouvez utiliser des certificats auto-signés générés automatiquement ou téléverser les vôtres. Pour les certificats auto-signés ou de CA privée, désactivez la vérification SSL pour le webhook GitHub. En savoir plus sur la page Configurer les certificats TLS.
• Custom Certificate Authority : fournissez une CA personnalisée si nécessaire.
• Proxy HTTP(S) : référez-vous à la section proxy si nécessaire.
• Bases/datastores : choisissez entre PostgreSQL/Redis embedded ou externes. Pour plus d'informations, voir Configurer votre base de données.
• Considérations sur le load balancer : pour utiliser le cluster embedded derrière un load balancer, lisez Configurer votre instance derrière un load balancer.

5. Vérifiez que les preflight checks passent.

Prérequis

Les preflight checks sont essentiels pour une installation réussie. Les règles suivantes s'appliquent :

• ❌ Échec des preflight checks : si les preflight checks échouent, l'installation ne doit pas continuer tant que l'environnement cible ne satisfait pas tous les prérequis. Contactez notre équipe support si nécessaire.
• ⚠️ Avertissements des preflight checks : si les preflight checks renvoient des avertissements, l'installation peut continuer, mais il est recommandé de les traiter pour respecter nos recommandations.

6. Lancez

La première installation de l'application GitGuardian nécessite quelques minutes pour créer tous les objets de base de données. Une fois le processus terminé, vous pourrez vous connecter au tableau de bord avec l'utilisateur administrateur que vous avez défini.

Conserver la clé de chiffrement des données

attention

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

Vous devriez la sauvegarder et la conserver dans un emplacement sûr. Utilisez la commande suivante pour afficher la clé :

sudo ./gitguardian shell
kubectl get secrets gim-secrets -o jsonpath='{.data.DJANGO_SECRET_KEY}' | base64 -d

Dépannage

Si vous rencontrez des problèmes durant l'installation, vous pouvez générer un support bundle pour permettre à l'équipe GitGuardian de diagnostiquer et résoudre les problèmes plus efficacement. Consultez la documentation du support bundle pour des instructions détaillées.

Prochaines étapes

Après une installation réussie :

• Accédez à votre instance GitGuardian via le hostname configuré
• Connectez-vous avec les identifiants administrateur que vous avez définis (changez le mot de passe temporaire à la première connexion)
• Configurez les paramètres d'e-mail pour les notifications
• Mettez en place l'intégration SSO et SCIM (optionnel)
• Intégrez vos premiers dépôts pour démarrer la détection des secrets