Introduzione a Cloud Endpoints per Kubernetes con ESPv2

Questo tutorial mostra come configurare ed eseguire il deployment di un'API di esempio e Extensible Service Proxy V2 (ESPv2) in un cluster Kubernetes che non si trova su Google Cloud. Se vuoi usare Google Kubernetes Engine (GKE), usa Introduzione a Endpoints su GKE.

L'API REST del codice campione viene descritta utilizzando il comando Specifica OpenAPI. Il tutorial illustra anche come creare un Chiave API per inviare richieste all'API.

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

Per una panoramica di Cloud Endpoints, consulta Informazioni sugli endpoint e l'architettura degli endpoint.

Obiettivi

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

Parte 1

  1. Configurare un progetto Google Cloud. Consulta: Prima di iniziare.
  2. Installa e configura il software utilizzato nel tutorial. Consulta: Installazione e configurazione del software richiesto.
  3. Facoltativamente, scarica il codice campione. Consulta: Recupero del codice campione.
  4. Scarica il file di configurazione di Kubernetes. Consulta: Recupero del file di configurazione di Kubernetes.
  5. Configura il file openapi.yaml, utilizzato per configurare Endpoint. Consulta: Configurazione di Endpoints.
  6. Esegui il deployment della configurazione di Endpoints per creare servizio Cloud Endpoints. Consulta: Esegui il deployment della configurazione di Endpoints.
  7. Crea le credenziali per il servizio Endpoints. Consulta: Creazione delle credenziali per il servizio.
  8. Esegui il deployment dell'API e di ESPv2 nel cluster. Consulta: Deployment del backend dell'API.
  9. Ottieni l'indirizzo IP esterno del servizio. Consulta: Recuperare l'indirizzo IP esterno.
  10. Invia una richiesta all'API utilizzando un indirizzo IP. Consulta: Invio di una richiesta tramite un indirizzo IP.
  11. Monitorare l'attività dell'API. Consulta: Monitoraggio dell'attività dell'API.

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. Consulta: Invio di una richiesta tramite FQDN.

Pulizia

Al termine, consulta Pulizia per evitare che al tuo account Google Cloud vengano addebitati costi.

Costi

In questo documento utilizzi i seguenti componenti fatturabili di Google Cloud:

Per generare una stima dei costi basata sull'utilizzo previsto, utilizza il Calcolatore prezzi. I nuovi utenti di Google Cloud potrebbero essere idonei per una prova gratuita.

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à Minikube o un cluster Kubernetes configurazione. Per ulteriori informazioni, consulta Documentazione relativa a Kubernetes.

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  5. Make sure that billing is enabled for your Google Cloud project.

  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 per gestire il progetto. Utilizzi kubectl, un'interfaccia a riga di comando per eseguire comandi sui cluster Kubernetes. Inoltre occorre trovare un modo per testare l'API.

Nella procedura seguente, se disponi già dei necessari installato, continua con il passaggio successivo.

Per installare e configurare il software richiesto:

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

    • Utenti Linux e macOS: questo tutorial fornisce un esempio dell'utilizzo curl, che in genere è preinstallata sul sistema operativo. Se non hai curl, puoi scaricarlo dal curl Pagina Release e download.
    • Utenti Windows: questo tutorial fornisce un esempio di utilizzo Invoke-WebRequest, ovvero supportato in PowerShell 3.0 e versioni successive.
  2. Installa e inizializza con gcloud CLI.
  3. Aggiorna gcloud CLI e installa Endpoints componenti: 
    gcloud components update
  4. Assicurati che Google Cloud CLI (gcloud) sia autorizzato ad accedere i tuoi dati e servizi su Google Cloud: 
    gcloud auth login
    Seleziona un account nella nuova scheda visualizzata.
  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 consulta la sezione Gestione delle configurazioni gcloud CLI.

  6. Installa kubectl: 
    gcloud components install kubectl
  7. Acquisisci 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

Facoltativamente, scarica il codice campione. In questo tutorial eseguirai il deployment di una dell'immagine container, in modo da non dover creare un container dal codice campione. Tuttavia, ti consigliamo di scaricare il codice campione, fornito in linguaggi diversi 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 nella tua macchina locale: 
    git clone https://github.com/GoogleCloudPlatform/java-docs-samples

    In alternativa, scarica l'anteprima come file ZIP ed estrarlo.

  2. Passa alla directory che contiene il codice campione: 
    cd java-docs-samples/endpoints/getting-started
di Gemini Advanced.
.
.
Python

