kustomization.yaml

Kubernetes native configuration management

Type Kustomization
File match kustomization.yaml kustomization.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/kustomization-yaml/latest.json
Source https://www.schemastore.org/kustomization.json

Validate with Lintel

npx @lintel/lintel check
Type: Kustomization

Definitions

ConfigMapArgs object

ConfigMapArgs contains the metadata of how to generate a configmap

KVSources KVSource[]
behavior enum
Values: "create" "replace" "merge"
env string

Deprecated. Use envs instead.

envs string[]

A list of file paths. The contents of each file should be one key=value pair per line

files string[]

A list of file sources to use in creating a list of key, value pairs

literals string[]

A list of literal pair sources. Each literal source should be a key and literal value, e.g. key=value

name string

Name - actually the partial name - of the generated resource

namespace string

Namespace for the configmap, optional

options object

GeneratorOptions modify behavior of all ConfigMap and Secret generators

4 nested properties
annotations object

Annotations to add to all generated resources

disableNameSuffixHash boolean

DisableNameSuffixHash if true disables the default behavior of adding a suffix to the names of generated resources that is a hash of the resource contents

immutable boolean

Immutable if true add to all generated resources

labels object

Labels to add to all generated resources

FieldSelector object

Contains the fieldPath to an object field

fieldpath string
FieldSpec object
create boolean
group string
kind string
path string
version string
GeneratorOptions object

GeneratorOptions modify behavior of all ConfigMap and Secret generators

annotations object

Annotations to add to all generated resources

disableNameSuffixHash boolean

DisableNameSuffixHash if true disables the default behavior of adding a suffix to the names of generated resources that is a hash of the resource contents

immutable boolean

Immutable if true add to all generated resources

labels object

Labels to add to all generated resources

HelmChart object
name string
version string
repo string
releaseName string
namespace string
valuesFile string
valuesInline object
valuesMerge string
Values: "merge" "override" "replace"
includeCRDs boolean
skipHooks boolean
additionalValuesFiles string[]
skipTests boolean
apiVersions string[]
kubeVersion string
nameTemplate string
Image object
digest string
name string
newName string
newTag string
tagSuffix string

UNDOCUMENTED.

Inventory object

Inventory appends an object that contains the record of all other objects, which can be used in apply, prune and delete

configMap object
2 nested properties
name string
namespace string
type string
KVSource object
args string[]
name string
pluginType string
Kustomization object
apiVersion string
bases string[]

DEPRECATED. Bases are relative paths or git repository URLs specifying a directory containing a kustomization.yaml file.

commonAnnotations object

CommonAnnotations to add to all objects

buildMetadata string[]

BuildMetadata is a list of strings used to toggle different build options

commonLabels object

CommonLabels to add to all objects and selectors

configMapGenerator ConfigMapArgs[]

ConfigMapGenerator is a list of configmaps to generate from local data (one configMap per list item)

configurations string[]

Configurations is a list of transformer configuration files

crds string[]

Crds specifies relative paths to Custom Resource Definition files. This allows custom resources to be recognized as operands, making it possible to add them to the Resources list. CRDs themselves are not modified.

generatorOptions object

GeneratorOptions modify behavior of all ConfigMap and Secret generators

4 nested properties
annotations object

Annotations to add to all generated resources

disableNameSuffixHash boolean

DisableNameSuffixHash if true disables the default behavior of adding a suffix to the names of generated resources that is a hash of the resource contents

immutable boolean

Immutable if true add to all generated resources

labels object

Labels to add to all generated resources

generators string[]

Generators is a list of files containing custom generators

helmCharts HelmChart[]

HelmCharts is a list of helm chart configuration instances

helmGlobals object

HelmGlobals contains helm configuration that isn't chart specific

2 nested properties
chartHome string

ChartHome is a file path, relative to the kustomization root, to a directory containing a subdirectory for each chart to be included in the kustomization

configHome string

ConfigHome defines a value that kustomize should pass to helm via the HELM_CONFIG_HOME environment variable

images Image[]

Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify.

inventory object

Inventory appends an object that contains the record of all other objects, which can be used in apply, prune and delete

2 nested properties
configMap object
2 nested properties
name string
namespace string
type string
labels Labels[]

Labels to add to all objects but not selectors

kind string
metadata object
4 nested properties
name string
namespace string
labels object
annotations object
namePrefix string

NamePrefix will prefix the names of all resources mentioned in the kustomization file including generated configmaps and secrets

nameSuffix string

NameSuffix will suffix the names of all resources mentioned in the kustomization file including generated configmaps and secrets

namespace string

Namespace to add to all objects

replacements ReplacementsPath | ReplacementsInline[]

Substitute field(s) in N target(s) with a field from a source

openapi object

OpenAPI contains information about what kubernetes schema to use

patches PatchesPatchPath | PatchesInlinePatch[]

Apply a patch to multiple resources

patchesJson6902 PatchJson6902[]

JSONPatches is a list of JSONPatch for applying JSON patch. See http://jsonpatch.com

