Endpoints è un sistema di gestione delle API distribuito che comprende servizi, runtime e strumenti. Endpoints fornisce gestione, monitoraggio e autenticazione.
I componenti che compongono Endpoints sono:
Extensible Service Proxy (ESP) o Extensible Service Proxy V2 (ESPv2): per inserire le funzionalità di Endpoints.
Service Control: per applicare le regole di gestione delle API.
Service Management per configurare le regole di gestione delle API.
Google Cloud CLI per il deployment e la gestione.
Console Google Cloud per il logging, il monitoraggio e la condivisione.
Architettura di Endpoints
Componenti endpoint
ESP
ESP è un proxy basato su NGINX che viene eseguito davanti al backend e inserisce le funzionalità di Endpoints come l'autenticazione, il monitoraggio e il logging. ESP recupera una configurazione del servizio da Service Management e la utilizza per convalidare le richieste in entrata.
ESP è progettato per consentirti di eseguirne il deployment in un ambiente containerizzato e di convalidare i token JWT e ID Google. Utilizza varie tecniche, ad esempio la memorizzazione nella cache intensiva e le chiamate asincrone, per essere leggera e ad alte prestazioni.
L'assistenza di ESP è disponibile per le seguenti piattaforme:
ESPv2
ESPv2 è un proxy scalabile e ad alte prestazioni basato su Envoy che viene eseguito davanti a un backend OpenAPI o gRPC API. Endpoints su ESPv2 supporta la versione 2 della specifica OpenAPI e delle specifiche gRPC.
ESPv2 si integra con Google Service Infrastructure per abilitare funzionalità di gestione delle API su larga scala, tra cui autenticazione, report di telemetria, metriche e sicurezza.
Il supporto di ESPv2 è disponibile per le seguenti piattaforme:- Ambiente standard di App Engine
- Cloud Functions
- Cloud Run
- Knative serving
- Compute Engine
- Google Kubernetes Engine
- Kubernetes
Controllo servizio
Controllo del servizio applica le regole di gestione delle API in fase di runtime, come l'autenticazione delle chiavi, il monitoraggio e il logging. Service Control offre i seguenti metodi:
"Check": verifica l'autenticazione e le chiavi API e indica se la chiamata deve essere consentita
Report: notifica ai sistemi di registrazione per la registrazione e il monitoraggio
Gestione del servizio
Utilizza la specifica OpenAPI per descrivere la superficie e il comportamento dell'API in un file di testo denominato configurazione di Endpoints. Puoi eseguire il deployment della configurazione degli endpoint in Service Management utilizzando gcloud CLI, che configura le regole di gestione delle API. Qui si verificano anche altre attività relative alla configurazione, ad esempio la condivisione dell'API con altri sviluppatori, l'abilitazione o la disabilitazione dell'API in progetti diversi e la generazione di chiavi API.gcloud CLI
gcloud CLI fornisce Google Cloud CLI che puoi utilizzare per effettuare chiamate a vari servizi Google Cloud. Utilizza Google Cloud CLI per eseguire il deployment della configurazione di Endpoints in Service Management.
Console Google Cloud
La console Google Cloud è la Graphic User Interface per Google Cloud. Endpoints utilizza la console Google Cloud per esporre i dati di monitoraggio e logging inviati da ESP o ESPv2 e registrati da Service Control, per condividere le API con altri sviluppatori e per generare chiavi API per chiamare l'API.
Scenari di deployment
Le opzioni per il deployment variano in base all'utilizzo di ESP o ESPv2 come proxy Endpoints. È possibile eseguire il deployment di ESPv2 come proxy remoto e di eseguire il deployment di ESPv2 ed ESP in modalità sidecar, come spiegato nelle sezioni seguenti.
Modalità proxy remoto
Se utilizzi ESPv2, puoi eseguire il deployment degli endpoint come proxy remoto. Questa modalità viene utilizzata per supportare le applicazioni in esecuzione su piattaforme serverless come Cloud Run, Cloud Functions e App Engine per gli ambienti standard.
In questa modalità, viene eseguito il deployment di ESPv2 come applicazione Cloud Run. L'applicazione è configurata per utilizzare ESPv2 come backend remoto utilizzando il campo x-google-backend nella configurazione del servizio OpenAPI. Quando funziona come proxy remoto in questa modalità di deployment, un singolo ESPv2 può supportare più backend remoti.
Modalità Sidecar
Sia ESP sia ESPv2 supportano il deployment in un container insieme a ciascuna istanza del backend. Questa topologia server-locale è ideale sia per le API per il web sia per i microservizi. Evita l'hop di rete tipicamente associato a proxy centralizzati e consente una gestione delle API ad alte prestazioni e scalabile.
In genere, il bilanciamento del carico viene applicato prima che il traffico raggiunga ESP o ESPv2. In App Engine, il bilanciamento del carico viene eseguito automaticamente. Su Compute Engine, questa operazione viene eseguita da Cloud Load Balancing. Per i deployment Kubernetes, puoi utilizzare un proxy in entrata per il bilanciamento del carico. In Google Kubernetes Engine, per il bilanciamento del carico puoi utilizzare Cloud Load Balancing o un proxy in entrata.
All'avvio, ESP o ESPv2 ottiene la configurazione del servizio da Service Management. La configurazione del servizio viene generata dalla specifica OpenAPI o da gRPC, il file YAML di configurazione del servizio. Indica a ESP o ESPv2 sia la superficie dell'API da gestire insieme ai criteri, ad esempio quali metodi richiedono l'autenticazione e quali richiedono chiavi API.
Routing delle richieste
Quando viene ricevuta una richiesta, ESP o ESPv2 crea un token di traccia per Cloud Trace.
Successivamente, ESP o ESPv2 associa il percorso delle richieste in entrata con la superficie dell'API. Dopo aver trovato una route corrispondente, ESP o ESPv2 esegue tutti i passaggi di autenticazione per il metodo specificato.
Se è necessaria la convalida JWT, ESP o ESPv2 convalida l'autenticazione utilizzando la chiave pubblica appropriata per il firmatario e convalida il campo relativo al pubblico nel JWT. Se è richiesta una chiave API, ESP o ESPv2 chiama l'API Service Control per convalidare la chiave.
Service Control cerca la chiave per convalidarla e garantisce che il progetto associato alla chiave abbia abilitato l'API. Se la chiave non è valida o se il progetto non ha abilitato l'API, la chiamata viene rifiutata e viene registrata tramite l'API Service Control.
Se il Controllo del servizio convalida la chiave, la richiesta insieme a tutte le intestazioni originali, più un'intestazione di convalida JWT, se appropriata, viene inoltrata al backend.
Quando viene ricevuta una risposta dal backend, ESP o ESPv2 restituisce la risposta al chiamante e invia le informazioni sul momento finale finali a Trace. I punti di chiamata vengono registrati dall'API Service Control, che scrive metriche e log nelle destinazioni appropriate.
ESP o ESPv2 su Kubernetes
Il seguente diagramma mostra l'architettura complessiva in cui ESP viene eseguito come container side-car di fronte al container dell'applicazione del servizio API, con l'API my-api ospitata in my-api.com e supportata da un servizio Kubernetes. L'architettura sarebbe la stessa per un deployment collaterale con ESPv2.
