fluxcd
/
kustomize-controller
mirror of https://github.com/fluxcd/kustomize-controller.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
kustomize-controller/docs/api/kustomize.md

22 KiB
Raw Blame History

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.
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
KubeConfig 		(Optional)

The KubeConfig for reconciling the Kustomization on a remote cluster. When specified, KubeConfig takes precedence over ServiceAccountName.
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)

Patches (also called overlays), defined as inline YAML objects.
patchesStrategicMerge
[]Kubernetes pkg/apis/apiextensions/v1.JSON 		(Optional)

Strategic merge patches, defined as inline YAML objects.
patchesJson6902
[]github.com/fluxcd/pkg/apis/kustomize.JSON6902Patch 		(Optional)

JSON 6902 patches, defined as inline YAML objects.
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.
validation
string 		(Optional)

Validate the Kubernetes objects before applying them on the cluster. The validation strategy can be ‘client’ (local dry-run), ‘server’ (APIServer dry-run) or ‘none’. When ‘Force’ is ‘true’, validation will fallback to ‘client’ if set to ‘server’ because server-side validation is not supported in this scenario.
force
bool 		(Optional)

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

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
github.com/fluxcd/pkg/apis/meta.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
github.com/fluxcd/pkg/apis/meta.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.
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
KubeConfig 		(Optional)

The KubeConfig for reconciling the Kustomization on a remote cluster. When specified, KubeConfig takes precedence over ServiceAccountName.
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)

Patches (also called overlays), defined as inline YAML objects.
patchesStrategicMerge
[]Kubernetes pkg/apis/apiextensions/v1.JSON 		(Optional)

Strategic merge patches, defined as inline YAML objects.
patchesJson6902
[]github.com/fluxcd/pkg/apis/kustomize.JSON6902Patch 		(Optional)

JSON 6902 patches, defined as inline YAML objects.
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.
validation
string 		(Optional)

Validate the Kubernetes objects before applying them on the cluster. The validation strategy can be ‘client’ (local dry-run), ‘server’ (APIServer dry-run) or ‘none’. When ‘Force’ is ‘true’, validation will fallback to ‘client’ if set to ‘server’ because server-side validation is not supported in this scenario.
force
bool 		(Optional)

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

KustomizationStatus

(Appears on: Kustomization)

KustomizationStatus defines the observed state of a kustomization.

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

PostBuild

(Appears on: KustomizationSpec)

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

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

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.

SubstituteReference

(Appears on: PostBuild)

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

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

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