Deployment dell'app Bookshelf Python utilizzando Cloud Deployment Manager

Questo tutorial mostra come eseguire il deployment dell'app di esempio Python Bookshelf utilizzando Cloud Deployment Manager.

Deployment Manager consente di creare le risorse necessarie Google Cloud risorse per un deployment in un unico passaggio, tramite un processo dichiarativo e ripetibile. Con Deployment Manager, puoi aggiornare i deployment, monitorare le modifiche nel tempo, creare modelli utilizzando Jinja o Python e parametrizzare i modelli, in modo che i deployment simili condividano un modello.

Obiettivi

• Clonare e configurare l'app di esempio Bookshelf.
• Creare configurazioni e modelli di Deployment Manager.
• Creare deployment di Deployment Manager.
• Eseguire il deployment dell'app di esempio Bookshelf utilizzando Deployment Manager.

Costi

In questo documento vengono utilizzati i seguenti componenti fatturabili di Google Cloud:

• Compute Engine
• Cloud Storage
• Datastore
• Cloud Logging
• Pub/Sub

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il calcolatore prezzi.

I nuovi Google Cloud utenti potrebbero avere diritto a una prova senza costi.

Al termine delle attività descritte in questo documento, puoi evitare l'addebito di ulteriori costi eliminando le risorse che hai creato. Per saperne di più, consulta Esegui la pulizia.

Prima di iniziare

Accedi al tuo Google Cloud account. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti senza costi per l'esecuzione, il test e il deployment dei workload.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Datastore API, Cloud Storage API, Pub/Sub API APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Installa Google Cloud CLI.

Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

Per inizializzare gcloud CLI, esegui questo comando:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Datastore API, Cloud Storage API, Pub/Sub API APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Installa Google Cloud CLI.

Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

Per inizializzare gcloud CLI, esegui questo comando:

gcloud init

1. Installa Python, pip e virtualenv sul tuo sistema. Per istruzioni, consulta Configurazione di un ambiente di sviluppo Python per Google Cloud.

Creazione di un bucket Cloud Storage

Le seguenti istruzioni descrivono in dettaglio come creare un bucket Cloud Storage. I bucket sono i container di base di Cloud Storage in cui vengono archiviati i dati.

Nota: puoi scegliere qualsiasi nome per il bucket Cloud Storage. Una buona pratica è assegnare al bucket lo stesso nome dell'ID progetto. I nomi dei bucket devono essere univoci in tutto Google Cloud, quindi è possibile che tu non possa utilizzare il tuo ID progetto come nome del bucket.

1. Nella finestra del terminale, crea un bucket Cloud Storage, dove YOUR_BUCKET_NAME rappresenta il nome del bucket:

   gcloud storage buckets create gs://YOUR_BUCKET_NAME

2. Per visualizzare le immagini caricate nell'app Bookshelf, imposta la policy Identity and Access Management del bucket in modo da concedere il ruolo legacyObjectReader a allUsers:

   gcloud storage buckets add-iam-policy-binding gs://YOUR_BUCKET_NAME
   --member=allUsers --role=roles/storage.legacyObjectReader

Clonazione dell'app di esempio

L'app di esempio è disponibile su GitHub all'indirizzo GoogleCloudPlatform/getting-started-python.

1. Clona il repository:

   git clone https://github.com/GoogleCloudPlatform/getting-started-python.git -b steps
   

2. Vai alla directory di esempio:

   cd getting-started-python/7-gce
   

Configurazione dell'applicazione

1. Apri config.py per la modifica.

   • Imposta il valore di PROJECT_ID sull'ID progetto.

   • Imposta il valore CLOUD_STORAGE_BUCKET sul nome del bucket Cloud Storage.

2. Salva e chiudi config.py.

Esecuzione dell'applicazione nel computer locale

1. Crea un ambiente Python isolato e installa le dipendenze:

   Linux/macOS

   virtualenv -p python3 env
   source env/bin/activate
   pip install -r requirements.txt
   

   Windows

   virtualenv -p python3 env
   env\scripts\activate
   pip install -r requirements.txt
   

2. Esegui l'applicazione:

   python main.py
   

3. Nel browser, inserisci il seguente indirizzo:

   http://localhost:8080

Per arrestare il server web locale premi CTRL+C. Se vuoi uscire dall'ambiente virtuale, inserisci deactivate.

Deployment dell'app di esempio

Esegui il push del codice in un repository

