Kustomize API reference

The GitOps Toolkit Custom Resource Definitions documentation.

Packages:

kustomize.toolkit.fluxcd.io/v1beta2

Package v1beta2 contains API Schema definitions for the kustomize.toolkit.fluxcd.io v1beta2 API group.

Resource Types:

Kustomization

Kustomization is the Schema for the kustomizations API.

FieldDescription
apiVersion
string
kustomize.toolkit.fluxcd.io/v1beta2
kind
string
Kustomization
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
KustomizationSpec


dependsOn
[]github.com/fluxcd/pkg/apis/meta.NamespacedObjectReference
(Optional)

DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled.

decryption
Decryption
(Optional)

Decrypt Kubernetes secrets before applying them on the cluster.

interval
Kubernetes meta/v1.Duration

The interval at which to reconcile the Kustomization.

retryInterval
Kubernetes meta/v1.Duration
(Optional)

The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the KustomizationSpec.Interval value to retry failures.

kubeConfig
github.com/fluxcd/pkg/apis/meta.KubeConfigReference
(Optional)

The KubeConfig for reconciling the Kustomization on a remote cluster. When used in combination with KustomizationSpec.ServiceAccountName, forces the controller to act on behalf of that Service Account at the target cluster. If the –default-service-account flag is set, its value will be used as a controller level fallback for when KustomizationSpec.ServiceAccountName is empty.

path
string
(Optional)

Path to the directory containing the kustomization.yaml file, or the set of plain YAMLs a kustomization.yaml should be generated for. Defaults to ‘None’, which translates to the root path of the SourceRef.

postBuild
PostBuild
(Optional)

PostBuild describes which actions to perform on the YAML manifest generated by building the kustomize overlay.

prune
bool

Prune enables garbage collection.

healthChecks
[]github.com/fluxcd/pkg/apis/meta.NamespacedObjectKindReference
(Optional)

A list of resources to be included in the health assessment.

patches
[]github.com/fluxcd/pkg/apis/kustomize.Patch
(Optional)

Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors.

patchesStrategicMerge
[]Kubernetes pkg/apis/apiextensions/v1.JSON
(Optional)

Strategic merge patches, defined as inline YAML objects. Deprecated: Use Patches instead.

patchesJson6902
[]github.com/fluxcd/pkg/apis/kustomize.JSON6902Patch
(Optional)

JSON 6902 patches, defined as inline YAML objects. Deprecated: Use Patches instead.

images
[]github.com/fluxcd/pkg/apis/kustomize.Image
(Optional)

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.

serviceAccountName
string
(Optional)

The name of the Kubernetes service account to impersonate when reconciling this Kustomization.

sourceRef
CrossNamespaceSourceReference

Reference of the source where the kustomization file is.

suspend
bool
(Optional)

This flag tells the controller to suspend subsequent kustomize executions, it does not apply to already started executions. Defaults to false.

targetNamespace
string
(Optional)

TargetNamespace sets or overrides the namespace in the kustomization.yaml file.

timeout
Kubernetes meta/v1.Duration
(Optional)

Timeout for validation, apply and health checking operations. Defaults to ‘Interval’ duration.

force
bool
(Optional)

Force instructs the controller to recreate resources when patching fails due to an immutable field change.

wait
bool
(Optional)

Wait instructs the controller to check the health of all the reconciled resources. When enabled, the HealthChecks are ignored. Defaults to false.

validation
string
(Optional)

Deprecated: Not used in v1beta2.

status
KustomizationStatus

CrossNamespaceSourceReference

(Appears on: KustomizationSpec)

CrossNamespaceSourceReference contains enough information to let you locate the typed Kubernetes resource object at cluster level.

FieldDescription
apiVersion
string
(Optional)

API version of the referent.

kind
string

Kind of the referent.

name
string

Name of the referent.

namespace
string
(Optional)

Namespace of the referent, defaults to the namespace of the Kubernetes resource object that contains the reference.

Decryption

(Appears on: KustomizationSpec)

Decryption defines how decryption is handled for Kubernetes manifests.

FieldDescription
provider
string

Provider is the name of the decryption engine.

secretRef
github.com/fluxcd/pkg/apis/meta.LocalObjectReference
(Optional)

The secret name containing the private OpenPGP keys used for decryption.

KustomizationSpec

(Appears on: Kustomization)

KustomizationSpec defines the configuration to calculate the desired state from a Source using Kustomize.

FieldDescription
dependsOn
[]github.com/fluxcd/pkg/apis/meta.NamespacedObjectReference
(Optional)

DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled.

decryption
Decryption
(Optional)

Decrypt Kubernetes secrets before applying them on the cluster.

interval
Kubernetes meta/v1.Duration

The interval at which to reconcile the Kustomization.

