Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Carlos-Descalzi authored Sep 15, 2020
1 parent 76c08be commit d493dca
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ A little console based tool for managing Kubernetes clusters.

## Setup and install

python3 setup.sh install
sudo python3 setup.sh install
or
python3 setup.sh install --prefix=[Installation path prefix, for example $HOME/.local]

### Dependencies
kubernetes>=11.0.0
Expand All @@ -18,20 +20,26 @@ The folder **$HOME/.kubemgr** is created the first time the program is executed
- editor: Absolute path to external editor program.
- viewer: Absolute path to external viewer program. If ommitted will use internal viewer.

### Tabs.
It is possible to customize visible resources by adding them as tabs.
Check the default configuration file for details.

### clusters.ini
This file configures the paths to kube config files of clusters.
The first execution will attempt to locate the current cluster configuration, by checking KUBECONFIG environment variable, or for the file $HOME/.kube/config

[Cluster Name]
configfile=/path/to/kube/config
timeout=requests timeout in seconds.


### colors.ini
Allows customize the UI. On the first run the program will dump here the actual settings.

## User interface Navigation

### Keys
* h : Show this help.
* h : Shows help window.
* tab : cycles focus across UI components.
* esc : Closes popup if open, otherwise closes the application.
* cursors up/down : move across items in different lists.
Expand All @@ -41,9 +49,21 @@ Allows customize the UI. On the first run the program will dump here the actual
* e: Opens editor to edit resource as Yaml.
* d: Deletes de selected resource.
* c: Creates/updates a kubernetes resource from a yaml file.
* for clusters:
* enter: set current cluster.
* for pods:
* l: View pod logs.
* for nodes:
* l: view labels for node.
* for namespaces:
* enter: toggle namespace filter, all other views will filter its item by selected namespace.

### Indications
#### Cluster Status
* (C) green: Cluster connected.
* <X> red: Error on connection. Pressing enter on marked cluster will show the error.
* ...: Connecting

#### Namespaces
* (F): The namespace is used for filtering views.

0 comments on commit d493dca

Please sign in to comment.