Utiliser dynctl pour le dépannage de Dynamic Engine
Utilisez dynctlpour monitorer, déboguer et dépanner un cluster et des services de Dynamic Engine qui s'y exécutent.
La commande dynctl vous permet de :
- Vérifiez la version de dynctl.
- Générer des scripts de complétion shell.
- Récupérez les détails du cluster.
- Visualiser les logs des services de Dynamic Engine s'exécutant dans le cluster.
Syntaxe dynctl
La syntaxe générale des commandes dynctl est :
dynctl [command] [params] [flags]
Dans cette syntaxe :
- command
- Spécifie l'opération à effectuer, par exemple collecter des logs ou lister des environnements.
- params
- Fournit des détails supplémentaires requis pour la commande, comme l'ID des ressources (resource ID).
- flags
- Configure des instructions supplémentaires, comme --kubeconfig pour écraser le fichier Kubeconfig par défaut.
Note InformationsImportant : Les instructions (flags) de l'invite de commande sont prioritaires sur les valeurs par défaut, les paramètres des fichiers de configuration et les variables d'environnement. L'ordre de priorité pour les valeurs de configuration est le suivant :
- Instructions (flags) de l'invite de commande (priorité la plus haute).
- Variables d'environnement.
- Configuration dans le fichier YAML (priorité la plus basse).
Commandes dynctl
Commande | Syntaxe | Description |
---|---|---|
Version | dynctl version | Affiche la version courante de dynctl. |
completion | dynctl completion [shell] | Crée des scripts de complétion shell spécifiques (Bash, Zsh, PowerShell et Fish). Pour plus d'informations, consultez Facultatif : Installer la fonctionnalité d'autocomplétion de dynctl. |
get | dynctl get [flags] | Récupère les détails de Dynamic Engine depuis le cluster. |
get environment | dynctl get environment <name> [flags] dynctl get env <name> [flags]
|
Liste les environnements de Dynamic Engine ou fournit des détails concernant un environnement spécifique. |
help | dynctl help <command> | Permet d'obtenir de l'aide pour une commande spécifique. |
logs | dynctl logs [flags] | Affiche les logs des services de Dynamic Engine s'exécutant dans le cluster. |
logs environment | dynctl logs environment <name> [flags] dynctl logs env <name> [flags]
|
Affiche les logs des services en cours d'exécution pour l'environnement de Dynamic Engine spécifié. |
Instructions (flags) des commandes dynctl
Les instructions (flags) modifient le comportement des commandes en écrasant les paramètres par défaut. Elles appartiennent à deux catégories :
- Instructions globales : Elles s'appliquent à toutes les commandes.
- Instructions spécifiques à des commandes : Elles s'appliquent uniquement aux commandes spécifiées.
- Instructions (flags) de l'invite de commande comme présentés ci-dessus (priorité la plus haute).
- Variables d'environnement.
- Configuration dans le fichier YAML (priorité la plus basse).
- Instructions globales
- --config
- Écrase le fichier de configuration de dynctl par défaut, $HOME/.dynctl/config.
- --kubeconfig
- Écrase la configuration par défaut de kubectl pour la connexion au cluster.
- --kubecontext
- Écrase le contexte Kubernetes dont la valeur par défaut est default-context dans le fichier kubeconfig.
- -d, --debug
- Active le mode débogage, convertissant les logs de dynctl de JSON à un format lisible par l'humain.
- -v, --verbose
- Active le mode verbose, pour enregistrer dans les logs tous les niveaux de logs de dynctl.
- -h, --help
- Affiche les informations d'aide pour la commande.
- Instructions (flags) spécifiques à des commandes pour les logs et logs environment (environnement des logs)
- --follow, -f
- Met en flux les logs continuellement au fur et à mesure de leur génération. Par défaut : false.
- --output, -o
- Spécifie le format de sortie du log, stdout ou zip. Par défaut : stdout.
- --output-file
- Configure le chemin pour le fichier de sortie. Par défaut : autogenerated.
- --service, -s
- Filtre les logs par service spécifié. Vous pouvez utiliser cette instruction (flag) plusieurs fois pour filtrer plusieurs services.
- --since
- Affiche la sortie de log générée dans une limite de temps spécifiée, par exemple, 300ms, -1.5h, 2h45m. Les unités temporelles valides sont : ns, us (or µs), ms, s, m et h. Par défaut : Tous les logs.
- --tail
- Spécifie le nombre de lignes de sortie de log à afficher. Par défaut : Toutes les lignes.
Méthodes de configuration de dynctl
L'outil dynctl peut être configuré par plusieurs méthodes, listées par ordre de précédence :
- Instructions (flags) de l'invite de commande comme présentés ci-dessus (priorité la plus haute).
- Variables d'environnement.
- Valeurs par défaut dans le fichier YAML (priorité la plus basse).
Option | Variable d'environnement | Clé YAML | Défaut | Description |
---|---|---|---|---|
--config | DYNCTL_CONFIG | --config | $HOME/.dynctl/config | Chemin du fichier de configuration de dynctl |
--kubeconfig | DYNCTL_KUBECONFIG | k8s.config | Valeur par défaut de kubectl | Fichier·s de configuration de Kubernetes pour dynctl |
--kubecontext | DYNCTL_KUBECONTEXT | k8s.context | Contexte actif de kubectl | Contexte Kubernetes de dynctl |
--debug | DYNCTL_DEBUG | Debug | false | Debug mode |
--verbose | DYNCTL_VERBOSE | verbose | false | Verbose mode (Mode verbose) |