Sviluppo InnerLoop con NodeJS

1. Panoramica

Questo lab mostra funzionalità e capacità progettate per semplificare il workflow di sviluppo per gli ingegneri software incaricati di sviluppare applicazioni NodeJS in un ambiente containerizzato. Il tipico sviluppo di container richiede all'utente di comprendere i dettagli dei container e il processo di compilazione dei container. Inoltre, gli sviluppatori in genere devono interrompere il flusso di lavoro, uscire dall'IDE per testare ed eseguire il debug delle applicazioni in ambienti remoti. Con gli strumenti e le tecnologie menzionati in questo tutorial, gli sviluppatori possono lavorare in modo efficace con le applicazioni in contenitori senza uscire dall'IDE.

Cosa imparerai a fare

In questo lab imparerai i metodi per sviluppare con i container in Google Cloud, tra cui:

Creazione di un'applicazione Node.js iniziale
Configurazione dell'applicazione Node.js per lo sviluppo di container
Codifica di un semplice servizio REST CRUD
Deployment in GKE
Eseguire il debug di uno stato di errore
Utilizzo di punti di interruzione / log
Deployment a caldo delle modifiche in GKE
(Facoltativo) Integrare Cloud SQL per la persistenza del backend

2. Configurazione e requisiti

Configurazione dell'ambiente autonomo

Accedi alla console Google Cloud e crea un nuovo progetto o riutilizzane uno esistente. Se non hai ancora un account Gmail o Google Workspace, devi crearne uno.

Il nome del progetto è il nome visualizzato per i partecipanti a questo progetto. È una stringa di caratteri non utilizzata dalle API di Google e puoi aggiornarla in qualsiasi momento.
L'ID progetto deve essere univoco in tutti i progetti Google Cloud ed è immutabile (non può essere modificato dopo essere stato impostato). Cloud Console genera automaticamente una stringa univoca, di solito non ti interessa di cosa si tratta. Nella maggior parte dei codelab, devi fare riferimento all'ID progetto (che in genere è identificato come PROJECT_ID), quindi, se non ti piace, generane un altro casuale oppure puoi provare il tuo e vedere se è disponibile. Viene "congelato" dopo la creazione del progetto.
Esiste un terzo valore, un numero di progetto, utilizzato da alcune API. Scopri di più su tutti e tre questi valori nella documentazione.

Successivamente, devi abilitare la fatturazione in Cloud Console per utilizzare le risorse/API Cloud. L'esecuzione di questo codelab non dovrebbe costare molto, se non nulla. Per arrestare le risorse in modo da non incorrere in costi di fatturazione al termine di questo tutorial, segui le istruzioni di "pulizia" riportate alla fine del codelab. I nuovi utenti di Google Cloud possono beneficiare del programma prova senza costi di 300$.

Avvia l'editor di Cloud Shell

Questo lab è stato progettato e testato per l'utilizzo con l'editor di Google Cloud Shell. Per accedere all'editor:

accedi al tuo progetto Google all'indirizzo https://console.cloud.google.com.
Nell'angolo in alto a destra, fai clic sull'icona dell'editor Cloud Shell.

Si aprirà un nuovo riquadro nella parte inferiore della finestra.
Fai clic sul pulsante Apri editor.

L'editor si aprirà con un explorer a destra e l'editor nell'area centrale
Nella parte inferiore dello schermo dovrebbe essere disponibile anche un riquadro del terminale
Se il terminale NON è aperto, utilizza la combinazione di tasti "Ctrl + `" per aprire una nuova finestra del terminale.

Configura gcloud

In Cloud Shell, imposta l'ID progetto e la regione in cui vuoi eseguire il deployment dell'applicazione. Salvali come variabili PROJECT_ID e REGION.

export PROJECT_ID=$(gcloud config get-value project)
export PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID --format='value(projectNumber)')

Configura il cluster GKE e il database

Scarica lo script di configurazione e rendilo eseguibile.

wget https://raw.githubusercontent.com/GoogleCloudPlatform/container-developer-workshop/main/labs/nodejs/setup.sh
chmod +x setup.sh

Esegui il provisioning dell'infrastruttura utilizzata in questo lab

