Introduzione a Cloud Endpoints per GKE con ESPv2

---

OpenAPI | gRPC

Questo tutorial mostra come configurare ed eseguire il deployment di un'API di esempio e di Extensible Service Proxy V2 (ESPv2) in un cluster Google Kubernetes Engine (GKE).

L'API REST del codice campione è descritta utilizzando la specifica OpenAPI. Il tutorial mostra anche come creare una chiave API e utilizzarla quando si inviano richieste all'API.

Il tutorial utilizza immagini container predefinite del codice di esempio e di ESPv2, che sono archiviate in Container Registry.

Per una panoramica di Cloud Endpoints, consulta Informazioni sugli endpoint ed architettura degli endpoint.

Obiettivi

Durante il tutorial, utilizza il seguente elenco di attività di alto livello. Tutte le attività nella Parte 1 sono obbligatorie per inviare correttamente le richieste all'API.

Parte 1

1. Configurare un progetto Google Cloud. Vedi Prima di iniziare.
2. Creare un cluster di container su GKE. Vedi Creazione di un cluster di container.
3. Installa e configura il software utilizzato nel tutorial. Vedi Installare e configurare il software richiesto.
4. Scarica il codice campione. Vedi Generare il codice campione.
5. Configura il file openapi.yaml, che viene utilizzato per configurare Cloud Endpoints. Vedi Configurazione degli endpoint.
6. Eseguire il deployment della configurazione Endpoints per creare un servizio Endpoints. Vedi Deployment della configurazione endpoint.
7. Eseguire il deployment dell'API e di ESPv2 nel cluster. Vedi Deployment del backend API.
8. Recupera l'indirizzo IP del cluster. Vedi Ottenere l'indirizzo IP esterno del cluster.
9. Inviare una richiesta all'API utilizzando un indirizzo IP. Vedi Inviare una richiesta utilizzando un indirizzo IP.
10. Monitora l'attività dell'API. Consulta Attività dell'API di monitoraggio.

Parte 2

1. Configura un record DNS per l'API di esempio. Vedi Configurazione del DNS per gli endpoint.
2. Invia una richiesta all'API utilizzando il nome di dominio completo. Vedi Inviare una richiesta utilizzando il nome di dominio completo.

Pulizia

Al termine, consulta l'articolo sulla pulizia per evitare che al tuo account Google Cloud vengano addebitati costi.

Costi

Questo tutorial utilizza i seguenti componenti fatturabili di Google Cloud:

• GKE
• Endpoint

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il Calcolatore prezzi. I nuovi utenti di Google Cloud possono beneficiare di una prova gratuita.

Al termine di questo tutorial, puoi evitare una fatturazione continua eliminando le risorse che hai creato. Per scoprire di più, vedi 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 dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.

   Nota: se non hai intenzione di mantenere le risorse che crei in questa procedura, crea un progetto invece di selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto e rimuovere tutte le risorse associate.

   Vai al selettore progetti

3. Assicurati che la fatturazione sia attivata per il tuo progetto Cloud. Scopri come verificare se la fatturazione è abilitata su un progetto.

4. Nella pagina del selettore dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.

   Nota: se non hai intenzione di mantenere le risorse che crei in questa procedura, crea un progetto invece di selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto e rimuovere tutte le risorse associate.

   Vai al selettore progetti

5. Assicurati che la fatturazione sia attivata per il tuo progetto Cloud. Scopri come verificare se la fatturazione è abilitata su un progetto.

6. Prendi nota dell'ID progetto Google Cloud, perché è necessario in seguito.

Creazione di un cluster di container

Devi creare un cluster di container su GKE perché venga eseguito il codice di backend dell'API di esempio. Il cluster necessita di un alias IP per utilizzare il bilanciamento del carico nativo del container. Per creare un cluster di container con un alias IP per l'API di esempio:

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

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

Prendi nota del nome e della zona del cluster perché sono necessari quando autentichi kubectl nel cluster del container.

Installare e configurare il software richiesto

In questo tutorial, installi l'interfaccia a riga di comando gcloud in modo da poter utilizzare Google Cloud CLI per gestire il tuo progetto. Utilizzi kubectl per eseguire comandi nei cluster GKE. Ti serve anche un modo per testare l'API.