patchesStrategicMerge string[]

PatchesStrategicMerge specifies the relative path to a file containing a strategic merge patch. URLs and globs are not supported

replicas Replicas[]

Replicas is a list of (resource name, count) for changing number of replicas for a resources. It will match any group and kind that has a matching name and that is one of: Deployment, ReplicationController, Replicaset, Statefulset.

resources string[]

Resources specifies relative paths to files holding YAML representations of kubernetes API objects. URLs and globs not supported.

components string[]

Components are relative paths or git repository URLs specifying a directory containing a kustomization.yaml file of Kind Component.

secretGenerator SecretArgs[]

SecretGenerator is a list of secrets to generate from local data (one secret per list item)

sortOptions object | object

sortOptions is used to sort the resources kustomize outputs

transformers string[]

Transformers is a list of files containing transformers

validators string[]

Validators is a list of files containing validators

vars Var[]

Allows things modified by kustomize to be injected into a container specification. A var is a name (e.g. FOO) associated with a field in a specific resource instance. The field must contain a value of type string, and defaults to the name field of the instance

Labels object
pairs

Pairs contains the key-value pairs for labels to add

includeSelectors boolean

IncludeSelectors indicates should transformer include the fieldSpecs for selectors

includeTemplates boolean

IncludeTemplates indicates should transformer include the template labels

fields FieldSpec[]

FieldSpec completely specifies a kustomizable field in a k8s API object. It helps define the operands of transformations

Metadata object
name string
namespace string
labels object
annotations object
NameArgs object
name string
namespace string
PatchJson6902 object | object | object
PatchTarget object
kind string required
name string required
version string required
group string
namespace string
PatchesOptions object
allowNameChange boolean
allowKindChange boolean
PatchesPatchPath object
path string required
options object
2 nested properties
allowNameChange boolean
allowKindChange boolean
target object

Selector specifies a set of resources. Any resource that matches intersection of all conditions is included in this set.

7 nested properties
group string

The group of the referent

kind string

The kind of the referent

name string

The name of the referent

namespace string

The namespace of the referent

version string

The version of the referent

annotationSelector string

AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api

labelSelector string

LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api

PatchesInlinePatch object
patch string required
options object
2 nested properties
allowNameChange boolean
allowKindChange boolean
target object

Selector specifies a set of resources. Any resource that matches intersection of all conditions is included in this set.

7 nested properties
group string

The group of the referent

kind string

The kind of the referent

name string

The name of the referent

namespace string

The namespace of the referent

version string

The version of the referent

annotationSelector string

AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api

labelSelector string

LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api

ReplacementsInline object | object
ReplacementsPath object
path string required
ReplacementsSource object

The source of the value

group string

The group of the referent

version string

The version of the referent

kind string

The kind of the referent

name string

The name of the referent

namespace string

The namespace of the referent

fieldPath string

The structured path to the source value

options object
3 nested properties
delimiter string
index number
create boolean
ReplacementsTarget object
select object required

Selector specifies a set of resources. Any resource that matches intersection of all conditions is included in this set.

7 nested properties
group string

The group of the referent

kind string

The kind of the referent

name string

The name of the referent

namespace string

The namespace of the referent

version string

The version of the referent

annotationSelector string

AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api

labelSelector string

LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api

reject Selector[]

Exclude objects that match this

fieldPaths string[]

The structured path(s) to the target nodes

options object
3 nested properties
delimiter string
index number
create boolean
Replicas object
name string
count number
SecretArgs object

SecretArgs contains the metadata of how to generate a secret

KVSources KVSource[]
behavior enum
Values: "create" "replace" "merge"
env string
envs string[]
files string[]
literals string[]
name string

Name - actually the partial name - of the generated resource

namespace string

Namespace for the secret, optional

options object

GeneratorOptions modify behavior of all ConfigMap and Secret generators

4 nested properties
annotations object

Annotations to add to all generated resources

disableNameSuffixHash boolean

DisableNameSuffixHash if true disables the default behavior of adding a suffix to the names of generated resources that is a hash of the resource contents

immutable boolean

Immutable if true add to all generated resources

labels object

Labels to add to all generated resources

type string

Type of the secret, optional

Selector object

Selector specifies a set of resources. Any resource that matches intersection of all conditions is included in this set.

group string

The group of the referent

kind string

The kind of the referent

name string

The name of the referent

namespace string

The namespace of the referent

version string

The version of the referent

annotationSelector string

AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api

labelSelector string

LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api

Target object
name string required
apiVersion string
group string
kind string
namespace string

UNDOCUMENTED.

version string
Var object

Represents a variable whose value will be sourced from a field in a Kubernetes object.

name string required

Value of identifier name e.g. FOO used in container args, annotations, Appears in pod template as $(FOO)

objref object required
6 nested properties
name string required
apiVersion string
group string
kind string
namespace string

UNDOCUMENTED.

version string
fieldref object

Contains the fieldPath to an object field

1 nested properties
fieldpath string