kustomize.nvim

I work a lot with Kustomize and I love Neovim. So why not write a plugin for some tasks for that I usually switch to a shell. Jump to the use cases to check out what this plugin can do!

Requirements

• Neovim >= 0.9
• kustomize in your PATH to build manifests
• kubeconform in your PATH to validate manifests
• kubent in your PATH to check for deprecations
• plenary.nvim
• nvim-treesitter and yaml parser
• (optionally) LuaSnip snippets (default is disabled)

Quickstart

With Lazy.nvim:

{
  "allaman/kustomize.nvim",
  requires = "nvim-lua/plenary.nvim",
  ft = "yaml",
  opts = {}
}

Run :checkhealth kustomize for a health check.

Default mappings

You can define your own keybindings/override the default mappings, for instance:

  use({
    "allaman/kustomize.nvim",
    requires = "nvim-lua/plenary.nvim",
    ft = "yaml",
    opts = { enable_key_mappings = false },
    config = function(opts)
      require('kustomize').setup({opts})
      -- default keybindings, adjust to your needs
      vim.keymap.set("n", "<leader>kb", "<cmd>lua require('kustomize').build()<cr>", { noremap = true })
      vim.keymap.set("n", "<leader>kk", "<cmd>lua require('kustomize').kinds()<cr>", { noremap = true })
      vim.keymap.set("n", "<leader>kl", "<cmd>lua require('kustomize').list_resources()<cr>", { noremap = true })
      vim.keymap.set("n", "<leader>kp", "<cmd>lua require('kustomize').print_resources()<cr>", { noremap = true })
      vim.keymap.set("n", "<leader>kv", "<cmd>lua require('kustomize').validate()<cr>", { noremap = true })
      vim.keymap.set("n", "<leader>kd", "<cmd>lua require('kustomize').deprecations()<cr>", { noremap = true })
    end,
  })

Default configuration

This is the default configuration that can be (partially) overwritten by you.

{
  enable_key_mappings = true,
  enable_lua_snip = false,
  validate = { kubeconform_args = { "--strict", "--ignore-missing-schemas" } },
  build = { additional_args = {} },
  deprecations = { kube_version = "1.25" },
  kinds = { show_filepath = true, show_line = true, exclude_pattern = "" },
}

With Lazy.nvim for instance:

  opts = { validate = { kubeconform_args = { "--strict" } } },

And some command / Lua APIs support arguments. See List "kinds" and Check for deprecations.

Use cases

Snippets

If enabled, kustomize.nvim includes some useful snippets for LuaSnip. All snippets start with kust.

Showcase

Build manifests

Showcase

This command will run kustomize build . in the current buffer's directory. The generated YAML will be printed to a new buffer. The new buffer can be closed by just typing q. This allows me to quickly inspect the YAML that Kustomize generates (and ultimately is applied to the cluster). In addition, I get fast feedback on any errors in my YAML sources.

You can add additional arguments to the build call via config file:

build = {
  additional_args = {"--enable-helm", "--load-restrictor=LoadRestrictionsNone"}
},

You can also dynamically overwrite the values of your config file with

lua require("kustomize").build({additional_args={"--enable-helm", "--load-restrictor=LoadRestrictionsNone"}})

:KustomizeBuild additional_args={"--enable-helm", "--load-restrictor=LoadRestrictionsNone"}

List "kinds"

Showcase

Sometimes, I just want to roughly check the YAMLs generated by Kustomize. A good hint is to check the kind: key of the generated YAML manifests. This command will parse all kind: keys in the current buffer with the help of tree-sitter and prints their values to a loclist allowing you to easily jump around all resources. You could use it on any YAML file with multiple resources, for instance generated by Build manifests. Only Resources with metadata.name are recognized, e.g. Kustomization resources are not detected.

The output consists of <the buffer name> |<the line nr>| <which kind> <name> <namespace>. Cluster-wide resources omit the namespace value. You can hide the buffer name and line number by adding the following snippet to the opts table:

If Telescope.nvim is installed, you can toggle Telescope loclist with <leader>kt

kinds = {
-- setting those to false removes "clutter" but you cannot "jump" to a resource anymore
show_filepath = false,
show_line = false,
-- filter resources you are not interested in
exclude_pattern = {"Namespace", "Ingress"}
},

You can also dynamically overwrite the values of your config file with

:lua require("kustomize").kinds({show_line=true, show_filepath=true, exclude_pattern={"Namespace", "Ingress"}})

:KustomizeListKinds show_line=true, show_filepath=true, exclude_pattern={"Namespace", "Ingress"}

Open file/directory

Showcase

You list your YAMLs that should be included by Kustomize for the build of the final manifests like so:

---
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
  - service1/
  - grafana-dashboard.yaml
  - ../../base/namespace.yaml

In order to quickly check/edit those included YAMLs this command will go through all items in resources: and populate a loclist with them.

Print resource files

Showcase

When writing a new deployment I usually split the resources into files according to their type, for instance deployment.yaml, cm.yaml, or sa.yaml. When writing my kustomization.yaml I must add all resource files which does this command for me.

Validate resources

Showcase

kubeconform is a Kubernetes manifests validator that can detect a misconfiguration before you apply your manifests to your cluster. This command runs kubeconform --strict --ignore-missing-schemas on the current buffer. The buffer's content may be a file on disk or content not (yet) saved, e.g. the output of Build manifests.

Check for deprecations

Showcase

kubent is a tool to search for deprecated Kubernetes APIs. This plugin utilizes the plugin to check the manifests in the current buffer for deprecated Kubernetes APIs. The buffer's content may be a file on disk or content not (yet) saved, e.g. the output of Build manifests. The Kubernetes target version can be set with deprecations = { kube_version = "1.25" }.

You can also dynamically overwrite the values of your config file with

:lua require("kustomize").deprecations({kube_version=1.25})

:KustomizeDeprecations kube_version=1.16