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

update docs

mine
derailed 2020-05-23 11:42:10 -06:00
parent 46c2f31249
commit 01cdc5b86e
2 changed files with 42 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -3,7 +3,7 @@ PACKAGE := github.com/derailed/$(NAME)
GIT := $(shell git rev-parse --short HEAD) GIT := $(shell git rev-parse --short HEAD)
SOURCE_DATE_EPOCH ?= $(shell date +%s) SOURCE_DATE_EPOCH ?= $(shell date +%s)
DATE := $(shell date -u -d @${SOURCE_DATE_EPOCH} +%FT%T%Z) DATE := $(shell date -u -d @${SOURCE_DATE_EPOCH} +%FT%T%Z)
VERSION ?= v0.19.1 VERSION ?= v0.19.7
IMG_NAME := derailed/k9s IMG_NAME := derailed/k9s
IMAGE := ${IMG_NAME}:${VERSION} IMAGE := ${IMG_NAME}:${VERSION}

79
README.md
View File

@ -63,35 +63,38 @@ K9s is available on Linux, macOS and Windows platforms.
scoop install k9s scoop install k9s
``` ```
* Building from source * Via a GO install
K9s was built using go 1.13 or above. In order to build K9 from source you must:
1. Clone the repo
2. Add the following command in your go.mod file
```text ```shell
replace ( # NOTE: The dev version will be in effect!
github.com/derailed/k9s => MY_K9S_CLONED_GIT_REPO go get -u github.com/derailed/k9s
) ```
---
## Building From Source
K9s is currently using go v1.14 or above. In order to build K9 from source you must:
1. Clone the repo
2. Build and run the executable
```shell
make build && ./k9s
``` ```
3. Build and run the executable ---
```shell
go run main.go
```
---
## Running with Docker ## Running with Docker
You can run k9s as a Docker container by mounting your `KUBECONFIG`: You can run k9s as a Docker container by mounting your `KUBECONFIG`:
```shell ```shell
docker run --rm -it -v $KUBECONFIG:/root/.kube/config derailed/k9s docker run --rm -it -v $KUBECONFIG:/root/.kube/config derailed/k9s
``` ```
For default path it would be: For default path it would be:
```shell ```shell
docker run --rm -it -v ~/.kube/config:/root/.kube/config derailed/k9s docker run --rm -it -v ~/.kube/config:/root/.kube/config derailed/k9s
``` ```
@ -158,25 +161,25 @@ k9s -l debug
K9s uses aliases to navigate most K8s resources. K9s uses aliases to navigate most K8s resources.
| Action | Command | Comment | | Action | Command | Comment |
|---------------------------------------------------------------|-----------------------|-------------------------------------------------------------| |---------------------------------------------------------------|-------------------------------|------------------------------------------------------------------------|
| Show active keyboard mnemonics and help | `?` | | | Show active keyboard mnemonics and help | `?` | |
| Show all available resource alias | `ctrl-a` | | | Show all available resource alias | `ctrl-a` | |
| To bail out of K9s | `:q`, `ctrl-c` | | | To bail out of K9s | `:q`, `ctrl-c` | |
| View a Kubernetes resource using singular/plural or shortname | `:`po⏎ | accepts singular, plural, shortname or alias ie pod or pods | | View a Kubernetes resource using singular/plural or shortname | `:`po⏎ | accepts singular, plural, shortname or alias ie pod or pods |
| View a Kubernetes resource in a given namespace | `:`alias namespace⏎ | | | View a Kubernetes resource in a given namespace | `:`alias namespace⏎ | |
| Filter out a resource view given a filter | `/`filter⏎ | | | Filter out a resource view given a filter | `/`filter⏎ | |
| Filter resource view by labels | `/`-l label-selector⏎ | | | Filter resource view by labels | `/`-l label-selector⏎ | |
| Fuzzy find a resource given a filter | `/`-f filter⏎ | | | Fuzzy find a resource given a filter | `/`-f filter⏎ | |
| Bails out of view/command/filter mode | `<esc>` | | | Bails out of view/command/filter mode | `<esc>` | |
| Key mapping to describe, view, edit, view logs,... | `d`,`v`, `e`, `l`,... | | | Key mapping to describe, view, edit, view logs,... | `d`,`v`, `e`, `l`,... | |
| To view and switch to another Kubernetes context | `:`ctx⏎ | | | To view and switch to another Kubernetes context | `:`ctx⏎ | |
| To view and switch to another Kubernetes context | `:`ctx context-name⏎ | | | To view and switch to another Kubernetes context | `:`ctx context-name⏎ | |
| To view and switch to another Kubernetes namespace | `:`ns⏎ | | | To view and switch to another Kubernetes namespace | `:`ns⏎ | |
| To view all saved resources | `:`screendump or sd⏎ | | | To view all saved resources | `:`screendump or sd⏎ | |
| To delete a resource (TAB and ENTER to confirm) | `ctrl-d` | | | To delete a resource (TAB and ENTER to confirm) | `ctrl-d` | |
| To kill a resource (no confirmation dialog!) | `ctrl-k` | | | To kill a resource (no confirmation dialog!) | `ctrl-k` | |
| Launch pulses view | `:`pulses or pu⏎ | | | Launch pulses view | `:`pulses or pu⏎ | |
| Launch XRay view | `:`xray RESOURCE [NAMESPACE]⏎ | RESOURCE can be one of po, svc, dp, rs, sts, ds, NAMESPACE is optional | | Launch XRay view | `:`xray RESOURCE [NAMESPACE]⏎ | RESOURCE can be one of po, svc, dp, rs, sts, ds, NAMESPACE is optional |
--- ---