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

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

Questo tutorial utilizza la versione Python dell'esempio bookstore-grpc. Consulta la sezione Passaggi successivi per 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 progetto Google Cloud e scarica il software richiesto. Vedi Prima di iniziare.
  2. Copia e configura i file dall'esempio bookstore-grpc. Consulta la sezione Configurazione di Endpoints.
  3. Esegui il deployment della configurazione di Endpoints per creare un servizio Endpoints. Vedi Deployment della configurazione di Endpoints.
  4. Esegui il deployment dell'API e di ESPv2 nel backend del gruppo di istanze gestite. Consulta Esegui il 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. Vedi Pulizia.

Costi

In questo documento vengono utilizzati i seguenti componenti fatturabili di Google Cloud:

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il calcolatore prezzi.

I nuovi utenti di Google Cloud 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 ulteriori informazioni, vedi 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.

    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 (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify 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.

    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 (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  5. Verify that billing is enabled for your Google Cloud project.

  6. Prendi nota dell'ID progetto perché ti servirà in seguito.
  7. Installa e inizializza Google Cloud CLI.
  8. Aggiorna gcloud CLI e installa i componenti di Endpoints: 
    gcloud components update
  9. Assicurati che Google Cloud CLI (gcloud) sia autorizzata ad accedere ai tuoi dati e servizi su Google Cloud: 
    gcloud auth login
     Nella nuova scheda del browser che si apre, seleziona un account.
  10. 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 Google Cloud e vuoi utilizzare gcloud per gestirli, consulta la sezione Gestione delle configurazioni di gcloud CLI.

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

    12. Al termine delle attività descritte in questo documento, puoi evitare l'addebito di ulteriori costi eliminando le risorse che hai creato. Per ulteriori informazioni, vedi Pulizia.

Configurazione di Endpoints

Clona il repository di bookstore-grpc esempio 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. 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 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 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 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

Per ulteriori informazioni, consulta la sezione Configurazione degli 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 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 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
  3. 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 e bookstore.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.

Controllo dei servizi richiesti

Come minimo, Endpoints ed ESP richiedono l'abilitazione 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 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 progettoGoogle Cloud esistente in cui questi servizi sono stati disattivati in modo esplicito.

Utilizza questo comando per verificare che i servizi richiesti siano abilitati:

gcloud services list

Se non vedi i servizi richiesti elencati, 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 il 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, ENDPOINTS_SERVICE_NAME è ciò che hai specificato nel campo host della specifica OpenAPI. Per gRPC, ENDPOINTS_SERVICE_NAME è ciò che hai specificato nel campo name della configurazione di gRPC Endpoints.

Per saperne di più sui comandi gcloud, consulta servizi gcloud.

Se ricevi un messaggio di errore, consulta la sezione 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 ti guida nella configurazione di Docker nel gruppo di istanze gestite e nell'esecuzione del codice di 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 ESPv2 e un server delle applicazioni di backend.

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

    Vai a Template 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. 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.

Attendi il completamento della 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 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.

  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 scalare automaticamente.

  9. Imposta Numero di istanze su 3.

  10. In Ridistribuzione delle istanze, seleziona On.

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

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

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 console Google Cloud , 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 che Porta sia 80.

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

  12. In Esamina e finalizza, verifica

    • Gruppo di istanze = load-balancing-espv2-group.
    • La Regione è us-central1.
    • Protocollo = TCP.
    • IP:Porta è EPHEMERAL:80.

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

    Vai a 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. Altrimenti, 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

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

      Vai alla pagina Esplora log

Se non ricevi una risposta riuscita, consulta la sezione Risoluzione dei problemi relativi agli errori di risposta.

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.

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

    gcloud auth login

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

    gcloud projects list

  3. Utilizzando l'ID progetto applicabile del passaggio precedente, imposta il progettoGoogle Cloud predefinito su 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 vuoi rimuovere.

    gcloud endpoints services delete SERVICE_NAME

    L'esecuzione di gcloud endpoints services delete non elimina immediatamente il servizio gestito. La gestione dei servizi 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 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