apigeectl

Al momento stai visualizzando la versione 1.5 della documentazione di Apigee hybrid. Questa versione è al termine del ciclo di vita. Devi eseguire l'upgrade a una versione più recente. Per maggiori informazioni, vedi Versioni supportate.

Version 1.5 (unsupported)

   Supported versions:

• v1.11 (latest)                        
• v1.10                                        
• List of supported versions

   Unsupported versions:

• 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: per utilizzare il comando apigeectl, devi aver installato e configurato kubectl sulla tua macchina di amministrazione Kubernetes.

Ambiti per l'applicazione di apigeectl

Con i flag apigeectl puoi controllare a quali ambiti il comando applica le modifiche alla configurazione. Per una panoramica degli ambiti all'interno del runtime di Apigee ibrido, 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	UDCA Sincronizzatore di runtime	--all-envs --env
Organization (Organizzazione)	Agente Apigee Connect MART Watcher	--org
Report	Logger Metriche	--telemetry

Sintassi apigeectl

apigeectl [command] [flags]

Dove:

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

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

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 di 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 gli script automatici, tieni presente che il comando esce con lo stato 0 quando i container sono tutti pronti. Quando almeno un pod non è pronto, il comando viene chiuso con lo stato 1. Flag di apigeectl: -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 quelli 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. Flag di apigeectl: --all, --all-envs, --datastore, --env, -f, --file-override-config, --help, --org, --redis, --telemetry, --verbose
encode	Restituisce un elenco di nomi codificati di tutti i ApigeeDeployment 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 hash dell'organizzazione e, se utilizzi il flag --env, un nome dell'ambiente con hash. Apigee hybrid crea nomi con hash di organizzazioni e ambienti per evitare collisioni dello spazio 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 in linea per le stampe.
init	Installa operatori e CRD Apigee nello spazio dei nomi apigee-system. Esegui apigeectl init dopo una nuova installazione o un upgrade prima di eseguire apigeectl apply. Flag di apigeectl: -f, --file-override-config, --help, --verbose
version	Stampa le informazioni sulla versione dell'interfaccia a riga di comando. flag Apigeectl: --help

Flag apigeectl

Nella tabella seguente sono elencati i flag apigeectl:

Flag	Descrizione
--all	Solo delete: elimina l'intera installazione di Apigee ibrida tranne ASM (Istio) e cert-manager dal cluster.
--all-envs	Applica il comando apigeectl a tutti gli ambienti all'interno 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 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. Usa gcloud version per verificare 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. È necessario 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: se 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 in cui viene utilizzato questo flag, vedi Stampare la configurazione su un file.
--redis	Applica la configurazione all'ambito di archiviazione dei dati in memoria (Redis).
-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 apporti una modifica alla configurazione di 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 log dettagliati su errori standard.

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

Esempi

Inizializzare la configurazione del cluster

Applica le configurazioni dei componenti prerequisito al cluster con init. Devi eseguire il comando 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, 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 cluster:

apigeectl apply -f my_overrides.yaml

Applicare la configurazione a un singolo componente

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

L'esempio seguente applica 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 controllare le impostazioni di configurazione. Il flag --print-yaml stampa la configurazione ibrida su stdout, mentre 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: è consigliabile 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 cluster:

apigeectl check-ready -f overrides/overrides.yaml
All containers ready in namespace 'my-namespace'

Elimina l'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 essere disinstallata correttamente, devi aver installato kubectl versione 1.11.x o successiva.

apigeectl delete -f my_overrides.yaml