kustomize
kustomize is a command line tool supporting
template-free customization of YAML (or JSON) objects
that conform to the kubernetes style. If your
objects have a kind and a metadata field,
kustomize can patch them to support configuration
sharing and re-use.
For more details, try a demo.
Installation
This assumes Go (v1.10.1 or higher)
is installed and your PATH contains $GOPATH/bin:
go get github.com/kubernetes-sigs/kustomize
Usage
1) Make a customized base
A base configuration is a kustomization file listing a set of k8s resources - deployments, services, configmaps, secrets that serve some common purpose.
File structure:
~/yourApp └── base ├── deployment.yaml ├── kustomization.yaml └── service.yaml
Your base could be a fork of someone else's configuration, that your occasionally rebase from to capture improvements.
2) Further customize with overlays
An overlay customizes your base along different dimensions for different purposes or different teams, e.g. for development and production.
File structure:
~/yourApp ├── base │ ├── deployment.yaml │ ├── kustomization.yaml │ └── service.yaml └── overlays ├── development │ ├── cpu_count.yaml │ ├── kustomization.yaml │ └── replica_count.yaml └── production ├── cpu_count.yaml ├── kustomization.yaml └── replica_count.yaml
Your overlays could sit in your own repository.
3) Run kustomize
Run kustomize on an overlay, e.g.
kustomize build ~/yourApp/overlays/production
The result is printed to stdout as a set of complete
resources, ready to be applied to a cluster. See the
demos.