Referencia da CLI

A CLI kubetail e o principal ponto de entrada do Kubetail no seu desktop. Voce pode usa-la para iniciar o dashboard web, transmitir logs para o terminal ou gerenciar recursos do Kubetail no cluster.

Flags globais

Estas flags estao disponiveis em todos os comandos:

Flag	Default	Description
`--kubeconfig`		Caminho para o arquivo kubeconfig
`--in-cluster`	`false`	Usar configuracao Kubernetes in-cluster
`-c, --config`	`~/.kubetail/config.yaml`	Caminho para o arquivo de configuracao

Comandos

`kubetail serve`

Inicie o dashboard server e abra a Web UI no navegador padrao.

kubetail serve [flags]

Flags

Flag	Default	Description
`-p, --port`	`7500`	Numero da porta a escutar
`--host`	`localhost`	Endereco do host ao qual se vincular
`-l, --log-level`	`info`	Nivel de log (`debug`, `info`, `warn`, `error`, `disabled`)
`--skip-open`	`false`	Nao abrir o navegador

Exemplos

# Iniciar o dashboard (abre em http://localhost:7500)
kubetail serve

# Usar uma porta personalizada
kubetail serve --port 8080

# Iniciar sem abrir o navegador
kubetail serve --skip-open

`kubetail logs`

Buscar logs de um contêiner ou de um conjunto de workload containers.

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

Fontes

Uma fonte identifica de quais Pods ou contêineres os logs devem ser transmitidos. As fontes usam a seguinte sintaxe:

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

Example	Description
`web-abc123`	Pod chamado `web-abc123` no namespace padrao
`deployments/web`	Deployment `web` no namespace padrao
`deployments/*`	Todos os Deployments no namespace padrao
`deployments/web/container1`	Contêiner especifico em um Deployment
`deployments/web/*`	Todos os contêineres em um Deployment
`frontend:web-abc123`	Pod no namespace `frontend`
`frontend:deployments/web`	Deployment no namespace `frontend`

Varias fontes podem ser especificadas:

kubetail logs <source1> <source2>

Flags

Flag	Default	Description
`--kube-context`		Contexto kubeconfig a usar
`-h, --head[=N]`	`10`	Retornar os primeiros N registros
`-t, --tail[=N]`	`10`	Retornar os ultimos N registros
`--all`	`false`	Retornar todos os registros
`-f, --follow`	`false`	Transmitir novos registros
`--since`		Incluir registros a partir do ponto especificado (inclusivo)
`--until`		Incluir registros ate o ponto especificado (inclusivo)
`--after`		Incluir registros estritamente apos o ponto especificado
`--before`		Incluir registros estritamente antes do ponto especificado
`-g, --grep`		Filtrar registros por expressao regular (requer `--force`)
`--region`		Filtrar Pods de origem por region (separado por virgulas)
`--zone`		Filtrar Pods de origem por zona (separado por virgulas)
`--os`		Filtrar Pods de origem por sistema operacional (separado por virgulas)
`--arch`		Filtrar Pods de origem por arquitetura de CPU (separado por virgulas)
`--node`		Filtrar Pods de origem por nome do no (separado por virgulas)
`--raw`	`false`	Exibir apenas mensagens de log brutas, sem metadados
`--columns`		Definir colunas de saida (sobrescreve os padroes)
`--add-columns`		Adicionar colunas de saida aos padroes
`--remove-columns`		Remover colunas de saida dos padroes
`--with-cursors`	`false`	Mostrar cursores de paginacao
`--hide-header`	`false`	Ocultar o cabecalho da tabela
`--all-containers`	`false`	Mostrar logs de todos os contêineres em um Pod
`--force`	`false`	Forcar o comando (requerido ao usar `--grep`)

As flags --columns, --add-columns e --remove-columns aceitam uma lista de nomes de colunas separada por virgulas: timestamp, dot, node, region, zone, os, arch, namespace, pod, container.

As flags --head, --tail e --all sao mutuamente exclusivas. As flags --since e --after tambem sao mutuamente exclusivas, assim como --until e --before.

As flags --since, --until, --after e --before aceitam:

