https://github.com/nlamirault/timonier

Manage Kubernetes cluster from Emacs
https://github.com/nlamirault/timonier

emacs kubernetes

Last synced: 3 months ago
JSON representation

Manage Kubernetes cluster from Emacs

• Host: GitHub
• URL: https://github.com/nlamirault/timonier
• Owner: nlamirault
• License: apache-2.0
• Created: 2016-09-27T11:56:05.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-01-14T14:38:35.000Z (almost 3 years ago)
• Last Synced: 2024-04-26T01:33:02.508Z (6 months ago)
• Topics: emacs, kubernetes
• Language: Emacs Lisp
• Homepage:
• Size: 341 KB
• Stars: 20
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Timonier

[![Coverage Status](https://coveralls.io/repos/nlamirault/timonier/badge.png?branch=master)](https://coveralls.io/r/nlamirault/timonier?branch=master)

Master :

* [![MELPA Stable](https://stable.melpa.org/packages/timonier-badge.svg)](https://stable.melpa.org/#/timonier)

* [![Circle CI](https://circleci.com/gh/nlamirault/timonier/tree/master.svg?style=svg)](https://circleci.com/gh/nlamirault/timonier/tree/master)

Develop:

* [![Melpa Status](https://melpa.org/packages/timonier-badge.svg)](https://melpa.org/#/timonier)

* [![Circle CI](https://circleci.com/gh/nlamirault/timonier/tree/develop.svg?style=svg)](https://circleci.com/gh/nlamirault/timonier/tree/develop)

``timonier`` is an Emacs frontend for a [Kubernetes][] cluster.

## Installation

The recommended way to install ``timonier`` is via [MELPA][]:

    M-x package-install timonier

or [Cask][]:

	(depends-on "timonier")

## Usage

* Setup the Kubernetes proxy endpoint:

        (setq timonier-k8s-proxy "http://localhost:8001")

* Display the dashboard:

        M-x timonier-k8s

* In the buffer:

Launch the timonier menu using the key : C-c C-k

Keybinding           | Description

---------------------|------------------------------------------------------------

g         | go to the news pod

h         | go to the previous pod

P         | describe current pod

k         | go to the next service

l         | go to the previous service

S         | describe the current service

i         | go to the next node

j         | go to the previous node

N         | describe the current service

q         | quit

![Timonier](timonier-0.1.0.png)

## Development

### Cask

``timonier`` use [Cask][] for dependencies management. Install it and

retrieve dependencies :

    $ curl -fsSkL https://raw.github.com/cask/cask/master/go | python

    $ export PATH="$HOME/.cask/bin:$PATH"

    $ cask

### Testing

* Launch unit tests from shell

    $ make clean test

* Using [overseer][] :

Keybinding           | Description

---------------------|------------------------------------------------------------

C-c , t   | launch unit tests from buffer

C-c , b   | launch unit tests

C-c , g   | launch unit tests with tag (backend, ...)

* Tips:

If you want to launch a single unit test, add a specify tag :

```lisp

(ert-deftest test-foobar ()

  :tags '(current)

  ```

And launch it using : C-c , g and specify tag : *current*

## Support / Contribute

See [here](CONTRIBUTING.md)

## Changelog

A changelog is available [here](ChangeLog.md).

## License

See [LICENSE](LICENSE).

## Contact

Nicolas Lamirault 

[badge-license]: https://img.shields.io/badge/license-GPL_2-green.svg?style=flat

[LICENSE]: https://github.com/nlamirault/ripgrep.el/blob/master/LICENSE

[GNU Emacs]: https://www.gnu.org/software/emacs/

[MELPA]: https://melpa.org/

[Cask]: http://cask.github.io/

[Issue tracker]: https://github.com/nlamirault/ripgrep.el/issues

[overseer]: https://github.com/tonini/overseer.el

[ag]: https://github.com/ggreer/the_silver_searcher

[pt]: https://github.com/monochromegane/the_platinum_searcher

[sift]: https://sift-tool.org/

[ripgrep]: https://github.com/BurntSushi/ripgrep