Endpoints è un sistema distribuito di gestione delle API, che comprende servizi, runtime e strumenti. Gli endpoint forniscono gestione, monitoraggio e autenticazione.
I componenti che compongono gli endpoint sono:
Extensible Service Proxy (ESP) o Extensible Service Proxy V2 (ESPv2), per l'inserimento delle funzionalità degli endpoint.
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 degli endpoint
Componenti degli endpoint
ESP
ESP è un proxy basato su NGINX che viene eseguito davanti al backend e inserisce le funzionalità degli endpoint 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.
L'ESP è progettato per consentirti di eseguirne il deployment in un ambiente containerizzato e di convalidare i token JWT e ID Google. Impiega una varietà di tecniche, come la memorizzazione nella cache intensiva e le chiamate asincrone, per mantenere leggerezza e prestazioni elevate.
L'assistenza ESP è disponibile per le seguenti piattaforme:
ESPv2
ESPv2 è un proxy scalabile ad alte prestazioni basato su Envoy che viene eseguito davanti al backend di un'API OpenAPI o gRPC. 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 per ESPv2 è disponibile per le seguenti piattaforme:Service Control
Service Control applica le regole di gestione delle API in fase di runtime, ad esempio l'autenticazione delle chiavi, il monitoraggio e il logging. Service Control offre i seguenti metodi:
Controllo: consente di verificare l'autenticazione e le chiavi API e indica se una chiamata deve essere consentita.
Report: notifica i sistemi di registrazione per il logging e il monitoraggio
Gestione servizio
Descrivi il comportamento del servizio gRPC in un file YAML indicato come configurazione Endpoints. Puoi eseguire il deployment della configurazione degli endpoint e dei file.proto compilati in Service Management utilizzando gcloud CLI, che configura le regole di gestione delle API.
Altre attività correlate alla configurazione si verificano anche qui, 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. Puoi utilizzare 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 di 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, condividere le API con altri sviluppatori e generare chiavi API per chiamare l'API.
Scenari di deployment
Le opzioni per il deployment variano a seconda dell'utilizzo di ESP o ESPv2 come proxy di Endpoints. Il deployment di ESPv2 può essere eseguito come proxy remoto ed è possibile eseguire il deployment sia di ESPv2 che di ESP in modalità sidecar, come spiegato nelle sezioni seguenti.
Modalità proxy remoto
Se utilizzi ESPv2, è possibile eseguire il deployment di Endpoints 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 mediante 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 che ESPv2 supportano il deployment in un container insieme a ogni istanza del backend. Questa topologia server-locale è ideale sia per API rivolte al web che per microservizi. Evita l'hop di rete tipicamente associato ai 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 Compute Engine, l'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, puoi utilizzare Cloud Load Balancing o un proxy in entrata per il bilanciamento del carico.
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 i metodi che richiedono l'autenticazione e quelli che richiedono le chiavi API.
Routing delle richieste
Alla ricezione di una richiesta, ESP o ESPv2 crea un token di traccia per Cloud Trace.
Quindi, ESP o ESPv2 associano il percorso delle richieste in entrata alla superficie dell'API. Dopo aver trovato una route corrispondente, ESP o ESPv2 esegue qualsiasi passaggio 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 pubblico nel JWT. Se è richiesta una chiave API, ESP o ESPv2 chiama l'API Service Control per convalidarla.
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 Service Control convalida la chiave correttamente, la richiesta insieme a tutte le intestazioni originali e un'intestazione di convalida JWT, se appropriata, vengono inoltrate al backend.
Quando viene ricevuta una risposta dal backend, ESP o ESPv2 restituisce la risposta al chiamante e invia le informazioni di tempistica finali a Trace. I call point 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 davanti 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 sarà la stessa per un deployment collaterale con ESPv2.
