Updated README and release notes
derailed
parent
3ff2f64255
commit
2fa5efafe7
50
README.md
50
README.md
|
|
@ -34,22 +34,52 @@ brew tap derailed/k9s && brew install k9s
|
|||
<br/>
|
||||
|
||||
---
|
||||
## Command Line Options
|
||||
## Command Line
|
||||
|
||||
* --namespace(-n) change the default namespace
|
||||
* --refresh(-r) changes the default(2sec) refresh
|
||||
To show all available options from the cli use:
|
||||
|
||||
```shell
|
||||
k9s -h
|
||||
```
|
||||
|
||||
<br/>
|
||||
|
||||
---
|
||||
## PreFlight
|
||||
## PreFlight Checks
|
||||
|
||||
* K9s uses 256 colors terminal mode. On OSX make sure TERM is set accordingly.
|
||||
* K9s uses 256 colors terminal mode. On `Nix system make sure TERM is set accordingly.
|
||||
|
||||
```shell
|
||||
export TERM=xterm-256color
|
||||
```
|
||||
|
||||
* For clusters with many namespaces you can either edit ~/.k9s/config.yml or
|
||||
go to the namespace(ns) view to switch your default namespace to your namespace
|
||||
of choice using *Ctrl-S*witch. K9s will keep your top 5 favorite namespaces.
|
||||
Namespaces will get evicted based on your namespace switching frequency.
|
||||
|
||||
|
||||
```yaml
|
||||
k9s:
|
||||
refreshRate: 5 # K9s refresh rate in secs
|
||||
logBufferSize: 200 # Size of the logs buffer. Try to keep a sensible default!
|
||||
namespace:
|
||||
active: myCoolNS # Current active namespace name
|
||||
favorites: # List of your 5 most frequently used namespaces
|
||||
- myCoolNS1
|
||||
- myCoolNS2
|
||||
- all
|
||||
- default
|
||||
- kube-system
|
||||
view:
|
||||
active: po # Active resource view
|
||||
```
|
||||
|
||||
* K9s can use **$KUBECONFIG** env var to load cluster information. However we've
|
||||
seen hill effects of using this env with multiple files as setting the current
|
||||
context may not update the correct file when using this technique.
|
||||
|
||||
|
||||
---
|
||||
<br/>
|
||||
|
||||
|
|
@ -57,7 +87,7 @@ brew tap derailed/k9s && brew install k9s
|
|||
## Commands
|
||||
|
||||
+ K9s uses 2 or 3 letters alias to navigate most K8s resource
|
||||
+ At any time you can use `?<Enter>` to look up the various commands
|
||||
+ At any time you can use `?` to look up the various commands
|
||||
+ Use `alias<Enter>` to activate a resource under that alias
|
||||
+ `Ctrl` sequences are used to view, edit, delete, ssh ...
|
||||
+ Use `ctx<Enter>` to switch between clusters
|
||||
|
|
@ -109,12 +139,8 @@ dig this effort, please let us know that too!
|
|||
---
|
||||
## ATTA Girls/Boys!
|
||||
|
||||
k9s sits on top of two very cool GO projects that provides the much needed terminal
|
||||
support. So big thanks and shootout to the good folks at tcell+tview for
|
||||
making k9s a reality!!
|
||||
|
||||
+ [tcell](https://github.com/gdamore/tcell)
|
||||
+ [tview](https://github.com/rivo/tview)
|
||||
k9s sits on top of on a lot of opensource projects. So *big thanks* to all the
|
||||
contributors that made this project a reality!
|
||||
|
||||
|
||||
<br/>
|
||||
|
|
|
|||
|
|
@ -1,16 +1,49 @@
|
|||
# Release v0.1.1
|
||||
|
||||
<br/>
|
||||
|
||||
---
|
||||
## Notes
|
||||
|
||||
Thank you to all that contributed with flushing out issues with K9s! I'll try
|
||||
to mark some of these issues as fixed. But if you don't mind grab the latest
|
||||
rev and see if we're happier with some of the fixes!
|
||||
|
||||
<br/>
|
||||
|
||||
---
|
||||
## Change Logs
|
||||
|
||||
+ Added config file to tracks K9s configs
|
||||
+ Changed namespace management to track top 5 most recent namespaces.
|
||||
+ Changed keyboard naviation on log view
|
||||
+ Added log buffer to default to the last 200 lines (settable in config file)
|
||||
+ Added fail early countermeasures.
|
||||
+ Added info sub-command to show K9s general info
|
||||
+ Added log level setting on CLI
|
||||
+ Changed help command to just ? and back to escape
|
||||
+ Added config file to tracks K9s configuration ~/.k9s/config.yml
|
||||
+ Changeg log file location to use Go tmp dir stdlib package.
|
||||
Check the log destination and config file location using
|
||||
```shell
|
||||
k9s info
|
||||
```
|
||||
+ Removed 9 namespaces limitation by allowing user to manage namespaces using
|
||||
the namespace view or the dotfile configuration.
|
||||
+ Updated keyboard navigation on log view. Up/Down, PageUp/PageDown
|
||||
+ Added configuration to manage buffer size while viewing container logs
|
||||
+ Added fail early countermeasures. Hopefully will help us figure out non starts??
|
||||
+ Beefed up CLI arguments
|
||||
+ Changed help command to just ?
|
||||
+ Changed back command to just Esc
|
||||
+ Added filtering feature to trim down viewed resources
|
||||
Use **/**term or **Esc** to kill filtering
|
||||
|
||||
## Bugs
|
||||
<br/>
|
||||
|
||||
+
|
||||
---
|
||||
## Resolved Bugs
|
||||
|
||||
+ [Issue 17] Multi user log usage. Added user descriptor on log files
|
||||
+ [Issue 18] Non starts due to color. Added preflight item on README.
|
||||
+ [Issue 13] ? does not do anything.
|
||||
+ [Issue 8] Don't reset selection after deletion.
|
||||
+ [Issue 1,7] Limit available namespaces. Added config file to manage top 5 namespaces
|
||||
and also added a switch command while in the namespace resource view.
|
||||
+ [Issue 6] Sorting/filtering. Added preliminary filtering capability. Raw search
|
||||
on table item using /filter_me command. Use Esc to turn off filtering.
|
||||
+ [Issue 5] Scrolling in log view. Added up/down/pageUp/pageDown.
|
||||
+ [Issue 3] No output when failing. Added fail early countermeasures. Hopefully
|
||||
will give us a heads up now to track down config issues??
|
||||
|
|
|
|||
|
|
@ -8,7 +8,6 @@ import (
|
|||
"github.com/derailed/k9s/resource"
|
||||
"github.com/gdamore/tcell"
|
||||
"github.com/k8sland/tview"
|
||||
log "github.com/sirupsen/logrus"
|
||||
)
|
||||
|
||||
const (
|
||||
|
|
|
|||
Loading…
Reference in New Issue