Guida alle operazioni

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Come ottenere una chiave API

L'esempio seguente spiega come ottenere una chiave API che puoi utilizzare per convalidare le chiamate API a un servizio di destinazione proxy tramite Apigee Adapter per Envoy.

1. Accedi ad Apigee

  1. Apri l'interfaccia utente di Apigee in un browser.
  2. Una volta nell'interfaccia utente, seleziona la stessa organizzazione utilizzata per configurare Apigee Adapter per Envoy.

2. Creazione di uno sviluppatore

Puoi utilizzare uno sviluppatore esistente per i test o crearne uno nuovo nel seguente modo:

  1. Seleziona Pubblica > Sviluppatori nel menu di navigazione laterale.
  2. Fai clic su + Sviluppatore.
  3. Compila la finestra di dialogo per creare un nuovo sviluppatore. Puoi utilizzare il nome/l'indirizzo email dello sviluppatore che preferisci.

3. Creazione di un prodotto API

Segui l'esempio di creazione del prodotto riportato di seguito. Consulta anche Informazioni sulla configurazione dei prodotti API.

  1. Seleziona Pubblica > Prodotti API nel menu di navigazione laterale.
  2. Fai clic su + Prodotto API.
  3. Compila la pagina Dettagli prodotto come segue. Non fare clic su Salva finché non ti viene chiesto di farlo.
    4. Campo Valore
    Nome httpbin-product
    Nome visualizzato httpbin product
    Ambiente your_environment

    Impostalo sull'ambiente utilizzato per il provisioning di Apigee Adapter per Envoy con apigee-remote-service-cli.

    Accesso Private
    Quota 5 richieste ogni minuto

    Consulta anche Informazioni sulla configurazione dei prodotti API.

  4. Nella sezione Destinatari dei servizi remoti Apigee, fai clic su Aggiungi un destinatario del servizio remoto Apigee.
  5. Nella finestra di dialogo Destinazione del servizio remoto Apigee, aggiungi i seguenti valori:
    Attributo Valore Descrizione
    Nome target Inserisci il nome del servizio di destinazione. Ad esempio: httpbin.org L'endpoint di destinazione gestito dal proxy Envoy.
    Proxy API remote-service Il proxy remote-service di cui è stato eseguito il provisioning su Apigee durante l'installazione di Envoy Adapter.
    Percorso Inserisci un /resource_path per trovare una corrispondenza con un percorso specifico. Ad esempio: /httpbin. Il percorso della richiesta da associare all'endpoint di destinazione. Le chiamate proxy API a questo percorso corrisponderanno a questo prodotto API.
  6. Fai clic su Salva.

4. Creazione di un'app sviluppatore

  1. Seleziona Pubblica > App nel menu di navigazione laterale.
  2. Fai clic su + App.
  3. Compila la pagina dell'app per sviluppatori come segue. Non salvare finché non ti viene chiesto di farlo.
    4. Nome httpbin-app
    Nome visualizzato httpbin app
    Developer Seleziona lo sviluppatore che hai creato in precedenza o scegli uno qualsiasi dall'elenco.
  4. Aggiungi poi due prodotti all'app:
    1. Innanzitutto, nella sezione Credenziali, fai clic su + Aggiungi prodotto e seleziona il prodotto appena configurato: httpbin-product.
    2. Aggiungi il prodotto remote-service. Questo prodotto è stato creato automaticamente quando hai eseguito il provisioning di Apigee.
  5. Fai clic su Crea.
  6. In Credenziali, fai clic su Mostra accanto a Chiave.
  7. Copia il valore della chiave consumer. Questo valore è la chiave API che utilizzerai per effettuare chiamate API al servizio httpbin.

Informazioni sui prodotti API

I prodotti API sono il punto di controllo principale per il servizio Apigee Remote. Quando crei un prodotto API e lo associ a un servizio di destinazione, crei un criterio che verrà applicato a tutte le richieste che configuri per la gestione da parte di Apigee Adapter per Envoy.

Definizione del prodotto API

Quando definisci un prodotto API in Apigee, puoi impostare una serie di parametri che verranno utilizzati per valutare le richieste:

  • Target
  • Percorso richiesta
  • Quota
  • ambiti OAuth

Destinazioni dei servizi remoti

La definizione del prodotto API verrà applicata a una richiesta se questa corrisponde sia al binding di destinazione (ad es. httpbin.org) sia al percorso della richiesta (ad es. /httpbin). Un elenco di potenziali target viene memorizzato come attributo del prodotto API.

