Vimkubectl

A (neo)vim plugin that acts as a kubectl wrapper providing commands and mappings to manipulate Kubernetes resources.

The following has been implemented so far:

• Fetch and view lists of kubernetes resources
• Edit resource manifests in YAML form
• Apply any file or buffer to the cluster
• Switch namespace
• Delete resources

Installation

Use your favourite plugin manager.

Or use Vim's built-in package support:

git clone https://github.com/rottencandy/vimkubectl.git ~/.vim/pack/plugins/start/vimkubectl

Help tag files can be generated inside Vim using :helptags ALL.

Usage

This plugin assumes your Kubernetes cluster is reachable and logged in with kubectl or oc.(see configuration)

• :Kget {resource}

  Get a list of all objects of type {resource}. If {resource} is not given, pod is used.

  You can also use <Tab> for completion and to cycle through possible resources.

  • gr to refresh/update the list of resources.

  • ii (think, "insert mode") to open and edit the manifest of the resource under cursor, in the current window(opens in YAML format)

  • is to open in a split.

  • iv to open in a vertical split.

  • it to open in a new tab.

  • dd to delete the resource under cursor. (Prompts for confirmation)

• :Kedit {resource} {object}

  Open a split containing the manifest of {object} of type {resource}. Also has <Tab> completion.

• The opened manifest can be edited just like a regular file, except that it gets applied on every save.

  The following mappings are available in these buffers:

  • gr to refresh/update the manifest. Note that this will disregard any unsaved local changes.

  • :Ksave {filename} to save the manifest locally. If {filename} is not given, the resource object name is used.

• :Knamespace {name}

  Change the currently selected namespace to {name}. If {name} is not given, prints the currently used namespace.

  <Tab> completion can be used to cycle through available namespaces.

• :{range}Kapply

  Apply file contents. When used with a selection({range}), applies the selected content, else applies the entire file. Can be used on any open buffer.

Configuration

• g:vimkubectl_command

  Default: 'kubectl'

  If you are using an alternate Kubernetes cli, it can be specified with g:vimkubectl_command.

  For example to use OpenShift's oc as the command, add this to your vimrc:

  let g:vimkubectl_command = 'oc'
  

• g:vimkubectl_timeout

  Default: 5

  The maximum time to wait for the cluster to respond to requests.

  For example, to change the wait time to 10 seconds:

  let g:vimkubectl_timeout = 10
  

License

MIT