Esegui il deployment di un server web Flask di base utilizzando Terraform

In questo tutorial scoprirai come iniziare a utilizzare Terraform creando un server web di base su Compute Engine.

In questo tutorial imparerai a:

  • Utilizza Terraform per creare una VM in Google Cloud.
  • Avvia un server Flask Python di base.

Costi

In questo documento utilizzi i seguenti componenti fatturabili di Google Cloud:

Compute Engine

Per generare una stima dei costi basata sull'utilizzo previsto, utilizza il Calcolatore prezzi. I nuovi utenti di Google Cloud potrebbero essere idonei per una prova gratuita.

Al termine delle attività descritte in questo documento, puoi evitare la fatturazione continua eliminando le risorse che hai creato. Per ulteriori informazioni, consulta la sezione Pulizia.

Prima di iniziare

Preparati ad avviare il tutorial.

Seleziona o crea un progetto

  1. In the Google Cloud console, go to the project selector page.

    Go to project selector

  2. Select or create a Google Cloud project.

Configurare le autorizzazioni

Assicurati di disporre delle autorizzazioni Compute Engine necessarie nel tuo account utente:

  • compute.instances.*
  • compute.firewalls.*

Vai alla pagina IAM

Scopri di più su ruoli e autorizzazioni.

Abilita l'API

Enable the Compute Engine API.

Enable the API

Avvia Cloud Shell

Cloud Shell è una macchina virtuale Compute Engine.

Le credenziali di servizio associate a questa macchina virtuale sono automatiche, quindi non è necessario configurare o scaricare una chiave dell'account di servizio.

Terraform è integrato con Cloud Shell e Cloud Shell autentica automaticamente Terraform, consentendoti di iniziare con una configurazione ridotta.

Crea la VM Compute Engine

Innanzitutto, definisci le impostazioni della VM in un file di configurazione Terraform. Quindi, esegui i comandi Terraform per creare la VM nel tuo progetto.

Crea la directory

Crea una nuova directory. Nella nuova directory, crea un file main.tf per la configurazione di Terraform. I contenuti di questo file descrivono tutte le risorse Google Cloud da creare nel progetto.

In Cloud Shell:

mkdir tf-tutorial && cd tf-tutorial
nano main.tf

Crea la rete e la subnet del virtual private cloud

In questa sezione crei una rete e una subnet Virtual Private Cloud (VPC) per l'interfaccia di rete della VM.

Aggiungi le seguenti risorse Terraform al file main.tf che hai creato:

resource "google_compute_network" "vpc_network" {
  name                    = "my-custom-mode-network"
  auto_create_subnetworks = false
  mtu                     = 1460
}

resource "google_compute_subnetwork" "default" {
  name          = "my-custom-subnet"
  ip_cidr_range = "10.0.1.0/24"
  region        = "us-west1"
  network       = google_compute_network.vpc_network.id
}

Crea la risorsa VM Compute Engine

In questa sezione, crei un'unica istanza Compute Engine che esegue Debian. In questo tutorial utilizzi il tipo di macchina più piccolo disponibile. In un secondo momento, puoi eseguire l'upgrade a un tipo di macchina più grande.

Aggiungi la seguente risorsa Terraform google_compute_instance al file main.tf che hai creato.

# Create a single Compute Engine instance
resource "google_compute_instance" "default" {
  name         = "flask-vm"
  machine_type = "f1-micro"
  zone         = "us-west1-a"
  tags         = ["ssh"]

  boot_disk {
    initialize_params {
      image = "debian-cloud/debian-11"
    }
  }

  # Install Flask
  metadata_startup_script = "sudo apt-get update; sudo apt-get install -yq build-essential python3-pip rsync; pip install flask"

  network_interface {
    subnetwork = google_compute_subnetwork.default.id

    access_config {
      # Include this section to give the VM an external IP address
    }
  }
}

Il codice campione imposta la zona Google Cloud su us-west1-a. Puoi impostare un'altra zona.

Inizializza Terraform

A questo punto, puoi eseguire terraform init per aggiungere i plug-in necessari e compilare la directory .terraform.

terraform init

Output:

Initializing the backend...

Initializing provider plugins...
...

Terraform has been successfully initialized!

Convalida la configurazione di Terraform

Se vuoi, puoi convalidare il codice Terraform che hai creato finora. Esegui terraform plan, che esegue le seguenti operazioni:

  • Verifica che la sintassi di main.tf sia corretta
  • Mostra un'anteprima delle risorse che verranno create
terraform plan

Output:

...

Plan: 1 to add, 0 to change, 0 to destroy.

Note: You didn't use the -out option to save this plan, so Terraform can't
guarantee to take exactly these actions if you run "terraform apply" now.

Applica la configurazione

Per creare la VM, esegui terraform apply.

terraform apply

Quando richiesto, inserisci yes.

