Reference CLI

La CLI kubetail est le point d’entree principal de Kubetail sur votre poste. Vous pouvez l’utiliser pour demarrer le dashboard web, diffuser des logs dans votre terminal ou gerer les ressources Kubetail dans votre cluster.

Indicateurs globaux

Ces indicateurs sont disponibles pour toutes les commandes:

Flag	Default	Description
`--kubeconfig`		Chemin vers le fichier kubeconfig
`--in-cluster`	`false`	Utiliser la configuration Kubernetes in-cluster
`-c, --config`	`~/.kubetail/config.yaml`	Chemin vers le fichier de configuration

Commandes

`kubetail serve`

Demarrez le serveur du dashboard et ouvrez l’interface web dans votre navigateur par defaut.

kubetail serve [flags]

Indicateurs

Flag	Default	Description
`-p, --port`	`7500`	Numero de port a ecouter
`--host`	`localhost`	Adresse hote a laquelle se lier
`-l, --log-level`	`info`	Niveau de log (`debug`, `info`, `warn`, `error`, `disabled`)
`--skip-open`	`false`	Ne pas ouvrir le navigateur

Exemples

# Demarrer le dashboard (s'ouvre sur http://localhost:7500)
kubetail serve

# Utiliser un port personnalise
kubetail serve --port 8080

# Demarrer sans ouvrir le navigateur
kubetail serve --skip-open

`kubetail logs`

Recuperer les logs d’un conteneur ou d’un ensemble de conteneurs de workload.

kubetail logs [source1] [source2] ... [flags]

Sources

Une source identifie les pods/conteneurs depuis lesquels diffuser les logs. Les sources utilisent la syntaxe suivante:

[namespace:]<resource>[/name[/container]]

Example	Description
`web-abc123`	Pod nomme `web-abc123` dans le namespace par defaut
`deployments/web`	Deployment `web` dans le namespace par defaut
`deployments/*`	Tous les deployments dans le namespace par defaut
`deployments/web/container1`	Conteneur specifique dans un deployment
`deployments/web/*`	Tous les conteneurs d’un deployment
`frontend:web-abc123`	Pod dans le namespace `frontend`
`frontend:deployments/web`	Deployment dans le namespace `frontend`

Plusieurs sources peuvent etre specifiees:

kubetail logs <source1> <source2>

Indicateurs

Flag	Default	Description
`--kube-context`		Contexte kubeconfig a utiliser
`-h, --head[=N]`	`10`	Retourner les N premiers enregistrements
`-t, --tail[=N]`	`10`	Retourner les N derniers enregistrements
`--all`	`false`	Retourner tous les enregistrements
`-f, --follow`	`false`	Diffuser les nouveaux enregistrements
`--since`		Inclure les enregistrements a partir du point specifie (inclus)
`--until`		Inclure les enregistrements jusqu’au point specifie (inclus)
`--after`		Inclure les enregistrements strictement apres le point specifie
`--before`		Inclure les enregistrements strictement avant le point specifie
`-g, --grep`		Filtrer les enregistrements avec une expression reguliere (necessite `--force`)
`--region`		Filtrer les pods source par region (separes par des virgules)
`--zone`		Filtrer les pods source par zone (separes par des virgules)
`--os`		Filtrer les pods source par systeme d’exploitation (separes par des virgules)
`--arch`		Filtrer les pods source par architecture CPU (separes par des virgules)
`--node`		Filtrer les pods source par nom de noeud (separes par des virgules)
`--raw`	`false`	Sortir uniquement les messages de log bruts sans metadonnees
`--columns`		Definir les colonnes de sortie (remplace les valeurs par defaut)
`--add-columns`		Ajouter des colonnes de sortie aux valeurs par defaut
`--remove-columns`		Retirer des colonnes de sortie des valeurs par defaut
`--with-cursors`	`false`	Afficher les curseurs de pagination
`--hide-header`	`false`	Masquer l’en-tete du tableau
`--all-containers`	`false`	Afficher les logs de tous les conteneurs d’un pod
`--force`	`false`	Forcer la commande (requis lors de l’utilisation de `--grep`)