Puoi inserire il codice in un'istanza di Compute Engine in esecuzione in diversi modi. Un modo è utilizzare Cloud Source Repositories. Ogni progetto include un repository Git disponibile per le istanze di Compute Engine. Le istanze eseguono il pull della versione più recente del codice dell'app durante l'avvio. L'utilizzo di un repository Git è pratico perché l'aggiornamento dell'app non richiede la configurazione di nuove immagini o istanze; basta riavviare un'istanza esistente o crearne una.

1. La prima volta che utilizzi Git, usa git config --global per configurare la tua identità.

2. Nella tua Google Cloud console, crea un repository:

   Crea repository

3. Quindi, esegui il push del codice dell'app nel repository del progetto, dove [YOUR_PROJECT_ID] è l'ID progetto e [YOUR_REPO] è il nome del repository:

   git commit -am "Updating configuration"
   git config credential.helper gcloud.sh
   git remote add cloud https://source.developers.google.com/p/[YOUR_PROJECT_ID]/r/[YOUR_REPO]
   git push cloud master
   

Crea il deployment

Dopo aver eseguito il commit della configurazione e caricato il codice in Cloud Source Repositories, puoi utilizzare Deployment Manager per creare il deployment:

1. Vai alla directory deployment_manager:

   cd getting-started-python/7-gce/gce/deployment_manager
   

2. Crea il deployment:

   gcloud deployment-manager deployments create my-deployment --config config.yaml
   

3. Visualizza un elenco di tutti i deployment:

   gcloud deployment-manager deployments list
   

4. Ottieni una descrizione del deployment e delle risorse che ha creato:

   gcloud deployment-manager deployments describe my-deployment
   

Visualizza l'app

Dopo aver creato la regola di forwarding, possono trascorrere alcuni minuti prima che la configurazione venga propagata e che il traffico venga instradato alle istanze.

1. Per controllare l'avanzamento:

   gcloud compute backend-services get-health bookshelf-my-deployment-frontend --global
   

2. Quando almeno una delle istanze segnala HEALTHY, recupera l'indirizzo IP di forwarding per il bilanciatore del carico:

   gcloud compute forwarding-rules list --global
   

   L'indirizzo IP delle regole di inoltro si trova nella colonna IP_ADDRESS.

3. Nel browser, inserisci l'indirizzo IP dall'elenco.

   La tua app è ora in esecuzione su Google Cloud.

Nozioni di base sul codice

Configura il deployment

Puoi vedere come è configurato il deployment in config.yaml:

imports:
- name: bookshelf.jinja
  path: ./bookshelf.jinja

resources:
- name: bookshelf
  type: bookshelf.jinja
  properties:
    zone: us-central1-f
    machine-type: n1-standard-1
    machine-image: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/images/family/debian-9
    min-instances: 1
    max-instances: 10
    target-utilization: 0.6
    scopes:
    - https://www.googleapis.com/auth/cloud-platform

Il file di configurazione importa il file del modello come risorsa e lo utilizza per definire una risorsa denominata bookshelf. Il modello accetta diverse proprietà come parametri. Per ulteriori informazioni sulla creazione di file di configurazione di Deployment Manager, consulta Creazione di una configurazione.

Configura lo schema del modello di deployment

Esamina il file dello schema bookshelf.jinja.schema, che definisce e documenta i parametri che il deployment deve fornire nel file di configurazione. Per ulteriori informazioni sugli schemi di configurazione, consulta Utilizzo degli schemi.

info:
  title: Bookshelf GCE Deploy
  author: Google Inc.
  description: Creates a GCE Deployment

imports:
- name: startup-script
  path: ../startup-script.sh

required:
- zone
- machine-type
- min-instances
- max-instances
- scopes

properties:
  zone:
    description: Zone to create the resources in.
    type: string
  machine-type:
    description: Type of machine to use
    type: string
  machine-image:
    description: The OS image to use on the machines
    type: string
  min-instances:
    description: The minimum number of VMs the autoscaler will create
    type: integer
  max-instances:
    description: The maximum number of VMs the autoscaler will create
    type: integer
  target-utilization:
    description: The target CPU usage for the autoscaler to base its scaling on
    type: number
  scopes:
    description: A list of scopes to create the VM with
    type: array
    minItems: 1
    items:
      type: string

Configura il modello di deployment

Il modello definisce diverse risorse necessarie per creare un gruppo di istanze gestite con scalabilità automatica e bilanciamento del carico. Per una descrizione completa delle risorse create, consulta i commenti nel modello e il tutorial Bookshelf su Compute Engine.

