apigeectl

Sie sehen sich gerade die Version 1.10 der Apigee Hybrid-Dokumentation an. Weitere Informationen finden Sie unter Unterstützte Versionen.

Version 1.10 

Unterstützte Versionen:

• v1.13 (aktuellste Version)                        
• v1.12                         
• v1.11                         
• Liste der unterstützten Versionen

Nicht unterstützte Versionen:

• v1.10                                      
• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

apigeectl ist eine Befehlszeile zum Installieren und Verwalten von Apigee hybrid in einem Kubernetes-Cluster. Informationen zum Herunterladen und Installieren von apigeectl finden Sie unter apigeectl herunterladen und installieren.

HINWEIS: Sie müssen kubectl auf Ihrem Kubernetes-Verwaltungssystem installiert und eingerichtet haben, um den Befehl apigeectl nutzen zu können.

Bereiche für die Anwendung von apigeectl

Mit apigeectl - Flags steuern Sie, auf welche Bereiche der Befehl Konfigurationsänderungen anwendet. Eine Übersicht der Bereiche innerhalb der Apigee-Hybrid-Laufzeit finden Sie in der Übersicht über die Laufzeitdienstkonfiguration.

Umfang	Komponenten	apigeectl Flag
Speicher	Cassandra	‑‑datastore
In-Memory-Speicher	Redis	‑‑redis
Umgebung	Laufzeit Synchronizer UDCA	‑‑all‑envs ‑‑env
Organisation	Apigee Connect-Agent MART Watcher	‑‑org
Berichterstellung	Logger Messwerte	‑‑telemetry

apigeectl-Syntax

apigeectl [command] [flags]

Dabei gilt:

• command: Gibt den Vorgang an, den Sie ausführen möchten. Eine vollständige Liste der Befehle finden Sie unter apigeectl-Befehle.

• flags: Gibt Befehlsparameter an. Eine vollständige Liste der Flags finden Sie unter apigeectl-Flags.

apigeectl-Befehle

In der folgenden Tabelle sind die apigeectl-Befehle aufgeführt:

Befehl	Beschreibung
apply	Wendet Konfigurationen für Apigee hybrid-Laufzeitkomponenten auf Ihren Kubernetes-Cluster an. Bei apigeectl apply ohne Flags werden Änderungen auf alle Komponenten im Cluster angewendet. Apigeectl-Flags: ‑‑all‑envs, ‑‑datastore, ‑‑dry‑run, ‑‑env, ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑org, ‑‑print‑yaml, ‑‑redis, ‑‑settings virtualhosts, ‑‑telemetry, ‑‑v HINWEIS: Nach einer Neuinstallation oder einem Upgrade müssen Sie vor dem Aufruf von apigeectl apply apigeectl init aufrufen.
check‑ready	Überprüft den Status der hybriden Komponenten-Pods. Wenn alle Komponenten-Pods bereit sind, wird die Meldung "All containers ready" (Alle Container bereit) ausgegeben. Beachten Sie bei automatisierten Skripts, dass der Befehl mit dem Status 0 beendet wird, wenn alle Container bereit sind. Wenn mindestens ein Pod nicht bereit ist, wird der Befehl mit dem Status 1 beendet. apigeectl-Flags: ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑v
delete	Warnung: Wenn Sie den Befehl apigeectl delete mit dem Flag ‑‑all verwenden (z. B. apigeectl delete ‑‑all -f overrides.yaml), werden auch die Sicherungsdaten für alle CSI-Volume-Snapshots gelöscht. Löscht Hybridkomponenten aus dem Cluster. Mit dem Flag ‑‑all entfernen Sie ALLE Komponenten. Wenn Sie ‑‑all weglassen, werden nur die Apigee-spezifischen Komponenten entfernt (die mit apigeectl init installierten Komponenten werden nicht gelöscht). Apigee-spezifische Komponenten sind Komponenten, die mit dem Befehl apply installiert werden. apigeectl delete ohne optionale Flags wendet den Befehl delete auf alle im Cluster bereitgestellten Komponenten an. apigeectl diagnostic delete ‑f OVERRIDES_FILE löscht den von apigeectl diagnostic erstellten Namespace apigee‑diagnostic. Das Flag ‑f/‑‑file‑override‑config ist für apigeectl diagnostic delete erforderlich. Apigeectl flags: ‑‑all, ‑‑all‑envs, ‑‑datastore, ‑‑env, ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑org, ‑‑redis, ‑‑telemetry, ‑‑v Weitere Informationen finden Sie unter Hybridlaufzeit deinstallieren.
diagnostic	Ruft den Diagnose-Collector auf, der bei Bedarf Diagnosedaten zu den Kubernetes-Komponenten einer Apigee Hybrid-Instanz erfasst und in Google Cloud Storage-Buckets speichert. Der Diagnose-Collector erfordert einen benannten Google Cloud Storage-Bucket, ein Dienstkonto mit der Rolle Storage-Administrator und eine diagnostic:-Stanza, die der Datei overrides hinzugefügt wird. Weitere Informationen: Diagnose-Collector verwenden Referenz zu Konfigurationsattributen: diagnostic Wenn Sie den Diagnose-Collector aufrufen, wird der Kubernetes-Namespace "apigee‑diagnostic" erstellt. Sie müssen diesen mit apigeectl diagnostic delete löschen, bevor Sie den Diagnose-Collector noch einmal aufrufen. Rufen Sie den Diagnose-Collector auf: apigeectl diagnostic ‑f OVERRIDES_FILE Löschen Sie den Diagnose-Collector: apigeectl diagnostic delete ‑f OVERRIDES_FILE apigeectl-Flags: ‑‑file‑override‑config
encode	Gibt eine Liste codierter Namen aller ApigeeDeployments für die angegebene Organisation oder die angegebene Umgebung innerhalb der angegebenen Organisation zurück. Die codierten Namen enthalten den Namen der Komponente mit einem Hash-Namen der Organisation und bei Verwendung des Flags ‑‑env den Hash-Namen der Umgebung. Apigee hybrid erstellt Hash-Namen von Organisationen und Umgebungen, um Namespace-Konflikte zu vermeiden. Sie müssen entweder das ‑‑org org‑name oder beide ‑‑org org‑name mit den Flags ‑‑env env‑name und encode verwenden. Beispiel: ./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 apigeectl-Flags: ‑‑env, ‑‑org
help	Zeigt die Onlinehilfe an.
init	Installiert Apigee-Operatoren und CRDs im Apigee-System-Namespace. Führen Sie apigeectl init nach einer Neuinstallation oder Upgrade aus, bevor Sie apigeectl apply ausführen. apigeectl-Flags: ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑v
version	Druckt die CLI-Versionsinformationen. apigeectl-Flag: ‑‑help

