jayjay
/
k9s
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs + release notes

mine
derailed 2019-10-03 12:08:20 -06:00
parent 1bef93b662
commit 5d92069315
2 changed files with 161 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

120
README.md
View File

@ -14,8 +14,8 @@ for changes and offers subsequent commands to interact with observed Kubernetes
[![Build Status](https://travis-ci.com/derailed/k9s.svg?branch=master)](https://travis-ci.com/derailed/k9s)
[![release](https://img.shields.io/github/release-pre/derailed/k9s.svg)](https://github.com/derailed/k9s/releases)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/mum4k/termdash/blob/master/LICENSE)
[![k9s](https://snapcraft.io/k9s/badge.svg)](https://snapcraft.io/k9s)
[![Releases](https://img.shields.io/github/downloads/derailed/k9s/total.svg)]()
<!-- [![k9s](https://snapcraft.io/k9s/badge.svg)](https://snapcraft.io/k9s)
[![Releases](https://img.shields.io/github/downloads/derailed/k9s/total.svg)]() -->
---
@ -32,10 +32,9 @@ K9s is available on Linux, OSX and Windows platforms.
```
* Building from source
K9s was built using go 1.12 or above. In order to build K9 from source you must:
K9s was built using go 1.13 or above. In order to build K9 from source you must:
1. Clone the repo
2. Set env var *GO111MODULE=on*
3. Add the following command in your go.mod file
2. Add the following command in your go.mod file
```text
replace (
@ -43,7 +42,7 @@ K9s is available on Linux, OSX and Windows platforms.
)
```
4. Build and run the executable
3. Build and run the executable
```shell
go run main.go
@ -51,21 +50,6 @@ K9s is available on Linux, OSX and Windows platforms.
---
## The Command Line
```shell
# List all available CLI options
k9s -h
# To get info about K9s runtime (logs, configs, etc..)
k9s info
# To run K9s in a given namespace
k9s -n mycoolns
# Start K9s in an existing KubeConfig context
k9s --context coolCtx
```
---
## PreFlight Checks
* K9s uses 256 colors terminal mode. On `Nix system make sure TERM is set accordingly.
@ -76,6 +60,58 @@ k9s --context coolCtx
---
## The Command Line
```shell
# List all available CLI options
k9s help
# To get info about K9s runtime (logs, configs, etc..)
k9s info
# To run K9s in a given namespace
k9s -n mycoolns
# Start K9s in an existing KubeConfig context
k9s --context coolCtx
```
---
## Key Bindings
K9s uses aliases to navigate most K8s resources.
| Command | Result | Example |
|-----------------------------|----------------------------------------------------|----------------------------|
| `:`alias`<ENTER>` | View a Kubernetes resource aliases | `:po<ENTER>` |
| `?` | Show keyboard shortcuts and help | |
| `Ctrl-a` | Show all available resource alias | select+`<ENTER>` to view |
| `/`filter`ENTER` | Filter out a resource view given a filter | `/bumblebeetuna` |
| `/`-l label-selector`ENTER` | Filter resource view by labels | `/-l app=fred` |
| `<Esc>` | Bails out of command mode | |
| `d`,`v`, `e`, `l`,... | Key mapping to describe, view, edit, view logs,... | `d` (describes a resource) |
| `:`ctx`<ENTER>` | To view and switch to another Kubernetes context | `:`+`ctx`+`<ENTER>` |
| `Ctrl-d` | To delete a resource (TAB and ENTER to confirm) | |
| `Ctrl-k` | To delete a resource (no confirmation dialog) | |
| `:q`, `Ctrl-c` | To bail out of K9s | |
---
## Demo Video
1. [K9s v0 Demo](https://youtu.be/k7zseUhaXeU)
2. [K9s v0.7.0 Features](https://youtu.be/83jYehwlql8)
## Screenshots
1. Pods
<img src="assets/screen_po.png"/>
1. Logs
<img src="assets/screen_logs.png"/>
1. Deployments
<img src="assets/screen_dp.png"/>
---
## K9s config file ($HOME/.k9s/config.yml)
K9s keeps its configurations in a dot file in your home directory.
@ -117,7 +153,7 @@ k9s --context coolCtx
---
## Benchmarking (Preview!)
## Benchmarking
K9s integrates [Hey](https://github.com/rakyll/hey) from the brilliant and super talented [Jaana Dogan](https://github.com/rakyll) of Google fame. Hey is a CLI tool to benchmak HTTP endpoints similar to AB bench. This preliminary feature currently supports benchmarking port-forwards and services (Read the paint on this is way fresh!).
@ -179,44 +215,6 @@ benchmarks:
password: Zorg!
```
---
## Key Bindings
K9s uses aliases to navigate most K8s resources.
| Command | Result | Example |
|-----------------------------|----------------------------------------------------|----------------------------|
| `:`alias`<ENTER>` | View a Kubernetes resource aliases | `:po<ENTER>` |
| `?` | Show keyboard shortcuts and help | |
| `Ctrl-a` | Show all available resource alias | select+`<ENTER>` to view |
| `/`filter`ENTER` | Filter out a resource view given a filter | `/bumblebeetuna` |
| `/`-l label-selector`ENTER` | Filter resource view by labels | `/-l app=fred` |
| `<Esc>` | Bails out of command mode | |
| `d`,`v`, `e`, `l`,... | Key mapping to describe, view, edit, view logs,... | `d` (describes a resource) |
| `:`ctx`<ENTER>` | To view and switch to another Kubernetes context | `:`+`ctx`+`<ENTER>` |
| `Ctrl-d` | To delete a resource (TAB and ENTER to confirm) | |
| `Ctrl-k` | To delete a resource (no confirmation dialog) | |
| `:q`, `Ctrl-c` | To bail out of K9s | |
---
## Demo Video
1. [K9s v0 Demo](https://youtu.be/k7zseUhaXeU)
2. [K9s v0.7.0 Features](https://youtu.be/83jYehwlql8)
## Screenshots
1. Pods
<img src="assets/screen_po.png"/>
1. Logs
<img src="assets/screen_logs.png"/>
1. Deployments
<img src="assets/screen_dp.png"/>
---
## K9s RBAC FU
@ -450,7 +448,6 @@ K9s sits on top of many of opensource projects and libraries. Our *sincere*
appreciations to all the OSS contributors that work nights and weekends
to make this project a reality!
---
## Contact Info
@ -458,7 +455,6 @@ to make this project a reality!
1. **Email**: fernand@imhotep.io
2. **Twitter**: [@kitesurfer](https://twitter.com/kitesurfer?lang=en)
---
<img src="assets/imhotep_logo.png" width="32" height="auto"/> © 2019 Imhotep Software LLC. All materials licensed under [Apache v2.0](http://www.apache.org/licenses/LICENSE-2.0)

103
change_logs/release_0.9.0.md Normal file
View File

@ -0,0 +1,103 @@
<img src="https://raw.githubusercontent.com/derailed/k9s/master/assets/k9s_small.png" align="right" width="200" height="auto"/>
# Release v0.9.0
## Notes
Thank you to all that contributed with flushing out issues and enhancements for 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! If you've filed an issue please help me verify and close. Your support, kindness and awesome suggestions to make K9s better is as ever very much noticed and appreciated!
Also if you dig this tool, please make some noise on social! [@kitesurfer](https://twitter.com/kitesurfer)
---
## Change Logs
A lots of changes here in 0.9.0!! Please watch out for potential disturbance in the force as much code changed on this drop...
Figured, I'll put a quick video out for you to checkout the latest [K9s V0.9.0](https://www.youtube.com/watch?v=bxKfqumjW4I)
### Support K8s 1.16
As you might have heard K8s had a big drop with 1.16 so we've added client/server support this new kubernetes release.
### Alias Alas!
K9s now supports standard kubernetes short name. Major shoutout to [Gustavo](https://github.com/paivagustavo) for making this painful change happen!
With this change is place you can now use all standard K8s short names along with defining your own. You can now define a new alias file aka `alias.yml` in your k9s home directory `$HOME/.k9s`. An alias is made up of a command and a group/version/resource aka GVR specification as follows:
```yaml
alias:
fred: apps/v1/deployments # Typing fred while in command mode will list out deployments
pp: v1/pods # Typing pp while in command mode will list out pods
```
### Plug For Plugins
As of this release and based on some users feedback we've moved the plugin section that used to live in the main K9s configuration file out to it's own file. So as of this release we've added a new file in K9s home dir called `plugin.yml`. This is where you will define/share your K9s plugins and define your own commands and menu mnemonics. Here is an example for defining a custom command to show logs.
```yaml
# plugin.yml
plugin:
fred:
shortCut: Ctrl-L
description: "Pod logs"
scopes:
- po
command: /usr/local/bin/kubectl
background: false
args:
- logs
- -f
- $NAME
- -n
- $NAMESPACE
- --context
- $CONTEXT
```
Special K9s env vars you will have access to are currently for your commands or shell scripts are as follows:
* NAMESPACE
* NAME
* CLUSTER
* CONTEXT
* USER
* GROUPS
* COL[0-9+]
I will setup an plugin/alias repo so we can share these with all K9sers. Please ping me if interested in contributing/sharing your commands. Thank you!!
### Aye Aye Capt'ain!!
Hopefully improved overall navigation...
#### Real Estate
This release allows you to maximize screen real estate via 2 combos. First, the command/filter prompt is now hidden. To enter commands or filters you can type `:` or `/` to type your commands. Second, you can toggle the header using `CTRL-H`.
#### Bett'a ShortCuts
You can now use commands like `svc fred` while in command mode to directly navigate to a resource in a given namespace. Likewise to switch contexts you can now enter `ctx blee` to switch out clusters.
#### Sticky Filters
You can now keep filters sticky allowing you to filter a view bases on regex, fuzzy or labels and keep the filter live while switching resources. This provides for an horizontal navigation to view the various resources for a given application. Thank you so much [Nobert](https://github.com/ncsibra) for your continuous awesome feedback!!
### New Resources
Added support for StorageClass, you can now view this resource and describe it directly in K9s. Major shoutout to [Oscar F](https://github.com/fridokus), zero go chops and yet managed to push this PR thru with minimal suppport. You Sir, blew me away. Thank you!!
---
## Resolved Bugs/Features
* [Issue #318](https://github.com/derailed/k9s/issues/318)
* [Issue #303](https://github.com/derailed/k9s/issues/303)
* [Issue #301](https://github.com/derailed/k9s/issues/301)
* [Issue #300](https://github.com/derailed/k9s/issues/300)
* [Issue #276](https://github.com/derailed/k9s/issues/276)
* [Issue #268](https://github.com/derailed/k9s/issues/268)
---
<img src="https://raw.githubusercontent.com/derailed/k9s/master/assets/imhotep_logo.png" width="32" height="auto"/> © 2019 Imhotep Software LLC. All materials licensed under [Apache v2.0](http://www.apache.org/licenses/LICENSE-2.0)