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

OpenAPI   |  gRPC

gRPC

Questo tutorial utilizza la versione Python dell' bookstore-grpc esempio. Consulta la sezione Passaggi successivi per gli esempi di gRPC in altre lingue.

Per una panoramica di Cloud Endpoints, consulta Informazioni su Endpoints e Architettura di Endpoints.

Obiettivi

Utilizza il seguente elenco di attività di alto livello mentre segui il tutorial. Tutte le attività sono necessarie per inviare correttamente le richieste all'API.

1. Configura un Google Cloud progetto e scarica il software richiesto. Consulta Prima di iniziare.
2. Copia e configura i file dal bookstore-grpc esempio. Consulta Configurazione di Endpoints.
3. Esegui il deployment della configurazione di Endpoints per creare un 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 Esegui il deployment del backend dell'API.
5. Invia una richiesta all'API. Consulta Invia una richiesta all'API.
6. Evita di incorrere in addebiti sul tuo Google Cloud account. Consulta Libera spazio.

Costi

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

• Compute Engine
• Endpoints

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il calcolatore dei 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 hai mai utilizzato Google Cloud, crea un account per valutare il rendimento dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti senza costi per eseguire, testare ed eseguire il deployment dei carichi di lavoro.

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.

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.

1. Prendi nota dell'ID progetto perché ti servirà in seguito.
2. Installa e inizializza Google Cloud CLI.
3. Aggiorna gcloud CLI e installa i componenti di Endpoints:

   gcloud components update

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

   gcloud auth login

   Nella nuova scheda del browser che si apre, seleziona un account.
5. Imposta il progetto predefinito sull'ID progetto.

   gcloud config set project YOUR_PROJECT_ID

   Sostituisci YOUR_PROJECT_ID con l'ID progetto. Se hai altri progetti e vuoi utilizzare gcloud per gestirli, consulta Gestire le configurazioni di gcloud CLI. Google Cloud

6. Segui i passaggi descritti nella guida rapida di gRPC Python per installare gRPC e gli strumenti gRPC.

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 Liberare spazio.

Configurazione di Endpoints

Clona il bookstore-grpc campione repository da GitHub.

Per configurare Endpoints:

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 sulla directory di lavoro corrente. Nel tuo ambiente di compilazione gRPC, se utilizzi una directory diversa per i file di input .proto, modifica --proto_path in modo che il compilatore esegua la ricerca 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 API completo del file .proto; in caso contrario, il deployment non funzionerà. Il servizio Bookstore è definito in bookstore.proto all'interno del pacchetto endpoints.examples.bookstore. Il suo nome API completo è endpoints.examples.bookstore.Bookstore, così come appare nel file api_config.yaml.

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

Per ulteriori informazioni, consulta Configurazione di Endpoints.

Esegui il deployment della configurazione di Endpoints

Per eseguire il deployment della configurazione di Endpoints, utilizza il gcloud endpoints services deploy comando. Questo comando utilizza Service Management 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. Verifica che il progetto predefinito attualmente utilizzato dallo strumento a riga di comando gcloud sia il progetto Google Cloud in cui 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 Google Cloud CLI:

   gcloud endpoints services deploy api_descriptor.pb api_config.yaml
   

   Durante la creazione e la configurazione del servizio, Service Management visualizza le informazioni nel terminale. Al termine del deployment, viene visualizzato un messaggio simile al seguente:

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

   CONFIG_ID è l'ID univoco della configurazione del servizio Endpoints 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 di configurazione del servizio e bookstore.endpoints.example-project.cloud.goog è il nome del servizio. L'ID configurazione del servizio è composto da un timestamp seguito da un numero di revisione. Se esegui di nuovo il deployment della configurazione di Endpoints lo stesso giorno, il numero di revisione viene incrementato nell'ID configurazione del servizio.

Controlla i servizi richiesti

Come minimo, Endpoints ed ESP richiedono l'attivazione dei seguenti servizi Google:

Nome	Titolo
servicemanagement.googleapis.com	API Service Management
servicecontrol.googleapis.com	API Service Control

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

• Se hai utilizzato un'applicazione di terze parti come Terraform e non hai incluso questi servizi.

• Hai eseguito il deployment della configurazione di Endpoints in un progetto esistente Google Cloud in cui questi servizi erano stati disattivati esplicitamente.

Utilizza il seguente comando per verificare che i servizi richiesti siano attivati:

gcloud services list

Se non vedi i servizi richiesti elencati, attivali:

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

Attiva anche il servizio Endpoints:

gcloud services enable ENDPOINTS_SERVICE_NAME

Per determinare ENDPOINTS_SERVICE_NAME, puoi:

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

• Per OpenAPI, il ENDPOINTS_SERVICE_NAME è quello che hai specificato nel campo host della specifica OpenAPI. Per gRPC, il ENDPOINTS_SERVICE_NAME è quello che hai specificato nel campo name della configurazione di Endpoints 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. Per ulteriori informazioni, consulta Esegui il deployment della configurazione di Endpoints.