apigeectl-Flags

In der folgenden Tabelle sind die Flags apigeectl aufgeführt:

Flag	Beschreibung
‑‑all	Warnung: Wenn Sie den Befehl apigeectl delete mit dem Flag ‑‑all verwenden (z. B. apigeectl delete ‑‑all -f overrides.yaml), werden auch die Sicherungsdaten für alle CSI-Volume-Snapshots gelöscht. Nur delete: Löscht die gesamte Apigee Hybridinstallation außer ASM (Istio) und cert-manager aus Ihrem Cluster.
‑‑all‑envs	Wendet den Befehl apigeectl auf alle Umgebungen unter der Organisation an, die in der Überschreibungen-Konfigurationsdatei angegeben wird.
‑‑datastore	Wendet die Konfiguration auf den Datenspeicherbereich (Cassandra) an.
‑‑dry‑run	Führt den angegebenen Befehl aus, ohne den Cluster zu ändern. Verwenden Sie ‑‑print‑yaml, um die gerenderte Objektspezifikation in eine Datei auszugeben. ‑‑dry‑run muss mit einem der beiden folgenden Werte verwendet werden, abhängig von der ausgeführten kubectl-Version. Prüfen Sie Ihre kubectl-Version mit gcloud version: kubectl Version 1.17.x oder niedriger: ‑‑dry‑run=true kubectl-Version 1.18.x oder höher: ‑‑dry‑run=client
‑‑env env‑name	Wendet die Konfiguration auf die angegebene Umgebung an. Dieses Flag wendet die Konfiguration auf die Komponenten der Umgebung Apigee-Laufzeit, Apigee-Synchronizer und Apigee-udca an. ‑‑envMuss mit dem Flag ‑‑org verwendet werden. Beispiel: apigeectl apply ‑‑org hybrid‑example ‑‑env example‑env \ ‑f overrides/overrides.yaml
‑f ‑‑file‑override‑config	Gibt eine YAML-Datei an, die benutzerdefinierte Konfigurationsattribute für die Hybridbereitstellung enthält. Der Standardwert ist ./overrides.yaml. Für die Befehle apply, check‑ready, delete und init ist eine Überschreibungsdatei erforderlich. Sie müssen den vollständigen Pfad mit diesem Flag angeben. Weitere Informationen finden Sie unter Komponenten der Laufzeitebene verwalten.
‑h ‑‑help	Zeigt Hilfe zu diesem Befehl an.
‑‑org	Wendet die Konfiguration auf die angegebene Organisation an. Dieses Flag wendet die Konfiguration auf die Organisationsbereichskomponenten apigee-Verbindungs-Agent, Apigee-Mart und Apigee-Watcher an. Hinweis: Wenn Sie ‑‑org mit encode verwenden, müssen Sie die Organisations-ID angeben. Beispiel: apigeectl encode ‑‑org example‑org
‑‑print‑yaml	Druckt die Ausgabe der Konfigurationsvorlage in stdout. Ein Beispiel, das dieses Flag verwendet, finden Sie unter Konfiguration in eine Datei drucken.
‑‑redis	Wendet die Konfiguration auf den In-Memory-Datenspeicherbereich (Redis) an.
‑‑restore	Stellt Cassandra anhand eines zuvor gespeicherten Snapshots wieder her, der durch das Attribut snapshotTimestamp in der restore-Konfiguration der Datei overrides.yaml angegeben wurde. Die Sicherung wird entweder aus dem Cloud Storage-Bucket oder von einem Remoteserver wiederhergestellt, basierend auf der backup-Konfiguration in der Datei overrides.yaml. Weitere Informationen finden Sie unter Region aus einer Sicherung wiederherstellen.
‑s ‑‑settings virtualhosts	Gibt eine Konfiguration an, auf die der Befehl angewendet wird. Derzeit wird dieses Flag nur für die virtualhosts-Konfiguration unterstützt, die Teil der runtime-Komponente ist. Verwenden Sie dieses Flag, wenn Sie Änderungen am Attribut virtualhosts vornehmen. Wenn Sie beispielsweise eine Änderung an der virtualhosts-Konfiguration in der Überschreibungsdatei vornehmen, wenden Sie diese mit dem folgenden Befehl auf den Cluster an: apigeectl apply ‑f my‑overrides.yaml ‑‑settings virtualhosts \ ‑‑org example‑org ‑‑env example‑env
‑‑telemetry	Wendet die Konfiguration für Telemetriekomponenten an: apigee-logger und apigee-metrics.
‑‑v int	Zeigt ausführliche Logs an std err an. int ist eine Ganzzahl, die die Ausführlichkeitsstufe festlegt. int ist mit ‑‑v erforderlich. Diese Option verhält sich identisch mit der Option kubectl ‑‑v. Hinweis: Diese Option ersetzt die verworfene Option ‑‑verbose.

