apigeectl

Al momento stai visualizzando la versione 1.3 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.3 (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 Apigee hybrid, consulta la Panoramica della configurazione dei servizi di runtime.

Ambito	Componenti	apigeectl flag
Spazio di archiviazione	Cassandra	--datastore
Ambiente	Runtime Synchronizer UDCA	--all-envs --env
Organization (Organizzazione)	Osservatore dell'agente Apigee Connect MART	--org
Report	Logger Metriche	--telemetry

Sintassi di 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 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 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, --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 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 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 delete si applica a tutti i componenti di cui è stato eseguito il deployment nel cluster. Flag apigeectl: --all, --all-envs, --datastore, --env, -f, --file-override-config, --help, --org, --telemetry, --verbose
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 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 apigeectl: --env, --org
help	Stampa la guida online.
init	Installa gli operatori e i CRD di Apigee 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 di Apigee hybrid, ad eccezione di ASM (Istio) e cert-manager, dal 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. Utilizza con ‑‑print-yaml per esportare la specifica dell'oggetto visualizzato in un file. ‑‑dry‑run deve essere utilizzato con uno dei due valori seguenti, a seconda del di kubectl che stai eseguendo. 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 delle proprietà di configurazione 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 saperne di più, consulta la pagina relativa alla 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, vedi Stampare la configurazione su un file.
-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 alle virtualhosts proprietà e niente diverso. 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 i log dettagliati in stderr.

Il comando apigeectl usa kubectl per eseguire questa operazione il suo funzionamento. Le opzioni del comando apigeectl (apply e delete, e l'uso dei file di configurazione YAML, sono simili alle loro controparti 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 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 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 di nuovo apply per applicare solo le modifiche o utilizza i flag per applicare una modifica solo a un ambito specifico.

Il seguente esempio applica la configurazione per i componenti del piano di runtime ibrida 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 la classe 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'intero configurazione del cluster in un file per poter esaminare la configurazione impostazioni. Il flag --print-yaml stampa la configurazione ibrida su stdout e il flag --dry-run consente di eseguire il 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 dei l'output YAML nel controllo del codice sorgente per riferimento futuro. Ricorda però che il file di output contiene password e segreti che potresti non voler archiviare.

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 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 una disinstallazione riuscita, devi avere installatokubectl versione 1.11.x o successive.

apigeectl delete -f my_overrides.yaml