Introduzione a Cloud Endpoints gRPC per il gruppo di istanze gestite con ESPv2

---

OpenAPI   | gRPC

Questo tutorial mostra come eseguire il deployment di un semplice esempio di gRPC servizio con Extensible Service Proxy V2 (ESPv2) in un gruppo di istanze gestite.

Questo tutorial utilizza la versione Python bookstore-grpc campione. Consulta la sezione Passaggi successivi per gli esempi di gRPC in altri lingue diverse.

Per una panoramica di Cloud Endpoints, consulta Informazioni su Endpoints e l'architettura degli endpoint.

Obiettivi

Durante il tutorial, utilizza il seguente elenco di attività di alto livello. Tutti necessarie per inviare correttamente le richieste all'API.

1. Configura un progetto Google Cloud e scarica il software necessario. Vedi Prima di iniziare.
2. Copia e configura file dal bookstore-grpc campione. Consulta Configurazione di Endpoints.
3. Esegui il deployment della configurazione di Endpoints per creare Servizio Endpoints. Consulta: Esegui il deployment della configurazione di Endpoints.
4. Esegui il deployment dell'API e di ESPv2 sul backend del gruppo di istanze gestite. Consulta Deployment del backend dell'API.
5. Invia una richiesta all'API. Consulta Invio di una richiesta all'API.
6. Evita che al tuo account Google Cloud vengano addebitati costi. Consulta: Esegui la pulizia.

Costi

In questo documento utilizzi i seguenti componenti fatturabili di Google Cloud:

• Compute Engine
• Endpoints

Per generare una stima dei costi basata sull'utilizzo previsto, utilizza il Calcolatore prezzi. I nuovi utenti di Google Cloud potrebbero essere idonei per una prova gratuita.

Una volta completate le attività descritte in questo documento, puoi evitare la fatturazione continua eliminando le risorse che hai creato. Per ulteriori informazioni, consulta la pagina Pulizia.

Prima di iniziare

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

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

   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

3. Make sure that billing is enabled for your Google Cloud project.

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

   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

5. Make sure that billing is enabled for your Google Cloud project.

6. Prendi nota dell'ID progetto perché sarà necessario in seguito.
7. Installa e inizializza Google Cloud CLI.
8. Aggiorna gcloud CLI e installa Endpoints componenti:

   gcloud components update

9. Assicurati che Google Cloud CLI (gcloud) sia autorizzato ad accedere i tuoi dati e servizi su Google Cloud:

   gcloud auth login

   Seleziona un account nella nuova scheda del browser che si apre.
10. Imposta il progetto predefinito sul tuo ID progetto.

    gcloud config set project YOUR_PROJECT_ID

    Sostituisci YOUR_PROJECT_ID con l'ID progetto. Se hai altri progetti Google Cloud e vuoi utilizzare gcloud consulta Gestione di gcloud CLI Configurazioni:

11. Segui la procedura descritta in Guida rapida di gRPC Python per installare gRPC e gli strumenti gRPC.

Una volta completate le attività descritte in questo documento, puoi evitare la fatturazione continua eliminando le risorse che hai creato. Per ulteriori informazioni, consulta la pagina Pulizia.

Configurazione di Endpoints

Clona l'esempio bookstore-grpc repository Git da GitHub.

Per configurare gli endpoint:

1. Crea un file descrittore protobuf autonomo dal file .proto del servizio:
   1. Salva una copia di bookstore.proto dal repository di esempio. Questo file definisce l'API del servizio Bookstore.
   2. Crea la seguente directory: mkdir generated_pb2
   3. Crea il file descrittore api_descriptor.pb utilizzando il compilatore di buffer di protocollo protoc. Esegui questo comando nella directory in cui hai salvato bookstore.proto:

      python -m grpc_tools.protoc \
          --include_imports \
          --include_source_info \
          --proto_path=. \
          --descriptor_set_out=api_descriptor.pb \
          --python_out=generated_pb2 \
          --grpc_python_out=generated_pb2 \
          bookstore.proto

      Nel comando precedente, --proto_path è impostato sul valore attuale nella directory di lavoro. Nel tuo ambiente di build gRPC, se utilizzi un'interfaccia directory per .proto file di input, modifica --proto_path in modo che il compilatore cerca nella directory in cui hai salvato bookstore.proto.

