Introduzione a Cloud Endpoints per GKE con ESP

---

OpenAPI   |  gRPC

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

L'API REST del codice campione viene descritta utilizzando la specifica OpenAPI. Il tutorial mostra inoltre come creare una chiave API e utilizzarla quando invii richieste all'API.

Il tutorial utilizza immagini container predefinite del codice campione e dell'ESP, archiviate in Container Registry.

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à della Parte 1 sono necessarie per inviare 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 Installazione e configurazione del software richiesto.
4. Scarica il codice campione. Vedi Ottenere il codice di esempio.
5. Configura il file openapi.yaml, utilizzato per configurare Cloud Endpoints. Consulta Configurazione di Endpoints.
6. Esegui il deployment della configurazione di Endpoints per creare un servizio Endpoints. Vedi Eseguire il deployment della configurazione di Endpoints.
7. Eseguire il deployment dell'API e dell'ESP nel cluster. Vedi Deployment del backend dell'API.
8. Recupera l'indirizzo IP del cluster. Vedi Recupero dell'indirizzo IP esterno del cluster.
9. Invia una richiesta all'API utilizzando un indirizzo IP. Vedi Inviare una richiesta tramite un indirizzo IP.
10. Monitora l'attività dell'API. Consulta la sezione Attività dell'API di monitoraggio.

Parte 2

1. Configura un record DNS per l'API di esempio. Vedi Configurazione del DNS per Endpoints.
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 Pulizia per evitare addebiti al tuo account Google Cloud.

Costi

In questo documento vengono utilizzati 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 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.

   Nota: se non prevedi di conservare le risorse create in questa procedura, crea un progetto anziché selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto, rimuovendo tutte le risorse associate.

   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.

   Nota: se non prevedi di conservare le risorse create in questa procedura, crea un progetto anziché selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto, rimuovendo tutte le risorse associate.

   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.

Creazione di un cluster di container

Occorre creare un cluster container su GKE su cui eseguire il codice di backend dell'API di esempio.

Per creare un cluster di container per l'API di esempio:

1. Nella console Google Cloud, vai alla pagina dei cluster GKE.
   

   Vai alla pagina Cluster Kubernetes

2. Fai clic su Crea cluster.

3. Accetta i valori predefiniti e fai clic su Crea. Il completamento di questo passaggio può richiedere alcuni minuti.

4. Prendi nota del nome del cluster e della zona perché sono necessari quando esegui l'autenticazione kubectl al cluster di container.

Installazione e configurazione del software richiesto

In questo tutorial installerai gcloud CLI in modo da poter utilizzare Google Cloud CLI per gestire il progetto. Puoi usare kubectl per eseguire comandi sui cluster GKE. Devi anche poter testare l'API.

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

Per installare e configurare il software richiesto:

1. Devi avere un'applicazione per inviare richieste all'API di esempio.

   • Utenti Linux e macOS: questo tutorial fornisce un esempio dell'utilizzo di curl, che in genere è preinstallato sul sistema operativo. Se non hai l'app curl, puoi scaricarla dalla pagina curl Release e download.
   • Utenti Windows: questo tutorial fornisce un esempio utilizzando Invoke-WebRequest, che è supportato in PowerShell 3.0 e versioni successive.
2. Installa e inizializza gcloud CLI.
3. Aggiorna gcloud CLI e installa i componenti di 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

   Nella nuova scheda del browser che si apre, seleziona un account.
5. 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.

6. Installa kubectl:

   gcloud components install kubectl

7. Acquisisci nuove credenziali utente da utilizzare per 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, seleziona un account.

Download del codice campione in corso...

Per aiutarti a iniziare a utilizzarla rapidamente, il codice campione è fornito in diverse lingue.

Per scaricare il codice campione sulla tua macchina locale:

Java

Per clonare o scaricare l'API di esempio:

1. Clona il repository dell'app di esempio sulla tua 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 sulla tua 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 sulla tua 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 sulla tua 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 sulla tua 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 sulla tua 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 Endpoints:

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

   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

   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

   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

   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

   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

   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 openapi.yaml di esempio contiene una sezione per la configurazione dell'autenticazione che 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 praticità, lo stesso file openapi.yaml si trova nell'esempio getting-started in ogni repository GitHub di linguaggio.

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

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

   Sostituisci YOUR_PROJECT_ID con l'ID del tuo 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 (FQDN) che utilizzi per inviare le richieste all'API.

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

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

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.

Per eseguire il deployment della configurazione di 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 le informazioni al terminale. Puoi ignorare tranquillamente gli avvisi sui 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 configurazione del servizio e il nome del servizio, 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 di configurazione del servizio e echo-api.endpoints.example-project-12345.cloud.goog è il servizio Endpoint. L'ID configurazione del servizio è costituito da un timestamp della data seguito da un numero di revisione. Se esegui di nuovo il deployment del file openapi.yaml lo stesso giorno, il numero di revisione viene incrementato nell'ID configurazione del servizio. Puoi visualizzare la configurazione del servizio Endpoints nella pagina Endpoint > Servizi della console Google Cloud.

Se viene visualizzato un messaggio di errore, consulta Risoluzione dei problemi di deployment della configurazione di Endpoints.

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.

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 utilizzato per il backend dell'API. Questa sezione illustra il deployment di container predefiniti per l'API di esempio e l'ESP nel cluster.

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?