Der Befehl apigeectl verwendet für die Arbeit kubectl im Hintergrund. Die apigeectl-Befehlsoptionen (apply und delete) und die Verwendung von YAML-Konfigurationsdateien sind ähnlich wie kubectl-Gegenstücke. Mehr über die Verwaltung von Objekten in einem Kubernetes-Cluster erfahren Sie unter folgenden Themen:

• Imperative Verwaltung von Kubernetes-Objekten mithilfe von Konfigurationsdateien
• Übersicht über kubectl

Beispiele

Clusterkonfiguration initialisieren

Wenden Sie die erforderlichen Komponentenkonfigurationen mit init auf Ihren Cluster an. Sie müssen den Befehl init vor apply ausführen.

apigeectl init ‑f my_overrides.yaml

Clusterkonfiguration anwenden

Mit dem Befehl apply können Sie Hybridkonfigurationen auf Ihren Kubernetes-Cluster anwenden. Wenn Sie apply zum ersten Mal ausführen, werden alle Hybrid-Laufzeitkomponenten in Ihrem Cluster erstellt. Wenn Sie Konfigurationsänderungen vornehmen, führen Sie apply noch einmal aus, um nur die Änderungen anzuwenden, oder verwenden Sie Flags, um die Änderungen nur auf einen bestimmten Bereich anzuwenden.

Im folgenden Beispiel wird die Konfiguration für Komponenten der Hybrid-Laufzeitebene auf Ihren Cluster angewendet:

apigeectl apply ‑f my_overrides.yaml

Konfiguration auf eine einzelne Komponente anwenden

Wenn Sie den Befehl apply auf eine bestimmte Komponente beschränken möchten, verwenden Sie die unter apigeectl-Flags beschriebenen Flags.

Im folgenden Beispiel wird nur die Konfiguration für die Cassandra-Komponente angewendet:

apigeectl apply ‑‑datastore ‑f my_overrides.yaml

Konfiguration in einer Datei ausgeben

Wenn Sie ein Installationsproblem beheben, empfiehlt es sich, die gesamte Clusterkonfiguration in einer Datei auszudrucken, damit Sie die Konfigurationseinstellungen prüfen können. Das Flag ‑‑print‑yaml gibt die Hybridkonfiguration an stdout an und mit dem Flag ‑‑dry‑run wird der Befehl ausgeführt, ohne Änderungen am Cluster vorzunehmen.

apigeectl apply ‑f my_overrides.yaml ‑‑dry‑run=client ‑‑print‑yaml > apigee‑hybrid.yaml

Hinweis: Es wird empfohlen, eine Kopie der YAML-Ausgabe in der Versionsverwaltung zur späteren Verwendung zu speichern. Die Ausgabedatei enthält Passwörter und Secrets, die Sie eventuell nicht speichern möchten.

Pod-Status prüfen

Im folgenden Beispiel wird der Status der in dem Cluster bereitgestellten Pods geprüft:

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

Hybrid aus dem Cluster löschen

Weitere Informationen finden Sie unter Hybridlaufzeit deinstallieren.