Ambiente di sviluppo

1. Panoramica

Questo lab mostra le funzionalità e le capacità progettate per semplificare il flusso di lavoro di sviluppo per gli ingegneri software incaricati di sviluppare applicazioni Python 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.

Che cos'è Cloud Workstations?

Cloud Workstations fornisce ambienti di sviluppo gestiti su Google Cloud con sicurezza integrata e ambienti di sviluppo preconfigurati ma personalizzabili. Accedi a Cloud Workstations tramite un IDE basato su browser, da più editor di codice locali (come VSCode o IDE JetBrains come IntelliJ IDEA Ultimate e PyCharm Professional) o tramite SSH.

Cloud Workstations utilizza le seguenti risorse:

• Gli amministratori creano cluster di workstation
• In ogni cluster di workstation, gli amministratori creano una o più configurazioni di workstation che fungono da modelli per le workstation.
• Gli sviluppatori possono creare workstation che definiscono ambienti di sviluppo che forniscono un IDE Cloud, strumenti per il linguaggio, librerie e altro ancora.

Cloud Workstations consente agli amministratori IT e della sicurezza di eseguire facilmente il provisioning, scalare, gestire e proteggere i propri ambienti di sviluppo e consente agli sviluppatori di accedere agli ambienti di sviluppo con configurazioni coerenti e strumenti personalizzabili.

Cloud Workstations contribuisce a spostare la sicurezza a sinistra migliorando la strategia di sicurezza degli ambienti di sviluppo delle applicazioni. Dispone di funzionalità di sicurezza come i Controlli di servizio VPC, il traffico in entrata o in uscita privato, l'aggiornamento forzato delle immagini e i criteri di accesso Identity and Access Management.

Che cos'è Cloud Code?

Cloud Code fornisce il supporto IDE per l'intero ciclo di sviluppo delle applicazioni Kubernetes e Cloud Run, dalla creazione e personalizzazione di una nuova applicazione da modelli di esempio all'esecuzione dell'applicazione finita. Cloud Code ti supporta lungo il percorso con esempi pronti per l'esecuzione, snippet di configurazione predefiniti e un'esperienza di debug personalizzata, semplificando notevolmente lo sviluppo con Kubernetes e Cloud Run.

Ecco alcune delle funzionalità di Cloud Code:

• Creare ed eseguire applicazioni in modo continuo
• Supporto per il debug dell'applicazione Kubernetes in fase di sviluppo
• Streaming e visualizzazione dei log

Scopri di più sulle altre funzionalità di Cloud Code.

Cosa imparerai a fare

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

• Esamina Cloud Workstations
• Avvia workstation
• Esaminare Cloud Code
• Esegui il debug su Kubernetes

2. Configurazione e requisiti

Configurazione dell'ambiente autonomo

1. 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. Puoi aggiornarlo in qualsiasi momento.
• L'ID progetto è univoco in tutti i progetti Google Cloud ed è immutabile (non può essere modificato dopo l'impostazione). La console Cloud 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 (in genere è identificato come PROJECT_ID). Se non ti piace l'ID generato, puoi generarne un altro casuale. In alternativa, puoi provare a crearne uno e vedere se è disponibile. Non può essere modificato dopo questo passaggio e rimarrà per tutta la durata del progetto.
• Per tua informazione, esiste un terzo valore, un numero di progetto, utilizzato da alcune API. Scopri di più su tutti e tre questi valori nella documentazione.

Attenzione:un ID progetto è univoco a livello globale e non può essere utilizzato da altri dopo che lo hai selezionato. Sei l'unico utente di questo ID. Anche se un progetto viene eliminato, l'ID non potrà mai più essere utilizzato

Nota:se utilizzi un account Gmail, puoi lasciare la località predefinita impostata su Nessuna organizzazione. Se utilizzi un account Google Workspace, scegli una posizione adatta alla tua organizzazione.

2. 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, puoi eliminare le risorse che hai creato o l'intero progetto. I nuovi utenti di Google Cloud possono beneficiare del programma prova senza costi di 300$.

Configurazione dell'ambiente

In Cloud Shell, imposta l'ID progetto e il numero del tuo progetto. Salvali come variabili PROJECT_ID e PROJECT_ID.

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

