/
storage.go
457 lines (398 loc) · 16 KB
/
storage.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
/*
* Tencent is pleased to support the open source community by making TKEStack
* available.
*
* Copyright (C) 2012-2019 Tencent. All Rights Reserved.
*
* 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://opensource.org/licenses/Apache-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 OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package storage
import (
"context"
"fmt"
"strings"
"sync"
"github.com/casbin/casbin/v2"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
metainternal "k8s.io/apimachinery/pkg/apis/meta/internalversion"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apiserver/pkg/registry/generic"
"k8s.io/apiserver/pkg/registry/generic/registry"
"k8s.io/apiserver/pkg/registry/rest"
"k8s.io/apiserver/pkg/storage"
storageerr "k8s.io/apiserver/pkg/storage/errors"
"k8s.io/apiserver/pkg/util/dryrun"
"tkestack.io/tke/pkg/apiserver/authentication"
"tkestack.io/tke/api/auth"
apiserverutil "tkestack.io/tke/pkg/apiserver/util"
"tkestack.io/tke/pkg/auth/registry/role"
"tkestack.io/tke/pkg/auth/util"
"tkestack.io/tke/pkg/util/log"
authinternalclient "tkestack.io/tke/api/client/clientset/internalversion/typed/auth/internalversion"
)
// Storage includes storage for roles and all sub resources.
type Storage struct {
Role *REST
Status *StatusREST
Finalize *FinalizeREST
Binding *BindingREST
Unbinding *UnbindingREST
PolicyBinding *PolicyBindingREST
PolicyUnbinding *PolicyUnbindingREST
User *UserREST
Group *GroupREST
Policy *PolicyREST
}
// NewStorage returns a Storage object that will work against roles.
func NewStorage(optsGetter generic.RESTOptionsGetter, authClient authinternalclient.AuthInterface, enforcer *casbin.SyncedEnforcer, privilegedUsername string) *Storage {
strategy := role.NewStrategy(enforcer, authClient)
store := ®istry.Store{
NewFunc: func() runtime.Object { return &auth.Role{} },
NewListFunc: func() runtime.Object { return &auth.RoleList{} },
DefaultQualifiedResource: auth.Resource("roles"),
PredicateFunc: role.MatchRole,
CreateStrategy: strategy,
UpdateStrategy: strategy,
DeleteStrategy: strategy,
ShouldDeleteDuringUpdate: role.ShouldDeleteDuringUpdate,
}
options := &generic.StoreOptions{
RESTOptions: optsGetter,
AttrFunc: role.GetAttrs,
}
if err := store.CompleteWithOptions(options); err != nil {
log.Panic("Failed to create role etcd rest storage", log.Err(err))
}
statusStore := *store
statusStore.UpdateStrategy = role.NewStatusStrategy(strategy)
statusStore.ExportStrategy = role.NewStatusStrategy(strategy)
finalizeStore := *store
finalizeStore.UpdateStrategy = role.NewFinalizerStrategy(strategy)
finalizeStore.ExportStrategy = role.NewFinalizerStrategy(strategy)
return &Storage{
Role: &REST{store, privilegedUsername},
Status: &StatusREST{&statusStore},
Finalize: &FinalizeREST{&finalizeStore},
Binding: &BindingREST{store, authClient},
Unbinding: &UnbindingREST{store, authClient},
PolicyBinding: &PolicyBindingREST{store, authClient},
PolicyUnbinding: &PolicyUnbindingREST{store, authClient},
User: &UserREST{store, authClient},
Group: &GroupREST{store, authClient},
Policy: &PolicyREST{store, authClient, enforcer},
}
}
// ValidateGetObjectAndTenantID validate name and tenantID, if success return Role
func ValidateGetObjectAndTenantID(ctx context.Context, store *registry.Store, name string, options *metav1.GetOptions) (runtime.Object, error) {
obj, err := store.Get(ctx, name, options)
if err != nil {
return nil, err
}
o := obj.(*auth.Role)
if err := util.FilterRole(ctx, o); err != nil {
return nil, err
}
return o, nil
}
// ValidateExportObjectAndTenantID validate name and tenantID, if success return Role
func ValidateExportObjectAndTenantID(ctx context.Context, store *registry.Store, name string, options metav1.ExportOptions) (runtime.Object, error) {
obj, err := store.Export(ctx, name, options)
if err != nil {
return nil, err
}
o := obj.(*auth.Role)
if err := util.FilterRole(ctx, o); err != nil {
return nil, err
}
return o, nil
}
// REST implements a RESTStorage for clusters against etcd.
type REST struct {
*registry.Store
privilegedUsername string
}
// ShortNames implements the ShortNamesProvider interface. Returns a list of short names for a resource.
func (r *REST) ShortNames() []string {
return []string{"rol"}
}
// List selects resources in the storage which match to the selector. 'options' can be nil.
func (r *REST) List(ctx context.Context, options *metainternal.ListOptions) (runtime.Object, error) {
keyword := util.InterceptKeyword(options)
wrappedOptions := apiserverutil.PredicateListOptions(ctx, options)
obj, err := r.Store.List(ctx, wrappedOptions)
if err != nil {
return obj, err
}
roleList := obj.(*auth.RoleList)
if keyword != "" {
var newList []auth.Role
for _, val := range roleList.Items {
if val.Name == keyword || strings.Contains(val.Spec.Description, keyword) || strings.Contains(val.Spec.DisplayName, keyword) {
newList = append(newList, val)
}
}
roleList.Items = newList
}
return roleList, nil
}
// DeleteCollection selects all resources in the storage matching given 'listOptions'
// and deletes them.
func (r *REST) DeleteCollection(ctx context.Context, deleteValidation rest.ValidateObjectFunc, options *metav1.DeleteOptions, listOptions *metainternal.ListOptions) (runtime.Object, error) {
if !authentication.IsAdministrator(ctx, r.privilegedUsername) {
return nil, apierrors.NewMethodNotSupported(auth.Resource("roles"), "delete collection")
}
if listOptions == nil {
listOptions = &metainternal.ListOptions{}
} else {
listOptions = listOptions.DeepCopy()
}
listObj, err := r.Store.List(ctx, listOptions)
if err != nil {
return nil, err
}
items, err := meta.ExtractList(listObj)
if err != nil {
return nil, err
}
// Spawn a number of goroutines, so that we can issue requests to storage
// in parallel to speed up deletion.
// TODO: Make this proportional to the number of items to delete, up to
// DeleteCollectionWorkers (it doesn't make much sense to spawn 16
// workers to delete 10 items).
workersNumber := r.Store.DeleteCollectionWorkers
if workersNumber < 1 {
workersNumber = 1
}
wg := sync.WaitGroup{}
toProcess := make(chan int, 2*workersNumber)
errs := make(chan error, workersNumber+1)
go func() {
defer utilruntime.HandleCrash(func(panicReason interface{}) {
errs <- fmt.Errorf("DeleteCollection distributor panicked: %v", panicReason)
})
for i := 0; i < len(items); i++ {
toProcess <- i
}
close(toProcess)
}()
wg.Add(workersNumber)
for i := 0; i < workersNumber; i++ {
go func() {
// panics don't cross goroutine boundaries
defer utilruntime.HandleCrash(func(panicReason interface{}) {
errs <- fmt.Errorf("DeleteCollection goroutine panicked: %v", panicReason)
})
defer wg.Done()
for index := range toProcess {
accessor, err := meta.Accessor(items[index])
if err != nil {
errs <- err
return
}
tmpOpt := options
tmpOpt.Preconditions = nil
if _, _, err := r.Delete(ctx, accessor.GetName(), deleteValidation, tmpOpt); err != nil && !apierrors.IsNotFound(err) {
log.Warnf("Delete %s in DeleteCollection failed: %v", accessor.GetName(), err)
errs <- err
return
}
}
}()
}
wg.Wait()
select {
case err := <-errs:
return nil, err
default:
return listObj, nil
}
}
// Get finds a resource in the storage by name and returns it.
func (r *REST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error) {
return ValidateGetObjectAndTenantID(ctx, r.Store, name, options)
}
// Export an object. Fields that are not user specified are stripped out
// Returns the stripped object.
func (r *REST) Export(ctx context.Context, name string, options metav1.ExportOptions) (runtime.Object, error) {
return ValidateExportObjectAndTenantID(ctx, r.Store, name, options)
}
// Update alters the object subset of an object.
func (r *REST) Update(ctx context.Context, name string, objInfo rest.UpdatedObjectInfo, createValidation rest.ValidateObjectFunc, updateValidation rest.ValidateObjectUpdateFunc, forceAllowCreate bool, options *metav1.UpdateOptions) (runtime.Object, bool, error) {
// We are explicitly setting forceAllowCreate to false in the call to the underlying storage because
// subresources should never allow create on update.
_, err := ValidateGetObjectAndTenantID(ctx, r.Store, name, &metav1.GetOptions{})
if err != nil {
return nil, false, err
}
return r.Store.Update(ctx, name, objInfo, createValidation, updateValidation, false, options)
}
// Delete enforces life-cycle rules for role termination
func (r *REST) Delete(ctx context.Context, name string, deleteValidation rest.ValidateObjectFunc, options *metav1.DeleteOptions) (runtime.Object, bool, error) {
object, err := ValidateGetObjectAndTenantID(ctx, r.Store, name, &metav1.GetOptions{})
if err != nil {
return nil, false, err
}
role := object.(*auth.Role)
// Ensure we have a UID precondition
if options == nil {
options = metav1.NewDeleteOptions(0)
}
if options.Preconditions == nil {
options.Preconditions = &metav1.Preconditions{}
}
if options.Preconditions.UID == nil {
options.Preconditions.UID = &role.UID
} else if *options.Preconditions.UID != role.UID {
err = apierrors.NewConflict(
auth.Resource("roles"),
name,
fmt.Errorf("precondition failed: UID in precondition: %v, UID in object meta: %v", *options.Preconditions.UID, role.UID),
)
return nil, false, err
}
// upon first request to delete, we switch the phase to start role termination
if role.DeletionTimestamp.IsZero() {
key, err := r.Store.KeyFunc(ctx, name)
if err != nil {
return nil, false, err
}
preconditions := storage.Preconditions{UID: options.Preconditions.UID}
out := r.Store.NewFunc()
err = r.Store.Storage.GuaranteedUpdate(
ctx, key, out, false, &preconditions,
storage.SimpleUpdate(func(existing runtime.Object) (runtime.Object, error) {
existingRole, ok := existing.(*auth.Role)
if !ok {
// wrong type
return nil, fmt.Errorf("expected *auth.Role, got %v", existing)
}
if err := deleteValidation(ctx, existingRole); err != nil {
return nil, err
}
// Set the deletion timestamp if needed
if existingRole.DeletionTimestamp.IsZero() {
now := metav1.Now()
existingRole.DeletionTimestamp = &now
}
// Set the role phase to terminating, if needed
if existingRole.Status.Phase != auth.RoleTerminating {
existingRole.Status.Phase = auth.RoleTerminating
}
// the current finalizers which are on namespace
currentFinalizers := map[string]bool{}
for _, f := range existingRole.Finalizers {
currentFinalizers[f] = true
}
// the finalizers we should ensure on rule
shouldHaveFinalizers := map[string]bool{
metav1.FinalizerOrphanDependents: apiserverutil.ShouldHaveOrphanFinalizer(options, currentFinalizers[metav1.FinalizerOrphanDependents]),
metav1.FinalizerDeleteDependents: apiserverutil.ShouldHaveDeleteDependentsFinalizer(options, currentFinalizers[metav1.FinalizerDeleteDependents]),
}
// determine whether there are changes
changeNeeded := false
for finalizer, shouldHave := range shouldHaveFinalizers {
changeNeeded = currentFinalizers[finalizer] != shouldHave || changeNeeded
if shouldHave {
currentFinalizers[finalizer] = true
} else {
delete(currentFinalizers, finalizer)
}
}
// make the changes if needed
if changeNeeded {
var newFinalizers []string
for f := range currentFinalizers {
newFinalizers = append(newFinalizers, f)
}
existingRole.Finalizers = newFinalizers
}
return existingRole, nil
}),
dryrun.IsDryRun(options.DryRun),
)
if err != nil {
err = storageerr.InterpretGetError(err, auth.Resource("roles"), name)
err = storageerr.InterpretUpdateError(err, auth.Resource("roles"), name)
if _, ok := err.(*apierrors.StatusError); !ok {
err = apierrors.NewInternalError(err)
}
return nil, false, err
}
return out, false, nil
}
// prior to final deletion, we must ensure that finalizers is empty
if len(role.Spec.Finalizers) != 0 {
err = apierrors.NewConflict(auth.Resource("roles"), role.Name, fmt.Errorf("the system is ensuring all content is removed from this role. Upon completion, this role will automatically be purged by the system"))
return nil, false, err
}
return r.Store.Delete(ctx, name, deleteValidation, options)
}
// StatusREST implements the REST endpoint for changing the status of a
// replication controller.
type StatusREST struct {
store *registry.Store
}
// StatusREST implements Patcher.
var _ = rest.Patcher(&StatusREST{})
// New returns an empty object that can be used with Create and Update after
// request data has been put into it.
func (r *StatusREST) New() runtime.Object {
return r.store.New()
}
// Get retrieves the object from the storage. It is required to support Patch.
func (r *StatusREST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error) {
return ValidateGetObjectAndTenantID(ctx, r.store, name, options)
}
// Export an object. Fields that are not user specified are stripped out
// Returns the stripped object.
func (r *StatusREST) Export(ctx context.Context, name string, options metav1.ExportOptions) (runtime.Object, error) {
return ValidateExportObjectAndTenantID(ctx, r.store, name, options)
}
// Update alters the status subset of an object.
func (r *StatusREST) Update(ctx context.Context, name string, objInfo rest.UpdatedObjectInfo, createValidation rest.ValidateObjectFunc, updateValidation rest.ValidateObjectUpdateFunc, forceAllowCreate bool, options *metav1.UpdateOptions) (runtime.Object, bool, error) {
// We are explicitly setting forceAllowCreate to false in the call to the underlying storage because
// subresources should never allow create on update.
_, err := ValidateGetObjectAndTenantID(ctx, r.store, name, &metav1.GetOptions{})
if err != nil {
return nil, false, err
}
return r.store.Update(ctx, name, objInfo, createValidation, updateValidation, false, options)
}
// FinalizeREST implements the REST endpoint for finalizing a role.
type FinalizeREST struct {
store *registry.Store
}
// New returns an empty object that can be used with Create and Update after
// request data has been put into it.
func (r *FinalizeREST) New() runtime.Object {
return r.store.New()
}
// Get retrieves the object from the storage. It is required to support Patch.
func (r *FinalizeREST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error) {
return ValidateGetObjectAndTenantID(ctx, r.store, name, options)
}
// Export an object. Fields that are not user specified are stripped out
// Returns the stripped object.
func (r *FinalizeREST) Export(ctx context.Context, name string, options metav1.ExportOptions) (runtime.Object, error) {
return ValidateExportObjectAndTenantID(ctx, r.store, name, options)
}
// Update alters the status finalizers subset of an object.
func (r *FinalizeREST) Update(ctx context.Context, name string, objInfo rest.UpdatedObjectInfo, createValidation rest.ValidateObjectFunc, updateValidation rest.ValidateObjectUpdateFunc, forceAllowCreate bool, options *metav1.UpdateOptions) (runtime.Object, bool, error) {
_, err := ValidateGetObjectAndTenantID(ctx, r.store, name, &metav1.GetOptions{})
if err != nil {
return nil, false, err
}
return r.store.Update(ctx, name, objInfo, createValidation, updateValidation, false, options)
}