apigeectl

apigeectl è un'interfaccia a riga di comando (CLI) per l'installazione e la gestione di Apigee Hybrid in un cluster Kubernetes. Per informazioni su come scaricare e installare apigeectl, consulta Scaricare e installare apigeectl.

Sintassi di apigeectl

apigeectl [command] [flags]

Dove:

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

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

Comandi apigeectl

La tabella seguente elenca i comandi apigeectl:

Comando Descrizione
apply

Applica le configurazioni per i componenti del 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.
check‑ready

Controlla lo stato dei pod di componenti ibride. Quando tutti i pod dei componenti sono pronti, viene visualizzato il messaggio "Tutti i container pronti". Per gli script automatici, tieni presente che il comando esce con uno stato pari a 0 quando tutti i contenitori sono pronti. Se almeno un pod non è pronto, il comando esce con uno stato pari a 1.

Se non specifichi il flag -c, il comando check-ready si applica a tutti i componenti del cluster.
delete

Consente di eliminare i componenti ibride 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 Stampe.
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 Stampa le informazioni sulla versione della CLI.

Flag apigeectl

La tabella seguente elenca i flag apigeectl:

Bandiera 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) del 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. Da utilizzare con ‑‑print-yaml per generare la specifica dell'oggetto visualizzato 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 la pagina relativa alla 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, consulta Stampare 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 a nessun'altra. (Aggiunta nella versione 1.2.0)

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

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

Esempi

Inizializza la configurazione del cluster

Applica le configurazioni dei componenti prerequisiti al tuo 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 tuo cluster Kubernetes, utilizza il comando apply. La prima volta che esegui apply, tutti i componenti di runtime ibrida 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 ibrida al cluster:

apigeectl apply -f my_overrides.yaml

Applicare la configurazione per un singolo componente

Per limitare il comando apply a un determinato componente, utilizza il flag -c, come descritto in flag apigeectl.

Il seguente esempio applica la configurazione solo al componente Synchronizer:

apigeectl apply -c synchronizer -f my_overrides.yaml

L'esempio seguente applica la configurazione solo ai componenti Cassandra e di 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 in modo da poter ispezionare le impostazioni di configurazione. Il flag --print-yaml stampa la configurazione ibrida su stdout e il flag --dry-run consente di eseguire il comando senza apportare modifiche al cluster.

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

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'istanza ibrida dal cluster

L'esempio seguente elimina solo i componenti di runtime ibrida nel cluster Kubernetes. Per eliminare tutto, utilizza il flag --all.

apigeectl delete -f my_overrides.yaml