tkn-dash

command module
v0.0.18 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 23, 2023 License: Apache-2.0 Imports: 24 Imported by: 0

README

tkn-dash

License Go Report Card CI

tkn-dash is a barebones, lightweight and fast alternative to Tekton Dashboard.

Some of its highlights are:

  • no deployment required: can be used as a command line tool, spinning up a local dashboard using the user's own cluster credentials.
  • can be used without cluster access, if provided with a snapshot of Tekton resources.
  • fast: while the official tekton dashboard list pages can take minutes to become interactive in clusters with thousands of tekton resources, tkn-dash is immediatelly responsive as the full list of resources is never sent to the client.
  • powered by HTMX.

Installing

  • Via go install:
go install github.com/cezarguimaraes/tkn-dash@latest
  • Self-contained executables for Linux, Windows and Mac are available on the releases page.

Usage

  • Start the server on a random port, using local kubernetes credentials and open a browser to it:

    tkn-dash -browser
    
  • On a specific port:

    tkn-dash -browser -addr :8000
    
  • Using Tekton resources snapshots - does not require cluster credentials:

    tkn-dash -browser tmp/*.json
    

    For this scenario, snapshots could have been created as follows:

    mkdir tmp
    kubectl get taskruns -o json > tmp/trs.json
    kubectl get pipelineruns -o json > tmp/prs.json
    

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL