Questo tutorial mostra come eseguire il deployment di un semplice servizio gRPC di esempio con Extensible Service Proxy V2 (ESPv2) in un container Docker in Compute Engine.
Questo tutorial utilizza la versione Python del campione di bookstore-grpc
. Consulta la sezione Passaggi successivi per gli esempi gRPC in altre lingue.
Per una panoramica di Cloud Endpoints, consulta Informazioni su Endpoints ed architettura degli endpoint.
Obiettivi
Utilizza il seguente elenco di attività di alto livello mentre svolgi il tutorial. Tutte le attività sono necessarie per poter inviare correttamente richieste all'API.
- Configura un progetto Google Cloud e scarica il software richiesto. Vedi Prima di iniziare.
- Creare un'istanza VM di Compute Engine. Consulta la pagina relativa alla creazione di un'istanza Compute Engine.
- Copia e configura i file dall'esempio
bookstore-grpc
. Vedi Configurazione di Endpoints. - Esegui il deployment della configurazione di Endpoints per creare un servizio endpoint. Vedi Deployment della configurazione di Endpoints.
- Eseguire il deployment dell'API e di ESPv2 sulla VM di Compute Engine. Vedi Deployment del backend dell'API.
- Invia una richiesta all'API. Vedi Invio di una richiesta all'API.
- Evita che al tuo account Google Cloud vengano addebitati costi. Vedi Pulizia.
Costi
In questo documento, utilizzi i seguenti componenti fatturabili di Google Cloud:
Per generare una stima dei costi in base all'utilizzo previsto, utilizza il Calcolatore prezzi.
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
- Accedi al tuo account Google Cloud. 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 gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.
- Prendi nota dell'ID progetto perché ti servirà in un secondo momento.
- Installa e inizializza Google Cloud CLI.
- Aggiorna gcloud CLI e installa i componenti di Endpoints:
gcloud components update
-
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. -
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
per gestirli, consulta Gestione della gcloud CLI gcloud. - Segui i passaggi nella guida rapida di gRPC per Python per installare gli strumenti gRPC e 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.
Creazione di un'istanza Compute Engine
Per creare un'istanza Compute Engine:
- Nella console Google Cloud, vai alla pagina Crea un'istanza.
- Nella sezione Firewall, seleziona Consenti traffico HTTP e Consenti traffico HTTPS.
- Per creare la VM, fai clic su Crea.
- Assicurati di poterti connettere all'istanza VM.
- Nell'elenco delle istanze di macchine virtuali, fai clic su SSH nella riga dell'istanza a cui vuoi connetterti.
- Ora puoi utilizzare il terminale per eseguire i comandi Linux sulla tua istanza Debian.
- Inserisci
exit
per disconnetterti dall'istanza.
- Prendi nota del nome dell'istanza, della zona e dell'indirizzo IP esterno perché saranno necessari in seguito.
Potrebbe essere necessario un po' di tempo per l'avvio dell'istanza. Una volta pronta, viene elencata nella pagina Istanze VM con un'icona di stato verde.
Configurazione di Endpoints
Clona il repository bookstore-grpc
di esempio da GitHub.
Per configurare Endpoints:
- Crea un file descrittore autonomo di un protobuf dal file
.proto
del servizio:- Salva una copia di
bookstore.proto
dal repository di esempio. Questo file definisce l'API del servizio Bookstore. - Crea la directory seguente:
mkdir generated_pb2
- Crea il file del descrittore
api_descriptor.pb
utilizzando il compilatore dei buffer di protocolloprotoc
. Esegui questo comando nella directory in cui hai salvatobookstore.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 attuale. Nel tuo ambiente di build gRPC, se utilizzi una directory diversa per i file di input.proto
, modifica--proto_path
in modo che il compilatore cerchi nella directory in cui hai salvatobookstore.proto
.
- Salva una copia di
- Crea un file YAML di configurazione API gRPC:
- Salva una copia del
api_config.yaml
file. Questo file definisce la configurazione dell'API gRPC per il servizio Bookstore. - Sostituisci MY_PROJECT_ID nel tuo file
api_config.yaml
con l'ID del tuo 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
; altrimenti il deployment non funzionerà. Il servizio Libreria è definito inbookstore.proto
all'interno del pacchettoendpoints.examples.bookstore
. Il nome completo dell'API èendpoints.examples.bookstore.Bookstore
, esattamente come appare nel fileapi_config.yaml
.apis: - name: endpoints.examples.bookstore.Bookstore
- Salva una copia del
Per ulteriori informazioni, consulta Configurazione di Endpoints.
Eseguire il deployment della configurazione di Endpoints
Per eseguire il deployment della configurazione di Endpoints, utilizza il comando gcloud endpoints services deploy
. Questo comando utilizza Service Management per creare un servizio gestito.
- Assicurati di essere nella directory in cui si trovano i file
api_descriptor.pb
eapi_config.yaml
. - Verifica che il progetto predefinito utilizzato attualmente dallo strumento a riga di comando
gcloud
sia il progetto Google Cloud in cui vuoi eseguire il deployment della configurazione degli endpoint. Convalida l'ID progetto restituito dal comando seguente per assicurarti che il servizio non venga creato nel progetto sbagliato.gcloud config list project
Se devi modificare il progetto predefinito, esegui il comando seguente:
gcloud config set project YOUR_PROJECT_ID
- 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 genera 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 ebookstore.endpoints.example-project.cloud.goog
è il nome del servizio. L'ID di configurazione del servizio è costituito da un timestamp con un numero di revisione. Se esegui nuovamente il deployment della configurazione Endpoint, lo stesso giorno, il numero di revisione viene aumentato nell'ID configurazione del servizio.
Controllo dei servizi richiesti in corso...
Come minimo, Endpoints ed ESP richiedono che siano abilitati i seguenti servizi Google: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, ma non abilita i servizi richiesti nelle seguenti circostanze:
Se hai utilizzato un'applicazione di terze parti come Terraform e non includi questi servizi.
Hai eseguito il deployment della configurazione di Endpoints in un progetto Google Cloud esistente in cui questi servizi sono stati disabilitati esplicitamente.
Utilizza il comando seguente per confermare che i servizi richiesti siano abilitati:
gcloud services list
Se i servizi richiesti non sono elencati, attivali:
gcloud services enable servicemanagement.googleapis.comgcloud services enable servicecontrol.googleapis.com
gcloud services enable endpoints.googleapis.com
Abilita anche il servizio Endpoints:
gcloud services enable ENDPOINTS_SERVICE_NAME
Per determinare i 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, il valore ENDPOINTS_SERVICE_NAME è quello specificato nel campo
host
della specifica OpenAPI. Per gRPC, il valore ENDPOINTS_SERVICE_NAME è quello specificato nel camponame
della configurazione degli endpoint gRPC.
Per ulteriori informazioni sui comandi gcloud
, consulta la pagina relativa ai servizi gcloud
.
Se viene visualizzato un messaggio di errore, consulta Risoluzione dei problemi di deployment della configurazione di Endpoints. Per ulteriori informazioni, consulta Deployment della configurazione di Endpoints.
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 sull'istanza VM e come eseguire il codice di backend dell'API e ESPv2 in un container Docker.
Installa Docker sull'istanza VM
Per installare Docker sull'istanza VM:
- Imposta la zona per il tuo progetto eseguendo il comando:
gcloud config set compute/zone YOUR_INSTANCE_ZONE
Sostituisci YOUR_INSTANCE_ZONE con la zona in cui è in esecuzione l'istanza.
- Connettiti all'istanza utilizzando il comando seguente:
gcloud compute ssh INSTANCE_NAME
Sostituisci INSTANCE_NAME con il nome dell'istanza VM.
- Consulta la documentazione di Docker per configurare il repository Docker. Assicurati di seguire i passaggi corrispondenti alla versione e all'architettura dell'istanza VM:
- Jessie o più recenti
- x86_64 / amd64
Esegui l'API di esempio e ESPv2 in un container Docker
Per eseguire il servizio gRPC di esempio con ESPv2 in un container Docker in modo che i client possano utilizzarlo:
- Nell'istanza VM, crea la tua rete di container denominata
esp_net
.sudo docker network create --driver bridge esp_net
- Esegui il server Bookstore di esempio che gestisce l'API di esempio:
sudo docker run \ --detach \ --name=bookstore \ --net=esp_net \ gcr.io/endpointsv2/python-grpc-bookstore-server:1
- Esegui il container Docker ESPv2 preconfigurato. Nelle opzioni di avvio di ESPv2, sostituisci SERVICE_NAME con il nome del tuo servizio. Si tratta dello stesso nome che hai configurato nel campo
name
del fileapi_config.yaml
. Ad 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:2 \ --service=SERVICE_NAME \ --rollout_strategy=managed \ --listener_port=9000 \ --backend=grpc://bookstore:8000
L'opzione
--rollout_strategy=managed
configura ESPv2 in modo che utilizzi l'ultima configurazione del servizio di cui è stato eseguito il deployment. Quando specifichi questa opzione, entro un minuto dal deployment di una nuova configurazione del servizio, ESPv2 rileva la modifica e inizia automaticamente a utilizzarla. Ti consigliamo di specificare questa opzione anziché fornire un ID di configurazione specifico per ESPv2. Per maggiori dettagli sugli argomenti ESPv2, consulta Opzioni di avvio ESPv2.
Se viene visualizzato un messaggio di errore, consulta Risoluzione dei problemi di Endpoints su Compute Engine.
Invio di una richiesta all'API
Se stai inviando 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.
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 Python.
Clona il repository Git in cui è ospitato il codice client gRPC:
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
Cambia la directory di lavoro:
cd python-docs-samples/endpoints/bookstore-grpc/
Installa le dipendenze:
pip install virtualenv
virtualenv env
source env/bin/activate
python -m pip install -r requirements.txt
Invia una richiesta all'API di esempio:
python bookstore_client.py --host SERVER_IP --port 80
Consulta i grafici delle attività per la tua API nella pagina Endpoint > Servizi.
Vai alla pagina Servizi endpoint
Potrebbero essere necessari alcuni istanti perché la richiesta venga riportata nei grafici.
Esamina i log delle richieste per la tua API nella pagina Esplora log.
Se non ricevi una risposta corretta, consulta la sezione Risoluzione dei problemi relativi agli errori di risposta.
Hai appena eseguito il deployment e il test di un'API in Endpoints.
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.
- Elimina l'API:
gcloud endpoints services delete SERVICE_NAME
Sostituisci
SERVICE_NAME
con il nome del tuo servizio. - Nella console Google Cloud, vai alla pagina Istanze VM.
- Seleziona la casella di controllo per l'istanza che vuoi eliminare.
- Per eliminare l'istanza, fai clic su Altre azioni, quindi su Elimina e segui le istruzioni.
Passaggi successivi
- Scopri come configurare la tua API gRPC per Endpoints.
- Dai un'occhiata all'esempio di Bookstore su GitHub in modo più dettagliato. Sia il client che il server sono disponibili in Python e Java.
- L'esempio
getting-started-grpc
è disponibile su GitHub nei seguenti linguaggi: