-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathparameters.go
148 lines (132 loc) · 4.81 KB
/
parameters.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*
Copyright 2020 The Kubernetes Authors.
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 common
import (
"fmt"
"strings"
)
const (
// Parameters for StorageClass
ParameterKeyType = "type"
ParameterKeyReplicationType = "replication-type"
ParameterKeyDiskEncryptionKmsKey = "disk-encryption-kms-key"
ParameterKeyLabels = "labels"
// Parameters for VolumeSnapshotClass
ParameterKeyStorageLocations = "storage-locations"
replicationTypeNone = "none"
// Keys for PV and PVC parameters as reported by external-provisioner
ParameterKeyPVCName = "csi.storage.k8s.io/pvc/name"
ParameterKeyPVCNamespace = "csi.storage.k8s.io/pvc/namespace"
ParameterKeyPVName = "csi.storage.k8s.io/pv/name"
// Keys for tags to put in the provisioned disk description.
tagKeyCreatedForClaimNamespace = "kubernetes.io/created-for/pvc/namespace"
tagKeyCreatedForClaimName = "kubernetes.io/created-for/pvc/name"
tagKeyCreatedForVolumeName = "kubernetes.io/created-for/pv/name"
tagKeyCreatedBy = "storage.gke.io/created-by"
)
// DiskParameters contains normalized and defaulted disk parameters
type DiskParameters struct {
// Values: pd-standard, pd-balanced, pd-ssd, or any other PD disk type. Not validated.
// Default: pd-standard
DiskType string
// Values: "none", regional-pd
// Default: "none"
ReplicationType string
// Values: {string}
// Default: ""
DiskEncryptionKMSKey string
// Values: {map[string]string}
// Default: ""
Tags map[string]string
// Values: {map[string]string}
// Default: ""
Labels map[string]string
}
// SnapshotParameters contains normalized and defaulted parameters for snapshots
type SnapshotParameters struct {
StorageLocations []string
}
// ExtractAndDefaultParameters will take the relevant parameters from a map and
// put them into a well defined struct making sure to default unspecified fields.
// extraVolumeLabels are added as labels; if there are also labels specified in
// parameters, any matching extraVolumeLabels will be overridden.
func ExtractAndDefaultParameters(parameters map[string]string, driverName string, extraVolumeLabels map[string]string) (DiskParameters, error) {
p := DiskParameters{
DiskType: "pd-standard", // Default
ReplicationType: replicationTypeNone, // Default
DiskEncryptionKMSKey: "", // Default
Tags: make(map[string]string), // Default
Labels: make(map[string]string), // Default
}
for k, v := range extraVolumeLabels {
p.Labels[k] = v
}
for k, v := range parameters {
if k == "csiProvisionerSecretName" || k == "csiProvisionerSecretNamespace" {
// These are hardcoded secrets keys required to function but not needed by GCE PD
continue
}
switch strings.ToLower(k) {
case ParameterKeyType:
if v != "" {
p.DiskType = strings.ToLower(v)
}
case ParameterKeyReplicationType:
if v != "" {
p.ReplicationType = strings.ToLower(v)
}
case ParameterKeyDiskEncryptionKmsKey:
// Resource names (e.g. "keyRings", "cryptoKeys", etc.) are case sensitive, so do not change case
p.DiskEncryptionKMSKey = v
case ParameterKeyPVCName:
p.Tags[tagKeyCreatedForClaimName] = v
case ParameterKeyPVCNamespace:
p.Tags[tagKeyCreatedForClaimNamespace] = v
case ParameterKeyPVName:
p.Tags[tagKeyCreatedForVolumeName] = v
case ParameterKeyLabels:
paramLabels, err := ConvertLabelsStringToMap(v)
if err != nil {
return p, fmt.Errorf("parameters contain invalid labels parameter: %w", err)
}
// Override any existing labels with those from this parameter.
for labelKey, labelValue := range paramLabels {
p.Labels[labelKey] = labelValue
}
default:
return p, fmt.Errorf("parameters contains invalid option %q", k)
}
}
if len(p.Tags) > 0 {
p.Tags[tagKeyCreatedBy] = driverName
}
return p, nil
}
func ExtractAndDefaultSnapshotParameters(parameters map[string]string) (SnapshotParameters, error) {
p := SnapshotParameters{
StorageLocations: []string{},
}
for k, v := range parameters {
switch strings.ToLower(k) {
case ParameterKeyStorageLocations:
normalizedStorageLocations, err := ProcessStorageLocations(v)
if err != nil {
return p, err
}
p.StorageLocations = normalizedStorageLocations
default:
return p, fmt.Errorf("parameters contains invalid option %q", k)
}
}
return p, nil
}