-
Notifications
You must be signed in to change notification settings - Fork 331
/
storage.go
310 lines (273 loc) · 12 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
/*
* 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"
"k8s.io/apimachinery/pkg/api/errors"
metainternal "k8s.io/apimachinery/pkg/apis/meta/internalversion"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
genericregistry "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/api/notify"
apiserverutil "tkestack.io/tke/pkg/apiserver/util"
channelstrategy "tkestack.io/tke/pkg/notify/registry/channel"
"tkestack.io/tke/pkg/notify/util"
"tkestack.io/tke/pkg/util/log"
)
// Storage includes storage for channels and all sub resources.
type Storage struct {
Channel *REST
Status *StatusREST
Finalize *FinalizeREST
}
// NewStorage returns a Storage object that will work against channels.
func NewStorage(optsGetter genericregistry.RESTOptionsGetter, privilegedUsername string) *Storage {
strategy := channelstrategy.NewStrategy()
store := ®istry.Store{
NewFunc: func() runtime.Object { return ¬ify.Channel{} },
NewListFunc: func() runtime.Object { return ¬ify.ChannelList{} },
DefaultQualifiedResource: notify.Resource("channels"),
PredicateFunc: channelstrategy.MatchChannel,
ReturnDeletedObject: true,
CreateStrategy: strategy,
UpdateStrategy: strategy,
DeleteStrategy: strategy,
}
store.TableConvertor = rest.NewDefaultTableConvertor(store.DefaultQualifiedResource)
options := &genericregistry.StoreOptions{
RESTOptions: optsGetter,
AttrFunc: channelstrategy.GetAttrs,
}
if err := store.CompleteWithOptions(options); err != nil {
log.Panic("Failed to create channel etcd rest storage", log.Err(err))
}
statusStore := *store
statusStore.UpdateStrategy = channelstrategy.NewStatusStrategy(strategy)
finalizeStore := *store
finalizeStore.UpdateStrategy = channelstrategy.NewFinalizerStrategy(strategy)
return &Storage{
Channel: &REST{store, privilegedUsername},
Status: &StatusREST{&statusStore},
Finalize: &FinalizeREST{&finalizeStore},
}
}
// ValidateGetObjectAndTenantID validate name and tenantID, if success return Channel
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
}
channel := obj.(*notify.Channel)
if err := util.FilterChannel(ctx, channel); err != nil {
return nil, err
}
return channel, nil
}
// REST implements a RESTStorage for channels against etcd.
type REST struct {
*registry.Store
privilegedUsername string
}
var _ rest.ShortNamesProvider = &REST{}
// ShortNames implements the ShortNamesProvider interface. Returns a list of short names for a resource.
func (r *REST) ShortNames() []string {
return []string{"chn"}
}
// 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) {
wrappedOptions := apiserverutil.PredicateListOptions(ctx, options)
return r.Store.List(ctx, wrappedOptions)
}
// 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) {
return r.Store.DeleteCollection(ctx, deleteValidation, options, listOptions)
}
// Get finds a resource in the storage by name and returns it.
func (r *REST) Get(ctx context.Context, channelName string, options *metav1.GetOptions) (runtime.Object, error) {
return ValidateGetObjectAndTenantID(ctx, r.Store, channelName, options)
}
// Update finds a resource in the storage and updates it.
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
// sub resources 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 channel termination
func (r *REST) Delete(ctx context.Context, name string, deleteValidation rest.ValidateObjectFunc, options *metav1.DeleteOptions) (runtime.Object, bool, error) {
nsObj, err := ValidateGetObjectAndTenantID(ctx, r.Store, name, &metav1.GetOptions{})
if err != nil {
return nil, false, err
}
channel := nsObj.(*notify.Channel)
// 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 = &channel.UID
} else if *options.Preconditions.UID != channel.UID {
err = errors.NewConflict(
notify.Resource("channels"),
name,
fmt.Errorf("precondition failed: UID in precondition: %v, UID in object meta: %v", *options.Preconditions.UID, channel.UID),
)
return nil, false, err
}
if options.Preconditions.ResourceVersion != nil && *options.Preconditions.ResourceVersion != channel.ResourceVersion {
err = errors.NewConflict(
notify.Resource("channels"),
name,
fmt.Errorf("precondition failed: ResourceVersion in precondition: %v, ResourceVersion in object meta: %v", *options.Preconditions.ResourceVersion, channel.ResourceVersion),
)
return nil, false, err
}
if channel.DeletionTimestamp.IsZero() {
key, err := r.Store.KeyFunc(ctx, name)
if err != nil {
return nil, false, err
}
preconditions := storage.Preconditions{UID: options.Preconditions.UID, ResourceVersion: options.Preconditions.ResourceVersion}
out := r.Store.NewFunc()
err = r.Store.Storage.GuaranteedUpdate(
ctx, key, out, false, &preconditions,
storage.SimpleUpdate(func(existing runtime.Object) (runtime.Object, error) {
existingChannel, ok := existing.(*notify.Channel)
if !ok {
// wrong type
return nil, fmt.Errorf("expected *notify.Channel, got %v", existing)
}
if err := deleteValidation(ctx, existingChannel); err != nil {
return nil, err
}
// Set the deletion timestamp if needed
if existingChannel.DeletionTimestamp.IsZero() {
now := metav1.Now()
existingChannel.DeletionTimestamp = &now
}
// Set the channel phase to terminating, if needed
if existingChannel.Status.Phase != notify.ChannelTerminating {
existingChannel.Status.Phase = notify.ChannelTerminating
}
// the current finalizers which are on namespace
currentFinalizers := map[string]bool{}
for _, f := range existingChannel.Finalizers {
currentFinalizers[f] = true
}
// the finalizers we should ensure on namespace
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)
}
existingChannel.Finalizers = newFinalizers
}
return existingChannel, nil
}),
dryrun.IsDryRun(options.DryRun),
nil,
)
if err != nil {
err = storageerr.InterpretGetError(err, notify.Resource("channels"), name)
err = storageerr.InterpretUpdateError(err, notify.Resource("channels"), name)
if _, ok := err.(*errors.StatusError); !ok {
err = errors.NewInternalError(err)
}
return nil, false, err
}
return out, false, nil
}
// prior to final deletion, we must ensure that finalizers is empty
if len(channel.Spec.Finalizers) != 0 {
err = errors.NewConflict(notify.Resource("channels"), channel.Name, fmt.Errorf("the system is ensuring all content is removed from this channel. Upon completion, this channel 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 channel.
type StatusREST 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 *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)
}
// 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 channel.
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 status finalizers subset of an object.
func (r *FinalizeREST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error) {
return ValidateGetObjectAndTenantID(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) {
// 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)
}