kgv's Introduction

KGV

KGV is Kubernetes Global View or an acronym for GVK. It's a Terminal UI for observing and manipulating Kubernetes resources.

Features

rhai-based data extraction for table views. Write a small script to extract the data for each column for a given GVK. Data extraction is parallel.
Rhai module support. Use imports and reuse the code.
Detail view templates are defined as Handlebars HTML templates, rendered against the resource context, and then converted to ASCII using cursive-markup.
Live reloading support for the rhai engine and templates.
Live updates for the detail, YAML, and list views.
Collecting initial GVK resource names is cached. Startup on overprovisioned or overloaded k8s installations is faster.
Multiple window support. Open multiple windows (logs, list views, list details views, or just details views) and switch between them. Switching is instant.
Custom user dirs support. Specify your modules and templates dirs with CMD arguments.

Screenshots

Minor features

Rhai debugs are transferred to the main debug window
Handlebars template includes and inheritance support
YAML partial code extractors for Handlebars (use to_yaml helper)

Hotkeys

~: Show Debug Console
Esc: Close the current window
Ctrl+s: execute kubectl exec -it
Alt+=: Show windows view
Ctrl+p: Dump rhai object to temp
F5: Refresh the view (clears deleted items)
Ctrl+y: Show Resource YAML view
Ctrl+/: Show a list of registered GVKs
Ctrl+k: Delete current selected resource
Ctrl+l: Show logs for the selected resource
Ctrl+f: Show Port Forwarding dialog for the selected pod
Ctrl+g: Show active Port Forwards

Run

RUST_BACKTRACE=1 cargo run -- --module-dirs ./default_config/modules --extractor-dirs ./default_config/views/list  --detail-template-dirs ./default_config/views/detail

Adding new Resource / GVK support

Describe the Resource List view YAML. Top-level sections are:
- resource: there you describe Group, Version, Kind
- imports: automatically prepend for each column evaluator script these lines
- pseudo_resources: an extractor for nested resource list (return a list of PseudoResource items; for Pod pseudo-resource is a container)
- events: show either a pseudo resource table or an HTML detail template
- columns: a list of column evaluators with column names
- details: for HTML-based views specify a root template and rhai helpers
If you need an HTML detail view, describe templates. Includes and template inheritance is supported.
When writing column evaluators, use Ctrl+P hotkey to extract currently selected resource as a rhai object.

TODO

kgv's People

Contributors

Stargazers

Watchers

kgv's Issues

Azure login support

Hello, just tried your tool, but had this error:

Error: auth error: failed exec auth: The azure auth plugin is not supported; use https://github.com/Azure/kubelogin instead

Caused by:
    failed exec auth: The azure auth plugin is not supported; use https://github.com/Azure/kubelogin instead

I guess it's not usable for Azure yet?