In questo lab eseguirai il deployment del codice su GKE. Utilizzerai anche Cloud Workstations come IDE.

Lo script di configurazione riportato di seguito prepara questa infrastruttura per te.

1. Scarica lo script di configurazione e rendilo eseguibile.

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

2. Apri il file setup_with_cw.sh e modifica i valori delle password attualmente impostate su CHANGEME
3. Esegui lo script di configurazione per creare un cluster GKE che utilizzerai in questo lab. Questa configurazione richiederà circa 20 minuti.

./setup_with_cw.sh &

4. Apri Cloud Workstations in Cloud Console. Attendi che il cluster sia nello stato READY prima di passare ai passaggi successivi.
5. Se la sessione di Cloud Shell è stata disconnessa, fai clic su "Riconnetti" e poi esegui il comando gcloud CLI per impostare l'ID progetto. Prima di eseguire il comando, sostituisci l'ID progetto di esempio riportato di seguito con il tuo ID progetto Qwiklabs.

gcloud config set project qwiklabs-gcp-project-id

6. Scarica ed esegui lo script riportato di seguito nel terminale per creare la configurazione di Cloud Workstations.

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

Cluster e configurazione Cloud Workstations

Apri Cloud Workstations in Cloud Console. Verifica che il cluster sia nello stato READY.

Verifica lo stato delle configurazioni esistenti.

Crea una nuova workstation.

Modifica il nome in my-workstation e seleziona la configurazione esistente: codeoss-python.

Avvia workstation

1. Avvia la workstation. L'avvio della workstation richiede qualche istante.

2. Consenti i cookie di terze parti facendo clic sull'icona nella barra degli indirizzi.

3. Fai clic su "Il sito non funziona?".

4. Fai clic su "Consenti cookie".

5. Una volta avviata la workstation, viene visualizzato l'IDE Code OSS.

Fai clic su "Mark Done" (Segna come completato) nella pagina Getting Started (Guida introduttiva) dell'IDE della workstation.

3. Panoramica di Cloud Code

Esamina le diverse sezioni disponibili in Cloud Code.

• Sviluppo Kubernetes. Approfitta di un ambiente di sviluppo e debug di Kubernetes completamente integrato all'interno del tuo IDE. Crea e gestisci i cluster direttamente dall'IDE.
• Esegui il debug delle applicazioni in esecuzione. Esegui il debug del codice all'interno degli IDE utilizzando Cloud Code for VS Code e Cloud Code for IntelliJ, sfruttando le funzionalità di debug integrate dell'IDE.
• Esplora i deployment. Visualizza le risorse e i metadati sottostanti per i tuoi cluster Kubernetes e i servizi Cloud Run. Puoi recuperare una descrizione, visualizzare log, gestire secret o portare un terminale direttamente in un pod.
• Semplifica lo sviluppo locale in Kubernetes. Cloud Code per IDE utilizza strumenti diffusi come Skaffold, Jib e kubectl per fornirti feedback continui sul codice in tempo reale.

Accedi a Google Cloud

1. Fai clic sull'icona di Cloud Code e seleziona "Accedi a Google Cloud":

2. Fai clic su "Procedi all'accesso".

3. Controlla l'output nel terminale e apri il link:

4. Accedi con le credenziali degli studenti Qwiklabs.

5. Seleziona "Consenti":

6. Copia il codice di verifica e torna alla scheda Workstation.

7. Incolla il codice di verifica e premi Invio.

Se vedi questo messaggio, fai clic sul pulsante "Consenti" per poter copiare e incollare nella workstation.

4. Crea una nuova applicazione iniziale Python

In questa sezione creerai una nuova applicazione Python.

1. Apri un nuovo terminale.

2. Crea una nuova directory e aprila come workspace

mkdir music-service && cd music-service

code-oss-cloud-workstations -r --folder-uri="$PWD"

3. Crea un file denominato requirements.txt e copia al suo interno i seguenti contenuti:

Flask
gunicorn
ptvsd==4.3.2

4. Crea un file denominato app.py e incolla il seguente codice al suo interno