Les indicateurs --columns, --add-columns et --remove-columns acceptent une liste de noms de colonnes separes par des virgules: timestamp, dot, node, region, zone, os, arch, namespace, pod, container.

Les indicateurs --head, --tail et --all sont mutuellement exclusifs. Les indicateurs --since et --after sont egalement mutuellement exclusifs, de meme que --until et --before.

Les indicateurs --since, --until, --after et --before acceptent:

Un horodatage ISO 8601 (par ex. 2006-01-02T15:04:05Z07:00)
Une duree ISO 8601 relative a maintenant (par ex. PT30M pour il y a 30 minutes) - uniquement pour --since et --until

Comportement par defaut: mode tail (10 derniers enregistrements), sauf si --since est specifie, auquel cas le mode head est utilise.

Exemples

# Afficher les 10 derniers enregistrements d'un pod
kubetail logs nginx

# Faire le tail d'un deployment
kubetail logs deployments/web

# Suivre les nouveaux enregistrements
kubetail logs deployments/web --follow

# Retourner tous les enregistrements et continuer a suivre
kubetail logs deployments/web --all --follow

# Retourner les 100 premiers enregistrements
kubetail logs nginx --head=100

# Retourner les enregistrements des 30 dernieres minutes
kubetail logs nginx --since PT30M --all

# Retourner les enregistrements entre deux horodatages
kubetail logs nginx --since 2006-01-02T15:04:05Z --until 2007-01-02T15:04:05Z --all

# Filtrer par expression reguliere (necessite --force)
kubetail logs nginx --grep "GET /about" --force

# Filtrer les pods par region
kubetail logs deployments/web --region=us-east-1

# Sortir uniquement les messages de log bruts
kubetail logs nginx --raw

`kubetail cluster`

Gerer les ressources Kubetail du cluster en utilisant Helm en interne (Helm n’a pas besoin d’etre installe separement).

kubetail cluster <subcommand> [flags]

`kubetail cluster install`

Creer une nouvelle release Kubetail dans le cluster.

kubetail cluster install [flags]

Indicateurs

Flag	Default	Description
`--kube-context`		Nom du contexte kubeconfig a utiliser

Exemples

kubetail cluster install

`kubetail cluster upgrade`

Mettre a niveau une release Kubetail existante vers la derniere version du chart disponible localement.

kubetail cluster upgrade [flags]

Indicateurs

Flag	Default	Description
`--kube-context`		Nom du contexte kubeconfig a utiliser

Exemples

kubetail cluster upgrade

`kubetail cluster uninstall`

Supprimer une release Kubetail existante du cluster.

kubetail cluster uninstall [flags]

Indicateurs

Flag	Default	Description
`--kube-context`		Nom du contexte kubeconfig a utiliser

Exemples

kubetail cluster uninstall

`kubetail cluster list`

Lister les releases Kubetail actuellement installees.

kubetail cluster list [flags]

Indicateurs

Flag	Default	Description
`--kube-context`		Nom du contexte kubeconfig a utiliser

Exemples

kubetail cluster list

`kubetail cluster repo`

