Terraform Infrastructure as Code · Lezione

Struttura del codice e convenzioni di denominazione

Adotti le best practice per organizzare i file e i moduli Terraform, insieme a convenzioni di denominazione coerenti per risorse e variabili.

Struttura del codice e convenzioni di denominazione è una lezione Terraform Infrastructure as Code gratuita su CoddyKit. Questa è la lezione 1 di 4. Puoi leggere la lezione completa qui gratuitamente — poi esercitati direttamente nel browser con un editor di codice integrato e un tutor IA disponibile 24/7. Fa parte del percorso di apprendimento Terraform Infrastructure as Code, e i tuoi progressi si sincronizzano tra il web e l'app CoddyKit. Il corso Terraform Infrastructure as Code include 4 lezioni in totale.

Perché strutturare il codice Terraform?

Proprio come organizzare il proprio spazio di lavoro, strutturare il codice Terraform lo rende più facile da comprendere, gestire e condividere.

Una buona struttura migliora la leggibilità, riduce gli errori e aiuta i nuovi membri del team a diventare rapidamente operativi.

File Terraform essenziali

I progetti Terraform iniziano solitamente con alcuni file fondamentali. Organizzare la configurazione in questi file è una buona pratica comune:

main.tf: definisce risorse e moduli.
variables.tf: dichiara tutte le variabili di input.
outputs.tf: definisce i valori di output dell'infrastruttura.
versions.tf: specifica le versioni di Terraform e dei provider.

Assegnare nomi alle risorse

Usare nomi coerenti facilita l'identificazione delle risorse. Segua queste linee guida generali per il nome locale (ad esempio, my_instance in resource "aws_instance" "my_instance"):

Usi nomi descrittivi: che cosa fa la risorsa?
Usi trattini o caratteri di sottolineatura: per migliorare la leggibilità (ad esempio, web-server-sg o web_server_sg).
Eviti i nomi generici: server è meno utile di app-frontend-server.

I nomi locali delle risorse Terraform devono essere univoci all'interno di un modulo.

Convenzioni per le variabili

Le variabili rendono flessibili le configurazioni. Assegnare loro nomi appropriati è fondamentale:

Minuscole con caratteri di sottolineatura: è la convenzione più comune (ad esempio, instance_type, vpc_id).
Sia specifico: che cosa controlla questa variabile?
Aggiunga descrizioni: spieghi lo scopo della variabile per maggiore chiarezza.

Dei buoni nomi per le variabili aiutano gli altri a comprendere quali input si aspetta il modulo.

Assegnare nomi ai valori di output

Gli output espongono informazioni importanti sull'infrastruttura distribuita. Assegnare loro nomi coerenti aiuta chi li utilizza:

Minuscole con caratteri di sottolineatura: come per le variabili, ad esempio web_server_ip.
Descrittivi del valore: quali informazioni forniscono?
Aggiunga descrizioni: sono essenziali per gli output dei moduli, per spiegare che cosa restituiscono.

Esempio: configurazione semplice

Questo file main.tf completo illustra buone pratiche per assegnare nomi a una risorsa, una variabile e un output. Può eseguire terraform init e terraform plan con questo file.

terraform {
  required_providers {
    null = {
      source = "hashicorp/null"
      version = "~> 3.0"
    }
  }
}

resource "null_resource" "example_web_server" {
  # Descriptive resource name
  triggers = {
    always_run = timestamp()
  }
}

variable "app_environment" {
  description = "The application's deployment environment (e.g., dev, prod)."
  type        = string
  default     = "development"
}

output "resource_unique_id" {
  description = "The unique ID of the example null resource."
  value       = null_resource.example_web_server.id
}

Strutturare i moduli Terraform

Per i componenti riutilizzabili, i moduli hanno una struttura chiara propria:

Modulo radice: la directory di livello superiore che contiene la configurazione principale.
Moduli figlio: sottodirectory, ciascuna contenente il proprio main.tf, variables.tf, outputs.tf e così via.
README.md: essenziale per spiegare lo scopo, gli input e gli output del modulo.