import os
from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route("/")
def hello_world():
    message="Hello, World!"
    return message

if __name__ == '__main__':
    server_port = os.environ.get('PORT', '8080')
    app.run(debug=False, port=server_port, host='0.0.0.0')

5. Crea un file denominato Dockerfile e incolla al suo interno quanto segue

FROM python:3.8
ARG FLASK_DEBUG=0
ENV FLASK_DEBUG=$FLASK_DEBUG
ENV FLASK_APP=app.py
WORKDIR /app
COPY requirements.txt .
RUN pip install --trusted-host pypi.python.org -r requirements.txt
COPY . .
ENTRYPOINT ["python3", "-m", "flask", "run", "--port=8080", "--host=0.0.0.0"]

Nota: FLASK_DEBUG=1 consente di ricaricare automaticamente le modifiche al codice in un'app Flask Python. Questo Dockerfile consente di passare questo valore come argomento di build.

Genera manifest

Nel terminale, esegui questo comando per generare un skaffold.yaml e un deployment.yaml predefiniti

1. Inizializza Skaffold con il seguente comando

skaffold init --generate-manifests

Quando ti viene chiesto, utilizza le frecce per spostare il cursore e la barra spaziatrice per selezionare le opzioni.

Scegli:

• 8080 per il porto
• y per salvare la configurazione.

Aggiorna le configurazioni di Skaffold

• Modificare il nome dell'applicazione predefinita
• Apri skaffold.yaml
• Seleziona il nome dell'immagine attualmente impostata come dockerfile-image
• Fai clic con il tasto destro del mouse e scegli Modifica tutte le occorrenze.
• Digita il nuovo nome come python-app
• Modifica ulteriormente la sezione di creazione per
• aggiungi docker.buildArgs alla tessera FLASK_DEBUG=1
• Sincronizza le impostazioni per caricare le modifiche ai file *.py dall'IDE al contenitore in esecuzione

Dopo le modifiche, la sezione build del file skaffold.yaml sarà la seguente:

build:
 artifacts:
 - image: python-app
   docker:
     buildArgs:
       FLASK_DEBUG: "1"
     dockerfile: Dockerfile
   sync:
     infer:
     - '**/*.py'

Modifica del file di configurazione di Kubernetes

1. Modificare il nome predefinito

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

5. Esaminare il processo di sviluppo

Ora che hai aggiunto la logica di business, puoi eseguire il deployment e testare l'applicazione. La sezione seguente mostrerà l'utilizzo del plug-in Cloud Code. Tra le altre cose, questo plug-in 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 your in GKE. Questa operazione avviene dietro le quinte, astraendo i dettagli dal flusso dello sviluppatore.

Aggiungi cluster Kubernetes

1. Aggiungere un cluster

2. Seleziona Google Kubernetes Engine:

3. Seleziona il progetto.

4. Seleziona "python-cluster" creato nella configurazione iniziale.

5. Il cluster ora viene visualizzato nell'elenco dei cluster Kubernetes in Cloud Code. Naviga ed esplora il cluster da qui.

Eseguire il deployment in Kubernetes

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

2. Nel riquadro visualizzato in alto, seleziona Esegui su Kubernetes.

Se richiesto, seleziona Sì per utilizzare il contesto Kubernetes attuale.

Questo comando avvia una build del codice sorgente e poi esegue i test. L'esecuzione della build e dei test richiederà alcuni minuti. Questi test includono test unitari e un passaggio di convalida che verifica le regole impostate per l'ambiente di deployment. Questo passaggio di convalida è già configurato e ti avvisa dei problemi di deployment anche mentre lavori ancora nel tuo ambiente di sviluppo.

3. 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.
4. Successivamente, verrà visualizzato un prompt che chiede quale registro dei container utilizzare. Premi Invio per accettare il valore predefinito fornito.
5. Seleziona la scheda "Output" nel riquadro inferiore per visualizzare l'avanzamento e le notifiche. Utilizza il menu a discesa per selezionare "Kubernetes: Run/Debug" (Kubernetes: esegui/debug).

6. 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.

Al termine della build e dei test, i log della scheda Output con l'URL http://localhost:8080 sono elencati nella visualizzazione "Kubernetes: Run/Debug".

