Skip to content

[release-1.17] Relax volumeContentSource restriction for ROX multi-zone dynamic volume creation #2036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 3, 2025
Merged

[release-1.17] Relax volumeContentSource restriction for ROX multi-zone dynamic volume creation #2036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pkg/common/parameters.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ const (
DiskTypeHdHA = "hyperdisk-balanced-high-availability"
DiskTypeHdT = "hyperdisk-throughput"
DiskTypeHdE = "hyperdisk-extreme"
DiskTypeHdML = "hyperdisk-ml"
)

type DataCacheParameters struct {
Expand Down
56 changes: 41 additions & 15 deletions pkg/gce-pd-csi-driver/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ var (
"nextPageToken",
}
listDisksFieldsWithUsers = append(listDisksFieldsWithoutUsers, "items/users")
disksWithModifiableAccessMode = []string{"hyperdisk-ml"}
disksWithModifiableAccessMode = []string{common.DiskTypeHdML}
disksWithUnsettableAccessMode = map[string]bool{
common.DiskTypeHdE: true,
common.DiskTypeHdT: true,
Expand Down Expand Up @@ -374,7 +374,8 @@ func (gceCS *GCEControllerServer) createVolumeInternal(ctx context.Context, req

// Validate VolumeContentSource is set when access mode is read only
readonly, _ := getReadOnlyFromCapabilities(volumeCapabilities)
if readonly && req.GetVolumeContentSource() == nil {

if readonly && req.GetVolumeContentSource() == nil && params.DiskType != common.DiskTypeHdML {
return nil, status.Error(codes.InvalidArgument, "VolumeContentSource must be provided when AccessMode is set to read only")
}

Expand Down Expand Up @@ -485,12 +486,19 @@ func (gceCS *GCEControllerServer) createMultiZoneDisk(ctx context.Context, req *
}
defer gceCS.volumeLocks.Release(volumeID)

// If creating an empty disk (content source nil), always create RWO disks (when supported)
// This allows disks to be created as underlying RWO disks, so they can be hydrated.
accessMode := common.GCEReadWriteOnceAccessMode
if req.GetVolumeContentSource() != nil {
accessMode = common.GCEReadOnlyManyAccessMode
}

createDiskErrs := []error{}
createdDisks := make([]*gce.CloudDisk, 0, len(zones))
for _, zone := range zones {
volKey := meta.ZonalKey(req.GetName(), zone)
klog.V(4).Infof("Creating single zone disk for zone %q and volume: %v", zone, volKey)
disk, err := gceCS.createSingleDisk(ctx, req, params, volKey, []string{zone})
disk, err := gceCS.createSingleDisk(ctx, req, params, volKey, []string{zone}, accessMode)
if err != nil {
createDiskErrs = append(createDiskErrs, err)
continue
Expand Down Expand Up @@ -593,11 +601,23 @@ func (gceCS *GCEControllerServer) createSingleDeviceDisk(ctx context.Context, re
if err != nil {
return nil, common.LoggedError("Failed to convert volume key to volume ID: ", err)
}
accessMode, err := getAccessMode(req, params)
if err != nil {
return nil, common.LoggedError("Failed to get access mode: ", err)
}

// If creating an empty disk (content source nil), always create RWO disks (when supported)
// This allows disks to be created as underlying RWO disks, so they can be hydrated.
readonly, _ := getReadOnlyFromCapabilities(req.GetVolumeCapabilities())
if readonly && req.GetVolumeContentSource() == nil && params.DiskType == common.DiskTypeHdML {
accessMode = common.GCEReadWriteOnceAccessMode
}

if acquired := gceCS.volumeLocks.TryAcquire(volumeID); !acquired {
return nil, status.Errorf(codes.Aborted, common.VolumeOperationAlreadyExistsFmt, volumeID)
}
defer gceCS.volumeLocks.Release(volumeID)
disk, err := gceCS.createSingleDisk(ctx, req, params, volKey, zones)
disk, err := gceCS.createSingleDisk(ctx, req, params, volKey, zones, accessMode)

if err != nil {
return nil, common.LoggedError("CreateVolume failed: %v", err)
Expand All @@ -606,30 +626,36 @@ func (gceCS *GCEControllerServer) createSingleDeviceDisk(ctx context.Context, re
return generateCreateVolumeResponseWithVolumeId(disk, zones, params, dataCacheParams, enableDataCache, volumeID), err
}

func (gceCS *GCEControllerServer) createSingleDisk(ctx context.Context, req *csi.CreateVolumeRequest, params common.DiskParameters, volKey *meta.Key, zones []string) (*gce.CloudDisk, error) {
capacityRange := req.GetCapacityRange()
capBytes, _ := getRequestCapacity(capacityRange)
func getAccessMode(req *csi.CreateVolumeRequest, params common.DiskParameters) (string, error) {
readonly, _ := getReadOnlyFromCapabilities(req.GetVolumeCapabilities())
accessMode := ""
multiWriter := false
if common.IsHyperdisk(params.DiskType) {
if am, err := getHyperdiskAccessModeFromCapabilities(req.GetVolumeCapabilities()); err != nil {
return nil, err
return "", err
} else if disksWithUnsettableAccessMode[params.DiskType] {
// Disallow multi-attach for HdT and HdE. These checks were done in `createVolumeInternal`,
// but repeating them here future-proves us from possible refactors.
if am != common.GCEReadWriteOnceAccessMode {
return nil, status.Errorf(codes.Internal, "")
return "", status.Errorf(codes.Internal, "")
}
} else {
accessMode = am
return am, nil
}
} else {
multiWriter, _ = getMultiWriterFromCapabilities(req.GetVolumeCapabilities())
}

if readonly && slices.Contains(disksWithModifiableAccessMode, params.DiskType) {
accessMode = common.GCEReadOnlyManyAccessMode
return common.GCEReadOnlyManyAccessMode, nil
}

return "", nil
}

func (gceCS *GCEControllerServer) createSingleDisk(ctx context.Context, req *csi.CreateVolumeRequest, params common.DiskParameters, volKey *meta.Key, zones []string, accessMode string) (*gce.CloudDisk, error) {
capacityRange := req.GetCapacityRange()
capBytes, _ := getRequestCapacity(capacityRange)

multiWriter := false
if !common.IsHyperdisk(params.DiskType) {
multiWriter, _ = getMultiWriterFromCapabilities(req.GetVolumeCapabilities())
}

// Validate if disk already exists
Expand Down
123 changes: 106 additions & 17 deletions pkg/gce-pd-csi-driver/controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1298,6 +1298,54 @@ func TestCreateVolumeArguments(t *testing.T) {
},
expErrCode: codes.InvalidArgument,
},
{
name: "err empty HdB ROX single-zone disk no content source",
req: &csi.CreateVolumeRequest{
Name: name,
CapacityRange: stdCapRange,
VolumeCapabilities: []*csi.VolumeCapability{
{
AccessType: &csi.VolumeCapability_Mount{
Mount: &csi.VolumeCapability_MountVolume{},
},
AccessMode: &csi.VolumeCapability_AccessMode{
Mode: csi.VolumeCapability_AccessMode_MULTI_NODE_READER_ONLY,
},
},
},
Parameters: map[string]string{
common.ParameterKeyType: "hyperdisk-balanced",
},
},
expErrCode: codes.InvalidArgument,
},
{
name: "success empty HdML ROX single-zone disk no content source",
req: &csi.CreateVolumeRequest{
Name: name,
CapacityRange: stdCapRange,
VolumeCapabilities: []*csi.VolumeCapability{
{
AccessType: &csi.VolumeCapability_Mount{
Mount: &csi.VolumeCapability_MountVolume{},
},
AccessMode: &csi.VolumeCapability_AccessMode{
Mode: csi.VolumeCapability_AccessMode_MULTI_NODE_READER_ONLY,
},
},
},
Parameters: map[string]string{
common.ParameterKeyType: "hyperdisk-ml",
},
},
expVol: &csi.Volume{
CapacityBytes: common.GbToBytes(20),
VolumeId: testVolumeID,
VolumeContext: nil,
AccessibleTopology: stdTopology,
},
expErrCode: codes.OK,
},
}

// Run test cases
Expand All @@ -1318,6 +1366,7 @@ func TestCreateVolumeArguments(t *testing.T) {
}
continue
}
t.Logf("ErroCode: %v", err)
if tc.expErrCode != codes.OK {
t.Fatalf("Expected error: %v, got no error", tc.expErrCode)
}
Expand Down Expand Up @@ -1504,7 +1553,7 @@ func TestMultiZoneVolumeCreation(t *testing.T) {
expZones: []string{"us-central1-a", "us-central1-b", "us-central1-c"},
},
{
name: "err single ROX multi-zone no topology",
name: "success empty HdML ROX multi-zone disk no content source",
req: &csi.CreateVolumeRequest{
Name: "test-name",
CapacityRange: stdCapRange,
Expand All @@ -1522,18 +1571,26 @@ func TestMultiZoneVolumeCreation(t *testing.T) {
common.ParameterKeyType: "hyperdisk-ml",
common.ParameterKeyEnableMultiZoneProvisioning: "true",
},
VolumeContentSource: &csi.VolumeContentSource{
Type: &csi.VolumeContentSource_Snapshot{
Snapshot: &csi.VolumeContentSource_SnapshotSource{
SnapshotId: testSnapshotID,
AccessibilityRequirements: &csi.TopologyRequirement{
Requisite: []*csi.Topology{
{
Segments: map[string]string{common.TopologyKeyZone: "us-central1-a"},
},
},
Preferred: []*csi.Topology{
{
Segments: map[string]string{common.TopologyKeyZone: "us-central1-a"},
},
{
Segments: map[string]string{common.TopologyKeyZone: "us-central1-b"},
},
},
},
},
expErrCode: codes.InvalidArgument,
expZones: []string{"us-central1-a", "us-central1-b"},
},
{
name: "err rwo access mode",
name: "error empty HdB ROX multi-zone disk no content source",
req: &csi.CreateVolumeRequest{
Name: "test-name",
CapacityRange: stdCapRange,
Expand All @@ -1543,21 +1600,14 @@ func TestMultiZoneVolumeCreation(t *testing.T) {
Mount: &csi.VolumeCapability_MountVolume{},
},
AccessMode: &csi.VolumeCapability_AccessMode{
Mode: csi.VolumeCapability_AccessMode_SINGLE_NODE_WRITER,
Mode: csi.VolumeCapability_AccessMode_MULTI_NODE_READER_ONLY,
},
},
},
Parameters: map[string]string{
common.ParameterKeyType: "hyperdisk-ml",
common.ParameterKeyType: "hyperdisk-balanced",
common.ParameterKeyEnableMultiZoneProvisioning: "true",
},
VolumeContentSource: &csi.VolumeContentSource{
Type: &csi.VolumeContentSource_Snapshot{
Snapshot: &csi.VolumeContentSource_SnapshotSource{
SnapshotId: testSnapshotID,
},
},
},
AccessibilityRequirements: &csi.TopologyRequirement{
Requisite: []*csi.Topology{
{
Expand All @@ -1568,13 +1618,16 @@ func TestMultiZoneVolumeCreation(t *testing.T) {
{
Segments: map[string]string{common.TopologyKeyZone: "us-central1-a"},
},
{
Segments: map[string]string{common.TopologyKeyZone: "us-central1-b"},
},
},
},
},
expErrCode: codes.InvalidArgument,
},
{
name: "err no content source",
name: "err single ROX multi-zone no topology",
req: &csi.CreateVolumeRequest{
Name: "test-name",
CapacityRange: stdCapRange,
Expand All @@ -1592,6 +1645,42 @@ func TestMultiZoneVolumeCreation(t *testing.T) {
common.ParameterKeyType: "hyperdisk-ml",
common.ParameterKeyEnableMultiZoneProvisioning: "true",
},
VolumeContentSource: &csi.VolumeContentSource{
Type: &csi.VolumeContentSource_Snapshot{
Snapshot: &csi.VolumeContentSource_SnapshotSource{
SnapshotId: testSnapshotID,
},
},
},
},
expErrCode: codes.InvalidArgument,
},
{
name: "err rwo access mode",
req: &csi.CreateVolumeRequest{
Name: "test-name",
CapacityRange: stdCapRange,
VolumeCapabilities: []*csi.VolumeCapability{
{
AccessType: &csi.VolumeCapability_Mount{
Mount: &csi.VolumeCapability_MountVolume{},
},
AccessMode: &csi.VolumeCapability_AccessMode{
Mode: csi.VolumeCapability_AccessMode_SINGLE_NODE_WRITER,
},
},
},
Parameters: map[string]string{
common.ParameterKeyType: "hyperdisk-ml",
common.ParameterKeyEnableMultiZoneProvisioning: "true",
},
VolumeContentSource: &csi.VolumeContentSource{
Type: &csi.VolumeContentSource_Snapshot{
Snapshot: &csi.VolumeContentSource_SnapshotSource{
SnapshotId: testSnapshotID,
},
},
},
AccessibilityRequirements: &csi.TopologyRequirement{
Requisite: []*csi.Topology{
{
Expand Down
Loading