-
Notifications
You must be signed in to change notification settings - Fork 0
/
identity.go
334 lines (286 loc) · 10.9 KB
/
identity.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
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Cilium
package identitybackend
import (
"context"
"fmt"
"reflect"
"strconv"
"strings"
"github.com/sirupsen/logrus"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/fields"
"k8s.io/client-go/tools/cache"
"github.com/cilium/cilium/pkg/allocator"
"github.com/cilium/cilium/pkg/idpool"
k8sConst "github.com/cilium/cilium/pkg/k8s/apis/cilium.io"
v2 "github.com/cilium/cilium/pkg/k8s/apis/cilium.io/v2"
clientset "github.com/cilium/cilium/pkg/k8s/client/clientset/versioned"
"github.com/cilium/cilium/pkg/k8s/informer"
"github.com/cilium/cilium/pkg/kvstore"
"github.com/cilium/cilium/pkg/labels"
"github.com/cilium/cilium/pkg/logging"
"github.com/cilium/cilium/pkg/logging/logfields"
"github.com/cilium/cilium/pkg/rate"
)
var (
log = logging.DefaultLogger.WithField(logfields.LogSubsys, "crd-allocator")
)
const (
k8sPrefix = labels.LabelSourceK8s + ":"
k8sNamespaceLabelPrefix = labels.LabelSourceK8s + ":" + k8sConst.PodNamespaceMetaLabels + labels.PathDelimiter
)
func NewCRDBackend(c CRDBackendConfiguration) (allocator.Backend, error) {
return &crdBackend{CRDBackendConfiguration: c}, nil
}
type CRDBackendConfiguration struct {
NodeName string
Store cache.Store
Client clientset.Interface
KeyType allocator.AllocatorKey
}
type crdBackend struct {
CRDBackendConfiguration
}
func (c *crdBackend) DeleteAllKeys(ctx context.Context) {
}
// sanitizeK8sLabels strips the 'k8s:' prefix in the labels generated by
// AllocatorKey.GetAsMap (when the key is k8s labels). In the CRD identity case
// we map the labels directly to the ciliumidentity CRD instance, and
// kubernetes does not allow ':' in the name of the label. These labels are not
// the canonical labels of the identity, but used to ease interaction with the
// CRD object.
func sanitizeK8sLabels(old map[string]string) (selected, skipped map[string]string) {
skipped = make(map[string]string, len(old))
selected = make(map[string]string, len(old))
for k, v := range old {
// Skip non-k8s labels.
// Skip synthesized labels for k8s namespace labels, since they contain user input which can result in the label
// name being longer than 63 characters.
if !strings.HasPrefix(k, k8sPrefix) || strings.HasPrefix(k, k8sNamespaceLabelPrefix) {
skipped[k] = v
continue // skip non-k8s labels
}
k = strings.TrimPrefix(k, k8sPrefix) // k8s: is redundant
selected[k] = v
}
return selected, skipped
}
// AllocateID will create an identity CRD, thus creating the identity for this
// key-> ID mapping.
// Note: the lock field is not supported with the k8s CRD allocator.
func (c *crdBackend) AllocateID(ctx context.Context, id idpool.ID, key allocator.AllocatorKey) error {
selectedLabels, skippedLabels := sanitizeK8sLabels(key.GetAsMap())
log.WithField(logfields.Labels, skippedLabels).Info("Skipped non-kubernetes labels when labelling ciliumidentity. All labels will still be used in identity determination")
identity := &v2.CiliumIdentity{
ObjectMeta: metav1.ObjectMeta{
Name: id.String(),
Labels: selectedLabels,
},
SecurityLabels: key.GetAsMap(),
}
_, err := c.Client.CiliumV2().CiliumIdentities().Create(ctx, identity, metav1.CreateOptions{})
return err
}
func (c *crdBackend) AllocateIDIfLocked(ctx context.Context, id idpool.ID, key allocator.AllocatorKey, lock kvstore.KVLocker) error {
return c.AllocateID(ctx, id, key)
}
// AcquireReference acquires a reference to the identity.
func (c *crdBackend) AcquireReference(ctx context.Context, id idpool.ID, key allocator.AllocatorKey, lock kvstore.KVLocker) error {
// For CiliumIdentity-based allocation, the reference counting is
// handled via CiliumEndpoint. Any CiliumEndpoint referring to a
// CiliumIdentity will keep the CiliumIdentity alive. No action is
// needed to acquire the reference here.
return nil
}
func (c *crdBackend) RunLocksGC(_ context.Context, _ map[string]kvstore.Value) (map[string]kvstore.Value, error) {
return nil, nil
}
func (c *crdBackend) RunGC(context.Context, *rate.Limiter, map[string]uint64, idpool.ID, idpool.ID) (map[string]uint64, *allocator.GCStats, error) {
return nil, nil, nil
}
// UpdateKey refreshes the reference that this node is using this key->ID
// mapping. It assumes that the identity already exists but will recreate it if
// reliablyMissing is true.
// Note: the lock field is not supported with the k8s CRD allocator.
func (c *crdBackend) UpdateKey(ctx context.Context, id idpool.ID, key allocator.AllocatorKey, reliablyMissing bool) error {
err := c.AcquireReference(ctx, id, key, nil)
if err == nil {
log.WithFields(logrus.Fields{
logfields.Identity: id,
logfields.Labels: key,
}).Debug("Acquired reference for identity")
return nil
}
// The CRD (aka the master key) is missing. Try to recover by recreating it
// if reliablyMissing is set.
log.WithError(err).WithFields(logrus.Fields{
logfields.Identity: id,
logfields.Labels: key,
}).Warning("Unable update CRD identity information with a reference for this node")
if reliablyMissing {
// Recreate a missing master key
if err = c.AllocateID(ctx, id, key); err != nil {
return fmt.Errorf("Unable recreate missing CRD identity %q->%q: %s", key, id, err)
}
}
return nil
}
func (c *crdBackend) UpdateKeyIfLocked(ctx context.Context, id idpool.ID, key allocator.AllocatorKey, reliablyMissing bool, lock kvstore.KVLocker) error {
return c.UpdateKey(ctx, id, key, reliablyMissing)
}
// Lock does not return a lock object. Locking is not supported with the k8s
// CRD allocator. It is here to meet interface requirements.
func (c *crdBackend) Lock(ctx context.Context, key allocator.AllocatorKey) (kvstore.KVLocker, error) {
return &crdLock{}, nil
}
type crdLock struct{}
// Unlock does not unlock a lock object. Locking is not supported with the k8s
// CRD allocator. It is here to meet interface requirements.
func (c *crdLock) Unlock(ctx context.Context) error {
return nil
}
// Comparator does nothing. Locking is not supported with the k8s
// CRD allocator. It is here to meet interface requirements.
func (c *crdLock) Comparator() interface{} {
return nil
}
// get returns the first identity found for the given set of labels as we might
// have duplicated entries identities for the same set of labels.
func (c *crdBackend) get(ctx context.Context, key allocator.AllocatorKey) *v2.CiliumIdentity {
if c.Store == nil {
return nil
}
for _, identityObject := range c.Store.List() {
identity, ok := identityObject.(*v2.CiliumIdentity)
if !ok {
return nil
}
if reflect.DeepEqual(identity.SecurityLabels, key.GetAsMap()) {
return identity
}
}
return nil
}
// Get returns the first ID which is allocated to a key in the identity CRDs in
// kubernetes.
// Note: the lock field is not supported with the k8s CRD allocator.
func (c *crdBackend) Get(ctx context.Context, key allocator.AllocatorKey) (idpool.ID, error) {
identity := c.get(ctx, key)
if identity == nil {
return idpool.NoID, nil
}
id, err := strconv.ParseUint(identity.Name, 10, 64)
if err != nil {
return idpool.NoID, fmt.Errorf("unable to parse value '%s': %s", identity.Name, err)
}
return idpool.ID(id), nil
}
func (c *crdBackend) GetIfLocked(ctx context.Context, key allocator.AllocatorKey, lock kvstore.KVLocker) (idpool.ID, error) {
return c.Get(ctx, key)
}
// getById fetches the identities from the local store. Returns a nil `err` and
// false `exists` if an Identity is not found for the given `id`.
func (c *crdBackend) getById(ctx context.Context, id idpool.ID) (idty *v2.CiliumIdentity, exists bool, err error) {
if c.Store == nil {
return nil, false, fmt.Errorf("store is not available yet")
}
identityTemplate := &v2.CiliumIdentity{
ObjectMeta: metav1.ObjectMeta{
Name: id.String(),
},
}
obj, exists, err := c.Store.Get(identityTemplate)
if err != nil {
return nil, exists, err
}
if !exists {
return nil, exists, nil
}
identity, ok := obj.(*v2.CiliumIdentity)
if !ok {
return nil, false, fmt.Errorf("invalid object")
}
return identity, true, nil
}
// GetByID returns the key associated with an ID. Returns nil if no key is
// associated with the ID.
// Note: the lock field is not supported with the k8s CRD allocator.
func (c *crdBackend) GetByID(ctx context.Context, id idpool.ID) (allocator.AllocatorKey, error) {
identity, exists, err := c.getById(ctx, id)
if err != nil {
return nil, err
}
if !exists {
return nil, nil
}
return c.KeyType.PutKeyFromMap(identity.SecurityLabels), nil
}
// Release dissociates this node from using the identity bound to the given ID.
// When an identity has no references it may be garbage collected.
func (c *crdBackend) Release(ctx context.Context, id idpool.ID, key allocator.AllocatorKey) (err error) {
// For CiliumIdentity-based allocation, the reference counting is
// handled via CiliumEndpoint. Any CiliumEndpoint referring to a
// CiliumIdentity will keep the CiliumIdentity alive. No action is
// needed to release the reference here.
return nil
}
func (c *crdBackend) ListAndWatch(ctx context.Context, handler allocator.CacheMutations, stopChan chan struct{}) {
c.Store = cache.NewStore(cache.DeletionHandlingMetaNamespaceKeyFunc)
identityInformer := informer.NewInformerWithStore(
cache.NewListWatchFromClient(c.Client.CiliumV2().RESTClient(),
v2.CIDPluralName, v1.NamespaceAll, fields.Everything()),
&v2.CiliumIdentity{},
0,
cache.ResourceEventHandlerFuncs{
AddFunc: func(obj interface{}) {
if identity, ok := obj.(*v2.CiliumIdentity); ok {
if id, err := strconv.ParseUint(identity.Name, 10, 64); err == nil {
handler.OnAdd(idpool.ID(id), c.KeyType.PutKeyFromMap(identity.SecurityLabels))
}
}
},
UpdateFunc: func(oldObj, newObj interface{}) {
if oldIdentity, ok := newObj.(*v2.CiliumIdentity); ok {
if newIdentity, ok := newObj.(*v2.CiliumIdentity); ok {
if oldIdentity.DeepEqual(newIdentity) {
return
}
if id, err := strconv.ParseUint(newIdentity.Name, 10, 64); err == nil {
handler.OnModify(idpool.ID(id), c.KeyType.PutKeyFromMap(newIdentity.SecurityLabels))
}
}
}
},
DeleteFunc: func(obj interface{}) {
// The delete event is sometimes for items with unknown state that are
// deleted anyway.
if deleteObj, isDeleteObj := obj.(cache.DeletedFinalStateUnknown); isDeleteObj {
obj = deleteObj.Obj
}
if identity, ok := obj.(*v2.CiliumIdentity); ok {
if id, err := strconv.ParseUint(identity.Name, 10, 64); err == nil {
handler.OnDelete(idpool.ID(id), c.KeyType.PutKeyFromMap(identity.SecurityLabels))
}
} else {
log.Debugf("Ignoring unknown delete event %#v", obj)
}
},
},
nil,
c.Store,
)
go func() {
if ok := cache.WaitForCacheSync(stopChan, identityInformer.HasSynced); ok {
handler.OnListDone()
}
}()
identityInformer.Run(stopChan)
}
func (c *crdBackend) Status() (string, error) {
return "OK", nil
}
func (c *crdBackend) Encode(v string) string {
return v
}