Infraestructura de Terraform

Terraform es una herramienta de código abierto para infraestructura como código que te permite crear, modificar y mejorar infraestructura de forma segura y predecible.

El generador de infraestructura Terraform crea un proyecto de infraestructura con Terraform. La aplicación generada incluye mejores prácticas de seguridad mediante verificaciones de Checkov.

Uso

Generar un proyecto Terraform

Puedes generar un nuevo proyecto Terraform de dos formas:

VSCode

1. Instale el Nx Console VSCode Plugin si aún no lo ha hecho
2. Abra la consola Nx en VSCode
3. Haga clic en Generate (UI) en la sección "Common Nx Commands"
4. Busque @aws/nx-plugin - terraform#project
5. Complete los parámetros requeridos
   • name: tf-infra
6. Haga clic en 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

También puede realizar una ejecución en seco para ver qué archivos se cambiarían

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

Opciones

Parámetro	Tipo	Predeterminado	Descripción
name Requerido	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.

Salida del generador

El generador crea diferentes estructuras de archivos según el tipo de proyecto:

Tipo Aplicación

Para proyectos de aplicación (--type=application), el generador crea una aplicación Terraform completa con gestión de estado remoto:

• Directorysrc

  • main.tf Archivo principal de configuración de Terraform
  • providers.tf Configuración de proveedores con backend S3
  • variables.tf Definiciones de variables de entrada
  • outputs.tf Definiciones de valores de salida
  • Directoryenv Archivos de variables específicas por entorno

    • dev.tfvars Variables de entorno de desarrollo
• Directorybootstrap Configuración de bootstrap para estado remoto

  • main.tf Bucket S3 y políticas para almacenamiento de estado
  • providers.tf Configuración del proveedor AWS
  • variables.tf Definiciones de variables para bootstrap
• project.json Configuración del proyecto y objetivos de build

Nota

El generador también crea una biblioteca packages/common/terraform que inicialmente solo agrega un módulo de métricas (crea un stack CloudFormation vacío con metadatos) que se instrumenta automáticamente para que el equipo de nx-plugin-for-aws pueda rastrear métricas de uso.

Tipo Biblioteca

Para proyectos de biblioteca (--type=library), el generador crea una estructura más simple para módulos Terraform reutilizables:

• Directorysrc

  • main.tf Archivo principal del módulo Terraform
• project.json Configuración del proyecto y objetivos de build

Consejo

Los proyectos de aplicación incluyen capacidades completas de despliegue con gestión de estado remoto, mientras que los proyectos de biblioteca están diseñados para crear módulos Terraform reutilizables que pueden ser consumidos por otros proyectos.

Implementando tu infraestructura Terraform

Puedes comenzar a escribir tu infraestructura Terraform en src/main.tf, por ejemplo:

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

# Declara tu infraestructura aquí
resource "aws_s3_bucket" "my_bucket" {
  bucket = "my-unique-bucket-name"
}

Dependencias entre proyectos

Si deseas ejecutar un módulo de un proyecto separado (lib), puedes hacerlo de la siguiente manera:

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

Esto actualizará automáticamente el grafo de Nx para agregar una dependencia entre tu aplicación consumidora y tu biblioteca.

Configuración de entornos

Configura variables específicas por entorno en los archivos src/env/*.tfvars.

Para agregar nuevos entornos, crea un nuevo archivo src/env/<entorno>.tfvars con las variables específicas del entorno y agrega nuevas entradas para apply, destroy, init, plan en el project.json para la nueva configuración de entorno. Por ejemplo, supongamos que queremos agregar un entorno prod:

src/env/prod.tfvars

# Variables de entorno de producción
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"]
        }
    }
}

Consejo

Por defecto, todos los objetivos asumen el entorno dev, pero puedes especificar un entorno de la siguiente manera:

• 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

También puedes cambiar de entorno en cualquier momento ya que el estado segmenta automáticamente el tfstate entre entornos.

Bootstrap de estado remoto (Solo proyectos de aplicación)

Para proyectos de aplicación, antes de desplegar tu infraestructura, necesitas inicializar el backend de estado remoto. Esto crea un bucket S3 para almacenar tus archivos de estado de 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

Asegúrate de que tu perfil de AWS CLI esté configurado para la cuenta/región donde deseas desplegar los recursos de bootstrap.

El objetivo bootstrap solo está disponible para proyectos de tipo aplicación. Los proyectos de biblioteca no requieren gestión de estado remoto ya que están diseñados para ser módulos reutilizables.

Objetivos disponibles

Los objetivos disponibles dependen del tipo de proyecto:

Objetivos comunes (Aplicación y Biblioteca)

Validar tu infraestructura

Puedes validar tu configuración Terraform usando el objetivo 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

Formatear tu código

Formatea tu código Terraform usando el objetivo 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

Pruebas de seguridad

Ejecuta verificaciones de seguridad en tu infraestructura usando Checkov con el objetivo 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

Encontrarás los resultados de las pruebas de seguridad en la carpeta dist raíz, bajo dist/packages/<mi-proyecto-terraform>/checkov.

Objetivos exclusivos de aplicación

Los siguientes objetivos solo están disponibles para proyectos de tipo aplicación:

Planificar tu infraestructura

Antes de aplicar cambios, puedes ver lo que Terraform hará ejecutando el objetivo 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

Esto creará un archivo de plan en dist/packages/<mi-proyecto-terraform>/terraform/dev.tfplan.

Inicializar Terraform

Inicializa tu directorio de trabajo de Terraform con el objetivo 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

Desplegar en AWS

Después de planificar, puedes desplegar tu infraestructura en AWS usando el objetivo 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

Consejo

El comando anterior aplica el plan creado por el objetivo plan. Asegúrate de ejecutar plan primero para revisar los cambios.

Obtener salidas

Recupera valores de salida de tu configuración 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

Destruir infraestructura

Cuando necesites eliminar tu infraestructura, usa el objetivo 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

Precaución

¡Esto eliminará permanentemente todos los recursos gestionados por esta configuración de Terraform! Usa con precaución.

Destruir recursos de bootstrap

Para limpiar los recursos de bootstrap (bucket S3 para almacenamiento de estado):

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

Más información

Para más información sobre Terraform, consulta la Documentación de Terraform y la Documentación del Proveedor AWS.