README
¶
kustomize
kustomize lets you customize raw, template-free YAML
files for multiple purposes, leaving the original YAML
untouched and usable as is.
kustomize targets kubernetes; it understands and can
patch kubernetes style API objects. It's like
make, in that what it does is declared in a file,
and it's like sed, in that it emits edited text.
This tool is sponsored by sig-cli (KEP), and inspired by DAM.
Download a binary from the release page, or see these instructions.
Browse the docs or jump right into the tested examples.
kubectl integration
Since v1.14 the kustomize build system has been included in kubectl.
| kubectl version | kustomize version |
|---|---|
| v1.16.0 | v2.0.3 |
| v1.15.x | v2.0.3 |
| v1.14.x | v2.0.3 |
For examples and guides for using the kubectl integration please see the kubectl book or the kubernetes documentation.
Usage
1) Make a kustomization file
In some directory containing your YAML resource files (deployments, services, configmaps, etc.), create a kustomization file.
This file should declare those resources, and any customization to apply to them, e.g. add a common label.
File structure:
~/someApp ├── deployment.yaml ├── kustomization.yaml └── service.yaml
The resources in this directory could be a fork of someone else's configuration. If so, you can easily rebase from the source material to capture improvements, because you don't modify the resources directly.
Generate customized YAML with:
kustomize build ~/someApp
The YAML can be directly applied to a cluster:
kustomize build ~/someApp | kubectl apply -f -
2) Create variants using overlays
Manage traditional variants of a configuration - like development, staging and production - using overlays that modify a common base.
File structure:
~/someApp ├── 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
Take the work from step (1) above, move it into a
someApp subdirectory called base, then
place overlays in a sibling directory.
An overlay is just another kustomization, refering to the base, and referring to patches to apply to that base.
This arrangement makes it easy to manage your
configuration with git. The base could have files
from an upstream repository managed by someone else.
The overlays could be in a repository you own.
Arranging the repo clones as siblings on disk avoids
the need for git submodules (though that works fine, if
you are a submodule fan).
Generate YAML with
kustomize build ~/someApp/overlays/production
The YAML can be directly applied to a cluster:
kustomize build ~/someApp/overlays/production | kubectl apply -f -
Community
To file bugs please read this.
Before working on an implementation, please
- Read the eschewed feature list.
- File an issue describing how the new feature would behave and label it kind/feature.
Other communication channels
- Slack
- Mailing List
- General kubernetes community page
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
kusterr
Package error has contextual error types.
|
Package error has contextual error types. |
|
loadertest
Package loadertest holds a fake for the Loader interface.
|
Package loadertest holds a fake for the Loader interface. |
|
configmapandsecret
Package configmapandsecret generates configmaps and secrets per generator rules.
|
Package configmapandsecret generates configmaps and secrets per generator rules. |
|
kunstruct
Package kunstruct provides unstructured from api machinery and factory for creating unstructured Package kunstruct provides unstructured from api machinery and factory for creating unstructured
|
Package kunstruct provides unstructured from api machinery and factory for creating unstructured Package kunstruct provides unstructured from api machinery and factory for creating unstructured |
|
transformer
Package transformer provides transformer factory
|
Package transformer provides transformer factory |
|
validator
Package validator provides functions to validate labels, annotations, namespaces and configmap/secret keys using apimachinery functions.
|
Package validator provides functions to validate labels, annotations, namespaces and configmap/secret keys using apimachinery functions. |
|
A dummy main to help with releasing the kustomize API module.
|
A dummy main to help with releasing the kustomize API module. |
|
pkg
|
|
|
expansion
Package expansion provides functions find and replace $(FOO) style variables in strings.
|
Package expansion provides functions find and replace $(FOO) style variables in strings. |
|
fs
Package fs provides a file system abstraction layer.
|
Package fs provides a file system abstraction layer. |
|
ifc
Package ifc holds miscellaneous interfaces used by kustomize.
|
Package ifc holds miscellaneous interfaces used by kustomize. |
|
image
Package image provides struct definitions and libraries for image overwriting of names, tags and digest.
|
Package image provides struct definitions and libraries for image overwriting of names, tags and digest. |
|
loader
Package loader has a data loading interface and various implementations.
|
Package loader has a data loading interface and various implementations. |
|
pgmconfig
Package pgmconfig holds global constants for the kustomize tool.
|
Package pgmconfig holds global constants for the kustomize tool. |
|
resmap
Package patch holds miscellaneous interfaces used by kustomize.
|
Package patch holds miscellaneous interfaces used by kustomize. |
|
resource
Package resource implements representations of k8s API resources as "unstructured" objects.
|
Package resource implements representations of k8s API resources as "unstructured" objects. |
|
target
Package target implements state for the set of all resources to customize.
|
Package target implements state for the set of all resources to customize. |
|
transformers
Utilities to aid transformer plugins.
|
Utilities to aid transformer plugins. |
|
transformers/config
Package config provides the functions to load default or user provided configurations for different transformers
|
Package config provides the functions to load default or user provided configurations for different transformers |
|
transformers/config/defaultconfig
Package defaultconfig provides the default transformer configurations
|
Package defaultconfig provides the default transformer configurations |
|
types
Package types holds struct definitions that should find a better home.
|
Package types holds struct definitions that should find a better home. |
|
validators
Package validators defines a FakeValidator that can be used in tests
|
Package validators defines a FakeValidator that can be used in tests |
|
See docs/plugins.md to learn about plugins.
|
See docs/plugins.md to learn about plugins. |
|
builtin
Code generated by pluginator on AnnotationsTransformer; DO NOT EDIT.
|
Code generated by pluginator on AnnotationsTransformer; DO NOT EDIT. |