mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-05-17 18:25:26 +00:00
188 lines
5.9 KiB
Markdown
188 lines
5.9 KiB
Markdown
# kustomize
|
|
|
|
_[v3.1.0](https://github.com/kubernetes-sigs/kustomize/releases/tag/v3.1.0) is the latest release._
|
|
|
|
`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].
|
|
|
|
|
|
[](https://travis-ci.org/kubernetes-sigs/kustomize)
|
|
[](https://goreportcard.com/report/github.com/kubernetes-sigs/kustomize)
|
|
|
|
Download a binary from the [release page], or see
|
|
these [instructions](docs/INSTALL.md).
|
|
|
|
Browse the [docs](docs) or jump right into the
|
|
tested [examples](examples).
|
|
|
|
## kubectl integration
|
|
|
|
Since [v1.14][kubectl announcement] the kustomize build system has been included in kubectl.
|
|
|
|
| kubectl version | kustomize version |
|
|
|---------|--------|
|
|
| v1.15.x | [v2.0.3](https://github.com/kubernetes-sigs/kustomize/tree/v2.0.3) |
|
|
| v1.14.x | [v2.0.3](https://github.com/kubernetes-sigs/kustomize/tree/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_.
|
|
|
|
![base image][imageBase]
|
|
|
|
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].
|
|
|
|
![overlay image][imageOverlay]
|
|
|
|
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
|
|
|
|
```sh
|
|
kustomize build ~/someApp/overlays/production
|
|
```
|
|
|
|
The YAML can be directly [applied] to a cluster:
|
|
|
|
> ```sh
|
|
> kustomize build ~/someApp/overlays/production | kubectl apply -f -
|
|
> ```
|
|
|
|
## Community
|
|
|
|
To file bugs please read [this](docs/bugs.md).
|
|
|
|
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].
|
|
|
|
[`make`]: https://www.gnu.org/software/make
|
|
[`sed`]: https://www.gnu.org/software/sed
|
|
[DAM]: docs/glossary.md#declarative-application-management
|
|
[KEP]: https://github.com/kubernetes/enhancements/blob/master/keps/sig-cli/0008-kustomize.md
|
|
[Kubernetes Code of Conduct]: code-of-conduct.md
|
|
[Mailing List]: https://groups.google.com/forum/#!forum/kubernetes-sig-cli
|
|
[Slack]: https://kubernetes.slack.com/messages/sig-cli
|
|
[applied]: docs/glossary.md#apply
|
|
[base]: docs/glossary.md#base
|
|
[community page]: http://kubernetes.io/community/
|
|
[declarative configuration]: docs/glossary.md#declarative-application-management
|
|
[eschewed feature list]: docs/eschewedFeatures.md
|
|
[imageBase]: docs/images/base.jpg
|
|
[imageOverlay]: docs/images/overlay.jpg
|
|
[kind/feature]: https://github.com/kubernetes-sigs/kustomize/labels/kind%2Ffeature
|
|
[kubectl announcement]: https://kubernetes.io/blog/2019/03/25/kubernetes-1-14-release-announcement
|
|
[kubectl book]: https://kubectl.docs.kubernetes.io/pages/app_customization/introduction.html
|
|
[kubernetes documentation]: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/
|
|
[kubernetes style]: docs/glossary.md#kubernetes-style-object
|
|
[kustomization]: docs/glossary.md#kustomization
|
|
[overlay]: docs/glossary.md#overlay
|
|
[overlays]: docs/glossary.md#overlay
|
|
[release page]: https://github.com/kubernetes-sigs/kustomize/releases
|
|
[resource]: docs/glossary.md#resource
|
|
[resources]: docs/glossary.md#resource
|
|
[sig-cli]: https://github.com/kubernetes/community/blob/master/sig-cli/README.md
|
|
[variant]: docs/glossary.md#variant
|
|
[variants]: docs/glossary.md#variant
|
|
[v2.0.3]: https://github.com/kubernetes-sigs/kustomize/releases/tag/v2.0.3
|
|
[v2.1.0]: https://github.com/kubernetes-sigs/kustomize/releases/tag/v2.1.0
|
|
[workflows]: docs/workflows.md
|