Per impostazione predefinita, il servizio Apigee Remote controlla l'intestazione :authority (host) speciale di Envoy rispetto al suo elenco di target. Tuttavia, può essere configurato per utilizzare altre intestazioni.

Percorso della risorsa API

Il percorso inserito corrisponde in base alle seguenti regole:

  • Una singola barra (/) da sola corrisponde a qualsiasi percorso.
  • * è valido ovunque e corrisponde all'interno di un segmento (tra barre oblique).
  • ** è valido alla fine e corrisponde a qualsiasi carattere fino alla fine della riga.

Quota

Una quota specifica il numero di messaggi di richiesta che un'app può inviare a un'API nel corso di un'ora, un giorno, una settimana o un mese. Quando un'app raggiunge il limite di quota, le chiamate API successive vengono rifiutate.

Casi d'uso delle quote

Le quote ti consentono di applicare il numero di richieste che un client può inviare a un servizio in un determinato periodo di tempo. Le quote vengono spesso utilizzate per applicare contratti commerciali o SLA con sviluppatori e partner, anziché per la gestione del traffico operativo. Ad esempio, una quota potrebbe essere utilizzata per limitare il traffico per un servizio gratuito, consentendo al contempo l'accesso completo ai clienti paganti.

La quota è definita in un prodotto API

I parametri di quota sono configurati nei prodotti API. Ad esempio, quando crei un prodotto API, puoi impostare facoltativamente il limite di quota, l'unità di tempo e l'intervallo consentiti.

Impostazione di un limite di quota nell'interfaccia utente di Apigee.

Poiché le chiavi API vengono associate ai prodotti API, ogni volta che viene verificata una chiave API, il contatore delle quote appropriato può essere decrementato (se è definita una quota nel prodotto associato).

A differenza del runtime Apigee, le quote inserite nella definizione del prodotto vengono applicate automaticamente dal servizio remoto Apigee. Se la richiesta è autorizzata, verrà conteggiata ai fini della quota consentita.

Dove vengono mantenute le quote

Le quote vengono gestite e controllate localmente dal processo del servizio remoto e gestite in modo asincrono con Apigee Runtime. Ciò significa che le quote non sono precise e potrebbero verificarsi alcuni superamenti se hai più di un servizio remoto che gestisce la quota. Se la connessione al runtime Apigee viene interrotta, la quota locale continuerà come quota autonoma fino a quando non potrà ricollegarsi al runtime Apigee.

Ambiti OAuth

Se utilizzi i token JWT, puoi limitarli a sottoinsiemi degli ambiti OAuth consentiti. Gli ambiti assegnati al token JWT emesso verranno controllati in base agli ambiti del prodotto dell'API.

Informazioni sulle app sviluppatore

Dopo aver configurato i prodotti API, dovrai creare un'app associata a uno sviluppatore. L'app consente a un client di accedere ai prodotti API associati con una chiave API o un token JWT.

Utilizzo dell'autenticazione basata su JWT

Puoi utilizzare un token JWT per effettuare chiamate proxy API autenticate anziché utilizzare una chiave API. Questa sezione spiega come utilizzare il comando apigee-remote-service-cli token per creare, ispezionare e ruotare i token JWT. Per l'ambiente ibrido Apigee, puoi utilizzare questo comando per creare il secret Kubernetes per contenere i token JWT.

Panoramica

La verifica e l'autenticazione JWT vengono gestite da Envoy utilizzando il JWT Authentication Filter.

Una volta autenticato, il filtro ext-authz di Envoy invia le intestazioni della richiesta e il JWT a apigee-remote-service-envoy. Corrisponde ai claim api_product_list e scope del JWT ai prodotti API Apigee per autorizzarlo rispetto al target della richiesta.

Creazione di token JWT Apigee

I token JWT di Apigee possono essere creati utilizzando l'interfaccia a riga di comando:

apigee-remote-service-cli token create -c config.yaml --id $KEY --secret $SECRET

In alternativa, puoi utilizzare l'endpoint del token OAuth standard. Esempio di curl:

curl https://org-env.apigee.net/remote-service/token -d '{"client_id":"myclientid","client_secret":"myclientsecret","grant_type":"client_credentials"}' -H "Content-type: application/json"

Utilizzo del token JWT

Una volta ottenuto il token, devi semplicemente passarlo a Envoy nell'intestazione Authorization. Esempio:

curl localhost:8080/httpbin/headers -i -H "Authorization:Bearer $TOKEN"