Nella procedura seguente, se hai già installato il software richiesto, continua con il passaggio successivo.

Per installare e configurare il software richiesto:

1. È necessaria un'applicazione per inviare richieste all'API di esempio.

   • Utenti Linux e macOS: questo tutorial fornisce un esempio di utilizzo di curl, che in genere è preinstallato sul sistema operativo. Se non hai l'app curl, puoi scaricarla dalla curl pagina Release e download.
   • Utenti Windows: questo tutorial fornisce un esempio utilizzando Invoke-WebRequest, supportato in PowerShell 3.0 e versioni successive.
2. Installa e inizializza l'interfaccia a riga di comando gcloud.
3. Aggiorna l'interfaccia a riga di comando gcloud e installa i componenti Endpoints:

   gcloud components update

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

   gcloud auth login

   Seleziona un account nella nuova scheda del browser che si apre.
5. 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 Gestione delle configurazioni dell'interfaccia gcloud CLI di gcloud.

6. Installa kubectl:

   gcloud components install kubectl

7. Acquisire le nuove credenziali utente da utilizzare per le Credenziali predefinite dell'applicazione. Le credenziali utente sono necessarie per autorizzare kubectl.

   gcloud auth application-default login

   Seleziona un account nella nuova scheda del browser che si apre.

Download del codice campione

Per aiutarti a iniziare subito a utilizzare la funzionalità, hai a disposizione un codice campione in diverse lingue. Per scaricare il codice campione sulla macchina locale:

Java

Per clonare o scaricare l'API di esempio:

1. Clona il repository dell'app di esempio nella macchina locale:

   git clone https://github.com/GoogleCloudPlatform/java-docs-samples

   In alternativa, scarica l'esempio come file ZIP ed estrailo.

2. Passa alla directory che contiene il codice di esempio:

   cd java-docs-samples/endpoints/getting-started

Python

Per clonare o scaricare l'API di esempio:

1. Clona il repository dell'app di esempio nella macchina locale:

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples

   In alternativa, scarica l'esempio come file ZIP ed estrailo.

2. Passa alla directory che contiene il codice di esempio:

   cd python-docs-samples/endpoints/getting-started

Vai

Per clonare o scaricare l'API di esempio:

1. Assicurati che la variabile di ambiente GOPATH sia impostata.
2. Clona il repository dell'app di esempio nella macchina locale:

   go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

3. Passa alla directory che contiene il codice di esempio:

   cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

PHP

Per clonare o scaricare l'API di esempio:

1. Clona il repository dell'app di esempio nella macchina locale:

   git clone https://github.com/GoogleCloudPlatform/php-docs-samples

   In alternativa, scarica l'esempio come file ZIP ed estrailo.

2. Passa alla directory che contiene il codice di esempio:

   cd php-docs-samples/endpoints/getting-started

Ruby

Per clonare o scaricare l'API di esempio:

1. Clona il repository dell'app di esempio nella macchina locale:

   git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples

   In alternativa, scarica l'esempio come file ZIP ed estrailo.

2. Passa alla directory che contiene il codice di esempio:

   cd ruby-docs-samples/endpoints/getting-started

NodeJS

Per clonare o scaricare l'API di esempio:

1. Clona il repository dell'app di esempio nella macchina locale:

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples

   In alternativa, scarica l'esempio come file ZIP ed estrailo.

2. Passa alla directory che contiene il codice di esempio:

   cd nodejs-docs-samples/endpoints/getting-started

Configurazione di Endpoints

Il codice campione include il file di configurazione OpenAPI, openapi.yaml, che si basa sulla specifica OpenAPI v2.0. Per configurare gli endpoint:

