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.
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-Flags: |
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: |
delete |
Löscht Hybridkomponenten aus dem Cluster. Mit dem Flag
Apigeectl flags: |
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 Wenn Sie den Diagnose-Collector aufrufen, wird der Kubernetes-Namespace " 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:
|
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 Sie müssen entweder das ./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: |
help |
Zeigt die Onlinehilfe an. |
init |
Installiert Apigee-Operatoren und CRDs im Apigee-System-Namespace. Führen Sie apigeectl-Flags: |
version |
Druckt die CLI-Versionsinformationen. apigeectl-Flag: |
apigeectl-Flags
In der folgenden Tabelle sind die Flags apigeectl
aufgeführt:
Flag | Beschreibung |
---|---|
--all |
delete : Löscht die gesamte Apigee Hybridinstallation außer ASM (Istio) und cert-manager aus Ihrem Cluster.
|
--all-envs |
Wendet den Befehl |
--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.
|
--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.
apigeectl apply --org hybrid-example --env example-env \ -f overrides/overrides.yaml |
-f |
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 |
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. |
--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 |
-s |
Gibt eine Konfiguration an, auf die der Befehl angewendet wird. Derzeit wird dieses Flag nur für die Wenn Sie beispielsweise eine Änderung an der apigeectl apply -f my-overrides.yaml --settings virtualhosts \ --org example-org --env example-env |
--telemetry |
Wendet die Konfiguration für Telemetriekomponenten wie Apigee-Logger und Apigee-Messwerte an. |
--v int |
Zeigt ausführliche Logs an std err an. --verbose . |
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
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'