Aller au contenu principal

Mettre à jour Helm

danger

N'effectuez pas de rollback ou de downgrade sans consulter au préalable notre équipe de support. Certains scénarios peuvent nécessiter la restauration de la base de données à partir d'une sauvegarde antérieure à la mise à jour, en raison de la complexité de l'annulation de certaines migrations de base de données.

attention

Avant de procéder à la mise à jour, assurez-vous de sauvegarder votre base de données PostgreSQL. Pour des instructions détaillées, consultez la page Sauvegarde.

Chemin de mise à jour et versions requises​

Certaines versions sont requises et ne peuvent pas être ignorées. Elles comportent des migrations de base de données et des changements d'infrastructure sur lesquels les versions ultérieures s'appuient, votre instance doit donc passer par chacune d'elles.

Les versions requises suivent un cycle trimestriel : janvier, avril, juillet et octobre. Toutes les autres versions sont facultatives. Vous pouvez reconnaître une version requise dans les notes de version Self-Hosted : son titre se termine par Required.

Si une ou plusieurs versions requises se situent entre votre version actuelle et la version que vous visez, mettez à jour vers chacune d'elles dans l'ordre avant d'atteindre votre cible. Passer de 2025.6 à 2026.7, par exemple, nécessite cinq mises à jour successives :

2025.6 ➔ 2025.7 ➔ 2025.10 ➔ 2026.1 ➔ 2026.4 ➔ 2026.7

Pour chaque étape du chemin :

  1. Examinez les breaking changes de la version cible ainsi que le changelog des valeurs Helm, puis mettez à jour votre fichier de valeurs en conséquence.
  2. Lancez la mise à jour.
  3. Attendez que l'application soit entièrement mise à jour avant de commencer l'étape suivante : tous les pods en cours d'exécution et tous les jobs terminés.
remarque

Vous ne pouvez pas ignorer une version requise par accident. Chaque mise à jour commence par un job upgrade-path-check qui valide le chemin et arrête la mise à jour avant qu'aucun changement ne soit appliqué si une version requise est manquante.

Lancer les vérifications préliminaires​

Prérequis

Les vérifications préliminaires sont essentielles pour une installation réussie. Les règles suivantes s'appliquent :

  • ❌ Échecs des vérifications préliminaires : si les vérifications préliminaires échouent, la mise à jour ne doit pas continuer tant que l'environnement ciblé ne répond pas à toutes les exigences. Veuillez contacter notre équipe de support si nécessaire.
  • ⚠️ Avertissements des vérifications préliminaires : si les vérifications préliminaires renvoient des avertissements, l'installation peut se poursuivre, mais il est recommandé de traiter ces avertissements pour vous conformer à nos recommandations.

Nous vous recommandons vivement d'exécuter notre script de vérification préliminaire pour vous assurer que votre cluster existant répond aux exigences de GitGuardian.

Récupérez le script depuis notre dépôt public ici

Spécifiez un namespace Kubernetes existant à l'aide de l'option -n. Si elle n'est pas spécifiée, le script s'exécutera dans votre namespace par défaut. Remplacez <release-name> par le nom de votre release helm existante.

./preflights.sh -r <release-name> -n <namespace> oci://registry.replicated.com/gitguardian/gitguardian -f local-values.yaml

Mettre à jour l'application GitGuardian​

Connectez-vous au registre avec la commande suivante :

helm registry login registry.replicated.com --username your.name@yourcompany.com

Mettez à jour l'application GitGuardian vers la dernière version dans le cluster Kubernetes et le namespace où elle est installée :

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

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

Cela mettra à jour votre application vers la dernière version. Pour mettre à jour vers une version spécifique, utilisez le flag --version :

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

Mettre à jour l'application GitGuardian en Airgap​

Suivez ces étapes pour mettre à jour une installation basée sur Helm dans un environnement air-gapped :

  1. Connectez-vous au registre Helm :

    helm registry login registry.replicated.com --username your.name@yourcompany.com
  2. Téléchargez le chart Helm localement (remplacez par la version souhaitée si nécessaire) :

    helm fetch oci://registry.replicated.com/gitguardian/gitguardian
    # this will download a file like gitguardian-<version>.tgz
  3. Authentifiez Docker auprès du proxy Replicated pour récupérer les images (remplacez <your_licenseID>) :

    LICENSE_ID="<your_licenseID>"; \
    echo "{\"auths\": {\"proxy.replicated.com\": {\"auth\": \"$(echo -n \"${LICENSE_ID}:${LICENSE_ID}\" | base64)\"}, \"registry.replicated.com\": {\"auth\": \"$(echo -n \"${LICENSE_ID}:${LICENSE_ID}\" | base64)\"}}}" > ~/.docker/config.json
  4. Récupérez les images requises pour la version cible, puis chargez-les vers votre registre privé. Référez-vous à la liste des images sur la page d'installation Airgap. Vous pouvez utiliser docker ou skopeo pour transférer les images.

    Architecture des images

    Toutes les images GitGuardian sont multi-architecture. Vous n'avez pas besoin de passer --platform lors de leur récupération ; la variante correcte est sélectionnée automatiquement en fonction de l'architecture de l'hôte.

  5. Lancez les vérifications préliminaires sur l'archive du chart local :

    ./preflights.sh -r <release-name> -n <namespace> gitguardian-<version>.tgz -f local-values.yaml
  6. Mettez à jour à l'aide de l'archive du chart local :

    helm upgrade <release-name> --timeout 30m -n <namespace> gitguardian-<version>.tgz -f local-values.yaml

