Iniziare a utilizzare Endpoints per Compute Engine con ESPv2

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 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. Crea un'istanza VM di Compute Engine. Consulta Creazione di un'istanza Compute Engine.
  3. Copia e configura i file dal bookstore-grpc esempio. 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. Esegui il deployment dell'API e di ESPv2 sulla VM di Compute Engine. Consulta Esegui il deployment del backend dell'API.
  6. Invia una richiesta all'API. Consulta Invia una richiesta all'API.
  7. 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:

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

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

  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 role (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 role (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 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.
  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 e vuoi utilizzare gcloud per gestirli, consulta Gestire le configurazioni di gcloud CLI. Google Cloud

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

Creazione di un'istanza Compute Engine

Per creare un'istanza Compute Engine:

  1. Nella Google Cloud console, vai alla pagina Crea un'istanza.

    Vai a Crea un'istanza

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

    5. Screenshot della finestra di creazione dell'istanza VM con le opzioni richieste impostate

    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.

  5. Assicurati di poter connetterti all'istanza VM.
    1. Nell'elenco delle istanze della macchina virtuale, fai clic su SSH nella riga di l'istanza a cui vuoi connetterti.
    2. Ora puoi utilizzare il terminale per eseguire i comandi Linux sull'istanza Debian.
    3. Inserisci exit per disconnetterti dall'istanza.
  6. Prendi nota del nome dell'istanza, della zona e dell'indirizzo IP esterno perché ti serviranno in seguito.

Configurazione di Endpoints

Clona il bookstore-grpc esempio 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'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 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 hai incluso questi servizi.

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

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

gcloud services list

Se non vedi i servizi richiesti elencati, abilitali:

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 viene visualizzato nella colonna Nome servizio.

  • Per OpenAPI, il ENDPOINTS_SERVICE_NAME è quello specificato nel campo host della specifica OpenAPI. Per gRPC, il ENDPOINTS_SERVICE_NAME è quello 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 relativi al 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 che gestisce il backend dell'API. Questa sezione ti guida nella configurazione di Docker sull'istanza VM e nell'esecuzione del codice del backend dell'API e di ESPv2 in un container Docker.

Installa Docker sull'istanza VM

Per installare Docker sull'istanza VM:

  1. Imposta la zona del 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.

  2. Connettiti all'istanza utilizzando il seguente comando: 
    gcloud compute ssh INSTANCE_NAME

    Sostituisci INSTANCE_NAME con il nome dell'istanza VM.

  3. Consulta la documentazione di Docker per configurare il repository Docker. Assicurati di seguire i passaggi che corrispondono alla versione e all'architettura dell'istanza VM:
    • Jessie o versioni successive
    • 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:

  1. Nell'istanza VM, crea una rete di container personalizzata chiamata esp_net. 
    sudo docker network create --driver bridge esp_net
  2. 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
  3. Esegui il container Docker ESPv2 preconfigurato. Nelle opzioni di avvio di ESPv2, sostituisci SERVICE_NAME con il nome del servizio. Questo è lo stesso nome che hai configurato nel name campo nel api_config.yaml file. 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 la configurazione del servizio di cui è stato eseguito il deployment più recente. Quando specifichi questa opzione, entro un minuto dall'esecuzione del 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 da utilizzare per ESPv2. Per maggiori dettagli sugli argomenti di ESPv2, consulta Opzioni di avvio di ESPv2.

Se ricevi un messaggio di errore, consulta Risoluzione dei problemi relativi a Endpoints su Compute Engine.

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.

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. Elimina l'API: 
    gcloud endpoints services delete SERVICE_NAME

    Sostituisci SERVICE_NAME con il nome del servizio.

  2. Nella Google Cloud console, vai alla pagina Istanze VM.

    Vai a Istanze VM

  3. Seleziona la casella di controllo per l'istanza che vuoi eliminare.
  4. Per eliminare l'istanza, fai clic su Altre azioni, poi su Elimina, e segui le istruzioni.

Passaggi successivi