1. Nella directory del codice di esempio, apri il file di configurazione di openapi.yaml.
   Java

   endpoint/getting-started/openapi.yaml

   Visualizza su GitHub

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Python

   endpoint/getting-started/openapi.yaml

   Visualizza su GitHub

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Vai

   endpoint/getting-started/openapi.yaml

   Visualizza su GitHub

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   PHP

   endpoint/getting-started/openapi.yaml

   Visualizza su GitHub

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Ruby

   endpoint/getting-started/openapi.yaml

   Visualizza su GitHub

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   NodeJS

   endpoint/getting-started/openapi.yaml

   Visualizza su GitHub

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Tieni presente quanto segue:

   • L'esempio di configurazione mostra le righe vicino al campo host, che devi modificare. Per eseguire il deployment del file openapi.yaml in Endpoints, è necessario il documento OpenAPI completo.
   • Il file di esempio openapi.yaml contiene una sezione per la configurazione dell'autenticazione non necessaria per questo tutorial. Non è necessario configurare le righe con YOUR-SERVICE-ACCOUNT-EMAIL e YOUR-CLIENT-ID.
   • OpenAPI è una specifica indipendente dal linguaggio. Per comodità, lo stesso file openapi.yaml è nell'esempio getting-started in ogni repository GitHub in ogni lingua.

2. Nel campo host, sostituisci il testo con il nome del servizio endpoint, che dovrebbe essere nel seguente formato:

   host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
   

   Sostituisci YOUR_PROJECT_ID con l'ID progetto Google Cloud. Ad esempio:

   host: "echo-api.endpoints.example-project-12345.cloud.goog"
   

Tieni presente che echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog è il nome del servizio Endpoints. Non è il nome di dominio completo che utilizzi per inviare richieste all'API.

Per informazioni sui campi del documento OpenAPI richiesti da Endpoints, consulta la configurazione degli endpoint.

Dopo aver completato tutti i passaggi di configurazione seguenti in modo da poter inviare correttamente le richieste all'API di esempio utilizzando un indirizzo IP, consulta Configurazione del DNS degli endpoint per informazioni su come configurare echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog per il nome di dominio completo.

Eseguire il deployment della configurazione di Endpoints

Per eseguire il deployment della configurazione Endpoint puoi utilizzare il comando gcloud endpoints services deploy. Questo comando utilizza Service Management per creare un servizio gestito.

Per eseguire il deployment della configurazione Endpoints:

1. Assicurati di essere nella directory endpoints/getting-started.
2. Carica la configurazione e crea un servizio gestito:

   gcloud endpoints services deploy openapi.yaml
   

Il comando gcloud chiama quindi l'API Service Management per creare un servizio gestito con il nome specificato nel campo host del file openapi.yaml. Service Management configura il servizio in base alle impostazioni nel file openapi.yaml. Quando apporti modifiche a openapi.yaml, devi eseguire nuovamente il deployment del file per aggiornare il servizio endpoint.

Durante la creazione e la configurazione del servizio, Service Management invia informazioni al terminale. Puoi ignorare in tutta sicurezza gli avvisi relativi ai percorsi nel file openapi.yaml che non richiedono una chiave API. Al termine della configurazione del servizio, Service Management visualizza un messaggio con l'ID e il nome del servizio di servizio, in modo simile al seguente:

Service Configuration [2017-02-13r0] uploaded for service [echo-api.endpoints.example-project-12345.cloud.goog]

Nell'esempio precedente, 2017-02-13r0 è l'ID configurazione di servizio e echo-api.endpoints.example-project-12345.cloud.goog è il servizio Endpoint. L'ID di configurazione del servizio è costituito da un timbro data seguito da un numero di revisione. Se esegui nuovamente il deployment del file openapi.yaml nello stesso giorno, il numero di revisione viene aumentato nell'ID configurazione di servizio. Puoi visualizzare la configurazione del servizio Endpoints nella pagina Endpoint > Servizi della console Google Cloud.

Se viene visualizzato un messaggio di errore, vedi Risolvere i problemi di deployment della configurazione degli endpoint.

Verifica dei servizi richiesti

Come minimo, endpoint ed ESP richiedono l'abilitazione dei seguenti servizi Google:

Nome	Qualifica
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 Endpoint in un progetto Google Cloud esistente in cui questi servizi sono stati disattivati 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

Attiva anche il servizio Endpoints:

gcloud services enable ENDPOINTS_SERVICE_NAME

