apigeectl

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

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

Ambito per l'applicazione di apigeectl

Utilizzando i flag apigeectl puoi controllare gli ambiti a cui viene applicata la regola di configurazione. Per una panoramica degli ambiti all'interno del runtime di runtime ibrido Apigee, consulta la Panoramica della configurazione del servizio di runtime.

Ambito	Componenti	apigeectl flag
Spazio di archiviazione	Cassandra	--datastore
Spazio di archiviazione in memoria	Redis	--redis
Ambiente	Runtime Sincronizzatore UDCA	--all-envs --env
Organization (Organizzazione)	Agente Apigee Connect MART Watcher	--org
Rapporti	Metriche Logger	--telemetry

Sintassi Apigee

apigeectl [command] [flags]

Dove:

• command: specifica l'operazione che vuoi eseguire. Per un elenco completo dei comandi, consulta la sezione Comandi Apigeectl.

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

Comandi Apigeectl

Nella tabella seguente sono elencati i comandi apigeectl:

Comando	Descrizione
apply	Applica le configurazioni per i componenti runtime ibridi di Apigee al tuo cluster Kubernetes. apigeectl apply senza flag applicherà le modifiche a tutti i componenti nel cluster. Flag Apigeect: --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 script automatico, tieni presente che il comando esce con lo stato 0 quando i container sono tutti pronti. Se almeno un pod non è pronto, il comando esce con lo stato 1. Flag Apigeect: -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 (non vengono eliminati i componenti installati con apigeectl init). I componenti specifici di Apigee sono quelli che vengono 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 Apigeect: --all, --all-envs, --datastore, --env, -f, --file-override-config, --help, --org, --redis, --telemetry, --verbose
diagnostic	Richiama il raccoglitore diagnostico, che acquisisce i dati diagnostici sui componenti Kubernetes di un'istanza ibrida Apigee on demand e li archivia nei bucket di archiviazione Google Cloud. L'utilità di raccolta di diagnostica richiede un bucket di archiviazione Google Cloud denominato, un account di servizio con il ruolo Amministratore Storage e una riga diagnostic: aggiunta al tuo file overrides. Vedi: Utilizzo del raccoglitore diagnostico Riferimento proprietà configurazione: diagnostic Quando richiami raccoglitore diagnostico, viene creato uno spazio dei nomi "apigee-diagnostic" di Kubernetes. Devi eliminare l'elemento con apigeectl diagnostic delete prima di richiamare di nuovo il commerciante di diagnostica. Richiama dati diagnostici: apigeectl diagnostic -f OVERRIDES_FILE Elimina commerciante di diagnostica: apigeectl diagnostic delete -f OVERRIDES_FILE Flag Apigeect: --file-override-config
encode	Restituisce un elenco di nomi codificati di tutti i deployment Apigee per l'organizzazione specificata o per l'ambiente specificato all'interno dell'organizzazione specificata. I nomi codificati includono il nome del componente con un nome sottoposto ad hashing dell'organizzazione e, se utilizzi il flag --env, un nome sottoposto ad hashing dell'ambiente. Apigee ibrido crea nomi sottoposti ad hashing delle organizzazioni e degli ambienti per evitare conflitti di 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 Apigeectl: --env, --org
help	Guida online per le stampe.
init	Installa gli operatori Apigee e CRD nello spazio dei nomi del sistema Apigee. Esegui apigeectl init dopo una nuova installazione o upgrade prima di eseguire apigeectl apply. Flag Apigeect: -f, --file-override-config, --help, --verbose
version	Stampa le informazioni sulla versione dell'interfaccia a riga di comando. Bandiera Apigeectl: --help

Flag Apigee Apigee

Nella tabella seguente sono elencati i flag apigeectl:

Flag	Descrizione
--all	Solo delete: elimina l'intera installazione ibrida di Apigee, tranne ASM (Istio) e cert-manager dal cluster.
--all-envs	Applica il comando apigeectl a tutti gli ambienti nell'organizzazione specificata nel file di configurazione degli override.
--datastore	Applica la configurazione all'ambito datastore (Cassandra).
‑‑dry‑run	Esegue il comando specificato senza modificare il cluster. Utilizza con ‑‑print-yaml per generare in un file le specifiche dell'oggetto sottoposto a rendering. ‑‑dry‑run deve essere utilizzato con uno dei due valori seguenti, a seconda della versione di kubectl in esecuzione. Utilizza 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. Il 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 ulteriori informazioni, consulta la sezione Gestire i componenti del piano di runtime.
-h --help	Visualizza la guida per il comando.
--org	Applica la configurazione all'organizzazione specificata. Il 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 in un file.
--redis	Applica la configurazione all'ambito di archiviazione dei dati in memoria (Redis).
--restore	Ripristina Cassandra su uno snapshot salvato in precedenza specificato dalla proprietà snapshotTimestamp nella configurazione di restore del file overrides.yaml. Il backup viene ripristinato dal bucket Cloud Storage o da un server remoto in base alla configurazione backup nel file overrides.yaml. Per scoprire di più, consulta Ripristinare un'area geografica 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 alla proprietà virtualhosts e nient'altro. Ad esempio, se modifichi la configurazione virtualhosts nel file di 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 i log dettagliati in std err.

Il comando apigeectl usa kubectl dietro le quinte per svolgere il suo lavoro. Le opzioni dei comandi apigeectl (apply e delete) e l'utilizzo dei file di configurazione YAML sono simili alle rispettive controparti kubectl. Per saperne di più su come vengono gestiti gli oggetti in un cluster Kubernetes, vedi i seguenti argomenti:

• Gestione imperativa degli oggetti Kubernetes con i file di configurazione
• Panoramica di kubectl

Esempi

Inizializza la configurazione del cluster

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

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

apigeectl apply --datastore -f my_overrides.yaml

Stampare la configurazione su un file

Se stai eseguendo il debug di un problema di installazione, è utile stampare l'intera configurazione del cluster a un file in modo da poter controllare 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 eventuali riferimenti futuri. Tieni però presente che il file di output contiene password e segreti che potresti non voler archiviare.

Controlla lo stato del pod

L'esempio seguente verifica 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 il modello ibrido dal cluster

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

NOTA: per disinstallare correttamente l'app, devi disporre di kubectl 1.11.x o versioni successive.

apigeectl delete -f my_overrides.yaml