diff --git a/api/v1/doc.go b/api/v1/doc.go index d96907b1..fa70fe1d 100644 --- a/api/v1/doc.go +++ b/api/v1/doc.go @@ -14,7 +14,8 @@ See the License for the specific language governing permissions and limitations under the License. */ -// Package v1 contains API Schema definitions for the kustomize.toolkit.fluxcd.io v1 API group. +// Package v1 contains API Schema definitions for the kustomize.toolkit.fluxcd.io +// v1 API group. // +kubebuilder:object:generate=true // +groupName=kustomize.toolkit.fluxcd.io package v1 diff --git a/api/v1/inventory_types.go b/api/v1/inventory_types.go index 83fc9e71..69e52146 100644 --- a/api/v1/inventory_types.go +++ b/api/v1/inventory_types.go @@ -16,7 +16,8 @@ limitations under the License. package v1 -// ResourceInventory contains a list of Kubernetes resource object references that have been applied by a Kustomization. +// ResourceInventory contains a list of Kubernetes resource object references +// that have been applied by a Kustomization. type ResourceInventory struct { // Entries of Kubernetes resource object references. Entries []ResourceRef `json:"entries"` diff --git a/api/v1/kustomization_types.go b/api/v1/kustomization_types.go index 19ac5197..15e86bca 100644 --- a/api/v1/kustomization_types.go +++ b/api/v1/kustomization_types.go @@ -33,10 +33,12 @@ const ( MergeValue = "merge" ) -// KustomizationSpec defines the configuration to calculate the desired state from a Source using Kustomize. +// KustomizationSpec defines the configuration to calculate the desired state +// from a Source using Kustomize. type KustomizationSpec struct { - // 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. + // 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. // +optional CommonMetadata *CommonMetadata `json:"commonMetadata,omitempty"` @@ -139,8 +141,8 @@ type KustomizationSpec struct { // +optional Force bool `json:"force,omitempty"` - // Wait instructs the controller to check the health of all the reconciled resources. - // When enabled, the HealthChecks are ignored. Defaults to false. + // Wait instructs the controller to check the health of all the reconciled + // resources. When enabled, the HealthChecks are ignored. Defaults to false. // +optional Wait bool `json:"wait,omitempty"` @@ -176,9 +178,8 @@ type Decryption struct { // generated by building the kustomize overlay. type PostBuild struct { // 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. + // 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}. // +optional @@ -186,8 +187,9 @@ type PostBuild struct { // 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. + // 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. // +optional SubstituteFrom []SubstituteReference `json:"substituteFrom,omitempty"` } @@ -235,7 +237,8 @@ type KustomizationStatus struct { // +optional LastAttemptedRevision string `json:"lastAttemptedRevision,omitempty"` - // Inventory contains the list of Kubernetes resource object references that have been successfully applied. + // Inventory contains the list of Kubernetes resource object references that + // have been successfully applied. // +optional Inventory *ResourceInventory `json:"inventory,omitempty"` } diff --git a/api/v1/reference_types.go b/api/v1/reference_types.go index e466cbd0..cf0d9abd 100644 --- a/api/v1/reference_types.go +++ b/api/v1/reference_types.go @@ -34,7 +34,8 @@ type CrossNamespaceSourceReference struct { // +required Name string `json:"name"` - // Namespace of the referent, defaults to the namespace of the Kubernetes resource object that contains the reference. + // Namespace of the referent, defaults to the namespace of the Kubernetes + // resource object that contains the reference. // +optional Namespace string `json:"namespace,omitempty"` } diff --git a/config/crd/bases/kustomize.toolkit.fluxcd.io_kustomizations.yaml b/config/crd/bases/kustomize.toolkit.fluxcd.io_kustomizations.yaml index 730c375a..f5b6ec48 100644 --- a/config/crd/bases/kustomize.toolkit.fluxcd.io_kustomizations.yaml +++ b/config/crd/bases/kustomize.toolkit.fluxcd.io_kustomizations.yaml @@ -280,7 +280,7 @@ spec: description: 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 + represent the var names, and they must match the vars declared in the manifests for the substitution to happen. items: description: SubstituteReference contains a reference to a resource diff --git a/docs/api/v1/kustomize.md b/docs/api/v1/kustomize.md index da5b640f..76c1804b 100644 --- a/docs/api/v1/kustomize.md +++ b/docs/api/v1/kustomize.md @@ -6,7 +6,8 @@

kustomize.toolkit.fluxcd.io/v1

-

Package v1 contains API Schema definitions for the kustomize.toolkit.fluxcd.io v1 API group.

+

Package v1 contains API Schema definitions for the kustomize.toolkit.fluxcd.io +v1 API group.

Resource Types: