Skip to content

Commit 0530ef8

Browse files
committed
Renamed deprecated ClusterClass Metadata field to DeprecatedV1Beta1Metadata
Signed-off-by: Stefan Büringer buringerst@vmware.com
1 parent 19d5987 commit 0530ef8

File tree

12 files changed

+83
-79
lines changed

12 files changed

+83
-79
lines changed

.golangci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ linters:
231231
# should be removed as the referenced deprecated item is removed from the project.
232232
- linters:
233233
- staticcheck
234-
text: 'SA1019: (bootstrapv1.ClusterStatus|DockerMachine.Spec.Bootstrapped|machineStatus.Bootstrapped|dockerMachine.Spec.Backend.Docker.Bootstrapped|dockerMachine.Spec.Bootstrapped|devMachine.Spec.Backend.Docker.Bootstrapped|c.TopologyPlan|clusterv1.ClusterClassVariableMetadata|clusterv1beta1.ClusterClassVariableMetadata|(variable|currentDefinition|specVar|newVariableDefinition|statusVarDefinition).Metadata) is deprecated'
234+
text: 'SA1019: (bootstrapv1.ClusterStatus|DockerMachine.Spec.Bootstrapped|machineStatus.Bootstrapped|dockerMachine.Spec.Backend.Docker.Bootstrapped|dockerMachine.Spec.Bootstrapped|devMachine.Spec.Backend.Docker.Bootstrapped|c.TopologyPlan|clusterv1.ClusterClassVariableMetadata|clusterv1beta1.ClusterClassVariableMetadata|(variable|currentDefinition|specVar|newVariableDefinition|statusVarDefinition|out).DeprecatedV1Beta1Metadata) is deprecated'
235235
# Deprecations for MD revision management
236236
- linters:
237237
- staticcheck

