apigeectl

Attualmente stai visualizzando la versione 1.8 della documentazione di Apigee hybrid. This version is end of life. You should upgrade to a newer version. Per ulteriori informazioni, consulta Versioni supportate.

Version 1.8 (unsupported)

   Supported versions:

• v1.15 (latest)                        
• v1.14                        
• v1.13                         
• List of supported versions

   Unsupported versions:

• v1.12                         
• v1.11                         
• v1.10                                      
• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

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

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

Ambiti per l'applicazione apigeectl

Utilizzando i flag apigeectl, controlli gli ambiti a cui il comando applica le modifiche alla configurazione. Per una panoramica degli ambiti all'interno del runtime di Apigee hybrid, consulta la panoramica configurazione del servizio di runtime.

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

Sintassi di apigeectl

apigeectl [command] [flags]

Dove:

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

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

Comandi apigeectl

La tabella seguente elenca i comandi apigeectl:

Comando	Descrizione
apply	Applica le configurazioni per i componenti runtime di Apigee hybrid 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 "All containers ready" (Tutti i container sono pronti). Per gli script automatizzati, tieni presente che il comando viene chiuso con lo stato 0 quando i container sono tutti pronti. Quando è presente 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. Utilizza 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
diagnostic	Richiama il raccoglitore di diagnostica, che acquisisce i dati di diagnostica sui componenti Kubernetes di un'istanza ibrida Apigee on demand e li archivia nei bucket Google Cloud Storage. Diagnostic Collector richiede un bucket di archiviazione Google Cloud denominato, un account di servizio con il ruolo Amministratore archiviazione e una sezione diagnostic: aggiunta al file overrides. Vedi: Utilizzo del raccoglitore Diagnostic Riferimento per le proprietà di configurazione: diagnostic Quando richiami Diagnostic Collector, viene creato uno spazio dei nomi Kubernetes "apigee‑diagnostic". Devi eliminarlo con apigeectl diagnostic delete prima di richiamare di nuovo Diagnostic Collector. Richiama il raccoglitore Diagnostic: apigeectl diagnostic ‑f OVERRIDES_FILE Elimina il raccoglitore Diagnostic: apigeectl diagnostic delete ‑f OVERRIDES_FILE Flag apigeectl: ‑‑file‑override‑config
encode	Restituisce un elenco di nomi codificati di tutti gli ApigeeDeployments per l'organizzazione specificata o l'ambiente specificato all'interno dell'organizzazione specificata. I nomi codificati includono il nome del componente con un nome con hash dell'organizzazione e, se utilizzi il flag ‑‑env, un nome con hash dell'ambiente. Apigee Hybrid crea nomi sottoposti ad hashing di organizzazioni e ambienti per evitare conflitti di spazi dei nomi. Devi utilizzare ‑‑org org‑name o entrambi i flag ‑‑org org‑name e ‑‑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	Guida online di Prints.
init	Installa gli operatori e le CRD di 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	Visualizza le informazioni sulla versione della CLI. Flag apigeectl: ‑‑help

Flag di apigeectl

La tabella seguente elenca i flag apigeectl:

Flag	Descrizione
‑‑all	Solo delete: elimina l'intera installazione di Apigee Hybrid, ad eccezione di ASM (Istio) e cert-manager dal cluster.
‑‑all‑envs	Applica il comando apigeectl a tutti gli ambienti 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. Utilizza con ‑‑print‑yaml per generare la specifica 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 in esecuzione. Utilizza gcloud version per controllare la versione di kubectl: kubectl versione 1.17.x o precedente: ‑‑dry‑run=true kubectl versione 1.18.x o successive: ‑‑dry‑run=client
‑‑env env‑name	Applica la configurazione all'ambiente specificato. Questo flag applicherà la configurazione ai componenti con ambito 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 saperne di più, consulta Gestione dei componenti del piano di runtime.
‑h ‑‑help	Visualizza la guida per il comando.
‑‑org	Applica la configurazione all'organizzazione specificata. Questo flag applicherà 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 che utilizza questo flag, vedi Stampa la configurazione in un file.
‑‑redis	Applica la configurazione all'ambito di archiviazione dei dati in memoria (Redis).
‑‑restore	Ripristina Cassandra a 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 ulteriori informazioni, vedi Ripristino di una regione da un backup.
‑s ‑‑settings virtualhosts	Specifica una configurazione a cui si applica il comando. Al momento, 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 apporti una modifica alla 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 per i componenti di telemetria come apigee‑logger e apigee‑metrics.
‑‑v int	Stampa i log dettagliati su std err. int è un numero intero che imposta il livello di verbosità. int è obbligatorio con ‑‑v. Questa opzione si comporta in modo identico all'opzione kubectl ‑‑v. Nota:questa opzione sostituisce l'opzione ‑‑verbose ritirata.

Il comando apigeectl utilizza kubectl in background per svolgere il suo lavoro. Le opzioni del comando apigeectl (apply e delete) e l'utilizzo dei file di configurazione YAML sono simili alle 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 utilizzando i file di configurazione
• Panoramica di kubectl

Esempi

Inizializza la configurazione del cluster

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

apigeectl init ‑f my_overrides.yaml

Applica la configurazione del cluster

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

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

apigeectl apply ‑f my_overrides.yaml

Applica la configurazione per un singolo componente

Per limitare il comando apply a un componente specifico, utilizza i flag descritti in flag apigeectl.

Il seguente esempio applica solo la configurazione per il componente Cassandra:

apigeectl apply ‑‑datastore ‑f my_overrides.yaml

Stampa la configurazione in un file

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

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

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

Controllare lo stato del pod

Il seguente esempio 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

L'esempio seguente elimina solo i componenti di runtime ibrido dal tuo cluster Kubernetes. Per eliminare tutti i dati, utilizza il flag ‑‑all.

NOTA: per disinstallare correttamente, devi aver installato kubectl versione 1.11.x o successive.

apigeectl delete ‑f my_overrides.yaml