Questo tutorial mostra come eseguire il deployment di un semplice servizio gRPC di esempio con Extensible Service Proxy 2 (ESPv2) in un gruppo di istanze gestite.
Questo tutorial utilizza la versione Python dell'esempio bookstore-grpc
. Consulta la sezione Passaggi successivi per gli esempi gRPC in altri linguaggi.
Per una panoramica di Cloud Endpoints, consulta Informazioni su Endpoints e Architettura di Endpoints.
Obiettivi
Segui il seguente elenco di attività di alto livello durante il tutorial. Tutte le attività sono necessarie per inviare richieste all'API.
- Configura un Google Cloud progetto e scarica il software necessario. Vedi Prima di iniziare.
- Copia e configura i file dall'esempio
bookstore-grpc
. Consulta Configurare Endpoints. - Esegui il deployment della configurazione di Endpoints per creare un servizio Endpoints. Consulta Eseguire il deployment della configurazione di Endpoints.
- Esegui il deployment dell'API e di ESPv2 sul backend del gruppo di istanze gestite. Consulta Eseguire il deployment del backend dell'API.
- Invia una richiesta all'API. Consulta Invio di una richiesta all'API.
- Evitare che al tuo Google Cloud account vengano addebitati costi. Consulta 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.
Al termine delle attività descritte in questo documento, puoi evitare la fatturazione continua eliminando le risorse che hai creato. Per ulteriori informazioni, consulta la sezione Pulizia.
Prima di iniziare
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure 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.
-
Make sure that billing is enabled for your Google Cloud project.
- Prendi nota dell'ID progetto perché ti servirà in seguito.
- Installa e inizializza Google Cloud CLI.
- Aggiorna l'interfaccia a riga di comando gcloud e installa i componenti Endpoints:
gcloud components update
-
Assicurati che Google Cloud CLI (
gcloud
) sia autorizzato ad accedere ai tuoi dati e servizi su Google Cloud: Nella nuova scheda del browser che si apre, seleziona un account.gcloud auth login
-
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 Google Cloud progetti e vuoi utilizzare
gcloud
per gestirli, consulta Gestire le configurazioni dell'interfaccia a riga di comando gcloud. - Segui i passaggi descritti nella guida introduttiva di gRPC per Python per installare gRPC e gli strumenti gRPC.
Al termine delle attività descritte in questo documento, puoi evitare la fatturazione continua eliminando le risorse che hai creato. Per ulteriori informazioni, consulta la sezione Pulizia.
Configurazione di Endpoints
Clona il repository di esempi bookstore-grpc
da GitHub.
Per configurare Endpoints:
- Crea un file descrittore protobuf autonomo 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 seguente directory:
mkdir generated_pb2
- Crea il file descrittore
api_descriptor.pb
utilizzando il compilatore di 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 corrente. Nell'ambiente di compilazione 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 dell'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 file
api_config.yaml
con il tuo 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 inbookstore.proto
all'interno del pacchettoendpoints.examples.bookstore
. Il nome completo dell'API èendpoints.examples.bookstore.Bookstore
, proprio come appare nel fileapi_config.yaml
.apis: - name: endpoints.examples.bookstore.Bookstore
- Salva una copia del
Per ulteriori informazioni, consulta Configurare gli endpoint.
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 servizi per creare un servizio gestito.
- Assicurati di trovarti nella directory in cui si trovano i file
api_descriptor.pb
eapi_config.yaml
. - Verifica che il progetto predefinito attualmente utilizzato dallo strumento a riga di comando
gcloud
sia il progetto in cui vuoi eseguire il deployment della configurazione di Endpoints. Google Cloud 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 il seguente comando:
gcloud config set project YOUR_PROJECT_ID
- Esegui il deployment del file
proto descriptor
e del file di configurazione utilizzando l'interfaccia a Google Cloud CLI:gcloud endpoints services deploy api_descriptor.pb api_config.yaml
Durante la creazione e la configurazione del servizio, Service Management visualizza informazioni sul 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 configurazione del servizio ebookstore.endpoints.example-project.cloud.goog
è il nome del servizio. L'ID configurazione del servizio è costituito da un timestamp seguito da un numero di revisione. Se esegui nuovamente il deployment della configurazione di Endpoints nello stesso giorno, il numero di revisione viene incrementato nell'ID configurazione del servizio.
Verifica dei 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 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 e non includi questi servizi.
Hai eseguito il deployment della configurazione di Endpoints in un progettoGoogle Cloud esistente 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 i servizi richiesti nell'elenco, attivali:
gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.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 Endpoints nella console Cloud. L'elenco dei possibili ENDPOINTS_SERVICE_NAME è riportato nella colonna Nome servizio.
Per OpenAPI, ENDPOINTS_SERVICE_NAME è il valore specificato nel campo
host
della specifica OpenAPI. Per gRPC, ENDPOINTS_SERVICE_NAME è il valore specificato nel camponame
della configurazione degli endpoint gRPC.
Per ulteriori informazioni sui comandi gcloud
, consulta
Servizi gcloud
.
Se viene visualizzato 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 la procedura per configurare Docker nel gruppo di istanze gestite ed eseguire il codice di backend dell'API e 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 ESPv2 e un server applicazioni backend.
Nella console Google Cloud, vai alla pagina Modelli di istanza.
Fai clic su Crea modello istanza.
In Nome, inserisci
load-balancing-espv2-template
.In Configurazione macchina, imposta Tipo di macchina su
e2-micro
.In Disco di avvio, imposta Immagine su
Container Optimized OS stable version
.In Firewall, seleziona Consenti traffico HTTP.
Fai clic su Gestione, sicurezza, dischi, networking, single-tenancy per visualizzare le impostazioni avanzate.
Fai clic sulla scheda Gestione. In Automazione, inserisci il seguente 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 di applicazioni echo e il server proxy ESPv2 all'avvio dell'istanza.
Fai clic su Crea.
Attendi il completamento della creazione del modello prima di continuare.
Crea un gruppo di istanze gestite regionale
Per eseguire l'applicazione, utilizza il modello di istanza per creare un gruppo di istanze gestite regionale:
Nella console Google Cloud, vai alla pagina Gruppi di istanze.
Fai clic su Crea gruppo di istanze.
In Nome, inserisci
load-balancing-espv2-group
.In Località, seleziona Più zone.
In Regione, seleziona us-central1.
Fai clic sul menu a discesa Configura zone per visualizzare Zone. Seleziona le seguenti zone:
- us-central1-b
- us-central1-c
- us-central1-f
In Modello di istanza, seleziona
load-balancing-espv2-template
.In Scalabilità automatica, seleziona Non scalare automaticamente.
Imposta Numero di istanze su
3
.In Ridistribuzione delle istanze, seleziona On.
In Riparazione automatica e Controllo di integrità, seleziona Nessun controllo di integrità.
Fai clic su Crea. Verrà visualizzata nuovamente la pagina Gruppi di istanze.
Crea un bilanciatore del carico
Questa sezione spiega i passaggi necessari per creare un bilanciatore del carico regionale che indirizzi il traffico TCP al gruppo di istanze.
Nella console Google Cloud, vai alla pagina Crea un bilanciatore del carico.
In Bilanciamento del carico TCP, fai clic su Avvia configurazione.
In Per internet o solo interno, seleziona Da internet alle mie VM.
In Più regioni o una sola regione, seleziona Solo una regione.
In Tipo di backend, seleziona Servizio di backend.
Fai clic su Continua.
In Nome, inserisci
espv2-load-balancer
.In Configurazione backend, seleziona la regione us-central1.
Seleziona il gruppo di istanze
load-balancing-espv2-group
.In Controllo di integrità, crea un nuovo controllo di integrità.
- In Nome, inserisci
espv2-load-balancer-check
. - Verifica che Protocollo sia TCP e che Porta sia 80.
- In Nome, inserisci
In Configurazione frontend, inserisci il numero di porta 80.
In Esamina e finalizza, verifica
- Il gruppo di istanze è
load-balancing-espv2-group
. - La regione è
us-central1
. - Il protocollo è
TCP
. - IP:Porta è
EPHEMERAL:80
.
- Il gruppo di istanze è
Una volta creato il bilanciatore del carico, individua l'indirizzo IP nella pagina Bilanciatore del carico.
Invio di 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.
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
Esamina i grafici delle 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.
Se non ricevi una risposta positiva, consulta la sezione Risoluzione dei problemi relativi alle risposte.
Hai 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.
Assicurati che l'interfaccia a riga di comando gcloud (
gcloud
) sia autorizzata ad accedere ai tuoi dati e servizi su Google Cloud:gcloud auth login
Inserisci quanto segue per visualizzare gli ID progetto per i tuoi Google Cloud progetti:
gcloud projects list
Utilizzando l'ID progetto applicabile del passaggio precedente, imposta il progetto Google Cloud predefinito su quello in cui si trova la tua applicazione:
gcloud config set project [YOUR_PROJECT_ID]
Ottieni il nome di tutti i servizi gestiti nel tuo progetto Google Cloud:
gcloud endpoints services list
Elimina il servizio da Gestione servizi. 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.Vai alla pagina Bilanciatore del carico.
Elimina il bilanciatore del carico
espv2-load-balancer
con il controllo di integritàespv2-load-balancer-check
.Vai alla pagina Gruppi di istanze.
Elimina
load-balancing-espv2-group
Vai alla pagina Modello di istanza.
Elimina
load-balancing-espv2-template
.