Terraform import - Générer les ressources automatiquement

Générez automatiquement des ressources avec Terraform grâce à Terraform import

Sommaire

Importez la ressource existante dans Terraform. C'est quelque chose que nous redoutons tous de faire un jour, mais parfois, nous devons le faire.

Avant Terraform 1.5, nous devions utiliser la commande terraform import et ensuite ajouter la configuration à notre ressource pour compléter la base d'arguments sur les détails que nous connaissons à son sujet. Mais à partir de Terraform v1.5 (en tant que fonctionnalité expérimentale), nous pouvons importer des ressources Terraform en demandant à Terraform d'extraire ses configurations existantes et de générer une ressource configurée complète pour nous. Jetons un coup d'œil rapide à cette fonctionnalité.

Nous utiliserons Azure pour cette démo.

Documentation : https://developer.hashicorp.com/terraform/language/import/generating-configuration

Ancienne approche

Avant de commencer, j'ai créé une resource group hands-on-rg avec la commande az group create

az group create --location westeurope --resource-group hands-on-rg

az group show --resource-group hands-on-rg

{
  "id": "/subscriptions/XXX/resourceGroups/hands-on-rg",
  "location": "westeurope",
  "managedBy": null,
  "name": "hands-on-rg",
  "properties": {
    "provisioningState": "Succeeded"
  },
  "tags": null,
  "type": "Microsoft.Resources/resourceGroups"
}

Dans les versions précédentes de Terraform, nous aurions fait ce qui suit :

Configurer notre ressource Terraform vide

terraform {
  required_providers {
    azurerm = {
      source = "hashicorp/azurerm"
      version = "3.85.0"
    }
  }
}

provider "azurerm" {
    features {}
    skip_provider_registration = true
}

resource "azurerm_resource_group" "hands_on" {
}

Exécuter la commande d'importation Terraform

terraform import azurerm_resource_group.hands_on /subscriptions/XXX/resourceGroups/hands-on-rg

Compléter la configuration de notre ressource importée, puisqu'elle se trouve dans notre state

resource "azurerm_resource_group" "hands_on" {
    location   = "westeurope"
  managed_by = null
  name       = "hands-on-rg"
  tags       = {}
}

Trop long, non?

Nouvelle approche

Pour cette approche nouvelle génération, il suffit d'utiliser le bloc import avec la syntaxe suivante :

import {
  id = <id de la ressource>
  to = <pointeur de la ressource à générer>
}

import {
  id = "/subscriptions/XXX/resourceGroups/hands-on-rg"
  to = azurerm_resource_group.hands_on
}

C'est simple, il suffit d'exécuter terraform plan et terraform apply

terraform plan -generate-config-out=generated.tf -out=plan.tfplan

generate-config-out pour le fichier de sortie de la génération
out pour la sortie du plan

Nous obtenons comme sortie

Terraform will perform the following actions:

  # azurerm_resource_group.this will be imported
  # (config will be generated)
    resource "azurerm_resource_group" "hands_on" {
        id       = "/subscriptions/XXX/resourceGroups/hands-on-rg"
        location   = "westeurope"
              managed_by = null
              name       = "hands-on-rg"
        tags     = {}
    }

Plan: 1 to import, 0 to add, 0 to change, 0 to destroy.

Nous remarquons le nouveau plan d'action import. Nous pouvons également voir que le fichier a été généré.

# generated.tf
resource "azurerm_resource_group" "hands_on" {
    location   = "westeurope"
      managed_by = null
      name       = "hands-on-rg"
    tags     = {}
}

Tout ce que nous avons à faire, c'est d'exécuter notre plan pour que la ressource puisse être ajoutée à notre état avec

terraform apply "plan.tfplan"
# Apply complete! Resources: 1 imported, 0 added, 0 changed, 0 destroyed.

terraform state list
# azurerm_resource_group.hands_on

Veuillez consulter ces ressources et les déplacer dans vos fichiers de configuration principaux.

Et voilà...