api/core/v1beta1/conversion.go

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -884,3 +884,31 @@ func Convert_v1beta1_MachinePoolStatus_To_v1beta2_MachinePoolStatus(in *MachineP
884884
func Convert_v1beta1_MachinePoolSpec_To_v1beta2_MachinePoolSpec(in *MachinePoolSpec, out *clusterv1.MachinePoolSpec, s apimachineryconversion.Scope) error {
885885
return autoConvert_v1beta1_MachinePoolSpec_To_v1beta2_MachinePoolSpec(in, out, s)
886886
}
887+
888+
func Convert_v1beta1_ClusterClassStatusVariableDefinition_To_v1beta2_ClusterClassStatusVariableDefinition(in *ClusterClassStatusVariableDefinition, out *clusterv1.ClusterClassStatusVariableDefinition, s apimachineryconversion.Scope) error {
889+
if err := autoConvert_v1beta1_ClusterClassStatusVariableDefinition_To_v1beta2_ClusterClassStatusVariableDefinition(in, out, s); err != nil {
890+
return err
891+
}
892+
return autoConvert_v1beta1_ClusterClassVariableMetadata_To_v1beta2_ClusterClassVariableMetadata(&in.Metadata, &out.DeprecatedV1Beta1Metadata, s)
893+
}
894+
895+
func Convert_v1beta2_ClusterClassStatusVariableDefinition_To_v1beta1_ClusterClassStatusVariableDefinition(in *clusterv1.ClusterClassStatusVariableDefinition, out *ClusterClassStatusVariableDefinition, s apimachineryconversion.Scope) error {
896+
if err := autoConvert_v1beta2_ClusterClassStatusVariableDefinition_To_v1beta1_ClusterClassStatusVariableDefinition(in, out, s); err != nil {
897+
return err
898+
}
899+
return autoConvert_v1beta2_ClusterClassVariableMetadata_To_v1beta1_ClusterClassVariableMetadata(&in.DeprecatedV1Beta1Metadata, &out.Metadata, s)
900+
}
901+
902+
func Convert_v1beta1_ClusterClassVariable_To_v1beta2_ClusterClassVariable(in *ClusterClassVariable, out *clusterv1.ClusterClassVariable, s apimachineryconversion.Scope) error {
903+
if err := autoConvert_v1beta1_ClusterClassVariable_To_v1beta2_ClusterClassVariable(in, out, s); err != nil {
904+
return err
905+
}
906+
return autoConvert_v1beta1_ClusterClassVariableMetadata_To_v1beta2_ClusterClassVariableMetadata(&in.Metadata, &out.DeprecatedV1Beta1Metadata, s)
907+
}
908+
909+
func Convert_v1beta2_ClusterClassVariable_To_v1beta1_ClusterClassVariable(in *clusterv1.ClusterClassVariable, out *ClusterClassVariable, s apimachineryconversion.Scope) error {
910+
if err := autoConvert_v1beta2_ClusterClassVariable_To_v1beta1_ClusterClassVariable(in, out, s); err != nil {
911+
return err
912+
}
913+
return autoConvert_v1beta2_ClusterClassVariableMetadata_To_v1beta1_ClusterClassVariableMetadata(&in.DeprecatedV1Beta1Metadata, &out.Metadata, s)
914+
}

api/core/v1beta1/zz_generated.conversion.go

Lines changed: 4 additions & 32 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

api/core/v1beta2/clusterclass_types.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -546,10 +546,10 @@ type ClusterClassVariable struct {
546546
// It can be used to add additional data for higher level tools to
547547
// a ClusterClassVariable.
548548
//
549-
// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please use XMetadata in JSONSchemaProps instead.
549+
// Deprecated: This field is deprecated and will be removed when support for v1beta1 will be dropped. Please use XMetadata in JSONSchemaProps instead.
550550
//
551551
// +optional
552-
Metadata ClusterClassVariableMetadata `json:"metadata,omitempty"`
552+
DeprecatedV1Beta1Metadata ClusterClassVariableMetadata `json:"deprecatedV1Beta1Metadata,omitempty"`
553553

554554
// schema defines the schema of the variable.
555555
// +required
@@ -1223,10 +1223,10 @@ type ClusterClassStatusVariableDefinition struct {
12231223
// It can be used to add additional data for higher level tools to
12241224
// a ClusterClassVariable.
12251225
//
1226-
// Deprecated: This field is deprecated and is going to be removed in the next apiVersion.
1226+
// Deprecated: This field is deprecated and will be removed when support for v1beta1 will be dropped. Please use XMetadata in JSONSchemaProps instead.
12271227
//
12281228
// +optional
1229-
Metadata ClusterClassVariableMetadata `json:"metadata,omitempty"`
1229+
DeprecatedV1Beta1Metadata ClusterClassVariableMetadata `json:"deprecatedV1Beta1Metadata,omitempty"`
12301230

12311231
// schema defines the schema of the variable.
12321232
// +required

api/core/v1beta2/zz_generated.deepcopy.go

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

api/core/v1beta2/zz_generated.openapi.go

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

config/crd/bases/cluster.x-k8s.io_clusterclasses.yaml

Lines changed: 12 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/book/src/developer/providers/migrations/v1.10-to-v1.11.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,10 @@ proposal because most of the changes described below are a consequence of the wo
166166
- The `unhealthyConditions` field has been renamed to `unhealthyNodeConditions` in following struct:
167167
- `spec.controlPlane.machineHealthCheck`
168168
- `spec.workers.machineDeployments[].machineHealthCheck`
169+
- The `spec.variables[].metadata` and `.status.variables[].definitions[].metadata` fields have been renamed
170+
to `spec.variables[].deprecatedV1Beta1Metadata` and `.status.variables[].definitions[].deprecatedV1Beta1Metadata`
171+
- These fields are deprecated and will be removed when support for v1beta1 will be dropped.
172+
- Please use `XMetadata` in `JSONSchemaProps` instead.
169173
- The `builtin.cluster.classRef.Name` and `builtin.cluster.classRef.Namespace` variables have been added
170174
- The `builtin.cluster.class` and `builtin.cluster.classNamespace` are deprecated and will be removed with the next apiVersion.
171175
- The `builtin.cluster.network.ipFamily` variable has been removed and it cannot be used anymore in patches

internal/controllers/clusterclass/clusterclass_controller.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -401,29 +401,29 @@ func addNewStatusVariable(variable clusterv1.ClusterClassVariable, from string)
401401
DefinitionsConflict: false,
402402
Definitions: []clusterv1.ClusterClassStatusVariableDefinition{
403403
{
404-
From: from,
405-
Required: variable.Required,
406-
Metadata: variable.Metadata,
407-
Schema: variable.Schema,
404+
From: from,
405+
Required: variable.Required,
406+
DeprecatedV1Beta1Metadata: variable.DeprecatedV1Beta1Metadata,
407+
Schema: variable.Schema,
408408
},
409409
}}
410410
}
411411

412412
func addDefinitionToExistingStatusVariable(variable clusterv1.ClusterClassVariable, from string, existingVariable *clusterv1.ClusterClassStatusVariable) *clusterv1.ClusterClassStatusVariable {
413413
combinedVariable := existingVariable.DeepCopy()
414414
newVariableDefinition := clusterv1.ClusterClassStatusVariableDefinition{
415-
From: from,
416-
Required: variable.Required,
417-
Metadata: variable.Metadata,
418-
Schema: variable.Schema,
415+
From: from,
416+
Required: variable.Required,
417+
DeprecatedV1Beta1Metadata: variable.DeprecatedV1Beta1Metadata,
418+
Schema: variable.Schema,
419419
}
420420
combinedVariable.Definitions = append(existingVariable.Definitions, newVariableDefinition)
421421

422422
// If the new definition is different from any existing definition, set DefinitionsConflict to true.
423423
// If definitions already conflict, no need to check.
424424
if !combinedVariable.DefinitionsConflict {
425425
currentDefinition := combinedVariable.Definitions[0]
426-
if currentDefinition.Required != newVariableDefinition.Required || !reflect.DeepEqual(currentDefinition.Schema, newVariableDefinition.Schema) || !reflect.DeepEqual(currentDefinition.Metadata, newVariableDefinition.Metadata) {
426+
if currentDefinition.Required != newVariableDefinition.Required || !reflect.DeepEqual(currentDefinition.Schema, newVariableDefinition.Schema) || !reflect.DeepEqual(currentDefinition.DeprecatedV1Beta1Metadata, newVariableDefinition.DeprecatedV1Beta1Metadata) {
427427
combinedVariable.DefinitionsConflict = true
428428
}
429429
}

0 commit comments

Comments
 (0)