7. Nel terminale Cloud Code, passa il mouse sopra il primo URL nell'output (http://localhost:8080) e poi seleziona Apri anteprima web nel suggerimento visualizzato.
8. Si apre una nuova scheda del browser e viene visualizzato il messaggio: Hello, World!

Ricaricamento rapido

1. Apri il file app.py
2. Modifica il messaggio di saluto in Hello from Python

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

Update initiated
Build started for artifact python-app
Build completed for artifact python-app

Deploy started
Deploy completed

Status check started
Resource pod/python-app-6f646ffcbb-tn7qd status updated to In Progress
Resource deployment/python-app status updated to In Progress
Resource deployment/python-app status completed successfully
Status check succeeded
...

3. Se passi alla visualizzazione Kubernetes: Run/Debug - Detailed, noterai che riconosce le modifiche ai file, quindi crea ed esegue nuovamente il deployment dell'app.

files modified: [app.py]
Syncing 1 files for gcr.io/veer-pylab-01/python-app:3c04f58-dirty@sha256:a42ca7250851c2f2570ff05209f108c5491d13d2b453bb9608c7b4af511109bd
Copying files:map[app.py:[/app/app.py]]togcr.io/veer-pylab-01/python-app:3c04f58-dirty@sha256:a42ca7250851c2f2570ff05209f108c5491d13d2b453bb9608c7b4af511109bd
Watching for changes...
[python-app] * Detected change in '/app/app.py', reloading
[python-app] * Restarting with stat
[python-app] * Debugger is active!
[python-app] * Debugger PIN: 744-729-662

4. Aggiorna la scheda del browser in cui hai visualizzato i risultati precedenti per visualizzare i risultati aggiornati.

Debug

1. Vai alla visualizzazione Debug e interrompi il thread corrente . Se ti viene chiesto, puoi scegliere di liberare spazio dopo ogni esecuzione.
2. 
3. 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.

4. La prima volta che viene eseguito, un prompt chiede dove si trova l'origine all'interno del container. Questo valore è correlato alle directory nel Dockerfile.

Premi Invio per accettare il valore predefinito

La creazione e il deployment dell'applicazione richiedono un paio di minuti. Se la sessione di debug viene disconnessa, ripeti i passaggi per "Eseguire il debug su Kubernetes" dalla sezione "Sessioni di sviluppo".

5. Al termine della procedura. Noterai un debugger collegato e la scheda Output indica: Attached debugger to container "python-app-8476f4bbc-h6dsl" successfully. e l'URL http://localhost:8080 è elencato.

Port forwarding pod/python-app-8bd64cf8b-cskfl in namespace default, remote port 5678 -> http://127.0.0.1:5678

6. Il colore della barra di stato inferiore cambia da blu ad arancione, indicando che è in modalità di debug.

7. Nella visualizzazione Kubernetes Run/Debug, nota che viene avviato un container di cui è possibile eseguire il debug

**************URLs*****************
Forwarded URL from service python-app: http://localhost:8080
Debuggable container started pod/python-app-8bd64cf8b-cskfl:python-app (default)
Update succeeded
***********************************

Utilizzare i punti di interruzione

1. Apri il file app.py
2. Individua l'istruzione return message.
3. 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
4. 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
5. Fai clic sulla sezione VARIABILI.
6. Fai clic su Locals (Variabili locali) per trovare la variabile "message".
7. Fai doppio clic sul nome della variabile "message" e, nel popup, cambia il valore in qualcosa di diverso, ad esempio "Greetings from Python"
8. Fai clic sul pulsante Continua nel pannello di controllo del debug
9. Controlla la risposta nel browser, che ora mostra il valore aggiornato appena inserito.
10. Arresta la modalità "Debug" premendo il pulsante di arresto e rimuovi il punto di interruzione facendo di nuovo clic su di esso.

6. Esegui la pulizia

Complimenti! In questo lab hai creato una nuova applicazione Python da zero e l'hai configurata per funzionare in modo efficace 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:

1. Eliminare i file utilizzati nel lab

cd ~ && rm -rf ~/music-service

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

—

Ultimo aggiornamento: 22/03/2023