Remplacez <release-name>, <namespace> et <version> en conséquence. Assurez-vous que votre local-values.yaml pointe vers votre registre d'images privé comme décrit sur la page d'installation Airgap.

Mettre à jour la configuration de l'application​

Modifiez la configuration de l'application avec un fichier de valeurs mis à jour à l'aide de la commande helm upgrade. Restez sur la même version en utilisant le flag --version :

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

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

Breaking changes​

Certaines versions nécessitent des modifications manuelles avant la mise à jour. Vérifiez chaque version entre votre version actuelle et votre cible, y compris celles par lesquelles vous passez sur votre chemin de mise à jour.

2025.10​

Si vous utilisez un déploiement air gap : cette version utilise désormais un chart et une image Docker non-Bitnami pour le sous-chart MinIO (qui prend en charge la fonctionnalité de collecteur de logs). Ce changement implique des modifications mineures de votre fichier values.yaml :

Modifiez votre fichier de valeurs Helm :

2025.8​

Si vous utilisez un déploiement air gap : cette version introduit un nouveau paramètre image.registry dans les valeurs Helm pour prendre en charge le système Log Collector. Ce paramètre spécifie l'emplacement des images GitGuardian pour les composants du Log Collector (Loki, MinIO, Fluent Bit) et est distinct du paramètre principal imageRegistry.

Ajoutez image.registry à votre fichier de valeurs Helm :

global:
imageRegistry: docker.internal/example/path # Location of the GitGuardian images
image:
registry: docker.internal/example/path # Location of the GitGuardian images (same as imageRegistry)

Trouvez tous les noms d'images et de tags sur la page d'installation Air Gap.

2025.7​

Le moteur de Machine Learning est désormais activé par défaut. Assurez-vous que votre infrastructure répond aux exigences ML.

2025.6​

GitGuardian 2025.6 requiert désormais Kubernetes 1.28 comme version minimale prise en charge. Cependant, Kubernetes 1.28 ne reçoit plus de support actif ou de maintenance de la part du projet Kubernetes (le support a pris fin en octobre 2024).

Nous vous recommandons vivement de mettre à jour vers Kubernetes 1.32 pour une sécurité et une stabilité optimales. Kubernetes 1.32 est activement pris en charge jusqu'en décembre 2025 et recevra un support de maintenance jusqu'en février 2026.

Pour plus d'informations :

2025.5​

Déploiement air gap ? Nous avons renommé des images dans cette version. Voir ci-dessous et trouver tous les noms d'images et de tags sur la page d'installation Air Gap.

Ce changement implique le renommage des images suivantes :

  • gitguardian/prm-static-chainguard-fips en gitguardian/prm-static-chainguard
  • gitguardian/prm-app-fips en gitguardian/prm-app-chainguard

2025.4​

Veuillez installer l'extension PostgreSQL pgvector pour activer la recherche de similarité vectorielle. Ceci est essentiel pour les fonctionnalités à venir exploitant notre moteur interne de machine learning. Suivez les instructions d'installation pour garantir la compatibilité.

Déploiement air gap ? Nous avons ajouté de nouvelles images dans cette version. Les nouvelles images concernent le système de collecte de logs, qui comprend :

  • Fluent Bit (collecteur de logs)
  • Loki (agrégation de logs)
  • MinIO (stockage objet pour les logs)

Trouvez tous les noms d'images et de tags sur la page d'installation Air Gap.

2025.3​

La version 2025.3 introduit un breaking change dans l'URL du registre de nommage, y compris le chemin et les noms d'images. Si vous téléchargez nos images dans un registre privé (consultez notre documentation air gap), assurez-vous de mettre à jour votre outillage, ainsi que les noms et chemins d'images dans votre fichier de valeurs Helm.

Changement de l'URL du registre

  • Ancien : proxy.replicated.com/proxy/gitguardian/513715405986.dkr.ecr.us-west-2.amazonaws.com
  • Nouveau : proxy.replicated.com/proxy/gitguardian/docker.io

Changements de chemin et de nom d'images

  • /prm/static-chainguard ➔ /gitguardian/prm-static-chainguard-fips
  • /prm/app-chainguard ➔ /gitguardian/prm-app-chainguard-fips
  • /prm/helm-tooling ➔ /gitguardian/prm-helm-tooling
  • /services/nginx-unprivileged ➔ /nginxinc/nginx-unprivileged
  • /ml-detector/ml-secret-engine/app-chainguard ➔ /gitguardian/ml-secret-engine-app-chainguard-fips

Changement de l'URL du registre

  • Ancien : registry.replicated.com
  • Nouveau : proxy.replicated.com/proxy/gitguardian/docker.io

Changements de chemin et de nom d'images

  • /gitguardian/replicated-sdk ➔ /replicated/replicated-sdk

Notes supplémentaires​

Stratégie de mise à jour des pods​

L'objectif est de trouver un équilibre entre la continuité de service et les ressources disponibles sur le cluster. Vous pouvez définir quelle stratégie de mise à jour utiliser lors d'une mise à niveau / mise à jour.

Cette configuration est possible pour les celeryWorkers (celeryWorkers.worker.updateStrategy) et les webapps (webapps.app.updateStrategy).

Si elle n'est pas définie, cette stratégie par défaut s'applique :

  • Si moins de 3 réplicas
type: RollingUpdate
rollingUpdate:
maxUnavailable: 50%
maxSurge: 50%
  • Sinon
type: RollingUpdate
rollingUpdate:
maxUnavailable: 25%
maxSurge: 25%