Verwenden von dynctl zur Problembehebung in Dynamic Engine
Verwenden Sie dynctl, um einen Dynamic Engine-Cluster sowie die darin ausgeführten Dienste zu überwachen, zu debuggen und Fehler zu beheben.
Mithilfe der dynctl-Befehle können Sie:
- die dynctl-Version überprüfen.
- Shell-Vervollständigungsskripte generieren.
- Cluster-Details abrufen.
- Logs ausgeführter Dienste im Dynamic Engine-Cluster anzeigen.
Die dynctl-Syntax
Die allgemeine Syntax für dynctl-Befehle lautet:
dynctl [command] [params] [flags]
In dieser Syntax:
- command
- Gibt den auszuführenden Vorgang an, z. B. das Erfassen von Protokollen oder Auflisten von Umgebungen.
- params
- Stellt zusätzliche Details bereit, die für den Befehl erforderlich sind, z. B. Ressourcen-IDs.
- flags
- Legt zusätzliche Anweisungen fest, z. B. --kubeconfig zum Überschreiben der Kubeconfig-Standarddatei.
InformationshinweisWichtig: Befehlszeilen-Flags haben Vorrang vor Standardwerten, Konfigurationsdateieinstellungen und Umgebungsvariablen. Die Vorrangreihenfolge für Konfigurationswerte ist:
- Befehlszeilen-Flags (höchste Priorität)
- Umgebungsvariablen
- Konfiguration in YAML-Datei (niedrigste Priorität)
Die dynctl-Befehle
Befehl | Syntax | Beschreibung |
---|---|---|
Version | dynctl version | Zeigt die aktuelle dynctl-Version. |
completion | dynctl completion [shell] | Erstellt shell-spezifische Vervollständigungsskripte (Bash, Zsh, PowerShell und Fish). Weitere Informationen finden Sie unter Optional: Installieren der automatischen Vervollständigungsfunktion von dynctl. |
get | dynctl get [flags] | Ruft Dynamic Engine-Details aus dem Cluster ab. |
get environment | dynctl get environment <name> [flags] dynctl get env <name> [flags]
|
Listet Dynamic Engine-Umgebungen auf oder gibt Details zu einer spezifischen Umgebung an. |
help | dynctl help <command> | Ruft Hilfe für einen bestimmten Befehl auf. |
logs | dynctl logs [flags] | Zeigt Logs ausgeführter Dynamic Engine-Dienste im Cluster an. |
logs environment | dynctl logs environment <name> [flags] dynctl logs env <name> [flags]
|
Zeigt Logs ausgeführter Dienste für die angegebene Dynamic Engine-Umgebung an. |
Die dynctl-Befehls-Flags
Flags verändern das Befehlsverhalten, indem Standardeinstellungen überschrieben werden. Sie sind in zwei Kategorien unterteilt:
- Globale Flags: Gelten für alle Befehle.
- Befehlsspezifische Flags: Gelten nur für die entsprechenden Befehle.
- Befehlszeilen-Flags wie oben erläutert (höchste Priorität)
- Umgebungsvariablen
- Konfiguration in YAML-Datei (niedrigste Priorität)
- Globale Flags
- --config
- Überschreibt die dynctl-Standardkonfigurationsdatei $HOME/.dynctl/config.
- --kubeconfig
- Überschreibt die kubectl-Standardkonfiguration für die Cluster-Verbindung.
- --kubecontext
- Überschreibt den Kubernetes-Kontext, der standardmäßig default-context in der kubeconfig-Datei ist.
- -d, --debug
- Aktiviert den Debug-Modus und konvertiert dynctl-Logs aus JSON in ein für Personen lesbares Format.
- -v, --verbose
- Aktiviert den Modus „verbose“ und protokolliert alle dynctl-Log-Stufen.
- -h, --help
- Zeigt Hilfeinformationen für den Befehl an.
- Befehlsspezifische Flags für logs und logs environment
- --follow, -f
- Streamt Protokolle fortlaufend, während sie generiert werden. Standard: false.
- --output, -o
- Gibt das Log-Ausgabeformat an, entweder stdout oder zip. Standard: stdout.
- --output-file
- Legt den Pfad für die Ausgabedatei fest. Standard: autogenerated.
- --service, -s
- Filtert Logs nach dem angegebenen Dienst. Sie können dieses Flag mehrmals verwenden, um nach verschiedenen Diensten zu filtern.
- --since
- Zeigt Log-Ausgaben an, die innerhalb eines bestimmten Zeitraums generiert wurden, z. B. 300ms, -1.5h, 2h45m. Gültige Zeiteinheiten sind ns, us (oder µs), ms, s, m, h. Standard: alle Logs.
- --tail
- Gibt die Anzahl der anzuzeigenden Log-Ausgabezeilen an. Standard: alle Zeilen.
Die dynctl-Konfigurationsmethoden
Das dynctl-Tool kann mithilfe verschiedener Methoden konfiguriert werden, die nach Vorrang aufgelistet werden:
- Befehlszeilen-Flags wie oben erläutert (höchste Priorität)
- Umgebungsvariablen
- Standardwerte in YAML-Datei (niedrigste Priorität).
Flag | Umgebungsvariable | YAML-Schlüssel | Standard | Beschreibung |
---|---|---|---|---|
--config | DYNCTL_CONFIG | config | $HOME/.dynctl/config | Der dynctl-Konfigurationsdateipfad |
--kubeconfig | DYNCTL_KUBECONFIG | k8s.config | kubectl-Standard | Kubernetes-Konfigurationsdatei(en) für dynctl |
--kubecontext | DYNCTL_KUBECONTEXT | k8s.context | aktueller Kontext von kubectl | Kubernetes-Kontext für dynctl |
--debug | DYNCTL_DEBUG | debug | false | Debug-Modus |
--verbose | DYNCTL_VERBOSE | verbose | false | Modus „verbose“ |