Tieni presente che Deployment Manager fornisce un modo per definire le risorse in modo dichiarativo, ma la maggior parte della configurazione per una determinata risorsa è definita dalla sua API. Ad esempio, la maggior parte delle opzioni di configurazione per la risorsa del modello di istanza si trova nella definizione della risorsa del modello di istanza nella documentazione di riferimento per l' API Compute Engine.

Il modello è scritto utilizzando il linguaggio di creazione di modelli Jinja. Quando scrivi i modelli di Deployment Manager, puoi utilizzare Jinja o Python. Jinja ha il vantaggio di essere più dichiarativo, il che può essere più leggibile e facile da capire rispetto a Python. Per alcuni deployment complessi, la piena espressività di Python potrebbe semplificare le cose. In questo caso, Jinja è sufficiente per creare le risorse necessarie.

In un modello, alcune variabili di ambiente vengono impostate automaticamente e puoi accedervi utilizzando il dizionario env. In questo caso, il nome del deployment viene fatto riferimento come nome da riutilizzare quando si assegnano nomi alle risorse create. Per ulteriori informazioni sulle variabili di ambiente disponibili, consulta Utilizzo delle variabili di ambiente nella documentazione di Deployment Manager:

{% set NAME = "bookshelf-" + env["deployment"] %}
{% set SERVICE = "bookshelf-" + env["deployment"] + "-frontend" %}

Il modello utilizza lo stesso script di avvio utilizzato nel tutorial di Compute Engine. I contenuti dello script vengono inseriti nel modello e la direttiva di rientro Jinja rientra correttamente i contenuti:

            value: |
{{imports['startup-script']|indent(14, true)}}

In un modello Jinja di Deployment Manager, puoi anche fare riferimento alle risorse create altrove nel modello. Nell'esempio seguente, il servizio di backend utilizza il riferimento del gruppo di istanze gestite per ottenere il gruppo di istanze a cui deve puntare:

- group: $(ref.{{ NAME }}-frontend-group.instanceGroup)
  zone: {{ properties['zone'] }}

Le proprietà specificate in config.yaml possono essere utilizzate nel modello:

minNumReplicas: {{ properties['min-instances'] }}
maxNumReplicas: {{ properties['max-instances'] }}
loadBalancingUtilization:
  utilizationTarget: {{ properties['target-utilization'] }}

Libera spazio

Per evitare che al tuo Account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questo tutorial, elimina il progetto che contiene le risorse oppure mantieni il progetto ed elimina le singole risorse.

Elimina il progetto

Il modo più semplice per eliminare la fatturazione è eliminare il progetto creato per il tutorial.

Per eliminare il progetto:

Attenzione: l'eliminazione di un progetto ha i seguenti effetti:

• L'intero contenuto del progetto viene eliminato. Se hai utilizzato un progetto esistente per, le attività descritte in questo documento, eliminerai anche tutto il lavoro che hai svolto nel progetto.
• Gli ID progetto personalizzati non sono più disponibili. Quando hai creato questo progetto, potresti aver creato un ID progetto personalizzato che vuoi utilizzare in futuro. Per conservare gli URL che utilizzano l'ID progetto, ad esempio un URL appspot.com, elimina le risorse selezionate all'interno del progetto anziché eliminare l'intero progetto.

Se intendi esplorare più architetture, tutorial o guide rapide, puoi riutilizzare i progetti ed evitare così di superare i limiti di quota.

1. Nella Google Cloud console, vai alla pagina Gestisci risorse.

   Vai a Gestisci risorse

2. Nell'elenco dei progetti, seleziona il progetto che vuoi eliminare, quindi fai clic su Elimina.
3. Nella finestra di dialogo, digita l'ID progetto e fai clic su Chiudi per eliminare il progetto.

Elimina il deployment

Per eliminare il deployment, inserisci il seguente comando. Questo comando elimina il bilanciatore del carico e le eventuali istanze di Compute Engine associate al deployment:

gcloud deployment-manager deployments delete my-deployment

Passaggi successivi

• Scopri di più su come definire i modelli di Deployment Manager.

• Scopri come eseguire l'app di esempio Python Bookshelf su Google Kubernetes Engine.

• Scopri come eseguire l'app di esempio Python Bookshelf nell'ambiente flessibile di App Engine.

• Esplora architetture, diagrammi e best practice di riferimento su Google Cloud. Consulta il nostro Cloud Architecture Center.

• Esplora altri Google Cloud servizi.