pkg/configmap/informed_watcher.go

123 lines
3.4 KiB
Go

/*
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
istributed under the License is istributed 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"
"time"
corev1 "k8s.io/api/core/v1"
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)
}
// NewInformedWatcher watchers a Kubernetes namespace for configmap changs
func NewInformedWatcher(kc kubernetes.Interface, namespace string) *InformedWatcher {
sif := informers.NewSharedInformerFactoryWithOptions(
kc,
5*time.Minute,
informers.WithNamespace(namespace),
)
return &InformedWatcher{
sif: sif,
informer: sif.Core().V1().ConfigMaps(),
ManualWatcher: ManualWatcher{
Namespace: namespace,
},
}
}
// InformedWatcher provides an informer-based implementation of Watcher.
type InformedWatcher struct {
sif informers.SharedInformerFactory
informer corev1informers.ConfigMapInformer
started bool
// 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)
// Start implements Watcher
func (i *InformedWatcher) Start(stopCh <-chan struct{}) error {
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,
})
// Start the shared informer factory (non-blocking)
i.sif.Start(stopCh)
return nil
}
func (i *InformedWatcher) checkObservedResourcesExist() error {
i.m.Lock()
defer i.m.Unlock()
// Check that all objects with Observers exist in our informers.
for k := range i.observers {
_, err := i.informer.Lister().ConfigMaps(i.Namespace).Get(k)
if err != nil {
return err
}
}
return nil
}
func (i *InformedWatcher) addConfigMapEvent(obj interface{}) {
configMap := obj.(*corev1.ConfigMap)
i.OnChange(configMap)
}
func (i *InformedWatcher) updateConfigMapEvent(old, new interface{}) {
configMap := new.(*corev1.ConfigMap)
i.OnChange(configMap)
}