apigeectl

Attualmente stai visualizzando la versione 1.2 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.2 (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.

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. Utilizza il flag -c per specificare uno o più componenti (separati da virgole). Se non specifichi il flag -c, il comando apply applica tutti i componenti al cluster. NOTA:devi chiamare il numero apigeectl init prima di chiamare il numero 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. Se non specifichi il flag -c, il comando check-ready si applica a tutti i componenti del cluster.
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. Se non specifichi il flag -c, il comando delete si applica a tutti i componenti di cui è stato eseguito il deployment nel cluster.
help	Guida online di Prints.
init	Applica le configurazioni per i componenti prerequisiti, come Istio e Apigee Deployment, al cluster. Utilizza il flag -c per specificare uno o più componenti (separati da virgole).
version	Visualizza le informazioni sulla versione della CLI.

Flag di apigeectl

La tabella seguente elenca i flag apigeectl:

Flag	Descrizione
-c, --components	Specifica un singolo componente a cui si applica il comando. Se non specifichi questo flag, il comando si applica a tutti i componenti (l'intero deployment) nel cluster. I valori possibili sono: cassandra logger mart metrics runtime synchronizer udca Ad esempio, -c cassandra In alternativa, per specificare più componenti, aggiungi valori separati da virgole: -c cassandra, runtime
--dry-run	Esegue il comando specificato senza modificare il cluster. Utilizza ‑‑print-yaml per generare la specifica dell'oggetto sottoposto a rendering in un file.
‑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.
--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.
-s, --settings	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. (Aggiunto nella versione 1.2.0) 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 -c runtime

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 -c per applicare solo un componente 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 il flag -c, come descritto in Flag apigeectl.

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

apigeectl apply -c synchronizer -f my_overrides.yaml

Il seguente esempio applica la configurazione solo ai componenti Cassandra e runtime:

apigeectl apply -c cassandra,runtime -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 --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
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