Esegui la migrazione delle app Node.js da Heroku a Cloud Run

Configurazione dell'ambiente

1. Apri Cloud Shell.

   Apri Cloud Shell

2. In Cloud Shell, imposta le variabili di ambiente e i valori predefiniti per Google Cloud CLI utilizzato in questo tutorial.

   gcloud config set project PROJECT_ID
   gcloud config set run/region us-central1
   

   Sostituisci PROJECT_ID con l'ID progetto.

Architettura

Le seguenti figure illustrano l'architettura dell'app web su Heroku (così com'è) e il suo layout architettonico su Google Cloud (che dovrai creare).

L'app Tasks attualmente di cui è stato eseguito il deployment in Heroku è composta da uno o più dyno web. I dyno web sono in grado di ricevere e rispondere al traffico HTTP, a differenza dei dyno worker, che sono più adatti per i job in background e le attività a tempo. L'app visualizza una pagina di indice che mostra le attività archiviate in un database Postgres utilizzando la libreria di modelli Mustache per Node.js.

Puoi accedere all'app tramite un URL HTTPS. Un percorso /tasks all'URL ti consente di creare nuove attività.

Su Google Cloud, Cloud Run viene utilizzato come piattaforma serverless per eseguire il deployment dell'app Tasks. Cloud Run è progettato per eseguire container stateless e basati su richieste. È ideale quando hai bisogno che il tuo servizio gestito supporti app containerizzate che si ridimensionano automaticamente e anche a zero quando non gestiscono traffico.

Mappatura dei componenti utilizzati in Heroku a Google Cloud

La tabella seguente mappa i componenti della piattaforma Heroku a Google Cloud. Questa mappatura ti aiuta a tradurre l'architettura descritta in questo tutorial da Heroku a Google Cloud.

Eseguire il deployment dell'app web di esempio Tasks su Heroku

Le sezioni seguenti mostrano come configurare l'interfaccia a riga di comando (CLI) per Heroku, clonare il repository di origine GitHub ed eseguire il deployment dell'app su Heroku.

Configurare l'interfaccia a riga di comando per Heroku

Questo tutorial esegue la CLI Heroku in Cloud Shell e deve autenticarsi utilizzando una chiave API Heroku. Quando viene eseguito in Cloud Shell, il client Heroku CLI non può autenticarsi utilizzando una password o un'autenticazione basata sul web.

In alternativa, se esegui il sample su un terminale locale, puoi utilizzare qualsiasi metodo di autenticazione della CLI Heroku. Quando esegui il tutorial su un terminale locale, devi installare anche Google Cloud CLI, git e Docker.

1. Accedi alla console web per Heroku e poi copia il valore della chiave API dalla pagina delle impostazioni dell'account.

2. In Cloud Shell, installa l'interfaccia a riga di comando Heroku

3. In Cloud Shell, autentica la CLI di Heroku. Quando ti viene richiesta la password, inserisci il valore della chiave API che hai copiato dalla console Heroku, non la password che utilizzi per accedere alla console.

   heroku login --interactive
   

clona il repository del codice sorgente

1. In Cloud Shell, clona il repository GitHub dell'app Tasks di esempio:

   git clone https://github.com/GoogleCloudPlatform/migrate-webapp-heroku-to-cloudrun-node.git
   

2. Cambia directory e vai alla directory creata clonando il repository:

   cd migrate-webapp-heroku-to-cloudrun-node
   

   La directory contiene i seguenti file:

   • Uno script Node.js denominato index.js con il codice per i percorsi pubblicati dall'app web.
   • File package.json e package-lock.json che illustrano le dipendenze dell'app web. Devi installare queste dipendenze per eseguire l'app.
   • Un file Procfile che specifica il comando eseguito dall'app all'avvio. Puoi creare un file Procfile per eseguire il deployment dell'app su Heroku.
   • Una directory views con i contenuti HTML pubblicati dall'app web sulla route "/".
   • Un file .gitignore.

Eseguire il deployment di un'app su Heroku

1. In Cloud Shell, crea un'app Heroku:

   heroku create
   

   Prendi nota del nome creato per l'app. Ti servirà questo valore nel passaggio successivo.

2. Crea una variabile di ambiente per il nome dell'app Heroku:

   export APP_NAME=APP_NAME
   

   Sostituisci APP_NAME con il nome dell'app restituito dal comando heroku create.

3. Aggiungi il componente aggiuntivo Heroku Postgres per eseguire il provisioning di un database PostgreSQL:

   heroku addons:create heroku-postgresql:mini
   

4. Assicurati che il componente aggiuntivo sia stato aggiunto correttamente:

   heroku addons
   

   Se il componente aggiuntivo Postgres è stato aggiunto correttamente, viene visualizzato un messaggio simile al seguente:

   Add-on               Plan     Price       State
   -----------------    -----    --------    -----
   heroku-postgresql    mini     5$/month    created
   

5. Esegui il deployment dell'app su Heroku:

   git push heroku master
   

6. Esegui il seguente comando per confermare il valore di DATABASE_URL.

   heroku config
   

   Prendi nota del valore recuperato per DATABASE_URL. Ti servirà questo valore nel passaggio successivo.

7. Esegui un container Docker.

   docker run -it --rm postgres psql "DATABASE_URL"
   

   Sostituisci DATABASE_URL con l'URL di Heroku Postgres che hai annotato nel passaggio precedente.

8. Nel contenitore Docker, crea la tabella TASKS utilizzando il seguente comando:

   CREATE TABLE TASKS
   (DESCRIPTION TEXT NOT NULL);
   

9. Esci dal contenitore:

   exit
   

10. In Cloud Shell, ottieni l'URL web per la tua app Heroku eseguendo il seguente comando:

    heroku info
    

11. Apri l'URL web in una finestra del browser. L'app ha il seguente screenshot (anche se nella tua versione non sono elencate le attività):

    

12. Crea attività di esempio nella tua app dal browser. Assicurati che le attività vengano recuperate dal database e siano visibili nell'interfaccia utente.

Preparazione del codice dell'app web per la migrazione a Cloud Run

Questa sezione descrive i passaggi da completare per preparare l'app web per il deployment in Cloud Run.

Crea e pubblica il container Docker in Container Registry

Per creare il container dell'app in modo che possa essere eseguito in Cloud Run, hai bisogno di un'immagine Docker. Puoi creare il contenitore manualmente o utilizzando Buildpack.

Crea un'istanza Cloud SQL per PostgreSQL

Crea un'istanza Cloud SQL per PostgreSQL da utilizzare come backend per l'app web. In questo tutorial, PostgreSQL è l'app di esempio più adatta per il deployment su Heroku, che utilizza un database Postgres come backend. Ai fini di questa app, la migrazione a Cloud SQL per PostgreSQL da un servizio PostgreSQL gestito non richiede modifiche allo schema.

1. Prepara la rete per Cloud SQL con un indirizzo IP privato.

   gcloud compute addresses create google-managed-services-default \
     --global \
     --purpose=VPC_PEERING \
     --prefix-length=16 \
     --description="peering range for CloudSQL Private Service Access" \
     --network=default
   
   gcloud services vpc-peerings connect \
     --service=servicenetworking.googleapis.com \
     --ranges=google-managed-services-default \
     --network=default \
     --project=PROJECT_ID
   

2. Crea una variabile di ambiente denominata CLOUDSQL_DB_NAME per contenere il nome dell'istanza del database che crei nel passaggio successivo:

   export CLOUDSQL_DB_NAME=tasks-db
   

3. Crea il database:

   gcloud sql instances create $CLOUDSQL_DB_NAME \
   --cpu=1 \
   --memory=4352Mib \
   --database-version=POSTGRES_15 \
   --region=us-central1 \
   --network default \
   --no-assign-ip
   

   L'inizializzazione dell'istanza potrebbe richiedere alcuni minuti.

4. Imposta una password per l'utente Postgres:

   gcloud sql users set-password postgres \
       --instance=$CLOUDSQL_DB_NAME  \
       --password=POSTGRES_PASSWORD
   

   Sostituisci POSTGRES_PASSWORD con la password che vuoi utilizzare per il database Postgres.

Importare dati in Cloud SQL da Heroku Postgres

Esistono diversi pattern di migrazione che puoi utilizzare per eseguire la migrazione dei dati in Cloud SQL. In genere, l'approccio migliore che richiede poco o nessun tempo di riposo è configurare Cloud SQL come replica del database di cui viene eseguita la migrazione e impostare Cloud SQL come istanza principale dopo la migrazione. Heroku Postgres non supporta le repliche esterne (follower), quindi in questo tutorial utilizzerai strumenti open source per eseguire la migrazione dello schema dell'app.

Per l'app Tasks in questo tutorial, utilizzerai l'utilità pg_dump per esportare i dati da Heroku Postgres in un bucket Cloud Storage e poi importarli in Cloud SQL. Questa utility può trasferire i dati tra versioni omogenee o quando la versione del database di destinazione è più recente rispetto al database di origine.

1. In Cloud Shell, ottieni le credenziali del database per il database Heroku Postgres collegato all'app di esempio. Queste credenziali ti serviranno nel passaggio successivo.

   heroku pg:credentials:url
   

   Questo comando restituisce la stringa di informazioni di connessione e l'URL di connessione per la tua applicazione. La stringa delle informazioni di connessione ha il seguente formato:

   "dbname=DATABASE_NAME host=FQDN port=5432 user=USER_NAME password=PASSWORD_STRING sslmode=require"
   

   Nel passaggio successivo avrai bisogno dei valori mostrati nella stringa di connessione.

   Per un esempio di valore FQDN (nome di dominio completo) in una stringa di informazioni di connessione, consulta la documentazione di Heroku.

2. Imposta le variabili di ambiente per contenere i valori Heroku da utilizzare nei passaggi successivi:

   export HEROKU_PG_DBNAME=DATABASE_NAME
   export HEROKU_PG_HOST=FQDN
   export HEROKU_PG_USER=USER_NAME
   export HEROKU_PG_PASSWORD=PASSWORD_STRING
   

   Sostituisci quanto segue:

   • DATABASE_NAME: il nome del database mostrato nella stringa di informazioni.
   • FQDN: il FQDN mostrato nella stringa di informazioni.
   • USER_NAME: il nome utente visualizzato nella stringa di informazioni.
   • PASSWORD_STRING: la stringa della password mostrata nella stringa di informazioni.

3. Crea un backup in formato SQL del tuo database Heroku Postgres:

   docker run \
     -it --rm \
     -e PGPASSWORD=$HEROKU_PG_PASSWORD \
     -v $(pwd):/tmp \
     --entrypoint "pg_dump" \
     postgres \
     -Fp \
     --no-acl \
     --no-owner \
     -h $HEROKU_PG_HOST \
     -U $HEROKU_PG_USER \
     $HEROKU_PG_DBNAME > herokudump.sql
   

4. Crea una variabile di ambiente in cui inserire il nome del bucket Cloud Storage:

   export PG_BACKUP_BUCKET=gs://PROJECT_ID-pg-backup-bucket
   

5. Crea un bucket Cloud Storage:

   gcloud storage buckets create $PG_BACKUP_BUCKET \
     --location=us-central1 \
     --public-access-prevention \
     --uniform-bucket-level-access
   

6. Carica il file SQL in questo bucket:

   gcloud storage cp herokudump.sql $PG_BACKUP_BUCKET/herokudump.sql
   

7. Autorizza l'istanza Cloud SQL con i ruoli necessari per importare il file SQL dal bucket Cloud Storage:

   gcloud projects add-iam-policy-binding PROJECT_ID \
     --member=serviceAccount:$(gcloud sql instances describe $CLOUDSQL_DB_NAME --format='get("serviceAccountEmailAddress")') \
     --role=roles/storage.objectAdmin
   
   gcloud projects add-iam-policy-binding PROJECT_ID \
     --member=serviceAccount:$(gcloud sql instances describe $CLOUDSQL_DB_NAME --format='get("serviceAccountEmailAddress")') \
     --role=roles/cloudsql.editor
   

8. Importa il file SQL nell'istanza Cloud SQL:

   gcloud sql import sql $CLOUDSQL_DB_NAME $PG_BACKUP_BUCKET/herokudump.sql \
     --database=postgres \
     --user=postgres
   

   Quando è richiesto do you want to continue (y/n), inserisci "y".

In che modo Cloud Run accede al database Cloud SQL

Proprio come l'app web di cui è stato eseguito il deployment in Heroku deve connettersi all'istanza gestita di Heroku Postgres, Cloud Run richiede l'accesso a Cloud SQL per poter leggere e scrivere dati.

Cloud Run comunica con Cloud SQL utilizzando il proxy Cloud SQL che viene attivato e configurato automaticamente quando esegui il deployment del contenitore in Cloud Run. Il database non deve avere indirizzi IP esterni approvati perché tutte le comunicazioni che riceve provengono dal proxy che utilizza TCP sicuro.

Il codice deve richiamare le operazioni del database (ad esempio il recupero dei dati dal database o la scrittura al suo interno) richiamando il proxy su una socket UNIX.

Poiché questa app web è scritta in Node.js, utilizzi la libreria pg-connection-string per analizzare un URL del database e creare un oggetto config. Il vantaggio di questo approccio è che semplifica la connessione al database di backend su Heroku e Cloud Run.

Nel passaggio successivo, dovrai passare l'URL del database come variabile di ambiente quando esegui il deployment dell'app web.

Esegui il deployment dell'app di esempio in Cloud Run

1. In Cloud Shell, configura l'accesso VPC serverless per consentire il traffico privato da Cloud Run a Cloud SQL:

   gcloud compute networks subnets create serverless-connector-subnet \
   --network=default \
   --range=10.0.0.0/28 \
   --region=us-central1
   
   gcloud compute networks vpc-access connectors create serverless-connector \
   --region=us-central1 \
   --subnet=serverless-connector-subnet
   

2. In Cloud Shell, crea una variabile di ambiente che contenga il nome della connessione dell'istanza Cloud SQL che hai creato:

   export DB_CONN_NAME=$(gcloud sql instances describe $CLOUDSQL_DB_NAME --format='value(connectionName)')
   

3. Crea una variabile di ambiente denominata DATABASE_URL per contenere la stringa di connessione per connetterti al proxy Cloud SQL tramite una porta UNIX.

   export DATABASE_URL="socket:/cloudsql/${DB_CONN_NAME}?db=postgres&user=postgres&password=POSTGRES_PASSWORD"
   

4. Crea un account di servizio per Cloud Run con un ruolo IAM per connetterti al database:

   gcloud iam service-accounts create sa-run-db-client
   
   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:sa-run-db-client@PROJECT_ID.iam.gserviceaccount.com \
       --role=roles/cloudsql.client
   

5. Esegui il deployment dell'app web in Cloud Run:

   gcloud run deploy tasksapp-PROJECT_ID \
       --image=$IMAGE_NAME \
       --service-account=sa-run-db-client@PROJECT_ID.iam.gserviceaccount.com \
       --set-env-vars=DATABASE_URL=$DATABASE_URL \
       --add-cloudsql-instances $DB_CONN_NAME \
       --vpc-connector serverless-connector \
       --allow-unauthenticated
   
   

   Il comando precedente collega anche il contenitore Cloud Run all'istanza di database Cloud SQL che hai creato. Il comando imposta una variabile di ambiente per Cloud Run in modo che punti alla stringa DATABASE_URL creata nel passaggio precedente.

Test dell'applicazione

1. In Cloud Shell, recupera l'URL a cui Cloud Run pubblica il traffico:

   gcloud run services list
   

   Puoi anche esaminare il servizio Cloud Run nella console Google Cloud.

2. Assicurati che l'app web accetti le richieste HTTP visitando l'URL del servizio Cloud Run.

Cloud Run crea o avvia un nuovo contenitore quando viene inviata una richiesta HTTP all'endpoint di servizio e se non è già in esecuzione un contenitore. Ciò significa che la richiesta che causa l'avvio di un nuovo contenitore potrebbe richiedere un po' più di tempo per essere eseguita. Tieni conto del tempo aggiuntivo, del numero di richieste simultanee che la tua app può supportare e di eventuali requisiti di memoria specifici.

Per questa app, utilizza le impostazioni di contemporaneità predefinite, che consentono a un servizio Cloud Run di gestire 80 richieste contemporaneamente da un singolo container.