apigeectl

Stai visualizzando la versione 1.6 della documentazione di Apigee hybrid. This version is end of life. You should upgrade to a newer version. Per maggiori informazioni, vedi Versioni supportate.

Version 1.6 (unsupported)

Versioni supportate:

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

Versioni non supportate:

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

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

Ambiti per l'applicazione di apigeectl

Utilizzando i flag apigeectl puoi stabilire a quali ambiti il comando applica le modifiche alla configurazione. Per una panoramica degli ambiti all'interno del runtime di Apigee hybrid consulta la panoramica della configurazione del servizio di runtime.

Ambito	Componenti	apigeectl flag
Spazio di archiviazione	Cassandra	--datastore
Archiviazione in memoria	Redis	--redis
Ambiente	Runtime Sincronizzatore UDCA	--all-envs --env
Organization (Organizzazione)	Osservatore dell'agente Apigee Connect MART	--org
Report	Metriche Logger	--telemetry

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 le configurazioni per i componenti di runtime ibridi di Apigee al tuo cluster Kubernetes. apigeectl apply senza flag applicherà le modifiche a tutti i componenti del cluster. Flag Apigeectl: --all-envs, --datastore, --dry-run, --env, -f, --file-override-config, --help, --org, --print-yaml, --redis, --settings virtualhosts, --telemetry,--verbose 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 "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. Flag Apigee: -f, --file-override-config, --help, --verbose
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. 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, --verbose
diagnostic	Consente di richiamare il raccoglitore diagnostico, che acquisisce on demand i dati diagnostici sui componenti Kubernetes di un'istanza ibrida Apigee e li archivia nei bucket di archiviazione di Google Cloud. 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 al tuo file overrides. Vedi: Utilizzo del raccoglitore di diagnostica Riferimento della proprietà di configurazione: diagnostic Quando richiami il raccoglitore diagnostico, viene creato uno spazio dei nomi Kubernetes "apigee-diagnostic". Devi eliminarlo con apigeectl diagnostic delete prima di richiamare di nuovo il raccoglitore di diagnostica. 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 i deployment Apigee per l'organizzazione specificata o l'ambiente specificato all'interno dell'organizzazione specificata. I nomi codificati includono il nome del componente con un nome hash dell'organizzazione e, se utilizzi il flag --env, un nome hash dell'ambiente. Apigee hybrid crea nomi con hash di organizzazioni e ambienti per evitare collisioni degli spazi dei nomi. Devi utilizzare --org org-name o entrambi --org org-name con i flag --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 Apigee: --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, --verbose
version	Stampa le informazioni sulla versione dell'interfaccia a riga di comando. flag Apigee: --help

Flag apigeectl

Nella tabella seguente sono elencati i flag apigeectl:

Flag	Descrizione
--all	Solo delete: elimina l'intera installazione ibrida di Apigee dal cluster ad eccezione di ASM (Istio) e cert-manager.
--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. Utilizzalo 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 seguenti, a seconda della versione di kubectl in esecuzione. Usa gcloud version per controllare la tua 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 dell'ambito dell'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. È 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.
--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 di utilizzo di questo flag, vedi Stampare la configurazione su un file.
--redis	Applica la configurazione all'ambito dell'archiviazione dei dati in memoria (Redis).
--restore	(Introdotta nella versione 1.6.6) 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 da un server remoto in base alla configurazione di backup nel file overrides.yaml. Per maggiori informazioni, consulta Ripristinare una regione da un backup.
-s ‑‑settings virtualhosts	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. 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 \ --org example-org --env example-env
--telemetry	Applica la configurazione per i componenti di telemetria come apigee-logger e apigee-metrics.
--verbose	Stampa log dettagliati in std err.

Il comando apigeectl utilizza kubectl dietro le quinte per svolgere il proprio lavoro. Le opzioni del comando apigeectl (apply e delete e l'utilizzo di file di configurazione YAML, sono simili alle loro 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 tramite i file di configurazione
• Panoramica di kubectl

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 i flag per applicare le modifiche solo a un ambito 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 i flag descritti in flag Apigee.

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 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=client --print-yaml > apigee-hybrid.yaml

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

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 -f overrides/overrides.yaml
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.

NOTA: per eseguire correttamente la disinstallazione, devi avere kubectl versione 1.11.x o successiva installata.

apigeectl delete -f my_overrides.yaml