Per determinare il ENDPOINTS_SERVICE_NAME puoi:

• Dopo aver eseguito il deployment della configurazione Endpoint, vai alla pagina Endpoint nella console Cloud. L'elenco dei possibili ENDPOINTS_SERVICE_NAME è riportato nella colonna Nome servizio.

• Per OpenAPI, il valore di ENDPOINTS_SERVICE_NAME è quello che hai specificato nel campo host della specifica OpenAPI. Per gRPC, ENDPOINTS_SERVICE_NAME è ciò che hai specificato nel campo name della configurazione degli endpoint gRPC.

Per maggiori informazioni sui comandi gcloud, consulta i servizi gcloud.

Esegui il deployment del backend dell'API

Finora hai eseguito il deployment del documento OpenAPI in Service Management, ma non hai ancora eseguito il deployment del codice che gestisce il backend dell'API. Questa sezione illustra come eseguire il deployment di container predefiniti per l'API di esempio e ESPv2 nel cluster.

Verifica delle autorizzazioni richieste

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

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

Se si utilizza Workload Identity, è possibile utilizzare un account di servizio separato, diverso dall'account di servizio nodo, per comunicare con i servizi Google. Puoi creare un account di servizio Kubernetes per il pod per eseguire 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 associato.

Se l'account di servizio associato è l'account di servizio predefinito di Compute Engine del progetto e viene eseguito il deployment della configurazione del servizio di endpoint nello stesso progetto, l'account di servizio deve avere autorizzazioni sufficienti per accedere alle risorse IAM, ignorando il passaggio di configurazione dei ruoli IAM. In caso contrario, i seguenti ruoli IAM devono essere aggiunti all'account di servizio collegato.

Aggiungi i ruoli IAM richiesti:

In questa sezione vengono descritte le risorse IAM utilizzate da ESP ed ESPv2 e i ruoli IAM richiesti dall'account di servizio associato per accedere a queste risorse.

Configurazione del servizio di endpoint

ESP ed ESPv2 chiamano Service Control che utilizza la configurazione del servizio endpoint. La configurazione del servizio endpoint è una risorsa IAM e ESP ed ESPv2 hanno bisogno del 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 servizio endpoint.

Utilizza il seguente comando gcloud per aggiungere il ruolo all'account di servizio associato 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 associato.

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 che possiede la configurazione del servizio endpoint sono uguali. In ESPv2, il progetto di monitoraggio può essere specificato dal flag --tracing_project_id e il valore 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 associato:

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 monitoraggio
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com è l'account di servizio associato. Per saperne di più, vedi Cosa sono i ruoli e le autorizzazioni?

Deployment dei container nel cluster

I container offrono un meccanismo logico di pacchettizzazione in cui puoi astrare le applicazioni dall'ambiente in cui sono eseguite. Utilizza la procedura seguente per eseguire il deployment dell'API di esempio e di ESPv2 nel cluster. Per eseguire il deployment dei container nel cluster:

1. Ottieni le credenziali del cluster e rendile disponibili per kubectl:

       gcloud container clusters get-credentials NAME --zone ZONE
       

   Sostituisci NAME con il nome del cluster e ZONE con la zona del cluster.
