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 editted text.
Installation: Download a binary from the release page, or see these install notes. Then try one of the tested examples.
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 -
About
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
app
Package app implements state for the set of all resources being customized.
|
Package app implements state for the set of all resources being customized. |
|
commands
Package commands holds the CLI glue mapping textual commands/args to method calls.
|
Package commands holds the CLI glue mapping textual commands/args to method calls. |
|
configmapandsecret
Package configmapandsecret generates configmaps and secrets per generator rules.
|
Package configmapandsecret generates configmaps and secrets per generator rules. |
|
configmapandsecret/util
Package util offers Configmap and Secret generation utilities.
|
Package util offers Configmap and Secret generation utilities. |
|
constants
Package constants holds global constants for the kustomize tool.
|
Package constants holds global constants for the kustomize tool. |
|
crds
Package crds read in files for CRD schemas and parse annotations from it
|
Package crds read in files for CRD schemas and parse annotations from it |
|
diff
Package diff runs system `diff` to compare resource collections.
|
Package diff runs system `diff` to compare resource collections. |
|
exec
Package exec provides an injectable interface and implementations for running commands.
|
Package exec provides an injectable interface and implementations for running commands. |
|
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. |
|
hash
Package hash generates hash strings from configmaps and secrets.
|
Package hash generates hash strings from configmaps and secrets. |
|
internal/error
Package error has contextual error types.
|
Package error has contextual error types. |
|
internal/loadertest
Package loadertest holds a fake for the Loader interface.
|
Package loadertest holds a fake for the Loader interface. |
|
loader
Package loader has a data loading interface and various implementations.
|
Package loader has a data loading interface and various implementations. |
|
resmap
Package resmap implements a map from ResId to Resource that tracks all resources in a kustomization.
|
Package resmap implements a map from ResId to Resource that tracks all resources in a kustomization. |
|
resource
Package resource implements representations of k8s API resources as "unstructured" objects.
|
Package resource implements representations of k8s API resources as "unstructured" objects. |
|
transformers
Package transformers has implementations of resmap.ResMap transformers.
|
Package transformers has implementations of resmap.ResMap transformers. |
|
types
Package types holds struct definitions that should find a better home.
|
Package types holds struct definitions that should find a better home. |