Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/allaman/kustomize.nvim
A Neovim plugin with some useful functions for working with Kustomize
https://github.com/allaman/kustomize.nvim
kubernetes kustomize neovim neovim-plugin yaml
Last synced: 24 days ago
JSON representation
A Neovim plugin with some useful functions for working with Kustomize
- Host: GitHub
- URL: https://github.com/allaman/kustomize.nvim
- Owner: Allaman
- License: mit
- Created: 2022-11-17T21:07:44.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-04T23:43:03.000Z (about 1 month ago)
- Last Synced: 2024-12-15T16:55:34.630Z (26 days ago)
- Topics: kubernetes, kustomize, neovim, neovim-plugin, yaml
- Language: Lua
- Homepage:
- Size: 223 KB
- Stars: 41
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
kustomize.nvim
I work a lot with [Kustomize](https://kustomize.io/) 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](#use-cases) to check out what this plugin can do!
## Requirements
- Neovim >= 0.9
- `kustomize` in your PATH to [build manifests](#build-manifests)
- [kubeconform](https://github.com/yannh/kubeconform) in your PATH to [validate manifests](#validate-resources)
- [kubent](https://github.com/doitintl/kube-no-trouble) in your PATH to [check for deprecations](#check-for-deprecations)
- [plenary.nvim](https://github.com/nvim-lua/plenary.nvim)
- [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) and `yaml` parser
- (optionally) [LuaSnip](https://github.com/L3MON4D3/LuaSnip) for snippets support (default is disabled)
## Quickstart
With [Lazy.nvim](https://github.com/folke/lazy.nvim):
```lua
{
"allaman/kustomize.nvim",
requires = "nvim-lua/plenary.nvim",
dependencies = "nvim-lua/plenary.nvim"
ft = "yaml",
opts = {}
}
```
Run `:checkhealth kustomize` for a health check.
## Default mappings
| Mode | Mapping | Action | Command |
| ---- | ------------ | ---------------------- | -------------------------- |
| n | \kb | Kustomize build | `:KustomizeBuild` |
| n | \kk | List kinds | `:KustomizeListKinds` |
| n | \kp | Print resources | `:KustomizePrintResources` |
| n | \kl | List 'resources' | `:KustomizeListResources` |
| n | \kv | Validate file | `:KustomizeValidate` |
| n | \kd | Check API deprecations | `:KustomizeDeprecations` |
| n | | Run custom commands | `:KustomizeRun ` |
You can define your own keybindings after setting `opts.enable_key_mappings = false`:
```lua
use({
"allaman/kustomize.nvim",
requires = "nvim-lua/plenary.nvim",
ft = "yaml",
opts = { enable_key_mappings = false },
config = function(opts)
require('kustomize').setup({opts})
-- adjust to your needs if not using the default key mappings
vim.api.nvim_set_keymap("n", "kb", "KustomizeBuild", { desc = "Build Kustomize" })
vim.api.nvim_set_keymap("n", "kk", "KustomizeListKinds", { desc = "List Kubernetes Kinds" })
-- ...
end,
})
```
## Default configuration
This is the default configuration that can be overwritten, also in parts, by you.
```lua
{
enable_key_mappings = true,
enable_lua_snip = false,
build = { additional_args = {} },
kinds = { show_filepath = true, show_line = true, exclude_pattern = {} },
-- built-in commands
run = {
validate = {
cmd = "kubeconform",
args = {
"--strict",
"--ignore-missing-schemas",
"-schema-location",
"default",
"-schema-location",
"https://raw.githubusercontent.com/datreeio/CRDs-catalog/main/{{.Group}}/{{.ResourceKind}}_{{.ResourceAPIVersion}}.json",
},
},
deprecations = {
cmd = "kubent",
args = { "-t", "1.26", "-c=false", "--helm3=false", "-l=error", "-e", "-f" },
},
},
}
```
With Lazy.nvim for instance:
```lua
opts = { enable_lua_snip = true },
```
## 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:
```lua
build = {
additional_args = {"--enable-helm", "--load-restrictor=LoadRestrictionsNone"}
},
```
You can also dynamically overwrite the values of your config file with
```
:KustomizeBuild --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](#build-manifests). Only Resources with `metadata.name` are recognized, e.g. `Kustomization` resources are not detected.
The output consists of ` || `. 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:
```lua
kinds = {
show_filepath = false,
show_line = false,
},
```
You can exclude certain resources from the results via:
```lua
kinds = {
exclude_pattern = { "CronJob", "ServiceAccount" }
},
```
You can also dynamically overwrite the values of your config file with
```
:KustomizeListKinds show_line=false show_filepath=false exclude_pattern=Namespace,Ingress
```
If [Telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) is installed, you can toggle `Telescope loclist` with `kt` (if default mappings are enabled).
### Open file/directory
Showcase
In a kustomiation.yaml you list your YAMLs that should be included by Kustomize for the build of the final manifests like so:
```yaml
---
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](https://github.com/yannh/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](#build-manifests).
You can overwrite the default args like so
```lua
run = {
validate = {
args = { "--strict" },
},
}
```
### Check for deprecations
Showcase
[kubent](https://github.com/doitintl/kube-no-trouble) 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](#build-manifests).
You can overwrite the default args like so
```lua
run = {
deprecations = {
args = { "-t", "1.30", "-l=error", "-e", "-f" },
}
```
### Run custom commands
You can define and run arbitrary commands on yaml files, for instance:
```lua
run = {
trivy = {
cmd = "trivy",
args = { "-q", "fs" },
timeout = 10000, -- in ms
},
deprecations29 = {
cmd = "kubent",
args = { "-t", "1.29", "-c=false", "--helm3=false", "-l=error", "-e", "-f" },
-- the default timeout is 5000 when not specified
},
deprecations30 = {
cmd = "kubent",
args = { "-t", "1.29", "-c=false", "--helm3=false", "-l=error", "-e", "-f" },
},
},
```
Keep in mind, that the last argument of the command must accept a file.
Then you can run `:KustomizeRun trivy` to run the specified command. Auto-completion is supported!