Riferimento asmcli

Panoramica

asmcli è uno strumento fornito da Google che puoi utilizzare per installare o eseguire l'upgrade di Cloud Service Mesh. Se lo consenti, asmcli configurerà il progetto e il cluster nel seguente modo:

  • Ti concede le autorizzazioni IAM (Gestione di identità e accessi) necessarie per il tuo progetto Google Cloud.
  • Abilita le API Google richieste nel tuo progetto Google Cloud.
  • Imposta un'etichetta sul cluster che identifichi il mesh.
  • Creare un account di servizio che consenta ai componenti del piano dati di eseguire il piano dati, come proxy sidecar, puoi accedere in modo sicuro ai dati e alle risorse del progetto.
  • Registra il cluster al parco risorse, se non è già registrato.

Basta includere il flag --enable_all quando esegui asmcli per consentire la configurazione del progetto e del cluster. Per ulteriori informazioni sulle opzioni e sui flag asmcli, consulta la documentazione di riferimento di asmcli.

Successivamente, asmcli configura i file YAML con le informazioni sul tuo progetto e sul tuo cluster. Questi file di configurazione sono necessari per installare il control plane di Cloud Service Mesh.

Se non hai mai utilizzato Cloud Service Mesh e Istio, passa direttamente al Piattaforme supportate. La sezione successiva è intesa per aiutare a eseguire l'upgrade a 1.23di Cloud Service Mesh esistente.

Transizione a asmcli in corso...

asmcli sostituisce istioctl install e install_asm. Sebbene puoi continuare a utilizzare gli strumenti legacy in Cloud Service Mesh 1.11, ritireremo e non saranno più supportati in Cloud Service Mesh 1.12 e versioni successive. Aggiorna gli script e gli strumenti per utilizzare asmcli.

Tutti i cluster devono essere registrati in un parco risorse. Per maggiori dettagli, consulta i Requisiti del parco veicoli.

Transizione da install_asm

Se conosci install_asm, asmcli è simile, ma presenta le seguenti differenze sostanziali:

  • Utilizzi asmcli install per nuove installazioni e upgrade. Non esiste un Opzione --mode come con install_asm. Quando esegui asmcli install, controlla se esiste già un piano di controllo sul cluster. Se non esiste una dal piano di controllo, asmcli installa Cloud Service Mesh. Se il cluster ha un piano di controllo esistente (un piano di controllo Cloud Service Mesh o un piano di controllo Istio):

  • La maggior parte delle opzioni e dei flag di asmcli si comporta come quelle di install_asm.

Transizione da istioctl install

Se hai dimestichezza con istioctl install e di solito passi un IstioOperator file YAML tramite l'argomento della riga di comando -f per configurare il piano di controllo, puoi passare il file a asmcli utilizzando l'opzione --custom_overlay. Nella documentazione di Cloud Service Mesh, utilizziamo questi file come file di overlay.

Piattaforme supportate

Le installazioni di Cloud Service Mesh nell'elenco delle piattaforme supportate possono essere configurate o sottoposte ad upgrade entro il giorno asmcli.

Tuttavia, non tutte le funzionalità sono disponibili sulle piattaforme esterne a Google Cloud. Per maggiori dettagli, vedi Funzionalità supportate dal piano di controllo in-cluster.

Riferimento asmcli

Questa sezione descrive gli argomenti disponibili per asmcli.

Opzioni

Identifica il cluster Per identificare il cluster, hai a disposizione le seguenti opzioni:

Solo GKE

-p|--project_id CLUSTER_PROJECT_ID
L'ID progetto in cui è stato creato il cluster.
-n|--cluster_name CLUSTER_NAME
Il nome del cluster.
-l|--cluster_location CLUSTER_LOCATION
La zona (per i cluster a zona singola) o la regione (per i cluster regionali) in cui è stato creato il cluster.

Tutte le piattaforme

--kubeconfig KUBECONFIG_FILE Il percorso completo del file kubeconfig. La variabile di ambiente $PWD non funziona qui.

--ctx|--context KUBE_CONTEXT Il contesto kubeconfig da utilizzare. Se non specificato, asmcli utilizza il contesto predefinito.

-c|--ca {mesh_ca|gcp_cas|citadel}

L'autorità di certificazione (CA) da utilizzare per gestire i certificati TLS reciproci. Specifica mesh_ca per utilizzare l'autorità di certificazione Cloud Service Mesh, gcp_cas per utilizzare Certificate Authority Service o citadel per utilizzare l'autorità di certificazione Istio. Cloud Service Mesh gestito non supporta Istio CA. Per ulteriori informazioni, consulta quanto segue:

--channel CLOUD_SERVICE_MESH_CHANNEL

Utilizza --channel con una specifica Canale di rilascio di Cloud Service Mesh per eseguire il provisioning della revisione del piano di controllo associata a quel canale di rilascio. Ad esempio, --channel rapid, --channel regular e --channel stable. Questo flag è obbligatorio per la configurazione di determinate funzionalità di Cloud Service Mesh sui cluster GKE Autopilot.

