Deprecate disableMDevConfiguration in favor of mediatedDevicesConfiguration.enabled #4057
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -63,7 +63,6 @@ spec: | |
| decentralizedLiveMigration: true | ||
| declarativeHotplugVolumes: false | ||
| deployKubeSecondaryDNS: false | ||
| downwardMetrics: false | ||
| enableMultiArchBootImageImport: false | ||
| incrementalBackup: false | ||
|
|
@@ -1091,7 +1090,6 @@ spec: | |
| decentralizedLiveMigration: true | ||
| declarativeHotplugVolumes: false | ||
| deployKubeSecondaryDNS: false | ||
| downwardMetrics: false | ||
| enableMultiArchBootImageImport: false | ||
| incrementalBackup: false | ||
|
|
@@ -1146,8 +1144,8 @@ spec: | |
| Use spec.deployVmConsoleProxy instead | ||
| type: boolean | ||
| disableMDevConfiguration: | ||
| description: 'Deprecated: This field is ignored and use mediatedDevicesConfiguration.Enabled | ||
| instead , it will be removed in the next version of the API.' | ||
| type: boolean | ||
| downwardMetrics: | ||
| default: false | ||
|
|
@@ -2494,6 +2492,12 @@ spec: | |
| description: MediatedDevicesConfiguration holds information about | ||
| MDEV types to be defined on nodes, if available | ||
| properties: | ||
| enabled: | ||
| description: |- | ||
| Enable the creation and removal of mediated devices by virt-handler | ||
| Replaces the deprecated DisableMDEVConfiguration feature gate | ||
| Defaults to true | ||
| type: boolean | ||
| mediatedDeviceTypes: | ||
| items: | ||
| type: string | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -612,9 +612,8 @@ func getObsoleteCPUConfig(hcObsoleteCPUConf *hcov1beta1.HyperConvergedObsoleteCP | |
|
|
||
| func toKvMediatedDevicesConfiguration(hc *hcov1beta1.HyperConverged) *kubevirtcorev1.MediatedDevicesConfiguration { | ||
| mdevsConfig := hc.Spec.MediatedDevicesConfiguration | ||
|
Collaborator
There was a problem hiding this comment. we do need it. we don't ignoring the FG. if only the FG is true, then we need to set the KubeVirt's |
||
|
|
||
| if mdevsConfig == nil { | ||
| return nil | ||
| } | ||
|
|
||
|
|
@@ -632,7 +631,7 @@ func toKvMediatedDevicesConfiguration(hc *hcov1beta1.HyperConverged) *kubevirtco | |
| kvMdev.NodeMediatedDeviceTypes = toKvNodeMediatedDevicesConfiguration(mdevsConfig.NodeMediatedDeviceTypes) | ||
| } | ||
|
|
||
| if !ptr.Deref(mdevsConfig.Enabled, true) { | ||
| kvMdev.Enabled = ptr.To(false) | ||
| } | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -798,9 +798,19 @@ Version: 1.2.3`) | |
| Expect(kv.Spec.Configuration.MediatedDevicesConfiguration).To(BeNil()) | ||
| }) | ||
|
|
||
| It("should not propagate the mediated devices configuration is empty", func() { | ||
| hco.Spec.MediatedDevicesConfiguration = nil | ||
|
|
||
| kv, err := NewKubeVirt(hco) | ||
| Expect(err).ToNot(HaveOccurred()) | ||
|
|
||
| Expect(kv.Spec.Configuration.MediatedDevicesConfiguration).To(BeNil()) | ||
| }) | ||
|
|
||
| It("should propagate the mediated devices configuration, only with the Enabled field, if enabled set to false in HCO", func() { | ||
| hco.Spec.MediatedDevicesConfiguration = &hcov1beta1.MediatedDevicesConfiguration{ | ||
| Enabled: ptr.To(false), | ||
| } | ||
|
|
||
| kv, err := NewKubeVirt(hco) | ||
| Expect(err).ToNot(HaveOccurred()) | ||
|
|
@@ -1081,10 +1091,10 @@ Version: 1.2.3`) | |
| Expect(mdc.MediatedDeviceTypes).To(ContainElements("nvidia-181", "nvidia-191", "nvidia-224")) | ||
| }) | ||
|
|
||
| It("should set the enabled field to false, if enabled set to false in HCO", func() { | ||
| hco.Spec.MediatedDevicesConfiguration = &hcov1beta1.MediatedDevicesConfiguration{ | ||
| MediatedDeviceTypes: []string{"nvidia-222", "nvidia-230"}, | ||
| Enabled: ptr.To(false), | ||
| } | ||
|
|
||
| kv, err := NewKubeVirt(hco) | ||
|
|
@@ -1095,7 +1105,7 @@ Version: 1.2.3`) | |
| }) | ||
|
|
||
| It("should not set the enabled field, if the DisableMDevConfiguration FG is disabled", func() { | ||
| hco.Spec.FeatureGates.DisableMDevConfiguration = ptr.To(false) //nolint:staticcheck // Testing deprecated FG behavior. | ||
| hco.Spec.MediatedDevicesConfiguration = &hcov1beta1.MediatedDevicesConfiguration{ | ||
| MediatedDeviceTypes: []string{"nvidia-222", "nvidia-230"}, | ||
| } | ||
|
|
@@ -1108,7 +1118,7 @@ Version: 1.2.3`) | |
| }) | ||
|
|
||
| It("should not set the enabled field, if the DisableMDevConfiguration FG is nil", func() { | ||
| hco.Spec.FeatureGates.DisableMDevConfiguration = nil //nolint:staticcheck // Testing deprecated FG behavior. | ||
| hco.Spec.MediatedDevicesConfiguration = &hcov1beta1.MediatedDevicesConfiguration{ | ||
| MediatedDeviceTypes: []string{"nvidia-222", "nvidia-230"}, | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -383,6 +383,13 @@ func (r *ReconcileHyperConverged) doReconcile(req *common.HcoRequest) (reconcile | |
| return reconcile.Result{}, nil | ||
| } | ||
|
|
||
| // Controller-driven upgrade: if deprecated disableMDevConfiguration is true and | ||
| // mediatedDevicesConfiguration.enabled is missing, set enabled=false so the CR | ||
| // is migrated without requiring a user edit. updateHyperConverged will persist it. | ||
| if r.migrateMDevConfigurationIfNeeded(req) { | ||
| req.Logger.Info("Migrated HCO spec: set mediatedDevicesConfiguration.enabled from deprecated disableMDevConfiguration") | ||
| } | ||
|
|
||
|
Comment on lines
+386
to
+392
Collaborator
There was a problem hiding this comment. This code should be in the mutating webhook. |
||
| // Add conditions if there are none | ||
| init := req.Instance.Status.Conditions == nil | ||
| if init { | ||
|
|
@@ -1120,6 +1127,32 @@ func (r *ReconcileHyperConverged) setOperatorUpgradeableStatus(request *common.H | |
| return nil | ||
| } | ||
|
|
||
| // migrateMDevConfigurationIfNeeded performs a controller-driven upgrade: when the deprecated | ||
|
|
||
| // spec.featureGates.disableMDevConfiguration is true and spec.mediatedDevicesConfiguration.enabled | ||
| // is missing, it sets enabled=false so the CR is migrated without requiring a user edit. | ||
| // Returns true if the spec was modified (caller should set req.Dirty and requeue). | ||
| func (r *ReconcileHyperConverged) migrateMDevConfigurationIfNeeded(req *common.HcoRequest) bool { | ||
| //nolint:staticcheck // Read deprecated field to migrate existing CRs. | ||
| if req.Instance.Spec.FeatureGates.DisableMDevConfiguration == nil || | ||
| !*req.Instance.Spec.FeatureGates.DisableMDevConfiguration { | ||
| return false | ||
| } | ||
| mdc := req.Instance.Spec.MediatedDevicesConfiguration | ||
| if mdc == nil { | ||
| req.Instance.Spec.MediatedDevicesConfiguration = &hcov1beta1.MediatedDevicesConfiguration{ | ||
| Enabled: ptr.To(false), | ||
| } | ||
| req.Dirty = true | ||
| return true | ||
| } | ||
| if mdc.Enabled != nil { | ||
| return false | ||
| } | ||
| mdc.Enabled = ptr.To(false) | ||
| req.Dirty = true | ||
| return true | ||
| } | ||
|
|
||
| func (r *ReconcileHyperConverged) migrateBeforeUpgrade(req *common.HcoRequest) (bool, error) { | ||
| upgradePatched, err := r.applyUpgradePatches(req) | ||
| if err != nil { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -860,6 +860,33 @@ var _ = Describe("HyperconvergedController", func() { | |
| Expect(foundResource.Finalizers).To(Equal([]string{FinalizerName})) | ||
| }) | ||
|
|
||
| It("should migrate mediatedDevicesConfiguration.enabled from deprecated disableMDevConfiguration on reconcile", func() { | ||
|
|
||
| expected := getBasicDeployment() | ||
| //nolint:staticcheck // Intentionally set deprecated FG to test controller-driven migration. | ||
| expected.hco.Spec.FeatureGates.DisableMDevConfiguration = ptr.To(true) | ||
| expected.hco.Spec.MediatedDevicesConfiguration = &hcov1beta1.MediatedDevicesConfiguration{ | ||
| MediatedDeviceTypes: []string{"nvidia-222"}, | ||
| Enabled: nil, // missing; controller should set to false | ||
| } | ||
| cl := expected.initClient() | ||
| foundResource, _, _ := doReconcile(cl, expected.hco, nil) | ||
| Expect(foundResource.Spec.MediatedDevicesConfiguration).ToNot(BeNil()) | ||
| Expect(foundResource.Spec.MediatedDevicesConfiguration.Enabled).ToNot(BeNil()) | ||
| Expect(*foundResource.Spec.MediatedDevicesConfiguration.Enabled).To(BeFalse()) | ||
| }) | ||
|
|
||
| It("should create mediatedDevicesConfiguration with enabled=false when FG is true and MDC is nil", func() { | ||
| expected := getBasicDeployment() | ||
| //nolint:staticcheck // Intentionally set deprecated FG to test controller-driven migration. | ||
| expected.hco.Spec.FeatureGates.DisableMDevConfiguration = ptr.To(true) | ||
| expected.hco.Spec.MediatedDevicesConfiguration = nil | ||
| cl := expected.initClient() | ||
| foundResource, _, _ := doReconcile(cl, expected.hco, nil) | ||
| Expect(foundResource.Spec.MediatedDevicesConfiguration).ToNot(BeNil()) | ||
| Expect(foundResource.Spec.MediatedDevicesConfiguration.Enabled).ToNot(BeNil()) | ||
| Expect(*foundResource.Spec.MediatedDevicesConfiguration.Enabled).To(BeFalse()) | ||
| }) | ||
|
|
||
| It("Should not be ready if one of the operands is returns error, on create", func() { | ||
| hco := commontestutils.NewHco() | ||
| cl := commontestutils.InitClient([]client.Object{hcoNamespace, hco}) | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -63,7 +63,6 @@ spec: | |
| decentralizedLiveMigration: true | ||
| declarativeHotplugVolumes: false | ||
| deployKubeSecondaryDNS: false | ||
| downwardMetrics: false | ||
| enableMultiArchBootImageImport: false | ||
| incrementalBackup: false | ||
|
|
@@ -1091,7 +1090,6 @@ spec: | |
| decentralizedLiveMigration: true | ||
| declarativeHotplugVolumes: false | ||
| deployKubeSecondaryDNS: false | ||
| downwardMetrics: false | ||
| enableMultiArchBootImageImport: false | ||
| incrementalBackup: false | ||
|
|
@@ -1146,8 +1144,8 @@ spec: | |
| Use spec.deployVmConsoleProxy instead | ||
| type: boolean | ||
| disableMDevConfiguration: | ||
| description: 'Deprecated: This field is ignored and use mediatedDevicesConfiguration.Enabled | ||
| instead , it will be removed in the next version of the API.' | ||
| type: boolean | ||
| downwardMetrics: | ||
| default: false | ||
|
|
@@ -2494,6 +2492,12 @@ spec: | |
| description: MediatedDevicesConfiguration holds information about | ||
| MDEV types to be defined on nodes, if available | ||
| properties: | ||
| enabled: | ||
| description: |- | ||
| Enable the creation and removal of mediated devices by virt-handler | ||
| Replaces the deprecated DisableMDEVConfiguration feature gate | ||
| Defaults to true | ||
| type: boolean | ||
| mediatedDeviceTypes: | ||
| items: | ||
| type: string | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,7 +19,6 @@ spec: | |
| decentralizedLiveMigration: true | ||
| declarativeHotplugVolumes: false | ||
| deployKubeSecondaryDNS: false | ||
| downwardMetrics: false | ||
| enableMultiArchBootImageImport: false | ||
| incrementalBackup: false | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -63,7 +63,6 @@ spec: | |
| decentralizedLiveMigration: true | ||
| declarativeHotplugVolumes: false | ||
| deployKubeSecondaryDNS: false | ||
| downwardMetrics: false | ||
| enableMultiArchBootImageImport: false | ||
| incrementalBackup: false | ||
|
|
@@ -1091,7 +1090,6 @@ spec: | |
| decentralizedLiveMigration: true | ||
| declarativeHotplugVolumes: false | ||
| deployKubeSecondaryDNS: false | ||
| downwardMetrics: false | ||
| enableMultiArchBootImageImport: false | ||
| incrementalBackup: false | ||
|
|
@@ -1146,8 +1144,8 @@ spec: | |
| Use spec.deployVmConsoleProxy instead | ||
| type: boolean | ||
| disableMDevConfiguration: | ||
| description: 'Deprecated: This field is ignored and use mediatedDevicesConfiguration.Enabled | ||
| instead , it will be removed in the next version of the API.' | ||
| type: boolean | ||
| downwardMetrics: | ||
| default: false | ||
|
|
@@ -2494,6 +2492,12 @@ spec: | |
| description: MediatedDevicesConfiguration holds information about | ||
| MDEV types to be defined on nodes, if available | ||
| properties: | ||
| enabled: | ||
| description: |- | ||
| Enable the creation and removal of mediated devices by virt-handler | ||
| Replaces the deprecated DisableMDEVConfiguration feature gate | ||
| Defaults to true | ||
| type: boolean | ||
| mediatedDeviceTypes: | ||
| items: | ||
| type: string | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we're not ignoring it, but it is deprecated.