Terraform chiama le API Google Cloud per configurare la nuova VM. Controlla la pagina Istanze VM per vedere la nuova VM.

Eseguire un server web su Google Cloud

I passaggi successivi consistono nel creare un'applicazione web, eseguirne il deployment nella VM e creare una regola firewall per consentire le richieste dei client all'applicazione web.

Aggiungere una regola firewall SSH personalizzata

La regola firewall default-allow-ssh nella rete default ti consente di utilizzare SSH per connetterti alla VM. Se preferisci utilizzare la tua regola personalizzata del firewall, puoi aggiungere la seguente risorsa alla fine del file main.tf:

resource "google_compute_firewall" "ssh" {
  name = "allow-ssh"
  allow {
    ports    = ["22"]
    protocol = "tcp"
  }
  direction     = "INGRESS"
  network       = google_compute_network.vpc_network.id
  priority      = 1000
  source_ranges = ["0.0.0.0/0"]
  target_tags   = ["ssh"]
}

Esegui terraform apply per creare la regola firewall.

Connettiti alla VM con SSH

A questo punto, verifica che tutto sia configurato correttamente collegandoti alla VM con SSH.

  1. Vai alla pagina Istanze VM.

  2. Trova la VM con il nome flask-vm.

  3. Nella colonna Connetti, fai clic su SSH.

    Si apre una finestra del terminale SSH nel browser per la VM in esecuzione.

Per saperne di più, vedi Connessione alle VM.

Crea l'app Flask

Per questo tutorial, crea un'app Flask in Python in modo da avere un unico file che descriva il server web e gli endpoint di test.

  1. Nel terminale SSH in browser, crea un file denominato app.py.

    nano app.py
    
  2. Aggiungi quanto segue al file app.py:

    from flask import Flask
    app = Flask(__name__)
    
    @app.route('/')
    def hello_cloud():
      return 'Hello Cloud!'
    
    app.run(host='0.0.0.0')
    
  3. Esegui app.py:

    python3 app.py
    

    Flask gestisce il traffico su localhost:5000 per impostazione predefinita.

  4. Apri una seconda connessione SSH:

    1. Vai alla pagina Istanze VM.
    2. Individua la VM denominata flask-vm e fai clic su SSH.
  5. Nella seconda connessione SSH, esegui curl per verificare che il messaggio di benvenuto configurato in app.py venga restituito.

    curl http://0.0.0.0:5000
    

    L'output di questo comando è Hello Cloud.

Apri la porta 5000 sulla VM

Per connetterti al server web dal tuo computer locale, la VM deve avere la porta 5000 aperta. Google Cloud ti consente di aprire le porte al traffico utilizzando le regole firewall.

Aggiungi la seguente risorsa Terraform google_compute_firewall alla fine del file main.tf.

resource "google_compute_firewall" "flask" {
  name    = "flask-app-firewall"
  network = google_compute_network.vpc_network.id

  allow {
    protocol = "tcp"
    ports    = ["5000"]
  }
  source_ranges = ["0.0.0.0/0"]
}

In Cloud Shell, esegui terraform apply per creare la regola firewall.

Aggiungi una variabile di output per l'URL del server web

  1. Alla fine di main.tf, aggiungi una variabile di output Terraform per stampare l'URL del server web:

    // A variable for extracting the external IP address of the VM
    output "Web-server-URL" {
     value = join("",["http://",google_compute_instance.default.network_interface.0.access_config.0.nat_ip,":5000"])
    }
    
  2. Esegui terraform apply.

    terraform apply
    

    Quando richiesto, inserisci yes. Terraform stampa sullo schermo l'indirizzo IP esterno e la porta 5000 della VM, come segue:

    Web-server-URL = "http://IP_ADDRESS:5000"
    

    In qualsiasi momento puoi eseguire terraform output per visualizzare questo output:

    terraform output
    
  3. Fai clic sull'URL del passaggio precedente e visualizza il messaggio "Hello Cloud!".

    Ciò significa che il server è in esecuzione.

Risoluzione dei problemi

  • Se un'API richiesta non è abilitata, Terraform restituisce un errore. Il messaggio di errore include un link per abilitare l'API. Dopo aver attivato l'API, puoi eseguire nuovamente terraform apply.

  • Se non riesci a connetterti alla VM tramite SSH:

    • Assicurati di aggiungere la regola firewall SSH.
    • Assicurati che la VM includa l'argomento tags = ["ssh"].

Esegui la pulizia

Dopo aver completato il tutorial, puoi eliminare tutto ciò che hai creato per non incorrere in ulteriori costi.

Terraform ti consente di rimuovere tutte le risorse definite nel file di configurazione eseguendo il comando terraform destroy:

terraform destroy

Inserisci yes per consentire a Terraform di eliminare le risorse.

Passaggi successivi