2. Eseguire il deployment di un servizio Kubernetes nel cluster GKE. Il servizio Kubernetes implementa l'API. git clone questo repository, cd getting-started/ per inserire nella cartella e modificare il file di configurazione di Kubernetes LANG-deployment.yaml, e sostituisci SERVICE_NAME nelle opzioni di avvio di ESPv2 con il nome del tuo servizio.
   Java

   Getting-started/java-deployment.yaml

   Visualizza su GitHub

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:2
     args: [
       "--listener_port=8081",
       "--backend=127.0.0.1:8080",
       "--service=SERVICE_NAME",
       "--rollout_strategy=managed",
       "--healthz=/healthz",
     ]
     readinessProbe:
       httpGet:
         path: /healthz
         port: 8081

   Python

   Getting-started/python-deployment.yaml

   Visualizza su GitHub

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:2
     args: [
       "--listener_port=8081",
       "--backend=http://127.0.0.1:8080",
       "--service=SERVICE_NAME",
       "--rollout_strategy=managed",
       "--healthz=/healthz",
     ]
     readinessProbe:
       httpGet:
         path: /healthz
         port: 8081

   Vai

   Getting-started/golang-deployment.yaml

   Visualizza su GitHub

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:2
     args: [
       "--listener_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
       "--healthz=/healthz",
     ]
     readinessProbe:
       httpGet:
         path: /healthz
         port: 8081

   PHP

   Getting-started/php-deployment.yaml

   Visualizza su GitHub

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:2
     args: [
       "--listener_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
       "--healthz=/healthz",
     ]

   Ruby

   Getting-started/ruby-deployment.yaml

   Visualizza su GitHub

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:2
     args: [
       "--listener_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
       "--healthz=/healthz",
     ]

   NodeJS

   Getting-started/nodejs-deployment.yaml

   Visualizza su GitHub

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:2
     args: [
       "--listener_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
       "--healthz=/healthz",
     ]
     readinessProbe:
       httpGet:
         path: /healthz
         port: 8081

   Ad esempio:

     args: [
       "--listener_port=8081",
       "--backend=http://127.0.0.1:8080",
       "--service=echo-api.endpoints.example-project-12345.cloud.goog ",
       "--rollout_strategy=managed",
     ]
   

   L'opzione --rollout_strategy=managed configura ESPv2 in modo da utilizzare la configurazione del servizio più recente sottoposta a deployment. Quando specifichi questa opzione, entro un minuto dal deployment di una nuova configurazione di servizio, ESPv2 rileva la modifica e inizia automaticamente a utilizzarla. Ti consigliamo di specificare questa opzione invece di fornire un ID di configurazione specifico per ESPv2. Per informazioni sulle altre opzioni ESPv2 utilizzate, consulta Opzioni di avvio ESPv2.

   Ti consigliamo di impostare imagePullPolicy nella specifica del contenitore su Always. In questo modo, i pod appena creati avranno sempre la versione più recente di ESPv2. Per saperne di più, consulta le best practice per la configurazione. Quando viene rilasciata una nuova versione di ESPv2, puoi eseguire un riavvio in sequenza di tutti i pod per assicurarti di utilizzare la versione più recente.

   Se esegui un ampio parco risorse di endpoint nello stesso progetto Google Cloud (più di 100), ti consigliamo di montare la configurazione del servizio per il container, anziché utilizzare il flag --rollout_strategy=managed per eseguire il pull della configurazione del servizio dall'API Service Management. L'API Service Management ha una quota predefinita. Se un ampio parco risorse di endpoint utilizza --rollout_strategy=managed, tutti gli endpoint acquisiranno la configurazione del servizio più recente. Il parco risorse potrebbe superare la quota e causare errori di aggiornamento della configurazione del servizio. Segui questi passaggi per montare la configurazione del servizio.

   • Scarica la configurazione JSON della configurazione del servizio.

   curl -o "/tmp/service_config.json" -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://servicemanagement.googleapis.com/v1/services/SERVICE/configs/CONFIG_ID?view=FULL"
   

   • Crea una risorsa mappa di configurazione Kubernetes dalla configurazione JSON.

   kubectl create configmap service-config-configmap \
     --from-file=service_config.json:/tmp/service_config.json
   

   • Monta la risorsa di mappatura di configurazione nel container e utilizza il flag "--service_config_path" per specificare il percorso del file di configurazione.

   Ad esempio:

     containers:
     - args:
       - --listener_port=8081
       - --backend=http://127.0.0.1:8080
       - --service_json_path=/etc/espv2_config/service_config.json
       - --healthz=/healthz
       image: gcr.io/endpoints-release/endpoints-runtime:2
       name: esp
       ports:
       - containerPort: 8081
         protocol: TCP
       volumeMounts:
       - mountPath: /etc/espv2_config
         name: service-config-volume
     volumes:
     - configMap:
         defaultMode: 420
         name: service-config-configmap
       name: service-config-volume
   

