fix(vd): move metadata sync to its own step #1776
+278
−129
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
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
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 |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| /* | ||
| Copyright 2025 Flant JSC | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package step | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
|
|
||
| vsv1 "github.com/kubernetes-csi/external-snapshotter/client/v6/apis/volumesnapshot/v1" | ||
| corev1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| "sigs.k8s.io/controller-runtime/pkg/reconcile" | ||
|
|
||
| "github.com/deckhouse/virtualization-controller/pkg/common/annotations" | ||
| "github.com/deckhouse/virtualization-controller/pkg/common/object" | ||
| "github.com/deckhouse/virtualization-controller/pkg/controller/conditions" | ||
| "github.com/deckhouse/virtualization-controller/pkg/controller/service" | ||
| "github.com/deckhouse/virtualization-controller/pkg/eventrecord" | ||
| "github.com/deckhouse/virtualization/api/core/v1alpha2" | ||
| "github.com/deckhouse/virtualization/api/core/v1alpha2/vdcondition" | ||
| ) | ||
|
|
||
| const lastAppliedConfigAnnotation = "kubectl.kubernetes.io/last-applied-configuration" | ||
|
|
||
| type AddOriginalMetadataStep struct { | ||
| recorder eventrecord.EventRecorderLogger | ||
| client client.Client | ||
| cb *conditions.ConditionBuilder | ||
| } | ||
|
|
||
| func NewAddOriginalMetadataStep( | ||
| recorder eventrecord.EventRecorderLogger, | ||
| client client.Client, | ||
| cb *conditions.ConditionBuilder, | ||
| ) *AddOriginalMetadataStep { | ||
| return &AddOriginalMetadataStep{ | ||
| recorder: recorder, | ||
| client: client, | ||
| cb: cb, | ||
| } | ||
| } | ||
|
|
||
| func (s AddOriginalMetadataStep) Take(ctx context.Context, vd *v1alpha2.VirtualDisk) (*reconcile.Result, error) { | ||
| vdSnapshot, err := object.FetchObject(ctx, types.NamespacedName{Name: vd.Spec.DataSource.ObjectRef.Name, Namespace: vd.Namespace}, s.client, &v1alpha2.VirtualDiskSnapshot{}) | ||
| if err != nil { | ||
| wrappedErr := fmt.Errorf("failed to fetch the virtual disk snapshot: %w", err) | ||
| vd.Status.Phase = v1alpha2.DiskFailed | ||
| s.cb. | ||
| Status(metav1.ConditionFalse). | ||
| Reason(vdcondition.ProvisioningFailed). | ||
| Message(service.CapitalizeFirstLetter(wrappedErr.Error() + ".")) | ||
| return nil, wrappedErr | ||
| } | ||
|
|
||
| if vdSnapshot == nil { | ||
| vd.Status.Phase = v1alpha2.DiskPending | ||
| s.cb. | ||
| Status(metav1.ConditionFalse). | ||
| Reason(vdcondition.ProvisioningNotStarted). | ||
| Message(fmt.Sprintf("VirtualDiskSnapshot %q not found.", vd.Spec.DataSource.ObjectRef.Name)) | ||
| return &reconcile.Result{}, nil | ||
| } | ||
|
|
||
| vs, err := object.FetchObject(ctx, types.NamespacedName{Name: vdSnapshot.Status.VolumeSnapshotName, Namespace: vdSnapshot.Namespace}, s.client, &vsv1.VolumeSnapshot{}) | ||
| if err != nil { | ||
| wrappedErr := fmt.Errorf("failed to fetch the volume snapshot: %w", err) | ||
| vd.Status.Phase = v1alpha2.DiskFailed | ||
| s.cb. | ||
| Status(metav1.ConditionFalse). | ||
| Reason(vdcondition.ProvisioningFailed). | ||
| Message(service.CapitalizeFirstLetter(wrappedErr.Error() + ".")) | ||
| return nil, wrappedErr | ||
| } | ||
|
|
||
| if vdSnapshot.Status.Phase != v1alpha2.VirtualDiskSnapshotPhaseReady || vs == nil || vs.Status == nil || vs.Status.ReadyToUse == nil || !*vs.Status.ReadyToUse { | ||
| vd.Status.Phase = v1alpha2.DiskPending | ||
| s.cb. | ||
| Status(metav1.ConditionFalse). | ||
| Reason(vdcondition.ProvisioningNotStarted). | ||
| Message(fmt.Sprintf("VirtualDiskSnapshot %q is not ready to use.", vdSnapshot.Name)) | ||
| return &reconcile.Result{}, nil | ||
| } | ||
|
|
||
| areAnnotationsAdded, err := setOriginalAnnotations(vd, vs) | ||
| if err != nil { | ||
| wrappedErr := fmt.Errorf("failed to set original annotations: %w", err) | ||
| vd.Status.Phase = v1alpha2.DiskFailed | ||
| s.cb. | ||
| Status(metav1.ConditionFalse). | ||
| Reason(vdcondition.ProvisioningFailed). | ||
| Message(service.CapitalizeFirstLetter(wrappedErr.Error() + ".")) | ||
| return nil, wrappedErr | ||
| } | ||
|
|
||
| areLabelsAdded, err := setOriginalLabels(vd, vs) | ||
| if err != nil { | ||
| wrappedErr := fmt.Errorf("failed to set original labels: %w", err) | ||
| vd.Status.Phase = v1alpha2.DiskFailed | ||
| s.cb. | ||
| Status(metav1.ConditionFalse). | ||
| Reason(vdcondition.ProvisioningFailed). | ||
| Message(service.CapitalizeFirstLetter(wrappedErr.Error() + ".")) | ||
| return nil, wrappedErr | ||
| } | ||
|
|
||
| // Ensure that new metadata is applied correctly because a conflict error can occur | ||
| // when updating the virtual disk resource. Therefore, this step should finish | ||
| // with reconciliation if the metadata has changed. | ||
| if areAnnotationsAdded || areLabelsAdded { | ||
| s.recorder.Event( | ||
| vd, | ||
| corev1.EventTypeNormal, | ||
| v1alpha2.ReasonMetadataSyncStarted, | ||
| "The original metadata sync has started", | ||
| ) | ||
|
|
||
| return &reconcile.Result{}, nil | ||
| } | ||
|
|
||
| return nil, nil | ||
| } | ||
|
|
||
| func setOriginalAnnotations(vd *v1alpha2.VirtualDisk, vs *vsv1.VolumeSnapshot) (bool, error) { | ||
| var originalAnnotationsMap map[string]string | ||
| if vs.Annotations[annotations.AnnVirtualDiskOriginalAnnotations] != "" { | ||
| err := json.Unmarshal([]byte(vs.Annotations[annotations.AnnVirtualDiskOriginalAnnotations]), &originalAnnotationsMap) | ||
| if err != nil { | ||
| return false, fmt.Errorf("failed to unmarshal the original annotations: %w", err) | ||
| } | ||
| } | ||
|
|
||
| if vd.Annotations == nil { | ||
| vd.Annotations = make(map[string]string) | ||
| } | ||
|
|
||
| var areAnnotationsAdded bool | ||
| for key, originalvalue := range originalAnnotationsMap { | ||
| if currentValue, exists := vd.Annotations[key]; !exists || (key != lastAppliedConfigAnnotation && currentValue != originalvalue) { | ||
|
Contributor
There was a problem hiding this comment. You don’t need to set the lastAppliedConfigAnnotation. Right now you are setting it. |
||
| vd.Annotations[key] = originalvalue | ||
| areAnnotationsAdded = true | ||
| } | ||
| } | ||
|
|
||
| return areAnnotationsAdded, nil | ||
| } | ||
|
|
||
| func setOriginalLabels(vd *v1alpha2.VirtualDisk, vs *vsv1.VolumeSnapshot) (bool, error) { | ||
| var originalLabelsMap map[string]string | ||
| if vs.Annotations[annotations.AnnVirtualDiskOriginalLabels] != "" { | ||
| err := json.Unmarshal([]byte(vs.Annotations[annotations.AnnVirtualDiskOriginalLabels]), &originalLabelsMap) | ||
| if err != nil { | ||
| return false, fmt.Errorf("failed to unmarshal the original labels: %w", err) | ||
| } | ||
| } | ||
|
|
||
| if vd.Labels == nil { | ||
| vd.Labels = make(map[string]string) | ||
| } | ||
|
|
||
| var areLabelsAdded bool | ||
| for key, originalvalue := range originalLabelsMap { | ||
| if currentValue, exists := vd.Labels[key]; !exists || currentValue != originalvalue { | ||
| vd.Labels[key] = originalvalue | ||
| areLabelsAdded = true | ||
| } | ||
| } | ||
|
|
||
| return areLabelsAdded, nil | ||
| } | ||
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.
No need to create the new variable