Kustomize API reference

Packages:

kustomize.toolkit.fluxcd.io/v1beta1

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

Resource Types:

Kustomization

Kustomization is the Schema for the kustomizations API.

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


dependsOn
[]Runtime dependency.CrossNamespaceDependencyReference
(Optional)

DependsOn may contain a dependency.CrossNamespaceDependencyReference 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.

kubeConfig
KubeConfig
(Optional)

The KubeConfig for reconciling the Kustomization on a remote cluster.

path
string

Path to the directory containing the kustomization file.

prune
bool

Prune enables garbage collection.

healthChecks
[]CrossNamespaceObjectReference
(Optional)

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

serviceAccount
ServiceAccount
(Optional)

The Kubernetes service account used for applying the 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.

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

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, defaults to ‘apps/v1’

kind
string

Kind of the referent

name
string

Name of the referent

namespace
string
(Optional)

Namespace of the referent

CrossNamespaceSourceReference

(Appears on: KustomizationSpec)

CrossNamespaceSourceReference 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, defaults to the Kustomization namespace

Decryption

(Appears on: KustomizationSpec)

Decryption defines how decryption is handled for Kubernetes manifests.

Field Description
provider
string

Provider is the name of the decryption engine.

secretRef
Kubernetes core/v1.LocalObjectReference
(Optional)

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

KubeConfig

(Appears on: KustomizationSpec)

KubeConfig references a Kubernetes secret that contains a kubeconfig file.

Field Description
secretRef
Kubernetes core/v1.LocalObjectReference

SecretRef holds the name to a secret that contains a ‘value’ key with the kubeconfig file as the value. It 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.

KustomizationSpec

(Appears on: Kustomization)

KustomizationSpec defines the desired state of a kustomization.

Field Description
dependsOn
[]Runtime dependency.CrossNamespaceDependencyReference
(Optional)

DependsOn may contain a dependency.CrossNamespaceDependencyReference 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.

kubeConfig
KubeConfig
(Optional)

The KubeConfig for reconciling the Kustomization on a remote cluster.

path
string

Path to the directory containing the kustomization file.

prune
bool

Prune enables garbage collection.

healthChecks
[]CrossNamespaceObjectReference
(Optional)

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

serviceAccount
ServiceAccount
(Optional)

The Kubernetes service account used for applying the 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.

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
[]github.com/fluxcd/pkg/apis/meta.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.

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

(Members of ReconcileRequestStatus are embedded into this type.)

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
checksum
string

The manifests sha1 checksum.

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.

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