L'opzione --channel non è più supportata per Managed Cloud Service Mesh come menzionate nelle note di rilascio di CSM. Il canale di rilascio viene determinato in base al canale di rilascio del cluster GKE. Per saperne di più, consulta Canali di rilascio di Cloud Service Mesh gestito.

--co|--custom_overlay OVERLAY_FILE
Utilizza --custom_overly con il nome di un file YAML (chiamato file overlay) contenente la risorsa personalizzata IstioOperator per configurare il piano di controllo in cluster. Puoi specificare un file di overlay su attivare una funzionalità che non è abilitato per impostazione predefinita. Cloud Service Mesh gestito non supporta l'API IstioOperator, pertanto non puoi utilizzare --custom_overlay per configurare il control plane gestito. asmcli deve essere in grado di individuare il file overlay, quindi deve trovarsi nella stessa directory di asmcli o puoi specificare un percorso relativo. Per aggiungere più file, specifica--co|--custom_overlay e il nome del file, ad esempio:--co overlay_file1.yaml --co overlay_file2.yaml --co overlay_file3.yaml
--hub-registration-extra-flags HUB_REGISTRATION_EXTRA_FLAGS
Se utilizzi cluster Amazon EKS collegati, usa --hub-registration-extra-flags per registrare il cluster nel parco risorse, se non è già registrato.
-k|--key_file FILE_PATH
Il file della chiave di un account di servizio. Ometti questa opzione se non utilizzi un account di servizio.
--network_id NETWORK_ID
Utilizza --network_id per impostare l'etichetta topology.istio.io/network applicata allo spazio dei nomi istio-system. Per GKE, --network_id è impostato per impostazione predefinita sul nome della rete del cluster. Per gli altri ambienti, verrà utilizzato default.
-o|--option OVERLAY_FILE