Esegui il deployment del backend dell'API

Fino a questo punto, hai eseguito il deployment della configurazione dell'API in Service Management, ma non hai ancora eseguito il deployment del codice soggiacente al backend dell'API. Questa sezione ti guida nella configurazione di Docker nel gruppo di istanze gestite e nell'esecuzione del codice del backend dell'API e di ESPv2 in un container Docker.

Crea un modello di istanza

Crea un modello da utilizzare per creare un gruppo di istanze VM. Ogni istanza creata dal modello avvia un server ESPv2 e un server di applicazioni di backend.

1. Nella Google Cloud console, 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 il seguente Script di avvio. Ricorda 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 di applicazioni echo e il server proxy ESPv2 all'avvio dell'istanza.

9. Fai clic su Crea.

Attendi la creazione del modello prima di continuare.

Crea un gruppo di istanze gestite a livello di regione

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

1. Nella Google Cloud console, 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 sia disponibile nel corso 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 seguenti zone:

   • 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 eseguire la scalabilità automatica.

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 le istanze di una zona non sono disponibili, quelle rimanenti soddisfino comunque il numero minimo di istanze richiesto. Tuttavia, l'esecuzione del provisioning di più istanze del necessario potrebbe comportare costi aggiuntivi. Per ulteriori informazioni, consulta Selezione delle dimensioni del gruppo di istanze per garantire la disponibilità.

10. In Ridistribuzione delle istanze, seleziona On.

11. In Ripristino automatico e Controllo di integrità, seleziona Nessun controllo di integrità.

12. Fai clic su Crea. Verrà visualizzata nuovamente la pagina Gruppi di istanze.

    Nota: potrebbe essere necessario attendere alcuni minuti affinché tutte le istanze del gruppo siano in esecuzione e pronte a visualizzare l'applicazione web.

Crea un bilanciatore del carico

Questa sezione illustra i passaggi necessari per creare un bilanciatore del carico regionale che indirizzi il traffico TCP al gruppo di istanze.

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

   Vai a Crea 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 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à.

    • In Nome, inserisci espv2-load-balancer-check.
    • Verifica che Protocollo sia TCP e 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.
    • L'IP:Porta è EPHEMERAL:80.

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

    Vai a Bilanciatore del carico

Invia una richiesta all'API

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

Puoi trovare l'indirizzo IP esterno eseguendo:

gcloud compute instances list

Per inviare richieste all'API di esempio, puoi utilizzare un client gRPC di esempio scritto in 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
   

   • Consulta i grafici di attività della tua API nella pagina Endpoints > Servizi.
     

     Vai alla pagina Servizi endpoint

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

   • Esamina i log delle richieste per la tua API nella pagina Esplora log.
     

     Vai alla pagina Esplora log

Se non ricevi una risposta positiva, consulta Risoluzione dei problemi relativi agli errori di risposta.

Hai appena eseguito il deployment e testato un'API in Endpoints.

Nota: se vuoi comunicarci cosa ti è piaciuto di questo tutorial, non esitare a fornire un feedback in fondo alla pagina. Il tuo feedback ci aiuta a migliorare questi tutorial.
Se hai riscontrato un errore, unisciti al google-cloud-endpoints gruppo Google e comunicaci cosa è andato storto. Questo gruppo riceve risposte da altri utenti di Endpoints e dagli ingegneri di Google, che monitorano il gruppo.

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.

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

   gcloud auth login
   

2. Inserisci quanto segue per visualizzare gli ID progetto dei tuoi Google Cloud progetti:

   gcloud projects list
   

3. Utilizzando l'ID progetto applicabile del passaggio precedente, imposta il progetto predefinito Google Cloud su quello in cui si trova l'applicazione:

   gcloud config set project [YOUR_PROJECT_ID]
   

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

   gcloud endpoints services list
   

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

   gcloud endpoints services delete SERVICE_NAME
   

   L'esecuzione di gcloud endpoints services delete non elimina immediatamente il servizio gestito. Service Management disattiva il servizio gestito per 30 giorni, il che ti consente di ripristinarlo se necessario. Dopo 30 giorni, Service Management elimina definitivamente il servizio gestito.

6. Vai alla pagina Bilanciatore del carico.

   Vai a Bilanciatore del carico

   Elimina il bilanciatore del carico espv2-load-balancer con il 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 a Modelli di istanza

   Elimina load-balancing-espv2-template.

Passaggi successivi

• Scopri come configurare la tua API gRPC per Endpoints.
• Esamina più nel dettaglio l'esempio di Bookstore su GitHub. Il client e il server sono disponibili in Python e Java.
• L'esempio getting-started-grpc è disponibile su GitHub nelle seguenti lingue:
  • Java
  • Python
  • Ruby
  • Go
  • Node.js