2. Crea un file YAML di configurazione dell'API gRPC:
   1. Salva una copia del api_config.yamlfile. Questo file definisce la configurazione dell'API gRPC per il servizio Bookstore.
   2. Sostituisci MY_PROJECT_ID nel file api_config.yaml con l'ID progetto Google Cloud. Ad esempio:

      #
      # Name of the service configuration.
      #
      name: bookstore.endpoints.example-project-12345.cloud.goog
      

      Tieni presente che il valore del campo apis.name in questo file corrisponde esattamente al nome completo dell'API nel file .proto. In caso contrario, il deployment non funzionerà. Il servizio Bookstore è definito in bookstore.proto all'interno del pacchetto endpoints.examples.bookstore. Il nome completo dell'API è endpoints.examples.bookstore.Bookstore, proprio come appare nel file api_config.yaml.

      apis:
        - name: endpoints.examples.bookstore.Bookstore

Consulta Configurazione di Endpoints per ulteriori informazioni.

esegui il deployment della configurazione di Endpoints

Per eseguire il deployment della configurazione di Endpoints, utilizza gcloud endpoints services deploy . Questo comando utilizza Gestione del servizio per creare un servizio gestito.

1. Assicurati di trovarti nella directory in cui si trovano i file api_descriptor.pb e api_config.yaml.
2. Conferma che il progetto predefinito a riga di comando gcloud attualmente in uso è il progetto Google Cloud che vuoi eseguire il deployment della configurazione di Endpoints. Convalida l'ID progetto restituito dal seguente comando per assicurarti che il servizio non venga creato nel progetto sbagliato.

   gcloud config list project
   

   Se devi modificare il progetto predefinito, esegui questo comando:

   gcloud config set project YOUR_PROJECT_ID
   

3. Esegui il deployment del file proto descriptor e del file di configurazione utilizzando l'interfaccia a riga di comando Google Cloud:

   gcloud endpoints services deploy api_descriptor.pb api_config.yaml
   

   Durante la creazione e la configurazione del servizio, Service Management genera le informazioni al terminale. Al termine del deployment, verrà visualizzato un messaggio simile a viene visualizzato quanto segue:

   Service Configuration [CONFIG_ID] uploaded for service [bookstore.endpoints.example-project.cloud.goog]

   CONFIG_ID è la configurazione univoca del servizio Endpoints ID creato dal deployment. Ad esempio:

   Service Configuration [2017-02-13r0] uploaded for service [bookstore.endpoints.example-project.cloud.goog]
   

   Nell'esempio precedente, 2017-02-13r0 è l'ID configurazione del servizio e bookstore.endpoints.example-project.cloud.goog è il nome del servizio. L'ID configurazione del servizio è costituito da una data seguita da un numero di revisione. Se esegui il deployment della configurazione di Endpoints sempre nello stesso giorno, il numero di revisione viene incrementato o l'ID configurazione.

Controllo dei servizi richiesti in corso...

Come minimo, Endpoints ed ESP richiedono seguenti servizi Google da attivare:

Nome	Titolo
servicemanagement.googleapis.com	API Service Management
servicecontrol.googleapis.com	API Service Control
endpoints.googleapis.com	Google Cloud Endpoints

Nella maggior parte dei casi, il comando gcloud endpoints services deploy abilita questi servizi richiesti. Tuttavia, il comando gcloud viene completato correttamente, non abilita i servizi richiesti nelle seguenti circostanze:

• Se hai utilizzato un'applicazione di terze parti, come Terraform, includono questi servizi.

• Hai eseguito il deployment della configurazione di Endpoints in una Progetto Google Cloud in cui questi servizi sono stati disattivati esplicitamente.

Utilizza il comando seguente per confermare che i servizi richiesti siano abilitati:

gcloud services list

Se non vedi elencati i servizi richiesti, abilitali:

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com
gcloud services enable endpoints.googleapis.com

Abilita anche il servizio Endpoints:

gcloud services enable ENDPOINTS_SERVICE_NAME

Per determinare il ENDPOINTS_SERVICE_NAME puoi:

• Dopo aver eseguito il deployment della configurazione di Endpoints, vai alla pagina Endpoint nella console Cloud. L'elenco dei possibili ENDPOINTS_SERVICE_NAME è visualizzato nella colonna Nome servizio.

• Per OpenAPI, ENDPOINTS_SERVICE_NAME è quello che hai specificato nel campo host della specifica OpenAPI. Per gRPC, il valore ENDPOINTS_SERVICE_NAME è quello specificato nel campo name della configurazione degli endpoint gRPC.

Per ulteriori informazioni sui comandi gcloud, consulta gcloud servizi.

Se ricevi un messaggio di errore, consulta Risoluzione dei problemi di deployment della configurazione di Endpoints. Consulta: Deployment della configurazione di Endpoints per ulteriori informazioni.

esegui il deployment del backend dell'API

