apigeectl

Al momento stai visualizzando la versione 1.11 della documentazione di Apigee hybrid. Per ulteriori informazioni, consulta Versioni supportate.

Version 1.11 

   Versioni supportate:

• v1.13 (più recente)                        
• v1.12                         
• v1.11                         
• Elenco delle versioni supportate

Versioni non supportate:

• 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 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.

Nota: devi avere kubectl installato e configurato sulla tua macchina di amministrazione Kubernetes per l'utilizzo del comando apigeectl.

Ambiti per l'applicazione di apigeectl

Utilizzando i flag apigeectl, puoi controllare gli ambiti a cui il comando applica le modifiche alla configurazione. Per una panoramica degli ambiti all'interno del runtime Apigee hybrid, consulta la Panoramica della configurazione dei servizi di runtime.

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

Sintassi di apigeectl

apigeectl [command] [flags]

Dove:

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

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

Comandi apigeectl

Nella tabella seguente sono elencati i comandi apigeectl:

Comando	Descrizione
apply	Applica le configurazioni per i componenti di runtime di Apigee hybrid al tuo cluster Kubernetes. apigeectl apply senza flag applicherà le modifiche a tutti i componenti nel cluster. Flag Apigee: ‑‑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 di componenti ibride. Quando tutti i pod dei componenti sono pronti, viene visualizzato il messaggio "Tutti i container pronti". Per lo scripting automatico, nota che il comando si chiude con uno stato pari a 0 quando i container sono pronti. Se almeno un pod non è pronto, il comando esce con uno stato pari a 1. Flag Apigee: ‑f, ‑‑file‑override‑config, ‑‑help e ‑‑v
delete	Avviso: L'utilizzo del comando apigeectl delete con il flag ‑‑all (ad es. apigeectl delete ‑‑all -f overrides.yaml) comporta anche l'eliminazione dei dati di backup per tutti gli snapshot dei volumi CSI. 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 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 apigeectl diagnostic. La ‑f / Il flag ‑‑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 maggiori informazioni, vedi Disinstallare il runtime ibrido.
diagnostic	Richiama il raccoglitore diagnostico, che acquisisce i dati diagnostici su Kubernetes di un'istanza ibrida Apigee on demand e li archivia in Google Cloud Storage bucket. Il raccoglitore di diagnostica richiede un bucket Google Cloud Storage denominato, un account di servizio con il ruolo Storage Admin e una stanza diagnostic: aggiunta overrides file. Vedi: Utilizzo della diagnostica raccoglitore Riferimento per le proprietà di configurazione: diagnostic Quando richiami il raccoglitore di dati diagnostici, viene creato uno spazio dei nomi Kubernetes "apigee‑diagnostic". Devi eliminare questo elemento con apigeectl diagnostic delete prima di richiamare di nuovo il raccoglitore diagnostico. Richiama raccoglitore diagnostica: apigeectl diagnostic ‑f OVERRIDES_FILE Elimina raccoglitore di diagnostica: apigeectl diagnostic delete ‑f OVERRIDES_FILE Flag Apigee: ‑‑file‑override‑config
encode	Restituisce un elenco di nomi codificati di tutti gli ApigeeDeployment per l'organizzazione o l'ambiente specificato all'interno dell'organizzazione specificata. I nomi codificati includi il nome del componente con il nome dell'organizzazione sottoposto ad hashing e, se utilizzi ‑‑env, un nome 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 con ‑‑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 Apigee e CRD nello spazio dei nomi apigee‐system. Esegui apigeectl init dopo una nuova installazione o un upgrade prima di eseguire apigeectl apply. Flag Apigee: ‑f, ‑‑file‑override‑config, ‑‑help e ‑‑v
version	Stampa le informazioni sulla versione della CLI. flag Apigee: ‑‑help

Flag apigeectl

La tabella seguente elenca i flag apigeectl:

Bandiera	Descrizione
‑‑all	Avviso: L'utilizzo del comando apigeectl delete con il flag ‑‑all (ad es. apigeectl delete ‑‑all -f overrides.yaml) comporta anche l'eliminazione dei dati di backup per tutti gli snapshot dei volumi CSI. Solo delete: elimina l'intera installazione ibrida di Apigee, ad eccezione di ASM (Istio) e cert-manager, dal cluster.
‑‑all‑envs	Applica il comando apigeectl a tutti gli ambienti dell'organizzazione specificati nel file di configurazione delle sostituzioni.
‑‑datastore	Applica la configurazione all'ambito del datastore (Cassandra).
‑‑dry‑run	Esegue il comando specificato senza modificare il cluster. Da utilizzare con ‑‑print‑yaml per inviare la specifica dell'oggetto di cui è stato eseguito il rendering in un file. ‑‑dry‑run deve essere utilizzato con uno dei due valori riportati di seguito, a seconda della versione di kubectl in esecuzione. Usa gcloud version per controllare la versione di kubectl: kubectl versione 1.17.x o precedente: ‑‑dry‑run=true kubectl versione 1.18.x o successiva: ‑‑dry‑run=client
‑‑env env‑name	Applica la configurazione all'ambiente specificato. Questo flag applicherà la configurazione ai componenti apigee-runtime, apigee-synchronizer e apigee-udca a livello di ambito dell'ambiente. ‑‑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 delle proprietà di configurazione per il deployment ibrido. Il valore predefinito è ./overrides.yaml. È richiesto un file di override per apply, Comandi 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.
‑‑org	Applica la configurazione all'organizzazione specificata. Questo flag applicherà la configurazione ai componenti apigee‑connect‑agent, apigee‑mart e apigee‑watcher a livello di ambito dell'organizzazione. 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 Stampare la configurazione su un file.
‑‑redis	Applica la configurazione all'ambito dell'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 un server remoto in base alla configurazione backup in il file overrides.yaml. Per ulteriori informazioni, consulta Ripristinare 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 alle virtualhosts proprietà e niente diverso. 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 \ ‑‑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 in stderr. int è un numero intero che imposta il livello di dettaglio. È obbligatorio specificare int con ‑‑v. Questa opzione si comporta in modo identico all'opzione kubectl ‑‑v. Nota: questa opzione sostituisce l'opzione ‑‑verbose ritirata.

Il comando apigeectl usa kubectl per eseguire questa operazione il suo funzionamento. Le opzioni del comando apigeectl (apply e delete, e l'uso dei file di configurazione YAML, sono simili alle loro controparti kubectl. Per scoprire di più su come vengono gestiti gli oggetti in un cluster Kubernetes, consulta i seguenti argomenti:

• Gestione imperativa degli oggetti Kubernetes tramite 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 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 tutte le vengono creati componenti runtime ibridi nel cluster. Se apporti modifiche alla configurazione, esegui nuovamente apply per applicare solo le modifiche o utilizzare i flag per applicare modifiche a una specifica solo nell'ambito.

Nell'esempio seguente viene applicata la configurazione per il piano di runtime ibrido componenti per il tuo cluster:

apigeectl apply ‑f my_overrides.yaml

Applicare la configurazione per un singolo componente

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

Nell'esempio seguente viene applicata 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 in un file in modo da poter ispezionare le impostazioni di configurazione. La bandiera ‑‑print‑yaml viene stampata la configurazione ibrida a stdout e il flag ‑‑dry‑run consente senza dover apportare modifiche al cluster.

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

Nota: è buona norma salvare una copia dei l'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 memorizzare.

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

Per maggiori dettagli, vedi Disinstallare il runtime di hybrid.