apigeectl

Al momento stai visualizzando la versione 1.9 della documentazione di Apigee hybrid. Per saperne di più, consulta Versioni supportate.

Version 1.9 (unsupported)

Versioni supportate:

• v1.12 (più recente)                        
• Versione 1.11                         
• Versione 1.10                                        
• Elenco delle versioni supportate

Versioni non supportate:

• Versione 1.9                                         
• Versione 1.8                                         
• Versione 1.7                                         
• Versione 1.6                                         
• Versione 1.5                                         
• Versione 1.4                                         
• Versione 1.3                                         
• Versione 1.2                                         
• Versione 1.1                                         

apigeectl è un'interfaccia a riga di comando (CLI) per l'installazione e la gestione di Apigee hybrid in un cluster Kubernetes. Per informazioni sul download e sull'installazione di apigeectl, consulta Scaricare e installare apigeectl.

NOTA: per utilizzare il comando apigeectl, devi aver installato e configurato kubectl sulla tua macchina di amministrazione Kubernetes.

Ambiti per l'applicazione di apigeectl

Utilizza i flag apigeectl per controllare a quali ambiti applicare le modifiche alla configurazione del comando. Per una panoramica degli ambiti all'interno del runtime ibrido di Apigee, consulta la panoramica della configurazione del servizio di runtime.

Ambito	Componenti	Flag apigeectl
Spazio di archiviazione	Cassandra	‑‑datastore
Spazio di archiviazione in memoria	Redis	‑‑redis
Ambiente	UDCA Sincronizzatore di runtime	‑‑all‑envs ‑‑env
Organization (Organizzazione)	Agente Apigee Connect MART Watcher	‑‑org
Report	Logger Metriche	‑‑telemetry

Sintassi apigeectl

apigeectl [command] [flags]

Dove:

• command: specifica l'operazione che vuoi eseguire. Per un elenco completo dei comandi, vedi Comandi Apigeectl.

• flags: specifica i parametri del comando. Per un elenco completo dei flag, vedi flag Apigeectl.

Comandi apigeectl

Nella tabella seguente sono elencati i comandi apigeectl:

