Installer Config Sync avec les paramètres par défaut

Config Sync synchronise vos configurations Kubernetes avec vos clusters. Ce document explique comment activer et configurer Config Sync à l'aide des paramètres par défaut. Il se concentre sur la synchronisation des configurations à partir d'un dépôt Git non structuré.

Cette page s'adresse aux opérateurs qui souhaitent implémenter des outils GitOps pour centraliser la gestion de la configuration de leurs équipes. Pour en savoir plus sur les rôles courants et les exemples de tâches que nous citons dans le contenu Google Cloud , consultez Rôles utilisateur et tâches courantes de GKE.

Pour savoir comment installer Config Sync avec des paramètres avancés, consultez Personnaliser votre installation de Config Sync.

Avant de commencer

Avant d'installer Config Sync, préparez votre dépôt Git et vos clusters GKE.

Créer un dépôt Git et accorder l'accès à Config Sync

Pour synchroniser la configuration d'un dépôt Git avec vos clusters, Config Sync a besoin d'un accès en lecture seule à votre dépôt. Pour autoriser Config Sync à lire vos configurations, procédez comme suit :

  • Créez un dépôt Git contenant les fichiers de configuration que vous souhaitez que Config Sync synchronise avec vos clusters, ou assurez-vous d'y avoir accès.

  • Si votre dépôt Git est public, aucune autre action n'est requise. Config Sync ne nécessite pas d'autorisations supplémentaires.

  • Si votre dépôt Git est privé, suivez les instructions de la section Accorder à Config Sync l'accès à Git.

Créer un cluster

Si vous avez déjà préparé un cluster, par exemple en suivant les étapes pour accorder à Config Sync l'accès à Git, passez à la section Installer Config Sync.

Config Sync exige que vos clusters soient enregistrés dans un parc. Pour enregistrer vos clusters, procédez comme suit :

Console

Aucune action n'est requise. Vos clusters sont automatiquement enregistrés dans un parc lorsque vous installez Config Sync.

gcloud

  • Pour créer un cluster Autopilot enregistré dans un parc, exécutez la commande suivante :

    gcloud container clusters create-auto CLUSTER_NAME --enable-fleet

  • Pour créer un cluster Standard enregistré dans un parc, exécutez la commande suivante :

    gcloud container clusters create CLUSTER_NAME --enable-fleet \
    --workload-pool=PROJECT_ID.svc.id.goog

Remplacez les éléments suivants :

  • CLUSTER_NAME : nom du cluster
  • PROJECT_ID : ID de votre projet.

Pour en savoir plus sur l'enregistrement des clusters, consultez Enregistrer un cluster dans un parc.

Installer Config Sync

Pour activer et configurer Config Sync afin de synchroniser les configurations de votre dépôt Git avec vos clusters enregistrés, procédez comme suit :

Console

Si vous utilisez la console Google Cloud , vous devez d'abord installer Config Sync sur vos clusters, puis configurer un package qui permet à Config Sync de se synchroniser à partir de votre dépôt Git.

Installer Config Sync

  1. Accédez à la page Config Sync dans la console Google Cloud .

    Accéder à la page "Configuration"

  2. Cliquez sur Installer Config Sync.

  3. Sélectionnez Installer sur tous les clusters du parc.

  4. Conservez les valeurs par défaut de tous les autres paramètres.

  5. Cliquez sur Installer Config Sync.

Dans l'onglet Paramètres, après quelques minutes, Activé s'affiche dans la colonne État pour les clusters de votre parc.

Déployer un package

  1. Cliquez sur Déployer le package de cluster.

  2. Dans l'onglet Sélectionner des clusters, sélectionnez le cluster sur lequel vous souhaitez déployer un package, puis cliquez sur Continuer.

  3. Cliquez sur l'onglet Configurer le package et saisissez un nom pour votre package.

  4. Dans la section Source, configurez les éléments suivants :

    1. Dans le champ URL du dépôt, saisissez l'URL de votre dépôt Git.

    2. Facultatif : Vérifiez et modifiez les autres paramètres des champs. Selon la structure de votre dépôt, vous n'aurez peut-être pas besoin de modifier ces paramètres.

  5. Facultatif : Si votre dépôt est privé, développez la section Paramètres avancés pour configurer votre méthode d'authentification. La console Google Cloud fournit des instructions intégrées pour vous aider à configurer vos paramètres d'authentification.

  6. Conservez les valeurs par défaut de tous les autres paramètres.

  7. Cliquez sur Déployer le package.

Vous êtes redirigé vers la page Packages de Config Sync. Après quelques minutes, Synchronisé s'affiche dans la colonne État de synchronisation du cluster que vous avez configuré.

gcloud

Si vous utilisez gcloud CLI, vous installez Config Sync en créant un fichier manifeste contenant vos paramètres Config Sync, puis en appliquant ces paramètres à votre cluster.

  1. Activez la fonctionnalité de parc ConfigManagement :

    gcloud beta container fleet config-management enable

  2. Créez un fichier manifeste appelé apply-spec.yaml. Cet exemple de fichier manifeste contient les paramètres par défaut recommandés :

    applySpecVersion: 1
spec:
  configSync:
    enabled: true
    sourceFormat: unstructured
    syncRepo: REPO_URL
    # syncRev: REVISION
    secretType: none
    preventDrift: false

    Remplacez les éléments suivants :

    • REPO_URL : URL de votre dépôt Git (par exemple, https://github.com/GoogleCloudPlatform/anthos-config-management-samples).

    • (Facultatif) REVISION : révision Git (tag ou hachage) ou branche à partir de laquelle vous souhaitez effectuer la synchronisation. Annulez la mise en commentaire et remplacez ce champ si vous devez effectuer la synchronisation à partir d'un emplacement autre que HEAD.

      Pour les dépôts privés, vous pouvez remplacer le champ secretType par une méthode d'authentification compatible. Il est généralement recommandé d'utiliser un compte de service Google (gcpserviceaccount) avec Secure Source Manager. Vous pouvez également utiliser ssh, car il fonctionne avec la plupart des fournisseurs Git. Pour obtenir des instructions plus détaillées sur les méthodes d'authentification compatibles, consultez Accorder l'accès à Git.

  3. Appliquez le fichier manifeste à votre cluster :

    gcloud beta container fleet config-management apply \
    --membership=MEMBERSHIP_NAME \
    --config=apply-spec.yaml \
    --project=PROJECT_ID

    Remplacez les éléments suivants :

    • MEMBERSHIP_NAME : nom d'appartenance de parc que vous avez choisi lors de l'enregistrement de votre cluster. Obtenez le nom avec la commande gcloud container fleet memberships list.
    • PROJECT_ID : ID de votre projet

Vérifiez l'installation

Une fois que vous avez installé et configuré Config Sync, vérifiez que l'installation s'est bien déroulée.

Console

  1. Accédez à la page Config Sync dans la console Google Cloud .

    Accéder à Config Sync

  2. Dans l'onglet Packages, vérifiez la colonne Sync status (État de la synchronisation) dans le tableau du cluster. Une installation réussie de Config Sync présente l'état Installé. Un dépôt Git correctement configuré affiche l'état Synchronisé.

gcloud

Exécutez la commande suivante :

nomos status

Une installation réussie présente l'état SYNCED ou PENDING.

Pour en savoir plus sur les informations fournies par la commande nomos status, y compris les erreurs signalées, consultez Vérifier l'état de Config Sync dans la documentation de l'outil de ligne de commande nomos.

Étapes suivantes