Kustomize API reference v1

Annotations to be added to the object’s metadata.

Labels to be added to the object’s metadata.

API version of the referent.

Kind of the referent.

Name of the referent.

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

Provider is the name of the decryption engine.

ServiceAccountName is the name of the service account used to authenticate with KMS services from cloud providers. If a static credential for a given cloud provider is defined inside the Secret referenced by SecretRef, that static credential takes priority.

The secret name containing the private OpenPGP keys used for decryption. A static credential for a cloud provider defined inside the Secret takes priority to secret-less authentication with the ServiceAccountName field.

Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from consideration in a Kubernetes object.

Target is a selector for specifying Kubernetes objects to which this rule applies. If Target is not set, the Paths will be ignored for all Kubernetes objects within the manifest of the Kustomization.

CommonMetadata specifies the common labels and annotations that are applied to all resources. Any existing label or annotation will be overridden if its key matches a common one.

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

Decrypt Kubernetes secrets before applying them on the cluster.

The interval at which to reconcile the Kustomization. This interval is approximate and may be subject to jitter to ensure efficient use of resources.

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

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 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 describes which actions to perform on the YAML manifest generated by building the kustomize overlay.

Prune enables garbage collection.

DeletionPolicy can be used to control garbage collection when this Kustomization is deleted. Valid values are (‘MirrorPrune’, ‘Delete’, ‘WaitForTermination’, ‘Orphan’). ‘MirrorPrune’ mirrors the Prune field (orphan if false, delete if true). Defaults to ‘MirrorPrune’.

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

NamePrefix will prefix the names of all managed resources.

NameSuffix will suffix the names of all managed resources.

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

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.

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

Reference of the source where the kustomization file is.

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

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

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

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

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

BuildMetadata specifies which kustomize build metadata should be added to the built resources. The allowed values are ‘originAnnotations’ to annotate resources with their source origin, and ‘transformerAnnotations’ to annotate resources with the transformers that produced them.

Components specifies relative paths to kustomize Components.

IgnoreMissingComponents instructs the controller to ignore Components paths not found in source by removing them from the generated kustomization.yaml before running kustomize build.

HealthCheckExprs is a list of healthcheck expressions for evaluating the health of custom resources using Common Expression Language (CEL). The expressions are evaluated only when Wait or HealthChecks are specified.

Ignore is a list of rules for specifying which changes to ignore during drift detection. These rules are applied to the resources managed by the Kustomization and are used to exclude specific JSON pointer paths from the drift detection and apply process.

(Members of ReconcileRequestStatus are embedded into this type.)

ObservedGeneration is the last reconciled generation.

The last successfully applied revision. Equals the Revision of the applied Artifact from the referenced Source.

The last successfully applied origin revision. Equals the origin revision of the applied Artifact from the referenced Source. Usually present on the Metadata of the applied Artifact and depends on the Source type, e.g. for OCI it’s the value associated with the key “org.opencontainers.image.revision”.

LastAttemptedRevision is the revision of the last reconciliation attempt.

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

History contains a set of snapshots of the last reconciliation attempts tracking the revision, the state and the duration of each attempt.

SubstituteStrategy defines the strategy for substituting variables in the YAML manifests. Valid values are:

• WithVariables (the default): require at least one variable to be defined, either through the inline map or through the resolved references to ConfigMaps and Secrets.
• Always: perform the substitution even if no variables are defined.

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 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.

Entries of Kubernetes resource object references.

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

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

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

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

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.

Instances is the list of known OpenBao/Vault instances.

Address is the address of the OpenBao/Vault instance, matching the address stored in the SOPS metadata of the encrypted data key.

LoginPath is the API path of the login endpoint to authenticate to this instance with, e.g. “auth/kubernetes/login”. It is used verbatim, so it supports any JWT-backed auth method (e.g. the Kubernetes or JWT auth method) and namespace-prefixed paths (e.g. “ns1/ns2/auth/kubernetes/login”).