Finora hai eseguito il deployment della configurazione API in Service Management, ma non hai ancora eseguito il deployment del codice che gestisce il backend dell'API. Questa sezione illustra come configurare Docker sul gruppo di istanze gestite che esegue il codice di backend dell'API e ESPv2 in un container Docker.

Crea un modello di istanza

Crea un modello che utilizzerai per creare un gruppo di istanze VM. Ciascuna l'istanza creata dal modello avvia un ESPv2 e un backend un server delle applicazioni.

1. Nella console Google Cloud, vai alla pagina Modelli di istanza.

   Vai a Modelli di istanza

2. Fai clic su Crea modello istanza.

3. In Nome, inserisci load-balancing-espv2-template.

4. In Configurazione macchina, imposta Tipo di macchina su e2-micro.

5. In Disco di avvio, imposta Immagine su Container Optimized OS stable version.

6. In Firewall, seleziona Consenti traffico HTTP.

7. Fai clic su Gestione, sicurezza, dischi, networking, single-tenancy per visualizzare le impostazioni avanzate.

8. Fai clic sulla scheda Gestione. In Automazione, inserisci quanto segue Script di avvio. Ricordati di aggiornare ENDPOINTS_SERVICE_NAME.

   sudo docker network create --driver bridge esp_net
   sudo docker run \
     --detach \
     --name=bookstore \
     --net=esp_net \
     gcr.io/endpointsv2/python-grpc-bookstore-server:1
   sudo docker run \
     --detach \
     --name=esp \
     --publish=80:9000 \
     --net=esp_net \
     gcr.io/endpoints-release/endpoints-runtime:2 \
     --service=ENDPOINTS_SERVICE_NAME \
     --rollout_strategy=managed \
     --listener_port=9000 \
     --healthz=/healthz \
     --backend=grpc://bookstore:8000
   

   Lo script recupera, installa e avvia il server delle applicazioni echo e il server proxy ESPv2 all'avvio dell'istanza.

9. Fai clic su Crea.

Prima di continuare, attendi la creazione del modello.

Crea un gruppo di istanze gestite a livello di regione

Per eseguire l'applicazione, utilizza il modello di istanza per creare una regione gruppo di istanze gestite:

1. Nella console Google Cloud, vai alla pagina Gruppi di istanze.

   Vai a Gruppi di istanze

2. Fai clic su Crea gruppo di istanze.

3. In Nome, inserisci load-balancing-espv2-group.

4. In Località, seleziona Più zone.

   Suggerimento avanzato:per assicurarti che la tua applicazione sia disponibile in caso di eventi estremi, come interruzioni a livello di zona, Compute Engine consiglia di distribuire l'applicazione in più zone.

5. In Regione, seleziona us-central1.

6. Fai clic sul menu a discesa Configura zone per visualizzare Zone. Seleziona le zone seguenti:

   • us-central1-b
   • us-central1-c
   • us-central1-f

7. In Modello di istanza, seleziona load-balancing-espv2-template.

8. In Scalabilità automatica, seleziona Non scalare automaticamente.

9. Imposta Numero di istanze su 3.

   Suggerimento avanzato: Quando crei un gruppo di istanze gestite a livello di regione, Compute Engine consiglia di eseguire il provisioning di un numero sufficiente di istanze in modo che, se tutte le in una zona non sono disponibili, le istanze rimanenti soddisfa comunque il numero minimo di istanze richieste. Tuttavia, il provisioning di un numero maggiore di istanze potrebbe comportare ulteriori costi aggiuntivi. Per ulteriori informazioni, vedi Selezionare le dimensioni del gruppo di istanze per garantire la disponibilità.

10. In Ridistribuzione istanze, seleziona On.

11. In Riparazione automatica e Controllo di integrità, seleziona Nessun controllo di integrità.

12. Fai clic su Crea. Questo ti reindirizza al Pagina Gruppi di istanze.

    Nota: potrebbe essere necessario attendere alcuni minuti prima che tutte le istanze nella sono in esecuzione e pronti a visualizzare l'applicazione web.

Crea un bilanciatore del carico

Questa sezione illustra i passaggi necessari per creare un carico a livello di regione che indirizza il traffico TCP al gruppo di istanze.

1. Nella console Google Cloud, vai alla pagina Creare un bilanciatore del carico.

   Vai a Creare un bilanciatore del carico

2. In Bilanciamento del carico TCP, fai clic su Avvia configurazione.

3. In Per internet o solo interno, seleziona Da internet alle mie VM.

4. In Più regioni o una sola regione, seleziona Solo una singola regione.

5. In Tipo di backend, seleziona Servizio di backend.

6. Fai clic su Continua.

7. In Nome, inserisci espv2-load-balancer.

