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.
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.
Flag Apigeectl: |
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: |
delete |
Elimina i componenti ibridi dal cluster. Utilizza il flag
Flag Apigeectl: |
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 Quando richiami il raccoglitore diagnostico, viene creato uno spazio dei nomi Kubernetes " Richiama raccoglitore diagnostica: apigeectl diagnostic -f OVERRIDES_FILE Elimina raccoglitore di diagnostica: apigeectl diagnostic delete -f OVERRIDES_FILE
Flag Apigee:
|
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 Devi utilizzare ./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: |
help |
Stampa la guida online. |
init |
Installa operatori Apigee e CRD nello spazio dei nomi apigee-system.
Esegui
Flag Apigee: |
version |
Stampa le informazioni sulla versione dell'interfaccia a riga di comando.
flag Apigee: |
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 |
--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.
|
--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.
apigeectl apply --org hybrid-example --env example-env \ -f overrides/overrides.yaml |
‑f |
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 |
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. |
--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 |
Ripristina Cassandra in uno snapshot salvato in precedenza specificato dalla proprietà |
-s |
Specifica una configurazione a cui si applica il comando. Attualmente, questo flag è supportato solo per la configurazione Ad esempio, se apporti una modifica alla configurazione 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. |
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
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
.
apigeectl delete -f my_overrides.yaml