Skip to content

Commit 3f3ed63

Browse files
sunnylovestiramisusunnylovestiramisu
committed
Add provisionedIops for pd-extreme
1 parent df8eae3 commit 3f3ed63

File tree

15 files changed

+891
-22
lines changed

15 files changed

+891
-22
lines changed

‎README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,14 @@ See Github [Issues](https://github.com/kubernetes-sigs/gcp-compute-persistent-di
5858

5959
### CreateVolume Parameters
6060

61-
| Parameter | Values | Default | Description |
62-
|------------------|---------------------------|---------------|----------------------------------------------------------------------------------------------------|
63-
| type | Any PD type (see [GCP documentation](https://cloud.google.com/compute/docs/disks#disk-types)), eg `pd-ssd` `pd-balanced` | `pd-standard` | Type allows you to choose between standard Persistent Disks or Solid State Drive Persistent Disks |
64-
| replication-type | `none` OR `regional-pd` | `none` | Replication type allows you to choose between Zonal Persistent Disks or Regional Persistent Disks |
65-
| disk-encryption-kms-key | Fully qualified resource identifier for the key to use to encrypt new disks. | Empty string. | Encrypt disk using Customer Managed Encryption Key (CMEK). See [GKE Docs](https://cloud.google.com/kubernetes-engine/docs/how-to/using-cmek#create_a_cmek_protected_attached_disk) for details. |
66-
| labels | `key1=value1,key2=value2` | | Labels allow you to assign custom [GCE Disk labels](https://cloud.google.com/compute/docs/labeling-resources). |
61+
| Parameter | Values | Default | Description |
62+
|-----------------------------|---------------------------|---------------|----------------------------------------------------------------------------------------------------|
63+
| type | Any PD type (see [GCP documentation](https://cloud.google.com/compute/docs/disks#disk-types)), eg `pd-ssd` `pd-balanced` | `pd-standard` | Type allows you to choose between standard Persistent Disks or Solid State Drive Persistent Disks |
64+
| replication-type | `none` OR `regional-pd` | `none` | Replication type allows you to choose between Zonal Persistent Disks or Regional Persistent Disks |
65+
| disk-encryption-kms-key | Fully qualified resource identifier for the key to use to encrypt new disks. | Empty string. | Encrypt disk using Customer Managed Encryption Key (CMEK). See [GKE Docs](https://cloud.google.com/kubernetes-engine/docs/how-to/using-cmek#create_a_cmek_protected_attached_disk) for details. |
66+
| labels | `key1=value1,key2=value2` | | Labels allow you to assign custom [GCE Disk labels](https://cloud.google.com/compute/docs/labeling-resources). |
67+
| provisioned-iops-on-create | string (int64 format). Values typically between 10,000 and 120,000 | | Indicates how many IOPS to provision for the disk. See the [Extreme persistent disk documentation](https://cloud.google.com/compute/docs/disks/extreme-persistent-disk) for details, including valid ranges for IOPS. |
68+
6769

6870
### Topology
6971

‎go.mod

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ require (
2121
gopkg.in/gcfg.v1 v1.2.3
2222
k8s.io/apimachinery v0.24.1
2323
k8s.io/client-go v11.0.1-0.20190805182717-6502b5e7b1b5+incompatible
24+
k8s.io/cloud-provider v0.24.1
2425
k8s.io/component-base v0.24.1
2526
k8s.io/klog/v2 v2.60.1
2627
k8s.io/kubernetes v1.24.1

‎go.sum

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2432,6 +2432,7 @@ k8s.io/apiserver v0.24.1/go.mod h1:dQWNMx15S8NqJMp0gpYfssyvhYnkilc1LpExd/dkLh0=
24322432
k8s.io/cli-runtime v0.24.1/go.mod h1:14aVvCTqkA7dNXY51N/6hRY3GUjchyWDOwW84qmR3bs=
24332433
k8s.io/client-go v0.24.1 h1:w1hNdI9PFrzu3OlovVeTnf4oHDt+FJLd9Ndluvnb42E=
24342434
k8s.io/client-go v0.24.1/go.mod h1:f1kIDqcEYmwXS/vTbbhopMUbhKp2JhOeVTfxgaCIlF8=
2435+
k8s.io/cloud-provider v0.24.1 h1:SaQNq2Ax+epdY9wFngwN9GWpOVnM72hUqr2qy20cOvg=
24352436
k8s.io/cloud-provider v0.24.1/go.mod h1:h5m/KIiwiQ76hpUBsgrwm/rxteIfJG9kJQ/+/w1as2M=
24362437
k8s.io/cluster-bootstrap v0.24.1/go.mod h1:uq2PiYfKh8ZLb6DBU/3/2Z1DkMqXkTOHLemalC4tOgE=
24372438
k8s.io/code-generator v0.24.1/go.mod h1:dpVhs00hTuTdTY6jvVxvTFCk6gSMrtfRydbhZwHI15w=

‎pkg/common/parameters.go

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,11 @@ import (
2323

2424
const (
2525
// Parameters for StorageClass
26-
ParameterKeyType = "type"
27-
ParameterKeyReplicationType = "replication-type"
28-
ParameterKeyDiskEncryptionKmsKey = "disk-encryption-kms-key"
29-
ParameterKeyLabels = "labels"
26+
ParameterKeyType = "type"
27+
ParameterKeyReplicationType = "replication-type"
28+
ParameterKeyDiskEncryptionKmsKey = "disk-encryption-kms-key"
29+
ParameterKeyLabels = "labels"
30+
ParameterKeyProvisionedIOPSOnCreate = "provisioned-iops-on-create"
3031

3132
// Parameters for VolumeSnapshotClass
3233
ParameterKeyStorageLocations = "storage-locations"
@@ -80,6 +81,9 @@ type DiskParameters struct {
8081
// Values: {map[string]string}
8182
// Default: ""
8283
Labels map[string]string
84+
// Values: {int64}
85+
// Default: none
86+
ProvisionedIOPSOnCreate int64
8387
}
8488

8589
// SnapshotParameters contains normalized and defaulted parameters for snapshots
@@ -143,6 +147,12 @@ func ExtractAndDefaultParameters(parameters map[string]string, driverName string
143147
for labelKey, labelValue := range paramLabels {
144148
p.Labels[labelKey] = labelValue
145149
}
150+
case ParameterKeyProvisionedIOPSOnCreate:
151+
paramProvisionedIOPSOnCreate, err := ConvertGiBStringToInt64(v)
152+
if err != nil {
153+
return p, fmt.Errorf("parameters contain invalid provisionedIOPSOnCreate parameter: %w", err)
154+
}
155+
p.ProvisionedIOPSOnCreate = paramProvisionedIOPSOnCreate
146156
default:
147157
return p, fmt.Errorf("parameters contains invalid option %q", k)
148158
}

‎pkg/common/parameters_test.go

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,22 @@ func TestExtractAndDefaultParameters(t *testing.T) {
7474
},
7575
},
7676
},
77+
{
78+
name: "values from parameters, checking pd-extreme",
79+
parameters: map[string]string{ParameterKeyType: "pd-extreme", ParameterKeyReplicationType: "none", ParameterKeyDiskEncryptionKmsKey: "foo/key", ParameterKeyLabels: "key1=value1,key2=value2", ParameterKeyProvisionedIOPSOnCreate: "10000Gi"},
80+
labels: map[string]string{},
81+
expectParams: DiskParameters{
82+
DiskType: "pd-extreme",
83+
ReplicationType: "none",
84+
DiskEncryptionKMSKey: "foo/key",
85+
Tags: map[string]string{},
86+
Labels: map[string]string{
87+
"key1": "value1",
88+
"key2": "value2",
89+
},
90+
ProvisionedIOPSOnCreate: 10000,
91+
},
92+
},
7793
{
7894
name: "values from parameters, checking balanced pd",
7995
parameters: map[string]string{ParameterKeyType: "pd-balanced", ParameterKeyReplicationType: "regional-pd", ParameterKeyDiskEncryptionKmsKey: "foo/key"},

‎pkg/common/utils.go

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ import (
2222
"strings"
2323

2424
"github.com/GoogleCloudPlatform/k8s-cloud-provider/pkg/cloud/meta"
25+
"k8s.io/apimachinery/pkg/api/resource"
2526
"k8s.io/apimachinery/pkg/util/sets"
27+
volumehelpers "k8s.io/cloud-provider/volume/helpers"
2628
)
2729

2830
const (
@@ -248,3 +250,14 @@ func ValidateSnapshotType(snapshotType string) error {
248250
return fmt.Errorf("invalid snapshot type %s", snapshotType)
249251
}
250252
}
253+
254+
// ConvertGiBStringToInt64 converts a GiB string to int64
255+
func ConvertGiBStringToInt64(str string) (int64, error) {
256+
// Verify regex before
257+
match, _ := regexp.MatchString("^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$", str)
258+
if !match {
259+
return 0, fmt.Errorf("invalid string %s", str)
260+
}
261+
quantity := resource.MustParse(str)
262+
return volumehelpers.RoundUpToGiB(quantity)
263+
}

‎pkg/common/utils_test.go

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -577,3 +577,93 @@ func TestSnapshotStorageLocations(t *testing.T) {
577577
})
578578
}
579579
}
580+
581+
func TestConvertGiBStringToInt64(t *testing.T) {
582+
tests := []struct {
583+
desc string
584+
inputStr string
585+
expInt64 int64
586+
expectError bool
587+
}{
588+
{
589+
"valid number string",
590+
"10000",
591+
1,
592+
false,
593+
},
594+
{
595+
"round Ki to GiB",
596+
"1000Ki",
597+
1,
598+
false,
599+
},
600+
{
601+
"round k to GiB",
602+
"1000k",
603+
1,
604+
false,
605+
},
606+
{
607+
"round Mi to GiB",
608+
"1000Mi",
609+
1,
610+
false,
611+
},
612+
{
613+
"round M to GiB",
614+
"1000M",
615+
1,
616+
false,
617+
},
618+
{
619+
"round G to GiB",
620+
"1000G",
621+
932,
622+
false,
623+
},
624+
{
625+
"round Gi to GiB",
626+
"10000Gi",
627+
10000,
628+
false,
629+
},
630+
{
631+
"round decimal to GiB",
632+
"1.2Gi",
633+
2,
634+
false,
635+
},
636+
{
637+
"round big value to GiB",
638+
"8191Pi",
639+
8588886016,
640+
false,
641+
},
642+
{
643+
"invalid empty string",
644+
"",
645+
10000,
646+
true,
647+
},
648+
{
649+
"invalid string",
650+
"ew%65",
651+
10000,
652+
true,
653+
},
654+
}
655+
for _, tc := range tests {
656+
t.Run(tc.desc, func(t *testing.T) {
657+
actualInt64, err := ConvertGiBStringToInt64(tc.inputStr)
658+
if err != nil && !tc.expectError {
659+
t.Errorf("Got error %v converting string to int64 %s; expect no error", err, tc.inputStr)
660+
}
661+
if err == nil && tc.expectError {
662+
t.Errorf("Got no error converting string to int64 %s; expect an error", tc.inputStr)
663+
}
664+
if err == nil && actualInt64 != tc.expInt64 {
665+
t.Errorf("Got %d for converting string to int64; expect %d", actualInt64, tc.expInt64)
666+
}
667+
})
668+
}
669+
}

‎pkg/gce-cloud-provider/compute/fake-gce.go

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -196,13 +196,14 @@ func (cloud *FakeCloudProvider) InsertDisk(ctx context.Context, project string,
196196
}
197197

198198
computeDisk := &computev1.Disk{
199-
Name: volKey.Name,
200-
SizeGb: common.BytesToGbRoundUp(capBytes),
201-
Description: "Disk created by GCE-PD CSI Driver",
202-
Type: cloud.GetDiskTypeURI(project, volKey, params.DiskType),
203-
SourceDiskId: volumeContentSourceVolumeID,
204-
Status: cloud.mockDiskStatus,
205-
Labels: params.Labels,
199+
Name: volKey.Name,
200+
SizeGb: common.BytesToGbRoundUp(capBytes),
201+
Description: "Disk created by GCE-PD CSI Driver",
202+
Type: cloud.GetDiskTypeURI(project, volKey, params.DiskType),
203+
SourceDiskId: volumeContentSourceVolumeID,
204+
Status: cloud.mockDiskStatus,
205+
Labels: params.Labels,
206+
ProvisionedIops: params.ProvisionedIOPSOnCreate,
206207
}
207208

208209
if snapshotID != "" {

‎pkg/gce-cloud-provider/compute/gce-compute.go

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -429,11 +429,12 @@ func (cloud *CloudProvider) insertRegionalDisk(
429429
}
430430

431431
diskToCreate := &computev1.Disk{
432-
Name: volKey.Name,
433-
SizeGb: common.BytesToGbRoundUp(capBytes),
434-
Description: description,
435-
Type: cloud.GetDiskTypeURI(cloud.project, volKey, params.DiskType),
436-
Labels: params.Labels,
432+
Name: volKey.Name,
433+
SizeGb: common.BytesToGbRoundUp(capBytes),
434+
Description: description,
435+
Type: cloud.GetDiskTypeURI(cloud.project, volKey, params.DiskType),
436+
Labels: params.Labels,
437+
ProvisionedIops: params.ProvisionedIOPSOnCreate,
437438
}
438439
if snapshotID != "" {
439440
_, snapshotType, _, err := common.SnapshotIDToProjectKey(snapshotID)

‎pkg/gce-pd-csi-driver/controller_test.go

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -792,6 +792,31 @@ func TestCreateVolumeArguments(t *testing.T) {
792792
},
793793
expErrCode: codes.InvalidArgument,
794794
},
795+
{
796+
name: "success with provisionedIops parameter",
797+
req: &csi.CreateVolumeRequest{
798+
Name: name,
799+
CapacityRange: stdCapRange,
800+
VolumeCapabilities: stdVolCaps,
801+
Parameters: map[string]string{"labels": "key1=value1,key2=value2", "provisioned-iops-on-create": "10000"},
802+
},
803+
expVol: &csi.Volume{
804+
CapacityBytes: common.GbToBytes(20),
805+
VolumeId: testVolumeID,
806+
VolumeContext: nil,
807+
AccessibleTopology: stdTopology,
808+
},
809+
},
810+
{
811+
name: "fail with malformed provisionedIops parameter",
812+
req: &csi.CreateVolumeRequest{
813+
Name: name,
814+
CapacityRange: stdCapRange,
815+
VolumeCapabilities: stdVolCaps,
816+
Parameters: map[string]string{"labels": "key1=value1,key2=value2", "provisioned-iops-on-create": "dsfo3"},
817+
},
818+
expErrCode: codes.InvalidArgument,
819+
},
795820
}
796821

797822
// Run test cases

0 commit comments

Comments
 (0)