Per clonare o scaricare l'API di esempio:

  1. Clona il repository dell'app di esempio nella tua macchina locale: 
    git clone https://github.com/GoogleCloudPlatform/python-docs-samples

    In alternativa, scarica l'anteprima come file ZIP ed estrarlo.

  2. Passa alla directory che contiene il codice campione: 
    cd python-docs-samples/endpoints/getting-started
di Gemini Advanced.
.
.
Vai

Per clonare o scaricare l'API di esempio:

  1. Assicurati che il tuo La variabile di ambiente GOPATH è impostata.
  2. Clona il repository dell'app di esempio nella tua macchina locale: 
    go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
  3. Passa alla directory che contiene il codice campione: 
    cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
di Gemini Advanced.
.
.
PHP

Per clonare o scaricare l'API di esempio:

  1. Clona il repository dell'app di esempio nella tua macchina locale: 
    git clone https://github.com/GoogleCloudPlatform/php-docs-samples

    In alternativa, scarica l'anteprima come file ZIP ed estrarlo.

  2. Passa alla directory che contiene il codice campione: 
    cd php-docs-samples/endpoints/getting-started
di Gemini Advanced.
.
.
Rosso rubino

Per clonare o scaricare l'API di esempio:

  1. Clona il repository dell'app di esempio nella tua macchina locale: 
    git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples

    In alternativa, scarica l'anteprima come file ZIP ed estrarlo.

  2. Passa alla directory che contiene il codice campione: 
    cd ruby-docs-samples/endpoints/getting-started
di Gemini Advanced.
.
.
NodeJS

Per clonare o scaricare l'API di esempio:

  1. Clona il repository dell'app di esempio nella tua macchina locale: 
    git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples

    In alternativa, scarica l'anteprima come file ZIP ed estrarlo.

  2. Passa alla directory che contiene il codice campione: 
    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 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 è basato su Specifica OpenAPI v2.0. Per configurare gli endpoint:

  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 linee vicino a host , che dovrai modificare. Per eseguire il deployment del file openapi.yaml a Endpoints, è necessario il documento OpenAPI completo.
    • Il file openapi.yaml di esempio contiene una sezione per la configurazione non necessaria per questo tutorial. Non è necessario configurare le linee con YOUR-SERVICE-ACCOUNT-EMAIL e YOUR-CLIENT-ID.
    • OpenAPI è una specifica indipendente dalla lingua. Lo stesso file openapi.yaml si trova nell'esempio getting-started in GitHub di ogni lingua repository per praticità.

  2. Nel campo host, sostituisci il testo con Nome servizio Endpoints, che deve avere il 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 si tratta del modello completo nome di dominio (FQDN) che utilizzi per inviare richieste all'API.

Per informazioni sui campi nel documento OpenAPI che Per gli endpoint è necessario. Consulta Configurazione Endpoint.

Dopo aver completato tutti i passaggi di configurazione seguenti e puoi inviare richieste all'API di esempio utilizzando un indirizzo IP, consulta Configurazione del DNS per 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-samples/kubernetes.
  2. Carica la configurazione e crea un servizio gestito: 
    gcloud endpoints services deploy openapi.yaml

Il comando gcloud chiama quindi Service Management API per creare un servizio gestito con il nome specificato Campo host del file openapi.yaml. Service Management configura il servizio in base al impostazioni nel file openapi.yaml. Quando apporti modifiche openapi.yaml, devi rieseguire il deployment del file per aggiornare Servizio Endpoints.

Durante la creazione e la configurazione del servizio, Service Management invia informazioni al terminale. Puoi ignorare tranquillamente gli avvisi su I percorsi nel file openapi.yaml non richiedono una chiave API. Al termine della configurazione del servizio, Service Management visualizza con l'ID configurazione del servizio e il nome del servizio, simili seguenti:

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

Nell'esempio precedente, 2017-02-13r0 è il servizio dell'ID configurazione, mentre echo-api.endpoints.example-project-12345.cloud.goog è Servizio Endpoints. L'ID configurazione del servizio è composto da data e ora seguita da un numero di revisione. Se esegui il deployment Di nuovo openapi.yaml file nello stesso giorno, la revisione viene incrementato nell'ID configurazione del servizio. Puoi visualizzare la configurazione del servizio Endpoints negli Endpoint > la pagina Servizi nella console Google Cloud.

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

Controllo dei servizi richiesti in corso...

Come minimo, Endpoints ed ESP richiedono seguenti servizi Google da attivare:
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, non abilita i servizi richiesti nelle seguenti circostanze:

  • Se hai utilizzato un'applicazione di terze parti, come Terraform, includono questi servizi.

  • Hai eseguito il deployment della configurazione di Endpoints in una Progetto Google Cloud in cui questi servizi sono stati disattivati esplicitamente.

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

