Files
kustomize/examples/README.md
jregan a7df00c07a Starting v3 release for plugin developers.
[doc]: https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher

Per this Go modules [doc] a repo or branch that's
already tagged v2 or higher should increment the major
version (e.g. go to v3) when releasing their first Go
module-based packages.

At the moment, the kustomize repo has these top level
packages in the sigs.k8s.io/kustomize module:

 - `cmd` - holds main program for kustomize

	 Conceivably someone can depend on this
	 package for integration tests.

 - `internal` - intentionally unreleased subpackages

 - `k8sdeps` - an adapter wrapping k8s dependencies

	 This exists only for use in pre-Go-modules kustomize-into-kubectl
	 integration and won't live much longer (as everything involved is
	 switching to Go modules).

 - `pkg` - kustomize packages for export

	 This should shrink in later versions, since
	 the surface area is too large, containing
	 sub-packages that should be in 'internal'.

 - `plugin` - holds main programs for plugins

This PR changes the top level go.mod file from

```
module sigs.k8s.io/kustomize
```

to

```
module sigs.k8s.io/kustomize/v3
```

and adjusts all import statements to
reflect the change.
2019-06-23 15:05:59 -07:00

2.2 KiB

English | 简体中文

Examples

These examples assume that kustomize is on your $PATH.

They are covered by pre-commit tests, and should work with HEAD

go get sigs.k8s.io/kustomize/v3/cmd/kustomize

Basic Usage

  • configGenerations - Rolling update when ConfigMapGenerator changes.

  • combineConfigs - Mixing configuration data from different owners (e.g. devops/SRE and developers).

  • generatorOptions - Modifying behavior of all ConfigMap and Secret generators.

  • vars - Injecting k8s runtime data into container arguments (e.g. to point wordpress to a SQL service) by vars.

  • image names and tags - Updating image names and tags without applying a patch.

  • remote target - Building a kustomization from a github URL

  • json patch - Apply a json patch in a kustomization

Advanced Usage

Multi Variant Examples

  • hello world - Deploy multiple (differently configured) variants of a simple Hello World server.

  • LDAP - Deploy multiple (differently configured) variants of a LDAP server.

  • springboot - Create a Spring Boot application production configuration from scratch.

  • mySql - Create a MySQL production configuration from scratch.

  • breakfast - Customize breakfast for Alice and Bob.

  • multibases - Composing three variants (dev, staging, production) with a common base.