Il nome del file di overlay (senza l'estensione .yaml) che asmcli scarica da repository anthos-service-mesh per abilitare funzionalità facoltativa. È necessaria una connessione a internet per poter usare --option. Le opzioni --option e --custom_overlay sono simili, ma hanno un comportamento leggermente diverso:

  • Utilizza --custom_overlay quando devi modificare le impostazioni nel file overlay.

  • Utilizza --option per attivare una funzionalità che non richiede modifiche al file di overlay, ad esempio per configurare i criteri di audit per i tuoi servizi.

Per aggiungere più file, specifica -o|--option e i nome file, ad esempio: -o option_file1 -o option_file2 -o option_file3

-D|--output_dir DIR_PATH

Se non specificato, asmcli crea una directory temporanea in cui scarica i file e le configurazioni necessari per installare Cloud Service Mesh. Specifica il flag --output-dir per specificare un percorso relativo di una directory da utilizzare . Al termine, la directory specificata contiene i asm e nelle sottodirectory istio-1.23.2-asm.2. La directory asm contiene la configurazione per l'installazione. La La directory istio-1.23.2-asm.2 contiene i contenuti estratti di contenente istioctl, esempi e manifest. Se specificare --output-dir e la directory contiene già file, asmcli utilizza questi file anziché scaricarli di nuovo.

--platform PLATFORM {gcp|multicloud}

La piattaforma o il provider del cluster Kubernetes. Il valore predefinito è gcp (per i cluster GKE). Per tutte le altre piattaforme, multicloud.

-r|--revision_name REVISION NAME

Un'etichetta di revisione è una coppia chiave-valore che è impostata sul piano di controllo. La chiave dell'etichetta di revisione è sempre istio.io/rev. Per impostazione predefinita, asmcli imposta il valore per l'etichetta della revisione in base alla versione di Cloud Service Mesh, ad esempio asm-1232-2. Includi questa opzione se vuoi sostituire il valore predefinito e specificare il tuo. L'argomento REVISION NAME deve essere una etichetta DNS-1035. Ciò significa che il nome deve:

  • Deve contenere al massimo 63 caratteri
  • Deve contenere solo caratteri alfanumerici minuscoli o il trattino "-".
  • iniziano con un carattere alfabetico
  • terminare con un carattere alfanumerico

La regex utilizzata per la convalida è: '[a-z]([-a-z0-9]*[a-z0-9])?'

-s|--service_account ACCOUNT
Il nome di un account di servizio utilizzato per installare Cloud Service Mesh. In caso contrario specificato, l'account utente attivo nell'attuale configurazione di gcloud è in uso. Se devi modificare l'account utente attivo, esegui gcloud auth login.

Opzioni per il certificato personalizzato CA Istio

Se hai specificato --ca citadel e utilizzi una CA personalizzata, includi le seguenti opzioni:

  • --ca_cert FILE_PATH: il certificato intermedio
  • --ca_key FILE_PATH: la chiave per il certificato intermedio
  • --root_cert FILE_PATH: il certificato radice
  • --cert_chain FILE_PATH: la catena di certificati

Per ulteriori informazioni, vedi Collegamento dei certificati CA esistenti.

Flag di attivazione

I flag che iniziano con --enable consentono a asmcli di attivare la richiesta Google API autorizzazioni IAM (Identity and Access Management) richieste, e aggiornare il cluster. Se preferisci, aggiornare progetto e cluster autonomamente prima di eseguire asmcli. Tutti gli indicatori di attivazione non sono compatibili con asmcli validate. Se specifichi un flag di abilitazione quando esegui asmcli validate, il comando termina con un errore.

-e|--enable_all
Consenti a asmcli di eseguire tutte le singole azioni di attivazione descritte qui sotto.
--enable_cluster_roles
Consenti a asmcli di tentare di associare l'account utente o di servizio Google Cloud che esegue asmcli al ruolo cluster-admin nel tuo cluster. asmcli determina l'account utente dal comando gcloud config get core/account. Se esegui asmcli localmente con un account utente, assicurati di chiamare il comando gcloud auth login prima di eseguire asmcli. Se devi modificare l'account utente, esegui il comando gcloud config set core/account GCP_EMAIL_ADDRESS dove GCP_EMAIL_ADDRESS è l'account che utilizzi per accedere a Google Cloud.
--enable_cluster_labels
Consenti l'impostazione obbligatoria di asmcli etichette del cluster.
--enable_gcp_components

Consenti a asmcli di attivare i seguenti componenti e servizi gestiti Google Cloud obbligatori:

--enable_gcp_apis

Consenti a asmcli di attivare tutte le API di Google richieste.

--enable_gcp_iam_roles

Consenti a asmcli di impostare il campo obbligatorio Autorizzazioni IAM.

--enable_meshconfig_init

Consenti allo script di inizializzare l'endpoint meshconfig per tuo conto. Sottinteso da --enable_gcp_components e --managed.

--enable_namespace_creation

Consenti a asmcli di creare lo spazio dei nomi principale istio-system.

--enable_registration

Consenti a asmcli di registrare il cluster nel progetto a cui appartiene il cluster in. Se non includi questo flag, segui la procedura descritta in Registrazione di un cluster per registrare manualmente il cluster. Tieni presente che, a differenza degli altri flag di abilitazione, --enable_registration è incluso in --enable_all solo se specifichi un'opzione (ad esempio --option hub-meshca) che richiede la registrazione del cluster. In caso contrario, dovrai specificare questo flag separatamente.

Altri flag

--dry_run
Stampa i comandi, ma non eseguirli.
--fleet_id
Registra un cluster in un parco risorse utilizzando l'ID progetto host del parco risorse. Questo flag è per i cluster non Google Cloud. Se non viene fornito per i cluster Google Cloud, viene utilizzato per impostazione predefinita l'ID progetto del cluster. Puoi eseguire asmcli install insieme a --fleet_id prima dell'installazione o come parte dell'installazione passando i flag --enable-registration e --fleet-id. Questa impostazione non può essere modificata dopo la configurazione.
--managed
Obsoleta. Esegui il provisioning di un piano di controllo gestito e remoto anziché installarne uno in-cluster.
--offline
Esegui un'installazione offline utilizzando il pacchetto prescaricato nella directory di output. Se la directory non è specificata o non contiene i file richiesti, lo script verrà chiuso con un errore.
--only_enable
Esegui i passaggi specificati per configurare l'utente/cluster attuale, ma non installare qualsiasi cosa.
--only_validate
Esegui la convalida, ma non aggiornare il progetto o il cluster e non installare Cloud Service Mesh. Questo flag non è compatibile con i flag di attivazione. asmcli termina con un errore se specifichi --only_validate con un flag di abilitazione.
--print_config
Anche se non installi Cloud Service Mesh, stampa tutto il codice YAML compilato nell'output standard (stdout). Tutto l'altro output viene scritto nell'errore standard (stderr), anche se normalmente andrebbe in stdout. asmcli ignora tutte le verifiche e la configurazione quando specifichi questo flag.
--disable_canonical_service
Per impostazione predefinita, asmcli esegue il deployment Controller del servizio canonico nel cluster. Se non vuoi che asmcli esegua il deployment del controller, specificare --disable_canonical_service. Per ulteriori informazioni, consulta Attivazione e disattivazione del controller del servizio canonico.
-h|--help
Mostra un messaggio della guida che descrive le opzioni, i flag e l'uscita.
--use_managed_cni
Utilizza il CNI gestito. Se questo flag è non superato, asmcli applicherà i manifest CNI statici.
--use_vpcsc
Se la tua organizzazione applica i Controlli di servizio VPC per il tuo progetto, devi configurare Cloud Service Mesh gestito con il flag --use_vpcsc. In caso contrario, l'installazione non supererà i controlli di sicurezza.
-v|--verbose
Man mano che asmcli viene eseguito, stampa il comando che eseguirà successivamente. Con il --verbose flag, asmcli stampa il comando anche dopo l'esecuzione.
--version
Stampa la versione di asmcli ed esci. Se non hai l'impostazione più recente version, puoi eseguire scarica la versione più recente di asmcli_1.23.