Deployment dei container nel cluster

I container offrono un meccanismo di pacchettizzazione logico in cui puoi astrarre le applicazioni dall'ambiente in cui vengono effettivamente eseguite. Devi utilizzare la procedura seguente per eseguire il deployment dell'API e dell'ESP di esempio nel cluster.

Per eseguire il deployment dei container nel cluster:

1. Recupera 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. Modifica il file di configurazione di Kubernetes /endpoints/getting-started/deployment.yaml e sostituisci SERVICE_NAME nelle opzioni di avvio dell'ESP con il nome del tuo servizio.
   Java

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

   Python

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

   Vai

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

   PHP

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

   Ruby

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

   NodeJS

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

   Ad esempio:

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

   L'opzione --rollout_strategy=managed configura ESP in modo che utilizzi l'ultima configurazione del servizio di cui è stato eseguito il deployment. Quando specifichi questa opzione, fino a cinque minuti dopo il deployment di una nuova configurazione del servizio, ESP rileva la modifica e inizia automaticamente a utilizzarla. Ti consigliamo di specificare questa opzione anziché un ID di configurazione specifico per ESP. Per informazioni sulle altre opzioni ESP utilizzate, consulta Opzioni di avvio di ESP.

   Ti consigliamo di impostare imagePullPolicy nella specifica del container riportata sopra su Always. Ciò consentirà ai pod appena creati di eseguire sempre il pull della versione più recente di ESP. Per ulteriori dettagli, leggi le best practice di configurazione. Quando viene rilasciata una nuova versione di ESP, puoi eseguire un riavvio in sequenza di tutti i pod per assicurarti che venga utilizzata la versione più recente.

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

   kubectl apply -f deployment.yaml

Nota: se il cluster GKE è privato, devi utilizzare il server metadati di Compute Engine come resolver DNS per risolvere i nomi host dei servizi Google. Aggiungi questo flag ESP: --dns=169.254.169.254

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

Per ulteriori informazioni, consulta Eseguire il deployment del backend dell'API.

Recupero dell'indirizzo IP esterno del cluster

Per inviare richieste all'API, devi avere l'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 service
   

2. Prendi nota del valore di EXTERNAL-IP. che utilizzerai quando invii una richiesta all'API di esempio.

Invio di una richiesta tramite un indirizzo IP

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

Crea una chiave API e imposta una variabile di ambiente

Il codice campione richiede una chiave API. Per semplificare la richiesta, imposti 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 altro progetto Google Cloud, consulta Abilitazione di un'API nel progetto Google Cloud.

   Vai alla pagina Credenziali

2. Fai clic su Crea credenziali e seleziona Chiave API.
3. Copia la chiave negli appunti.
4. Fai clic su Chiudi.
5. Sul computer locale, incolla la chiave API 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 mediante la variabile di ambiente ENDPOINTS_KEY impostata 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}"

Nei curl precedenti:

• L'opzione --data consente di specificare 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 mediante la variabile di ambiente ENDPOINTS_KEY impostata in precedenza. Sostituisci IP_ADDRESS con l'indirizzo IP esterno dell'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 accento grave. Quando incolli l'esempio in PowerShell, assicurati che non ci sia uno spazio dopo l'accento grave. 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, ad esempio 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.
• Per il corpo, inserisci quanto segue:
  {"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 restituisce l'eco al messaggio che invii e risponde con quanto segue:

{
  "message": "hello world"
}

Se non hai ricevuto una risposta corretta, consulta la sezione Risoluzione degli errori di risposta.

Hai 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 inviarci un feedback in fondo a questa pagina. Il tuo feedback ci aiuta a migliorare questi tutorial.
Se hai ricevuto un errore, unisciti al google-cloud-endpoints gruppo Google e comunicaci il problema. Questo gruppo riceve risposte da altri utenti di endpoint e da tecnici di Google, che monitorano il gruppo.

monitora l'attività dell'API

Per monitorare l'attività dell'API:

1. Guarda i grafici di attività per la tua API nella pagina Endpoint > Servizi.
   

   Vai alla pagina Endpoints Services

   
   Potrebbero essere necessari alcuni minuti prima che la richiesta venga riportata nei grafici.

2. Esamina i log delle richieste per l'API nella pagina Esplora log.
   

   Vai alla pagina Esplora log

Configurazione del DNS per gli endpoint

Poiché il nome di 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 principale 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 il tuo 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 per il 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 maggiori dettagli su come configurare DNS e SSL, consulta Abilitazione di SSL per gli endpoint.

Invio di una richiesta tramite nome di dominio completo

Ora che hai configurato il record DNS per l'API di esempio, invia all'API di esempio una richiesta utilizzando il nome di dominio completo (sostituisci YOUR_PROJECT_ID con il tuo 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 gli sviluppatori per l'API

Puoi utilizzare il portale Cloud Endpoints per creare un portale per sviluppatori, un sito web che puoi utilizzare per interagire con l'API di esempio. Per ulteriori informazioni, consulta la pagina 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'interruzione dei servizi utilizzati da questo tutorial, vedi Eliminazione di un'API e istanze API.

Passaggi successivi

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