3. Avvia il servizio Kubernetes utilizzando il comando kubectl apply:
   Java

   kubectl apply -f java-deployment.yaml

   Python

   kubectl apply -f python-deployment.yaml

   Vai

   kubectl apply -f golang-deployment.yaml

   PHP

   kubectl apply -f php-deployment.yaml

   Ruby

   kubectl apply -f ruby-deployment.yaml

   NodeJS

   kubectl apply -f nodejs-deployment.yaml

Se viene visualizzato un messaggio di errore, vedi Risoluzione dei problemi degli endpoint in GKE. Per ulteriori informazioni, consulta la pagina relativa al deployment del backend API.

Ottenere l'indirizzo IP esterno del cluster

Per inviare richieste all'API, hai bisogno dell'IP esterno del servizio. Dopo l'avvio del servizio nel container, possono 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. che verrà utilizzato quando invii una richiesta all'API di esempio.

Invio di una richiesta tramite un indirizzo IP

Ora che il servizio è in esecuzione nel cluster del container e di avere l'indirizzo IP esterno, puoi inviare le richieste all'API.

Crea una chiave API e imposta una variabile di ambiente

Il codice campione richiede una chiave API. Per semplificare la richiesta, imposta una variabile di ambiente per la chiave API.

1. Nello stesso progetto Google Cloud che hai utilizzato per l'API, crea una chiave API nella pagina Credenziali API. Se vuoi creare una chiave API in un progetto Google Cloud diverso, consulta Abilitare un'API nel progetto Google Cloud.

   Vai alla pagina Credenziali

2. Fai clic su Crea credenziali, quindi seleziona Chiave API.
3. Copia la chiave negli appunti.
4. Fai clic su Chiudi.
5. Incolla la chiave API sul computer locale per assegnarla a una variabile di ambiente:
   • In Linux o macOS: export ENDPOINTS_KEY=AIza...
   • In Windows PowerShell: $Env:ENDPOINTS_KEY="AIza..."

Invia la richiesta

Linux o mac OS

Utilizza curl per inviare una richiesta HTTP tramite la variabile di ambiente ENDPOINTS_KEY che hai impostato in precedenza. Sostituisci IP_ADDRESS con l'indirizzo IP esterno della tua istanza.

curl --request POST \
   --header "content-type:application/json" \
   --data '{"message":"hello world"}' \
   "http://IP_ADDRESS:80/echo?key=${ENDPOINTS_KEY}"

Nel curl precedente:

• L'opzione --data specifica i dati da pubblicare nell'API.
• L'opzione --header specifica che i dati sono in formato JSON.

PowerShell

Utilizza Invoke-WebRequest per inviare una richiesta HTTP tramite la variabile di ambiente ENDPOINTS_KEY che hai impostato in precedenza. Sostituisci IP_ADDRESS con l'indirizzo IP esterno della tua istanza.

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://IP_ADDRESS:80/echo?key=$Env:ENDPOINTS_KEY").Content

Nell'esempio precedente, le prime due righe terminano con un backtick. Quando incolli l'esempio in PowerShell, assicurati che non ci sia uno spazio dopo i backtick. Per informazioni sulle opzioni utilizzate nella richiesta di esempio, consulta Invoke-WebRequest nella documentazione di Microsoft.

App di terze parti

Puoi utilizzare un'applicazione di terze parti come l'estensione del browser Chrome Postman per inviare la richiesta:

• Seleziona POST come verbo HTTP.
• Per l'intestazione, seleziona la chiave content-type e il valore application/json.
• Inserisci il testo seguente:
  {"message":"hello world"}
• Nell'URL, utilizza la chiave API effettiva anziché la variabile di ambiente. Ad esempio:
  http://192.0.2.0:80/echo?key=AIza...

L'API fa eco al messaggio che invii e risponde con quanto segue:

{
  "message": "hello world"
}

Se non hai ricevuto correttamente una risposta, consulta la sezione Risolvere gli errori di risposta.

Hai appena eseguito il deployment e il test di un'API in Endpoints.

Nota: se vuoi farci sapere cosa ti è piaciuto di questo tutorial, non esitare a fornirci un feedback in fondo a questa pagina. Il tuo feedback ci aiuta a migliorare questi tutorial.
Se hai riscontrato un errore, unisciti al gruppo google-cloud-endpoints Google e facci sapere cosa è andato storto. Questo gruppo riceve risposte da altri utenti endpoint e dai tecnici di Google che lo monitorano.