retryInterval
Kubernetes meta/v1.Duration
(Optional)

The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the KustomizationSpec.Interval value to retry failures.

kubeConfig
github.com/fluxcd/pkg/apis/meta.KubeConfigReference
(Optional)

The KubeConfig for reconciling the Kustomization on a remote cluster. When used in combination with KustomizationSpec.ServiceAccountName, forces the controller to act on behalf of that Service Account at the target cluster. If the –default-service-account flag is set, its value will be used as a controller level fallback for when KustomizationSpec.ServiceAccountName is empty.

path
string
(Optional)

Path to the directory containing the kustomization.yaml file, or the set of plain YAMLs a kustomization.yaml should be generated for. Defaults to ‘None’, which translates to the root path of the SourceRef.

postBuild
PostBuild
(Optional)

PostBuild describes which actions to perform on the YAML manifest generated by building the kustomize overlay.

prune
bool

Prune enables garbage collection.

healthChecks
[]github.com/fluxcd/pkg/apis/meta.NamespacedObjectKindReference
(Optional)

A list of resources to be included in the health assessment.

patches
[]github.com/fluxcd/pkg/apis/kustomize.Patch
(Optional)

Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors.

patchesStrategicMerge
[]Kubernetes pkg/apis/apiextensions/v1.JSON
(Optional)

Strategic merge patches, defined as inline YAML objects. Deprecated: Use Patches instead.

patchesJson6902
[]github.com/fluxcd/pkg/apis/kustomize.JSON6902Patch
(Optional)

JSON 6902 patches, defined as inline YAML objects. Deprecated: Use Patches instead.

images
[]github.com/fluxcd/pkg/apis/kustomize.Image
(Optional)

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.

serviceAccountName
string
(Optional)

The name of the Kubernetes service account to impersonate when reconciling this Kustomization.

sourceRef
CrossNamespaceSourceReference

Reference of the source where the kustomization file is.

suspend
bool
(Optional)

This flag tells the controller to suspend subsequent kustomize executions, it does not apply to already started executions. Defaults to false.

targetNamespace
string
(Optional)

TargetNamespace sets or overrides the namespace in the kustomization.yaml file.

timeout
Kubernetes meta/v1.Duration
(Optional)

Timeout for validation, apply and health checking operations. Defaults to ‘Interval’ duration.

force
bool
(Optional)

Force instructs the controller to recreate resources when patching fails due to an immutable field change.

wait
bool
(Optional)

Wait instructs the controller to check the health of all the reconciled resources. When enabled, the HealthChecks are ignored. Defaults to false.

validation
string
(Optional)

Deprecated: Not used in v1beta2.

KustomizationStatus

(Appears on: Kustomization)

KustomizationStatus defines the observed state of a kustomization.

FieldDescription
ReconcileRequestStatus
github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus

(Members of ReconcileRequestStatus are embedded into this type.)

observedGeneration
int64
(Optional)

ObservedGeneration is the last reconciled generation.

conditions
[]Kubernetes meta/v1.Condition
(Optional)
lastAppliedRevision
string
(Optional)

The last successfully applied revision. The revision format for Git sources is /.

lastAttemptedRevision
string
(Optional)

LastAttemptedRevision is the revision of the last reconciliation attempt.

inventory
ResourceInventory
(Optional)

Inventory contains the list of Kubernetes resource object references that have been successfully applied.

PostBuild

(Appears on: KustomizationSpec)

PostBuild describes which actions to perform on the YAML manifest generated by building the kustomize overlay.

FieldDescription
substitute
map[string]string
(Optional)

Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}.

substituteFrom
[]SubstituteReference
(Optional)

SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names and they must match the vars declared in the manifests for the substitution to happen.

ResourceInventory

(Appears on: KustomizationStatus)

ResourceInventory contains a list of Kubernetes resource object references that have been applied by a Kustomization.

FieldDescription
entries
[]ResourceRef

Entries of Kubernetes resource object references.

ResourceRef

(Appears on: ResourceInventory)

ResourceRef contains the information necessary to locate a resource within a cluster.

FieldDescription
id
string

ID is the string representation of the Kubernetes resource object’s metadata, in the format ‘_’.

v
string

Version is the API version of the Kubernetes resource object’s kind.

SubstituteReference

(Appears on: PostBuild)

SubstituteReference contains a reference to a resource containing the variables name and value.

FieldDescription
kind
string

Kind of the values referent, valid values are (‘Secret’, ‘ConfigMap’).

name
string

Name of the values referent. Should reside in the same namespace as the referring resource.

optional
bool
(Optional)

Optional indicates whether the referenced resource must exist, or whether to tolerate its absence. If true and the referenced resource is absent, proceed as if the resource was present but empty, without any variables defined.

This page was automatically generated with gen-crd-api-reference-docs