/kubernetes-el

Emacs porcelain for Kubernetes.

Primary LanguageEmacs LispGNU General Public License v3.0GPL-3.0

kubernetes-el

Build Status codecov MELPA Stable MELPA License GPL 3

A magit-style interface to the Kubernetes command-line client.

Screenshot of Kubernetes Emacs client

This project is in early stages, but the following are implemented:

  • Live-updating lists of kubernetes resources
  • Viewing and deleting pods, configmaps and secrets
  • Editing various Kubernetes resources like deployment, configmap, etc.
  • Switching contexts and namespaces.
  • Showing logs and exec'ing into containers
  • Describing pods

Usage

Run M-x kubernetes-overview to get started.

Installation

This package is available on the MELPA package repository. See the instructions there for how to configure Emacs to pull packages from MELPA.

Once you've set that up, use your preferred method of configuring and installing packages. If you use use-package, the forms below will get you started.

(use-package kubernetes
  :ensure t
  :commands (kubernetes-overview))

;; If you want to pull in the Evil compatibility package.
(use-package kubernetes-evil
  :ensure t
  :after kubernetes)

Otherwise, you can install the packages with M-x package-install.

Disabling automatic refresh helped many to solve issue #100. For example one can use the following configuration:

(use-package kubernetes
  :ensure t
  :commands (kubernetes-overview)
  :config
  (setq kubernetes-poll-frequency 3600
        kubernetes-redraw-frequency 3600))

Manual Installation

Requires Emacs 25 and Cask.

git clone git@github.com:kubernetes-el/kubernetes-el.git
cd kubernetes-el
make && make install

Contributing

Yes please! 😻 See contributing.org