-
Notifications
You must be signed in to change notification settings - Fork 1
/
csi_handler.go
464 lines (413 loc) · 13.8 KB
/
csi_handler.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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
/*
Copyright 2017 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 attacher
import (
"context"
"fmt"
"time"
"github.com/golang/glog"
"k8s.io/api/core/v1"
storage "k8s.io/api/storage/v1beta1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/client-go/kubernetes"
corelisters "k8s.io/client-go/listers/core/v1"
storagelisters "k8s.io/client-go/listers/storage/v1beta1"
"k8s.io/client-go/util/workqueue"
csilisters "k8s.io/csi-api/pkg/client/listers/csi/v1alpha1"
)
// csiHandler is a handler that calls CSI to attach/detach volume.
// It adds finalizer to VolumeAttachment instance to make sure they're detached
// before deletion.
type csiHandler struct {
client kubernetes.Interface
attacherName string
csiConnection CSIConnection
pvLister corelisters.PersistentVolumeLister
nodeLister corelisters.NodeLister
nodeInfoLister csilisters.CSINodeInfoLister
vaLister storagelisters.VolumeAttachmentLister
vaQueue, pvQueue workqueue.RateLimitingInterface
timeout time.Duration
}
var _ Handler = &csiHandler{}
// NewCSIHandler creates a new CSIHandler.
func NewCSIHandler(
client kubernetes.Interface,
attacherName string,
csiConnection CSIConnection,
pvLister corelisters.PersistentVolumeLister,
nodeLister corelisters.NodeLister,
nodeInfoLister csilisters.CSINodeInfoLister,
vaLister storagelisters.VolumeAttachmentLister,
timeout *time.Duration) Handler {
return &csiHandler{
client: client,
attacherName: attacherName,
csiConnection: csiConnection,
pvLister: pvLister,
nodeLister: nodeLister,
nodeInfoLister: nodeInfoLister,
vaLister: vaLister,
timeout: *timeout,
}
}
func (h *csiHandler) Init(vaQueue workqueue.RateLimitingInterface, pvQueue workqueue.RateLimitingInterface) {
h.vaQueue = vaQueue
h.pvQueue = pvQueue
}
func (h *csiHandler) SyncNewOrUpdatedVolumeAttachment(va *storage.VolumeAttachment) {
glog.V(4).Infof("CSIHandler: processing VA %q", va.Name)
var err error
if va.DeletionTimestamp == nil {
err = h.syncAttach(va)
} else {
err = h.syncDetach(va)
}
if err != nil {
// Re-queue with exponential backoff
glog.V(2).Infof("Error processing %q: %s", va.Name, err)
h.vaQueue.AddRateLimited(va.Name)
return
}
// The operation has finished successfully, reset exponential backoff
h.vaQueue.Forget(va.Name)
glog.V(4).Infof("CSIHandler: finished processing %q", va.Name)
}
func (h *csiHandler) syncAttach(va *storage.VolumeAttachment) error {
if va.Status.Attached {
// Volume is attached, there is nothing to be done.
glog.V(4).Infof("%q is already attached", va.Name)
return nil
}
// Attach and report any error
glog.V(2).Infof("Attaching %q", va.Name)
va, metadata, err := h.csiAttach(va)
if err != nil {
var saveErr error
va, saveErr = h.saveAttachError(va, err)
if saveErr != nil {
// Just log it, propagate the attach error.
glog.V(2).Infof("Failed to save attach error to %q: %s", va.Name, saveErr.Error())
}
// Add context to the error for logging
err := fmt.Errorf("failed to attach: %s", err)
return err
}
glog.V(2).Infof("Attached %q", va.Name)
// Mark as attached
if _, err := markAsAttached(h.client, va, metadata); err != nil {
return fmt.Errorf("failed to mark as attached: %s", err)
}
glog.V(4).Infof("Fully attached %q", va.Name)
return nil
}
func (h *csiHandler) syncDetach(va *storage.VolumeAttachment) error {
glog.V(4).Infof("Starting detach operation for %q", va.Name)
if !h.hasVAFinalizer(va) {
glog.V(4).Infof("%q is already detached", va.Name)
return nil
}
// Detach and report any error
glog.V(2).Infof("Detaching %q", va.Name)
va, err := h.csiDetach(va)
if err != nil {
var saveErr error
va, saveErr = h.saveDetachError(va, err)
if saveErr != nil {
// Just log it, propagate the detach error.
glog.V(2).Infof("Failed to save detach error to %q: %s", va.Name, saveErr.Error())
}
// Add context to the error for logging
err := fmt.Errorf("failed to detach: %s", err)
return err
}
glog.V(4).Infof("Fully detached %q", va.Name)
return nil
}
func (h *csiHandler) addVAFinalizer(va *storage.VolumeAttachment) (*storage.VolumeAttachment, error) {
finalizerName := GetFinalizerName(h.attacherName)
for _, f := range va.Finalizers {
if f == finalizerName {
// Finalizer is already present
glog.V(4).Infof("VA finalizer is already set on %q", va.Name)
return va, nil
}
}
// Finalizer is not present, add it
glog.V(4).Infof("Adding finalizer to VA %q", va.Name)
clone := va.DeepCopy()
clone.Finalizers = append(clone.Finalizers, finalizerName)
// TODO: use patch to save us from VersionError
newVA, err := h.client.StorageV1beta1().VolumeAttachments().Update(clone)
if err != nil {
return va, err
}
glog.V(4).Infof("VA finalizer added to %q", va.Name)
return newVA, nil
}
func (h *csiHandler) addPVFinalizer(pv *v1.PersistentVolume) (*v1.PersistentVolume, error) {
finalizerName := GetFinalizerName(h.attacherName)
for _, f := range pv.Finalizers {
if f == finalizerName {
// Finalizer is already present
glog.V(4).Infof("PV finalizer is already set on %q", pv.Name)
return pv, nil
}
}
// Finalizer is not present, add it
glog.V(4).Infof("Adding finalizer to PV %q", pv.Name)
clone := pv.DeepCopy()
clone.Finalizers = append(clone.Finalizers, finalizerName)
// TODO: use patch to save us from VersionError
newPV, err := h.client.CoreV1().PersistentVolumes().Update(clone)
if err != nil {
return pv, err
}
glog.V(4).Infof("PV finalizer added to %q", pv.Name)
return newPV, nil
}
func (h *csiHandler) hasVAFinalizer(va *storage.VolumeAttachment) bool {
finalizerName := GetFinalizerName(h.attacherName)
for _, f := range va.Finalizers {
if f == finalizerName {
return true
}
}
return false
}
func (h *csiHandler) csiAttach(va *storage.VolumeAttachment) (*storage.VolumeAttachment, map[string]string, error) {
glog.V(4).Infof("Starting attach operation for %q", va.Name)
// Check as much as possible before adding VA finalizer - it would block
// deletion of VA on error.
if va.Spec.Source.PersistentVolumeName == nil {
return va, nil, fmt.Errorf("VolumeAttachment.spec.persistentVolumeName is empty")
}
pv, err := h.pvLister.Get(*va.Spec.Source.PersistentVolumeName)
if err != nil {
return va, nil, err
}
// Refuse to attach volumes that are marked for deletion.
if pv.DeletionTimestamp != nil {
return va, nil, fmt.Errorf("PersistentVolume %q is marked for deletion", pv.Name)
}
pv, err = h.addPVFinalizer(pv)
if err != nil {
return va, nil, fmt.Errorf("could not add PersistentVolume finalizer: %s", err)
}
attributes, err := GetVolumeAttributes(pv)
if err != nil {
return va, nil, err
}
volumeHandle, readOnly, err := GetVolumeHandle(pv)
if err != nil {
return va, nil, err
}
volumeCapabilities, err := GetVolumeCapabilities(pv)
if err != nil {
return va, nil, err
}
secrets, err := h.getCredentialsFromPV(pv)
if err != nil {
return va, nil, err
}
nodeID, err := h.getNodeID(h.attacherName, va.Spec.NodeName)
if err != nil {
return va, nil, err
}
va, err = h.addVAFinalizer(va)
if err != nil {
return va, nil, fmt.Errorf("could not add VolumeAttachment finalizer: %s", err)
}
ctx, cancel := context.WithTimeout(context.Background(), h.timeout)
defer cancel()
// We're not interested in `detached` return value, the controller will
// issue Detach to be sure the volume is really detached.
publishInfo, _, err := h.csiConnection.Attach(ctx, volumeHandle, readOnly, nodeID, volumeCapabilities, attributes, secrets)
if err != nil {
return va, nil, err
}
return va, publishInfo, nil
}
func (h *csiHandler) csiDetach(va *storage.VolumeAttachment) (*storage.VolumeAttachment, error) {
if va.Spec.Source.PersistentVolumeName == nil {
return va, fmt.Errorf("VolumeAttachment.spec.persistentVolumeName is empty")
}
pv, err := h.pvLister.Get(*va.Spec.Source.PersistentVolumeName)
if err != nil {
return va, err
}
volumeHandle, _, err := GetVolumeHandle(pv)
if err != nil {
return va, err
}
secrets, err := h.getCredentialsFromPV(pv)
if err != nil {
return va, err
}
nodeID, err := h.getNodeID(h.attacherName, va.Spec.NodeName)
if err != nil {
return va, err
}
ctx, cancel := context.WithTimeout(context.Background(), h.timeout)
defer cancel()
detached, err := h.csiConnection.Detach(ctx, volumeHandle, nodeID, secrets)
if err != nil && !detached {
// The volume may not be fully detached. Save the error and try again
// after backoff.
return va, err
}
if err != nil {
glog.V(2).Infof("Detached %q with error %s", va.Name, err.Error())
} else {
glog.V(2).Infof("Detached %q", va.Name)
}
if va, err := markAsDetached(h.client, va); err != nil {
return va, fmt.Errorf("could not mark as detached: %s", err)
}
return va, nil
}
func (h *csiHandler) saveAttachError(va *storage.VolumeAttachment, err error) (*storage.VolumeAttachment, error) {
glog.V(4).Infof("Saving attach error to %q", va.Name)
clone := va.DeepCopy()
clone.Status.AttachError = &storage.VolumeError{
Message: err.Error(),
Time: metav1.Now(),
}
newVa, err := h.client.StorageV1beta1().VolumeAttachments().Update(clone)
if err != nil {
return va, err
}
glog.V(4).Infof("Saved attach error to %q", va.Name)
return newVa, nil
}
func (h *csiHandler) saveDetachError(va *storage.VolumeAttachment, err error) (*storage.VolumeAttachment, error) {
glog.V(4).Infof("Saving detach error to %q", va.Name)
clone := va.DeepCopy()
clone.Status.DetachError = &storage.VolumeError{
Message: err.Error(),
Time: metav1.Now(),
}
newVa, err := h.client.StorageV1beta1().VolumeAttachments().Update(clone)
if err != nil {
return va, err
}
glog.V(4).Infof("Saved detach error to %q", va.Name)
return newVa, nil
}
func (h *csiHandler) SyncNewOrUpdatedPersistentVolume(pv *v1.PersistentVolume) {
glog.V(4).Infof("CSIHandler: processing PV %q", pv.Name)
// Sync and remove finalizer on given PV
if pv.DeletionTimestamp == nil {
// Don't process anything that has no deletion timestamp.
glog.V(4).Infof("CSIHandler: processing PV %q: no deletion timestamp, ignoring", pv.Name)
h.pvQueue.Forget(pv.Name)
return
}
// Check if the PV has finalizer
finalizer := GetFinalizerName(h.attacherName)
found := false
for _, f := range pv.Finalizers {
if f == finalizer {
found = true
break
}
}
if !found {
// No finalizer -> no action required
glog.V(4).Infof("CSIHandler: processing PV %q: no finalizer, ignoring", pv.Name)
h.pvQueue.Forget(pv.Name)
return
}
// Check that there is no VA that requires the PV
vas, err := h.vaLister.List(labels.Everything())
if err != nil {
// Failed listing VAs? Try again with exp. backoff
glog.Errorf("Failed to list VolumeAttachments for PV %q: %s", pv.Name, err.Error())
h.pvQueue.AddRateLimited(pv.Name)
return
}
for _, va := range vas {
if va.Spec.Source.PersistentVolumeName != nil && *va.Spec.Source.PersistentVolumeName == pv.Name {
// This PV is needed by this VA, don't remove finalizer
glog.V(4).Infof("CSIHandler: processing PV %q: VA %q found", pv.Name, va.Name)
h.pvQueue.Forget(pv.Name)
return
}
}
// No VA found -> remove finalizer
glog.V(4).Infof("CSIHandler: processing PV %q: no VA found, removing finalizer", pv.Name)
clone := pv.DeepCopy()
newFinalizers := []string{}
for _, f := range pv.Finalizers {
if f == finalizer {
continue
}
newFinalizers = append(newFinalizers, f)
}
if len(newFinalizers) == 0 {
// Canonize empty finalizers for unit test (so we don't need to
// distinguish nil and [] there)
newFinalizers = nil
}
clone.Finalizers = newFinalizers
_, err = h.client.CoreV1().PersistentVolumes().Update(clone)
if err != nil {
glog.Errorf("Failed to remove finalizer from PV %q: %s", pv.Name, err.Error())
h.pvQueue.AddRateLimited(pv.Name)
return
}
glog.V(2).Infof("Removed finalizer from PV %q", pv.Name)
h.pvQueue.Forget(pv.Name)
return
}
func (h *csiHandler) getCredentialsFromPV(pv *v1.PersistentVolume) (map[string]string, error) {
if pv.Spec.PersistentVolumeSource.CSI == nil {
return nil, fmt.Errorf("persistent volume does not contain CSI volume source")
}
secretRef := pv.Spec.PersistentVolumeSource.CSI.ControllerPublishSecretRef
if secretRef == nil {
return nil, nil
}
secret, err := h.client.CoreV1().Secrets(secretRef.Namespace).Get(secretRef.Name, metav1.GetOptions{})
if err != nil {
return nil, fmt.Errorf("failed to load secret \"%s/%s\": %s", secretRef.Namespace, secretRef.Name, err)
}
credentials := map[string]string{}
for key, value := range secret.Data {
credentials[key] = string(value)
}
return credentials, nil
}
func (h *csiHandler) getNodeID(driver string, nodeName string) (string, error) {
// Try to find CSINodeInfo first.
nodeInfo, err := h.nodeInfoLister.Get(nodeName)
if err == nil {
if nodeID, found := GetNodeIDFromNodeInfo(driver, nodeInfo); found {
glog.V(4).Infof("Found NodeID %s in CSINodeInfo %s", nodeID, nodeName)
return nodeID, nil
}
glog.V(4).Infof("CSINodeInfo %s does not contain driver %s", nodeName, driver)
// CSINodeInfo exists, but does not have the requested driver.
// Fall through to Node annotation.
} else {
// Can't get CSINodeInfo, fall through to Node annotation.
glog.V(4).Infof("Can't get CSINodeInfo %s: %s", nodeName, err)
}
// Check Node annotation.
node, err := h.nodeLister.Get(nodeName)
if err != nil {
return "", err
}
return GetNodeIDFromNode(driver, node)
}