8. In Configurazione backend, seleziona la regione us-central1.

9. Seleziona il gruppo di istanze load-balancing-espv2-group.

10. In Controllo di integrità, crea un nuovo controllo di integrità.

    • Sotto il nome, inserisci espv2-load-balancer-check.
    • Verifica che Protocollo sia TCP e che Porta sia 80.

11. In Configurazione frontend, inserisci il numero di porta 80.

12. In Esamina e finalizza, verifica

    • Il Gruppo di istanze è load-balancing-espv2-group.
    • La regione è us-central1.
    • Il protocollo è TCP.
    • Il valore IP:Port è EPHEMERAL:80.

13. Dopo aver creato il bilanciatore del carico, trova l'indirizzo IP nel Pagina Bilanciatore del carico.

    Vai al bilanciatore del carico

Invio di una richiesta all'API

Se invii la richiesta dalla stessa istanza in cui Docker container sono in esecuzione, puoi sostituire SERVER_IP con localhost. Altrimenti sostituisci SERVER_IP con l'IP esterno dell'istanza.

Per trovare l'indirizzo IP esterno, esegui:

gcloud compute instances list

Per inviare richieste all'API di esempio, puoi utilizzare un client gRPC di esempio scritto in come Python.

1. Clona il repository git in cui è ospitato il codice client gRPC:

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
      

2. Cambia la directory di lavoro:

   cd python-docs-samples/endpoints/bookstore-grpc/
     

3. Installa le dipendenze:

   pip install virtualenv
   virtualenv env
   source env/bin/activate
   python -m pip install -r requirements.txt

4. Invia una richiesta all'API di esempio:

   python bookstore_client.py --host SERVER_IP --port 80
   

   • Osserva i grafici delle attività dell'API nella Endpoint > Servizi.
     

     Vai alla pagina Servizi endpoint

     La visualizzazione dei dati relativi alla richiesta nei grafici può richiedere alcuni minuti.

   • Controlla i log delle richieste per l'API nella pagina Esplora log.
     

     Vai alla pagina Esplora log

Se non ricevi una risposta positiva, consulta Risoluzione degli errori di risposta.

Hai eseguito il deployment e il test di un'API in Endpoints.

Nota: se vuoi farci sapere cosa ti è piaciuto di questa presentazione tutorial, non esitare a fornire un feedback in fondo a questa pagina. Il tuo feedback ci aiuta a migliorare questi tutorial.
Se ricevi un messaggio di errore, partecipa al google-cloud-endpoints gruppo Google e facci sapere cosa non ha funzionato. Questo gruppo riceve risposte da altri Utenti di Endpoints e degli ingegneri Google che monitorano il gruppo.

Esegui la pulizia

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.

1. Assicurati che gcloud CLI (gcloud) sia autorizzato ad accedere al tuo di dati e servizi su Google Cloud:

   gcloud auth login
   

2. Inserisci il codice seguente per visualizzare gli ID progetto per il tuo account Google Cloud progetti:

   gcloud projects list
   

3. Utilizza l'ID progetto applicabile del passaggio precedente, imposta il valore predefinito progetto Google Cloud a quello in cui si trova la tua applicazione:

   gcloud config set project [YOUR_PROJECT_ID]
   

4. Ottieni il nome di tutti i servizi gestiti nel tuo progetto Google Cloud:

   gcloud endpoints services list
   

5. Elimina il servizio da Service Management. Sostituisci SERVICE_NAME con il nome del servizio che ti interessa da rimuovere.

   gcloud endpoints services delete SERVICE_NAME
   

   L'esecuzione di gcloud endpoints services delete non elimina immediatamente un servizio gestito. Service Management disabilita il servizio gestito per che ti consente di ripristinare l'account in caso di necessità. Dopo 30 giorni, Service Management elimina definitivamente il servizio gestito.

6. Vai alla pagina Bilanciatore del carico.

   Vai al bilanciatore del carico

   Elimina il bilanciatore del carico espv2-load-balancer con controllo di integrità espv2-load-balancer-check.

7. Vai alla pagina Gruppi di istanze.

   Vai a Gruppi di istanze

   Elimina load-balancing-espv2-group

8. Vai alla pagina Modello di istanza.

   Vai ai modelli di istanza

   Elimina load-balancing-espv2-template.

Passaggi successivi

• Scopri come configurare l'API gRPC per Endpoint.
• Dai un'occhiata all'esempio della libreria su GitHub in modo più dettagliato. Sia il client e server sono disponibili in Python e Java.
• L'esempio getting-started-grpc è disponibile su GitHub nelle seguenti lingue:
  • Java
  • Python
  • Ruby
  • Go
  • Node.js