forked from cisco-open/operator-tools
/
inventory.go
398 lines (340 loc) · 13.3 KB
/
inventory.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
// Copyright © 2020 Banzai Cloud
//
// 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 inventory
import (
"context"
"fmt"
"strings"
"emperror.dev/errors"
"github.com/go-logr/logr"
core "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/discovery"
"sigs.k8s.io/controller-runtime/pkg/client"
"github.com/pb82/operator-tools/pkg/reconciler"
"github.com/pb82/operator-tools/pkg/utils"
)
const (
CustomResourceDefinition = "CustomResourceDefinition"
Namespace = "Namespace"
referencesKey = "refs"
)
// State holder between reconcile phases
type InventoryData struct {
ObjectsToDelete []runtime.Object
CurrentObjects []runtime.Object
DesiredObjects []runtime.Object
}
// A generalized structure to enable us to attach additional inventory management
// around the native reconcile loop and adds the capability to store state between
// reconcile phases (see operator-tool's NativeReconciler)
type Inventory struct {
genericClient client.Client
log logr.Logger
inventoryData InventoryData
// map of GVK of cluster scoped API resources
clusterScopedAPIResources map[string]struct{}
// Discovery client to look up API resources
discoveryClient discovery.DiscoveryInterface
}
func NewInventory(client client.Client, log logr.Logger, clusterResources map[string]struct{}) (*Inventory, error) {
if clusterResources == nil {
return nil, errors.New("list of cluster scoped resources is required")
}
return &Inventory{
genericClient: client,
log: log,
clusterScopedAPIResources: clusterResources,
}, nil
}
func NewDiscoveryInventory(client client.Client, log logr.Logger, discovery discovery.DiscoveryInterface) *Inventory {
return &Inventory{
genericClient: client,
log: log,
discoveryClient: discovery,
}
}
func CreateObjectsInventory(namespace, name string, objects []runtime.Object) (*core.ConfigMap, error) {
resourceURLs := make([]string, len(objects))
for i := range objects {
objMeta, err := meta.Accessor(objects[i])
if err != nil {
return nil, err
}
objGVK := objects[i].GetObjectKind().GroupVersionKind()
resourceURLs[i] = fmt.Sprintf("%s/%s/%s/%s/%s",
objGVK.Group,
objGVK.Version,
objGVK.Kind,
objMeta.GetNamespace(),
objMeta.GetName())
}
cm := core.ConfigMap{
TypeMeta: metav1.TypeMeta{
Kind: "ConfigMap",
APIVersion: "v1",
},
ObjectMeta: metav1.ObjectMeta{
Namespace: namespace,
Name: name,
},
Immutable: utils.BoolPointer(false),
Data: map[string]string{
referencesKey: strings.Join(resourceURLs, ","),
},
}
return &cm, nil
}
func GetObjectsFromInventory(inventory core.ConfigMap) (objects []runtime.Object) {
resourceURLs := strings.Split(inventory.Data[referencesKey], ",")
for i := range resourceURLs {
if resourceURLs[i] == "" {
continue
}
parts := strings.Split(resourceURLs[i], "/")
u := &unstructured.Unstructured{}
u.SetGroupVersionKind(schema.GroupVersionKind{
Group: parts[0],
Version: parts[1],
Kind: parts[2],
})
u.SetNamespace(parts[3])
u.SetName(parts[4])
objects = append(objects, u)
}
return
}
// Hand over a GVK list to the native reconcile loop's purge method
func (c *Inventory) TypesToPurge() []schema.GroupVersionKind {
currentObjects := c.inventoryData.ObjectsToDelete
groupVersionKindDict := make(map[schema.GroupVersionKind]struct{})
for _, currentObject := range currentObjects {
gvk := currentObject.GetObjectKind().GroupVersionKind()
if gvk.Kind == CustomResourceDefinition || gvk.Kind == Namespace {
continue
}
if objMeta, err := meta.Accessor(currentObject); err == nil {
c.log.V(1).Info("mark object for deletion", "gvk", gvk.String(), "namespace", objMeta.GetNamespace(), "name", objMeta.GetName())
groupVersionKindDict[gvk] = struct{}{}
}
}
groupVersionKindList := make([]schema.GroupVersionKind, 0, len(groupVersionKindDict))
for k := range groupVersionKindDict {
groupVersionKindList = append(groupVersionKindList, k)
}
return groupVersionKindList
}
// Fetch list of resources made by the previous reconcile loop and store into an attached context
// Return a new list of resources which will be reconciled among with the other resources we listed here
func (c *Inventory) PrepareDesiredObjects(ns, componentName string, parent reconciler.ResourceOwner, resourceBuilders []reconciler.ResourceBuilder) (*core.ConfigMap, error) {
var err error
var desiredObjects []runtime.Object
var objectsInventory core.ConfigMap
objectsInventoryName := fmt.Sprintf("%s-%s-%s-object-inventory", parent.GetName(), ns, componentName)
// collect
err = c.genericClient.Get(context.TODO(), types.NamespacedName{Namespace: ns, Name: objectsInventoryName}, &objectsInventory)
if err != nil && !meta.IsNoMatchError(err) && !apierrors.IsNotFound(err) {
return nil, errors.WrapIfWithDetails(err,
"during object inventory fetch...",
"namespace", ns, "component", componentName, "inventoryName", objectsInventoryName)
}
c.inventoryData.CurrentObjects = GetObjectsFromInventory(objectsInventory)
// desired
for _, builder := range resourceBuilders {
obj, state, err := builder()
if err != nil {
return nil, errors.WrapIfWithDetails(err,
"couldn't build desired object...",
"namespace", ns, "component", componentName)
}
if state != reconciler.StateAbsent {
desiredObjects = append(desiredObjects, obj)
}
}
// sanitize desired objects
err = c.sanitizeDesiredObjects(desiredObjects)
if err != nil {
return nil, errors.WrapIfWithDetails(err,
"couldn't sanitize desired objects",
"namespace", ns, "component", componentName)
}
// ensure namespace
err = c.ensureNamespace(ns, desiredObjects)
if err != nil {
return nil, errors.WrapIfWithDetails(err,
"couldn't ensure namespace meta field on desired objects",
"namespace", ns, "component", componentName)
}
// create inventory of created objects
if newInventory, err := CreateObjectsInventory(ns, objectsInventoryName, desiredObjects); err == nil {
c.inventoryData.DesiredObjects = desiredObjects
return newInventory, nil
}
return nil, errors.WrapIfWithDetails(err,
"during object inventory creation...",
"namespace", ns, "inventoryName", objectsInventoryName)
}
// Collect `missing` resources from desired state
func (c *Inventory) PrepareDeletableObjects() error {
var deleteObjects []runtime.Object
currentObjects := c.inventoryData.CurrentObjects
for _, currentObject := range currentObjects {
metaobj, err := meta.Accessor(currentObject)
if err != nil {
return errors.WrapIfWithDetails(err,
"could not access object metadata",
"gvk", currentObject.GetObjectKind().GroupVersionKind().String())
}
isClusterScoped, err := c.IsClusterScoped(currentObject)
if err != nil {
c.log.Error(err, "scope check failed, unable to determine whether object is eligible for deletion")
continue
}
// check if current object still exists
if !isClusterScoped && metaobj.GetNamespace() == "" {
c.log.Info("object namespace is unknown, unable to determine whether is eligible for deletion", "gvk", currentObject.GetObjectKind().GroupVersionKind().String(), "name", metaobj.GetName())
continue
}
err = c.genericClient.Get(context.TODO(), types.NamespacedName{Namespace: metaobj.GetNamespace(), Name: metaobj.GetName()}, currentObject.(client.Object))
if err != nil && !meta.IsNoMatchError(err) && !apierrors.IsNotFound(err) {
return errors.WrapIfWithDetails(err,
"could not verify if object exists",
"namespace", metaobj.GetNamespace(), "objectName", metaobj.GetName())
}
currentObjGVK := currentObject.GetObjectKind().GroupVersionKind()
if metaobj.GetDeletionTimestamp() != nil || currentObjGVK.Kind == CustomResourceDefinition || currentObjGVK.Kind == Namespace {
continue
}
desiredObjects := c.inventoryData.DesiredObjects
found := false
for _, desiredObject := range desiredObjects {
desiredObjGVK := desiredObject.GetObjectKind().GroupVersionKind()
desiredObjMeta, _ := meta.Accessor(desiredObject)
if currentObjGVK.Group == desiredObjGVK.Group &&
currentObjGVK.Version == desiredObjGVK.Version &&
currentObjGVK.Kind == desiredObjGVK.Kind &&
metaobj.GetNamespace() == desiredObjMeta.GetNamespace() &&
metaobj.GetName() == desiredObjMeta.GetName() {
found = true
break
}
}
if !found {
c.log.Info("object eligible for delete", "gvk", currentObjGVK.String(), "namespace", metaobj.GetNamespace(), "name", metaobj.GetName())
deleteObjects = append(deleteObjects, currentObject)
}
}
c.inventoryData.ObjectsToDelete = deleteObjects
return nil
}
// sanitizeDesiredObjects cleans up the passed desired objects
func (c *Inventory) sanitizeDesiredObjects(desiredObjects []runtime.Object) error {
for i := range desiredObjects {
objMeta, err := meta.Accessor(desiredObjects[i])
if err != nil {
return errors.WrapIfWithDetails(err, "couldn't get meta data access for object", "gvk", desiredObjects[i].GetObjectKind().GroupVersionKind().String(), "name", objMeta.GetName())
}
isClusterScoped, err := c.IsClusterScoped(desiredObjects[i])
if err != nil {
c.log.Error(err, "scope check failed")
continue
}
if isClusterScoped && objMeta.GetNamespace() != "" {
c.log.V(2).Info("removing namespace field from cluster scoped object", "gvk", desiredObjects[i].GetObjectKind().GroupVersionKind().String(), "name", objMeta.GetName())
objMeta.SetNamespace("")
}
}
return nil
}
// IsClusterScoped returns true of the type if the specified resource is of cluster scope.
// It returns false for namespace scoped resources.
func (c *Inventory) IsClusterScoped(obj runtime.Object) (bool, error) {
gv, k := obj.GetObjectKind().GroupVersionKind().ToAPIVersionAndKind()
gvk := strings.Join([]string{gv, k}, "/")
if c.clusterScopedAPIResources != nil {
_, ok := c.clusterScopedAPIResources[gvk]
return ok, nil
}
actualGK := obj.GetObjectKind().GroupVersionKind().GroupKind()
if namespaced, ok := getStaticResourceScope(actualGK); ok {
return !namespaced, nil
}
var fresh bool
var err error
fresh, err = initializeAPIResources(c.discoveryClient)
if err != nil {
return false, err
}
if namespaced, ok := getDynamicResourceScope(actualGK); ok {
return !namespaced, nil
}
if !fresh {
c.log.Info("API resource not found for object in the cache, updating resource list", "gk", actualGK.String())
if err := discoverAPIResources(c.discoveryClient); err != nil {
return false, err
}
}
if namespaced, ok := getDynamicResourceScope(actualGK); ok {
return !namespaced, nil
}
return false, errors.Errorf("unknown resource %s", actualGK.String())
}
// ensureNamespace sets `namespace` as namespace for namespace scoped objects that have no namespace set
func (c *Inventory) ensureNamespace(namespace string, objects []runtime.Object) error {
for i := range objects {
objMeta, err := meta.Accessor(objects[i])
if err != nil {
return errors.WrapIfWithDetails(err, "couldn't get meta data access for object", "gvk", objects[i].GetObjectKind().GroupVersionKind().String(), "name", objMeta.GetName())
}
isClusterScoped, err := c.IsClusterScoped(objects[i])
if err != nil {
c.log.Error(err, "scope check failed")
continue
}
if !isClusterScoped && objMeta.GetNamespace() == "" {
c.log.V(2).Info("setting namespace field for namespace scoped object", "gvk", objects[i].GetObjectKind().GroupVersionKind().String(), "name", objMeta.GetName())
objMeta.SetNamespace(namespace)
}
}
return nil
}
func (i *Inventory) Append(namespace, component string, parent reconciler.ResourceOwner, resourceBuilders []reconciler.ResourceBuilder) ([]reconciler.ResourceBuilder, error) {
ns := &core.Namespace{}
var err error
// get the namespace so that we can see if it's under deletion
// we don't care if the namespace does not exist, we might be preparing to run this for the first time
if err := i.genericClient.Get(context.TODO(), client.ObjectKey{Name: namespace}, ns); client.IgnoreNotFound(err) != nil {
return resourceBuilders, err
}
if objectInventory, err := i.PrepareDesiredObjects(namespace, component, parent, resourceBuilders); err == nil {
if err := i.PrepareDeletableObjects(); err != nil {
return resourceBuilders, err
}
// do not try to create the inventory when the namespace is being deleted
// or the parent resource is being deleted
// or the objects references are empty
if ns.GetDeletionTimestamp().IsZero() && parent.GetDeletionTimestamp().IsZero() && objectInventory.Data[referencesKey] != "" {
resourceBuilders = append(resourceBuilders, func() (runtime.Object, reconciler.DesiredState, error) {
return objectInventory, reconciler.StatePresent, err
})
}
}
return resourceBuilders, err
}