apigeectl

Al momento stai visualizzando la versione 1.7 della documentazione di Apigee hybrid. This version is end of life. You should upgrade to a newer version. Per ulteriori informazioni, consulta Versioni supportate.

Version 1.7 (unsupported)

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

Ambiti per l'applicazione di apigeectl

Utilizzando i flag apigeectl puoi stabilire gli ambiti in base al comando a cui applicare 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 Synchronizer UDCA	--all-envs --env
Organization (Organizzazione)	Apigee Connect Agent MART Watcher	--org
Report	Logger Metrics	--telemetry

Sintassi apigeectl

apigeectl [command] [flags]

Dove:

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

• flags: specifica il comando parametri. Per un elenco completo dei flag, vedi apigeectl flags.

Comandi apigeectl

La tabella seguente elenca i comandi apigeectl:

Comando	Descrizione
apply	Applica configurazioni per il runtime ibrido 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 di componenti ibride. Quando tutto i pod dei componenti sono pronti, viene visualizzato il messaggio "Tutti i container pronti" come output. 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 --verbose
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 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 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	Richiama il raccoglitore di dati di diagnostica, che acquisisce i dati di diagnostica sui componenti Kubernetes di un'istanza ibrida Apigee on demand e li archivia nei bucket Google Cloud Storage. Il Collector diagnostico richiede un bucket Google Cloud Storage denominato, un account di servizio con il ruolo Amministratore archiviazione e una stanza diagnostic: aggiunta al file overrides. Vedi: Utilizzare il raccoltore Diagnostic Riferimento per le proprietà di configurazione: diagnostic Quando richiami il raccoglitore diagnostico, viene creato un "apigee-diagnostic" dello spazio dei nomi Kubernetes. 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 apigeectl: --file-override-config
encode	Restituisce un elenco di nomi codificati di tutti gli ApigeeDeployment per il dell'organizzazione o dell'ambiente specificato all'interno dell'organizzazione specificata. I nomi codificati includono il nome del componente con un nome sottoposta ad hashing dell'organizzazione e, se si utilizza il flag --env, un nome sottoposta ad hashing dell'ambiente. Apigee hybrid crea nomi con hash delle organizzazioni e degli ambienti in modo da poter evitare le collisioni degli spazi dei nomi. Devi utilizzare --org org-name o entrambi --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 Apigee: --env, --org
help	Guida online di Stampe.
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 apigeectl: -f, --file-override-config, --help, --verbose
version	Stampa le informazioni sulla versione della CLI. flag Apigee: --help

Flag apigeectl

Nella tabella seguente sono elencati i flag apigeectl:

Bandiera	Descrizione
--all	Solo delete: elimina l'intera installazione ibrida di Apigee tranne ASM (Istio) e cert-manager dal tuo 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. Utilizza con ‑‑print-yaml per esportare la specifica dell'oggetto visualizzato 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 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 di 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 ulteriori 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 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, consulta Stampare la configurazione in 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 dal Proprietà snapshotTimestamp nella configurazione restore di il 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 ulteriori informazioni, vedi Ripristino di una regione da un backup.
-s ‑‑settings virtualhosts	Specifica una configurazione a cui si applica il comando. Attualmente, questa segnalazione è supportato solo per la configurazione virtualhosts, che fa parte di il componente runtime. Utilizza questo flag se apporti modifiche alla proprietà virtualhosts e a nessun'altra. Ad esempio, se apporti una modifica alla configurazione di virtualhosts nel file degli override, applicalo 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 stderr.

Il comando apigeectl utilizza kubectl dietro le quinte per svolgere il suo compito. Le opzioni del comando apigeectl (apply e delete) e l'utilizzo dei file di configurazione YAML sono simili alle relative controparti di 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

Inizializzare 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 utilizza i flag per applicare le modifiche solo a un ambito specifico.

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 a 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'intero configurazione del cluster in un file per poter esaminare la configurazione impostazioni. La bandiera --print-yaml viene stampata dalla 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.

Controllare 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

L'esempio seguente elimina solo i componenti di runtime ibridi nell'account in un cluster Kubernetes. Per eliminare tutti i dati, utilizza 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