Skip to content

Commit

Permalink
protect migrated volume from vm deletion
Browse files Browse the repository at this point in the history
  • Loading branch information
divyenpatel committed May 31, 2022
1 parent 623469b commit b510a83
Show file tree
Hide file tree
Showing 5 changed files with 72 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ spec:
volumepath:
description: VolumePath is the vmdk path of the vSphere Volume
type: string
protectvolumefromvmdelete:
description: protect volume from vm deletion after vmdk is migrated to CSI
type: boolean
required:
- volumeid
- volumepath
Expand Down
36 changes: 36 additions & 0 deletions pkg/apis/migration/migration.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ type VolumeMigrationService interface {
// DeleteVolumeInfo helps delete mapping of volumePath to VolumeID for
// specified volumeID.
DeleteVolumeInfo(ctx context.Context, volumeID string) error

// ProtectVolumeFromVMDeletion sets FCD_KEEP_AFTER_DELETE_VM control flag on the migrated volume
// Returns an error if not able to set FCD_KEEP_AFTER_DELETE_VM control flag on the volume
ProtectVolumeFromVMDeletion(ctx context.Context, volumeID string) error
}

// volumeMigration holds migrated volume information and provides functionality
Expand Down Expand Up @@ -235,6 +239,38 @@ func (volumeMigration *volumeMigration) GetVolumeID(ctx context.Context, volumeS
return "", ErrVolumeIDNotFound
}

// ProtectVolumeFromVMDeletion sets FCD_KEEP_AFTER_DELETE_VM control flag on the migrated volume
// Returns an error if not able to set FCD_KEEP_AFTER_DELETE_VM control flag on the volume
func (volumeMigration *volumeMigration) ProtectVolumeFromVMDeletion(ctx context.Context, volumeID string) error {
log := logger.GetLogger(ctx)
volumeMigrationResource := &migrationv1alpha1.CnsVSphereVolumeMigration{}
var err error
err = volumeMigration.k8sClient.Get(ctx, client.ObjectKey{Name: volumeID}, volumeMigrationResource)
if err != nil {
log.Errorf("error happened while getting CR for volumeMigration for VolumeID: %q, err: %v", volumeID, err)
return err
}
if !volumeMigrationResource.Spec.ProtectVolumeFromVMDelete {
log.Infof("Set FCD_KEEP_AFTER_DELETE_VM control flag using Vslm APIs")
err = (*volumeMigration.volumeManager).ProtectVolumeFromVMDeletion(ctx, volumeID)
if err != nil {
return err
}
} else {
log.Infof("migrated volume with ID: %q is already protected from vm deletion", volumeID)
return nil
}
log.Infof("Migrated Volume with ID: %q is protected from VM deletion", volumeID)
volumeMigrationResource.Spec.ProtectVolumeFromVMDelete = true
err = volumeMigration.k8sClient.Update(ctx, volumeMigrationResource)
if err != nil {
log.Errorf("error happened while updating volumeMigration CR to set ProtectVolumeFromVMDelete true "+
"for VolumeID: %q, err: %v", volumeID, err)
return err
}
return nil
}

// GetVolumePath returns VolumePath for given VolumeID.
// Returns an error if not able to retrieve VolumePath.
func (volumeMigration *volumeMigration) GetVolumePath(ctx context.Context, volumeID string) (string, error) {
Expand Down
2 changes: 2 additions & 0 deletions pkg/apis/migration/v1alpha1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ type CnsVSphereVolumeMigrationSpec struct {
VolumePath string `json:"volumepath"`
// VolumeID is the FCD ID obtained after register volume with CNS.
VolumeID string `json:"volumeid"`
// ProtectVolumeFromVMDelete true means migrated volumes is protected from Node VM deletion
ProtectVolumeFromVMDelete bool `json:"protectvolumefromvmdelete"`
}

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
Expand Down
26 changes: 26 additions & 0 deletions pkg/common/cns-lib/volume/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,8 @@ type Manager interface {
RegisterDisk(ctx context.Context, path string, name string) (string, error)
// RetrieveVStorageObject helps in retreiving virtual disk information for a given volume id.
RetrieveVStorageObject(ctx context.Context, volumeID string) (*vim25types.VStorageObject, error)
// ProtectVolumeFromVMDeletion sets FCD_KEEP_AFTER_DELETE_VM control flag on migrated volume
ProtectVolumeFromVMDeletion(ctx context.Context, volumeID string) error
// CreateSnapshot helps create a snapshot for a block volume
CreateSnapshot(ctx context.Context, volumeID string, desc string) (*CnsSnapshotInfo, error)
// DeleteSnapshot helps delete a snapshot for a block volume
Expand Down Expand Up @@ -2260,3 +2262,27 @@ func (m *defaultManager) DeleteSnapshot(ctx context.Context, volumeID string, sn
}
return err
}

// ProtectVolumeFromVMDeletion helps set FCD_KEEP_AFTER_DELETE_VM control flag for given volumeID
func (m *defaultManager) ProtectVolumeFromVMDeletion(ctx context.Context, volumeID string) error {
log := logger.GetLogger(ctx)
err := validateManager(ctx, m)
if err != nil {
log.Errorf("failed to validate volume manager with err: %+v", err)
return err
}
// Set up the VC connection
err = m.virtualCenter.ConnectVslm(ctx)
if err != nil {
log.Errorf("ConnectVslm failed with err: %+v", err)
return err
}
globalObjectManager := vslm.NewGlobalObjectManager(m.virtualCenter.VslmClient)
err = globalObjectManager.SetControlFlags(ctx, []string{"FCD_KEEP_AFTER_DELETE_VM"})
if err != nil {
log.Errorf("failed to set control flag FCD_KEEP_AFTER_DELETE_VM for volumeID %q with err: %v", volumeID, err)
return err
}
log.Infof("Successfully set FCD_KEEP_AFTER_DELETE_VM control flag for volumeID: %q", volumeID)
return nil
}
5 changes: 5 additions & 0 deletions pkg/csi/service/vanilla/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -1072,6 +1072,11 @@ func (c *controller) ControllerPublishVolume(ctx context.Context, req *csi.Contr
return nil, csifault.CSIInternalFault, logger.LogNewErrorCodef(log, codes.Internal,
"failed to get VolumeID from volumeMigrationService for volumePath: %q", volumePath)
}
err = volumeMigrationService.ProtectVolumeFromVMDeletion(ctx, req.VolumeId)
if err != nil {
return nil, csifault.CSIInternalFault, logger.LogNewErrorCodef(log, codes.Internal,
"failed to set FCD_KEEP_AFTER_DELETE_VM control flag for VolumeID %q", req.VolumeId)
}
}
var node *cnsvsphere.VirtualMachine
if commonco.ContainerOrchestratorUtility.IsFSSEnabled(ctx, common.UseCSINodeId) {
Expand Down

0 comments on commit b510a83

Please sign in to comment.