Infrastructure Terraform

Terraform est un outil open source d’infrastructure as code qui permet de créer, modifier et améliorer une infrastructure de manière sécurisée et prévisible.

Le générateur d’infrastructure Terraform crée un projet d’infrastructure Terraform. L’application générée intègre des bonnes pratiques de sécurité grâce aux vérifications de sécurité Checkov.

Utilisation

Générer un projet Terraform

Vous pouvez générer un nouveau projet Terraform de deux manières :

VSCode

1. Installez le Nx Console VSCode Plugin si ce n'est pas déjà fait
2. Ouvrez la console Nx dans VSCode
3. Cliquez sur Generate (UI) dans la section "Common Nx Commands"
4. Recherchez @aws/nx-plugin - terraform#project
5. Remplissez les paramètres requis
   • name: tf-infra
6. Cliquez sur Generate

CLI

pnpm

pnpm nx g @aws/nx-plugin:terraform#project --name=tf-infra

yarn

yarn nx g @aws/nx-plugin:terraform#project --name=tf-infra

npm

npx nx g @aws/nx-plugin:terraform#project --name=tf-infra

bun

bunx nx g @aws/nx-plugin:terraform#project --name=tf-infra

Vous pouvez également effectuer une simulation pour voir quels fichiers seraient modifiés

pnpm

pnpm nx g @aws/nx-plugin:terraform#project --name=tf-infra --dry-run

yarn

yarn nx g @aws/nx-plugin:terraform#project --name=tf-infra --dry-run

npm

npx nx g @aws/nx-plugin:terraform#project --name=tf-infra --dry-run

bun

bunx nx g @aws/nx-plugin:terraform#project --name=tf-infra --dry-run

Options

Paramètre	Type	Par défaut	Description
name Requis	string	-	The name of the project.
type	string	application	Whether this is a terraform lib (re-usable modules) or app (deployable).
directory	string	packages	The directory of the new project.

Sortie du générateur

Le générateur crée différentes structures de fichiers selon le type de projet :

Type Application

Pour les projets d’application (--type=application), le générateur crée une application Terraform complète avec gestion d’état distant :

• Répertoiresrc

  • main.tf Fichier de configuration principal Terraform
  • providers.tf Configuration des providers avec backend S3
  • variables.tf Définition des variables d’entrée
  • outputs.tf Définition des valeurs de sortie
  • Répertoireenv Fichiers de variables spécifiques à l’environnement

    • dev.tfvars Variables d’environnement de développement
• Répertoirebootstrap Configuration du backend pour l’état distant

  • main.tf Bucket S3 et politiques de stockage d’état
  • providers.tf Configuration du provider AWS
  • variables.tf Définition des variables de bootstrap
• project.json Configuration du projet et cibles de build

Note

Le générateur crée également une bibliothèque packages/common/terraform qui ajoute initialement un module de métriques (crée une stack CloudFormation vide avec métadonnées) instrumenté automatiquement pour permettre à l’équipe nx-plugin-for-aws de suivre les métriques d’utilisation.

Type Bibliothèque

Pour les projets de bibliothèque (--type=library), le générateur crée une structure simplifiée pour des modules Terraform réutilisables :

• Répertoiresrc

  • main.tf Fichier principal du module Terraform
• project.json Configuration du projet et cibles de build

Astuce

Les projets d’application incluent des capacités de déploiement complet avec gestion d’état distant, tandis que les projets de bibliothèque sont conçus pour créer des modules Terraform réutilisables consommables par d’autres projets.

Implémentation de votre infrastructure Terraform

Vous pouvez commencer à écrire votre infrastructure Terraform dans src/main.tf, par exemple :

src/main.tf

locals {
  account_id = data.aws_caller_identity.current.account_id
  aws_region = data.aws_region.current.id
}

resource "null_resource" "print_info" {
  # triggers = {
  #   always_run = timestamp()
  # }

  provisioner "local-exec" {
    command = "echo 'AWS Region: ${local.aws_region}, AWS Account: ${local.account_id}, Environment: ${var.environment}'"
  }
}

