Aller au contenu principal

ggscout pour les installations self-hosted

Le déploiement GitGuardian Self-Hosted est fourni avec un Helm chart prêt à l'emploi que vous pouvez utiliser pour déployer ggscout aux côtés de votre instance Self-Hosted. La procédure suivante vous aidera à déployer et configurer ggscout.

Aucun secret ne sort de votre environnement !

Les valeurs des secrets ne quitteront jamais votre environnement en clair !

Les valeurs des secrets sont hachées à l'aide de l'algorithme de hachage HMSL avant d'être envoyées à votre instance GitGuardian self-hosted. D'autres métadonnées non sensibles comme les noms des secrets, les chemins dans le vault, la date de création, la durée du bail, etc. sont également collectées pour vous aider dans le processus de remédiation.

Consultez les instructions sur la façon d'exécuter ggscout en mode audit pour examiner ce qui est envoyé à GitGuardian.

ggscout fonctionne également en mode Airgap. Suivez la documentation Airgap pour vous assurer que toutes les images nécessaires sont disponibles dans votre registre privé.

Installation basée sur Helm​

  1. Créez un Service Account Token dans GitGuardian

    Naviguez vers Settings > Service accounts et générez un token avec les permissions NHI. Scout SAT

  2. Créez un secret Kubernetes pour stocker le SAT GitGuardian et le token d'authentification de vos sources (par exemple le token Hashicorp Vault, ...)

    Pour créer ou mettre à jour les secrets, vous utilisez directement l'API Kubernetes Secrets. Créez secrets.yaml avec le contenu suivant (en remplaçant les valeurs par vos secrets) :

    apiVersion: v1
    kind: Secret
    metadata:
    name: gitguardian-ggscout-secrets
    stringData:
    GITGUARDIAN_API_KEY: "my_gitguardian_api_key"
    HASHICORP_VAULT_TOKEN: "my_vault_token"

    Pour appliquer les secrets à votre cluster/namespace, exécutez la commande suivante : kubectl apply -f secrets.yaml -n <namespace>

  3. Configurez ggscout dans le fichier de valeurs Helm Self-Hosted

    ggscout est un sous-chart du chart GitGuardian Self-Hosted. Toute la configuration de ggscout se fait sous ggscout. Suivez la documentation sur https://github.com/GitGuardian/ggscout-helm-charts.

    L'endpoint GitGuardian est automatiquement calculé en fonction de votre instance actuelle, mais vous pouvez l'exécuter dans un namespace différent et spécifier l'endpoint GitGuardian. Mettez à jour votre fichier de valeurs Helm avec les étapes de configuration suivantes :

    Utilisez les exemples fournis dans le dépôt GitHub Scout.

    Si vous déployez sur un cluster OpenShift, consultez l'installation OpenShift.

    Exemple avec Hashicorp Vault :

    ggscout:
    enabled: true # to activate the ggscout sub-chart
    inventory:
    config:
    sources:
    hashicorpvault: # example of Hashicorp vault secrets collector
    type: hashicorpvault
    vault_address: https://vault.example.com # Replace with the actual Vault address
    auth:
    auth_mode: "token"
    token: "${HASHICORP_VAULT_TOKEN}"
    fetch_all_versions: false # Fetch all versions of secrets or not
    gitguardian: # Pushes the inventory to the GitGuardian workspace. If the endpoint is empty, it will not push the inventory details.
    endpoint: 'https://<GitGuardian-url>/exposed/v1' # optional; if not specified, the current self-hosted GitGuardian instance URL will be used
    api_token: "${GITGUARDIAN_API_KEY}"
    check: # Validity and permissions checks against each secret's provider. On by default, see /ggscout-docs/configure-ggscout#configure-validity-checks
    enabled: true
    jobs:
    # Job to fetch defined sources
    fetch:
    enabled: true
    schedule: '*/15 * * * *'
    send: true # send hashed secrets to GitGuardian
    # Job to be able to sync/write secrets from GitGuardian into you vault
    sync:
    enabled: true
    schedule: '* * * * *'
    envFrom:
    - secretRef:
    name: gitguardian-ggscout-secrets
  4. Utilisez la commande helm upgrade et spécifiez la même version que celle actuellement installée pour éviter les mises à jour indésirables vers la dernière version.

    Pour trouver le nom de la release et la version actuellement installée, utilisez helm ls :

    helm ls
    NAME UPDATED STATUS CHART APP VERSION
    <release-name> 2025-03-20 12:40 deployed gitguardian-2025.3.0 2025.3.0

    Ici, la version installée est 2025.3.0. Pour installer ggscout, vous exécuteriez la commande suivante, en utilisant la version installée dans votre environnement :

    helm upgrade <release-name> -n <namespace> oci://registry.replicated.com/gitguardian/gitguardian --version 2025.3.0 -f local-values.yaml

    Remplacez <release-name> par le nom utilisé lors de l'installation initiale. Si nécessaire, spécifiez le namespace Kubernetes avec -n (le namespace par défaut est utilisé s'il n'est pas spécifié).

Installation basée sur KOTS​

  1. Créez un Service Account Token dans GitGuardian

    Naviguez vers Settings > Service accounts et générez un token avec les permissions NHI. Scout SAT

  2. Activez et configurez ggscout dans la KOTS Admin Console.

    Actuellement, la seule source disponible est HashiCorp Vault. Si vous souhaitez configurer d'autres sources, veuillez contacter support@gitguardian.com.

    Scout KOTS Configuration