-
Notifications
You must be signed in to change notification settings - Fork 55
/
bindingpolicy-resolution.go
254 lines (207 loc) · 9.01 KB
/
bindingpolicy-resolution.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
/*
Copyright 2023 The KubeStellar 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 binding
import (
"sync"
"golang.org/x/exp/slices"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/client-go/tools/cache"
"github.com/kubestellar/kubestellar/api/control/v1alpha1"
"github.com/kubestellar/kubestellar/pkg/util"
)
// bindingPolicyResolution stores the selected object identifiers and
// destinations for a single bindingpolicy. The mutex should be read locked
// before reading, and write locked before writing to any field.
type bindingPolicyResolution struct {
sync.RWMutex
objectIdentifierToResourceVersion map[util.ObjectIdentifier]string
destinations sets.Set[string]
// ownerReference identifies the bindingpolicy that this resolution is
// associated with as an owning object.
ownerReference *metav1.OwnerReference
// requiresSingletonReportedState indicates whether the bindingpolicy
// that this resolution is associated with requires singleton status.
requiresSingletonReportedState bool
}
// ensureObjectIdentifierWithVersion ensures that an object identifier exists
// in the resolution and is associated with the given resource version.
// The returned bool indicates whether the resolution was changed.
// This function is thread-safe.
func (resolution *bindingPolicyResolution) ensureObjectIdentifierWithVersion(objIdentifier util.ObjectIdentifier,
resourceVersion string) bool {
resolution.Lock()
defer resolution.Unlock()
currentResourceVersion := resolution.objectIdentifierToResourceVersion[objIdentifier]
if currentResourceVersion == resourceVersion {
return false
}
resolution.objectIdentifierToResourceVersion[objIdentifier] = resourceVersion
return true
}
// removeObjectIdentifier removes an object identifier from the resolution if it
// exists. The return bool indicates whether the resolution was changed.
// This function is thread-safe.
func (resolution *bindingPolicyResolution) removeObjectIdentifier(objIdentifier util.ObjectIdentifier) bool {
resolution.Lock()
defer resolution.Unlock()
if _, exists := resolution.objectIdentifierToResourceVersion[objIdentifier]; !exists {
return false
}
delete(resolution.objectIdentifierToResourceVersion, objIdentifier)
return true
}
// setDestinations updates the destinations list in the resolution.
// The given destinations set is expected not to be mutated after this call.
func (resolution *bindingPolicyResolution) setDestinations(destinations sets.Set[string]) {
resolution.Lock()
defer resolution.Unlock()
resolution.destinations = destinations
}
// getObjectIdentifiers returns a copy of the object identifiers in the resolution.
func (resolution *bindingPolicyResolution) getObjectIdentifiers() sets.Set[util.ObjectIdentifier] {
resolution.RLock()
defer resolution.RUnlock()
return sets.KeySet(resolution.objectIdentifierToResourceVersion)
}
// toBindingSpec converts the resolution to a binding
// spec. This function is thread-safe.
func (resolution *bindingPolicyResolution) toBindingSpec() *v1alpha1.BindingSpec {
resolution.RLock()
defer resolution.RUnlock()
workload := v1alpha1.DownsyncObjectReferences{}
// iterate over all objects and build workload efficiently. No (GVR, namespace, name) tuple is
// duplicated in the objectIdentifierToResourceVersion map, due to the uniqueness of the identifiers.
// Therefore, whenever an object is about to be appended, we simply append.
for objIdentifier, objResourceVersion := range resolution.objectIdentifierToResourceVersion {
// check if object is cluster-scoped or namespaced by checking namespace
if objIdentifier.ObjectName.Namespace == metav1.NamespaceNone {
workload.ClusterScope = append(workload.ClusterScope, v1alpha1.ClusterScopeDownsyncObject{
GroupVersionResource: metav1.GroupVersionResource(objIdentifier.GVR()),
Name: objIdentifier.ObjectName.Name,
ResourceVersion: objResourceVersion,
})
continue
}
workload.NamespaceScope = append(workload.NamespaceScope, v1alpha1.NamespaceScopeDownsyncObject{
GroupVersionResource: metav1.GroupVersionResource(objIdentifier.GVR()),
Name: objIdentifier.ObjectName.Name,
Namespace: objIdentifier.ObjectName.Namespace,
ResourceVersion: objResourceVersion,
})
}
// sort workload objects
sortBindingWorkloadObjects(&workload)
return &v1alpha1.BindingSpec{
Workload: workload,
Destinations: destinationsStringSetToSortedDestinations(resolution.destinations),
}
}
func (resolution *bindingPolicyResolution) matchesBindingSpec(bindingSpec *v1alpha1.BindingSpec) bool {
resolution.RLock()
defer resolution.RUnlock()
// check destinations
if !destinationsMatch(resolution.destinations, bindingSpec.Destinations) {
return false
}
// check workload
if len(resolution.objectIdentifierToResourceVersion) != len(bindingSpec.Workload.ClusterScope)+
len(bindingSpec.Workload.NamespaceScope) {
return false
}
objectRefSetFromWorkload := bindingObjectRefAndVersionSetFromWorkload(&bindingSpec.Workload)
for objIdentifier, objResourceVersion := range resolution.objectIdentifierToResourceVersion {
if !objectRefSetFromWorkload.Has(objectRefAndVersion{
GroupVersionResource: objIdentifier.GVR(),
ObjectName: objIdentifier.ObjectName,
ResourceVersion: objResourceVersion,
}) {
return false
}
} // this check works because both groups have unique members and are of equal size
return true
}
// destinationsMatch returns true if the destinations in the resolution
// match the destinations in the binding spec.
func destinationsMatch(resolvedDestinations sets.Set[string], bindingDestinations []v1alpha1.Destination) bool {
if len(resolvedDestinations) != len(bindingDestinations) {
return false
}
for _, destination := range bindingDestinations {
if !resolvedDestinations.Has(destination.ClusterId) {
return false
}
}
return true
}
type objectRefAndVersion struct {
schema.GroupVersionResource
cache.ObjectName
ResourceVersion string
}
func bindingObjectRefAndVersionSetFromWorkload(bindingSpecWorkload *v1alpha1.DownsyncObjectReferences) sets.Set[objectRefAndVersion] {
bindingObjectRefAndVersionSet := sets.New[objectRefAndVersion]()
for _, clusterScopeDownsyncObject := range bindingSpecWorkload.ClusterScope {
bindingObjectRefAndVersionSet.Insert(objectRefAndVersion{
GroupVersionResource: schema.GroupVersionResource(clusterScopeDownsyncObject.GroupVersionResource),
ObjectName: cache.ObjectName{
Name: clusterScopeDownsyncObject.Name,
Namespace: metav1.NamespaceNone,
},
ResourceVersion: clusterScopeDownsyncObject.ResourceVersion,
})
}
for _, namespacedScopeDownsyncObject := range bindingSpecWorkload.NamespaceScope {
bindingObjectRefAndVersionSet.Insert(objectRefAndVersion{
GroupVersionResource: schema.GroupVersionResource(namespacedScopeDownsyncObject.GroupVersionResource),
ObjectName: cache.ObjectName{
Name: namespacedScopeDownsyncObject.Name,
Namespace: namespacedScopeDownsyncObject.Namespace,
},
ResourceVersion: namespacedScopeDownsyncObject.ResourceVersion,
})
}
return bindingObjectRefAndVersionSet
}
func destinationsStringSetToSortedDestinations(destinationsStringSet sets.Set[string]) []v1alpha1.Destination {
sortedDestinations := make([]v1alpha1.Destination, 0, len(destinationsStringSet))
for _, d := range sets.List(destinationsStringSet) {
sortedDestinations = append(sortedDestinations, v1alpha1.Destination{ClusterId: d})
}
return sortedDestinations
}
func sortBindingWorkloadObjects(bindingWorkload *v1alpha1.DownsyncObjectReferences) {
// sort clusterScopeDownsyncObjects
slices.SortFunc(bindingWorkload.ClusterScope, func(a, b v1alpha1.ClusterScopeDownsyncObject) bool {
if a.GroupVersionResource.String() != b.GroupVersionResource.String() {
return a.GroupVersionResource.String() < b.GroupVersionResource.String()
}
if a.Name != b.Name {
return a.Name < b.Name
}
return a.ResourceVersion < b.ResourceVersion
})
// sort namespaceScopeDownsyncObjects
slices.SortFunc(bindingWorkload.NamespaceScope, func(a, b v1alpha1.NamespaceScopeDownsyncObject) bool {
if a.GroupVersionResource.String() != b.GroupVersionResource.String() {
return a.GroupVersionResource.String() < b.GroupVersionResource.String()
}
objectNameA := cache.NewObjectName(a.Namespace, a.Name).String()
objectNameB := cache.NewObjectName(b.Namespace, b.Name).String()
if objectNameA != objectNameB {
return objectNameA < objectNameB
}
return a.ResourceVersion < b.ResourceVersion
})
}