In questo modo i moduli restano autonomi e facili da riutilizzare.

Organizzare le cartelle del progetto

Oltre ai singoli file, il modo in cui organizza le cartelle del progetto è fondamentale, soprattutto nelle configurazioni più grandi:

Separi gli ambienti: crei cartelle dedicate per dev, staging e prod, ciascuna con la propria configurazione.
Cartella per i moduli comuni: una directory modules per i moduli personalizzati riutilizzabili.
Cartella radice per i provider: la cartella di livello superiore definisce solitamente i provider e il backend dello state.

In questo modo si previene la deriva della configurazione e si migliora la gestibilità tra i diversi ambienti.

Esempio di cartella del progetto

Un tipico progetto Terraform multiambiente potrebbe avere questa struttura, che garantisce una separazione chiara e la riutilizzabilità:

.
├── modules/
│   ├── vpc/
│   │   ├── main.tf
│   │   ├── variables.tf
│   │   └── outputs.tf
│   └── ec2-instance/
│       ├── main.tf
│       └── variables.tf
├── environments/
│   ├── dev/
│   │   └── main.tf
│   ├── staging/
│   │   └── main.tf
│   └── prod/
│       └── main.tf
└── README.md

Verifichi la Sua comprensione

Quale delle seguenti è la migliore pratica per assegnare un nome a una variabile di input Terraform che specifica il numero di istanze?

Riepilogo: struttura e denominazione

Ha imparato che un codice Terraform ben strutturato e con nomi coerenti è fondamentale per la leggibilità, la facilità di manutenzione e la collaborazione nel team.

Organizzi i file in main.tf, variables.tf e outputs.tf.
Usi nomi descrittivi, in minuscolo e con caratteri di sottolineatura, per risorse, variabili e output.
Strutturi moduli e cartelle del progetto per favorire il riutilizzo e la separazione degli ambienti.

Queste pratiche costituiscono la base per una gestione efficace dell'IaC!

Domande Frequenti

La lezione «Struttura del codice e convenzioni di denominazione» è gratuita?

Sì — il testo completo di «Struttura del codice e convenzioni di denominazione» è gratuito qui sul web. Per esercitarvi in modo interattivo (un editor di codice integrato e un tutor IA 24/7) e sbloccare il resto del corso Terraform Infrastructure as Code, passa a CoddyKit PRO. Il corso Terraform Infrastructure as Code include 4 lezioni in totale.

Cosa imparerò in «Struttura del codice e convenzioni di denominazione»?

Adotti le best practice per organizzare i file e i moduli Terraform, insieme a convenzioni di denominazione coerenti per risorse e variabili. Eserciti Terraform Infrastructure as Code con codice pratico che esegui direttamente nel browser, e un tutor IA 24/7 risponde alle tue domande mentre lavori sulla lezione.

Ho bisogno di esperienza per iniziare Terraform Infrastructure as Code?

Non è richiesta alcuna esperienza precedente. Terraform Infrastructure as Code su CoddyKit è strutturato per principianti e studenti avanzati, quindi puoi iniziare da qui o dall'inizio e procedere al tuo ritmo. Questa è la lezione 1 di 4.

Quanto tempo richiede la lezione «Struttura del codice e convenzioni di denominazione»?

La maggior parte delle lezioni CoddyKit richiede circa 5–10 minuti. Ogni lezione è breve e interattiva, quindi fai progressi costanti e riprendi esattamente da dove hai lasciato su web e app.

Posso scrivere ed eseguire codice in questa lezione Terraform Infrastructure as Code?

Sì. Ogni lezione Terraform Infrastructure as Code include un editor di codice integrato, quindi scrivi ed esegui codice reale direttamente nel tuo browser e ricevi feedback istantaneo dall'IA — nessuna configurazione locale necessaria.

Tutte le lezioni di questo corso

Struttura del codice e convenzioni di denominazione
Controllo versione con Git
Collaborazione del team e workflow
Documentazione e workflow self-service

← Torna a Terraform Infrastructure as Code