Errore del token JWT

Rifiuto di Envoy

Se Envoy rifiuta il token, potresti visualizzare un messaggio simile al seguente:

Jwks remote fetch is failed

In questo caso, assicurati che la configurazione di Envoy contenga un URI valido nella sezione remote_jwks, che sia raggiungibile da Envoy e che tu abbia impostato correttamente i certificati quando hai installato il proxy Apigee. Dovresti essere in grado di chiamare direttamente l'URI con una chiamata GET e ricevere una risposta JSON valida.

Esempio:

curl https://myorg-eval-test.apigee.net/remote-service/certs

Altri messaggi di Envoy potrebbero avere il seguente aspetto:

  • "I segmenti di pubblico in JWT non sono consentiti"
  • "L'emittente JWT non è configurato"

Si tratta di requisiti nella configurazione di Envoy che potresti dover modificare.

Ispezionare un token

Puoi utilizzare l'interfaccia a riga di comando per controllare il token. Esempio

apigee-remote-service-cli -c config.yaml token inspect -f path/to/file

o 

apigee-remote-service-cli -c config.yaml token inspect <<< $TOKEN

Debug

Consulta Chiave API valida non funziona.

Logging

Puoi regolare il livello di logging nel servizio $REMOTE_SERVICE_HOME/apigee-remote-service-envoy. Tutti i log vengono inviati a stderr.

Elemento Obbligatorio Descrizione
-l, --log-level Livelli validi: debug, info, warn, error. Regola il livello di registrazione. Valore predefinito: info
-j, --json-log Emette l'output del log come record JSON.

Envoy fornisce la registrazione. Per ulteriori informazioni, consulta i seguenti link alla documentazione di Envoy:

Modifica del nome del secret del criterio

Un secret Kubernetes di cui è stato eseguito il deployment nel cluster contiene le credenziali di cui l'adattatore ha bisogno per autenticare la comunicazione con il proxy del servizio remoto. Questo secret richiede un punto di montaggio del volume, che è configurabile. Per impostazione predefinita, il punto di montaggio è /policy-secret. Per modificare il punto di montaggio:

  1. Esegui questo comando: 
    $REMOTE_SERVICE_HOME/apigee-remote-service-envoy --policy-secret '/new-mount_point_name

    Ad esempio: 

    $REMOTE_SERVICE_HOME/apigee-remote-service-envoy --policy-secret '/my-mount-point
  2. Apri $CLI_HOME/samples/apigee-envoy-adapter.yaml in un editor.
  3. Modifica il nome del punto di montaggio con il nuovo nome: 
    volumeMounts:
  - mountPath: /config
    name: apigee-remote-service-envoy
    readOnly: true
  - mountPath: /opt/apigee/tls
    name: tls-volume
    readOnly: true
  - mountPath: /my-mount-point
    name: policy-secret
    readOnly: true
  4. Salva il file e applicalo al mesh di servizi: 
    kubectl apply -f $REMOTE_SERVICE_HOME/samples/apigee-envoy-adapter.yaml

Utilizzo di un proxy di rete

Un proxy HTTP può essere inserito utilizzando le variabili di ambiente HTTP_PROXY e HTTPS_PROXY nell'ambiente del file binario apigee-remote-service-envoy. Quando le utilizzi, la variabile di ambiente NO_PROXY può essere utilizzata anche per escludere l'invio di host specifici tramite il proxy.

HTTP_PROXY=http://[user]:[pass]@[proxy_ip]:[proxy_port]
HTTPS_PROXY=http://[user]:[pass]@[proxy_ip]:[proxy_port]
NO_PROXY=127.0.0.1,localhost

Ricorda che il proxy deve essere raggiungibile da apigee-remote-service-envoy.

Informazioni su metriche e analisi

Un endpoint delle metriche Prometheus è disponibile all'indirizzo :5001/metrics. Puoi configurare questo numero di porta. Consulta la sezione File di configurazione.

Dati di Envoy

I seguenti link forniscono informazioni su come ottenere i dati di analisi del proxy Envoy:

Dati e analisi di Istio

I seguenti link forniscono informazioni su come ottenere i dati di analisi del proxy Envoy:

Apigee Analytics

Apigee Remote Service for Envoy invia le statistiche sulle richieste ad Apigee per l'elaborazione di analisi. Apigee registra queste richieste sotto il nome del prodotto API associato.

Per informazioni su Apigee Analytics, consulta la panoramica dei servizi di analisi.