In questo lab eseguirai il deployment del codice in GKE e accederai ai dati archiviati in un database Spanner. Lo script di configurazione riportato di seguito prepara questa infrastruttura per te.

Apri il file setup.sh e modifica i valori delle password attualmente impostate su CHANGEME
Esegui lo script di configurazione per creare un cluster GKE e un database Cloud SQL che utilizzerai in questo lab

./setup.sh

In Cloud Shell, crea una nuova directory con il nome mynodejsapp.

mkdir mynodejsapp

Passa a questa directory e aprila come workspace. L'editor verrà ricaricato creando una configurazione dello spazio di lavoro nella cartella appena creata.

cd mynodejsapp && cloudshell workspace .

Installa Node e NPM utilizzando NVM.

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
        
        # This loads nvm bash_completion
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"  # This loads nvm
[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"  

nvm install stable

nvm alias default stable

3. Crea una nuova applicazione iniziale

Inizializzare l'applicazione

Creazione di un file package.json eseguendo il seguente comando

npm init

    Choose the entry point: (index.js) src/index.js and default values for the rest of the parameters. This will create the file with following contents

{
  "name": "mynodejsapp",
  "version": "1.0.0",
  "description": "",
  "main": "src/index.js",,
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

Aggiungere un punto di accesso

Modifica questo file per includere il comando di avvio nello script "start": "node src/index.js",. Dopo la modifica, gli script dovrebbero avere l'aspetto dello snippet di codice riportato di seguito:

"scripts": {
    "start": "node src/index.js",
    "test": "echo \"Error: no test specified\" && exit 1"
  },

Aggiungere la dipendenza Express

Il codice che aggiungeremo utilizza anche express, quindi aggiungiamo questa dipendenza al file package.json. Dopo tutte le modifiche, il file package.json dovrebbe essere come mostrato di seguito.

{
  "name": "mynodejsapp",
  "version": "1.0.0",
  "description": "",
  "main": "src/index.js",
  "scripts": {
    "start": "node src/index.js",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Your Name",
  "license": "ISC",
  "dependencies": {
    "express": "^4.16.4"
  }
}

Crea il file index.js

Crea una directory di origine denominata src

Crea src/index.js con il seguente codice

const express = require('express');
const app = express();
const PORT = 8080;

app.get('/', (req, res) => {
    var message="Greetings from Node";
    res.send({ message: message });
  });

app.listen(PORT, () => {
  console.log(`Server running at: http://localhost:${PORT}/`);

});

Tieni presente che la porta è impostata sul valore 8080

Genera manifest

Skaffold fornisce strumenti integrati per semplificare lo sviluppo dei container. In questo passaggio inizializzerai Skaffold, che creerà automaticamente i file YAML di base di Kubernetes. Esegui il comando riportato di seguito per iniziare la procedura.

Esegui questo comando nel terminale

skaffold init --generate-manifests

Quando richiesto:

Inserisci 8080 per la porta.
Inserisci y per salvare la configurazione.

Allo spazio di lavoro vengono aggiunti due file: skaffold.yaml e deployment.yaml

Aggiorna il nome dell'app

I valori predefiniti inclusi nella configurazione non corrispondono attualmente al nome dell'applicazione. Aggiorna i file in modo che facciano riferimento al nome dell'applicazione anziché ai valori predefiniti.

Modificare le voci nella configurazione di Skaffold

Apri skaffold.yaml
Seleziona il nome dell'immagine attualmente impostata come package-json-image
Fai clic con il tasto destro del mouse e scegli Modifica tutte le occorrenze.
Digita il nuovo nome come mynodejsapp

Modificare le voci nella configurazione di Kubernetes

Apri il file deployment.yaml
Seleziona il nome dell'immagine attualmente impostata come package-json-image
Fai clic con il tasto destro del mouse e scegli Modifica tutte le occorrenze.
Digita il nuovo nome come mynodejsapp

Nota che nel file skaffold.yaml, la sezione build utilizza buildpacks per inserire l'applicazione in un container. Questo codice non ha Dockerfile e lo sviluppatore non ha bisogno di alcuna conoscenza di Docker per creare il container di questa applicazione.

Inoltre, la sincronizzazione rapida viene attivata automaticamente tra l'editor e il container in esecuzione da questa configurazione di Skaffold. Non è necessaria alcuna configurazione aggiuntiva per attivare la sincronizzazione rapida.

4. Esaminare il processo di sviluppo

In questa sezione, seguirai alcuni passaggi utilizzando il plug-in Cloud Code per apprendere le procedure di base e convalidare la configurazione e la configurazione dell'applicazione iniziale.

Cloud Code si integra con Skaffold per semplificare il processo di sviluppo. Quando esegui il deployment in GKE nei passaggi successivi, Cloud Code e Skaffold creeranno automaticamente l'immagine container, eseguiranno il push in Container Registry e poi eseguiranno il deployment dell'applicazione in GKE. Questa operazione avviene dietro le quinte, astraendo i dettagli dal flusso dello sviluppatore. Cloud Code migliora anche il processo di sviluppo fornendo funzionalità di debug e sincronizzazione rapida tradizionali allo sviluppo basato su container.

Eseguire il deployment in Kubernetes

Nel riquadro in fondo all'editor di Cloud Shell, seleziona Cloud Code.

Nel riquadro visualizzato in alto, seleziona Esegui su Kubernetes. Se richiesto, seleziona Sì per utilizzare il contesto Kubernetes attuale.

La prima volta che esegui il comando, nella parte superiore dello schermo viene visualizzato un prompt che ti chiede se vuoi utilizzare il contesto Kubernetes attuale. Seleziona "Sì" per accettare e utilizzare il contesto attuale.

Successivamente, verrà visualizzato un prompt che chiede quale registro dei container utilizzare. Premi Invio per accettare il valore predefinito fornito.

Seleziona la scheda Output nel riquadro inferiore per visualizzare l'avanzamento e le notifiche.

Seleziona "Kubernetes: Run/Debug - Detailed" (Kubernetes: esecuzione/debug - dettagliato) nel menu a discesa del canale a destra per visualizzare ulteriori dettagli e i log in streaming live dai container.

Torna alla visualizzazione semplificata selezionando "Kubernetes: Run/Debug" (Kubernetes: esegui/debug) dal menu a discesa.
Al termine della build e dei test, nella scheda Output viene visualizzato il messaggio Resource deployment/mynodejsapp status completed successfully e viene elencato un URL: "Forwarded URL from service demo-app: http://localhost:8080"
Nel terminale Cloud Code, passa il mouse sopra l'URL nell'output (http://localhost:8080) e poi seleziona Apri anteprima web nel suggerimento visualizzato.

La risposta sarà:

{"message":"Greetings from Node"}

Ricaricamento rapido

Vai a src/index.js. Modifica il codice del messaggio di saluto in 'Hello from Node'

Nota immediatamente che nella finestra Output, nella visualizzazione Kubernetes: Run/Debug, il watcher sincronizza i file aggiornati con il container in Kubernetes

Update initiated
File sync started for 1 files for gcr.io/myproject/mynodejsapp:latest@sha256:f554756b3b4d6c301c4b26ef96102227cfa2833270db56241248ae42baa1971a
File sync succeeded for 1 files for gcr.io/myproject/mynodejsapp:latest@sha256:f554756b3b4d6c301c4b26ef96102227cfa2833270db56241248ae42baa1971a
Update succeeded

Se passi alla visualizzazione Kubernetes: Run/Debug - Detailed, noterai che riconosce le modifiche ai file e riavvia il nodo

files modified: [src/index.js]
Copying files:map[src/index.js:[/workspace/src/index.js]]togcr.io/myproject/mynodejsapp:latest@sha256:f554756b3b4d6c301c4b26ef96102227cfa2833270db56241248ae42baa1971a
Syncing 1 files for gcr.io/myproject/mynodejsapp:latest@sha256:f554756b3b4d6c301c4b26ef96102227cfa2833270db56241248ae42baa1971a
Watching for changes...
[mynodejsapp]
[mynodejsapp]> mynodejsapp@1.0.0 start /workspace
[mynodejsapp]> node src/index.js
[mynodejsapp]
[mynodejsapp]Server running at: http://localhost:8080/

Aggiorna il browser per visualizzare i risultati aggiornati.

Debug

Vai alla visualizzazione Debug e interrompi il thread corrente .
Fai clic su Cloud Code nel menu in basso e seleziona Debug on Kubernetes per eseguire l'applicazione in modalità debug.

Nella visualizzazione Kubernetes Run/Debug - Detailed della finestra Output, nota che Skaffold eseguirà il deployment di questa applicazione in modalità di debug.
La creazione e il deployment dell'applicazione richiedono un paio di minuti. Questa volta noterai un debugger collegato.

Port forwarding pod/mynodejsapp-6bbcf847cd-vqr6v in namespace default, remote port 9229 -> http://127.0.0.1:9229
[mynodejsapp]Debugger attached.

Il colore della barra di stato inferiore cambia da blu ad arancione, indicando che è in modalità di debug.
Nella visualizzazione Kubernetes Run/Debug, nota che viene avviato un container di cui è possibile eseguire il debug

**************URLs*****************
Forwarded URL from service mynodejsapp-service: http://localhost:8080
Debuggable container started pod/mynodejsapp-deployment-6bc7598798-xl9kj:mynodejsapp (default)
Update succeeded
***********************************

Utilizzare i punti di interruzione

Apri src/index.js
Individua l'istruzione var message="Greetings from Node";.
Aggiungi un punto di interruzione a quella riga facendo clic sullo spazio vuoto a sinistra del numero di riga. Viene visualizzato un indicatore rosso per indicare che il punto di interruzione è impostato
Ricarica il browser e nota che il debugger interrompe il processo nel punto di interruzione e ti consente di esaminare le variabili e lo stato dell'applicazione in esecuzione in remoto in GKE
Fai clic nella sezione delle variabili fino a trovare la variabile "message".
Esegui la riga premendo Step over (Passa sopra) .
Osserva il valore attuale della variabile "message" che cambia in "Greetings from Node"
Fai doppio clic sul nome della variabile "target" e, nel popup, modifica il valore in qualcosa di diverso, ad esempio "Hello from Node".
Fai clic sul pulsante Continua nel pannello di controllo del debug
Controlla la risposta nel browser, che ora mostra il valore aggiornato appena inserito.
Arresta la modalità "Debug" premendo il pulsante di arresto e rimuovi il punto di interruzione facendo di nuovo clic su di esso.

5. Sviluppo di un semplice servizio REST CRUD

A questo punto, l'applicazione è completamente configurata per lo sviluppo containerizzato e hai esaminato il flusso di lavoro di sviluppo di base con Cloud Code. Nelle sezioni seguenti metterai in pratica ciò che hai imparato aggiungendo endpoint del servizio REST che si connettono a un database gestito in Google Cloud.

Configura le dipendenze

Il codice dell'applicazione utilizza un database per archiviare i dati del servizio REST. Assicurati che le dipendenze siano disponibili aggiungendo quanto segue nel file package.json

Aggiungi altre due dipendenze pg e sequelize al file package.json per creare un'applicazione CRUD Postgres. La sezione delle dipendenze dopo aver caricato le modifiche avrebbe il seguente aspetto.

    "dependencies": {
    "express": "^4.16.4",
    "pg": "^8.7.3",
    "sequelize": "^6.17.0"
  }

Codifica del servizio REST

Aggiungi il codice dell'applicazione CRUD a questa applicazione

wget -O app.zip https://github.com/GoogleCloudPlatform/container-developer-workshop/raw/main/labs/nodejs/app.zip

unzip app.zip

Questo codice ha

Cartella models con il modello di entità per item
Cartella controllers con il codice che esegue le operazioni CRUD
Cartella routes che indirizza pattern URL specifici a chiamate diverse
Cartella config con i dettagli di connettività del database

Tieni presente che la configurazione del database nel file db.config.js fa riferimento alle variabili di ambiente che devono essere fornite per connettersi al database. Inoltre, devi analizzare la richiesta in arrivo per la codifica URL.
Aggiungi il seguente snippet di codice in src/index.js per poter connetterti al codice CRUD dal file JavaScript principale subito prima dell'ultima sezione che inizia con app.listen(PORT, () => {

const bodyParser = require('body-parser')
app.use(bodyParser.json())
app.use(
 bodyParser.urlencoded({
   extended: true,
 })
)
const db = require("../app/models");
db.sequelize.sync();
require("../app/routes/item.routes")(app);

Modifica il deployment nel file deployment.yaml per aggiungere le variabili di ambiente per fornire le informazioni di connettività del database.

Aggiorna la voce della specifica alla fine del file in modo che corrisponda alla seguente definizione

    spec:
      containers:
      - name: mynodejsapp
        image: mynodejsapp
        env:
        - name: DB_HOST
          value: ${DB_INSTANCE_IP}        
        - name: DB_PORT
          value: "5432"  
        - name: DB_USER
          valueFrom:
            secretKeyRef:
              name: gke-cloud-sql-secrets
              key: username
        - name: DB_PASS
          valueFrom:
            secretKeyRef:
              name: gke-cloud-sql-secrets
              key: password
        - name: DB_NAME
          valueFrom:
            secretKeyRef:
              name: gke-cloud-sql-secrets
              key: database

Sostituisci il valore DB_HOST con l'indirizzo del tuo database.

export DB_INSTANCE_IP=$(gcloud sql instances describe mytest-instance \
    --format=json | jq \
    --raw-output ".ipAddresses[].ipAddress")

envsubst < deployment.yaml > deployment.new && mv deployment.new deployment.yaml

Esegui il deployment e convalida l'applicazione

Nel riquadro in basso di Cloud Shell Editor, seleziona Cloud Code, poi seleziona Debug on Kubernetes nella parte superiore dello schermo.
Al termine della build e dei test, nella scheda Output viene visualizzato il messaggio Resource deployment/mynodejsapp status completed successfully e viene elencato un URL: "Forwarded URL from service mynodejsapp: http://localhost:8080"
Aggiungi un paio di elementi.

Dal terminale Cloud Shell, esegui i comandi riportati di seguito.

URL=localhost:8080
curl -X POST $URL/items -d '{"itemName":"Body Spray", "itemPrice":3.2}' -H "Content-Type: application/json"
curl -X POST $URL/items -d '{"itemName":"Nail Cutter", "itemPrice":2.5}' -H "Content-Type: application/json"

Prova GET eseguendo $URL/items nel browser. Puoi anche eseguire curl dalla riga di comando

curl -X GET $URL/items

Test Delete: ora prova a eliminare un elemento eseguendo. Modifica il valore di item-id, se necessario.

curl -X DELETE $URL/items/1

    This throws an error message

{"message":"Could not delete Item with id=[object Object]"}

Identificare e risolvere il problema

Riavvia l'applicazione in modalità di debug e individua il problema. Ecco alcuni suggerimenti:

Sappiamo che c'è qualcosa che non va con l'eliminazione, in quanto non restituisce il risultato desiderato. Quindi, imposteresti il punto di interruzione nel metodo itemcontroller.js->exports.delete.
Esegui l'esecuzione passo passo e osserva le variabili in ogni passaggio per visualizzare i valori delle variabili locali nella finestra a sinistra.
Per osservare valori specifici come request.params, aggiungi questa variabile alla finestra Espressioni di controllo.

Tieni presente che il valore assegnato a id è undefined. Modifica il codice per risolvere il problema.

Lo snippet di codice corretto sarà simile al seguente.

// Delete a Item with the specified id in the request
exports.delete = (req, res) => {
    const id = req.params.id;

Una volta riavviata l'applicazione, riprova a eliminare.
Interrompi la sessione di debug facendo clic sul quadrato rosso nella barra degli strumenti di debug

6. Esegui la pulizia

Complimenti! In questo lab hai creato una nuova applicazione Node.js da zero e l'hai configurata per funzionare in modalità di deployment rapido con i container. Successivamente, hai eseguito il deployment e il debug dell'applicazione in un cluster GKE remoto seguendo lo stesso flusso di sviluppo presente negli stack di applicazioni tradizionali.

Per liberare spazio dopo aver completato il lab:

Eliminare i file utilizzati nel lab

cd ~ && rm -rf mynodejsapp && rm -f setup.sh

Elimina il progetto per rimuovere tutte le infrastrutture e le risorse correlate