gcloud services list

Se non vedi elencati i servizi richiesti, 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 il 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 è visualizzato nella colonna Nome servizio.

  • Per OpenAPI, ENDPOINTS_SERVICE_NAME è quello che hai 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 ulteriori informazioni sui comandi gcloud, consulta gcloud servizi.

Creazione delle credenziali per il servizio

Per fornire la gestione dell'API, sia ESP sia 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 ambiente, ESP ed ESPv2 ottengono i token di accesso per te tramite servizio di metadati di Google Cloud.

Quando esegui il deployment di ESP o ESPv2 in un ambiente non Google Cloud, ad esempio come desktop locale, un cluster Kubernetes on-premise o un altro devi fornire un file JSON dell'account di servizio. che contiene una chiave privata. ESP ed ESPv2 utilizzano account di servizio 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 della 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 del 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. Sul computer viene scaricato un file della chiave JSON.

    Assicurati di archiviare il file della chiave in modo sicuro, perché può essere utilizzato per di autenticarsi con il proprio account di servizio. Puoi spostare e rinominare questo file come desideri.

  13. Fai clic su Chiudi.

gcloud

  1. Inserisci il codice seguente per visualizzare gli ID progetto per il tuo Progetti Google Cloud:

    gcloud projects list

  2. Sostituisci PROJECT_ID nel seguente comando per impostare il valore predefinito progetto a 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 al tuo di dati e servizi su Google Cloud:

    gcloud auth login

    Se hai più di un account, assicurati di scegliere quello con cui fa parte del progetto Google Cloud in cui si trova l'API. Se esegui gcloud auth list, l'account che hai selezionato risulta 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 per l'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 di chiavi per l'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 e ESPv2 e i ruoli IAM richiesti per l'account di servizio collegato per accedere a queste risorse.

Configurazione del servizio endpoint

ESP ed ESPv2 chiamano Service Control che utilizza la configurazione del servizio endpoint. La configurazione del servizio endpoint è una risorsa IAM, mentre ESP ed ESPv2 necessitano Controller di servizi per accedervi.

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

Utilizza il seguente comando gcloud per aggiungere il ruolo al 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

Chiamata ESP ed ESPv2 Cloud Trace per esportare Trace in un progetto. Questo progetto è chiamato tracciamento progetto. In ESP, il progetto di tracciamento e il progetto proprietario la configurazione del servizio endpoint è la stessa. In ESPv2, il progetto di tracciamento può essere specificato dal flag --tracing_project_id, e il valore predefinito del progetto di deployment.

ESP ed ESPv2 richiedono l'agente Cloud Trace per abilitare Cloud Trace.

Utilizza il seguente comando gcloud per aggiungere il ruolo al 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 del progetto di tracciamento
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com è l'account di servizio collegato. Per ulteriori informazioni, vedi Cosa sono i ruoli e le autorizzazioni?

Consulta: 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 che gestisce il backend dell'API. Questa sezione illustra come eseguire il deployment di container predefiniti per l'API di esempio da ESPv2 a Kubernetes.

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 ulteriori informazioni, vedi Cosa sono i ruoli e le autorizzazioni?

Fornisce a ESPv2 le credenziali di servizio

ESPv2, che viene eseguito all'interno di un container, richiede l'accesso a credenziali archiviate localmente nel file service-account-creds.json. Per fornire ESPv2 con accesso alle credenziali, devi creare Secret Kubernetes e montare il secret Kubernetes Volume Kubernetes.

Per creare il secret Kubernetes e montare il volume:

  1. Assicurati di rinominare il file JSON in service-account-creds.json e copiarlo in endpoints-samples/kubernetes se è stato scaricato in un'altra directory. In questo modo, il nome corrisponde alle opzioni specificate in echo.yaml del deployment.
  2. Assicurati di essere nella directory endpoints-samples/kubernetes.

  3. Crea un secret Kubernetes con le credenziali dell'account di servizio utilizzando il seguente comando:

    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 del deployment che utilizzi per eseguire il deployment dell'API e da ESPv2 a Kubernetes contiene già volume segreto, come mostrato nelle due sezioni seguenti del file:

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

Configurazione del nome del servizio e avvio del servizio

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

Per configurare il nome del servizio e avviarlo:

  1. Apri il file manifest di deployment echo.yaml e sostituisci SERVICE_NAME nelle opzioni di avvio di ESPv2 con il nome del tuo servizio. Si tratta dello stesso nome che hai configurato nella 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:2
  args: [
    "--listener_port=8080",
    "--backend=127.0.0.1:8081",
    "--service=SERVICE_NAME",
    "--rollout_strategy=managed",
    "--non_gcp",
    "--service_account_key=/etc/esp/creds/service-account-creds.json"
  ]
  ports:
    - containerPort: 8080
  volumeMounts:
    - mountPath: /etc/esp/creds
      name: service-account-creds
      readOnly: true
