kustomize-controller/docs/api/kustomize.md

Kustomize API reference

Packages:

• kustomize.toolkit.fluxcd.io/v1alpha1

kustomize.toolkit.fluxcd.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the kustomize v1alpha1 API group

Resource Types:

• Kustomization

Kustomization

Kustomization is the Schema for the kustomizations API.

Field	Description
apiVersion string	kustomize.toolkit.fluxcd.io/v1alpha1
kind string	Kustomization
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec KustomizationSpec	dependsOn []string (Optional) A list of kustomizations that must be ready before this kustomization can be applied. interval Kubernetes meta/v1.Duration The interval at which to apply the kustomization. path string Path to the directory containing the kustomization file. prune bool Enables garbage collection. healthChecks []WorkloadReference (Optional) A list of workloads (Deployments, DaemonSets and StatefulSets) to be included in the health assessment. serviceAccount ServiceAccount (Optional) The Kubernetes service account used for applying the kustomization. sourceRef CrossNamespaceObjectReference 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. timeout Kubernetes meta/v1.Duration (Optional) Timeout for validation, apply and health checking operations. Defaults to ‘Interval’ duration. validation string (Optional) Validate the Kubernetes objects before applying them on the cluster. The validation strategy can be ‘client’ (local dry-run) or ‘server’ (APIServer dry-run).
status KustomizationStatus

Condition

(Appears on: KustomizationStatus)

Condition contains condition information for a kustomization.

Field	Description
type string	Type of the condition, currently (‘Ready’).
status Kubernetes core/v1.ConditionStatus	Status of the condition, one of (‘True’, ‘False’, ‘Unknown’).
lastTransitionTime Kubernetes meta/v1.Time	LastTransitionTime is the timestamp corresponding to the last status change of this condition.
reason string	Reason is a brief machine readable explanation for the condition’s last transition.
message string	(Optional) Message is a human readable description of the details of the last transition, complementing reason.

CrossNamespaceObjectReference

(Appears on: KustomizationSpec)

CrossNamespaceObjectReference contains enough information to let you locate the typed referenced object at cluster level

Field	Description
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

KustomizationSpec

(Appears on: Kustomization)

KustomizationSpec defines the desired state of a kustomization.

Field	Description
dependsOn []string	(Optional) A list of kustomizations that must be ready before this kustomization can be applied.
interval Kubernetes meta/v1.Duration	The interval at which to apply the kustomization.
path string	Path to the directory containing the kustomization file.
prune bool	Enables garbage collection.
healthChecks []WorkloadReference	(Optional) A list of workloads (Deployments, DaemonSets and StatefulSets) to be included in the health assessment.
serviceAccount ServiceAccount	(Optional) The Kubernetes service account used for applying the kustomization.
sourceRef CrossNamespaceObjectReference	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.
timeout Kubernetes meta/v1.Duration	(Optional) Timeout for validation, apply and health checking operations. Defaults to ‘Interval’ duration.
validation string	(Optional) Validate the Kubernetes objects before applying them on the cluster. The validation strategy can be ‘client’ (local dry-run) or ‘server’ (APIServer dry-run).

KustomizationStatus

(Appears on: Kustomization)

KustomizationStatus defines the observed state of a kustomization.

Field	Description
observedGeneration int64	(Optional) ObservedGeneration is the last reconciled generation.
conditions []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.
snapshot Snapshot	(Optional) The last successfully applied revision metadata.

ServiceAccount

(Appears on: KustomizationSpec)

ServiceAccount defines a reference to a Kubernetes service account.

Field	Description
name string	Name is the name of the service account being referenced.
namespace string	Namespace is the namespace of the service account being referenced.

Snapshot

(Appears on: KustomizationStatus)

Snapshot holds the metadata of the Kubernetes objects generated for a source revision

Field	Description
revision string	The source revision.
entries []SnapshotEntry	A list of Kubernetes kinds grouped by namespace.

SnapshotEntry

(Appears on: Snapshot)

Snapshot holds the metadata of namespaced Kubernetes objects

Field	Description
namespace string	(Optional) The namespace of this entry.
kinds map[string]string	The list of Kubernetes kinds.

Unsortable ([][]string alias)

WorkloadReference

(Appears on: KustomizationSpec)

WorkloadReference defines a reference to a Deployment, DaemonSet or StatefulSet.

Field	Description
kind string	Kind is the type of resource being referenced.
name string	Name is the name of resource being referenced.
namespace string	Namespace is the namespace of resource being referenced.

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