forked from knative/pkg
/
informed_watcher.go
180 lines (152 loc) · 5.62 KB
/
informed_watcher.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
/*
Copyright 2018 The Knative 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 configmap
import (
"errors"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/equality"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
informers "k8s.io/client-go/informers"
corev1informers "k8s.io/client-go/informers/core/v1"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/tools/cache"
)
// NewDefaultWatcher creates a new default configmap.Watcher instance.
//
// Deprecated: Use NewInformedWatcher
func NewDefaultWatcher(kc kubernetes.Interface, namespace string) *InformedWatcher {
return NewInformedWatcher(kc, namespace)
}
// NewInformedWatcherFromFactory watches a Kubernetes namespace for configmap changes.
func NewInformedWatcherFromFactory(sif informers.SharedInformerFactory, namespace string) *InformedWatcher {
return &InformedWatcher{
sif: sif,
informer: sif.Core().V1().ConfigMaps(),
ManualWatcher: ManualWatcher{
Namespace: namespace,
},
defaults: make(map[string]*corev1.ConfigMap),
}
}
// NewInformedWatcher watches a Kubernetes namespace for configmap changes.
func NewInformedWatcher(kc kubernetes.Interface, namespace string) *InformedWatcher {
return NewInformedWatcherFromFactory(informers.NewSharedInformerFactoryWithOptions(
kc,
// We noticed that we're getting updates all the time anyway, due to the
// watches being terminated and re-spawned.
0,
informers.WithNamespace(namespace),
), namespace)
}
// InformedWatcher provides an informer-based implementation of Watcher.
type InformedWatcher struct {
sif informers.SharedInformerFactory
informer corev1informers.ConfigMapInformer
started bool
// defaults are the default ConfigMaps to use if the real ones do not exist or are deleted.
defaults map[string]*corev1.ConfigMap
// Embedding this struct allows us to reuse the logic
// of registering and notifying observers. This simplifies the
// InformedWatcher to just setting up the Kubernetes informer.
ManualWatcher
}
// Asserts that InformedWatcher implements Watcher.
var _ Watcher = (*InformedWatcher)(nil)
// Asserts that InformedWatcher implements DefaultingWatcher.
var _ DefaultingWatcher = (*InformedWatcher)(nil)
// WatchWithDefault implements DefaultingWatcher.
func (i *InformedWatcher) WatchWithDefault(cm corev1.ConfigMap, o ...Observer) {
i.defaults[cm.Name] = &cm
i.m.Lock()
started := i.started
i.m.Unlock()
if started {
// TODO make both Watch and WatchWithDefault work after the InformedWatcher has started.
// This likely entails changing this to `o(&cm)` and having Watch check started, if it has
// started, then ensuring i.informer.Lister().ConfigMaps(i.Namespace).Get(cmName) exists and
// calling this observer on it. It may require changing Watch and WatchWithDefault to return
// an error.
panic("cannot WatchWithDefault after the InformedWatcher has started")
}
i.Watch(cm.Name, o...)
}
// Start implements Watcher.
func (i *InformedWatcher) Start(stopCh <-chan struct{}) error {
// Pretend that all the defaulted ConfigMaps were just created. This is done before we start
// the informer to ensure that if a defaulted ConfigMap does exist, then the real value is
// processed after the default one.
for k := range i.observers {
if def, ok := i.defaults[k]; ok {
i.addConfigMapEvent(def)
}
}
if err := i.registerCallbackAndStartInformer(stopCh); err != nil {
return err
}
// Wait until it has been synced (WITHOUT holing the mutex, so callbacks happen)
if ok := cache.WaitForCacheSync(stopCh, i.informer.Informer().HasSynced); !ok {
return errors.New("error waiting for ConfigMap informer to sync")
}
return i.checkObservedResourcesExist()
}
func (i *InformedWatcher) registerCallbackAndStartInformer(stopCh <-chan struct{}) error {
i.m.Lock()
defer i.m.Unlock()
if i.started {
return errors.New("watcher already started")
}
i.started = true
i.informer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: i.addConfigMapEvent,
UpdateFunc: i.updateConfigMapEvent,
DeleteFunc: i.deleteConfigMapEvent,
})
// Start the shared informer factory (non-blocking).
i.sif.Start(stopCh)
return nil
}
func (i *InformedWatcher) checkObservedResourcesExist() error {
i.m.RLock()
defer i.m.RUnlock()
// Check that all objects with Observers exist in our informers.
for k := range i.observers {
if _, err := i.informer.Lister().ConfigMaps(i.Namespace).Get(k); err != nil {
if _, ok := i.defaults[k]; ok && k8serrors.IsNotFound(err) {
// It is defaulted, so it is OK that it doesn't exist.
continue
}
return err
}
}
return nil
}
func (i *InformedWatcher) addConfigMapEvent(obj interface{}) {
configMap := obj.(*corev1.ConfigMap)
i.OnChange(configMap)
}
func (i *InformedWatcher) updateConfigMapEvent(o, n interface{}) {
// Ignore updates that are idempotent. We are seeing those
// periodically.
if equality.Semantic.DeepEqual(o, n) {
return
}
configMap := n.(*corev1.ConfigMap)
i.OnChange(configMap)
}
func (i *InformedWatcher) deleteConfigMapEvent(obj interface{}) {
configMap := obj.(*corev1.ConfigMap)
if def, ok := i.defaults[configMap.Name]; ok {
i.OnChange(def)
}
// If there is no default value, then don't do anything.
}