Introduzione a Endpoints per Compute Engine con ESP

---

OpenAPI   | gRPC

Questa pagina mostra come eseguire il deployment di un semplice esempio gRPC servizio con Extensible Service Proxy (ESP) in un Docker un container in Compute Engine.

Questa pagina utilizza la versione Python del 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 per inviare correttamente le richieste all'API.

1. Configura un progetto Google Cloud e scarica il software necessario. Vedi Prima di iniziare.
2. Creare un'istanza VM di Compute Engine. Consulta Creazione di un'istanza Compute Engine.
3. Copia e configura file dal bookstore-grpc campione. Consulta Configurazione di Endpoints.
4. Esegui il deployment della configurazione di Endpoints per creare un servizio Endpoints. Consulta Esegui il deployment della configurazione di Endpoints.
5. Eseguire il deployment di API ed ESP sulla VM di Compute Engine. Consulta Deployment del backend dell'API.
6. Invia una richiesta all'API. Consulta Invio di una richiesta all'API.
7. 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 i passaggi descritti nella guida introduttiva di gRPC per Python per installare gRPC e gli strumenti gRPC.

Creazione di un'istanza Compute Engine

Per creare un'istanza Compute Engine:

1. In the Google Cloud console, go to the Create an instance page.

   Go to Create an instance

2. Nella sezione Firewall, seleziona Consenti traffico HTTP e Consenti traffico HTTPS.
3. Per creare la VM, fai clic su Crea.



Potrebbe essere necessario un po' di tempo per l'avvio dell'istanza. Quando è pronto, viene elencato nella pagina Istanze VM, con un'icona di stato verde.

4. Assicurati di poterti connettere alla tua istanza VM.
   1. In the list of virtual machine instances, click SSH in the row of the instance that you want to connect to.
   2. Ora puoi utilizzare il terminale per eseguire i comandi Linux su Debian in esecuzione in un'istanza Compute Engine.
   3. Inserisci exit per disconnetterti dall'istanza.
5. Prendi nota del nome dell'istanza, della zona e dell'indirizzo IP esterno perché saranno necessari in seguito.

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 il comando 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 attiva questi servizi obbligatori. 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, 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 seguente comando per verificare 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 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.

Per ulteriori informazioni, consulta Eseguire 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 illustra come configurare Docker sulla tua istanza VM ed eseguire l'API e l'ESP in un container Docker.

installa Docker sull'istanza VM

Per installare Docker sull'istanza VM:

1. Imposta la zona per il progetto eseguendo questo comando:

   gcloud config set compute/zone YOUR_INSTANCE_ZONE
   

   Sostituisci YOUR_INSTANCE_ZONE con la zona in cui è in esecuzione l'istanza.

2. Connettiti all'istanza utilizzando questo comando:

   gcloud compute ssh INSTANCE_NAME
   

   Sostituisci INSTANCE_NAME con il nome della tua istanza VM.

3. Consulta le Documentazione di Docker per configurare il repository Docker. Assicurati di seguire i passaggi corrispondenti alla versione e all'architettura della tua istanza VM:
   • Jessie o più recente
   • x86_64 / amd64

Esegui l'API e l'ESP di esempio in un container Docker

Per eseguire il servizio gRPC di esempio con ESP in un container Docker, ai quali i clienti possano usarlo:

1. Nell'istanza VM, crea la tua rete di container denominata esp_net.

   sudo docker network create --driver bridge esp_net
   

2. Esegui il server Libreria di esempio che pubblica l'API di esempio:

   sudo docker run \
       --detach \
       --name=bookstore \
       --net=esp_net \
       gcr.io/endpointsv2/python-grpc-bookstore-server:1
   

3. Esegui il container Docker ESP predefinito. Nella Opzioni di avvio ESP, sostituzione SERVICE_NAME con il nome del tuo servizio. Si tratta dello stesso nome configurato nel campo name del file api_config.yaml. Per esempio: bookstore.endpoints.example-project-12345.cloud.goog

   sudo docker run \
       --detach \
       --name=esp \
       --publish=80:9000 \
       --net=esp_net \
       gcr.io/endpoints-release/endpoints-runtime:1 \
       --service=SERVICE_NAME \
       --rollout_strategy=managed \
       --http2_port=9000 \
       --backend=grpc://bookstore:8000
   

   Opzione --rollout_strategy=managed configura ESP in modo che utilizzi l'ultima configurazione del servizio di cui è stato eseguito il deployment. Quando specificare questa opzione, fino a 5 minuti dopo il deployment di un nuovo servizio configurazione, ESP rileva la modifica e inizia automaticamente a utilizzarla. Me consigliamo di specificare questa opzione anziché un ID configurazione specifico per ESP. Per maggiori dettagli sugli argomenti ESP, consulta Opzioni di avvio di ESP.

Se hai attivato la Transcodifica, assicurati di configurare una porta per il traffico HTTP1.1 o SSL.

Se viene visualizzato un messaggio di errore, consulta Risoluzione dei problemi relativi agli endpoint su Compute Engine.

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 questo tutorial, non esitare a inviare un feedback nella parte inferiore di 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. Elimina l'API:

   gcloud endpoints services delete SERVICE_NAME

   Sostituisci SERVICE_NAME con il nome del tuo servizio.

2. In the Google Cloud console, go to the VM instances page.

   Go to VM instances

3. Select the checkbox for the instance that you want to delete.
4. To delete the instance, click More actions, click Delete, and then follow the instructions.

Passaggi successivi

• Scopri come configurare l'API gRPC per Endpoint.
• Esamina più da vicino l'esempio di libreria su GitHub. Sia il client sia 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