-
Notifications
You must be signed in to change notification settings - Fork 28
/
controller.go
329 lines (276 loc) · 10.7 KB
/
controller.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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
/*
Copyright 2018 The Kubernetes Authors.
Copyright 2022 Google LLC
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
https://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 driver
import (
"fmt"
"strings"
csi "github.com/container-storage-interface/spec/lib/go/csi"
"github.com/googlecloudplatform/gcs-fuse-csi-driver/pkg/cloud_provider/storage"
"github.com/googlecloudplatform/gcs-fuse-csi-driver/pkg/util"
"golang.org/x/net/context"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"k8s.io/klog/v2"
)
const (
MinimumVolumeSizeInBytes int64 = 1 * util.Mb
)
// CreateVolume parameters.
const (
// 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"
// User provided labels.
ParameterKeyLabels = "labels"
// Keys for tags to attach to the provisioned disk.
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"
)
// controllerServer handles volume provisioning.
type controllerServer struct {
driver *GCSDriver
storageServiceManager storage.ServiceManager
volumeLocks *util.VolumeLocks
}
func newControllerServer(driver *GCSDriver, storageServiceManager storage.ServiceManager) csi.ControllerServer {
return &controllerServer{
driver: driver,
storageServiceManager: storageServiceManager,
volumeLocks: util.NewVolumeLocks(),
}
}
func (s *controllerServer) ControllerGetCapabilities(_ context.Context, _ *csi.ControllerGetCapabilitiesRequest) (*csi.ControllerGetCapabilitiesResponse, error) {
return &csi.ControllerGetCapabilitiesResponse{
Capabilities: s.driver.cscap,
}, nil
}
func (s *controllerServer) ValidateVolumeCapabilities(ctx context.Context, req *csi.ValidateVolumeCapabilitiesRequest) (*csi.ValidateVolumeCapabilitiesResponse, error) {
// Validate arguments
volumeID := req.GetVolumeId()
if len(volumeID) == 0 {
return nil, status.Error(codes.InvalidArgument, "ValidateVolumeCapabilities volumeID must be provided")
}
caps := req.GetVolumeCapabilities()
if len(caps) == 0 {
return nil, status.Error(codes.InvalidArgument, "ValidateVolumeCapabilities volume capabilities must be provided")
}
storageService, err := s.prepareStorageService(ctx, req.GetSecrets())
if err != nil {
return nil, status.Errorf(codes.Unauthenticated, "failed to prepare storage service: %v", err)
}
// Check that the volume exists
newBucket, err := storageService.GetBucket(ctx, &storage.ServiceBucket{Name: volumeID})
if err != nil && !storage.IsNotExistErr(err) {
return nil, status.Error(codes.Internal, err.Error())
}
if newBucket == nil {
return nil, status.Error(codes.NotFound, fmt.Sprintf("volume %v doesn't exist", volumeID))
}
// Validate that the volume matches the capabilities
// Note that there is nothing in the bucket that we actually need to validate
if err := s.driver.validateVolumeCapabilities(caps); err != nil {
return &csi.ValidateVolumeCapabilitiesResponse{
Message: err.Error(),
}, status.Error(codes.InvalidArgument, err.Error())
}
return &csi.ValidateVolumeCapabilitiesResponse{
Confirmed: &csi.ValidateVolumeCapabilitiesResponse_Confirmed{
VolumeContext: req.GetVolumeContext(),
VolumeCapabilities: req.GetVolumeCapabilities(),
Parameters: req.GetParameters(),
},
}, nil
}
func (s *controllerServer) CreateVolume(ctx context.Context, req *csi.CreateVolumeRequest) (*csi.CreateVolumeResponse, error) {
// Validate arguments
name := req.GetName()
if len(name) == 0 {
return nil, status.Error(codes.InvalidArgument, "CreateVolume name must be provided")
}
volumeID := strings.ToLower(name)
if err := s.driver.validateVolumeCapabilities(req.GetVolumeCapabilities()); err != nil {
return nil, status.Error(codes.InvalidArgument, err.Error())
}
capBytes, err := getRequestCapacity(req.GetCapacityRange())
if err != nil {
return nil, status.Error(codes.InvalidArgument, err.Error())
}
secrets := req.GetSecrets()
projectID, ok := secrets["projectID"]
if !ok {
return nil, status.Error(codes.InvalidArgument, "projectID must be provided in secret")
}
if acquired := s.volumeLocks.TryAcquire(volumeID); !acquired {
return nil, status.Errorf(codes.Aborted, util.VolumeOperationAlreadyExistsFmt, volumeID)
}
defer s.volumeLocks.Release(volumeID)
param := req.GetParameters()
newBucket := &storage.ServiceBucket{
Project: projectID,
Name: volumeID,
SizeBytes: capBytes,
EnableUniformBucketLevelAccess: true,
}
storageService, err := s.prepareStorageService(ctx, secrets)
if err != nil {
return nil, status.Errorf(codes.Unauthenticated, "failed to prepare storage service: %v", err)
}
// Check if the bucket already exists
bucket, err := storageService.GetBucket(ctx, newBucket)
if err != nil && !storage.IsNotExistErr(err) {
return nil, status.Error(codes.Internal, err.Error())
}
if bucket != nil {
klog.V(4).Infof("Found existing bucket %+v, current bucket %+v\n", bucket, newBucket)
// Bucket already exists, check if it meets the request
if err = storage.CompareBuckets(newBucket, bucket); err != nil {
return nil, status.Error(codes.AlreadyExists, err.Error())
}
} else {
// Add labels
labels, err := extractLabels(param, s.driver.config.Name)
if err != nil {
return nil, status.Error(codes.InvalidArgument, err.Error())
}
newBucket.Labels = labels
// Create the bucket
var createErr error
bucket, createErr = storageService.CreateBucket(ctx, newBucket)
if createErr != nil {
return nil, status.Error(codes.Internal, createErr.Error())
}
}
resp := &csi.CreateVolumeResponse{Volume: bucketToCSIVolume(bucket)}
return resp, nil
}
func (s *controllerServer) DeleteVolume(ctx context.Context, req *csi.DeleteVolumeRequest) (*csi.DeleteVolumeResponse, error) {
// Validate arguments
volumeID := req.GetVolumeId()
if len(volumeID) == 0 {
return nil, status.Error(codes.InvalidArgument, "DeleteVolume volumeID must be provided")
}
if acquired := s.volumeLocks.TryAcquire(volumeID); !acquired {
return nil, status.Errorf(codes.Aborted, util.VolumeOperationAlreadyExistsFmt, volumeID)
}
defer s.volumeLocks.Release(volumeID)
storageService, err := s.prepareStorageService(ctx, req.GetSecrets())
if err != nil {
return nil, status.Errorf(codes.Unauthenticated, "failed to prepare storage service: %v", err)
}
// Delete the volume
err = storageService.DeleteBucket(ctx, &storage.ServiceBucket{Name: volumeID})
if err != nil {
return nil, status.Error(codes.Internal, err.Error())
}
return &csi.DeleteVolumeResponse{}, nil
}
// prepareStorageService prepares the GCS Storage Service using CreateVolume/DeleteVolume sercets.
func (s *controllerServer) prepareStorageService(ctx context.Context, secrets map[string]string) (storage.Service, error) {
serviceAccountName, ok := secrets["serviceAccountName"]
if !ok {
return nil, status.Error(codes.InvalidArgument, "serviceAccountName must be provided in secret")
}
serviceAccountNamespace, ok := secrets["serviceAccountNamespace"]
if !ok {
return nil, status.Error(codes.InvalidArgument, "serviceAccountNamespace must be provided in secret")
}
ts := s.driver.config.TokenManager.GetTokenSourceFromK8sServiceAccount(serviceAccountNamespace, serviceAccountName, "")
storageService, err := s.storageServiceManager.SetupService(ctx, ts)
if err != nil {
return nil, fmt.Errorf("storage service manager failed to setup service: %w", err)
}
return storageService, nil
}
// bucketToCSIVolume generates a CSI volume spec from the Google Cloud Storage Bucket.
func bucketToCSIVolume(bucket *storage.ServiceBucket) *csi.Volume {
resp := &csi.Volume{
CapacityBytes: bucket.SizeBytes,
VolumeId: bucket.Name,
}
return resp
}
func getRequestCapacity(capRange *csi.CapacityRange) (int64, error) {
var capBytes int64
// Default case where nothing is set
if capRange == nil {
capBytes = MinimumVolumeSizeInBytes
return capBytes, nil
}
rBytes := capRange.GetRequiredBytes()
rSet := rBytes > 0
lBytes := capRange.GetLimitBytes()
lSet := lBytes > 0
if lSet && rSet && lBytes < rBytes {
return 0, fmt.Errorf("limit bytes %v is less than required bytes %v", lBytes, rBytes)
}
if lSet && lBytes < MinimumVolumeSizeInBytes {
return 0, fmt.Errorf("limit bytes %v is less than minimum volume size: %v", lBytes, MinimumVolumeSizeInBytes)
}
// If Required set just set capacity to that which is Required
if rSet {
capBytes = rBytes
}
// Limit is more than Required, but larger than Minimum. So we just set capcity to Minimum
// Too small, default
if capBytes < MinimumVolumeSizeInBytes {
capBytes = MinimumVolumeSizeInBytes
}
return capBytes, nil
}
func extractLabels(parameters map[string]string, driverName string) (map[string]string, error) {
labels := make(map[string]string)
scLabels := make(map[string]string)
for k, v := range parameters {
switch strings.ToLower(k) {
case ParameterKeyPVCName:
labels[tagKeyCreatedForClaimName] = v
case ParameterKeyPVCNamespace:
labels[tagKeyCreatedForClaimNamespace] = v
case ParameterKeyPVName:
labels[tagKeyCreatedForVolumeName] = v
case ParameterKeyLabels:
var err error
scLabels, err = util.ConvertLabelsStringToMap(v)
if err != nil {
return nil, fmt.Errorf("parameters contain invalid labels parameter: %w", err)
}
}
}
labels[tagKeyCreatedBy] = strings.ReplaceAll(driverName, ".", "_")
labels, err := mergeLabels(scLabels, labels)
if err != nil {
return nil, err
}
// TODO: validate labels: https://cloud.google.com/storage/docs/tags-and-labels#bucket-labels
for k, v := range labels {
labels[k] = strings.ReplaceAll(v, ".", "_")
}
return mergeLabels(scLabels, labels)
}
func mergeLabels(scLabels map[string]string, metedataLabels map[string]string) (map[string]string, error) {
result := make(map[string]string)
for k, v := range metedataLabels {
result[k] = v
}
for k, v := range scLabels {
if _, ok := result[k]; ok {
return nil, fmt.Errorf("storage Class labels cannot contain metadata label key %s", k)
}
result[k] = v
}
return result, nil
}