Kustomize API reference

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.

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

SecretRef holds the name of a secret that contains a key with the kubeconfig file as the value. If no key is set, the key will default to ‘value’. The secret must be in the same namespace as the Kustomization. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific cmd-path auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling the Kustomization.

DependsOn may contain a meta.NamespacedObjectReference 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.

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.

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

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

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

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

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.

Deprecated: Not used in v1beta2.

(Members of ReconcileRequestStatus are embedded into this type.)

ObservedGeneration is the last reconciled generation.

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

LastAttemptedRevision is the revision of the last reconciliation attempt.

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

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.