Installer avec Argo CD

Introduction

À l'aide du dépôt Helm GitGuardian, vous pouvez facilement installer GitGuardian sur votre cluster Kubernetes existant via Argo CD.

Prérequis

Avant de commencer l'installation, examinez les prérequis système et réseau.

Ajouter le dépôt Helm GitGuardian

Vous devez d'abord ajouter le dépôt Helm GitGuardian à Argo CD avec les paramètres suivants :

name: gitguardian
type: helm
enableOCI: 'true'
url: registry.replicated.com/gitguardian
username: <your.name@yourcompany.com>
password: <your.password>

L'équipe GitGuardian vous fournira le nom d'utilisateur et le mot de passe.

Vous pouvez suivre la documentation officielle et choisir parmi les méthodes suivantes :

1. Configuration déclarative

Créez le secret de dépôt Argo CD suivant via kubectl :

Vous devez définir le nom d'utilisateur et le mot de passe au préalable.

cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
  name: replicated-repo
  namespace: argocd
  labels:
    argocd.argoproj.io/secret-type: repository
stringData:
  name: replicated
  type: helm
  enableOCI: "true"
  url: registry.replicated.com
  username: <your.name@yourcompany.com>
  password: <your.password>
EOF

2. CLI Argo CD

Prérequis

Vous devez d'abord vous authentifier sur votre serveur Argo CD via la commande : argocd login <server_url>

Définissez votre nom d'utilisateur/mot de passe et exécutez cette commande :

argocd repo add registry.replicated.com \
  --name replicated \
  --type helm \
  --enable-oci \
  --username <your.name@yourcompany.com> \
  --password <your.password>

3. UI Argo CD

Naviguez vers Settings/Repositories et ajoutez le dépôt Helm GitGuardian :

Prérequis

Veillez à activer OCI

Une fois ajouté, vous devriez voir le dépôt Helm GitGuardian :

Le statut de connexion doit être successful.

Configurer l'application GitGuardian

Vous pouvez configurer l'application GitGuardian en fournissant des valeurs Helm personnalisées ; suivez les instructions Helm pour procéder.

Nous recommandons fortement de gérer les secrets vous-même et de les référencer via les paramètres Helm existingSecret (voir la page Helm Secrets Management). Nous suggérons également de consulter la page Argo CD Secret Management pour gérer efficacement vos secrets.

Créer le secret de chiffrement

Créez un secret Kubernetes dans le namespace cible avec DJANGO_SECRET_KEY. GitGuardian l'utilise pour chiffrer les données sensibles de l'application dans la base. Voir Secret obligatoire pour les commandes et les valeurs.

Sauvegardez la clé

Il est essentiel de sauvegarder votre clé dans un coffre sécurisé. La perte de la clé entraîne une perte de données irréversible sur votre instance GitGuardian.

astuce

Ce secret est géré en dehors d'Argo CD et persistera à travers les syncs et les mises à niveau.

Installer l'application GitGuardian

Après avoir créé le fichier de valeurs Helm values.yaml en suivant les instructions ci-dessus, vous pouvez créer l'application GitGuardian via la CLI Argo CD en exécutant la commande suivante :

argocd app create gitguardian \
  --dest-server <cluster> \
  --dest-namespace <namespace> \
  --repo registry.replicated.com/gitguardian \
  --helm-chart gitguardian \
  --revision 2025.x.y \
  --values-literal-file values.yaml \
  --self-heal \
  --auto-prune \
  --sync-option PruneLast=true

Si l'autoscaling est activé, vous devez configurer l'application Argo pour qu'elle ignore les changements apportés au nombre de réplicas pour tous les déploiements :

argocd app patch gitguardian \
  --patch '{"spec": {"ignoreDifferences": [{"group": "apps", "kind": "Deployment", "jsonPointers": ["/spec/replicas"]}]}}' \
  --type merge

Statut Missing sur le job bucket-init de MinIO

Si le job bucket-init de MinIO apparaît avec un statut Missing dans Argo CD, ajoutez les annotations suivantes dans votre values.yaml pour qu'Argo CD suive correctement le job :

loki-minio:
  bucketInitJob:
    annotations:
      argocd.argoproj.io/hook: Sync
      argocd.argoproj.io/hook-delete-policy: BeforeHookCreation

Mettre à niveau l'application GitGuardian

attention

Avant de mettre à niveau, sauvegardez votre base PostgreSQL. Pour les instructions détaillées, consultez la page Backup.

Pour mettre à niveau GitGuardian, vous devez d'abord mettre à jour la version du Helm chart via la CLI Argo CD en exécutant la commande suivante :

argocd app patch gitguardian \
  --patch '{"spec": { "source": { "targetRevision": "2024.x.y" } }}' \
  --type merge

Synchronisez l'app GitGuardian :

argocd app sync gitguardian