Introduzione a Endpoints per GKE con ESPv2


Questo tutorial mostra come eseguire il deployment di un semplice servizio gRPC di esempio con Extensible Service Proxy V2 (ESPv2) su Google Kubernetes Engine (GKE). Questo tutorial utilizza la versione Python dell'esempio di bookstore-grpc. Consulta la sezione Passaggi successivi per gli esempi di gRPC in altre lingue.

Il tutorial utilizza immagini container predefinite del codice campione ed ESPv2, archiviate in Container Registry. Se non hai familiarità con i container, consulta quanto segue per saperne di più:

Per una panoramica di Cloud Endpoints, consulta la pagina 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 inviare correttamente richieste all'API.

  1. Configura un progetto Google Cloud e scarica il software necessario. Consulta Prima di iniziare.
  2. Copia e configura i file dall'esempio di bookstore-grpc. Consulta la pagina Configurazione di Endpoints.
  3. Eseguire il deployment della configurazione di Endpoints per creare un servizio endpoint. Vedi Eseguire il deployment della configurazione di Endpoints.
  4. Crea un backend per gestire l'API ed eseguirne il deployment. Vedi Deployment del backend dell'API.
  5. Recupera l'indirizzo IP esterno del servizio. Vedi Recupero dell'indirizzo IP esterno del servizio.
  6. Invia una richiesta all'API. Vedi Invio di una richiesta all'API.
  7. Evita addebiti sul tuo account Google Cloud. 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 possono essere idonei a una prova senza costi aggiuntivi.

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. 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.
  2. Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  3. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

  4. Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  5. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

  6. Prendi nota dell'ID progetto Google Cloud perché sarà necessario 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
    Si apre una nuova scheda del browser e ti viene chiesto di scegliere un account.
  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 per gestirli, consulta Gestione delle configurazioni di gcloud CLI.

  11. Installa kubectl:
    gcloud components install kubectl
  12. Acquisisci nuove credenziali utente da utilizzare come credenziali predefinite dell'applicazione. Sono necessarie le credenziali utente per autorizzare kubectl.
    gcloud auth application-default login
    Nella nuova scheda del browser che si apre, scegli un account.
  13. Segui i passaggi nella guida rapida per gRPC Python per installare gli strumenti gRPC e gRPC.

Configurazione di Endpoints

L'esempio di bookstore-grpc contiene i file che devi copiare in locale e configurare.

  1. Crea un file descrittore autonomo di un protobuf 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 directory seguente: mkdir generated_pb2
    3. Crea il file del descrittore api_descriptor.pb utilizzando il compilatore dei 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 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 salvato bookstore.proto.

  2. Crea un file YAML di configurazione 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 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 in bookstore.proto all'interno del pacchetto endpoints.examples.bookstore. Il nome completo dell'API è endpoints.examples.bookstore.Bookstore, esattamente 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 comando gcloud endpoints services deploy. Questo comando utilizza Service Management per creare un servizio gestito.

  1. Assicurati di essere nella directory in cui si trovano i file api_descriptor.pb e api_config.yaml.
  2. 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
    
  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 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 e bookstore.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

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
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 seguente comando per confermare che i servizi richiesti siano abilitati:

gcloud services list

Se i servizi richiesti non sono elencati, 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 è mostrato sotto la 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 campo name della configurazione degli endpoint gRPC.

Per maggiori 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 Eseguire il deployment della configurazione di Endpoints.

esegui il deployment del backend dell'API

Finora hai eseguito il deployment della configurazione del servizio in Service Management, ma non hai ancora eseguito il deployment del codice per il backend dell'API. Questa sezione ti guida nella creazione di un cluster GKE per ospitare il backend dell'API ed eseguire il deployment dell'API.

Creazione di un cluster di container

Il cluster ha bisogno di un alias IP per utilizzare il bilanciamento del carico nativo del container. Per creare un cluster di container con un alias IP per il nostro esempio:

gcloud container clusters create espv2-demo-cluster \
    --enable-ip-alias \
    --create-subnetwork="" \
    --network=default \
    --zone=us-central1-a

Il comando precedente crea un cluster, espv2-demo-cluster, con una subnet di cui è stato eseguito il provisioning automatico nella zona us-central1-a.

Autenticazione kubectl nel cluster di container

Per utilizzare kubectl per creare e gestire le risorse del cluster, devi ottenere le credenziali del cluster e renderle disponibili per kubectl. Per farlo, esegui il comando seguente, sostituendo NAME con il nome del nuovo cluster e ZONE con la zona del cluster.

gcloud container clusters get-credentials NAME --zone ZONE

Controllo delle autorizzazioni richieste in corso...

ESP ed ESPv2 chiamano i servizi Google che utilizzano IAM per verificare se l'identità di chiamata dispone di autorizzazioni sufficienti per accedere alle risorse IAM utilizzate. L'identità di chiamata è l'account di servizio collegato che esegue il deployment di ESP ed ESPv2.

Quando viene eseguito il deployment nel pod GKE, l'account di servizio collegato è l'account di servizio del nodo. Di solito è l'account di servizio predefinito di Compute Engine. Segui questo consiglio di autorizzazione per scegliere un account di servizio nodo appropriato.