Comando	Descrizione
apply	Applica le configurazioni per i componenti ibridi di runtime di Apigee al tuo cluster Kubernetes. apigeectl apply senza flag applicherà le modifiche a tutti i componenti nel cluster. Flag Apigeectl: ‑‑all‑envs, ‑‑datastore, ‑‑dry‑run, ‑‑env, ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑org, ‑‑print‑yaml, ‑‑redis, ‑‑settings virtualhosts, ‑‑telemetry, ‑‑v NOTA: dopo una nuova installazione o un upgrade, devi chiamare apigeectl init prima di chiamare apigeectl apply.
check‑ready	Controlla lo stato dei pod dei componenti ibridi. Quando tutti i pod dei componenti sono pronti, viene visualizzato il messaggio "Tutti i container pronti". Per lo scripting automatico, tieni presente che il comando termina con lo stato 0 quando i container sono tutti pronti. Quando almeno un pod non è pronto, il comando viene chiuso con lo stato 1. Flag Apigeectl: ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑v
delete	Elimina i componenti ibridi dal cluster. Usa il flag ‑‑all per rimuovere TUTTI i componenti. Se ometti ‑‑all, vengono rimossi solo i componenti specifici di Apigee (i componenti installati con apigeectl init non vengono eliminati). I componenti specifici di Apigee sono quelli installati con il comando apply. apigeectl delete senza flag facoltativi applica il comando delete a tutti i componenti di cui è stato eseguito il deployment nel cluster. apigeectl diagnostic delete ‑f OVERRIDES_FILE elimina lo spazio dei nomi apigee‑diagnostic creato da apigeectl diagnostic. Il flag ‑f/‑‑file‑override‑config è obbligatorio con apigeectl diagnostic delete flag Apigeectl: ‑‑all, ‑‑all‑envs, ‑‑datastore, ‑‑env, ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑org, ‑‑redis, ‑‑telemetry, ‑‑v Per saperne di più, vedi Disinstallare il runtime ibrido.
diagnostic	Richiama il raccoglitore di diagnostica, che acquisisce i dati diagnostici sui componenti Kubernetes di un'istanza ibrida Apigee on demand e li archivia nei bucket di archiviazione Google Cloud. Il raccoglitore di diagnostica richiede un bucket Google Cloud Storage denominato, un account di servizio con il ruolo Amministratore Storage e una stanza diagnostic: aggiunta al file overrides. Vedi: Utilizzo del raccoglitore Diagnostica Riferimento proprietà di configurazione: diagnostic Quando richiami il raccoglitore diagnostica, viene creato uno spazio dei nomi Kubernetes "apigee‑diagnostic". Devi eliminarlo con apigeectl diagnostic delete prima di richiamare il raccoglitore di diagnostica. Richiama raccoglitore diagnostica: apigeectl diagnostic ‑f OVERRIDES_FILE Elimina raccoglitore diagnostica: apigeectl diagnostic delete ‑f OVERRIDES_FILE Flag Apigeectl: ‑‑file‑override‑config
encode	Restituisce un elenco di nomi codificati di tutti i deployment ApigeeDeployment per l'organizzazione specificata o per l'ambiente specificato all'interno dell'organizzazione specificata. I nomi codificati includono il nome del componente con un nome dell'organizzazione sottoposto ad hashing e, se utilizzi il flag ‑‑env, un nome dell'ambiente sottoposto ad hashing. Apigee hybrid crea nomi sottoposti ad hashing di organizzazioni e ambienti per evitare conflitti dello spazio dei nomi. Devi utilizzare ‑‑org org‑name o entrambi ‑‑org org‑name con i flag ‑‑env env‑name con encode. Ad esempio: ./apigeectl encode ‑‑org hybrid‑example List of ApigeeDeployments are: apigee‑connect‑agent‑hybrid‑example‑6a82f8a apigee‑mart‑hybrid‑example‑6a82f8a apigee‑watcher‑hybrid‑example‑6a82f8a ./apigeectl encode ‑‑org hybrid‑example ‑‑env example‑env List of ApigeeDeployments are: apigee‑runtime‑hybrid‑example‑example‑env‑9e87e2d apigee‑synchronizer‑hybrid‑example‑example‑env‑9e87e2d apigee‑udca‑hybrid‑example‑example‑env‑9e87e2d flag Apigeectl: ‑‑env, ‑‑org
help	Stampa la guida online.
init	Installa operatori e CRD Apigee nello spazio dei nomi apigee‐system. Esegui apigeectl init dopo una nuova installazione o un upgrade prima di eseguire apigeectl apply. Flag Apigeectl: ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑v
version	Stampa le informazioni sulla versione dell'interfaccia a riga di comando. flag Apigeectl: ‑‑help

Flag apigeectl

Nella tabella seguente sono elencati i flag apigeectl:

Flag	Descrizione
‑‑all	Solo delete: elimina l'intera installazione ibrida di Apigee dal cluster, tranne ASM (Istio) e cert-manager.
‑‑all‑envs	Applica il comando apigeectl a tutti gli ambienti all'interno dell'organizzazione specificata nel file di configurazione degli override.
‑‑datastore	Applica la configurazione all'ambito del datastore (Cassandra).
‑‑dry‑run	Esegue il comando specificato senza modificare il cluster. Utilizzalo con ‑‑print‑yaml per estrarre le specifiche dell'oggetto sottoposto a rendering in un file. ‑‑dry‑run deve essere utilizzato con uno dei due valori seguenti, a seconda della versione di kubectl che stai eseguendo. Usa gcloud version per controllare la tua versione di kubectl: kubectl 1.17.x o versioni precedenti: ‑‑dry‑run=true kubectl 1.18.x o versioni successive: ‑‑dry‑run=client
‑‑env env‑name	Applica la configurazione all'ambiente specificato. Questo flag applica la configurazione ai componenti dell'ambito dell'ambiente apigee‐runtime, apigee‐synchronizer e apigee‐udca. ‑‑env deve essere utilizzato con il flag ‑‑org. Ad esempio: apigeectl apply ‑‑org hybrid‑example ‑‑env example‑env \ ‑f overrides/overrides.yaml
‑f ‑‑file‑override‑config	Specifica un file YAML contenente proprietà di configurazione personalizzate per il deployment ibrido. Il valore predefinito è ./overrides.yaml. È necessario un file di override per i comandi apply, check‑ready, delete e init. Devi specificare il percorso completo con questo flag. Per maggiori informazioni, consulta Gestione dei componenti del piano di runtime.
‑h ‑‑help	Visualizza la guida del comando.
‑‑org	Applica la configurazione all'organizzazione specificata. Questo flag applica la configurazione ai componenti dell'ambito dell'organizzazione apigee‐connect‐agent, apigee‐mart e apigee‐watcher. Nota: quando utilizzi ‑‑org con encode, devi includere l'ID organizzazione. Ad esempio: apigeectl encode ‑‑org example‑org
‑‑print‑yaml	Stampa l'output del modello di configurazione su stdout. Per un esempio di utilizzo di questo flag, vedi Stampare la configurazione su un file.
‑‑redis	Applica la configurazione all'ambito di archiviazione dei dati in memoria (Redis).
‑‑restore	Ripristina Cassandra in uno snapshot salvato in precedenza specificato dalla proprietà snapshotTimestamp nella configurazione restore del file overrides.yaml. Il backup viene ripristinato dal bucket Cloud Storage o da un server remoto in base alla configurazione backup nel file overrides.yaml. Per maggiori informazioni, consulta Ripristinare una regione da un backup.
‑s ‑‑settings virtualhosts	Specifica una configurazione a cui si applica il comando. Attualmente questo flag è supportato solo per la configurazione virtualhosts, che fa parte del componente runtime. Utilizza questo flag se apporti modifiche alla proprietà virtualhosts e nient'altro. Ad esempio, se modifichi la configurazione virtualhosts nel file di override, applicala al cluster con questo comando: apigeectl apply ‑f my‑overrides.yaml ‑‑settings virtualhosts \ ‑‑org example‑org ‑‑env example‑env
‑‑telemetry	Applica la configurazione ai componenti di telemetria come apigee-logger e apigee-metrics.
‑‑v int	Stampa log dettagliati su errore std. int è un numero intero che imposta il livello di dettaglio. int è obbligatorio con ‑‑v. Questa opzione si comporta in modo identico all'opzione ‑‑v di kubectl. Nota: questa opzione sostituisce l'opzione ‑‑verbose deprecata.