Gerer le depot Helm des charts Kubetail (https://kubetail-org.github.io/helm-charts/).

kubetail cluster repo <subcommand>

Subcommand	Description
`add`	Ajouter le depot de charts Kubetail a Helm
`update`	Mettre a jour le depot de charts Kubetail dans Helm
`remove`	Supprimer le depot de charts Kubetail de Helm

Exemples

kubetail cluster repo add
kubetail cluster repo update
kubetail cluster repo remove

`kubetail config`

Gerer la configuration de la CLI Kubetail.

kubetail config <subcommand>

`kubetail config init`

Creer un fichier de configuration par defaut.

kubetail config init [flags]

Indicateurs

Flag	Default	Description
`--path`	`~/.kubetail/config.yaml`	Chemin cible du fichier de configuration
`--format`	`yaml`	Format du fichier de configuration (`yaml`, `json`, `toml`)
`--force`	`false`	Ecraser un fichier de configuration existant

Exemples

# Creer la configuration par defaut dans ~/.kubetail/config.yaml
kubetail config init

# Creer la configuration au format JSON
kubetail config init --format json

# Ecraser un fichier de configuration existant
kubetail config init --force

# Ecrire la configuration dans un chemin personnalise
kubetail config init --path /etc/kubetail/config.yaml

Configuration

La CLI peut etre configuree a l’aide d’un fichier de configuration YAML (ou JSON/TOML). Par defaut, il est lu depuis ~/.kubetail/config.yaml. Utilisez kubetail config init pour generer un fichier de configuration par defaut, ou passez un chemin personnalise avec l’indicateur global -c / --config.

## Kubetail CLI Configuration File
#
# This file defines the behavior for the kubetail CLI tool,
# including logs command defaults and dashboard server settings.
#

## version ##
#
# Schema version for the configuration file
#
version: 1

## general ##
#
general:

  ## kubeconfig ##
  #
  # Path to the kubeconfig file to use for CLI requests.
  # If empty, the default path (~/.kube/config) or KUBECONFIG env var is used.
  #
  # Default value: ""
  #
  kubeconfig: ""

## commands ##
#
commands:

  ## logs ##
  #
  # Settings specific to the 'logs' subcommand
  #
  logs:

    ## kube-context ##
    #
    # The specific Kubernetes context to use.
    # If empty, the current active context is used.
    #
    # Default value: ""
    #
    kube-context: ""

    ## head ##
    #
    # The number of lines to show from the beginning of the log buffer
    #
    # Default value: 10
    #
    head: 10

    ## tail ##
    #
    # The number of lines to show from the end of the log buffer
    #
    # Default value: 10
    #
    tail: 10

    ## columns ##
    #
    # Full set of output columns for 'logs' records.
    # Allowed values: timestamp,dot,node,region,zone,os,arch,namespace,pod, container
    #
    # Default value: ["timestamp", "dot"]
    #
    columns:
      - timestamp
      - dot

  ## serve ##
  #
  # Settings for the dashboard server
  #
  serve:

    ## host ##
    #
    # The network interface the server should bind to.
    #
    # Default value: localhost
    #
    host: localhost

    ## port ##
    #
    # The TCP port the server will listen on.
    #
    # Default value: 7500
    #
    port: 7500

    ## skip-open ##
    #
    # If true, the CLI will not automatically open the browser
    # when the server starts.
    #
    # Default value: false
    #
    skip-open: false

## dashboard ##
#
# Settings for the web dashboard UI
#
dashboard:

  ## columns ##
  #
  # The default columns to show when displaying log records.
  #
  # Default value: ["timestamp", "dot"]
  #
  columns:
    - timestamp
    - dot

# Kubetail CLI Configuration File
#
# Defines behavior for the kubetail CLI tool, including
# logs command defaults and dashboard server settings.

# Schema version for the configuration file
version = 1

[general]
# Path to kubeconfig. If empty, uses ~/.kube/config or KUBECONFIG env var.
kubeconfig = ""

[commands.logs]
# Specific Kubernetes context to use. If empty, uses active context.
kube-context = ""

# Number of lines to show from the beginning of the log buffer
head = 10

# Number of lines to show from the end of the log buffer
tail = 10

# Full set of output columns for 'logs' records.
# Allowed values: timestamp,dot,node,region,zone,os,arch,namespace,pod,container
columns = ["timestamp", "dot"]

[commands.serve]
# Network interface the server binds to
host = "localhost"

# TCP port the server listens on
port = 7500

# If true, don't automatically open browser when server starts
skip-open = false

[dashboard]
# The default columns to show when displaying log records.
columns = ["timestamp", "dot"]

{
  "version": 1,
  "general": {
    "kubeconfig": ""
  },
  "commands": {
    "logs": {
      "kube-context": "",
      "head": 10,
      "tail": 10,
      "columns": ["timestamp", "dot"]
    },
    "serve": {
      "host": "localhost",
      "port": 7500,
      "skip-open": false
    }
  },
  "dashboard": {
    "columns": ["timestamp", "dot"]
  }
}