kubetui

Kubetui is a terminal user interface (TUI) tool designed for monitoring Kubernetes resources.
It provides an easy-to-use interface for developers and operators to access important information about their applications and infrastructure.

Features

Kubetui offers the following features to help you monitor and manage your Kubernetes resources:

• Pods List and Container Logs:
  • View a list of pods and their container logs.
  • JSON logs display mode switching: toggle between pretty print and single-line display using the f or p keys.
• ConfigMap and Secret Watching: Monitor ConfigMaps and secrets, and decode their data.
• Network-related Resources: Explore a list of network-related resources and their descriptions.
• Events Watching: Stay updated with a real-time view of Kubernetes events.
• Specific Resources Watching (List / YAML): View specific resources in list or YAML format.
• Namespace Multiple Selections: Select and view multiple namespaces simultaneously.
• Context Selection: Change the Kubernetes context you want to operate on.
• Clipboard Support (Text Copy): Copy text conveniently using mouse actions.
• Mouse Event Support: Leverage mouse events for a smoother user experience.
• Search Functionality: Easily search for specific keywords within the interface.
• Item Filtering: Filter items based on multiple keywords separated by spaces.
• Customizable UI Appearance: Modify the appearance of the UI, including border styles, colors, and text attributes.

Overall, kubetui is a powerful tool designed to provide a safe and efficient way to access and monitor your Kubernetes resources. With its user-friendly interface and comprehensive features, it simplifies the process of managing your applications and infrastructure.

Installation

To install kubetui, you can use the following methods:

Homebrew on macOS and Linux

Kubetui is available on homebrew, the package manager for macOS and Linux. Install it by running the following command:

brew install kubetui

Pacman on Arch Linux

Kubetui is available in the official repositories. Install it by running the following command:

pacman -S kubetui

Scoop on Windows

If you are using Windows with scoop, you can add the necessary buckets and install kubetui with the following commands:

# Add the 'extras' bucket for vcredist2022
scoop bucket add extras
scoop bucket add <bucket> https://github.com/sarub0b0/scoop-bucket
scoop install <bucket>/kubetui

WinGet on Windows

If you prefer using winget, the Windows package manager, you can install kubetui with the following command:

winget install kubetui

Chocolatey on Windows

Kubetui is available on Chocolatey, the package manager for Windows. Install it by running the following command:

choco install kubetui

openSUSE Tumbleweed

For openSUSE Tumbleweed, you can install kubetui using the zypper package manager. Run the following command to install:

zypper install kubetui

Using cargo install

Kubetui is available on crates.io, the official Rust package registry. Install it by running the following command:

cargo install kubetui

Make sure you have Rust and Cargo installed before running the command.

Downloading the binary

Alternatively, you can download the precompiled binary from the GitHub Release page that matches your operating system. Once downloaded, you can run the binary directly without any additional installation steps.

Choose the method that suits your needs and preferences.

Usage

kubetui

$ kubetui -h
An intuitive Terminal User Interface (TUI) tool for real-time monitoring and exploration of Kubernetes
resources.

Usage: kubetui [OPTIONS]

Options:
  -h, --help                           Print help
  -V, --version                        Print version
  -A, --all-namespaces[=<true|false>]  Select all namespaces [default: false]
  -c, --context <CONTEXT>              Context
  -C, --kubeconfig <KUBECONFIG>        kubeconfig path
      --config-file <CONFIG_FILE>      Config file path
  -l, --logging                        Logging
  -n, --namespaces <NAMESPACES>        Namespaces (e.g. -n val1,val2,val3 | -n val1 -n val2 -n val3)
  -s, --split-direction <v|h>          Window split direction [default: v]

Custom Configuration

You can customize the UI appearance by specifying a configuration file using the --config-file flag:

kubetui --config-file /path/to/your/config.yaml

The configuration file can also be located at ~/.config/kubetui/config.yaml or $XDG_CONFIG_FILE/kubetui/config.yaml.

The configuration file allows you to modify various aspects of the UI, including:

• Border Styles: Customize the border styles of different UI components.
• Colors: Change the colors of text, backgrounds, and borders.
• Text Attributes: Modify text attributes such as bold, italic, and underline.

A sample configuration file is available at examples/config.yaml to help you get started with customizing the UI.

Log Query

The Log Query feature empowers you to retrieve logs from multiple Pods and their containers. Using regular expressions, selectors, and specified resources, you can precisely define the log retrieval targets. This functionality also allows you to filter logs using regular expressions, providing a powerful and flexible log querying experience.

Usage Example

pod:app container:nginx log:401

When entering ? or help in the log query form, the help dialog will be displayed.

Supported Queries

Supported resources:

Query String Escaping

When including spaces in queries such as <regex> or <selector>, enclose the string with " or '. For example:

pod:"a b"
label:"environment in (production, qa)"

If you use ", ', or \ within the quoted string, escape them with \. For example:

pod:"a\\b"

**Lexer and Parser**

LOG_QUERIES = QUERY ( " "  QUERY )*

QUERY = POD
        | EXCLUDE_POD
        | CONTAINER
        | EXCLUDE_CONTAINER
        | LOG
        | EXCLUDE_LOG
        | LABEL
        | FIELD
        | SPECIFIED_RESOURCE

POD = ( "pods" | "pod" | "po" | "p" ) ":" REGEX
EXCLUDE_POD = "!" POD

CONTAINER = ( "containers" | "container" | "co" | "c" ) ":" REGEX
EXCLUDE_CONTAINER = "!" CONTAINER

LOG = ( "logs" | "log" | "lo" | "l" ) ":" REGEX
EXCLUDE_LOG = "!" LOG

REGEX = QUOTED_STRING | UNQUOTED_STRING

LABEL = ( "labels" | "label" ) ":" SELECTOR
FIELD = ( "fields" | "field" ) ":" SELECTOR

SELECTOR = QUOTED_STRING | UNQUOTED_STRING

SPECIFIED_RESOURCE = RESOURCE "/" NAME

RESOURCE = ( "pods" | "pod" | "po" )
           | ( "replicasets" | "replicaset" | "rs" )
           | ( "deployments" | "deployment" | "deploy" )
           | ( "statefulsets" | "statefulset" | "sts" )
           | ( "daemonsets" | "daemonset" | "ds" )
           | ( "services" | "service" | "svc" )
           | ( "jobs" | "job" )

NAME = ALPHANUMERIC ( ALPHANUMERIC | "-" | "." )* ALPHANUMERIC

UNQUOTED_STRING = ~['" \t\r\n] ( ~[ \t\r\n] )* // without spaces

QUOTED_STRING = "\"" ESCAPED_STRING "\"" | "'" ESCAPED_STRING "'"

ESCAPED_STRING = ( ESCAPED_CHAR | ~[\"'] )\*

ESCAPED_CHAR = "\\" | "\"" | "\'"

Key Bindings

General

Key Map

View Control

Text View

Search Mode

Table View

Dialog

Input Form

Container Logs View

Contributing

Bug reports and pull requests are welcome.

License

This software is available as open source under the terms of the MIT License.