Questo tutorial descrive come eseguire la migrazione delle app web Node.js in esecuzione su Heroku a Cloud Run su Google Cloud. Questo tutorial è rivolto ad architetti e proprietari di prodotti che vogliono eseguire la migrazione delle loro app da Heroku a servizi gestiti su Google Cloud.
Cloud Run è una piattaforma di computing gestita che consente di eseguire container stateless richiamabili tramite richieste HTTP. È basato su Knative open source, che consente la portabilità tra piattaforme e supporta flussi di lavoro e standard dei container per la continuous delivery. La piattaforma Cloud Run è ben integrata con la suite di prodotti Google Cloud e semplifica la progettazione e lo sviluppo di app portatili, scalabili e resilienti.
In questo tutorial imparerai a eseguire la migrazione di un'app a Google Cloud scritta in Node.js e che utilizza Heroku Postgres come servizio di backend su Heroku. L'app web è containerizzata e ospitata in Cloud Run e utilizza Cloud SQL per PostgreSQL come livello di persistenza.
Nel tutorial utilizzi una semplice app chiamata Attività che ti consente di visualizzare e creare attività. Queste attività sono archiviate in Heroku Postgres nel deployment attuale dell'app su Heroku.
Questo tutorial presuppone che tu conosca le funzionalità di base di Heroku e che tu disponga di un account Heroku (o dell'accesso a uno). Inoltre, si presuppone che tu abbia familiarità con Cloud Run, Cloud SQL, Docker e Node.js.
Obiettivi
- Crea un'immagine Docker per eseguire il deployment dell'app in Cloud Run.
- Crea un'istanza Cloud SQL per PostgreSQL da utilizzare come backend dopo la migrazione a Google Cloud.
- Esamina il codice Node.js per capire come Cloud Run si connette a Cloud SQL e per visualizzare le modifiche al codice (se presenti) necessarie per eseguire la migrazione a Cloud Run da Heroku.
- Esegui la migrazione dei dati da Heroku Postgres a Cloud SQL per PostgreSQL.
- Esegui il deployment dell'app in Cloud Run.
- Testa l'app di cui è stato eseguito il deployment.
Costi
In questo documento utilizzi i seguenti componenti fatturabili di Google Cloud:
Per generare una stima dei costi in base all'utilizzo previsto,
utilizza il calcolatore prezzi.
Potrebbero esserti addebitati anche costi per le risorse che utilizzi su Heroku.
Prima di iniziare
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud SQL, Cloud Build, Cloud Run, Container Registry, Service Networking, Serverless VPC Access APIs.
-
Make sure that you have the following role or roles on the project: Cloud Run > Cloud Run Admin, Cloud Storage > Storage Admin, Cloud SQL > Cloud SQL Admin, Compute Engine > Compute Network Admin, Resource Manager > Project IAM Admin, Cloud Build > Cloud Build Editor, Serverless VPC Access > Serverless VPC Access Admin, Logging > Logs Viewer, Service Accounts > Service Account Admin, Service Accounts > Service Account User, and Service Usage > Service Usage Consumer
Check for the roles
-
In the Google Cloud console, go to the IAM page.
Go to IAM - Select the project.
-
In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.
- For all rows that specify or include you, check the Role column to see whether the list of roles includes the required roles.
Grant the roles
-
In the Google Cloud console, go to the IAM page.
Vai a IAM - Seleziona il progetto.
- Fai clic su Concedi l'accesso.
-
Nel campo Nuove entità, inserisci il tuo identificatore utente. In genere si tratta dell'indirizzo email di un Account Google.
- Nell'elenco Seleziona un ruolo, seleziona un ruolo.
- Per concedere altri ruoli, fai clic su Aggiungi un altro ruolo e aggiungi ogni ruolo aggiuntivo.
- Fai clic su Salva.
-
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud SQL, Cloud Build, Cloud Run, Container Registry, Service Networking, Serverless VPC Access APIs.
-
Make sure that you have the following role or roles on the project: Cloud Run > Cloud Run Admin, Cloud Storage > Storage Admin, Cloud SQL > Cloud SQL Admin, Compute Engine > Compute Network Admin, Resource Manager > Project IAM Admin, Cloud Build > Cloud Build Editor, Serverless VPC Access > Serverless VPC Access Admin, Logging > Logs Viewer, Service Accounts > Service Account Admin, Service Accounts > Service Account User, and Service Usage > Service Usage Consumer
Check for the roles
-
In the Google Cloud console, go to the IAM page.
Go to IAM - Select the project.
-
In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.
- For all rows that specify or include you, check the Role column to see whether the list of roles includes the required roles.
Grant the roles
-
In the Google Cloud console, go to the IAM page.
Vai a IAM - Seleziona il progetto.
- Fai clic su Concedi l'accesso.
-
Nel campo Nuove entità, inserisci il tuo identificatore utente. In genere si tratta dell'indirizzo email di un Account Google.
- Nell'elenco Seleziona un ruolo, seleziona un ruolo.
- Per concedere altri ruoli, fai clic su Aggiungi un altro ruolo e aggiungi ogni ruolo aggiuntivo.
- Fai clic su Salva.
-
Configurazione dell'ambiente
Apri Cloud Shell.
In Cloud Shell, imposta le variabili di ambiente e i valori predefiniti per Google Cloud CLI utilizzata 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 descrivono l'architettura dell'app web su Heroku (così com'è) e il suo layout architettonico su Google Cloud (che creerai).
L'app Tasks attualmente implementata in Heroku è costituita da una o più dyno web. I dyno web sono in grado di ricevere e rispondere al traffico HTTP, a differenza dei dyno worker, più adatti a job in background e attività programmate. L'app mostra una pagina indice che visualizza 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
a quell'URL ti consente di
creare nuove attività.
Su Google Cloud, Cloud Run viene utilizzato come piattaforma serverless per il deployment dell'app Tasks. Cloud Run è progettato per eseguire container stateless basati su richieste. È ideale quando il servizio gestito deve supportare app containerizzate che si scalano automaticamente e anche fino a zero quando non gestiscono il traffico.
Mappatura dei componenti utilizzati in Heroku 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.
Componente | Piattaforma Heroku | Google Cloud |
---|---|---|
Container | Dynos: Heroku utilizza il modello di container per creare e scalare le app Heroku. Questi container Linux sono chiamati dyno e possono essere scalati fino a un numero specificato per supportare le richieste di risorse per la tua app Heroku. Puoi scegliere tra una gamma di tipi di dyno in base ai requisiti di memoria e CPU della tua app. | Container Cloud Run: Google Cloud supporta l'esecuzione di carichi di lavoro containerizzati in container stateless che possono essere eseguiti in un ambiente completamente gestito o in cluster Google Kubernetes Engine (GKE). |
App web | App Heroku: i dyno sono i componenti di base delle app Heroku. Le app in genere sono costituite da uno o più tipi di dyno, di solito una combinazione di dyno web e worker. | Servizio Cloud Run: un'app web può essere modellata come servizio Cloud Run. Ogni servizio ottiene il proprio endpoint HTTPS e può scalare automaticamente da 0 a N in base al traffico verso l'endpoint del servizio. |
Database | Heroku Postgres è il servizio di database as a service (DaaS) di Heroku basato su PostgreSQL. | Cloud SQL è un servizio di database gestito per database relazionali su Google Cloud. |
Deployment dell'app web di esempio Tasks su Heroku
Le sezioni successive 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 eseguita in Cloud Shell, la CLI Heroku non può autenticarsi utilizzando una password o l'autenticazione basata sul web.
In alternativa, se esegui l'esempio 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.
Accedi alla console web per Heroku e poi, dalla pagina delle impostazioni dell'account, copia il valore della chiave API.
In Cloud Shell, installa la CLI di Heroku.
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
In Cloud Shell, clona il repository GitHub dell'app di esempio Tasks:
git clone https://github.com/GoogleCloudPlatform/migrate-webapp-heroku-to-cloudrun-node.git
Passa 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 le route pubblicate dall'app web. - file
package.json
epackage-lock.json
che delineano le dipendenze dell'app web. Devi installare queste dipendenze affinché l'app venga eseguita. - Un file
Procfile
che specifica il comando che l'app esegue all'avvio. Crea un fileProcfile
per eseguire il deployment dell'app su Heroku. - Una directory
views
, con i contenuti HTML pubblicati dall'app web sulla route "/". - Un file
.gitignore
.
- Uno script Node.js denominato
Eseguire il deployment di un'app in Heroku
In Cloud Shell, crea un'app Heroku:
heroku create
Prendi nota del nome creato per l'app. Ti servirà nel passaggio successivo.
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 comandoheroku create
.Aggiungi il componente aggiuntivo Heroku Postgres per eseguire il provisioning di un database PostgreSQL:
heroku addons:create heroku-postgresql:mini
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
Esegui il deployment dell'app su Heroku:
git push heroku master
Esegui questo comando per verificare il valore di DATABASE_URL.
heroku config
Prendi nota del valore recuperato per DATABASE_URL. Ti servirà nel passaggio successivo.
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.Nel container Docker, crea la tabella
TASKS
utilizzando questo comando:CREATE TABLE TASKS (DESCRIPTION TEXT NOT NULL);
Esci dal container:
exit
In Cloud Shell, ottieni l'URL web per la tua app Heroku eseguendo questo comando:
heroku info
Apri l'URL web in una finestra del browser. L'app ha l'aspetto dello screenshot seguente (anche se la tua versione non avrà le attività elencate):
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 in dettaglio i passaggi da completare per preparare l'app web per il deployment su 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 container manualmente o utilizzando Buildpack.
Crea il container manualmente
In Cloud Shell, crea un Dockerfile nella directory creata clonando il repository per questo tutorial:
cat <<"EOF" > Dockerfile # Use the official Node image. # https://hub.docker.com/_/node FROM node:10-alpine # Create and change to the app directory. WORKDIR /app # Copying this separately prevents re-running npm install on every code change. COPY package*.json ./ RUN npm install # Copy local code to the container image. COPY . /app # Configure and document the service HTTP port. ENV PORT 8080 EXPOSE $PORT # Run the web service on container startup. CMD ["npm", "start"] EOF
Crea il container con Cloud Build e pubblica l'immagine in Container Registry:
gcloud builds submit --tag gcr.io/PROJECT_ID/APP_NAME:1 \ --gcs-log-dir=gs://PROJECT_ID_cloudbuild
Crea una variabile di ambiente in cui inserire il nome dell'immagine Docker che hai creato:
export IMAGE_NAME="gcr.io/PROJECT_ID/APP_NAME:1"
Crea il container con i buildpack
In Cloud Shell, installa la CLI pack.
Imposta l'interfaccia a riga di comando pack in modo che utilizzi il builder Heroku per impostazione predefinita:
pack config default-builder heroku/buildpacks:22
Crea una variabile di ambiente per contenere il nome dell'immagine Docker:
export IMAGE_NAME=gcr.io/PROJECT_ID/APP_NAME:1
Crea l'immagine utilizzando il comando
pack
ed esegui il push o la pubblicazione dell'immagine in Container Registry:pack build --publish $IMAGE_NAME
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 è più adatto come app di esempio di cui è stato eseguito 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 Postgres gestito non richiede modifiche allo schema.
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
Crea una variabile di ambiente denominata
CLOUDSQL_DB_NAME
in cui inserire il nome dell'istanza del database che crei nel passaggio successivo:export CLOUDSQL_DB_NAME=tasks-db
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.
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 tempi di inattività minimi o nulli consiste nel configurare Cloud SQL come replica del database di cui viene eseguita la migrazione e rendere Cloud SQL l'istanza principale dopo la migrazione. Heroku Postgres non supporta le repliche esterne (follower), quindi in questo tutorial utilizzi strumenti open source per eseguire la migrazione dello schema dell'app.
Per l'app Tasks in questo tutorial, utilizzi l'utilità pg_dump per esportare i dati da Heroku Postgres a un bucket Cloud Storage e poi importarli in Cloud SQL. Questa utilità può trasferire i dati tra versioni omogenee o quando la versione del database di destinazione è più recente rispetto al database di origine.
In Cloud Shell, recupera le credenziali del database per il database Heroku Postgres collegato all'app di esempio. 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 di 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 ti serviranno i 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.
Imposta le variabili di ambiente in modo che contengano i valori di Heroku che utilizzerai 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 nome di dominio completo mostrato nella stringa di informazioni.USER_NAME
: il nome utente mostrato nella stringa di informazioni.PASSWORD_STRING
: la stringa della password mostrata nella stringa di informazioni.
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
Crea una variabile di ambiente in cui inserire il nome del tuo bucket Cloud Storage:
export PG_BACKUP_BUCKET=gs://PROJECT_ID-pg-backup-bucket
Crea un bucket Cloud Storage:
gcloud storage buckets create $PG_BACKUP_BUCKET \ --location=us-central1 \ --public-access-prevention \ --uniform-bucket-level-access
Carica il file SQL in questo bucket:
gcloud storage cp herokudump.sql $PG_BACKUP_BUCKET/herokudump.sql
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
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".
Come Cloud Run accede al database Cloud SQL
Proprio come l'app web di cui è stato eseguito il deployment su 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 container in Cloud Run. Il database non deve avere indirizzi IP esterni approvati perché tutta la comunicazione che riceve proviene dal proxy tramite TCP sicuro.
Il codice deve richiamare operazioni di database (come il recupero di dati dal database o la scrittura nel database) richiamando il proxy su un 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 la connessione al database di backend è perfetta su Heroku e Cloud Run.
Nel passaggio successivo, trasmetti 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
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
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)')
Crea una variabile di ambiente chiamata
DATABASE_URL
per contenere la stringa di connessione per connettersi al proxy Cloud SQL tramite una porta UNIX.export DATABASE_URL="socket:/cloudsql/${DB_CONN_NAME}?db=postgres&user=postgres&password=POSTGRES_PASSWORD"
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
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 container Cloud Run all'istanza del database Cloud SQL che hai creato. Il comando imposta una variabile di ambiente per Cloud Run in modo che punti alla stringa
DATABASE_URL
che hai creato nel passaggio precedente.
Test dell'applicazione
In Cloud Shell, recupera l'URL in cui Cloud Run gestisce il traffico:
gcloud run services list
Puoi anche esaminare il servizio Cloud Run nella consoleGoogle Cloud .
Assicurati che la tua app web accetti le richieste HTTP accedendo all'URL del servizio Cloud Run.
Cloud Run crea, o avvia, un nuovo container quando viene inviata una richiesta HTTP all'endpoint di pubblicazione e se un container non è già in esecuzione. Ciò significa che la richiesta che causa l'avvio di un nuovo container potrebbe richiedere un po' più di tempo per essere servita. Considerando il tempo aggiuntivo, tieni conto del numero di richieste simultanee che la tua app può supportare e di eventuali requisiti di memoria specifici.
Per questa app, utilizzi le impostazioni di contemporaneità predefinite, che consentono a un servizio Cloud Run di gestire 80 richieste contemporaneamente da un singolo container.
Esegui la pulizia
Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questo tutorial. Potresti anche voler eliminare le risorse create in Heroku per questo tutorial.
Elimina il progetto Google Cloud
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.
Eliminare l'app Heroku
Per eliminare l'app di esempio di cui hai eseguito il deployment su Heroku e il componente aggiuntivo PostgreSQL associato, esegui questo comando:
heroku apps:destroy -a APP_NAME
Passaggi successivi
- Scopri di più sull'importazione di dati in Cloud SQL.
- Esplora la documentazione di Cloud Run.