|
| 1 | +<img src="assets/logo_w.png"> |
| 2 | + |
| 3 | +# K9s - Kubernetes Screens |
| 4 | + |
| 5 | +A Kubernetes CLI written in GO and curses to interact with your clusters. The initial |
| 6 | +aim of this project is to make it simpler to navigate and diagnose a cluster. |
| 7 | + |
| 8 | +<br/> |
| 9 | + |
| 10 | +--- |
| 11 | + |
| 12 | +[](https://goreportcard.com/report/github.com/k8sland/k9s) |
| 13 | +[](https://travis-ci.org/k8sland/k9s) |
| 14 | + |
| 15 | + |
| 16 | +<br/> |
| 17 | + |
| 18 | +--- |
| 19 | +## Description |
| 20 | + |
| 21 | +K9s is a CLI for Kubernetes. It provides a bit more information about your cluster |
| 22 | +than *kubectl* while allowing to perform primordial Kubernetes commands with |
| 23 | +ease. |
| 24 | + |
| 25 | +At the time of this writing, K9s only supports a subset of all available Kubernetes |
| 26 | +resources. More will be added soon (please PR us to add your favorite resource!) |
| 27 | + |
| 28 | +<br/> |
| 29 | + |
| 30 | +--- |
| 31 | +## Installation |
| 32 | + |
| 33 | +### Homebrew (OSX) |
| 34 | + |
| 35 | +```shell |
| 36 | +brew tap k8sland/k9s https://github.com/k8sland/k9s-homebrew-tap.git |
| 37 | +brew install k9s |
| 38 | +``` |
| 39 | + |
| 40 | +### Binary Releases |
| 41 | + |
| 42 | +- [Releases](https://github.com/k8sland/k9s/releases) |
| 43 | + |
| 44 | + |
| 45 | + |
| 46 | +<br/> |
| 47 | + |
| 48 | +--- |
| 49 | +## Features |
| 50 | + |
| 51 | +> Note: K9s does not have an idiot light. Please be sure to hit the correct command |
| 52 | +> sequences to avoid pilot errors. `Are you sure?` not in effect here... |
| 53 | +
|
| 54 | ++ K9s uses 2 or 3 letters alias to navigate to a K8s resource |
| 55 | ++ At any time you can use `?<Enter>` to look up the various commands |
| 56 | ++ Use `alias<Enter>` to activate a resource under that alias |
| 57 | ++ Use `Esc` to erase previous keystrokes. |
| 58 | ++ Use `Q` or `Ctrl-C` to Quit. |
| 59 | ++ `Ctrl` sequences are used to view, edit, delete, ssh ... |
| 60 | ++ Use `ctx<Enter>` to see and switch between your clusters |
| 61 | + |
| 62 | +<br/> |
| 63 | + |
| 64 | +--- |
| 65 | +## Video Demo |
| 66 | + |
| 67 | ++ [K9s Demo](https://youtu.be/k7zseUhaXeU) |
| 68 | + |
| 69 | + |
| 70 | +<br/> |
| 71 | + |
| 72 | +--- |
| 73 | +## Screen Shots |
| 74 | + |
| 75 | +### Pod View |
| 76 | + |
| 77 | +<img src="assets/screen_1.png"> |
| 78 | + |
| 79 | +### Log View |
| 80 | + |
| 81 | +<img src="assets/screen_2.png"> |
| 82 | + |
| 83 | +<br/> |
| 84 | + |
| 85 | +--- |
| 86 | +## Known Issues... |
| 87 | + |
| 88 | +This initial drop is brittle. K9s will most likely blow up if... |
| 89 | + |
| 90 | ++ Your kube-config file does not live under $HOME/.kube or you use multiple configs |
| 91 | ++ You don't have enough RBAC fu to manage your cluster |
| 92 | ++ Your cluster does not run a metrics-server |
| 93 | ++ You have more than 9 namespaces |
| 94 | ++ Most likely will bork on older Kubernetes revs. Guessing > 1.9+ is Ok?? |
| 95 | ++ Not sure at this time about the ill effects for large clusters?? |
| 96 | ++ Many others for sure... |
| 97 | + |
| 98 | +<br/> |
| 99 | + |
| 100 | +--- |
| 101 | +## Disclaimer |
| 102 | + |
| 103 | +This is still work in progress! If there is enough interest in the Kubernetes |
| 104 | +community, we will enhance per your recommendations/contributions. Also if you |
| 105 | +dig this effort, please let us know that too! |
| 106 | + |
| 107 | +<br/> |
| 108 | + |
| 109 | +--- |
| 110 | +## ATTA Girls/Boys! |
| 111 | + |
| 112 | +K9s sits on top of two very cool GO projects that provides the much needed terminal |
| 113 | +support. So big thanks and shootout to the good folks at tcell+tview for |
| 114 | +making K9s a reality!! |
| 115 | + |
| 116 | ++ [tcell](https://github.com/gdamore/tcell) |
| 117 | ++ [tview](https://github.com/rivo/tview) |
| 118 | + |
| 119 | + |
| 120 | +<br/> |
| 121 | + |
| 122 | +--- |
| 123 | +## Contact Information |
| 124 | + |
| 125 | ++ **Email**: fernand@k8sland.io |
| 126 | ++ **Twitter**: [@kitesurfer](https://twitter.com/kitesurfer?lang=en) |
| 127 | ++ **Github**: [K9s](https://github.com/k8sland/k9s) |
| 128 | +<br/> |
| 129 | + |
| 130 | +--- |
| 131 | +<img src="assets/imhotep_logo.png" width="32" height="auto"/> © 2018 Imhotep Software LLC. |
| 132 | +All materials licensed under [Apache v2.0](http://www.apache.org/licenses/LICENSE-2.0) |
0 commit comments