diff --git a/api/v1beta1/cluster_types.go b/api/v1beta1/cluster_types.go index ad0c43f6e0a0..383873af9738 100644 --- a/api/v1beta1/cluster_types.go +++ b/api/v1beta1/cluster_types.go @@ -1047,7 +1047,9 @@ type Cluster struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec ClusterSpec `json:"spec,omitempty"` + // spec is the desired state of Cluster. + Spec ClusterSpec `json:"spec,omitempty"` + // status is the observed state of Cluster. Status ClusterStatus `json:"status,omitempty"` } @@ -1180,7 +1182,8 @@ func (f ClusterIPFamily) String() string { type ClusterList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []Cluster `json:"items"` + // items is the list of Clusters. + Items []Cluster `json:"items"` } func init() { diff --git a/api/v1beta1/clusterclass_types.go b/api/v1beta1/clusterclass_types.go index e14552c1667e..f81de4f6aa67 100644 --- a/api/v1beta1/clusterclass_types.go +++ b/api/v1beta1/clusterclass_types.go @@ -75,7 +75,9 @@ type ClusterClass struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec ClusterClassSpec `json:"spec,omitempty"` + // spec is the desired state of ClusterClass. + Spec ClusterClassSpec `json:"spec,omitempty"` + // status is the observed state of ClusterClass. Status ClusterClassStatus `json:"status,omitempty"` } @@ -1073,7 +1075,8 @@ func (c *ClusterClass) SetV1Beta2Conditions(conditions []metav1.Condition) { type ClusterClassList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []ClusterClass `json:"items"` + // items is the list of ClusterClasses. + Items []ClusterClass `json:"items"` } func init() { diff --git a/api/v1beta1/machine_types.go b/api/v1beta1/machine_types.go index fccc584fe5a4..79a4655f592e 100644 --- a/api/v1beta1/machine_types.go +++ b/api/v1beta1/machine_types.go @@ -666,7 +666,9 @@ type Machine struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec MachineSpec `json:"spec,omitempty"` + // spec is the desired state of Machine. + Spec MachineSpec `json:"spec,omitempty"` + // status is the observed state of Machine. Status MachineStatus `json:"status,omitempty"` } @@ -702,7 +704,8 @@ func (m *Machine) SetV1Beta2Conditions(conditions []metav1.Condition) { type MachineList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []Machine `json:"items"` + // items is the list of Machines. + Items []Machine `json:"items"` } func init() { diff --git a/api/v1beta1/machinedeployment_types.go b/api/v1beta1/machinedeployment_types.go index bc3ab7092f69..aedf78b15025 100644 --- a/api/v1beta1/machinedeployment_types.go +++ b/api/v1beta1/machinedeployment_types.go @@ -585,7 +585,9 @@ type MachineDeployment struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec MachineDeploymentSpec `json:"spec,omitempty"` + // spec is the desired state of MachineDeployment. + Spec MachineDeploymentSpec `json:"spec,omitempty"` + // status is the observed state of MachineDeployment. Status MachineDeploymentStatus `json:"status,omitempty"` } @@ -595,7 +597,8 @@ type MachineDeployment struct { type MachineDeploymentList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []MachineDeployment `json:"items"` + // items is the list of MachineDeployments. + Items []MachineDeployment `json:"items"` } func init() { diff --git a/api/v1beta1/machinehealthcheck_types.go b/api/v1beta1/machinehealthcheck_types.go index 4be5d9e37b93..a3f1ff722173 100644 --- a/api/v1beta1/machinehealthcheck_types.go +++ b/api/v1beta1/machinehealthcheck_types.go @@ -244,7 +244,8 @@ func (m *MachineHealthCheck) SetV1Beta2Conditions(conditions []metav1.Condition) type MachineHealthCheckList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []MachineHealthCheck `json:"items"` + // items is the list of MachineHealthChecks. + Items []MachineHealthCheck `json:"items"` } func init() { diff --git a/api/v1beta1/machineset_types.go b/api/v1beta1/machineset_types.go index e90d5797228d..a68eb600eea0 100644 --- a/api/v1beta1/machineset_types.go +++ b/api/v1beta1/machineset_types.go @@ -422,7 +422,9 @@ type MachineSet struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec MachineSetSpec `json:"spec,omitempty"` + // spec is the desired state of MachineSet. + Spec MachineSetSpec `json:"spec,omitempty"` + // status is the observed state of MachineSet. Status MachineSetStatus `json:"status,omitempty"` } @@ -458,7 +460,8 @@ func (m *MachineSet) SetV1Beta2Conditions(conditions []metav1.Condition) { type MachineSetList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []MachineSet `json:"items"` + // items is the list of MachineSets. + Items []MachineSet `json:"items"` } func init() { diff --git a/api/v1beta1/zz_generated.openapi.go b/api/v1beta1/zz_generated.openapi.go index ee601f90f5ba..09d2cf1ac3a1 100644 --- a/api/v1beta1/zz_generated.openapi.go +++ b/api/v1beta1/zz_generated.openapi.go @@ -211,14 +211,16 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_Cluster(ref common.ReferenceCallba }, "spec": { SchemaProps: spec.SchemaProps{ - Default: map[string]interface{}{}, - Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ClusterSpec"), + Description: "spec is the desired state of Cluster.", + Default: map[string]interface{}{}, + Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ClusterSpec"), }, }, "status": { SchemaProps: spec.SchemaProps{ - Default: map[string]interface{}{}, - Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ClusterStatus"), + Description: "status is the observed state of Cluster.", + Default: map[string]interface{}{}, + Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ClusterStatus"), }, }, }, @@ -280,14 +282,16 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClass(ref common.ReferenceC }, "spec": { SchemaProps: spec.SchemaProps{ - Default: map[string]interface{}{}, - Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ClusterClassSpec"), + Description: "spec is the desired state of ClusterClass.", + Default: map[string]interface{}{}, + Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ClusterClassSpec"), }, }, "status": { SchemaProps: spec.SchemaProps{ - Default: map[string]interface{}{}, - Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ClusterClassStatus"), + Description: "status is the observed state of ClusterClass.", + Default: map[string]interface{}{}, + Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ClusterClassStatus"), }, }, }, @@ -327,7 +331,8 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassList(ref common.Refere }, "items": { SchemaProps: spec.SchemaProps{ - Type: []string{"array"}, + Description: "items is the list of ClusterClasses.", + Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ SchemaProps: spec.SchemaProps{ @@ -822,7 +827,8 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterList(ref common.ReferenceCa }, "items": { SchemaProps: spec.SchemaProps{ - Type: []string{"array"}, + Description: "items is the list of Clusters.", + Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ SchemaProps: spec.SchemaProps{ @@ -1863,14 +1869,16 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_Machine(ref common.ReferenceCallba }, "spec": { SchemaProps: spec.SchemaProps{ - Default: map[string]interface{}{}, - Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineSpec"), + Description: "spec is the desired state of Machine.", + Default: map[string]interface{}{}, + Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineSpec"), }, }, "status": { SchemaProps: spec.SchemaProps{ - Default: map[string]interface{}{}, - Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineStatus"), + Description: "status is the observed state of Machine.", + Default: map[string]interface{}{}, + Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineStatus"), }, }, }, @@ -1967,14 +1975,16 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeployment(ref common.Refer }, "spec": { SchemaProps: spec.SchemaProps{ - Default: map[string]interface{}{}, - Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineDeploymentSpec"), + Description: "spec is the desired state of MachineDeployment.", + Default: map[string]interface{}{}, + Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineDeploymentSpec"), }, }, "status": { SchemaProps: spec.SchemaProps{ - Default: map[string]interface{}{}, - Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineDeploymentStatus"), + Description: "status is the observed state of MachineDeployment.", + Default: map[string]interface{}{}, + Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineDeploymentStatus"), }, }, }, @@ -2152,7 +2162,8 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentList(ref common.R }, "items": { SchemaProps: spec.SchemaProps{ - Type: []string{"array"}, + Description: "items is the list of MachineDeployments.", + Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ SchemaProps: spec.SchemaProps{ @@ -2953,7 +2964,8 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineHealthCheckList(ref common. }, "items": { SchemaProps: spec.SchemaProps{ - Type: []string{"array"}, + Description: "items is the list of MachineHealthChecks.", + Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ SchemaProps: spec.SchemaProps{ @@ -3251,7 +3263,8 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineList(ref common.ReferenceCa }, "items": { SchemaProps: spec.SchemaProps{ - Type: []string{"array"}, + Description: "items is the list of Machines.", + Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ SchemaProps: spec.SchemaProps{ @@ -3639,14 +3652,16 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineSet(ref common.ReferenceCal }, "spec": { SchemaProps: spec.SchemaProps{ - Default: map[string]interface{}{}, - Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineSetSpec"), + Description: "spec is the desired state of MachineSet.", + Default: map[string]interface{}{}, + Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineSetSpec"), }, }, "status": { SchemaProps: spec.SchemaProps{ - Default: map[string]interface{}{}, - Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineSetStatus"), + Description: "status is the observed state of MachineSet.", + Default: map[string]interface{}{}, + Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineSetStatus"), }, }, }, @@ -3686,7 +3701,8 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineSetList(ref common.Referenc }, "items": { SchemaProps: spec.SchemaProps{ - Type: []string{"array"}, + Description: "items is the list of MachineSets.", + Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ SchemaProps: spec.SchemaProps{ diff --git a/bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go b/bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go index ea2956d30857..6faa8309dec0 100644 --- a/bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go +++ b/bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go @@ -477,7 +477,9 @@ type KubeadmConfig struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec KubeadmConfigSpec `json:"spec,omitempty"` + // spec is the desired state of KubeadmConfig. + Spec KubeadmConfigSpec `json:"spec,omitempty"` + // status is the observed state of KubeadmConfig. Status KubeadmConfigStatus `json:"status,omitempty"` } @@ -513,7 +515,8 @@ func (c *KubeadmConfig) SetV1Beta2Conditions(conditions []metav1.Condition) { type KubeadmConfigList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []KubeadmConfig `json:"items"` + // items is the list of KubeadmConfigs. + Items []KubeadmConfig `json:"items"` } func init() { diff --git a/bootstrap/kubeadm/api/v1beta1/kubeadmconfigtemplate_types.go b/bootstrap/kubeadm/api/v1beta1/kubeadmconfigtemplate_types.go index 46e970474223..27f0fdb19da3 100644 --- a/bootstrap/kubeadm/api/v1beta1/kubeadmconfigtemplate_types.go +++ b/bootstrap/kubeadm/api/v1beta1/kubeadmconfigtemplate_types.go @@ -35,6 +35,7 @@ type KubeadmConfigTemplateResource struct { // +optional ObjectMeta clusterv1.ObjectMeta `json:"metadata,omitempty"` + // spec is the desired state of KubeadmConfig. Spec KubeadmConfigSpec `json:"spec,omitempty"` } @@ -48,6 +49,7 @@ type KubeadmConfigTemplate struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` + // spec is the desired state of KubeadmConfigTemplate. Spec KubeadmConfigTemplateSpec `json:"spec,omitempty"` } @@ -57,7 +59,8 @@ type KubeadmConfigTemplate struct { type KubeadmConfigTemplateList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []KubeadmConfigTemplate `json:"items"` + // items is the list of KubeadmConfigTemplates. + Items []KubeadmConfigTemplate `json:"items"` } func init() { diff --git a/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigs.yaml b/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigs.yaml index 6044cbcfff2b..b6b4c1f15866 100644 --- a/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigs.yaml +++ b/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigs.yaml @@ -43,9 +43,7 @@ spec: metadata: type: object spec: - description: |- - KubeadmConfigSpec defines the desired state of KubeadmConfig. - Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined. + description: spec is the desired state of KubeadmConfig. properties: clusterConfiguration: description: clusterConfiguration along with InitConfiguration are @@ -937,7 +935,7 @@ spec: type: integer type: object status: - description: KubeadmConfigStatus defines the observed state of KubeadmConfig. + description: status is the observed state of KubeadmConfig. properties: bootstrapData: description: |- @@ -1047,9 +1045,7 @@ spec: metadata: type: object spec: - description: |- - KubeadmConfigSpec defines the desired state of KubeadmConfig. - Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined. + description: spec is the desired state of KubeadmConfig. properties: clusterConfiguration: description: clusterConfiguration along with InitConfiguration are @@ -1938,7 +1934,7 @@ spec: type: integer type: object status: - description: KubeadmConfigStatus defines the observed state of KubeadmConfig. + description: status is the observed state of KubeadmConfig. properties: conditions: description: conditions defines current service state of the KubeadmConfig. @@ -2041,9 +2037,7 @@ spec: metadata: type: object spec: - description: |- - KubeadmConfigSpec defines the desired state of KubeadmConfig. - Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined. + description: spec is the desired state of KubeadmConfig. properties: clusterConfiguration: description: clusterConfiguration along with InitConfiguration are @@ -3703,7 +3697,7 @@ spec: type: integer type: object status: - description: KubeadmConfigStatus defines the observed state of KubeadmConfig. + description: status is the observed state of KubeadmConfig. properties: conditions: description: conditions defines current service state of the KubeadmConfig. diff --git a/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigtemplates.yaml b/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigtemplates.yaml index a797eb07113b..3dfd5ba11e86 100644 --- a/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigtemplates.yaml +++ b/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigtemplates.yaml @@ -43,15 +43,13 @@ spec: metadata: type: object spec: - description: KubeadmConfigTemplateSpec defines the desired state of KubeadmConfigTemplate. + description: spec is the desired state of KubeadmConfigTemplate. properties: template: description: template defines the desired state of KubeadmConfigTemplate. properties: spec: - description: |- - KubeadmConfigSpec defines the desired state of KubeadmConfig. - Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined. + description: spec is the desired state of KubeadmConfig. properties: clusterConfiguration: description: clusterConfiguration along with InitConfiguration @@ -1002,15 +1000,13 @@ spec: metadata: type: object spec: - description: KubeadmConfigTemplateSpec defines the desired state of KubeadmConfigTemplate. + description: spec is the desired state of KubeadmConfigTemplate. properties: template: description: template defines the desired state of KubeadmConfigTemplate. properties: spec: - description: |- - KubeadmConfigSpec defines the desired state of KubeadmConfig. - Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined. + description: spec is the desired state of KubeadmConfig. properties: clusterConfiguration: description: clusterConfiguration along with InitConfiguration @@ -1958,7 +1954,7 @@ spec: metadata: type: object spec: - description: KubeadmConfigTemplateSpec defines the desired state of KubeadmConfigTemplate. + description: spec is the desired state of KubeadmConfigTemplate. properties: template: description: template defines the desired state of KubeadmConfigTemplate. @@ -1988,9 +1984,7 @@ spec: type: object type: object spec: - description: |- - KubeadmConfigSpec defines the desired state of KubeadmConfig. - Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined. + description: spec is the desired state of KubeadmConfig. properties: clusterConfiguration: description: clusterConfiguration along with InitConfiguration diff --git a/cmd/clusterctl/api/v1alpha3/metadata_type.go b/cmd/clusterctl/api/v1alpha3/metadata_type.go index 6533491fb2ed..cb9ee9274ccc 100644 --- a/cmd/clusterctl/api/v1alpha3/metadata_type.go +++ b/cmd/clusterctl/api/v1alpha3/metadata_type.go @@ -29,6 +29,7 @@ type Metadata struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` + // releaseSeries maps a provider release series (major/minor) with an API Version of Cluster API (contract). // +optional ReleaseSeries []ReleaseSeries `json:"releaseSeries"` } diff --git a/cmd/clusterctl/api/v1alpha3/provider_type.go b/cmd/clusterctl/api/v1alpha3/provider_type.go index d7bb6235ad88..e96b49c53426 100644 --- a/cmd/clusterctl/api/v1alpha3/provider_type.go +++ b/cmd/clusterctl/api/v1alpha3/provider_type.go @@ -166,7 +166,8 @@ func (p ProviderType) Order() int { type ProviderList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []Provider `json:"items"` + // items is the list of Providers. + Items []Provider `json:"items"` } // FilterByNamespace returns a new list of providers that reside in the namespace provided. diff --git a/cmd/clusterctl/config/crd/bases/clusterctl.cluster.x-k8s.io_metadata.yaml b/cmd/clusterctl/config/crd/bases/clusterctl.cluster.x-k8s.io_metadata.yaml index c004e8b150a4..0694276856d4 100644 --- a/cmd/clusterctl/config/crd/bases/clusterctl.cluster.x-k8s.io_metadata.yaml +++ b/cmd/clusterctl/config/crd/bases/clusterctl.cluster.x-k8s.io_metadata.yaml @@ -37,6 +37,8 @@ spec: metadata: type: object releaseSeries: + description: releaseSeries maps a provider release series (major/minor) + with an API Version of Cluster API (contract). items: description: ReleaseSeries maps a provider release series (major/minor) with a API Version of Cluster API (contract). diff --git a/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesetbindings.yaml b/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesetbindings.yaml index 01bd41f11e35..51dc52ed03bb 100644 --- a/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesetbindings.yaml +++ b/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesetbindings.yaml @@ -43,8 +43,7 @@ spec: metadata: type: object spec: - description: ClusterResourceSetBindingSpec defines the desired state of - ClusterResourceSetBinding. + description: spec is the desired state of ClusterResourceSetBinding. properties: bindings: description: bindings is a list of ClusterResourceSets and their resources. @@ -138,8 +137,7 @@ spec: metadata: type: object spec: - description: ClusterResourceSetBindingSpec defines the desired state of - ClusterResourceSetBinding. + description: spec is the desired state of ClusterResourceSetBinding. properties: bindings: description: bindings is a list of ClusterResourceSets and their resources. @@ -230,8 +228,7 @@ spec: metadata: type: object spec: - description: ClusterResourceSetBindingSpec defines the desired state of - ClusterResourceSetBinding. + description: spec is the desired state of ClusterResourceSetBinding. properties: bindings: description: bindings is a list of ClusterResourceSets and their resources. diff --git a/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesets.yaml b/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesets.yaml index bee120a0d543..abd6628e42f8 100644 --- a/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesets.yaml +++ b/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesets.yaml @@ -43,7 +43,7 @@ spec: metadata: type: object spec: - description: ClusterResourceSetSpec defines the desired state of ClusterResourceSet. + description: spec is the desired state of ClusterResourceSet. properties: clusterSelector: description: |- @@ -127,7 +127,7 @@ spec: - clusterSelector type: object status: - description: ClusterResourceSetStatus defines the observed state of ClusterResourceSet. + description: status is the observed state of ClusterResourceSet. properties: conditions: description: conditions defines current state of the ClusterResourceSet. @@ -216,7 +216,7 @@ spec: metadata: type: object spec: - description: ClusterResourceSetSpec defines the desired state of ClusterResourceSet. + description: spec is the desired state of ClusterResourceSet. properties: clusterSelector: description: |- @@ -301,7 +301,7 @@ spec: - clusterSelector type: object status: - description: ClusterResourceSetStatus defines the observed state of ClusterResourceSet. + description: status is the observed state of ClusterResourceSet. properties: conditions: description: conditions defines current state of the ClusterResourceSet. @@ -388,7 +388,7 @@ spec: metadata: type: object spec: - description: ClusterResourceSetSpec defines the desired state of ClusterResourceSet. + description: spec is the desired state of ClusterResourceSet. properties: clusterSelector: description: |- @@ -474,7 +474,7 @@ spec: - clusterSelector type: object status: - description: ClusterResourceSetStatus defines the observed state of ClusterResourceSet. + description: status is the observed state of ClusterResourceSet. properties: conditions: description: conditions defines current state of the ClusterResourceSet. diff --git a/config/crd/bases/cluster.x-k8s.io_clusterclasses.yaml b/config/crd/bases/cluster.x-k8s.io_clusterclasses.yaml index d67b02bcba89..331eaeb52a1a 100644 --- a/config/crd/bases/cluster.x-k8s.io_clusterclasses.yaml +++ b/config/crd/bases/cluster.x-k8s.io_clusterclasses.yaml @@ -50,7 +50,7 @@ spec: metadata: type: object spec: - description: ClusterClassSpec describes the desired state of the ClusterClass. + description: spec is the desired state of ClusterClass. properties: controlPlane: description: |- @@ -444,7 +444,7 @@ spec: metadata: type: object spec: - description: ClusterClassSpec describes the desired state of the ClusterClass. + description: spec is the desired state of ClusterClass. properties: controlPlane: description: |- @@ -2009,7 +2009,7 @@ spec: type: object type: object status: - description: ClusterClassStatus defines the observed state of the ClusterClass. + description: status is the observed state of ClusterClass. properties: conditions: description: conditions defines current observed state of the ClusterClass. diff --git a/config/crd/bases/cluster.x-k8s.io_clusters.yaml b/config/crd/bases/cluster.x-k8s.io_clusters.yaml index 0ffba4740e2a..afee3debe599 100644 --- a/config/crd/bases/cluster.x-k8s.io_clusters.yaml +++ b/config/crd/bases/cluster.x-k8s.io_clusters.yaml @@ -47,7 +47,7 @@ spec: metadata: type: object spec: - description: ClusterSpec defines the desired state of Cluster. + description: spec is the desired state of Cluster. properties: clusterNetwork: description: clusterNetwork is the cluster network configuration. @@ -197,7 +197,7 @@ spec: type: boolean type: object status: - description: ClusterStatus defines the observed state of Cluster. + description: status is the observed state of Cluster. properties: conditions: description: conditions defines current service state of the cluster. @@ -337,7 +337,7 @@ spec: metadata: type: object spec: - description: ClusterSpec defines the desired state of Cluster. + description: spec is the desired state of Cluster. properties: clusterNetwork: description: clusterNetwork is the cluster network configuration. @@ -614,7 +614,7 @@ spec: type: object type: object status: - description: ClusterStatus defines the observed state of Cluster. + description: status is the observed state of Cluster. properties: conditions: description: conditions defines current service state of the cluster. @@ -755,7 +755,7 @@ spec: metadata: type: object spec: - description: ClusterSpec defines the desired state of Cluster. + description: spec is the desired state of Cluster. properties: availabilityGates: description: |- @@ -1729,7 +1729,7 @@ spec: type: object type: object status: - description: ClusterStatus defines the observed state of Cluster. + description: status is the observed state of Cluster. properties: conditions: description: conditions defines current service state of the cluster. diff --git a/config/crd/bases/cluster.x-k8s.io_machinedeployments.yaml b/config/crd/bases/cluster.x-k8s.io_machinedeployments.yaml index 31184dfe4f67..c4f247e0de16 100644 --- a/config/crd/bases/cluster.x-k8s.io_machinedeployments.yaml +++ b/config/crd/bases/cluster.x-k8s.io_machinedeployments.yaml @@ -67,7 +67,7 @@ spec: metadata: type: object spec: - description: MachineDeploymentSpec defines the desired state of MachineDeployment. + description: spec is the desired state of MachineDeployment. properties: clusterName: description: clusterName is the name of the Cluster this object belongs @@ -498,7 +498,7 @@ spec: - template type: object status: - description: MachineDeploymentStatus defines the observed state of MachineDeployment. + description: status is the observed state of MachineDeployment. properties: availableReplicas: description: |- @@ -614,7 +614,7 @@ spec: metadata: type: object spec: - description: MachineDeploymentSpec defines the desired state of MachineDeployment. + description: spec is the desired state of MachineDeployment. properties: clusterName: description: clusterName is the name of the Cluster this object belongs @@ -952,7 +952,7 @@ spec: - template type: object status: - description: MachineDeploymentStatus defines the observed state of MachineDeployment. + description: status is the observed state of MachineDeployment. properties: availableReplicas: description: |- @@ -1117,7 +1117,7 @@ spec: metadata: type: object spec: - description: MachineDeploymentSpec defines the desired state of MachineDeployment. + description: spec is the desired state of MachineDeployment. properties: clusterName: description: clusterName is the name of the Cluster this object belongs @@ -1581,7 +1581,7 @@ spec: - template type: object status: - description: MachineDeploymentStatus defines the observed state of MachineDeployment. + description: status is the observed state of MachineDeployment. properties: availableReplicas: description: |- diff --git a/config/crd/bases/cluster.x-k8s.io_machinepools.yaml b/config/crd/bases/cluster.x-k8s.io_machinepools.yaml index 9a0ab37c1a01..3ca0ceb05043 100644 --- a/config/crd/bases/cluster.x-k8s.io_machinepools.yaml +++ b/config/crd/bases/cluster.x-k8s.io_machinepools.yaml @@ -59,7 +59,7 @@ spec: metadata: type: object spec: - description: MachinePoolSpec defines the desired state of MachinePool. + description: spec is the desired state of MachinePool. properties: clusterName: description: clusterName is the name of the Cluster this object belongs @@ -434,7 +434,7 @@ spec: - template type: object status: - description: MachinePoolStatus defines the observed state of MachinePool. + description: status is the observed state of MachinePool. properties: availableReplicas: description: availableReplicas is the number of available replicas @@ -633,7 +633,7 @@ spec: metadata: type: object spec: - description: MachinePoolSpec defines the desired state of MachinePool. + description: spec is the desired state of MachinePool. properties: clusterName: description: clusterName is the name of the Cluster this object belongs @@ -847,7 +847,7 @@ spec: - template type: object status: - description: MachinePoolStatus defines the observed state of MachinePool. + description: status is the observed state of MachinePool. properties: availableReplicas: description: availableReplicas is the number of available replicas @@ -1051,7 +1051,7 @@ spec: metadata: type: object spec: - description: MachinePoolSpec defines the desired state of MachinePool. + description: spec is the desired state of MachinePool. properties: clusterName: description: clusterName is the name of the Cluster this object belongs @@ -1313,7 +1313,7 @@ spec: - template type: object status: - description: MachinePoolStatus defines the observed state of MachinePool. + description: status is the observed state of MachinePool. properties: availableReplicas: description: availableReplicas is the number of available replicas diff --git a/config/crd/bases/cluster.x-k8s.io_machines.yaml b/config/crd/bases/cluster.x-k8s.io_machines.yaml index 00262ad68cf9..763d966bf609 100644 --- a/config/crd/bases/cluster.x-k8s.io_machines.yaml +++ b/config/crd/bases/cluster.x-k8s.io_machines.yaml @@ -63,7 +63,7 @@ spec: metadata: type: object spec: - description: MachineSpec defines the desired state of Machine. + description: spec is the desired state of Machine. properties: bootstrap: description: |- @@ -215,7 +215,7 @@ spec: - infrastructureRef type: object status: - description: MachineStatus defines the observed state of Machine. + description: status is the observed state of Machine. properties: addresses: description: |- @@ -450,7 +450,7 @@ spec: metadata: type: object spec: - description: MachineSpec defines the desired state of Machine. + description: spec is the desired state of Machine. properties: bootstrap: description: |- @@ -595,7 +595,7 @@ spec: - infrastructureRef type: object status: - description: MachineStatus defines the observed state of Machine. + description: status is the observed state of Machine. properties: addresses: description: |- @@ -881,7 +881,7 @@ spec: metadata: type: object spec: - description: MachineSpec defines the desired state of Machine. + description: spec is the desired state of Machine. properties: bootstrap: description: |- @@ -1074,7 +1074,7 @@ spec: - infrastructureRef type: object status: - description: MachineStatus defines the observed state of Machine. + description: status is the observed state of Machine. properties: addresses: description: |- diff --git a/config/crd/bases/cluster.x-k8s.io_machinesets.yaml b/config/crd/bases/cluster.x-k8s.io_machinesets.yaml index 08096efda338..e97e0fdd6c5a 100644 --- a/config/crd/bases/cluster.x-k8s.io_machinesets.yaml +++ b/config/crd/bases/cluster.x-k8s.io_machinesets.yaml @@ -58,7 +58,7 @@ spec: metadata: type: object spec: - description: MachineSetSpec defines the desired state of MachineSet. + description: spec is the desired state of MachineSet. properties: clusterName: description: clusterName is the name of the Cluster this object belongs @@ -426,7 +426,7 @@ spec: - selector type: object status: - description: MachineSetStatus defines the observed state of MachineSet. + description: status is the observed state of MachineSet. properties: availableReplicas: description: availableReplicas is the number of available replicas @@ -548,7 +548,7 @@ spec: metadata: type: object spec: - description: MachineSetSpec defines the desired state of MachineSet. + description: spec is the desired state of MachineSet. properties: clusterName: description: clusterName is the name of the Cluster this object belongs @@ -811,7 +811,7 @@ spec: - selector type: object status: - description: MachineSetStatus defines the observed state of MachineSet. + description: status is the observed state of MachineSet. properties: availableReplicas: description: availableReplicas is the number of available replicas @@ -982,7 +982,7 @@ spec: metadata: type: object spec: - description: MachineSetSpec defines the desired state of MachineSet. + description: spec is the desired state of MachineSet. properties: clusterName: description: clusterName is the name of the Cluster this object belongs @@ -1332,7 +1332,7 @@ spec: - selector type: object status: - description: MachineSetStatus defines the observed state of MachineSet. + description: status is the observed state of MachineSet. properties: availableReplicas: description: availableReplicas is the number of available replicas diff --git a/config/crd/bases/ipam.cluster.x-k8s.io_ipaddressclaims.yaml b/config/crd/bases/ipam.cluster.x-k8s.io_ipaddressclaims.yaml index ae1207e601a4..fafacfb5a267 100644 --- a/config/crd/bases/ipam.cluster.x-k8s.io_ipaddressclaims.yaml +++ b/config/crd/bases/ipam.cluster.x-k8s.io_ipaddressclaims.yaml @@ -52,7 +52,7 @@ spec: metadata: type: object spec: - description: IPAddressClaimSpec is the desired state of an IPAddressClaim. + description: spec is the desired state of IPAddressClaim. properties: poolRef: description: poolRef is a reference to the pool from which an IP address @@ -79,7 +79,7 @@ spec: - poolRef type: object status: - description: IPAddressClaimStatus is the observed status of a IPAddressClaim. + description: status is the observed state of IPAddressClaim. properties: addressRef: description: addressRef is a reference to the address that was created @@ -183,7 +183,7 @@ spec: metadata: type: object spec: - description: IPAddressClaimSpec is the desired state of an IPAddressClaim. + description: spec is the desired state of IPAddressClaim. properties: clusterName: description: clusterName is the name of the Cluster this object belongs @@ -214,7 +214,7 @@ spec: - poolRef type: object status: - description: IPAddressClaimStatus is the observed status of a IPAddressClaim. + description: status is the observed state of IPAddressClaim. properties: addressRef: description: addressRef is a reference to the address that was created diff --git a/config/crd/bases/ipam.cluster.x-k8s.io_ipaddresses.yaml b/config/crd/bases/ipam.cluster.x-k8s.io_ipaddresses.yaml index 2738d24a51f9..241d28a18859 100644 --- a/config/crd/bases/ipam.cluster.x-k8s.io_ipaddresses.yaml +++ b/config/crd/bases/ipam.cluster.x-k8s.io_ipaddresses.yaml @@ -56,7 +56,7 @@ spec: metadata: type: object spec: - description: IPAddressSpec is the desired state of an IPAddress. + description: spec is the desired state of IPAddress. properties: address: description: address is the IP address. @@ -154,7 +154,7 @@ spec: metadata: type: object spec: - description: IPAddressSpec is the desired state of an IPAddress. + description: spec is the desired state of IPAddress. properties: address: description: address is the IP address. diff --git a/config/crd/bases/runtime.cluster.x-k8s.io_extensionconfigs.yaml b/config/crd/bases/runtime.cluster.x-k8s.io_extensionconfigs.yaml index ac4a13e07a65..a1e285905892 100644 --- a/config/crd/bases/runtime.cluster.x-k8s.io_extensionconfigs.yaml +++ b/config/crd/bases/runtime.cluster.x-k8s.io_extensionconfigs.yaml @@ -46,7 +46,7 @@ spec: metadata: type: object spec: - description: spec is the desired state of the ExtensionConfig + description: spec is the desired state of the ExtensionConfig. properties: clientConfig: description: clientConfig defines how to communicate with the Extension diff --git a/controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go b/controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go index 58d20cae96f0..95241a3d1c4f 100644 --- a/controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go +++ b/controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go @@ -408,7 +408,9 @@ type KubeadmControlPlane struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec KubeadmControlPlaneSpec `json:"spec,omitempty"` + // spec is the desired state of KubeadmControlPlane. + Spec KubeadmControlPlaneSpec `json:"spec,omitempty"` + // status is the observed state of KubeadmControlPlane. Status KubeadmControlPlaneStatus `json:"status,omitempty"` } @@ -444,7 +446,8 @@ func (in *KubeadmControlPlane) SetV1Beta2Conditions(conditions []metav1.Conditio type KubeadmControlPlaneList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []KubeadmControlPlane `json:"items"` + // items is the list of KubeadmControlPlanes. + Items []KubeadmControlPlane `json:"items"` } func init() { diff --git a/controlplane/kubeadm/api/v1beta1/kubeadmcontrolplanetemplate_types.go b/controlplane/kubeadm/api/v1beta1/kubeadmcontrolplanetemplate_types.go index 45e82f80f508..bea9eff6fce8 100644 --- a/controlplane/kubeadm/api/v1beta1/kubeadmcontrolplanetemplate_types.go +++ b/controlplane/kubeadm/api/v1beta1/kubeadmcontrolplanetemplate_types.go @@ -39,6 +39,7 @@ type KubeadmControlPlaneTemplate struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` + // spec is the desired state of KubeadmControlPlaneTemplate. Spec KubeadmControlPlaneTemplateSpec `json:"spec,omitempty"` } @@ -48,7 +49,8 @@ type KubeadmControlPlaneTemplate struct { type KubeadmControlPlaneTemplateList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []KubeadmControlPlaneTemplate `json:"items"` + // items is the list of KubeadmControlPlaneTemplates. + Items []KubeadmControlPlaneTemplate `json:"items"` } func init() { @@ -62,6 +64,7 @@ type KubeadmControlPlaneTemplateResource struct { // +optional ObjectMeta clusterv1.ObjectMeta `json:"metadata,omitempty"` + // spec is the desired state of KubeadmControlPlaneTemplateResource. Spec KubeadmControlPlaneTemplateResourceSpec `json:"spec"` } diff --git a/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanes.yaml b/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanes.yaml index ec5031ee9fce..0f1f230d67ce 100644 --- a/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanes.yaml +++ b/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanes.yaml @@ -77,7 +77,7 @@ spec: metadata: type: object spec: - description: KubeadmControlPlaneSpec defines the desired state of KubeadmControlPlane. + description: spec is the desired state of KubeadmControlPlane. properties: infrastructureTemplate: description: |- @@ -1088,7 +1088,7 @@ spec: - version type: object status: - description: KubeadmControlPlaneStatus defines the observed state of KubeadmControlPlane. + description: status is the observed state of KubeadmControlPlane. properties: conditions: description: conditions defines current service state of the KubeadmControlPlane. @@ -1267,7 +1267,7 @@ spec: metadata: type: object spec: - description: KubeadmControlPlaneSpec defines the desired state of KubeadmControlPlane. + description: spec is the desired state of KubeadmControlPlane. properties: kubeadmConfigSpec: description: |- @@ -2313,7 +2313,7 @@ spec: - version type: object status: - description: KubeadmControlPlaneStatus defines the observed state of KubeadmControlPlane. + description: status is the observed state of KubeadmControlPlane. properties: conditions: description: conditions defines current service state of the KubeadmControlPlane. @@ -2503,7 +2503,7 @@ spec: metadata: type: object spec: - description: KubeadmControlPlaneSpec defines the desired state of KubeadmControlPlane. + description: spec is the desired state of KubeadmControlPlane. properties: kubeadmConfigSpec: description: |- @@ -4429,7 +4429,7 @@ spec: - version type: object status: - description: KubeadmControlPlaneStatus defines the observed state of KubeadmControlPlane. + description: status is the observed state of KubeadmControlPlane. properties: conditions: description: conditions defines current service state of the KubeadmControlPlane. diff --git a/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanetemplates.yaml b/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanetemplates.yaml index 587d51a5351b..33435c00701d 100644 --- a/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanetemplates.yaml +++ b/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanetemplates.yaml @@ -48,15 +48,13 @@ spec: metadata: type: object spec: - description: KubeadmControlPlaneTemplateSpec defines the desired state - of KubeadmControlPlaneTemplate. + description: spec is the desired state of KubeadmControlPlaneTemplate. properties: template: description: template defines the desired state of KubeadmControlPlaneTemplate. properties: spec: - description: KubeadmControlPlaneSpec defines the desired state - of KubeadmControlPlane. + description: spec is the desired state of KubeadmControlPlane. properties: kubeadmConfigSpec: description: |- @@ -1160,8 +1158,7 @@ spec: metadata: type: object spec: - description: KubeadmControlPlaneTemplateSpec defines the desired state - of KubeadmControlPlaneTemplate. + description: spec is the desired state of KubeadmControlPlaneTemplate. properties: template: description: template defines the desired state of KubeadmControlPlaneTemplate. @@ -1191,12 +1188,7 @@ spec: type: object type: object spec: - description: |- - KubeadmControlPlaneTemplateResourceSpec defines the desired state of KubeadmControlPlane. - NOTE: KubeadmControlPlaneTemplateResourceSpec is similar to KubeadmControlPlaneSpec but - omits Replicas and Version fields. These fields do not make sense on the KubeadmControlPlaneTemplate, - because they are calculated by the Cluster topology reconciler during reconciliation and thus cannot - be configured on the KubeadmControlPlaneTemplate. + description: spec is the desired state of KubeadmControlPlaneTemplateResource. properties: kubeadmConfigSpec: description: |- diff --git a/exp/addons/api/v1beta1/clusterresourceset_types.go b/exp/addons/api/v1beta1/clusterresourceset_types.go index f04d65d28fd7..0680672ec778 100644 --- a/exp/addons/api/v1beta1/clusterresourceset_types.go +++ b/exp/addons/api/v1beta1/clusterresourceset_types.go @@ -179,7 +179,9 @@ type ClusterResourceSet struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec ClusterResourceSetSpec `json:"spec,omitempty"` + // spec is the desired state of ClusterResourceSet. + Spec ClusterResourceSetSpec `json:"spec,omitempty"` + // status is the observed state of ClusterResourceSet. Status ClusterResourceSetStatus `json:"status,omitempty"` } @@ -189,7 +191,8 @@ type ClusterResourceSet struct { type ClusterResourceSetList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []ClusterResourceSet `json:"items"` + // items is the list of ClusterResourceSets. + Items []ClusterResourceSet `json:"items"` } func init() { diff --git a/exp/addons/api/v1beta1/clusterresourcesetbinding_types.go b/exp/addons/api/v1beta1/clusterresourcesetbinding_types.go index 937df7700c2c..7c14fdd25c64 100644 --- a/exp/addons/api/v1beta1/clusterresourcesetbinding_types.go +++ b/exp/addons/api/v1beta1/clusterresourcesetbinding_types.go @@ -175,7 +175,8 @@ func referSameObject(a, b metav1.OwnerReference) bool { type ClusterResourceSetBinding struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec ClusterResourceSetBindingSpec `json:"spec,omitempty"` + // spec is the desired state of ClusterResourceSetBinding. + Spec ClusterResourceSetBindingSpec `json:"spec,omitempty"` } // ANCHOR: ClusterResourceSetBindingSpec @@ -200,7 +201,8 @@ type ClusterResourceSetBindingSpec struct { type ClusterResourceSetBindingList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []ClusterResourceSetBinding `json:"items"` + // items is the list of ClusterResourceSetBindings. + Items []ClusterResourceSetBinding `json:"items"` } func init() { diff --git a/exp/api/v1beta1/machinepool_types.go b/exp/api/v1beta1/machinepool_types.go index 9cae2684dcd9..3b60a0728ecd 100644 --- a/exp/api/v1beta1/machinepool_types.go +++ b/exp/api/v1beta1/machinepool_types.go @@ -262,7 +262,9 @@ type MachinePool struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec MachinePoolSpec `json:"spec,omitempty"` + // spec is the desired state of MachinePool. + Spec MachinePoolSpec `json:"spec,omitempty"` + // status is the observed state of MachinePool. Status MachinePoolStatus `json:"status,omitempty"` } @@ -298,7 +300,8 @@ func (m *MachinePool) SetV1Beta2Conditions(conditions []metav1.Condition) { type MachinePoolList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []MachinePool `json:"items"` + // items is the list of MachinePools. + Items []MachinePool `json:"items"` } func init() { diff --git a/exp/ipam/api/v1alpha1/ipaddress_types.go b/exp/ipam/api/v1alpha1/ipaddress_types.go index 1ee18fadcb06..5ac9dc3fb06f 100644 --- a/exp/ipam/api/v1alpha1/ipaddress_types.go +++ b/exp/ipam/api/v1alpha1/ipaddress_types.go @@ -52,6 +52,7 @@ type IPAddress struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` + // spec is the desired state of IPAddress. Spec IPAddressSpec `json:"spec,omitempty"` } @@ -61,7 +62,8 @@ type IPAddress struct { type IPAddressList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []IPAddress `json:"items"` + // items is the list of IPAddresses. + Items []IPAddress `json:"items"` } func init() { diff --git a/exp/ipam/api/v1alpha1/ipaddressclaim_types.go b/exp/ipam/api/v1alpha1/ipaddressclaim_types.go index 02eb49db4335..2648f8b8f6df 100644 --- a/exp/ipam/api/v1alpha1/ipaddressclaim_types.go +++ b/exp/ipam/api/v1alpha1/ipaddressclaim_types.go @@ -52,7 +52,9 @@ type IPAddressClaim struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec IPAddressClaimSpec `json:"spec,omitempty"` + // spec is the desired state of IPAddressClaim. + Spec IPAddressClaimSpec `json:"spec,omitempty"` + // status is the observed state of IPAddressClaim. Status IPAddressClaimStatus `json:"status,omitempty"` } @@ -72,7 +74,8 @@ func (m *IPAddressClaim) SetConditions(conditions clusterv1.Conditions) { type IPAddressClaimList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []IPAddressClaim `json:"items"` + // items is the list of IPAddressClaims. + Items []IPAddressClaim `json:"items"` } func init() { diff --git a/exp/ipam/api/v1beta1/ipaddress_types.go b/exp/ipam/api/v1beta1/ipaddress_types.go index fd69f033f5b3..0016e3d9115b 100644 --- a/exp/ipam/api/v1beta1/ipaddress_types.go +++ b/exp/ipam/api/v1beta1/ipaddress_types.go @@ -53,6 +53,7 @@ type IPAddress struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` + // spec is the desired state of IPAddress. Spec IPAddressSpec `json:"spec,omitempty"` } @@ -62,7 +63,8 @@ type IPAddress struct { type IPAddressList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []IPAddress `json:"items"` + // items is the list of IPAddresses. + Items []IPAddress `json:"items"` } func init() { diff --git a/exp/ipam/api/v1beta1/ipaddressclaim_types.go b/exp/ipam/api/v1beta1/ipaddressclaim_types.go index 2e136196d1e5..cef223a8d584 100644 --- a/exp/ipam/api/v1beta1/ipaddressclaim_types.go +++ b/exp/ipam/api/v1beta1/ipaddressclaim_types.go @@ -57,7 +57,9 @@ type IPAddressClaim struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec IPAddressClaimSpec `json:"spec,omitempty"` + // spec is the desired state of IPAddressClaim. + Spec IPAddressClaimSpec `json:"spec,omitempty"` + // status is the observed state of IPAddressClaim. Status IPAddressClaimStatus `json:"status,omitempty"` } @@ -77,7 +79,8 @@ func (m *IPAddressClaim) SetConditions(conditions clusterv1.Conditions) { type IPAddressClaimList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []IPAddressClaim `json:"items"` + // items is the list of IPAddressClaims. + Items []IPAddressClaim `json:"items"` } func init() { diff --git a/exp/runtime/api/v1alpha1/extensionconfig_types.go b/exp/runtime/api/v1alpha1/extensionconfig_types.go index ee7cbb923877..e8d4ef4fee7c 100644 --- a/exp/runtime/api/v1alpha1/extensionconfig_types.go +++ b/exp/runtime/api/v1alpha1/extensionconfig_types.go @@ -186,7 +186,7 @@ type ExtensionConfig struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - // spec is the desired state of the ExtensionConfig + // spec is the desired state of the ExtensionConfig. Spec ExtensionConfigSpec `json:"spec,omitempty"` // status is the current state of the ExtensionConfig @@ -225,7 +225,8 @@ func (e *ExtensionConfig) SetV1Beta2Conditions(conditions []metav1.Condition) { type ExtensionConfigList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []ExtensionConfig `json:"items"` + // items is the list of ExtensionConfigs. + Items []ExtensionConfig `json:"items"` } func init() { diff --git a/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go b/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go index 5361c480cb26..9ba997983d87 100644 --- a/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go +++ b/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go @@ -27,10 +27,14 @@ const BuiltinsName = "builtin" // Builtins represents builtin variables exposed through patches. type Builtins struct { - Cluster *ClusterBuiltins `json:"cluster,omitempty"` - ControlPlane *ControlPlaneBuiltins `json:"controlPlane,omitempty"` + // cluster represents builtin cluster variables. + Cluster *ClusterBuiltins `json:"cluster,omitempty"` + // controlPlane represents builtin ControlPlane variables. + ControlPlane *ControlPlaneBuiltins `json:"controlPlane,omitempty"` + // machineDeployment represents builtin MachineDeployment variables. MachineDeployment *MachineDeploymentBuiltins `json:"machineDeployment,omitempty"` - MachinePool *MachinePoolBuiltins `json:"machinePool,omitempty"` + // machinePool represents builtin MachinePool variables. + MachinePool *MachinePoolBuiltins `json:"machinePool,omitempty"` } // ClusterBuiltins represents builtin cluster variables. diff --git a/exp/runtime/hooks/api/v1alpha1/zz_generated.openapi.go b/exp/runtime/hooks/api/v1alpha1/zz_generated.openapi.go index 69066c1b0658..f2e89debc290 100644 --- a/exp/runtime/hooks/api/v1alpha1/zz_generated.openapi.go +++ b/exp/runtime/hooks/api/v1alpha1/zz_generated.openapi.go @@ -734,22 +734,26 @@ func schema_runtime_hooks_api_v1alpha1_Builtins(ref common.ReferenceCallback) co Properties: map[string]spec.Schema{ "cluster": { SchemaProps: spec.SchemaProps{ - Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.ClusterBuiltins"), + Description: "cluster represents builtin cluster variables.", + Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.ClusterBuiltins"), }, }, "controlPlane": { SchemaProps: spec.SchemaProps{ - Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.ControlPlaneBuiltins"), + Description: "controlPlane represents builtin ControlPlane variables.", + Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.ControlPlaneBuiltins"), }, }, "machineDeployment": { SchemaProps: spec.SchemaProps{ - Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.MachineDeploymentBuiltins"), + Description: "machineDeployment represents builtin MachineDeployment variables.", + Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.MachineDeploymentBuiltins"), }, }, "machinePool": { SchemaProps: spec.SchemaProps{ - Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.MachinePoolBuiltins"), + Description: "machinePool represents builtin MachinePool variables.", + Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.MachinePoolBuiltins"), }, }, }, diff --git a/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfig_types.go b/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfig_types.go index 234eb28489a3..e5b79bcbc882 100644 --- a/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfig_types.go +++ b/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfig_types.go @@ -144,7 +144,9 @@ type KubeadmConfig struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec KubeadmConfigSpec `json:"spec,omitempty"` + // spec is the desired state of KubeadmConfig. + Spec KubeadmConfigSpec `json:"spec,omitempty"` + // status is the observed state of KubeadmConfig. Status KubeadmConfigStatus `json:"status,omitempty"` } @@ -166,7 +168,8 @@ func (c *KubeadmConfig) SetConditions(conditions clusterv1alpha3.Conditions) { type KubeadmConfigList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []KubeadmConfig `json:"items"` + // items is the list of KubeadmConfigs. + Items []KubeadmConfig `json:"items"` } func init() { diff --git a/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfigtemplate_types.go b/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfigtemplate_types.go index b592026f644f..faadfeb91ece 100644 --- a/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfigtemplate_types.go +++ b/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfigtemplate_types.go @@ -28,6 +28,7 @@ type KubeadmConfigTemplateSpec struct { // KubeadmConfigTemplateResource defines the Template structure. type KubeadmConfigTemplateResource struct { + // spec is the desired state of KubeadmConfig. Spec KubeadmConfigSpec `json:"spec,omitempty"` } @@ -43,6 +44,7 @@ type KubeadmConfigTemplate struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` + // spec is the desired state of KubeadmConfigTemplate. Spec KubeadmConfigTemplateSpec `json:"spec,omitempty"` } @@ -54,7 +56,8 @@ type KubeadmConfigTemplate struct { type KubeadmConfigTemplateList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []KubeadmConfigTemplate `json:"items"` + // items is the list of KubeadmConfigTemplates. + Items []KubeadmConfigTemplate `json:"items"` } func init() { diff --git a/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfig_types.go b/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfig_types.go index 9f823e17a86f..69d536557629 100644 --- a/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfig_types.go +++ b/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfig_types.go @@ -137,7 +137,9 @@ type KubeadmConfig struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec KubeadmConfigSpec `json:"spec,omitempty"` + // spec is the desired state of KubeadmConfig. + Spec KubeadmConfigSpec `json:"spec,omitempty"` + // status is the observed state of KubeadmConfig. Status KubeadmConfigStatus `json:"status,omitempty"` } @@ -159,7 +161,8 @@ func (c *KubeadmConfig) SetConditions(conditions clusterv1alpha4.Conditions) { type KubeadmConfigList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []KubeadmConfig `json:"items"` + // items is the list of KubeadmConfigs. + Items []KubeadmConfig `json:"items"` } func init() { diff --git a/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfigtemplate_types.go b/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfigtemplate_types.go index 1ec1e6f9689e..b7043f4870d9 100644 --- a/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfigtemplate_types.go +++ b/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfigtemplate_types.go @@ -28,6 +28,7 @@ type KubeadmConfigTemplateSpec struct { // KubeadmConfigTemplateResource defines the Template structure. type KubeadmConfigTemplateResource struct { + // spec is the desired state of KubeadmConfig. Spec KubeadmConfigSpec `json:"spec,omitempty"` } @@ -44,6 +45,7 @@ type KubeadmConfigTemplate struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` + // spec is the desired state of KubeadmConfigTemplate. Spec KubeadmConfigTemplateSpec `json:"spec,omitempty"` } @@ -55,7 +57,8 @@ type KubeadmConfigTemplate struct { type KubeadmConfigTemplateList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []KubeadmConfigTemplate `json:"items"` + // items is the list of KubeadmConfigTemplates. + Items []KubeadmConfigTemplate `json:"items"` } func init() { diff --git a/internal/apis/controlplane/kubeadm/v1alpha3/kubeadm_control_plane_types.go b/internal/apis/controlplane/kubeadm/v1alpha3/kubeadm_control_plane_types.go index e1be47f0996b..cbed19eb5cfb 100644 --- a/internal/apis/controlplane/kubeadm/v1alpha3/kubeadm_control_plane_types.go +++ b/internal/apis/controlplane/kubeadm/v1alpha3/kubeadm_control_plane_types.go @@ -204,7 +204,9 @@ type KubeadmControlPlane struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec KubeadmControlPlaneSpec `json:"spec,omitempty"` + // spec is the desired state of KubeadmControlPlane. + Spec KubeadmControlPlaneSpec `json:"spec,omitempty"` + // status is the observed state of KubeadmControlPlane. Status KubeadmControlPlaneStatus `json:"status,omitempty"` } @@ -226,7 +228,8 @@ func (in *KubeadmControlPlane) SetConditions(conditions clusterv1alpha3.Conditio type KubeadmControlPlaneList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []KubeadmControlPlane `json:"items"` + // items is the list of KubeadmControlPlanes. + Items []KubeadmControlPlane `json:"items"` } func init() { diff --git a/internal/apis/controlplane/kubeadm/v1alpha4/kubeadm_control_plane_types.go b/internal/apis/controlplane/kubeadm/v1alpha4/kubeadm_control_plane_types.go index 53426c32f6fc..a9486098da59 100644 --- a/internal/apis/controlplane/kubeadm/v1alpha4/kubeadm_control_plane_types.go +++ b/internal/apis/controlplane/kubeadm/v1alpha4/kubeadm_control_plane_types.go @@ -219,7 +219,9 @@ type KubeadmControlPlane struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec KubeadmControlPlaneSpec `json:"spec,omitempty"` + // spec is the desired state of KubeadmControlPlane. + Spec KubeadmControlPlaneSpec `json:"spec,omitempty"` + // status is the observed state of KubeadmControlPlane. Status KubeadmControlPlaneStatus `json:"status,omitempty"` } @@ -241,7 +243,8 @@ func (in *KubeadmControlPlane) SetConditions(conditions clusterv1alpha4.Conditio type KubeadmControlPlaneList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []KubeadmControlPlane `json:"items"` + // items is the list of KubeadmControlPlanes. + Items []KubeadmControlPlane `json:"items"` } func init() { diff --git a/internal/apis/controlplane/kubeadm/v1alpha4/kubeadmcontrolplanetemplate_types.go b/internal/apis/controlplane/kubeadm/v1alpha4/kubeadmcontrolplanetemplate_types.go index 28c9c71f3a98..eb31bcae3bdb 100644 --- a/internal/apis/controlplane/kubeadm/v1alpha4/kubeadmcontrolplanetemplate_types.go +++ b/internal/apis/controlplane/kubeadm/v1alpha4/kubeadmcontrolplanetemplate_types.go @@ -39,6 +39,7 @@ type KubeadmControlPlaneTemplate struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` + // spec is the desired state of KubeadmControlPlaneTemplate. Spec KubeadmControlPlaneTemplateSpec `json:"spec,omitempty"` } @@ -50,7 +51,8 @@ type KubeadmControlPlaneTemplate struct { type KubeadmControlPlaneTemplateList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []KubeadmControlPlaneTemplate `json:"items"` + // items is the list of KubeadmControlPlaneTemplates. + Items []KubeadmControlPlaneTemplate `json:"items"` } func init() { @@ -59,5 +61,6 @@ func init() { // KubeadmControlPlaneTemplateResource describes the data needed to create a KubeadmControlPlane from a template. type KubeadmControlPlaneTemplateResource struct { + // spec is the desired state of KubeadmControlPlane. Spec KubeadmControlPlaneSpec `json:"spec"` } diff --git a/internal/apis/core/exp/addons/v1alpha3/clusterresourceset_types.go b/internal/apis/core/exp/addons/v1alpha3/clusterresourceset_types.go index cdb82cebaa5c..04c56d6b8f2a 100644 --- a/internal/apis/core/exp/addons/v1alpha3/clusterresourceset_types.go +++ b/internal/apis/core/exp/addons/v1alpha3/clusterresourceset_types.go @@ -123,7 +123,9 @@ type ClusterResourceSet struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec ClusterResourceSetSpec `json:"spec,omitempty"` + // spec is the desired state of ClusterResourceSet. + Spec ClusterResourceSetSpec `json:"spec,omitempty"` + // status is the observed state of ClusterResourceSet. Status ClusterResourceSetStatus `json:"status,omitempty"` } @@ -135,7 +137,8 @@ type ClusterResourceSet struct { type ClusterResourceSetList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []ClusterResourceSet `json:"items"` + // items is the list of ClusterResourceSets. + Items []ClusterResourceSet `json:"items"` } func init() { diff --git a/internal/apis/core/exp/addons/v1alpha3/clusterresourcesetbinding_types.go b/internal/apis/core/exp/addons/v1alpha3/clusterresourcesetbinding_types.go index 78c50be68e11..f8e8c4c89606 100644 --- a/internal/apis/core/exp/addons/v1alpha3/clusterresourcesetbinding_types.go +++ b/internal/apis/core/exp/addons/v1alpha3/clusterresourcesetbinding_types.go @@ -112,7 +112,8 @@ func (c *ClusterResourceSetBinding) DeleteBinding(clusterResourceSet *ClusterRes type ClusterResourceSetBinding struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec ClusterResourceSetBindingSpec `json:"spec,omitempty"` + // spec is the desired state of ClusterResourceSetBinding. + Spec ClusterResourceSetBindingSpec `json:"spec,omitempty"` } // ANCHOR: ClusterResourceSetBindingSpec @@ -133,7 +134,8 @@ type ClusterResourceSetBindingSpec struct { type ClusterResourceSetBindingList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []ClusterResourceSetBinding `json:"items"` + // items is the list of ClusterResourceSetBindings. + Items []ClusterResourceSetBinding `json:"items"` } func init() { diff --git a/internal/apis/core/exp/addons/v1alpha4/clusterresourceset_types.go b/internal/apis/core/exp/addons/v1alpha4/clusterresourceset_types.go index 9980f4ff73fd..fe93cb6f0104 100644 --- a/internal/apis/core/exp/addons/v1alpha4/clusterresourceset_types.go +++ b/internal/apis/core/exp/addons/v1alpha4/clusterresourceset_types.go @@ -125,7 +125,9 @@ type ClusterResourceSet struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec ClusterResourceSetSpec `json:"spec,omitempty"` + // spec is the desired state of ClusterResourceSet. + Spec ClusterResourceSetSpec `json:"spec,omitempty"` + // status is the observed state of ClusterResourceSet. Status ClusterResourceSetStatus `json:"status,omitempty"` } @@ -137,7 +139,8 @@ type ClusterResourceSet struct { type ClusterResourceSetList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []ClusterResourceSet `json:"items"` + // items is the list of ClusterResourceSets. + Items []ClusterResourceSet `json:"items"` } func init() { diff --git a/internal/apis/core/exp/addons/v1alpha4/clusterresourcesetbinding_types.go b/internal/apis/core/exp/addons/v1alpha4/clusterresourcesetbinding_types.go index 3b48a98a7c80..08807b138743 100644 --- a/internal/apis/core/exp/addons/v1alpha4/clusterresourcesetbinding_types.go +++ b/internal/apis/core/exp/addons/v1alpha4/clusterresourcesetbinding_types.go @@ -113,7 +113,8 @@ func (c *ClusterResourceSetBinding) DeleteBinding(clusterResourceSet *ClusterRes type ClusterResourceSetBinding struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec ClusterResourceSetBindingSpec `json:"spec,omitempty"` + // spec is the desired state of ClusterResourceSetBinding. + Spec ClusterResourceSetBindingSpec `json:"spec,omitempty"` } // ANCHOR: ClusterResourceSetBindingSpec @@ -134,7 +135,8 @@ type ClusterResourceSetBindingSpec struct { type ClusterResourceSetBindingList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []ClusterResourceSetBinding `json:"items"` + // items is the list of ClusterResourceSetBindings. + Items []ClusterResourceSetBinding `json:"items"` } func init() { diff --git a/internal/apis/core/exp/v1alpha3/machinepool_types.go b/internal/apis/core/exp/v1alpha3/machinepool_types.go index 2b322d42404d..afadf9125d68 100644 --- a/internal/apis/core/exp/v1alpha3/machinepool_types.go +++ b/internal/apis/core/exp/v1alpha3/machinepool_types.go @@ -221,7 +221,9 @@ type MachinePool struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec MachinePoolSpec `json:"spec,omitempty"` + // spec is the desired state of MachinePool. + Spec MachinePoolSpec `json:"spec,omitempty"` + // status is the observed state of MachinePool. Status MachinePoolStatus `json:"status,omitempty"` } @@ -243,7 +245,8 @@ func (m *MachinePool) SetConditions(conditions clusterv1alpha3.Conditions) { type MachinePoolList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []MachinePool `json:"items"` + // items is the list of MachinePools. + Items []MachinePool `json:"items"` } func init() { diff --git a/internal/apis/core/exp/v1alpha4/machinepool_types.go b/internal/apis/core/exp/v1alpha4/machinepool_types.go index 9afdd102d6f6..02d6c4e261a3 100644 --- a/internal/apis/core/exp/v1alpha4/machinepool_types.go +++ b/internal/apis/core/exp/v1alpha4/machinepool_types.go @@ -217,7 +217,9 @@ type MachinePool struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec MachinePoolSpec `json:"spec,omitempty"` + // spec is the desired state of MachinePool. + Spec MachinePoolSpec `json:"spec,omitempty"` + // status is the observed state of MachinePool. Status MachinePoolStatus `json:"status,omitempty"` } @@ -239,7 +241,8 @@ func (m *MachinePool) SetConditions(conditions clusterv1alpha4.Conditions) { type MachinePoolList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []MachinePool `json:"items"` + // items is the list of MachinePools. + Items []MachinePool `json:"items"` } func init() { diff --git a/internal/apis/core/v1alpha3/cluster_types.go b/internal/apis/core/v1alpha3/cluster_types.go index cd443a7d1666..3a6e62fd01bd 100644 --- a/internal/apis/core/v1alpha3/cluster_types.go +++ b/internal/apis/core/v1alpha3/cluster_types.go @@ -212,7 +212,9 @@ type Cluster struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec ClusterSpec `json:"spec,omitempty"` + // spec is the desired state of Cluster. + Spec ClusterSpec `json:"spec,omitempty"` + // status is the observed state of Cluster. Status ClusterStatus `json:"status,omitempty"` } @@ -232,7 +234,8 @@ func (c *Cluster) SetConditions(conditions Conditions) { type ClusterList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []Cluster `json:"items"` + // items is the list of Clusters. + Items []Cluster `json:"items"` } func init() { diff --git a/internal/apis/core/v1alpha3/machine_types.go b/internal/apis/core/v1alpha3/machine_types.go index 7d0a2324d064..5eafbc68e2a0 100644 --- a/internal/apis/core/v1alpha3/machine_types.go +++ b/internal/apis/core/v1alpha3/machine_types.go @@ -253,7 +253,9 @@ type Machine struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec MachineSpec `json:"spec,omitempty"` + // spec is the desired state of Machine. + Spec MachineSpec `json:"spec,omitempty"` + // status is the observed state of Machine. Status MachineStatus `json:"status,omitempty"` } @@ -275,7 +277,8 @@ func (m *Machine) SetConditions(conditions Conditions) { type MachineList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []Machine `json:"items"` + // items is the list of Machines. + Items []Machine `json:"items"` } func init() { diff --git a/internal/apis/core/v1alpha3/machinedeployment_types.go b/internal/apis/core/v1alpha3/machinedeployment_types.go index 4bac9d73b6c5..44f55a0d2c74 100644 --- a/internal/apis/core/v1alpha3/machinedeployment_types.go +++ b/internal/apis/core/v1alpha3/machinedeployment_types.go @@ -259,7 +259,9 @@ type MachineDeployment struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec MachineDeploymentSpec `json:"spec,omitempty"` + // spec is the desired state of MachineDeployment. + Spec MachineDeploymentSpec `json:"spec,omitempty"` + // status is the observed state of MachineDeployment. Status MachineDeploymentStatus `json:"status,omitempty"` } @@ -271,7 +273,8 @@ type MachineDeployment struct { type MachineDeploymentList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []MachineDeployment `json:"items"` + // items is the list of MachineDeployments. + Items []MachineDeployment `json:"items"` } func init() { diff --git a/internal/apis/core/v1alpha3/machinehealthcheck_types.go b/internal/apis/core/v1alpha3/machinehealthcheck_types.go index 4f0a574e4940..0d96bbed5e90 100644 --- a/internal/apis/core/v1alpha3/machinehealthcheck_types.go +++ b/internal/apis/core/v1alpha3/machinehealthcheck_types.go @@ -161,7 +161,8 @@ func (m *MachineHealthCheck) SetConditions(conditions Conditions) { type MachineHealthCheckList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []MachineHealthCheck `json:"items"` + // items is the list of MachineHealthChecks. + Items []MachineHealthCheck `json:"items"` } func init() { diff --git a/internal/apis/core/v1alpha3/machineset_types.go b/internal/apis/core/v1alpha3/machineset_types.go index 0baa12eefc40..b621a4b6cced 100644 --- a/internal/apis/core/v1alpha3/machineset_types.go +++ b/internal/apis/core/v1alpha3/machineset_types.go @@ -209,7 +209,9 @@ type MachineSet struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec MachineSetSpec `json:"spec,omitempty"` + // spec is the desired state of MachineSet. + Spec MachineSetSpec `json:"spec,omitempty"` + // status is the observed state of MachineSet. Status MachineSetStatus `json:"status,omitempty"` } @@ -221,7 +223,8 @@ type MachineSet struct { type MachineSetList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []MachineSet `json:"items"` + // items is the list of MachineSets. + Items []MachineSet `json:"items"` } func init() { diff --git a/internal/apis/core/v1alpha4/cluster_types.go b/internal/apis/core/v1alpha4/cluster_types.go index 68d94c28a2e1..0abd779630fb 100644 --- a/internal/apis/core/v1alpha4/cluster_types.go +++ b/internal/apis/core/v1alpha4/cluster_types.go @@ -291,7 +291,9 @@ type Cluster struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec ClusterSpec `json:"spec,omitempty"` + // spec is the desired state of Cluster. + Spec ClusterSpec `json:"spec,omitempty"` + // status is the observed state of Cluster. Status ClusterStatus `json:"status,omitempty"` } @@ -397,7 +399,8 @@ func (f ClusterIPFamily) String() string { type ClusterList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []Cluster `json:"items"` + // items is the list of Clusters. + Items []Cluster `json:"items"` } func init() { diff --git a/internal/apis/core/v1alpha4/clusterclass_types.go b/internal/apis/core/v1alpha4/clusterclass_types.go index 0ab9c0e349ed..174c39ee2ff0 100644 --- a/internal/apis/core/v1alpha4/clusterclass_types.go +++ b/internal/apis/core/v1alpha4/clusterclass_types.go @@ -34,6 +34,7 @@ type ClusterClass struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` + // spec is the desired state of ClusterClass. Spec ClusterClassSpec `json:"spec,omitempty"` } @@ -130,7 +131,8 @@ type LocalObjectTemplate struct { type ClusterClassList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []ClusterClass `json:"items"` + // items is the list of ClusterClasses. + Items []ClusterClass `json:"items"` } func init() { diff --git a/internal/apis/core/v1alpha4/machine_types.go b/internal/apis/core/v1alpha4/machine_types.go index ef74d2c71036..39aea0387379 100644 --- a/internal/apis/core/v1alpha4/machine_types.go +++ b/internal/apis/core/v1alpha4/machine_types.go @@ -252,7 +252,9 @@ type Machine struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec MachineSpec `json:"spec,omitempty"` + // spec is the desired state of Machine. + Spec MachineSpec `json:"spec,omitempty"` + // status is the observed state of Machine. Status MachineStatus `json:"status,omitempty"` } @@ -274,7 +276,8 @@ func (m *Machine) SetConditions(conditions Conditions) { type MachineList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []Machine `json:"items"` + // items is the list of Machines. + Items []Machine `json:"items"` } func init() { diff --git a/internal/apis/core/v1alpha4/machinedeployment_types.go b/internal/apis/core/v1alpha4/machinedeployment_types.go index 99422ee3f17e..5fac912ff874 100644 --- a/internal/apis/core/v1alpha4/machinedeployment_types.go +++ b/internal/apis/core/v1alpha4/machinedeployment_types.go @@ -290,7 +290,9 @@ type MachineDeployment struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec MachineDeploymentSpec `json:"spec,omitempty"` + // spec is the desired state of MachineDeployment. + Spec MachineDeploymentSpec `json:"spec,omitempty"` + // status is the observed state of MachineDeployment. Status MachineDeploymentStatus `json:"status,omitempty"` } @@ -302,7 +304,8 @@ type MachineDeployment struct { type MachineDeploymentList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []MachineDeployment `json:"items"` + // items is the list of MachineDeployments. + Items []MachineDeployment `json:"items"` } func init() { diff --git a/internal/apis/core/v1alpha4/machinehealthcheck_types.go b/internal/apis/core/v1alpha4/machinehealthcheck_types.go index b1289703559d..0714621f1690 100644 --- a/internal/apis/core/v1alpha4/machinehealthcheck_types.go +++ b/internal/apis/core/v1alpha4/machinehealthcheck_types.go @@ -175,7 +175,8 @@ func (m *MachineHealthCheck) SetConditions(conditions Conditions) { type MachineHealthCheckList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []MachineHealthCheck `json:"items"` + // items is the list of MachineHealthChecks. + Items []MachineHealthCheck `json:"items"` } func init() { diff --git a/internal/apis/core/v1alpha4/machineset_types.go b/internal/apis/core/v1alpha4/machineset_types.go index 66b87cc489d6..562b9967fe30 100644 --- a/internal/apis/core/v1alpha4/machineset_types.go +++ b/internal/apis/core/v1alpha4/machineset_types.go @@ -222,7 +222,9 @@ type MachineSet struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - Spec MachineSetSpec `json:"spec,omitempty"` + // spec is the desired state of MachineSet. + Spec MachineSetSpec `json:"spec,omitempty"` + // status is the observed state of MachineSet. Status MachineSetStatus `json:"status,omitempty"` } @@ -234,7 +236,8 @@ type MachineSet struct { type MachineSetList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` - Items []MachineSet `json:"items"` + // items is the list of MachineSets. + Items []MachineSet `json:"items"` } func init() {