Infrastruttura Terraform

Terraform è uno strumento software open-source per l’infrastruttura come codice che consente di creare, modificare e migliorare l’infrastruttura in modo sicuro e prevedibile.

Il generatore di infrastruttura Terraform crea un progetto di infrastruttura Terraform. L’applicazione generata include le migliori pratiche di sicurezza attraverso i controlli di sicurezza di Checkov.

Utilizzo

Generare un progetto Terraform

Puoi generare un nuovo progetto Terraform in due modi:

VSCode

1. Installa il Nx Console VSCode Plugin se non l'hai già fatto
2. Apri la console Nx in VSCode
3. Clicca su Generate (UI) nella sezione "Common Nx Commands"
4. Cerca @aws/nx-plugin - terraform#project
5. Compila i parametri richiesti
   • name: tf-infra
6. Clicca su 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

Puoi anche eseguire una prova per vedere quali file verrebbero modificati

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

Opzioni

Parametro	Tipo	Predefinito	Descrizione
name Obbligatorio	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.

Output del Generatore

Il generatore crea strutture di file diverse in base al tipo di progetto:

Tipo Applicazione

Per progetti di tipo applicazione (--type=application), il generatore crea un’applicazione Terraform completa con gestione dello stato remoto:

• Directorysrc

  • main.tf File di configurazione principale Terraform
  • providers.tf Configurazione provider con backend S3
  • variables.tf Definizioni delle variabili di input
  • outputs.tf Definizioni dei valori di output
  • Directoryenv File di variabili specifici per ambiente

    • dev.tfvars Variabili per ambiente di sviluppo
• Directorybootstrap Configurazione bootstrap per lo stato remoto

  • main.tf Bucket S3 e politiche per lo storage dello stato
  • providers.tf Configurazione provider AWS
  • variables.tf Definizioni delle variabili bootstrap
• project.json Configurazione del progetto e target di build

Nota

Il generatore crea anche una libreria packages/common/terraform che inizialmente aggiunge solo un modulo metrics (crea uno stack Cloudformation vuoto con metadati) automaticamente strumentato per permettere al team nx-plugin-for-aws di tracciare le metriche di utilizzo.

Tipo Libreria

Per progetti di tipo libreria (--type=library), il generatore crea una struttura più semplice per moduli Terraform riutilizzabili:

• Directorysrc

  • main.tf File principale del modulo Terraform
• project.json Configurazione del progetto e target di build

Consiglio

I progetti applicazione includono capacità di deployment completo con gestione dello stato remoto, mentre i progetti libreria sono pensati per creare moduli Terraform riutilizzabili consumabili da altri progetti.

Implementare la tua Infrastruttura Terraform

Puoi iniziare a scrivere la tua infrastruttura Terraform all’interno di src/main.tf, ad esempio:

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}'"
  }
}

# Dichiarare la propria infrastruttura qui
resource "aws_s3_bucket" "my_bucket" {
  bucket = "my-unique-bucket-name"
}

Dipendenze cross-project

Se vuoi eseguire un modulo da un progetto separato (lib), puoi farlo così:

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

Questo aggiornerà automaticamente il grafo Nx per aggiungere una dipendenza tra la tua applicazione consumer e la tua libreria.

Configurazione Ambiente

Configura le variabili specifiche per ambiente nei file src/env/*.tfvars.

Per aggiungere nuovi ambienti, crea un nuovo file src/env/<ambiente>.tfvars con le variabili specifiche e aggiungi nuove voci per apply, destroy, init, plan nel project.json per la nuova configurazione ambiente. Ad esempio, supponiamo di voler aggiungere un ambiente prod:

src/env/prod.tfvars

# Variabili per ambiente produzione
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=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=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"]
        }
    }
}

Consiglio

Per default tutti i target assumono l’ambiente dev, ma puoi specificare un ambiente con:

• 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

Puoi anche cambiare ambiente in qualsiasi momento poiché lo stato separa automaticamente il tfstate tra ambienti.

Bootstrap Stato Remoto (Solo Progetti Applicazione)

Per i progetti applicazione, prima di deployare l’infrastruttura, devi eseguire il bootstrap del backend per lo stato remoto. Questo crea un bucket S3 per archiviare i file di stato 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

Nota

Assicurati che il profilo AWS CLI sia configurato per l’account/regione in cui vuoi deployare le risorse bootstrap.

Il target bootstrap è disponibile solo per progetti di tipo applicazione. I progetti libreria non richiedono gestione dello stato remoto essendo moduli riutilizzabili.

Target Disponibili

I target disponibili dipendono dal tipo di progetto:

Target Comuni (Sia Applicazione che Libreria)

Convalida dell’Infrastruttura

Puoi convalidare la configurazione Terraform con il target 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

Formattazione del Codice

Formatta il codice Terraform con il target 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

Test di Sicurezza

Esegui controlli di sicurezza sull’infrastruttura con Checkov usando il target 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

Troverai i risultati dei test di sicurezza nella cartella dist principale, sotto dist/packages/<my-terraform-project>/checkov.

Target Solo Applicazione

I seguenti target sono disponibili solo per progetti di tipo applicazione:

Pianificazione dell’Infrastruttura

Prima di applicare modifiche, puoi vedere cosa farà Terraform con il target 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

Questo creerà un file di pianificazione in dist/packages/<my-terraform-project>/terraform/dev.tfplan.

Inizializzazione Terraform

Inizializza la directory di lavoro Terraform con il target 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

Deploy su AWS

Dopo la pianificazione, puoi deployare l’infrastruttura su AWS con il target 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

Consiglio

Il comando sopra applica il piano creato dal target plan. Assicurati di eseguire prima plan per verificare le modifiche.

Ottenere Output

Recupera i valori di output dalla configurazione 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

Distruzione Infrastruttura

Per eliminare l’infrastruttura, usa il target 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

Attenzione

Questo eliminerà permanentemente tutte le risorse gestite da questa configurazione Terraform. Usa con cautela!

Distruzione Risorse Bootstrap

Per pulire le risorse bootstrap (bucket S3 per lo stato):

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

Ulteriori Informazioni

Per maggiori informazioni su Terraform, consulta la Documentazione Terraform e la Documentazione AWS Provider.