Informazioni sullo stato del client Cloud Service Mesh
Quando utilizzi Cloud Service Mesh per gestire il networking delle applicazioni, prendi in considerazione i due componenti principali seguenti:
- Il livello dell'infrastruttura. Il livello di infrastruttura, come proxy collaterali Envoy o librerie gRPC senza proxy, è configurato per gestire il networking per conto delle tue applicazioni.
- Il piano di controllo, Cloud Service Mesh. Il piano di controllo genera e distribuisce la configurazione a livello di infrastruttura.
Quando un proxy Envoy o la libreria gRPC vengono inizializzati, utilizza le API xDS per connettersi a Cloud Service Mesh. Il proxy o la libreria funge da client per il mesh di servizi Cloud. Dopo aver stabilito una connessione tra il client e Cloud Service Mesh, Cloud Service Mesh invia le informazioni di configurazione al client e, se necessario, aggiorna la configurazione.
A volte è utile capire quali client sono connessi a Cloud Service Mesh o ispezionare la configurazione che Cloud Service Mesh genera per i suoi client. Ad esempio, potresti voler eseguire il debug di un problema o capire in che modo le azioni eseguite durante la configurazione di Cloud Service Mesh influiscono sulla configurazione visualizzata dai client.
Cloud Service Mesh supporta l'API Client Status Discovery Service (CSDS). Utilizzi un client CSDS per eseguire query su questa API. In questo modo puoi vedere quali client sono connessi a Cloud Service Mesh e di ispezionare la configurazione che Cloud Service Mesh genera per i suoi client.
Il client CSDS è uno strumento open source che puoi scaricare dal repository Envoy. Il seguente diagramma illustra il modo in cui il client CSDS interroga Cloud Service Mesh per informazioni sull'API CSDS di Cloud Service Mesh.
Il client CSDS si connette a Cloud Service Mesh e riporta un numero di progetto e un nome di rete, insieme a un set di credenziali. Cloud Service Mesh può quindi rispondere con informazioni sui vari client Cloud Service Mesh a cui è connesso.
Per ulteriori informazioni sul client CSDS, consulta il file README.
Prerequisiti
Per connetterti all'API CSDS, devi disporre di un client CSDS. Puoi ottenere il client in due modi:
- Puoi creare il client utilizzando Cloud Shell.
- Puoi creare il client su una macchina di sviluppo locale.
Creare il client CSDS utilizzando Cloud Shell
Per utilizzare Cloud Shell per creare il client CSDS:
- Resetta Cloud Shell seguendo le istruzioni in Disabilitare o reimpostare Cloud Shell. In questo modo, le configurazioni esistenti non interferiscono con la build.
- Nella console Google Cloud, apri una nuova sessione di Cloud Shell.
Esegui questo comando per ottenere il codice sorgente da utilizzare per creare il client CSDS:
git clone https://github.com/envoyproxy/envoy-tools.git
Passa alla directory del client CSDS ed esegui questi comandi:
cd envoy-tools/csds-client/ make init make build
Dopo aver completato la build, testala con il seguente comando:
csds-client -help
Se la build ha esito positivo, verrà visualizzato il testo della guida per il client.
Crea il client CSDS su una macchina di sviluppo locale
Puoi scaricare e creare un client CSDS su una macchina locale seguendo le istruzioni riportate nel file README nel repository open source. Per farlo, devi anche aver configurato Go e lo strumento make
nel tuo ambiente. Se preferisci non farlo, segui le istruzioni precedenti per Cloud Shell, in cui Go e lo strumento make
sono disponibili.
Prerequisiti aggiuntivi
Assicurati che l'ID nodo di ciascun client sia univoco all'interno del mesh di servizi. Se più client condividono lo stesso ID nodo, viene restituita solo una configurazione, ovvero quella per il client che si è connesso più di recente a Cloud Service Mesh.
Se utilizzi i pacchetti di riferimento di Google, non è necessario impostare manualmente l'ID nodo nei file di bootstrap, in quanto viene generato automaticamente un ID nodo. Se non utilizzi i pacchetti di riferimento, devi impostare manualmente l'ID nodo in ciascuno dei tuoi file di bootstrap.
Assicurati di avere accesso a un account utente con le autorizzazioni IAM (Identity and Access Management) necessarie per configurare Cloud Service Mesh. Le seguenti istruzioni utilizzano Google Cloud CLI per generare e fornire automaticamente le credenziali necessarie al client CSDS. In alternativa, puoi utilizzare il client CSDS e fornire direttamente le credenziali.
Determina quali client sono attualmente connessi a Cloud Service Mesh
Puoi utilizzare il client CSDS per determinare quali client sono connessi alla tua configurazione Cloud Service Mesh.
Per ottenere queste informazioni, sono necessari i seguenti dettagli:
L'ID del progetto da cui sono state generate le credenziali.
Se utilizzi le API di routing dei servizi, puoi eseguire uno dei seguenti passaggi, a seconda della risorsa recuperata dal client xDS:
Se utilizzi le API precedenti, il nome della rete VPC specificato quando hai configurato Cloud Service Mesh. Questa rete è quella specificata dalla regola di forwarding della mappa di regole di routing.
API di routing dei servizi
Da un account che dispone delle autorizzazioni corrette, esegui questo comando:
gcloud auth application-default login \ --billing-project=BILLING_PROJECT_ID
Crea un nuovo file in formato YAML con i contenuti seguenti.
node_matchers: - node_metadatas: - path: - key: TRAFFICDIRECTOR_GCP_PROJECT_NUMBER value: string_match: exact: "PROJECT_NUMBER" - path: - key: TRAFFICDIRECTOR_MESH_SCOPE_NAME value: string_match: exact: "MESH_OR_SCOPE"
Sostituisci i seguenti valori:
PROJECT_NUMBER
: l'ID del progettoMESH_OR_SCOPE
: se il client xDS recupera una risorsa mesh, utilizza un prefissomesh:
seguito dal nome effettivo del mesh; se il client xDS recupera una risorsa gateway, utilizza il prefissoscope:
seguito dal nome del parametro dell'ambito
Esegui il client CSDS, che utilizza le credenziali generate da gcloud CLI. Sostituisci
PATH_TO_CSDS_REQUEST_YAML_FILE
con il percorso del file YAML che hai creato nel passaggio precedente.csds-client \ -service_uri trafficdirector.googleapis.com:443 \ -platform gcp \ -authn_mode auto \ -api_version v3 \ -request_file PATH_TO_CSDS_REQUEST_YAML_FILE
Dovresti vedere un output simile al seguente:
Client ID xDS stream type Config status 603e3524-d1d6-4a9e-9b26-39bcd633a7cb~10.128.0.5 ADS N/A 603e3524-d1d6-4a9e-9b26-39bcd633a7cb~10.128.0.5 LRS N/A 8576d4bf-8f10-40b2-920b-bb6a7cf9f34a~10.168.0.3 ADS N/A 8576d4bf-8f10-40b2-920b-bb6a7cf9f34a~10.168.0.3 LRS N/A d9577b61-fa3a-41d6-90bd-11c4fdd2f8c0~10.128.0.4 ADS N/A d9577b61-fa3a-41d6-90bd-11c4fdd2f8c0~10.128.0.4 LRS N/A f38a59c1-4428-42f1-be81-e02eb994f9dd~10.128.0.6 ADS N/A f38a59c1-4428-42f1-be81-e02eb994f9dd~10.128.0.6 LRS N/A
La colonna
Client ID
mostra gli ID client dei client connessi a Cloud Service Mesh. Questi ID client vengono forniti utilizzando il camponode_id
nel file di bootstrap utilizzato da Envoy o da gRPC senza proxy quando si connettono a Cloud Service Mesh.
API precedenti
Da un account che dispone delle autorizzazioni corrette, esegui questo comando:
gcloud auth application-default login \ --billing-project=BILLING_PROJECT_ID
Crea un nuovo file in formato YAML con i contenuti seguenti.
node_matchers: - node_metadatas: - path: - key: TRAFFICDIRECTOR_GCP_PROJECT_NUMBER value: string_match: exact: "PROJECT_NUMBER" - path: - key: TRAFFICDIRECTOR_NETWORK_NAME value: string_match: exact: "NETWORK_NAME"
Sostituisci i seguenti valori:
PROJECT_NUMBER
: l'ID univoco del progetto Google CloudNETWORK_NAME
: la rete VPC specificata dalla regola di forwarding della mappa delle regole di routing
Esegui il client CSDS, che utilizza le credenziali generate da gcloud CLI. Sostituisci
PATH_TO_CSDS_REQUEST_YAML_FILE
con il percorso del file YAML che hai creato nel passaggio precedente.csds-client \ -service_uri trafficdirector.googleapis.com:443 \ -platform gcp \ -authn_mode auto \ -api_version v3 \ -request_file PATH_TO_CSDS_REQUEST_YAML_FILE
Dovresti vedere un output simile al seguente:
Client ID xDS stream type Config status 603e3524-d1d6-4a9e-9b26-39bcd633a7cb~10.128.0.5 ADS N/A 603e3524-d1d6-4a9e-9b26-39bcd633a7cb~10.128.0.5 LRS N/A 8576d4bf-8f10-40b2-920b-bb6a7cf9f34a~10.168.0.3 ADS N/A 8576d4bf-8f10-40b2-920b-bb6a7cf9f34a~10.168.0.3 LRS N/A d9577b61-fa3a-41d6-90bd-11c4fdd2f8c0~10.128.0.4 ADS N/A d9577b61-fa3a-41d6-90bd-11c4fdd2f8c0~10.128.0.4 LRS N/A f38a59c1-4428-42f1-be81-e02eb994f9dd~10.128.0.6 ADS N/A f38a59c1-4428-42f1-be81-e02eb994f9dd~10.128.0.6 LRS N/A
La colonna
Client ID
mostra gli ID client dei client connessi a Cloud Service Mesh. Questi ID client vengono forniti utilizzando il camponode_id
nel file di bootstrap utilizzato da Envoy o da gRPC senza proxy quando si connettono a Cloud Service Mesh.
Ispeziona la configurazione per un client Cloud Service Mesh specifico
Puoi esaminare la configurazione che Cloud Service Mesh invia a un determinato client utilizzando l'ID client, ottenuto nella sezione precedente.
Puoi esaminare la configurazione dettagliata del protocollo delle risorse per determinare quale versione dell'API xDS viene utilizzata dal client specifico. Ad esempio, se vedi envoy.api.v2.Cluster
nella configurazione, significa che il client utilizza l'API v2.
Se nella configurazione è presente envoy.api.v3.Cluster
, significa che il client sta utilizzando l'API v3.
API di routing dei servizi
Aggiorna il file YAML che hai creato in Determinare quali client sono attualmente connessi a Cloud Service Mesh. Aggiungi un campo
node-id
che utilizza l'ID client come valore.node_matchers: - node_id: exact: "CLIENT_ID" node_metadatas: - path: - key: TRAFFICDIRECTOR_GCP_PROJECT_NUMBER value: string_match: exact: "PROJECT_NUMBER" - path: - key: TRAFFICDIRECTOR_MESH_SCOPE_NAME value: string_match: exact: "MESH_OR_SCOPE_NAME"
Sostituisci i seguenti valori:
CLIENT_ID
: l'ID del client di cui stai controllando la configurazione, ad esempioprojects/000000/networks/mesh:mesh1/nodes/00000000-0000-0000-0000-00000000~127.0.0.1
PROJECT_NUMBER
: l'ID univoco del progetto Google CloudMESH_OR_SCOPE
: se il client xDS recupera una risorsa mesh, utilizza un prefissomesh:
seguito dal nome effettivo del mesh; se il client xDS recupera una risorsa gateway, utilizza il prefissoscope:
seguito dal nome del parametro dell'ambito
Esegui il client CSDS. L'esecuzione del client genera un file JSON. Questo file contiene la configurazione inviata al client Cloud Service Mesh.
csds-client \ -service_uri trafficdirector.googleapis.com:443 \ -platform gcp \ -authn_mode auto \ -api_version v3 \ -request_file PATH_TO_CSDS_REQUEST_YAML_FILE \ -output_file FILENAME.JSON
Sostituisci i seguenti valori:
PATH_TO_CSDS_REQUEST_YAML_FILE
: il percorso del file YAMLFILENAME.JSON
: un nome per il file che contiene l'output del client CSDS
Dovresti vedere un output simile al seguente:
Client ID xDS stream type Config status 8576d4bf-8f10-40b2-920b-bb6a7cf9f34a~10.168.0.3 ADS LDS SYNCED RDS SYNCED CDS STALE Config has been saved to FILENAME.JSON
Puoi esaminare una configurazione xDS dettagliata esaminando il file JSON. Questo output contiene lo stato delle singole configurazioni xDS inviate da Cloud Service Mesh al client utilizzando un flusso gRPC aggregato (ADS).
API precedenti
Aggiorna il file YAML che hai creato in Determinare quali client sono attualmente connessi a Cloud Service Mesh. Aggiungi un campo
node-id
che utilizza l'ID client come valore.node_matchers: - node_id: exact: "CLIENT_ID" node_metadatas: - path: - key: TRAFFICDIRECTOR_GCP_PROJECT_NUMBER value: string_match: exact: "PROJECT_NUMBER" - path: - key: TRAFFICDIRECTOR_NETWORK_NAME value: string_match: exact: "NETWORK_NAME"
Sostituisci i seguenti valori:
CLIENT_ID
: l'ID del client di cui stai controllando la configurazione, ad esempiof38a59c1-4428-42f1-be81-e02eb994f9dd~10.128.0.6
PROJECT_NUMBER
: l'ID univoco del progetto Google CloudNETWORK_NAME
: la rete VPC specificata dalla regola di forwarding della mappa delle regole di routing
Esegui il client CSDS. L'esecuzione del client genera un file JSON. Questo file contiene la configurazione inviata al client Cloud Service Mesh.
csds-client \ -service_uri trafficdirector.googleapis.com:443 \ -platform gcp \ -authn_mode auto \ -api_version v3 \ -request_file PATH_TO_CSDS_REQUEST_YAML_FILE \ -output_file FILENAME.JSON
Sostituisci i seguenti valori:
PATH_TO_CSDS_REQUEST_YAML_FILE
: il percorso del file YAMLFILENAME.JSON
: un nome per il file che contiene l'output del client CSDS
Dovresti vedere un output simile al seguente:
Client ID xDS stream type Config status 8576d4bf-8f10-40b2-920b-bb6a7cf9f34a~10.168.0.3 ADS LDS SYNCED RDS SYNCED CDS STALE Config has been saved to FILENAME.JSON
Puoi esaminare una configurazione xDS dettagliata esaminando il file JSON. Questo output contiene lo stato delle singole configurazioni xDS inviate da Cloud Service Mesh al client utilizzando un flusso gRPC aggregato (ADS).
Valori di stato
La seguente tabella elenca i valori che potresti visualizzare per lo stato della configurazione xDS.
Valore | Descrizione |
---|---|
UNKNOWN |
(Predefinito) Le informazioni sullo stato non sono disponibili o sono sconosciute. |
SYNCED |
Cloud Service Mesh ha inviato la configurazione al client e ha ricevuto un valore ACK dal client. |
ERROR |
Cloud Service Mesh ha inviato la configurazione al client e ha ricevuto un
NACK dal client. |
STALE |
Cloud Service Mesh ha inviato la configurazione al client, ma non ha ricevuto un ACK o un NACK dal client. |
NOT_SENT |
La configurazione non è stata inviata. |
N/A |
Il client CSDS non include l'ID nodo. Vengono restituiti tutti i flussi connessi, ma lo stato della configurazione non è disponibile. |
Visualizzazione e monitoraggio
Lo strumento open source client CSDS offre funzionalità aggiuntive che potresti voler utilizzare, come la visualizzazione e il monitoraggio continuo. Per ulteriori informazioni su queste funzionalità, consulta il file README nel repository open source.
Messaggio di errore
Potresti visualizzare il seguente messaggio di errore del client CSDS quando abiliti l'API Cloud Service Mesh solo nel tuo progetto:
rpc error: code = NotFound desc = Requested entity was not found.
Questo è un comportamento previsto. L'ambito della configurazione di Cloud Service Mesh è definito in base alla rete. Se non hai ancora creato una rete ed esegui il client CSDS, visualizzerai questo messaggio di errore.
Limitazioni
- Le informazioni sugli endpoint non sono incluse nella risposta CSDS perché non sono disponibili nell'API CSDS v3.
- L'ID nodo di ciascun client deve essere univoco all'interno del mesh di servizi. Se più client condividono lo stesso ID nodo, viene restituita una sola configurazione, quella per il client che si è connesso più di recente a Cloud Service Mesh.
- A volte potresti vedere una barra rovesciata (\) nel campo ID nodo del file YAML. In questo caso, esegui l'escape della barra rovesciata utilizzando una barra rovesciata aggiuntiva quando esegui una query all'API CSDS per ottenere informazioni di configurazione. Questo è un problema noto.
Passaggi successivi
- Per trovare informazioni generali sulla risoluzione dei problemi di Cloud Service Mesh, consulta Risoluzione dei problemi relativi ai deployment che utilizzano Envoy.
- Per risolvere i problemi di configurazione quando esegui il deployment di servizi gRPC senza proxy, consulta Risoluzione dei problemi di deployment che utilizzano gRPC senza proxy.