Um timestamp ISO 8601 (por exemplo, 2006-01-02T15:04:05Z07:00)
Uma duracao ISO 8601 relativa a agora (por exemplo, PT30M para 30 minutos atras) - apenas para --since e --until

Comportamento padrao: modo tail (ultimos 10 registros), a menos que --since seja especificado, caso em que o modo head e usado.

Exemplos

# Fazer tail dos ultimos 10 registros de um Pod
kubetail logs nginx

# Fazer tail de um Deployment
kubetail logs deployments/web

# Seguir novos registros
kubetail logs deployments/web --follow

# Retornar todos os registros e continuar seguindo
kubetail logs deployments/web --all --follow

# Retornar os primeiros 100 registros
kubetail logs nginx --head=100

# Retornar registros dos ultimos 30 minutos
kubetail logs nginx --since PT30M --all

# Retornar registros entre dois timestamps
kubetail logs nginx --since 2006-01-02T15:04:05Z --until 2007-01-02T15:04:05Z --all

# Filtrar por regex (requer --force)
kubetail logs nginx --grep "GET /about" --force

# Filtrar Pods por region
kubetail logs deployments/web --region=us-east-1

# Exibir apenas mensagens de log brutas
kubetail logs nginx --raw

`kubetail cluster`

Gerencie recursos do Kubetail no cluster usando Helm internamente (o Helm nao precisa ser instalado separadamente).

kubetail cluster <subcommand> [flags]

`kubetail cluster install`

Criar um novo release do Kubetail no cluster.

kubetail cluster install [flags]

Flags

Flag	Default	Description
`--kube-context`		Nome do contexto kubeconfig a usar

Exemplos

kubetail cluster install

`kubetail cluster upgrade`

Atualizar um release existente do Kubetail para a versao mais recente do chart disponivel localmente.

kubetail cluster upgrade [flags]

Flags

Flag	Default	Description
`--kube-context`		Nome do contexto kubeconfig a usar

Exemplos

kubetail cluster upgrade

`kubetail cluster uninstall`

Remover um release existente do Kubetail do cluster.

kubetail cluster uninstall [flags]

Flags

Flag	Default	Description
`--kube-context`		Nome do contexto kubeconfig a usar

Exemplos

kubetail cluster uninstall

`kubetail cluster list`

Listar os releases do Kubetail atualmente instalados.

kubetail cluster list [flags]

Flags

Flag	Default	Description
`--kube-context`		Nome do contexto kubeconfig a usar

Exemplos

kubetail cluster list

`kubetail cluster repo`

Gerenciar o repositorio de charts Helm do Kubetail (https://kubetail-org.github.io/helm-charts/).

kubetail cluster repo <subcommand>

Subcommand	Description
`add`	Adicionar o repositorio de charts do Kubetail ao Helm
`update`	Atualizar o repositorio de charts do Kubetail no Helm
`remove`	Remover o repositorio de charts do Kubetail do Helm

Exemplos

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

`kubetail config`

Gerenciar a configuracao da CLI do Kubetail.

kubetail config <subcommand>

`kubetail config init`

Criar um arquivo de configuracao padrao.

kubetail config init [flags]

Flags

Flag	Default	Description
`--path`	`~/.kubetail/config.yaml`	Caminho de destino do arquivo de configuracao
`--format`	`yaml`	Formato do arquivo de configuracao (`yaml`, `json`, `toml`)
`--force`	`false`	Sobrescrever um arquivo de configuracao existente

Exemplos

# Criar a configuracao padrao em ~/.kubetail/config.yaml
kubetail config init

# Criar a configuracao em formato JSON
kubetail config init --format json

# Sobrescrever um arquivo de configuracao existente
kubetail config init --force

# Gravar a configuracao em um caminho personalizado
kubetail config init --path /etc/kubetail/config.yaml

Configuracao

A CLI pode ser configurada usando um arquivo de configuracao YAML (ou JSON/TOML). Por padrao, ele e lido de ~/.kubetail/config.yaml. Use kubetail config init para gerar um arquivo de configuracao padrao ou passe um caminho personalizado com a flag 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"]
  }
}