Se si utilizza Workload Identity, è possibile utilizzare un account di servizio separato diverso dall'account di servizio del nodo per comunicare con i servizi Google. Puoi creare un account di servizio Kubernetes affinché il pod esegua ESP ed ESPv2, creare un account di servizio Google e associare l'account di servizio Kubernetes all'account di servizio Google.

Segui questi passaggi per associare un account di servizio Kubernetes a un account di servizio Google. Questo account di servizio Google è l'account di servizio collegato.

Se l'account di servizio collegato è l'account di servizio predefinito di Compute Engine del progetto e il deployment della configurazione del servizio dell'endpoint è stato eseguito nello stesso progetto, l'account di servizio dovrebbe avere autorizzazioni sufficienti per accedere alle risorse IAM. Puoi saltare il passaggio di configurazione dei ruoli IAM che segue. In caso contrario, i seguenti ruoli IAM dovrebbero essere aggiunti all'account di servizio associato.

Aggiungi i ruoli IAM richiesti:

Questa sezione descrive le risorse IAM utilizzate da ESP ed ESPv2 e i ruoli IAM richiesti all'account di servizio collegato per accedere a queste risorse.

Configurazione servizio endpoint

ESP ed ESPv2 chiamano Service Control, che utilizza la configurazione del servizio endpoint. La configurazione del servizio endpoint è una risorsa IAM ed ESP ed ESPv2 devono avere il ruolo Controller di servizio per accedervi.

Il ruolo IAM si trova sulla configurazione del servizio endpoint, non sul progetto. Un progetto può avere più configurazioni di servizi endpoint.

Utilizza il seguente comando gcloud per aggiungere il ruolo all'account di servizio collegato per la configurazione del servizio endpoint.

gcloud endpoints services add-iam-policy-binding SERVICE_NAME \
  --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \
  --role roles/servicemanagement.serviceController

Dove
* SERVICE_NAME è il nome del servizio endpoint
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com è l'account di servizio collegato.

Cloud Trace

ESP ed ESPv2 chiamano il servizio Cloud Trace per esportare Trace in un progetto. Questo progetto è chiamato progetto di tracciamento. In ESP, il progetto di tracciamento e il progetto proprietario della configurazione del servizio endpoint sono gli stessi. In ESPv2, il progetto di tracciamento può essere specificato con il flag --tracing_project_id e il progetto predefinito è il progetto di deployment.

ESP ed ESPv2 richiedono il ruolo Agente Cloud Trace per abilitare Cloud Trace.

Utilizza il seguente comando gcloud per aggiungere il ruolo all'account di servizio collegato:

gcloud projects add-iam-policy-binding TRACING_PROJECT_ID \
  --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \
  --role roles/cloudtrace.agent

Dove
* TRACING_PROJECT_ID è l'ID progetto di tracciamento
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com è l'account di servizio collegato. Per maggiori informazioni, vedi Cosa sono i ruoli e le autorizzazioni?

Configurazione di chiavi e certificati SSL

Il bilanciamento del carico nativo del container utilizza il bilanciatore del carico HTTP2, che deve essere criptato con TLS. Ciò ha richiesto il deployment di un certificato TLS in GKE Ingress ed ESPv2. Puoi utilizzare il tuo certificato, oppure usarne uno autofirmato.

  1. Crea un certificato e una chiave autofirmati utilizzando openssl. Assicurati di aver inserito lo stesso nome di dominio completo bookstore.endpoints.MY_PROJECT_ID.cloud.goog quando viene richiesto "Nome comune(CN)". Questo nome viene utilizzato dai client per verificare il certificato del server.

    openssl req -x509 -nodes -days 365 -newkey rsa:2048 \
    -keyout ./server.key -out ./server.crt
  2. Crea un secret Kubernetes con la chiave e il certificato SSL. Tieni presente che il certificato viene copiato in due posizioni, server.crt e tls.crt, poiché il secret viene fornito sia a GKE in entrata sia a ESPv2. GKE Ingress cerca il percorso del certificato tls.crt, mentre ESPv2 cerca il percorso del certificato server.crt.

    kubectl create secret generic esp-ssl \
    --from-file=server.crt=./server.crt --from-file=server.key=./server.key \
    --from-file=tls.crt=./server.crt --from-file=tls.key=./server.key

Deployment dell'API di esempio ed ESPv2 nel cluster

