kubectl.nvim

Processes kubectl outputs to enable vim-like navigation in a buffer for your cluster.

Note: This is still incomplete in that it doesn't handle all possible resources and I might change things up in the future.

✨ Features

• Navigate your cluster in a buffer, using hierarchy where possible (backspace for up, enter for down) e.g. root -> deplyoment -> pod -> container
• Colored output and smart highlighting
• Floating windows for contextual stuff such as logs, description, containers..
• Run custom commands e.g :Kubectl get configmaps -A
• Exec into containers

⚡️ Dependencies

• kubectl

📦 Installation

Install the plugin with your preferred package manager:

lazy.nvim

return {
  {
    "ramilito/kubectl.nvim",
    keys = {
      {
        "<leader>k",
        function()
          require("kubectl").open()
        end,
        desc = "Kubectl",
      },
    },
    config = function()
      require("kubectl").setup()
    end,
  },
}

⚙️ Configuration

Setup

{
  hints = true,
  context = true,
}

Performance

Startup

No startup impact since we load on demand.

TODO

• Open in split
• Exec into container
• Auto refresh state (should probably do async operations task first)
• Async operations
• Populate the g? help buffer
• Configuration
  • Optional hints
  • Optional or toggable context info
  • Bring your own colors
• Hints bar for shortcuts
• Node view
• Services view
• Pod view
• Container viewn
• Deployment view
• Secrets view
• CRDS view
• Generic view for user commands
  • Add barebones to use user commands
  • Add autocompletion
  • Add some smartness, figure out filetype based on command
• Integrate with tooling (such as kubesses or kubediff)

Motivation

This plugins main purpose is to browse the kubernetes state using vim like navigation and keys, similar to oil.nvim for filebrowsing. I might add a way to act on the cluster (delete resources, ssh, edit) in the future, not sure yet.