apigeectl

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 l'installazione di apigeectl, vedi Scaricare e installare apigeectl.

Sintassi apigeectl

apigeectl [command] [flags]

Dove:

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

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

Comandi apigeectl

Nella tabella seguente sono elencati i comandi apigeectl:

Comando Descrizione
apply

Applica configurazioni per i componenti di runtime ibridi di Apigee al tuo cluster Kubenetes. 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.

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 si chiude con uno stato 0 quando i container sono tutti pronti. Quando almeno un pod non è pronto, il comando si chiude 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 i componenti 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 Stampa la guida online.
init

Applica al cluster le configurazioni per i componenti dei prerequisiti, come Istio e Apigee Deployment. Utilizza il flag -c per specificare uno o più componenti (separati da virgole).

version Stampa le informazioni sulla versione dell'interfaccia a riga di comando.

Flag apigeectl

Nella tabella seguente sono elencati 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. Utilizzalo con ‑‑print-yaml per inviare la specifica dell'oggetto di cui è stato eseguito il 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. È richiesto 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 per il comando.
--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.
-s, --settings

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 solo alla proprietà virtualhosts. (Aggiunta la versione 1.2.0)

Ad esempio, se apporti una modifica alla configurazione virtualhosts nel file degli override, applicala al cluster con questo comando:

apigeectl apply -f my-overrides.yaml --settings virtualhosts -c runtime

Esempi

Inizializzare la configurazione del cluster

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

apigeectl init -f my_overrides.yaml

Applica la configurazione del cluster

Per applicare configurazioni ibride al 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 -c per applicare solo un componente 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 il flag -c, come descritto nei flag Apigee.

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

apigeectl apply -c synchronizer -f my_overrides.yaml

L'esempio seguente applica solo la configurazione per i componenti Cassandra e di runtime:

apigeectl apply -c cassandra,runtime -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 e il flag --dry-run consente l'esecuzione del comando senza apportare modifiche al cluster.

apigeectl apply -f my_overrides.yaml --dry-run --print-yaml > apigee-hybrid.yaml

Controlla lo stato del pod

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

apigeectl check-ready
All containers ready in namespace 'my-namespace'

Elimina ibrido dal cluster

L'esempio seguente elimina solo i componenti di runtime ibridi nel cluster Kubernetes. Per eliminare tutti i dati, usa il flag --all.

apigeectl delete -f my_overrides.yaml