@@ -19,6 +19,8 @@ package common
1919import (
2020 "fmt"
2121 "strings"
22+
23+ "k8s.io/klog/v2"
2224)
2325
2426const (
@@ -32,7 +34,11 @@ const (
3234 ParameterAvailabilityClass = "availability-class"
3335 ParameterKeyEnableConfidentialCompute = "enable-confidential-storage"
3436 ParameterKeyStoragePools = "storage-pools"
35- ParameterKeyResourceTags = "resource-tags"
37+
38+ // Parameters for Data Cache
39+ ParameterKeyDataCacheSize = "data-cache-size"
40+ ParameterKeyDataCacheMode = "data-cache-mode"
41+ ParameterKeyResourceTags = "resource-tags"
3642
3743 // Parameters for VolumeSnapshotClass
3844 ParameterKeyStorageLocations = "storage-locations"
@@ -68,6 +74,16 @@ const (
6874 tagKeyCreatedForSnapshotContentName = "kubernetes.io/created-for/volumesnapshotcontent/name"
6975)
7076
77+ type DataCacheParameters struct {
78+ // Values: {string}
79+ // Default: ""
80+ // Example: "25Gi"
81+ DataCacheSize string
82+ // Values: writethrough, writeback
83+ // Default: writethrough
84+ DataCacheMode string
85+ }
86+
7187// DiskParameters contains normalized and defaulted disk parameters
7288type DiskParameters struct {
7389 // Values: pd-standard, pd-balanced, pd-ssd, or any other PD disk type. Not validated.
@@ -125,7 +141,7 @@ type StoragePool struct {
125141// put them into a well defined struct making sure to default unspecified fields.
126142// extraVolumeLabels are added as labels; if there are also labels specified in
127143// parameters, any matching extraVolumeLabels will be overridden.
128- func ExtractAndDefaultParameters (parameters map [string ]string , driverName string , extraVolumeLabels map [string ]string , enableStoragePools bool , extraTags map [string ]string ) (DiskParameters , error ) {
144+ func ExtractAndDefaultParameters (parameters map [string ]string , driverName string , extraVolumeLabels map [string ]string , enableStoragePools bool , enableDataCache bool , extraTags map [string ]string ) (DiskParameters , DataCacheParameters , error ) {
129145 p := DiskParameters {
130146 DiskType : "pd-standard" , // Default
131147 ReplicationType : replicationTypeNone , // Default
@@ -135,6 +151,12 @@ func ExtractAndDefaultParameters(parameters map[string]string, driverName string
135151 ResourceTags : make (map [string ]string ), // Default
136152 }
137153
154+ // Set data cache feature default
155+ d := DataCacheParameters {}
156+ if enableDataCache {
157+ d .DataCacheMode = "writethrough"
158+ }
159+
138160 for k , v := range extraVolumeLabels {
139161 p .Labels [k ] = v
140162 }
@@ -169,7 +191,7 @@ func ExtractAndDefaultParameters(parameters map[string]string, driverName string
169191 case ParameterKeyLabels :
170192 paramLabels , err := ConvertLabelsStringToMap (v )
171193 if err != nil {
172- return p , fmt .Errorf ("parameters contain invalid labels parameter: %w" , err )
194+ return p , d , fmt .Errorf ("parameters contain invalid labels parameter: %w" , err )
173195 }
174196 // Override any existing labels with those from this parameter.
175197 for labelKey , labelValue := range paramLabels {
@@ -178,58 +200,71 @@ func ExtractAndDefaultParameters(parameters map[string]string, driverName string
178200 case ParameterKeyProvisionedIOPSOnCreate :
179201 paramProvisionedIOPSOnCreate , err := ConvertStringToInt64 (v )
180202 if err != nil {
181- return p , fmt .Errorf ("parameters contain invalid provisionedIOPSOnCreate parameter: %w" , err )
203+ return p , d , fmt .Errorf ("parameters contain invalid provisionedIOPSOnCreate parameter: %w" , err )
182204 }
183205 p .ProvisionedIOPSOnCreate = paramProvisionedIOPSOnCreate
184206 case ParameterKeyProvisionedThroughputOnCreate :
185207 paramProvisionedThroughputOnCreate , err := ConvertMiStringToInt64 (v )
186208 if err != nil {
187- return p , fmt .Errorf ("parameters contain invalid provisionedThroughputOnCreate parameter: %w" , err )
209+ return p , d , fmt .Errorf ("parameters contain invalid provisionedThroughputOnCreate parameter: %w" , err )
188210 }
189211 p .ProvisionedThroughputOnCreate = paramProvisionedThroughputOnCreate
190212 case ParameterAvailabilityClass :
191213 paramAvailabilityClass , err := ConvertStringToAvailabilityClass (v )
192214 if err != nil {
193- return p , fmt .Errorf ("parameters contain invalid availability class parameter: %w" , err )
215+ return p , d , fmt .Errorf ("parameters contain invalid availability class parameter: %w" , err )
194216 }
195217 if paramAvailabilityClass == ParameterRegionalHardFailoverClass {
196218 p .ForceAttach = true
197219 }
198220 case ParameterKeyEnableConfidentialCompute :
199221 paramEnableConfidentialCompute , err := ConvertStringToBool (v )
200222 if err != nil {
201- return p , fmt .Errorf ("parameters contain invalid value for enable-confidential-storage parameter: %w" , err )
223+ return p , d , fmt .Errorf ("parameters contain invalid value for enable-confidential-storage parameter: %w" , err )
202224 }
203225
204226 if paramEnableConfidentialCompute {
205227 // DiskEncryptionKmsKey is needed to enable confidentialStorage
206228 if val , ok := parameters [ParameterKeyDiskEncryptionKmsKey ]; ! ok || ! isValidDiskEncryptionKmsKey (val ) {
207- return p , fmt .Errorf ("Valid %v is required to enable ConfidentialStorage" , ParameterKeyDiskEncryptionKmsKey )
229+ return p , d , fmt .Errorf ("Valid %v is required to enable ConfidentialStorage" , ParameterKeyDiskEncryptionKmsKey )
208230 }
209231 }
210232
211233 p .EnableConfidentialCompute = paramEnableConfidentialCompute
212234 case ParameterKeyStoragePools :
213235 if ! enableStoragePools {
214- return p , fmt .Errorf ("parameters contains invalid option %q" , ParameterKeyStoragePools )
236+ return p , d , fmt .Errorf ("parameters contains invalid option %q" , ParameterKeyStoragePools )
215237 }
216238 storagePools , err := ParseStoragePools (v )
217239 if err != nil {
218- return p , fmt .Errorf ("parameters contain invalid value for %s parameter: %w" , ParameterKeyStoragePools , err )
240+ return p , d , fmt .Errorf ("parameters contain invalid value for %s parameter: %w" , ParameterKeyStoragePools , err )
219241 }
220242 p .StoragePools = storagePools
243+ case ParameterKeyDataCacheSize :
244+ if ! enableDataCache {
245+ return p , d , fmt .Errorf ("parameters contains invalid option %q" , ParameterKeyDataCacheSize )
246+ }
247+ // TODO: need to parse or validate the string
248+ d .DataCacheSize = v
249+ klog .V (2 ).Infof ("====== Data cache size is %v ======" , v )
250+ case ParameterKeyDataCacheMode :
251+ if ! enableDataCache {
252+ return p , d , fmt .Errorf ("parameters contains invalid option %q" , ParameterKeyDataCacheSize )
253+ }
254+ d .DataCacheMode = v
255+ klog .V (2 ).Infof ("====== Data cache mode is %v ======" , v )
221256 case ParameterKeyResourceTags :
222257 if err := extractResourceTagsParameter (v , p .ResourceTags ); err != nil {
223- return p , err
258+ return p , d , err
224259 }
225260 default :
226- return p , fmt .Errorf ("parameters contains invalid option %q" , k )
261+ return p , d , fmt .Errorf ("parameters contains invalid option %q" , k )
227262 }
228263 }
229264 if len (p .Tags ) > 0 {
230265 p .Tags [tagKeyCreatedBy ] = driverName
231266 }
232- return p , nil
267+ return p , d , nil
233268}
234269
235270func ExtractAndDefaultSnapshotParameters (parameters map [string ]string , driverName string , extraTags map [string ]string ) (SnapshotParameters , error ) {
0 commit comments