Il comando apigeectl utilizza kubectl dietro le quinte per svolgere il proprio lavoro. Le opzioni del comando apigeectl (apply e delete, e l'uso di file di configurazione YAML, sono simili alle rispettive controparti kubectl. Per saperne di più su come vengono gestiti gli oggetti in un cluster Kubernetes, consulta i seguenti argomenti:

• Gestione imperativa degli oggetti Kubernetes mediante i file di configurazione
• Panoramica di kubectl

Esempi

Inizializza la configurazione del cluster

Applica le configurazioni dei componenti prerequisiti al cluster con init. Devi eseguire il comando init prima di apply.

apigeectl init ‑f my_overrides.yaml

Applica la configurazione del cluster

Per applicare configurazioni ibride al tuo cluster Kubernetes, utilizza il comando apply. La prima volta che esegui apply, tutti i componenti di runtime ibridi vengono creati nel cluster. Se apporti modifiche alla configurazione, esegui nuovamente apply per applicare solo le modifiche o utilizza i flag per applicare le modifiche solo a un ambito specifico.

L'esempio seguente applica la configurazione per i componenti del piano di runtime ibrido al tuo cluster:

apigeectl apply ‑f my_overrides.yaml

Applicare la configurazione a un singolo componente

Per limitare il comando apply a un particolare componente, utilizza i flag descritti nei flag Apigeectl.

L'esempio seguente applica solo la configurazione per il componente Cassandra:

apigeectl apply ‑‑datastore ‑f my_overrides.yaml

Stampa la configurazione su un file

Se stai eseguendo il debug di un problema di installazione, è utile stampare l'intera configurazione del cluster su un file, in modo da poter esaminare le impostazioni di configurazione. Il flag ‑‑print‑yaml stampa la configurazione ibrida su stdout, mentre il flag ‑‑dry‑run consente l'esecuzione del comando senza apportare modifiche al cluster.

apigeectl apply ‑f my_overrides.yaml ‑‑dry‑run=client ‑‑print‑yaml > apigee‑hybrid.yaml

NOTA: è buona norma salvare una copia dell'output YAML nel controllo del codice sorgente per riferimento futuro. Tieni presente, però, che il file di output contiene password e secret che potresti non voler archiviare.

Controlla lo stato del pod

L'esempio seguente controlla lo stato dei pod di cui è stato eseguito il deployment nel cluster:

apigeectl check‑ready ‑f overrides/overrides.yaml
All containers ready in namespace 'my-namespace'

Elimina l'ibrido dal cluster

Per maggiori dettagli, vedi Disinstallare il runtime ibrido.