Per eseguire il deployment del servizio gRPC di esempio nel cluster in modo che i client possano utilizzarlo:

  1. git clone questo repository e aprilo per modificare il file manifest di deployment di grpc-bookstore.yaml.
  2. Sostituisci SERVICE_NAME con il nome del servizio Endpoints per il traffico in entrata e il container ESPv2. Si tratta dello stesso nome che hai configurato nel campo name nel file api_config.yaml.
    # Copyright 2016 Google Inc.
    #
    # Licensed under the Apache License, Version 2.0 (the "License");
    # you may not use this file except in compliance with the License.
    # You may obtain a copy of the License at
    #
    #     http://www.apache.org/licenses/LICENSE-2.0
    #
    # Unless required by applicable law or agreed to in writing, software
    # distributed under the License is distributed on an "AS IS" BASIS,
    # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    # See the License for the specific language governing permissions and
    # limitations under the License
    
    # Use this file to deploy the container for the grpc-bookstore sample
    # and the container for the Extensible Service Proxy (ESP) to
    # Google Kubernetes Engine (GKE).
    
    apiVersion: networking.k8s.io/v1beta1
    kind: Ingress
    metadata:
      name: esp-grpc-bookstore
      annotations:
        kubernetes.io/ingress.class: "gce"
        kubernetes.io/ingress.allow-http: "false"
    spec:
      tls:
      - hosts:
        - SERVICE_NAME
        secretName: esp-ssl
      backend:
        serviceName: esp-grpc-bookstore
        servicePort: 443
    ---
    apiVersion: cloud.google.com/v1
    kind: BackendConfig
    metadata:
      name: esp-grpc-bookstore
    spec:
      healthCheck:
        type: HTTP2
        requestPath: /healthz
        port: 9000
    ---
    apiVersion: v1
    kind: Service
    metadata:
      name: esp-grpc-bookstore
      annotations:
        service.alpha.kubernetes.io/app-protocols: '{"esp-grpc-bookstore":"HTTP2"}'
        cloud.google.com/neg: '{"ingress": true, "exposed_ports": {"443":{}}}'
        cloud.google.com/backend-config: '{"default": "esp-grpc-bookstore"}'
    spec:
      ports:
      # Port that accepts gRPC and JSON/HTTP2 requests over TLS.
      - port: 443
        targetPort: 9000
        protocol: TCP
        name: esp-grpc-bookstore
      selector:
        app: esp-grpc-bookstore
      type: ClusterIP
    ---
    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: esp-grpc-bookstore
    spec:
      replicas: 1
      selector:
        matchLabels:
          app: esp-grpc-bookstore
      template:
        metadata:
          labels:
            app: esp-grpc-bookstore
        spec:
          volumes:
          - name: esp-ssl
            secret:
              secretName: esp-ssl
          containers:
          - name: esp
            image: gcr.io/endpoints-release/endpoints-runtime:2
            args: [
              "--listener_port=9000",
              "--service=SERVICE_NAME",
              "--rollout_strategy=managed",
              "--backend=grpc://127.0.0.1:8000",
              "--healthz=/healthz",
              "--ssl_server_cert_path=/etc/esp/ssl",
            ]
            ports:
              - containerPort: 9000
            volumeMounts:
            - mountPath: /etc/esp/ssl
              name:  esp-ssl
              readOnly: true
          - name: bookstore
            image: gcr.io/endpointsv2/python-grpc-bookstore-server:1
            ports:
              - containerPort: 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 dopo il 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 configurazione specifico per ESPv2. Per maggiori dettagli sugli argomenti ESPv2, consulta Opzioni di avvio di ESPv2.

    Ad esempio:

        spec:
          containers:
          - name: esp
            image: gcr.io/endpoints-release/endpoints-runtime:2
            args: [
              "--listener_port=9000",
              "--service=bookstore.endpoints.example-project-12345.cloud.goog",
              "--rollout_strategy=managed",
              "--backend=grpc://127.0.0.1:8000"
            ]
    
  3. Avvia il servizio:
    kubectl create -f grpc-bookstore.yaml
    

Se viene visualizzato un messaggio di errore, consulta Risoluzione dei problemi di Endpoints in GKE.

Ottenere l'indirizzo IP esterno del servizio

Per inviare richieste all'API di esempio è necessario l'indirizzo IP esterno del servizio. Dopo l'avvio del servizio nel container, potrebbero essere necessari alcuni minuti prima che l'indirizzo IP esterno sia pronto.

  1. Visualizza l'indirizzo IP esterno:

    kubectl get ingress

  2. Prendi nota del valore di EXTERNAL-IP e salvalo in una variabile di ambiente SERVER_IP. L'indirizzo IP esterno viene utilizzato per inviare richieste all'API di esempio.

    export SERVER_IP=YOUR_EXTERNAL_IP
    

Invio di una richiesta all'API

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. Crea una CA radice per il certificato autofirmato

    openssl x509 -in server.crt -out client.pem -outform PEM
      

  5. Invia una richiesta all'API di esempio:

    python bookstore_client.py --host SERVER_IP --port 443 \
    --servername bookstore.endpoints.MY_PROJECT_ID.cloud.goog --use_tls true --ca_path=client.pem
    
    • 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.

      Vai alla pagina Esplora log

Se non ottieni una risposta corretta, consulta la sezione Risoluzione degli 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. Elimina l'API:

    gcloud endpoints services delete SERVICE_NAME
    

    Sostituisci SERVICE_NAME con il nome della tua API.

  2. Elimina il cluster GKE:

    gcloud container clusters delete NAME --zone ZONE
    

Passaggi successivi

  • Scopri come configurare la tua API gRPC per Cloud Endpoints.
  • Dai un'occhiata all'esempio della libreria 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: