Infrastructure Terraform

Terraform est un outil logiciel open-source d’infrastructure as code qui vous permet de créer, modifier et améliorer votre infrastructure de manière sûre et prévisible.

Le générateur d’infrastructure Terraform crée un projet d’infrastructure Terraform. L’application générée inclut les meilleures 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 :

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

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

Options

Paramètre	Type	Par défaut	Description
name Requis	string	-	Le nom du projet.
type	application | library	application	Si c'est une bibliothèque terraform (modules réutilisables) ou une application (déployable).
directory	string	packages	Le répertoire du nouveau projet.
subDirectory	string	-	Le sous-répertoire dans lequel le projet est placé. Par défaut, il s'agit du nom du projet.
preferInstallDependencies	boolean	true	Indique s'il faut privilégier l'installation des dépendances après l'exécution du générateur. Définir sur false pour différer l'installation lors de l'exécution de plusieurs générateurs en lot (une installation s'exécute quand même si nécessaire pour que les générateurs suivants puissent calculer le graphe de projet Nx) ; installer une seule fois à la fin.

Sortie du générateur

Le générateur crée différentes structures de fichiers en fonction du type de projet :

type = application

Type Application

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

• Répertoiresrc

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

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

  • main.tf Bucket S3 et politiques pour le stockage de l’état
  • providers.tf Configuration du fournisseur AWS
  • variables.tf Définitions des variables de bootstrap
• Répertoirescripts Helpers Node exécutés par les cibles nx bootstrap et init

  • aws-config.ts Résout le compte + la région via la chaîne de credentials AWS SDK
  • bootstrap.ts Récupère/pousse le tfstate de bootstrap et exécute terraform apply
  • init.ts Exécute terraform init avec la configuration du backend S3
• project.json Configuration du projet et cibles de build

Modules Terraform partagés

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

type = library

Type Bibliothèque

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

• Répertoiresrc

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

Application vs Bibliothèque

Les projets d’application incluent des capacités de déploiement complètes avec gestion de l’état distant, tandis que les projets de bibliothèque sont conçus pour créer des modules Terraform réutilisables qui peuvent être consommés par d’autres projets.

Implémenter 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}'"
  }
}

# Declare your infrastructure here
resource "aws_s3_bucket" "my_bucket" {
  bucket = "my-unique-bucket-name"
}

Dépendances entre projets

Si vous souhaitez exécuter un module à partir d’un projet séparé (lib), vous pouvez le faire comme suit :

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 lib.

Configuration de l’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 à l’environnement et ajoutez de nouvelles entrées pour apply, destroy, init, plan dans le project.json pour la nouvelle configuration d’environnement. Par exemple, supposons que nous voulions ajouter un environnement prod :

src/env/prod.tfvars

# Production environment variables
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": {
                    "env": { "TF_ENV": "dev" }
                },
                "prod": {
                    "env": { "TF_ENV": "prod" }
                }
            },
            "options": {
                "forwardAllArgs": true,
                "commands": ["tsx {projectRoot}/scripts/init.ts {projectRoot}"],
                "cwd": "{workspaceRoot}"
            }
        },
        "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"]
        }
    }
}

Environnement par défaut

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

• pnpm
• yarn
• npm
• bun

pnpm nx apply tf-infra --configuration=prod

yarn nx apply tf-infra --configuration=prod

npx nx apply tf-infra --configuration=prod

bunx nx apply tf-infra --configuration=prod

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

type = application

Bootstrap de l’état distant (Projets d’application uniquement)

Avant de déployer votre infrastructure, vous devrez initialiser le backend d’état distant. Cela crée un bucket S3 pour stocker vos fichiers d’état Terraform :

pnpm

pnpm nx bootstrap tf-infra

yarn

yarn nx bootstrap tf-infra

npm

npx nx bootstrap tf-infra

bun

bunx nx bootstrap tf-infra

Configuration du profil AWS

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

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

Cibles disponibles

Les cibles disponibles dépendent du type de votre projet :

Cibles communes (Application et Bibliothèque)

Valider votre infrastructure

Vous pouvez valider votre configuration Terraform en utilisant la cible validate :

pnpm

pnpm nx validate tf-infra

yarn

yarn nx validate tf-infra

npm

npx nx validate tf-infra

bun

bunx nx validate tf-infra

Formater votre code

Formatez votre code Terraform en utilisant la cible fmt :

pnpm

pnpm nx fmt tf-infra

yarn

yarn nx fmt tf-infra

npm

npx nx fmt tf-infra

bun

bunx nx fmt tf-infra

Tests de sécurité

Exécutez des vérifications de sécurité sur votre infrastructure en utilisant Checkov avec la cible test :

pnpm

pnpm nx test tf-infra

yarn

yarn nx test tf-infra

npm

npx nx test tf-infra

bun

bunx nx test tf-infra

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

type = application

Cibles réservées aux applications

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

Planifier votre infrastructure

Avant d’appliquer des modifications, vous pouvez voir ce que Terraform va faire en exécutant la cible plan :

pnpm

pnpm nx plan tf-infra

yarn

yarn nx plan tf-infra

npm

npx nx plan tf-infra

bun

bunx nx plan tf-infra

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

Initialiser 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éployer sur AWS

Après la planification, vous pouvez déployer votre infrastructure sur AWS en utilisant la cible apply :

pnpm

pnpm nx apply tf-infra

yarn

yarn nx apply tf-infra

npm

npx nx apply tf-infra

bun

bunx nx apply tf-infra

Approbation automatique

La commande ci-dessus applique le plan créé par la cible plan. Assurez-vous d’exécuter plan d’abord pour examiner les modifications.

Alias Deploy

Une cible deploy est également disponible comme alias pour apply. Vous pouvez utiliser soit

• pnpm
• yarn
• npm
• bun

pnpm nx deploy tf-infra

yarn nx deploy tf-infra

npx nx deploy tf-infra

bunx nx deploy tf-infra

soit

pnpm

pnpm nx apply tf-infra

yarn

yarn nx apply tf-infra

npm

npx nx apply tf-infra

bun

bunx nx apply tf-infra

de manière interchangeable.

Obtenir les sorties

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

pnpm

pnpm nx output tf-infra

yarn

yarn nx output tf-infra

npm

npx nx output tf-infra

bun

bunx nx output tf-infra

Détruire l’infrastructure

Lorsque vous devez démanteler votre infrastructure, utilisez la cible destroy :

pnpm

pnpm nx destroy tf-infra

yarn

yarn nx destroy tf-infra

npm

npx nx destroy tf-infra

bun

bunx nx destroy tf-infra

Opération destructive

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

Détruire les ressources de bootstrap

Pour nettoyer les ressources de bootstrap (bucket S3 pour le stockage de l’état) :

pnpm

pnpm nx bootstrap-destroy tf-infra

yarn

yarn nx bootstrap-destroy tf-infra

npm

npx nx bootstrap-destroy tf-infra

bun

bunx nx bootstrap-destroy tf-infra

Plus d’informations

Pour plus d’informations sur Terraform, veuillez vous référer à la Documentation Terraform et à la Documentation du fournisseur AWS.