Monitora l'attività dell'API

Per monitorare l'attività dell'API:

1. Dai un'occhiata ai grafici relativi alle attività della tua API nella pagina Endpoint > Servizi.
   

   Vai alla pagina Servizi di Endpoints

   
   Potrebbe essere necessario qualche istante affinché la richiesta venga visualizzata nei grafici.
2. Esamina i log delle richieste per l'API nella pagina Esplora log.
   

   Vai alla pagina Esplora log

Configurazione di DNS per Endpoints

Poiché il nome del servizio Endpoints per l'API si trova nel dominio .endpoints.YOUR_PROJECT_ID.cloud.goog, puoi utilizzarlo come nome di dominio completo (FQDN) apportando una piccola modifica alla configurazione nel file openapi.yaml. In questo modo, puoi inviare richieste all'API di esempio utilizzando echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog anziché l'indirizzo IP.

Per configurare il DNS di Endpoints:

1. Apri il file di configurazione OpenAPI openapi.yaml e aggiungi la proprietà x-google-endpoints al livello superiore del file (non rientrato o nidificato) come mostrato nel seguente snippet:

   host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
   x-google-endpoints:
   - name: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
     target: "IP_ADDRESS"
   

2. Nella proprietà name, sostituisci YOUR_PROJECT_ID con l'ID progetto.
3. Nella proprietà target sostituisci IP_ADDRESS con l'indirizzo IP che hai utilizzato quando hai inviato una richiesta all'API di esempio.
4. Esegui il deployment del file di configurazione OpenAPI aggiornato in Service Management:

   gcloud endpoints services deploy openapi.yaml
   

Ad esempio, supponiamo che nel file openapi.yaml sia configurato quanto segue:

host: "echo-api.endpoints.example-project-12345.cloud.goog"
x-google-endpoints:
- name: "echo-api.endpoints.example-project-12345.cloud.goog"
  target: "192.0.2.1"

Quando esegui il deployment del file openapi.yaml utilizzando il comando gcloud precedente, Service Management crea un record A DNS, echo-api.endpoints.my-project-id.cloud.goog, che si risolve nell'indirizzo IP di destinazione, 192.0.2.1. La propagazione della nuova configurazione DNS potrebbe richiedere alcuni minuti.

Configurazione di SSL

Per ulteriori dettagli sulla configurazione di DNS e SSL, consulta la pagina relativa all'abilitazione di SSL per gli endpoint.

Invio di una richiesta utilizzando FQDN

Ora che il record DNS è configurato per l'API di esempio, invia una richiesta utilizzando l'FQDN (sostituisci YOUR_PROJECT_ID con l'ID progetto) e la variabile di ambiente ENDPOINTS_KEY impostata in precedenza:

• In Linux o mac OS:

  curl --request POST \
      --header "content-type:application/json" \
      --data '{"message":"hello world"}' \
      "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog:80/echo?key=${ENDPOINTS_KEY}"

• In Windows PowerShell:

  (Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' -Headers @{"content-type"="application/json"} -URI "http://echo-api.endpoints.[YOUR_PROJECT_ID].cloud.goog:80/echo?key=$Env:ENDPOINTS_KEY").Content

Creazione di un portale per sviluppatori per l'API

Puoi usare il portale Cloud Endpoints per creare un portale per gli sviluppatori, un sito web da utilizzare per interagire con l'API di esempio. Per scoprire di più, consulta la panoramica del portale Cloud 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.

Per informazioni sull'arresto dei servizi utilizzati da questo tutorial, consulta la sezione Eliminazione di un'API e di istanze API.

Passaggi successivi

• Scopri come creare un'immagine Docker.
• Scopri come eseguire il deployment di Endpoints su Kubernetes.
• Condividere l'API con un altro sviluppatore.
• Scopri di più sull'autenticazione.
• Scopri le opzioni di assistenza della community.
• Risoluzione dei problemi di deployment di GKE.