Introduzione a Cloud Endpoints per Kubernetes con ESP

Questo tutorial mostra come configurare ed eseguire il deployment di un'API di esempio e di Extensible Service Proxy (ESP) in un cluster Kubernetes che non è su Google Cloud. Se vuoi utilizzare Google Kubernetes Engine (GKE), consulta la guida introduttiva a Endpoints su GKE.

L'API REST del codice campione viene descritta utilizzando la specifica OpenAPI. Il tutorial mostra anche come creare una chiave API per inviare richieste all'API.

Il tutorial utilizza immagini container predefinite del codice campione e dell'ESP, 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à della Parte 1 sono necessarie per inviare richieste all'API.

Parte 1

  1. Configurare un progetto Google Cloud. Consulta Prima di iniziare.
  2. Installa e configura il software utilizzato nel tutorial. Vedi Installazione e configurazione del software richiesto.
  3. Se vuoi, scarica il codice campione. Consulta la pagina Ottenere il codice di esempio.
  4. Scaricare il file di configurazione di Kubernetes. Vedi Recupero del file di configurazione di Kubernetes.
  5. Configura il file openapi.yaml, utilizzato per configurare gli endpoint. Consulta la pagina Configurazione di Endpoints.
  6. Esegui il deployment della configurazione di Endpoints per creare un servizio Cloud Endpoints. Vedi Eseguire il deployment della configurazione di Endpoints.
  7. Crea le credenziali per il servizio Endpoints. Vedi Creazione di credenziali per il servizio.
  8. Eseguire il deployment dell'API e dell'ESP nel cluster. Vedi Deployment del backend dell'API.
  9. Recupera l'indirizzo IP esterno del servizio. Vedi Recupero dell'indirizzo IP esterno.
  10. Invia una richiesta all'API utilizzando un indirizzo IP. Vedi Inviare una richiesta tramite un indirizzo IP.
  11. Monitora l'attività dell'API. Consulta la pagina Attività dell'API di monitoraggio.

Parte 2

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

Pulizia

Al termine, consulta Pulizia per evitare addebiti sul tuo account Google Cloud.

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

Questo tutorial presuppone che tu abbia già configurato Minikube o un cluster Kubernetes. Per ulteriori informazioni, consulta la documentazione di Kubernetes.

  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.

Installazione e configurazione del software richiesto

In questo tutorial installerai Google Cloud CLI per utilizzare gcloud CLI al fine di gestire il progetto. Puoi usare kubectl, un'interfaccia a riga di comando, per eseguire comandi sui cluster Kubernetes. 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 visualizzata, 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. Acquisire nuove credenziali utente da utilizzare per le credenziali predefinite dell'applicazione. Le credenziali utente autorizzano kubectl. 
    gcloud auth application-default login
  8. Nella nuova scheda visualizzata, scegli un account.
  9. Esegui questo comando per assicurarti che il tuo client Kubernetes sia configurato correttamente: 
    kubectl version

    Dovresti vedere un output simile al seguente:

    
   Client Version: version.Info{Major:"1", Minor:"8", GitVersion:"v1.8.4",
     GitCommit:"9befc2b8928a9426501d3bf62f72849d5cbcd5a3", GitTreeState:"clean",
     BuildDate:"2017-11-20T05:28:34Z", GoVersion:"go1.8.3", Compiler:"gc",
     Platform:"linux/amd64"}
   Server Version: version.Info{Major:"1", Minor:"7+",
     GitVersion:"v1.7.8-gke.0",
     GitCommit:"a7061d4b09b53ab4099e3b5ca3e80fb172e1b018", GitTreeState:"clean",
     BuildDate:"2017-10-10T18:48:45Z", GoVersion:"go1.8.3", Compiler:"gc",
     Platform:"linux/amd64"}

Download del codice campione in corso...

Se vuoi, scarica il codice campione. In questo tutorial imparerai a eseguire il deployment di un'immagine container predefinita, senza dover creare un container. Tuttavia, ti consigliamo di scaricare il codice campione, fornito in diversi linguaggi, per aiutarti a capire come funziona l'API di esempio.

Per scaricare il codice campione:

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