- name: echo
  image: gcr.io/endpoints-release/echo:latest
  ports:
    - containerPort: 8081

    Opzione "--rollout_strategy=managed" configura ESPv2 in modo che utilizzi l'ultima configurazione del servizio di cui è stato eseguito il deployment. Quando specificare questa opzione, entro un minuto dopo il deployment di un nuovo servizio configurazione, ESPv2 rileva la modifica e inizia automaticamente a utilizzarla. Me ti consigliamo di specificare questa opzione anziché fornire un ID configurazione specifico per ESPv2. Per informazioni sulle altre opzioni ESPv2 utilizzate, vedi Opzioni di avvio di ESPv2.

  2. Avvia il servizio su cui eseguire il deployment del servizio Endpoints con il seguente comando:

    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. Consulta: Configurare kubectl per ulteriori informazioni. Per ulteriori informazioni, vedi Deployment di Endpoints su Kubernetes.

Recuperare l'indirizzo IP esterno del servizio

Se utilizzi Minikube, passa a Invio di una richiesta tramite un indirizzo IP. Dopo l'avvio del servizio nel container, possono essere necessari alcuni minuti 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. Questo indirizzo IP viene utilizzato invii una richiesta all'API di esempio.

Invio di una richiesta tramite un indirizzo IP

Dopo che l'API di esempio è in esecuzione nel cluster di container, puoi inviare richieste all'API.

Creare una chiave API e impostare una variabile di ambiente

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

  1. Nello stesso progetto Google Cloud che hai utilizzato per l'API, crea una chiave API nella Credenziali API. Se vuoi creare una chiave API in un altro progetto Google Cloud, vedi Attivazione 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. Incolla la chiave API sul computer locale per assegnarla a un ambiente variabile:
    • In Linux o macOS: export ENDPOINTS_KEY=AIza...
    • In Windows PowerShell: $Env:ENDPOINTS_KEY="AIza..."

Invia la richiesta a minikube

I seguenti comandi 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 tramite l'ambiente ENDPOINTS_KEY impostata in precedenza. Sostituisci IP_ADDRESS con l'indirizzo IP esterno dell'istanza.

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

Nel periodo precedente (curl):

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

PowerShell

Usa Invoke-WebRequest per inviare una richiesta HTTP mediante ENDPOINTS_KEY che hai impostato in precedenza. Sostituisci IP_ADDRESS con l'indirizzo IP esterno del tuo in esecuzione in un'istanza Compute Engine.

(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 in PowerShell, assicuratevi che non ci sia uno spazio dopo l’accento grave. Per informazioni sulle opzioni utilizzate nella richiesta di esempio, vedi Invoke-WebRequest nel documentazione.

App di terze parti

Puoi utilizzare un'applicazione di terze parti come il browser Chrome Postman per inviare 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 il messaggio che invii e risponde con seguenti:

{
  "message": "hello world"
}

Se non hai ricevuto una risposta positiva, consulta 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 delle attività per l'API in Endpoint > Servizi.

    Vai alla pagina dei servizi Endpoints


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

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

    Vai alla pagina Esplora log

Configurazione del DNS per Endpoints

Poiché il nome del servizio Endpoints per l'API è in .endpoints.YOUR_PROJECT_ID.cloud.goog dominio, puoi come nome di dominio completo (FQDN) inserendo un piccolo modifica alla configurazione nel file openapi.yaml. In questo modo puoi invia 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 il 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 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 il file openapi.yaml abbia quanto segue configurato: 

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 metodo gcloud, Service Management crea un record A DNS, echo-api.endpoints.my-project-id.cloud.goog, che si risolve nel indirizzo IP di destinazione, 192.0.2.1. Potrebbero essere necessari alcuni minuti nuova configurazione DNS da propagare.

Configurazione di SSL

Per maggiori dettagli su come configurare DNS e SSL, consulta Attivazione di SSL per Endpoint.

Invio di una richiesta al nome di dominio completo in corso...

Ora che hai configurato il record DNS per l'API di esempio, invia un utilizzando il nome di dominio completo (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 gli sviluppatori per l'API

Puoi usare il portale Cloud Endpoints per creare un portale per sviluppatori, un sito web che puoi utilizzare per interagire con l'API di esempio. Per saperne di più, vedi 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 echo.yaml

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

Passaggi successivi