This repository has been archived by the owner on Apr 25, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 531
/
accessor.go
300 lines (263 loc) · 10 KB
/
accessor.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
/*
Copyright 2019 The Kubernetes 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 sync
import (
"github.com/golang/glog"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
pkgruntime "k8s.io/apimachinery/pkg/runtime"
"k8s.io/client-go/tools/cache"
"github.com/kubernetes-sigs/federation-v2/pkg/apis/core/typeconfig"
fedclientset "github.com/kubernetes-sigs/federation-v2/pkg/client/clientset/versioned"
"github.com/kubernetes-sigs/federation-v2/pkg/controller/sync/version"
"github.com/kubernetes-sigs/federation-v2/pkg/controller/util"
"github.com/kubernetes-sigs/federation-v2/pkg/controller/util/deletionhelper"
)
// FederatedResourceAccessor provides a way to retrieve and visit
// logical federated resources (e.g. FederatedConfigMap)
type FederatedResourceAccessor interface {
Run(stopChan <-chan struct{})
HasSynced() bool
FederatedResource(qualifiedName util.QualifiedName) (FederatedResource, error)
VisitFederatedResources(visitFunc func(obj interface{}))
}
type resourceAccessor struct {
limitedScope bool
typeConfig typeconfig.Interface
targetIsNamespace bool
fedNamespace string
// The informer for the federated type.
federatedStore cache.Store
federatedController cache.Controller
// The informer used to source namespaces for templates of
// federated namespaces. Will only be initialized if
// targetIsNamespace=true.
namespaceStore cache.Store
namespaceController cache.Controller
fedNamespaceAPIResource *metav1.APIResource
// The informer used to source federated namespaces used in
// determining placement for namespaced resources. Will only be
// initialized if the target resource is namespaced.
fedNamespaceStore cache.Store
fedNamespaceController cache.Controller
// Manages propagated versions
versionManager *version.VersionManager
// Adds finalizers to resources and performs cleanup of target resources.
deletionHelper *deletionhelper.DeletionHelper
}
func NewFederatedResourceAccessor(
controllerConfig *util.ControllerConfig,
typeConfig typeconfig.Interface,
fedNamespaceAPIResource *metav1.APIResource,
fedClient fedclientset.Interface,
enqueueObj func(pkgruntime.Object),
informer util.FederatedInformer,
updater util.FederatedUpdater) (FederatedResourceAccessor, error) {
a := &resourceAccessor{
limitedScope: controllerConfig.LimitedScope(),
typeConfig: typeConfig,
targetIsNamespace: typeConfig.GetTarget().Kind == util.NamespaceKind,
fedNamespace: controllerConfig.FederationNamespace,
fedNamespaceAPIResource: fedNamespaceAPIResource,
}
targetNamespace := controllerConfig.TargetNamespace
federatedTypeAPIResource := typeConfig.GetFederatedType()
federatedTypeClient, err := util.NewResourceClient(controllerConfig.KubeConfig, &federatedTypeAPIResource)
if err != nil {
return nil, err
}
a.federatedStore, a.federatedController = util.NewResourceInformer(federatedTypeClient, targetNamespace, enqueueObj)
if a.targetIsNamespace {
// Initialize an informer for namespaces. The namespace
// containing a federated namespace resource is used as the
// template for target resources in member clusters.
namespaceAPIResource := typeConfig.GetTarget()
namespaceTypeClient, err := util.NewResourceClient(controllerConfig.KubeConfig, &namespaceAPIResource)
if err != nil {
return nil, err
}
a.namespaceStore, a.namespaceController = util.NewResourceInformer(namespaceTypeClient, targetNamespace, enqueueObj)
}
if typeConfig.GetNamespaced() {
fedNamespaceEnqueue := func(fedNamespaceObj pkgruntime.Object) {
// When a federated namespace changes, every resource in
// the namespace needs to be reconciled.
//
// TODO(marun) Consider optimizing this to only reconcile
// contained resources in response to a change in
// placement for the federated namespace.
namespace := util.NewQualifiedName(fedNamespaceObj).Namespace
for _, rawObj := range a.federatedStore.List() {
obj := rawObj.(pkgruntime.Object)
qualifiedName := util.NewQualifiedName(obj)
if qualifiedName.Namespace == namespace {
enqueueObj(obj)
}
}
}
// Initialize an informer for federated namespaces. Placement
// for a resource is computed as the intersection of resource
// and federated namespace placement.
fedNamespaceClient, err := util.NewResourceClient(controllerConfig.KubeConfig, fedNamespaceAPIResource)
if err != nil {
return nil, err
}
a.fedNamespaceStore, a.fedNamespaceController = util.NewResourceInformer(fedNamespaceClient, targetNamespace, fedNamespaceEnqueue)
}
a.versionManager = version.NewVersionManager(
fedClient,
typeConfig.GetFederatedNamespaced(),
typeConfig.GetFederatedType().Kind,
typeConfig.GetTarget().Kind,
targetNamespace,
)
a.deletionHelper = deletionhelper.NewDeletionHelper(
func(rawObj pkgruntime.Object) (pkgruntime.Object, error) {
obj := rawObj.(*unstructured.Unstructured)
return federatedTypeClient.Resources(obj.GetNamespace()).Update(obj, metav1.UpdateOptions{})
},
func(obj pkgruntime.Object) string {
return util.NewQualifiedName(obj).String()
},
informer,
updater,
)
return a, nil
}
func (a *resourceAccessor) Run(stopChan <-chan struct{}) {
go a.versionManager.Sync(stopChan)
go a.federatedController.Run(stopChan)
if a.namespaceController != nil {
go a.namespaceController.Run(stopChan)
}
if a.fedNamespaceController != nil {
go a.fedNamespaceController.Run(stopChan)
}
}
func (a *resourceAccessor) HasSynced() bool {
kind := a.typeConfig.GetFederatedType().Kind
if !a.versionManager.HasSynced() {
glog.V(2).Infof("Version manager for %s not synced", kind)
return false
}
if !a.federatedController.HasSynced() {
glog.V(2).Infof("Informer for %s not synced", kind)
return false
}
if a.namespaceController != nil && !a.namespaceController.HasSynced() {
glog.V(2).Infof("Namespace informer for %s not synced", kind)
return false
}
if a.fedNamespaceController != nil && !a.fedNamespaceController.HasSynced() {
glog.V(2).Infof("FederatedNamespace informer for %s not synced", kind)
return false
}
return true
}
func (a *resourceAccessor) FederatedResource(eventSource util.QualifiedName) (FederatedResource, error) {
if a.targetIsNamespace && a.isSystemNamespace(eventSource.Name) {
glog.V(7).Infof("Ignoring system namespace %q", eventSource.Name)
return nil, nil
}
kind := a.typeConfig.GetFederatedType().Kind
// Most federated resources have the same name as their targets.
targetName := eventSource
federatedName := util.QualifiedName{
Namespace: eventSource.Namespace,
Name: eventSource.Name,
}
// A federated type for namespace "foo" is namespaced
// (e.g. "foo/foo"). An event sourced from a namespace in the host
// or member clusters will have the name "foo", and an event
// sourced from a federated resource will have the name "foo/foo".
// In order to ensure object retrieval from the informers, it is
// necessary to derive the target name and federated name from the
// event source.
if a.targetIsNamespace {
eventSourceIsTarget := eventSource.Namespace == ""
if eventSourceIsTarget {
// Ensure the federated name is namespace qualified.
federatedName.Namespace = federatedName.Name
} else {
if federatedName.Namespace != federatedName.Name {
// A FederatedNamespace is only valid for propagation
// if it has the same name as the containing namespace.
return nil, nil
}
// Ensure the target name is not namespace qualified.
targetName.Namespace = ""
}
}
key := federatedName.String()
resource, err := util.ObjFromCache(a.federatedStore, kind, key)
if err != nil {
return nil, err
}
if resource == nil {
// The event source may be a federated resource that was
// deleted, but is more likely a non-federated resource in the
// target cluster.
glog.V(7).Infof("%s %q was not found which indicates that the %s is not federated",
kind, key, a.typeConfig.GetTarget().Kind)
return nil, nil
}
var namespace *unstructured.Unstructured
if a.targetIsNamespace {
namespace, err = util.ObjFromCache(a.namespaceStore, a.typeConfig.GetTarget().Kind, targetName.String())
if err != nil {
return nil, err
}
if namespace == nil {
// The namespace containing the FederatedNamespace was deleted.
return nil, nil
}
}
var fedNamespace *unstructured.Unstructured
if a.typeConfig.GetNamespaced() {
fedNamespaceName := util.QualifiedName{Namespace: targetName.Namespace, Name: targetName.Namespace}
fedNamespace, err = util.ObjFromCache(a.fedNamespaceStore, a.fedNamespaceAPIResource.Kind, fedNamespaceName.String())
if err != nil {
return nil, err
}
// If fedNamespace is nil, the resources in member clusters
// will be removed.
}
return &federatedResource{
limitedScope: a.limitedScope,
typeConfig: a.typeConfig,
targetIsNamespace: a.targetIsNamespace,
targetName: targetName,
federatedKind: kind,
federatedName: federatedName,
federatedResource: resource,
versionManager: a.versionManager,
deletionHelper: a.deletionHelper,
namespace: namespace,
fedNamespace: fedNamespace,
}, nil
}
func (a *resourceAccessor) VisitFederatedResources(visitFunc func(obj interface{})) {
for _, obj := range a.federatedStore.List() {
visitFunc(obj)
}
}
func (a *resourceAccessor) isSystemNamespace(namespace string) bool {
// TODO(font): Need a configurable or discoverable list of namespaces
// to not propagate beyond just the default system namespaces e.g.
switch namespace {
case "kube-system", "kube-public", "default", a.fedNamespace:
return true
default:
return false
}
}