Creazione di una configurazione Terraform

Quando curi le soluzioni del catalogo dei servizi per la tua organizzazione, puoi creare una configurazione Terraform o config, che gli utenti eseguono il deployment utilizzando Terraform. Dopo aver creato la configurazione, puoi condividerla con gli utenti assegnandola ai cataloghi.

In questa guida utilizzi Cloud Build per eseguire i comandi Terraform nell'ultima versione dell'immagine Docker di Terraform e Cloud Storage per archiviare e gestire le risorse Terraform, come i moduli e i file di stato.

Per risorse e indicazioni sull'utilizzo di Terraform, consulta Utilizzare Terraform con Google Cloud.

Prima di iniziare

  • Devi disporre dei seguenti ruoli IAM (Identity and Access Management):

    • Amministratore catalogo OPPURE Gestore catalogo per l'Google Cloud organizzazione associata al Google Cloud progetto in cui è attivato il catalogo dei servizi. Se non disponi di questo ruolo, contatta l'amministratore dell'organizzazione per richiedere l'accesso.
    • Amministratore archiviazione per il Google Cloud progetto in cui vuoi creare la soluzione. Se la configurazione Terraform si trova in un progetto diverso, devi disporre anche del ruolo Amministratore archiviazione per il progetto che contiene la configurazione Terraform.
    • Editor build Cloud per il Google Cloud progetto in cui vuoi creare la soluzione.

    Se prevedi di utilizzare il tuo account di servizio, devi disporre anche del ruolo Utente account di servizio per il progetto Google Cloud che contiene l'account di servizio che prevedi di utilizzare.

    Se non disponi di questi ruoli, contatta l'amministratore dell'organizzazione per richiedere l'accesso.

  • Se prevedi di utilizzare il tuo account di servizio, questo deve avere i seguenti ruoli IAM:

    • Amministratore archiviazione per il Google Cloud progetto in cui vuoi creare la soluzione. Se la configurazione Terraform si trova in un progetto diverso, l'account di servizio deve avere anche il ruolo Visualizzatore oggetti Storage per il progetto contenente la configurazione Terraform.
    • Logs Writer per il Google Cloud progetto in cui vuoi creare la soluzione.

    Se non disponi di questi ruoli, contatta l'amministratore dell'organizzazione per richiedere l'accesso.

  • Configura Cloud Build nel progetto in cui stai creando la configurazione:

    1. Enable the Cloud Build API.

      Enable the API

      L'attivazione dell'API crea automaticamente un account di servizio Cloud Build che utilizzerai nel passaggio successivo.
    2. Vai alla pagina Cloud Build.
    3. Nel riquadro a sinistra, seleziona Impostazioni.
    4. Utilizza l'account di servizio fornito nella sezione Indirizzo email dell'account di servizio.
    5. Se non utilizzi il tuo account di servizio, concedi all'account di servizio i seguenti ruoli IAM. Per la procedura per concedere i ruoli, consulta Configurare l'accesso per l'account di servizio Cloud Build.

Caricamento dei file di configurazione su Cloud Storage

Utilizzi Cloud Storage per gestire i file di configurazione di Terraform per il Catalogo di servizi.

Creazione di un bucket Cloud Storage

Per configurare Cloud Storage, crea un bucket nello stesso progetto in cui hai attivato Service Catalog per la tua organizzazione:

  1. In the Google Cloud console, go to the Cloud Storage Buckets page.

    Go to Buckets page

  2. Click Create bucket.
  3. On the Create a bucket page, enter your bucket information. To go to the next step, click Continue.
    • For Name your bucket, enter a name that meets the bucket naming requirements.
    • For Choose where to store your data, do the following:
      • Select a Location type option.
      • Select a Location option.
    • For Choose a default storage class for your data, select a storage class.
    • For Choose how to control access to objects, select an Access control option.
    • For Advanced settings (optional), specify an encryption method, a retention policy, or bucket labels.
  4. Click Create.

Attivazione del controllo delle versioni degli oggetti

Devi utilizzare il controllo delle versioni degli oggetti per il bucket per proteggere la configurazione Terraform dall'eliminazione o dalla sovrascrittura. Per attivare il controllo delle versioni degli oggetti, consulta la documentazione di Cloud Storage sull'utilizzo del controllo delle versioni degli oggetti.

Concedere l'accesso al bucket

Quando gli utenti della tua organizzazione eseguono il deployment della configurazione, il loro account di servizio Cloud Build deve disporre dell'accesso in lettura al tuo bucket. Se il bucket è archiviato nello stesso progetto Google Cloud in cui gli utenti eseguono il deployment della configurazione, l'account di servizio dispone già di questo accesso.