Recupero del file di configurazione di Kubernetes

  1. Clona il repository GitHub che contiene i file yaml utilizzati in questo tutorial sulla tua macchina locale:

     git clone https://github.com/googlecloudplatform/endpoints-samples

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

  2. Passa alla directory che contiene i file di configurazione:

     cd endpoints-samples/kubernetes

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. 

    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 e aver potuto inviare correttamente le richieste all'API di esempio utilizzando un indirizzo IP, consulta Configurazione di DNS per endpoint 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-samples/k8s.
  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.

Creazione di credenziali per il servizio

Per fornire la gestione della tua API, sia ESP che ESPv2 richiedono i servizi in Service Infrastructure. Per chiamare questi servizi, ESP ed ESPv2 devono utilizzare i token di accesso. Quando esegui il deployment di ESP o ESPv2 in ambienti Google Cloud, come GKE, Compute Engine o l'ambiente flessibile di App Engine, ESP ed ESPv2 ricevono i token di accesso per te tramite il servizio di metadati Google Cloud.

Quando esegui il deployment di ESP o ESPv2 in un ambiente non Google Cloud, come il tuo desktop locale, un cluster Kubernetes on-premise o un altro cloud provider, devi fornire un file JSON dell'account di servizio contenente una chiave privata. ESP ed ESPv2 utilizzano l'account di servizio per generare token di accesso per chiamare i servizi necessari per gestire l'API.

Puoi utilizzare la console Google Cloud o Google Cloud CLI per creare l'account di servizio e il file di chiave privata:

Console

  1. Nella console Google Cloud, apri la pagina Account di servizio .

    Vai alla pagina Account di servizio

  2. Fai clic su Seleziona un progetto.
  3. Seleziona il progetto in cui è stata creata l'API e fai clic su Apri.
  4. Fai clic su + Crea account di servizio.
  5. Nel campo Nome account di servizio, inserisci il nome dell'account di servizio.
  6. Fai clic su Crea.
  7. Fai clic su Continua.
  8. Fai clic su Fine.
  9. Fai clic sull'indirizzo email dell'account di servizio appena creato.
  10. Fai clic su Chiavi.
  11. Fai clic su Aggiungi chiave, quindi su Crea nuova chiave.

  12. Fai clic su Crea. Un file di chiave JSON viene scaricato sul computer.

    Assicurati di archiviare il file della chiave in modo sicuro, poiché può essere utilizzato per l'autenticazione come account di servizio. Puoi spostare e rinominare questo file come preferisci.

  13. Fai clic su Chiudi.

gcloud

  1. Inserisci quanto segue per visualizzare gli ID dei tuoi progetti Google Cloud:

    gcloud projects list

  2. Sostituisci PROJECT_ID nel comando seguente per impostare il progetto predefinito su quello in cui si trova la tua API:

    gcloud config set project PROJECT_ID

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

    gcloud auth login

    Se disponi di più account, assicurati di scegliere quello presente nel progetto Google Cloud in cui si trova l'API. Se esegui gcloud auth list, l'account selezionato viene mostrato come account attivo per il progetto.

  4. Per creare un account di servizio, esegui questo comando e sostituisci SERVICE_ACCOUNT_NAME e My Service Account con il nome e il nome visualizzato che vuoi utilizzare:

    gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
   --display-name "My Service Account"

    Il comando assegna un indirizzo email all'account di servizio nel seguente formato:

    SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

    Questo indirizzo email è obbligatorio nei comandi successivi.

  5. Crea un file della chiave dell'account di servizio:

    gcloud iam service-accounts keys create ~/service-account-creds.json \
   --iam-account SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

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?

Vedi gcloud iam service-accounts per ulteriori informazioni sui comandi.

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 come eseguire il deployment in Kubernetes dei container predefiniti per l'API di esempio e ESP.

Controllo delle autorizzazioni richieste in corso...

Concedi le autorizzazioni necessarie all'account di servizio associato al cluster:

gcloud endpoints services add-iam-policy-binding SERVICE_NAME \
  --member "serviceAccount:SERVICE_ACCOUNT" \
  --role roles/servicemanagement.serviceController

Per maggiori informazioni, vedi Cosa sono i ruoli e le autorizzazioni?

Fornire le credenziali del servizio a ESP

ESP, che viene eseguito all'interno di un container, deve accedere alle credenziali archiviate localmente nel file service-account-creds.json. Per consentire a ESP di accedere alle credenziali, devi creare un secret Kubernetes e montare il secret Kubernetes come volume Kubernetes.

