apigeectl

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

Version 1.6 (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 sul download e l'installazione di apigeectl, consulta Scarica e installa 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
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 apigeectl

apigeectl [command] [flags]

Dove:

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

• 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 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 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 gli script automatici, tieni presente che il comando esce con uno stato pari a 0 quando tutti i contenitori sono pronti. Se almeno un pod non è pronto, il comando esce con uno stato pari a 1. flag apigeectl: -f, --file-override-config, --help, --verbose
delete	Consente di eliminare i componenti ibride dal cluster. Usa 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 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. La -f / Il flag --file-override-config è obbligatorio con apigeectl diagnostic delete Flag Apigee: --all, --all-envs, --datastore, --env, -f, --file-override-config, --help, --org, --redis, --telemetry, --verbose
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 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: 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 eliminarlo con apigeectl diagnostic delete prima di richiamare di nuovo il Collector diagnostico. Richiama il raccoglitore Diagnostic: apigeectl diagnostic -f OVERRIDES_FILE Elimina il raccoglitore Diagnostic: apigeectl diagnostic delete -f OVERRIDES_FILE flag apigeectl: --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 --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 --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 all'interno dell'organizzazione specificato 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. 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 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 verrà applicato 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 apply, Comandi 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	(Introdotta nella versione 1.6.6) Ripristina Cassandra a 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, consulta Ripristinare 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 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.
--verbose	Stampa log dettagliati in std err.

Il comando apigeectl usa kubectl per eseguire questa operazione il suo funzionamento. 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

Inizializza la configurazione del cluster

Applica le configurazioni dei componenti prerequisiti al tuo 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 Comando apply. La prima volta che esegui apply, tutti i componenti di runtime ibrida 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.

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.

L'esempio seguente applica la configurazione solo 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 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. Tuttavia, tieni presente che il file di output contiene password e segreti che potresti non voler archiviare.

Controllare 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 ibrida nel 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