-
Notifications
You must be signed in to change notification settings - Fork 828
/
overridemanager.go
365 lines (316 loc) · 13.7 KB
/
overridemanager.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
/*
Copyright 2021 The Karmada 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 overridemanager
import (
"context"
"encoding/json"
"sort"
jsonpatch "github.com/evanphx/json-patch/v5"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/client-go/tools/record"
"k8s.io/klog/v2"
"sigs.k8s.io/controller-runtime/pkg/client"
clusterv1alpha1 "github.com/karmada-io/karmada/pkg/apis/cluster/v1alpha1"
policyv1alpha1 "github.com/karmada-io/karmada/pkg/apis/policy/v1alpha1"
"github.com/karmada-io/karmada/pkg/events"
"github.com/karmada-io/karmada/pkg/util"
)
const (
// OverrideManagerName is the manager name that will be used when reporting events.
OverrideManagerName = "override-manager"
)
// OverrideManager managers override policies operation
type OverrideManager interface {
// ApplyOverridePolicies overrides the object if one or more override policies exist and matches the target cluster.
// For cluster scoped resource:
// - Apply ClusterOverridePolicy by policies name in ascending
// For namespaced scoped resource, apply order is:
// - First apply ClusterOverridePolicy;
// - Then apply OverridePolicy;
ApplyOverridePolicies(rawObj *unstructured.Unstructured, cluster string) (appliedClusterPolicies *AppliedOverrides, appliedNamespacedPolicies *AppliedOverrides, err error)
}
// GeneralOverridePolicy is an abstract object of ClusterOverridePolicy and OverridePolicy
type GeneralOverridePolicy interface {
// GetName returns the name of OverridePolicy
GetName() string
// GetNamespace returns the namespace of OverridePolicy
GetNamespace() string
// GetOverrideSpec returns the OverrideSpec of OverridePolicy
GetOverrideSpec() policyv1alpha1.OverrideSpec
}
// overrideOption define the JSONPatch operator
type overrideOption struct {
Op string `json:"op"`
Path string `json:"path"`
Value interface{} `json:"value,omitempty"`
}
type policyOverriders struct {
name string
namespace string
overriders policyv1alpha1.Overriders
}
type overrideManagerImpl struct {
client.Client
record.EventRecorder
}
// New builds an OverrideManager instance.
func New(client client.Client, eventRecorder record.EventRecorder) OverrideManager {
return &overrideManagerImpl{
Client: client,
EventRecorder: eventRecorder,
}
}
func (o *overrideManagerImpl) ApplyOverridePolicies(rawObj *unstructured.Unstructured, clusterName string) (*AppliedOverrides, *AppliedOverrides, error) {
clusterObj := &clusterv1alpha1.Cluster{}
if err := o.Client.Get(context.TODO(), client.ObjectKey{Name: clusterName}, clusterObj); err != nil {
klog.Errorf("Failed to get member cluster: %s, error: %v", clusterName, err)
return nil, nil, err
}
var appliedClusterOverrides *AppliedOverrides
var appliedNamespacedOverrides *AppliedOverrides
var err error
// Apply cluster scoped override policies
appliedClusterOverrides, err = o.applyClusterOverrides(rawObj, clusterObj)
if err != nil {
klog.Errorf("Failed to apply cluster override policies. error: %v", err)
return nil, nil, err
}
// For namespace scoped resources, should apply override policies under the same namespace.
// No matter the resources propagated by ClusterPropagationPolicy or PropagationPolicy.
if len(rawObj.GetNamespace()) > 0 {
// Apply namespace scoped override policies
appliedNamespacedOverrides, err = o.applyNamespacedOverrides(rawObj, clusterObj)
if err != nil {
klog.Errorf("Failed to apply namespaced override policies. error: %v", err)
return nil, nil, err
}
}
return appliedClusterOverrides, appliedNamespacedOverrides, nil
}
// applyClusterOverrides will apply overrides according to ClusterOverridePolicy instructions.
func (o *overrideManagerImpl) applyClusterOverrides(rawObj *unstructured.Unstructured, cluster *clusterv1alpha1.Cluster) (*AppliedOverrides, error) {
// get all cluster-scoped override policies
policyList := &policyv1alpha1.ClusterOverridePolicyList{}
if err := o.Client.List(context.TODO(), policyList, &client.ListOptions{}); err != nil {
klog.Errorf("Failed to list cluster override policies, error: %v", err)
return nil, err
}
if len(policyList.Items) == 0 {
return nil, nil
}
items := make([]GeneralOverridePolicy, 0, len(policyList.Items))
for i := range policyList.Items {
items = append(items, &policyList.Items[i])
}
matchingPolicyOverriders := o.getOverridersFromOverridePolicies(items, rawObj, cluster)
if len(matchingPolicyOverriders) == 0 {
klog.V(2).Infof("No cluster override policy for resource: %s/%s", rawObj.GetNamespace(), rawObj.GetName())
return nil, nil
}
appliedList := &AppliedOverrides{}
for _, p := range matchingPolicyOverriders {
if err := applyPolicyOverriders(rawObj, p.overriders); err != nil {
klog.Errorf("Failed to apply cluster overrides(%s) for resource(%s/%s), error: %v", p.name, rawObj.GetNamespace(), rawObj.GetName(), err)
o.EventRecorder.Eventf(rawObj, corev1.EventTypeWarning, events.EventReasonApplyOverridePolicyFailed, "Apply cluster override policy(%s) for cluster(%s) failed.", p.name, cluster.Name)
return nil, err
}
klog.V(2).Infof("Applied cluster overrides(%s) for resource(%s/%s)", p.name, rawObj.GetNamespace(), rawObj.GetName())
o.EventRecorder.Eventf(rawObj, corev1.EventTypeNormal, events.EventReasonApplyOverridePolicySucceed, "Apply cluster override policy(%s) for cluster(%s) succeed.", p.name, cluster.Name)
appliedList.Add(p.name, p.overriders)
}
return appliedList, nil
}
// applyNamespacedOverrides will apply overrides according to OverridePolicy instructions.
func (o *overrideManagerImpl) applyNamespacedOverrides(rawObj *unstructured.Unstructured, cluster *clusterv1alpha1.Cluster) (*AppliedOverrides, error) {
// get all namespace-scoped override policies
policyList := &policyv1alpha1.OverridePolicyList{}
if err := o.Client.List(context.TODO(), policyList, &client.ListOptions{Namespace: rawObj.GetNamespace()}); err != nil {
klog.Errorf("Failed to list override policies from namespace: %s, error: %v", rawObj.GetNamespace(), err)
return nil, err
}
if len(policyList.Items) == 0 {
return nil, nil
}
items := make([]GeneralOverridePolicy, 0, len(policyList.Items))
for i := range policyList.Items {
items = append(items, &policyList.Items[i])
}
matchingPolicyOverriders := o.getOverridersFromOverridePolicies(items, rawObj, cluster)
if len(matchingPolicyOverriders) == 0 {
klog.V(2).Infof("No override policy for resource(%s/%s)", rawObj.GetNamespace(), rawObj.GetName())
return nil, nil
}
appliedList := &AppliedOverrides{}
for _, p := range matchingPolicyOverriders {
if err := applyPolicyOverriders(rawObj, p.overriders); err != nil {
klog.Errorf("Failed to apply overrides(%s/%s) for resource(%s/%s), error: %v", p.namespace, p.name, rawObj.GetNamespace(), rawObj.GetName(), err)
o.EventRecorder.Eventf(rawObj, corev1.EventTypeWarning, events.EventReasonApplyOverridePolicyFailed, "Apply override policy(%s/%s) for cluster(%s) failed.", p.namespace, p.name, cluster.Name)
return nil, err
}
klog.V(2).Infof("Applied overrides(%s/%s) for resource(%s/%s)", p.namespace, p.name, rawObj.GetNamespace(), rawObj.GetName())
o.EventRecorder.Eventf(rawObj, corev1.EventTypeNormal, events.EventReasonApplyOverridePolicySucceed, "Apply override policy(%s/%s) for cluster(%s) succeed.", p.namespace, p.name, cluster.Name)
appliedList.Add(p.name, p.overriders)
}
return appliedList, nil
}
func (o *overrideManagerImpl) getOverridersFromOverridePolicies(policies []GeneralOverridePolicy, resource *unstructured.Unstructured, cluster *clusterv1alpha1.Cluster) []policyOverriders {
resourceMatchingPolicies := make([]GeneralOverridePolicy, 0)
for _, policy := range policies {
if len(policy.GetOverrideSpec().ResourceSelectors) == 0 {
resourceMatchingPolicies = append(resourceMatchingPolicies, policy)
continue
}
if util.ResourceMatchSelectors(resource, policy.GetOverrideSpec().ResourceSelectors...) {
resourceMatchingPolicies = append(resourceMatchingPolicies, policy)
}
}
sort.SliceStable(resourceMatchingPolicies, func(i, j int) bool {
implicitPriorityI := util.ResourceMatchSelectorsPriority(resource, resourceMatchingPolicies[i].GetOverrideSpec().ResourceSelectors...)
if len(resourceMatchingPolicies[i].GetOverrideSpec().ResourceSelectors) == 0 {
implicitPriorityI = util.PriorityMatchAll
}
implicitPriorityJ := util.ResourceMatchSelectorsPriority(resource, resourceMatchingPolicies[j].GetOverrideSpec().ResourceSelectors...)
if len(resourceMatchingPolicies[j].GetOverrideSpec().ResourceSelectors) == 0 {
implicitPriorityJ = util.PriorityMatchAll
}
if implicitPriorityI != implicitPriorityJ {
return implicitPriorityI < implicitPriorityJ
}
return resourceMatchingPolicies[i].GetName() < resourceMatchingPolicies[j].GetName()
})
clusterMatchingPolicyOverriders := make([]policyOverriders, 0)
for _, policy := range resourceMatchingPolicies {
overrideRules := policy.GetOverrideSpec().OverrideRules
// Since the tuple of '.spec.TargetCluster' and '.spec.Overriders' can not co-exist with '.spec.OverrideRules'
// (guaranteed by webhook), so we only look '.spec.OverrideRules' here.
if len(overrideRules) == 0 {
overrideRules = []policyv1alpha1.RuleWithCluster{
{
//nolint:staticcheck
// disable `deprecation` check for backward compatibility.
TargetCluster: policy.GetOverrideSpec().TargetCluster,
//nolint:staticcheck
// disable `deprecation` check for backward compatibility.
Overriders: policy.GetOverrideSpec().Overriders,
},
}
}
for _, rule := range overrideRules {
if rule.TargetCluster == nil || (rule.TargetCluster != nil && util.ClusterMatches(cluster, *rule.TargetCluster)) {
clusterMatchingPolicyOverriders = append(clusterMatchingPolicyOverriders, policyOverriders{
name: policy.GetName(),
namespace: policy.GetNamespace(),
overriders: rule.Overriders,
})
}
}
}
// select policy in which at least one PlaintextOverrider matches target resource.
// TODO(RainbowMango): check if the overrider instructions can be applied to target resource.
return clusterMatchingPolicyOverriders
}
// applyJSONPatch applies the override on to the given unstructured object.
func applyJSONPatch(obj *unstructured.Unstructured, overrides []overrideOption) error {
jsonPatchBytes, err := json.Marshal(overrides)
if err != nil {
return err
}
patch, err := jsonpatch.DecodePatch(jsonPatchBytes)
if err != nil {
return err
}
objectJSONBytes, err := obj.MarshalJSON()
if err != nil {
return err
}
patchedObjectJSONBytes, err := patch.Apply(objectJSONBytes)
if err != nil {
return err
}
err = obj.UnmarshalJSON(patchedObjectJSONBytes)
return err
}
// applyPolicyOverriders applies OverridePolicy/ClusterOverridePolicy overriders to target object
func applyPolicyOverriders(rawObj *unstructured.Unstructured, overriders policyv1alpha1.Overriders) error {
err := applyImageOverriders(rawObj, overriders.ImageOverrider)
if err != nil {
return err
}
// patch command
if err := applyCommandOverriders(rawObj, overriders.CommandOverrider); err != nil {
return err
}
// patch args
if err := applyArgsOverriders(rawObj, overriders.ArgsOverrider); err != nil {
return err
}
if err := applyLabelsOverriders(rawObj, overriders.LabelsOverrider); err != nil {
return err
}
if err := applyAnnotationsOverriders(rawObj, overriders.AnnotationsOverrider); err != nil {
return err
}
return applyJSONPatch(rawObj, parseJSONPatchesByPlaintext(overriders.Plaintext))
}
func applyImageOverriders(rawObj *unstructured.Unstructured, imageOverriders []policyv1alpha1.ImageOverrider) error {
for index := range imageOverriders {
patches, err := buildPatches(rawObj, &imageOverriders[index])
if err != nil {
klog.Errorf("Build patches with imageOverrides err: %v", err)
return err
}
klog.V(4).Infof("Parsed JSON patches by imageOverriders(%+v): %+v", imageOverriders[index], patches)
if err = applyJSONPatch(rawObj, patches); err != nil {
return err
}
}
return nil
}
func applyCommandOverriders(rawObj *unstructured.Unstructured, commandOverriders []policyv1alpha1.CommandArgsOverrider) error {
for index := range commandOverriders {
patches, err := buildCommandArgsPatches(CommandString, rawObj, &commandOverriders[index])
if err != nil {
return err
}
klog.V(4).Infof("Parsed JSON patches by commandOverriders(%+v): %+v", commandOverriders[index], patches)
if err = applyJSONPatch(rawObj, patches); err != nil {
return err
}
}
return nil
}
func applyArgsOverriders(rawObj *unstructured.Unstructured, argsOverriders []policyv1alpha1.CommandArgsOverrider) error {
for index := range argsOverriders {
patches, err := buildCommandArgsPatches(ArgsString, rawObj, &argsOverriders[index])
if err != nil {
return err
}
klog.V(4).Infof("Parsed JSON patches by argsOverriders(%+v): %+v", argsOverriders[index], patches)
if err = applyJSONPatch(rawObj, patches); err != nil {
return err
}
}
return nil
}
func parseJSONPatchesByPlaintext(overriders []policyv1alpha1.PlaintextOverrider) []overrideOption {
patches := make([]overrideOption, 0, len(overriders))
for i := range overriders {
patches = append(patches, overrideOption{
Op: string(overriders[i].Operator),
Path: overriders[i].Path,
Value: overriders[i].Value,
})
}
return patches
}