apigeectl

Sie sehen sich gerade die Version 1.2 der Apigee Hybrid-Dokumentation an. This version is end of life. You should upgrade to a newer version. Weitere Informationen finden Sie unter Unterstützte Versionen.

Version 1.2 (unsupported)

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.

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. Mit dem Flag -c können Sie eine oder mehrere durch Kommas getrennte Komponenten angeben. Wenn Sie das Flag -c nicht angeben, wendet der Befehl apply alle Komponenten auf den Cluster an. HINWEIS: Sie müssen apigeectl init aufrufen, bevor Sie apigeectl apply aufrufen.
check‑ready	Prü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. Wenn Sie das Flag -c nicht angeben, gilt der Befehl check-ready für alle Komponenten im Cluster.
delete	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. Wenn Sie das Flag -c nicht angeben, gilt der Befehl delete für alle Komponenten, die im Cluster bereitgestellt werden.
help	Zeigt die Onlinehilfe an.
init	Wendet Konfigurationen für erforderliche Komponenten wie Istio und Apigee Deployment auf den Cluster an. Mit dem Flag -c können Sie eine oder mehrere durch Kommas getrennte Komponenten angeben.
version	Druckt die CLI-Versionsinformationen.

apigeectl-Flags

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

Flag	Beschreibung
-c, --components	Gibt eine einzelne Komponente an, auf die der Befehl angewendet wird. Wenn Sie dieses Flag nicht angeben, gilt der Befehl für alle Komponenten (das gesamte Deployment) im Cluster. Zulässige Werte: cassandra logger mart metrics runtime synchronizer udca Beispiel: -c cassandra Oder geben Sie mehrere durch Kommas getrennte Werte an, um mehrere Komponenten anzugeben: -c cassandra, runtime
--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.
‑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.
--print-yaml	Druckt die Ausgabe der Konfigurationsvorlage in stdout. Ein Beispiel, das dieses Flag verwendet, finden Sie unter Konfiguration in eine Datei drucken.
-s, --settings	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. (Version 1.2.0 hinzugefügt) 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 -c runtime

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 zu übernehmen, oder verwenden Sie -c, um nur eine bestimmte Komponente 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 apply-Befehl auf eine bestimmte Komponente beschränken möchten, verwenden Sie das Flag -c, wie unter apigeectl-Flags beschrieben.

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

apigeectl apply -c synchronizer -f my_overrides.yaml

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

apigeectl apply -c cassandra,runtime -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 --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
All containers ready in namespace 'my-namespace'

Hybrid aus dem Cluster löschen

Im folgenden Beispiel werden nur die Hybrid-Laufzeitkomponenten in Ihrem Kubernetes-Cluster gelöscht. Um alles zu löschen, verwenden Sie das Flag --all.

HINWEIS: Zum Deinstallieren benötigen Sie kubectl, Version 1.11.x oder höher.

apigeectl delete -f my_overrides.yaml