Per creare il secret Kubernetes e montare il volume:

  1. Assicurati di rinominare il file JSON in service-account-creds.json e copialo in endpoints-samples/k8s se è stato scaricato in un'altra directory. In questo modo, il nome corrisponde alle opzioni specificate nel file manifest di deployment esp_echo_http.yaml.

  2. Assicurati di essere nella directory endpoints-samples/k8s.

  3. Crea un secret Kubernetes con le credenziali dell'account di servizio:

    kubectl create secret generic service-account-creds \
  --from-file=service-account-creds.json

    Se l'operazione riesce, viene visualizzato il seguente messaggio: secret "service-account-creds" created

Il file manifest di deployment che utilizzi per eseguire il deployment dell'API e dell'ESP in Kubernetes contiene già il volume del secret, come mostrato nelle seguenti due sezioni del file:

volumes:
  - name: service-account-creds
    secret:
      secretName: service-account-creds
volumeMounts:
  - mountPath: /etc/nginx/creds
    name: service-account-creds
    readOnly: true

Configurazione del nome del servizio e avvio del servizio

ESP deve conoscere il nome del tuo servizio per trovare la configurazione di cui hai eseguito il deployment in precedenza (utilizzando il comando gcloud endpoints services deploy).

Per configurare il nome del servizio e avviarlo:

  1. Apri il file manifest di deployment, esp_echo_http.yaml, e sostituisci SERVICE_NAME nelle opzioni di avvio di ESP con il nome del tuo servizio. Si tratta dello stesso nome che hai configurato nel campo host del documento OpenAPI. Ad esempio:

    "--service=echo-api.endpoints.example-project-12345.cloud.goog"

    containers:
  - name: esp
    image: gcr.io/endpoints-release/endpoints-runtime:1
    args: [
      "--http_port", "8080",
      "--backend", "127.0.0.1:8081",
      "--service", "SERVICE_NAME",
      "--rollout_strategy", "managed",
      "--service_account_key", "/etc/nginx/creds/service-account-creds.json",
    ]

    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.

  2. Avvia il servizio per eseguire il deployment del servizio Endpoints su Kubernetes:

    kubectl create -f echo.yaml

    Se viene visualizzato un messaggio di errore simile al seguente:

    The connection to the server localhost:8080 was refused - did you specify the right host or port?

    Questo indica che kubectl non è configurato correttamente. Per ulteriori informazioni, consulta Configurare kubectl.

Per ulteriori informazioni, consulta Eseguire il deployment di Endpoints su Kubernetes.

Recupera l'indirizzo IP esterno del servizio

Se usi Minikube, vai a Inviare una richiesta tramite un indirizzo IP.

Dopo l'avvio del servizio nel container, potrebbero essere necessari alcuni minuti prima che l'indirizzo IP esterno sia pronto.

Per visualizzare l'indirizzo IP esterno del servizio:

  1. Esegui questo comando:

    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

Quando l'API di esempio è in esecuzione nel cluster di container, 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 a minikube

I comandi seguenti utilizzano la variabile di ambiente ENDPOINTS_KEY che hai impostato in precedenza.

Linux o Mac OS

NODE_PORT=`kubectl get service esp-echo --output='jsonpath={.spec.ports[0].nodePort}'`
MINIKUBE_IP=`minikube ip`
curl --request POST \
    --header "content-type:application/json" \
    --data '{"message":"hello world"}' \
    ${MINIKUBE_IP}:${NODE_PORT}/echo?key=${ENDPOINTS_KEY}

PowerShell

$Env:NODE_PORT=$(kubectl get service esp-echo --output='jsonpath={.spec.ports[0].nodePort}')
$Env:MINIKUBE_IP=$(minikube ip)
(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://$Env:MINIKUBE_IP:$Env:NODE_PORT/echo?key=$Env:ENDPOINTS_KEY").Content

Invia la richiesta ad altri cluster Kubernetes

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.

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

  • Elimina il servizio e il deployment Kubernetes:

    kubectl delete -f esp_echo_http.yaml

Consulta Eliminazione di un'API e istanze API per informazioni sull'interruzione dei servizi utilizzati da questo tutorial.

Passaggi successivi