Migrer votre objet ConfigManagement

Cette page explique comment migrer votre configuration Git d'un objet ConfigManagement vers un objet RootSync. La migration active les API RootSync et RepoSync, ce qui vous permet d'utiliser des fonctionnalités supplémentaires :

• Synchroniser à partir de plusieurs sources de référence
• Utiliser le tableau de bord Config Sync
• Surveiller Config Sync à l'aide de Cloud Monitoring, de Prometheus ou d'un système de surveillance personnalisé
• Effectuer le rendu des configurations Kustomize et des charts Helm
• Synchroniser les artefacts OCI à partir d'Artifact Registry
• Synchroniser des graphiques Helm à partir d'Artifact Registry
• Remplacer les valeurs système, telles que la modification des limites de ressources et la mise à jour du nombre de commits Git à récupérer

Vous pouvez activer ces API même si vous souhaitez n'utiliser qu'un dépôt racine et ne souhaitez pas utiliser de dépôts d'espaces de noms.

Migrer vos paramètres ConfigManagement

Si vous utilisez RootSync avec spec.enableLegacyFields, suivez les instructions pour cesser d'utiliser les anciens champs.

Si votre objet ConfigManagement utilise spec.git, mais que spec.enableMultiRepo est défini sur "false", suivez les instructions pour migrer vers RootSync.

Arrêter d'utiliser les anciens champs

Le champ spec.enableLegacyFields n'est pas compatible avec Config Sync. La présence de ce champ entraîne des erreurs. Si vous utilisez une version antérieure de Config Sync qui spécifie ce champ, procédez comme suit pour supprimer les anciens champs :

1. Ouvrez l'objet ConfigManagement.

2. Dans l'objet ConfigManagement, supprimez les champs spec.enableLegacyFields et spec.git. Votre objet ConfigManagement doit se présenter comme suit :

   # config-management.yaml
   apiVersion: configmanagement.gke.io/v1
   kind: ConfigManagement
   metadata:
     name: config-management
   spec:
     enableMultiRepo: true
   

3. Appliquez les modifications :

   kubectl apply -f config-management.yaml
   

Les anciens champs sont désormais désactivés sans affecter l'objet RootSync généré à partir des champs spec.git de votre objet ConfigManagement. La migration est terminée. Vous pouvez désormais utiliser directement les champs Git dans l'objet RootSync.

Migrer vers RootSync

Si votre objet ConfigManagement utilise spec.git, mais que spec.enableMultiRepo est défini sur "false", suivez ce guide pour activer les API RootSync et RepoSync.

Utiliser nomos migrate

À partir de la version 1.10.0, nomos fournit la commande nomos migrate pour activer les API RootSync et RepoSync. Vous devez mettre à jour nomos vers la version 1.10.0 et ultérieure.

Pour en savoir plus sur l'exécution de la commande, consultez la section Migrer depuis un objet ConfigManagement vers un objet RootSync. Assurez-vous que votre objet ConfigManagement n'est pas enregistré dans votre source de référence et qu'il est bien géré par Config Sync. Si tel est le cas, vous devez modifier l'objet ConfigManagement dans votre source de référence en suivant les étapes décrites dans la section Migration manuelle.

Migration manuelle

Si votre version de nomos est antérieure à la version 1.10.0, vous pouvez migrer manuellement vos paramètres. Vous devez définir spec.enableMultiRepo sur true dans votre objet ConfigManagement et créer un objet RootSync qui synchronise votre dépôt racine avec le cluster.

Pour configurer le dépôt racine en migrant la configuration, effectuez les tâches suivantes :

1. Ouvrez l'objet ConfigManagement.
2. Faites une copie des valeurs dans les champs spec.git. Ces valeurs s'utilisent pour créer l'objet RootSync.
3. Supprimez tous les champs spec.git (y compris git:) de l'objet ConfigManagement.

4. Dans l'objet ConfigManagement, définissez le champ spec.enableMultiRepo sur true :

   # config-management.yaml
   apiVersion: configmanagement.gke.io/v1
   kind: ConfigManagement
   metadata:
     name: config-management
   spec:
     enableMultiRepo: true
   

5. Appliquez les modifications :

   kubectl apply -f config-management.yaml
   

6. Attendez que le CRD RootSync soit créé.

   kubectl wait --for=condition=established crd rootsyncs.configsync.gke.io
   

7. En utilisant les valeurs que vous avez copiées à partir de l'objet ConfigManagement, créez l'objet RootSync. Exemple :

   # root-sync.yaml
   apiVersion: configsync.gke.io/v1beta1
   kind: RootSync
   metadata:
     name: root-sync
     namespace: config-management-system
   spec:
     sourceFormat: unstructured
     git:
       repo: ROOT_REPOSITORY
       revision: ROOT_REVISION
       branch: ROOT_BRANCH
       dir: "ROOT_DIRECTORY"
       auth: ROOT_AUTH_TYPE
       gcpServiceAccountEmail: ROOT_EMAIL
       # secretRef should be omitted if the auth type is none, gcenode, or gcpserviceaccount.
       secretRef:
         name: git-creds
   

   Remplacez les éléments suivants :

   • ROOT_REPOSITORY : ajoutez l'URL du dépôt Git à utiliser comme dépôt racine. Vous pouvez saisir des URL à l'aide du protocole HTTPS ou SSH. Par exemple, https://github.com/GoogleCloudPlatform/anthos-config-management-samples utilise le protocole HTTPS. Si vous ne saisissez pas de protocole, l'URL est traitée comme une URL HTTPS. Ce champ est obligatoire.
   • ROOT_REVISION : ajoutez la révision Git (tag ou hachage) à récupérer. Ce champ est facultatif et la valeur par défaut est HEAD.
   • ROOT_BRANCH : ajoutez la branche du dépôt à partir de laquelle la synchronisation doit être effectuée. Ce champ est facultatif et la valeur par défaut est master.
   • ROOT_DIRECTORY : ajoutez le chemin d'accès dans le dépôt Git au répertoire racine contenant la configuration que vous souhaitez synchroniser. Ce champ est facultatif et le paramètre par défaut est le répertoire racine (/) du dépôt.

   • ROOT_AUTH_TYPE : ajoutez l'un des types d'authentification suivants :

     • none : n'utiliser aucune authentification
     • ssh : utiliser une paire de clés SSH
     • cookiefile : utiliser un cookiefile
     • token : utiliser un jeton
     • gcpserviceaccount : utiliser un compte de service Google pour accéder à un dépôt dans Cloud Source Repositories.

     • gcenode : utiliser un compte de service Google pour accéder à un dépôt dans Cloud Source Repositories. Ne sélectionnez cette option que si Workload Identity Federation for GKE n'est pas activé dans votre cluster.

       Pour en savoir plus sur ces types d'authentification, consultez la page Accorder à Config Sync un accès en lecture seule à Git.

     Ce champ est obligatoire.

   • ROOT_EMAIL : si vous avez ajouté gcpserviceaccount comme ROOT_AUTH_TYPE, ajoutez l'adresse e-mail de votre compte de service Google. Par exemple, acm@PROJECT_ID.s3ns.iam.gserviceaccount.com.

8. Appliquez les modifications :

   kubectl apply -f root-sync.yaml
   

Tableau de comparaison ConfigManagement et RootSync

Le tableau suivant présente une correspondance des champs de votre objet ConfigMangent avec les champs d'un objet RootSync.

Étape suivante

• Configurer la synchronisation à partir de plusieurs dépôts