Bonnes pratiques pour utiliser DM Convert

Bonnes pratiques pour la conversion vers Terraform

État

Le fichier d'état stocke des informations sur les ressources que Terraform gère. Par défaut, Terraform stocke l'état localement sur disque. Si vous stockez l'état à distance, vous pouvez permettre la collaboration distribuée, protéger les informations sensibles et exécuter Terraform en intégration continue (CI).

Après avoir converti votre modèle Deployment Manager en Terraform et importé des ressources (facultatif), nous vous recommandons de suivre la procédure pour stocker l'état à distance dans Cloud Storage.

Modules

Si vous souhaitez réduire la complexité, appliquer la cohérence et favoriser la réutilisation de votre configuration, vous pouvez utiliser des modules Terraform pour encapsuler des collections de ressources.

Pour utiliser des modules, vous pouvez procéder comme suit:

Dans la plupart des cas d'utilisation, nous vous recommandons d'utiliser un module publié.

Créer un module personnalisé

  1. Une fois que vous avez converti votre configuration, identifiez les ressources que vous souhaitez déplacer vers un module.

  2. Déplacez les configurations de ces ressources dans un répertoire de module et convertissez les variables requises en paramètres.

    L'exemple suivant montre comment déplacer google_bigquery_dataset et google_bigquery_table dans un module:

    # bq-module/main.tf
    resource "google_bigquery_dataset" "bigquerydataset" {
      provider = google-beta
    
      default_table_expiration_ms = 36000000
      location = "us-west1"
      dataset_id = var.dataset_id
      project = var.project_id
    }
    
    resource "google_bigquery_table" "bigquerytable" {
      provider = google-beta
    
      labels = {
        data-source = "external"
        schema-type = "auto-junk"
      }
      dataset_id = var.dataset_id
      project = var.project_id
      table_id = var.table_id
    
      depends_on = [
        google_bigquery_dataset.bigquerydataset
      ]
    }
    
    # bq-module/variables.tf
    variable "project_id" {
      description = "Project ID"
      type = string
    }
    
    variable "dataset_id" {
      description = "Dataset ID"
      type = string
    }
    
    variable "table_id" {
      description = "Table ID"
      type = string
    }
    
  3. Dans le fichier main.tf exporté, remplacez la configuration d'origine par le module que vous avez créé.

    L'exemple suivant montre ce remplacement à l'aide du module créé dans l'exemple de l'étape précédente.

    # main.tf
    module "bq" {
      source = "./bq-module"
    
      project_id = "PROJECT_ID"
      dataset_id = "bigquerydataset"
      table_id   = "bigquerytable"
    }
    
  4. Pour initialiser le module local, exécutez la commande suivante:

    terraform init
    
  5. Déplacez l'état Terraform associé aux ressources dans l'instance du module.

    Pour déplacer le module de l'exemple de l'étape précédente, exécutez la commande suivante:

    terraform state mv google_bigquery_dataset.bigquerydataset module.bq.google_bigquery_dataset.bigquerydataset
    terraform state mv google_bigquery_table.bigquerytable module.bq.google_bigquery_table.bigquerytable
    

    Pour cet exemple, la sortie de la migration est la suivante:

    Move "google_bigquery_dataset.bigquerydataset" to "module.bq.google_bigquery_dataset.bigquerydataset"
    Successfully moved 1 object(s).
    Move "google_bigquery_table.bigquerytable" to "module.bq.google_bigquery_table.bigquerytable"
    Successfully moved 1 object(s).
    
  6. Vérifiez qu'aucune ressource n'a changé en exécutant la commande suivante:

    terraform plan
    

    Voici un exemple de résultat obtenu après l'exécution de la commande:

    No changes. Your infrastructure matches the configuration.
    

Utiliser un module publié

  1. Une fois que vous avez converti votre configuration, identifiez un module publié et les ressources que vous souhaitez y déplacer.

  2. Identifiez les options de configuration du module en lisant sa documentation.

  3. Créez une instance du module configuré en fonction de votre configuration de ressources actuelle.

    Par exemple, si vous souhaitez déplacer google_bigquery_dataset et google_bigquery_table dans le module BigQuery officiel, l'exemple suivant montre à quoi pourrait ressembler votre module:

    module "bq" {
      source  = "terraform-google-modules/bigquery/google"
      version = "~> 5.0"
    
      project_id          = "PROJECT_ID"
      dataset_id          = "bigquerydataset"
      location            = "us-west1"
      deletion_protection = true
    
      tables = [
        {
          table_id           = "bigquerytable",
          friendly_name      = "bigquerytable"
          time_partitioning  = null,
          range_partitioning = null,
          expiration_time    = null,
          clustering         = [],
          schema             = null,
          labels = {
            data-source = "external"
            schema-type = "auto-junk"
          },
        }
      ]
    }
    
  4. Pour initialiser le module local, exécutez la commande suivante:

    terraform init
    
  5. Lisez le code source du module pour identifier les adresses de ressources dans le module en amont et créer les commandes de déplacement.

    terraform state mv google_bigquery_dataset.bigquerydataset  module.bq.google_bigquery_dataset.main
    terraform state mv google_bigquery_table.bigquerytable 'module.bq.google_bigquery_table.main["bigquerytable"]'
    
  6. Pour afficher les modifications apportées à la configuration, exécutez la commande suivante:

    terraform plan
    

Si le module publié que vous avez sélectionné présente des paramètres par défaut différents ou est configuré différemment de votre configuration, des différences peuvent être mises en évidence dans la sortie de l'exécution de la commande.

Actionnement

Nous vous recommandons d'utiliser un système d'intégration continue (CI), tel que Cloud Build, Jenkins ou GitHub Actions, pour automatiser l'exécution de Terraform à grande échelle. Pour en savoir plus, consultez la page Gérer une infrastructure as Code avec Terraform, Cloud Build et GitOps.

Si vous souhaitez démarrer la création de déclencheurs et simplifier l'authentification, vous pouvez choisir d'utiliser le modèle Workspace Cloud Build.

Structure

Chaque configuration convertie à partir de DM Convert est une configuration racine unique mappée sur un seul fichier d'état. Nous vous déconseillons de configurer un seul fichier d'état pour contenir un grand nombre de ressources. Une fois votre configuration convertie, nous vous recommandons de vous assurer qu'elle respecte les bonnes pratiques pour les modules racine.