# Déclarez votre infrastructure ici
resource "aws_s3_bucket" "my_bucket" {
  bucket = "my-unique-bucket-name"
}

Dépendances inter-projets

Pour exécuter un module d’un projet séparé (lib), vous pouvez procéder ainsi :

module "lib_module" {
  source = "../../path/to/my-lib/src"
}

Cela mettra automatiquement à jour le graphe Nx pour ajouter une dépendance entre votre application consommatrice et votre librairie.

Configuration d’environnement

Configurez les variables spécifiques à l’environnement dans les fichiers src/env/*.tfvars.

Pour ajouter de nouveaux environnements, créez un nouveau fichier src/env/<environment>.tfvars avec les variables spécifiques et ajoutez de nouvelles entrées pour apply, destroy, init, plan dans le project.json. Par exemple, ajoutons un environnement prod :

src/env/prod.tfvars

# Variables d'environnement de production
environment = "prod"
region      = "us-west-2"

project.json

{
  "targets": {
        "apply": {
            "executor": "nx:run-commands",
            "defaultConfiguration": "dev",
            "configurations": {
                "dev": {
                    "command": "terraform apply ../../../dist/packages/infra/terraform/dev.tfplan"
                },
                "prod": {
                    "command": "terraform apply ../../../dist/packages/infra/terraform/prod.tfplan"
                }
            },
            "options": {
                "forwardAllArgs": true,
                "cwd": "{projectRoot}/src"
            },
            "dependsOn": ["plan"]
        },
        "destroy": {
            "executor": "nx:run-commands",
            "defaultConfiguration": "dev",
            "configurations": {
                "dev": {
                    "command": "terraform destroy -var-file=env/dev.tfvars"
                },
                "prod": {
                    "command": "terraform destroy -var-file=env/prod.tfvars"
                }
            },
            "options": {
                "forwardAllArgs": true,
                "cwd":"{projectRoot}/src"
            },
            "dependsOn": ["init"]
        },
        "init": {
            "executor": "nx:run-commands",
            "defaultConfiguration": "dev",
            "configurations": {
                "dev": {
                    "command": "terraform init -reconfigure -backend-config=\"region=$(aws configure get region)\" -backend-config=\"bucket=$(aws sts get-caller-identity --query Account --output text)-tf-state-$(aws configure get region)\" -backend-config=\"key=my-scope-my-project/dev/terraform.tfstate\""
                },
                "prod": {
                    "command": "terraform init -reconfigure -backend-config=\"region=$(aws configure get region)\" -backend-config=\"bucket=$(aws sts get-caller-identity --query Account --output text)-tf-state-$(aws configure get region)\" -backend-config=\"key=my-scope-my-project/prod/terraform.tfstate\""
                }
            },
            "options": {
                "forwardAllArgs": true,
                "cwd": "{projectRoot}/src"
            }
        },
        "plan": {
            "executor": "nx:run-commands",
            "defaultConfiguration": "dev",
            "configurations": {
                "dev": {
                    "command": "terraform plan -var-file=env/dev.tfvars -out=../../../dist/packages/infra/terraform/dev.tfplan"
                },
                "prod": {
                    "command": "terraform plan -var-file=env/dev.tfvars -out=../../../dist/packages/infra/terraform/prod.tfplan"
                }
            },
            "options": {
                "forwardAllArgs": true,
                "cwd": "{projectRoot}/src"
            },
            "dependsOn": ["init"]
        }
    }
}

Astuce

Par défaut, toutes les cibles utilisent l’environnement dev, mais vous pouvez cibler un environnement spécifique comme suit :

• pnpm
• yarn
• npm
• bun

pnpm nx run tf-infra:apply --configuration=prod

yarn nx run tf-infra:apply --configuration=prod

npx nx run tf-infra:apply --configuration=prod

bunx nx run tf-infra:apply --configuration=prod

Vous pouvez aussi changer d’environnement à tout moment car l’état segmente automatiquement le tfstate entre les environnements.

Bootstrap du backend distant (Projets application uniquement)

Pour les projets application, avant de déployer votre infrastructure, vous devez initialiser le backend distant. Cela crée un bucket S3 pour stocker les fichiers d’état Terraform :

pnpm

pnpm nx run tf-infra:bootstrap

yarn

yarn nx run tf-infra:bootstrap

npm

npx nx run tf-infra:bootstrap

bun

bunx nx run tf-infra:bootstrap

Note

Assurez-vous que votre profil AWS CLI est configuré pour le compte/région où vous souhaitez déployer les ressources de bootstrap.

La cible bootstrap est uniquement disponible pour les projets de type application. Les projets bibliothèque ne nécessitent pas de gestion d’état distant car ils sont conçus comme des modules réutilisables.

Cibles disponibles

Les cibles disponibles dépendent du type de projet :

Cibles communes (Application et Bibliothèque)

Validation de l’infrastructure

Validez votre configuration Terraform avec la cible validate :

pnpm

pnpm nx run tf-infra:validate

yarn

yarn nx run tf-infra:validate

npm

npx nx run tf-infra:validate

bun

bunx nx run tf-infra:validate

Formatage du code

Formatez votre code Terraform avec la cible fmt :

pnpm

pnpm nx run tf-infra:fmt

yarn

yarn nx run tf-infra:fmt

npm

npx nx run tf-infra:fmt

bun

bunx nx run tf-infra:fmt

Tests de sécurité

Exécutez des contrôles de sécurité sur votre infrastructure avec Checkov via la cible test :

pnpm

pnpm nx run tf-infra:test

yarn

yarn nx run tf-infra:test

npm

npx nx run tf-infra:test

bun

bunx nx run tf-infra:test

Vous trouverez les résultats des tests de sécurité dans le dossier dist racine, sous dist/packages/<my-terraform-project>/checkov.

Cibles spécifiques aux applications

Les cibles suivantes sont uniquement disponibles pour les projets de type application :

Planification de l’infrastructure

Avant d’appliquer les changements, visualisez les modifications avec la cible plan :

pnpm

pnpm nx run tf-infra:plan

yarn

yarn nx run tf-infra:plan

npm

npx nx run tf-infra:plan

bun

bunx nx run tf-infra:plan

Cela crée un fichier de plan dans dist/packages/<my-terraform-project>/terraform/dev.tfplan.

Initialisation de Terraform

Initialisez votre répertoire de travail Terraform avec la cible init :

pnpm

pnpm nx run tf-infra:init

yarn

yarn nx run tf-infra:init

npm

npx nx run tf-infra:init

bun

bunx nx run tf-infra:init

Déploiement sur AWS

Après la planification, déployez votre infrastructure sur AWS avec la cible apply :

pnpm

pnpm nx run tf-infra:apply

yarn

yarn nx run tf-infra:apply

npm

npx nx run tf-infra:apply

bun

bunx nx run tf-infra:apply

Astuce

Cette commande applique le plan créé par la cible plan. Pensez à exécuter plan d’abord pour examiner les changements.

Récupération des outputs

Récupérez les valeurs de sortie de votre configuration Terraform :

pnpm

pnpm nx run tf-infra:output

yarn

yarn nx run tf-infra:output

npm

npx nx run tf-infra:output

bun

bunx nx run tf-infra:output

Destruction de l’infrastructure

Pour supprimer votre infrastructure, utilisez la cible destroy :

pnpm

pnpm nx run tf-infra:destroy

yarn

yarn nx run tf-infra:destroy

npm

npx nx run tf-infra:destroy

bun

bunx nx run tf-infra:destroy

Attention

Cela supprimera définitivement toutes les ressources gérées par cette configuration Terraform. À utiliser avec prudence !

Destruction des ressources de bootstrap

Pour nettoyer les ressources de bootstrap (bucket S3 de stockage d’état) :

pnpm

pnpm nx run tf-infra:bootstrap-destroy

yarn

yarn nx run tf-infra:bootstrap-destroy

npm

npx nx run tf-infra:bootstrap-destroy

bun

bunx nx run tf-infra:bootstrap-destroy

Plus d’informations

Pour plus d’informations sur Terraform, consultez la Documentation Terraform et la Documentation du provider AWS.