Se i tuoi utenti eseguono il deployment della configurazione in un altro progetto Google Cloud, concedi l'accesso al bucket utilizzando uno dei seguenti metodi:

  • Concedi il ruolo Visualizzatore oggetti archiviazione (roles/storage.objectViewer) agli account di servizio Cloud Build dei tuoi utenti o a una Google Cloud risorsa in cui i tuoi utenti eseguono il deployment di configurazioni Terraform, ad esempio un progetto, una cartella o un'organizzazione.

  • Utilizza un elenco di controllo dell'accesso (ACL) per gestire l'accesso al bucket.

Per informazioni dettagliate sulla gestione dell'accesso ai bucket, consulta la Panoramica del controllo dell'accesso di Cloud Storage.

Creazione e caricamento di un modulo Terraform

Dopo aver configurato il bucket Cloud Storage, devi creare e caricare un modulo Terraform, che è un contenitore di tutti i tuoi file di configurazione. Service Catalog utilizza il modulo per generare automaticamente un file dello schema JSON per definire le variabili della configurazione.

Quando chiami i moduli esterni alla directory corrente, utilizza il percorso remoto anziché un percorso relativo. Ad esempio, invece di source = "../../", utilizza source = "GoogleCloudPlatform/cloud-run/google".

Per i moduli dei casi d'uso Google Cloud comuni, consulta i blueprint e i moduli Terraform per Google Cloud.

Il seguente esempio di codice illustra un file di configurazione Terraform, main.tf:


variable "machine_type" {
  type    = string
  default = "n1-standard-1"
}

variable "zone" {
  type    = string
  default = "us-central1-a"
}

variable "deployment_identifier" {
  description = "The unique name for your instance"
  type        = string
}

resource "google_compute_instance" "default" {
  name         = "vm-${var.deployment_identifier}"
  machine_type = var.machine_type
  zone         = var.zone

  boot_disk {
    device_name = "boot"
    auto_delete = true
    initialize_params {
      image = "debian-cloud/debian-11"
    }
  }

  network_interface {
    network = "default"
    access_config {
      // Ephemeral IP
    }
  }
}

Dopo aver creato il modulo, comprimi i file in un file ZIP. Assicurati che il modulo sia archiviato nella radice del file ZIP.

Per garantire lo stoccaggio corretto del modulo quando comprimi i file Terraform, esegui il seguente comando: none zip solution.zip file1.tf file2.tf file3.tf

Quindi, carica il file ZIP nel bucket. Per la procedura di caricamento del file ZIP, consulta la documentazione di Cloud Storage relativa al caricamento di oggetti.

Creazione della configurazione nel catalogo dei servizi

Dopo aver configurato un bucket Cloud Storage con il tuo modulo Terraform, crea una soluzione di Service Catalog che includa il bucket.

Per creare la configurazione Terraform come soluzione di Service Catalog:

  1. Vai alla pagina Soluzioni dell'Amministrazione di Service Catalog nella console Google Cloud.
    Vai alla pagina Soluzioni

  2. Per scegliere il Google Cloud progetto, fai clic su Seleziona.

  3. Fai clic su Crea soluzione. Nell'elenco a discesa, seleziona Crea configurazione Terraform.

  4. Inserisci un nome, una descrizione e un slogan per la configurazione Terraform. Il slogan è una breve descrizione di una soluzione che gli utenti visualizzano mentre navigano nel catalogo dei servizi.

  5. Nel campo Link alla configurazione Terraform, fornisci il link al bucket Cloud Storage che contiene il file ZIP per il modulo Terraform, ad esempio gs://my-terraform-bucket/my-zip-file.zip.

  6. (Facoltativo) Carica un'icona per la soluzione. Le dimensioni consigliate per un'icona sono 80 x 80 pixel.

  7. Se vuoi, inserisci un link all'assistenza e i dati di contatto del creator.

  8. Se vuoi, aggiungi un link alla documentazione della soluzione.

  9. Seleziona la versione di Terraform che vuoi utilizzare per eseguire il deployment della soluzione.

  10. Se vuoi, puoi fornire il tuo account di servizio facendo clic sulla casella di controllo accanto a Seleziona o inserisci il tuo account di servizio. Se il tuo account di servizio si trova nello stesso Google Cloud progetto in cui stai creando la soluzione, seleziona Seleziona un account di servizio dal progetto attuale e poi il tuo account di servizio dal menu a discesa. Se il tuo account di servizio si trova Google Cloud in un progetto diverso da quello della tua soluzione, seleziona Inserisci l'email di un account di servizio da qualsiasi progetto e inserisci l'email del tuo account di servizio.

  11. Fai clic su CREA.

La soluzione viene creata e visualizzata nella pagina Soluzioni dell'Amministrazione del catalogo dei servizi.

Il seguente screenshot mostra la creazione di una configurazione Terraform:

Crea una configurazione Terraform

Passaggi successivi