use shared informers for BootstrapSigner controller

pull/6/head
wackxu 2017-11-14 21:43:20 +08:00
parent fe5b8fac86
commit 0ae647bf33
4 changed files with 114 additions and 81 deletions

View File

@ -25,6 +25,8 @@ import (
func startBootstrapSignerController(ctx ControllerContext) (bool, error) { func startBootstrapSignerController(ctx ControllerContext) (bool, error) {
bsc, err := bootstrap.NewBootstrapSigner( bsc, err := bootstrap.NewBootstrapSigner(
ctx.ClientBuilder.ClientGoClientOrDie("bootstrap-signer"), ctx.ClientBuilder.ClientGoClientOrDie("bootstrap-signer"),
ctx.InformerFactory.Core().V1().Secrets(),
ctx.InformerFactory.Core().V1().ConfigMaps(),
bootstrap.DefaultBootstrapSignerOptions(), bootstrap.DefaultBootstrapSignerOptions(),
) )
if err != nil { if err != nil {

View File

@ -21,11 +21,14 @@ go_test(
"//pkg/apis/core:go_default_library", "//pkg/apis/core:go_default_library",
"//pkg/apis/core/helper:go_default_library", "//pkg/apis/core/helper:go_default_library",
"//pkg/bootstrap/api:go_default_library", "//pkg/bootstrap/api:go_default_library",
"//pkg/controller:go_default_library",
"//vendor/github.com/davecgh/go-spew/spew:go_default_library", "//vendor/github.com/davecgh/go-spew/spew:go_default_library",
"//vendor/github.com/stretchr/testify/assert:go_default_library", "//vendor/github.com/stretchr/testify/assert:go_default_library",
"//vendor/k8s.io/api/core/v1:go_default_library", "//vendor/k8s.io/api/core/v1:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/apis/meta/v1:go_default_library", "//vendor/k8s.io/apimachinery/pkg/apis/meta/v1:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/runtime/schema:go_default_library", "//vendor/k8s.io/apimachinery/pkg/runtime/schema:go_default_library",
"//vendor/k8s.io/client-go/informers:go_default_library",
"//vendor/k8s.io/client-go/informers/core/v1:go_default_library",
"//vendor/k8s.io/client-go/kubernetes/fake:go_default_library", "//vendor/k8s.io/client-go/kubernetes/fake:go_default_library",
"//vendor/k8s.io/client-go/testing:go_default_library", "//vendor/k8s.io/client-go/testing:go_default_library",
], ],
@ -44,6 +47,7 @@ go_library(
deps = [ deps = [
"//pkg/apis/core:go_default_library", "//pkg/apis/core:go_default_library",
"//pkg/bootstrap/api:go_default_library", "//pkg/bootstrap/api:go_default_library",
"//pkg/controller:go_default_library",
"//pkg/util/metrics:go_default_library", "//pkg/util/metrics:go_default_library",
"//vendor/github.com/golang/glog:go_default_library", "//vendor/github.com/golang/glog:go_default_library",
"//vendor/github.com/square/go-jose:go_default_library", "//vendor/github.com/square/go-jose:go_default_library",
@ -51,11 +55,14 @@ go_library(
"//vendor/k8s.io/apimachinery/pkg/api/errors:go_default_library", "//vendor/k8s.io/apimachinery/pkg/api/errors:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/apis/meta/v1:go_default_library", "//vendor/k8s.io/apimachinery/pkg/apis/meta/v1:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/fields:go_default_library", "//vendor/k8s.io/apimachinery/pkg/fields:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/labels:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/runtime:go_default_library", "//vendor/k8s.io/apimachinery/pkg/runtime:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/util/runtime:go_default_library", "//vendor/k8s.io/apimachinery/pkg/util/runtime:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/util/wait:go_default_library", "//vendor/k8s.io/apimachinery/pkg/util/wait:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/watch:go_default_library", "//vendor/k8s.io/apimachinery/pkg/watch:go_default_library",
"//vendor/k8s.io/client-go/informers/core/v1:go_default_library",
"//vendor/k8s.io/client-go/kubernetes:go_default_library", "//vendor/k8s.io/client-go/kubernetes:go_default_library",
"//vendor/k8s.io/client-go/listers/core/v1:go_default_library",
"//vendor/k8s.io/client-go/tools/cache:go_default_library", "//vendor/k8s.io/client-go/tools/cache:go_default_library",
"//vendor/k8s.io/client-go/util/workqueue:go_default_library", "//vendor/k8s.io/client-go/util/workqueue:go_default_library",
], ],

View File

@ -22,25 +22,25 @@ import (
"github.com/golang/glog" "github.com/golang/glog"
"fmt"
"k8s.io/api/core/v1" "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors" apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/fields"
"k8s.io/apimachinery/pkg/runtime"
utilruntime "k8s.io/apimachinery/pkg/util/runtime" utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/util/wait" "k8s.io/apimachinery/pkg/util/wait"
"k8s.io/apimachinery/pkg/watch" informers "k8s.io/client-go/informers/core/v1"
clientset "k8s.io/client-go/kubernetes" clientset "k8s.io/client-go/kubernetes"
corelisters "k8s.io/client-go/listers/core/v1"
"k8s.io/client-go/tools/cache" "k8s.io/client-go/tools/cache"
"k8s.io/client-go/util/workqueue" "k8s.io/client-go/util/workqueue"
api "k8s.io/kubernetes/pkg/apis/core" api "k8s.io/kubernetes/pkg/apis/core"
bootstrapapi "k8s.io/kubernetes/pkg/bootstrap/api" bootstrapapi "k8s.io/kubernetes/pkg/bootstrap/api"
"k8s.io/kubernetes/pkg/controller"
"k8s.io/kubernetes/pkg/util/metrics" "k8s.io/kubernetes/pkg/util/metrics"
) )
// BootstrapSignerOptions contains options for the BootstrapSigner // BootstrapSignerOptions contains options for the BootstrapSigner
type BootstrapSignerOptions struct { type BootstrapSignerOptions struct {
// ConfigMapNamespace is the namespace of the ConfigMap // ConfigMapNamespace is the namespace of the ConfigMap
ConfigMapNamespace string ConfigMapNamespace string
@ -71,88 +71,101 @@ func DefaultBootstrapSignerOptions() BootstrapSignerOptions {
// BootstrapSigner is a controller that signs a ConfigMap with a set of tokens. // BootstrapSigner is a controller that signs a ConfigMap with a set of tokens.
type BootstrapSigner struct { type BootstrapSigner struct {
client clientset.Interface client clientset.Interface
configMapKey string configMapKey string
secretNamespace string configMapName string
configMapNamespace string
configMaps cache.Store secretNamespace string
secrets cache.Store
// syncQueue handles synchronizing updates to the ConfigMap. We'll only ever // syncQueue handles synchronizing updates to the ConfigMap. We'll only ever
// have one item (Named <ConfigMapName>) in this queue. We are using it // have one item (Named <ConfigMapName>) in this queue. We are using it
// serializes and collapses updates as they can come from both the ConfigMap // serializes and collapses updates as they can come from both the ConfigMap
// and Secrets controllers. // and Secrets controllers.
syncQueue workqueue.Interface syncQueue workqueue.RateLimitingInterface
// Since we join two objects, we'll watch both of them with controllers. secretLister corelisters.SecretLister
configMapsController cache.Controller secretSynced cache.InformerSynced
secretsController cache.Controller
configMapLister corelisters.ConfigMapLister
configMapSynced cache.InformerSynced
} }
// NewBootstrapSigner returns a new *BootstrapSigner. // NewBootstrapSigner returns a new *BootstrapSigner.
// func NewBootstrapSigner(cl clientset.Interface, secrets informers.SecretInformer, configMaps informers.ConfigMapInformer, options BootstrapSignerOptions) (*BootstrapSigner, error) {
// TODO: Switch to shared informers
func NewBootstrapSigner(cl clientset.Interface, options BootstrapSignerOptions) (*BootstrapSigner, error) {
e := &BootstrapSigner{ e := &BootstrapSigner{
client: cl, client: cl,
configMapKey: options.ConfigMapNamespace + "/" + options.ConfigMapName, configMapKey: options.ConfigMapNamespace + "/" + options.ConfigMapName,
secretNamespace: options.TokenSecretNamespace, configMapName: options.ConfigMapName,
syncQueue: workqueue.NewNamed("bootstrap_signer_queue"), configMapNamespace: options.ConfigMapNamespace,
secretNamespace: options.TokenSecretNamespace,
secretLister: secrets.Lister(),
secretSynced: secrets.Informer().HasSynced,
configMapLister: configMaps.Lister(),
configMapSynced: configMaps.Informer().HasSynced,
syncQueue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "bootstrap_signer_queue"),
} }
if cl.CoreV1().RESTClient().GetRateLimiter() != nil { if cl.CoreV1().RESTClient().GetRateLimiter() != nil {
if err := metrics.RegisterMetricAndTrackRateLimiterUsage("bootstrap_signer", cl.CoreV1().RESTClient().GetRateLimiter()); err != nil { if err := metrics.RegisterMetricAndTrackRateLimiterUsage("bootstrap_signer", cl.CoreV1().RESTClient().GetRateLimiter()); err != nil {
return nil, err return nil, err
} }
} }
configMapSelector := fields.SelectorFromSet(map[string]string{api.ObjectNameField: options.ConfigMapName})
e.configMaps, e.configMapsController = cache.NewInformer( configMaps.Informer().AddEventHandlerWithResyncPeriod(
&cache.ListWatch{ cache.FilteringResourceEventHandler{
ListFunc: func(lo metav1.ListOptions) (runtime.Object, error) { FilterFunc: func(obj interface{}) bool {
lo.FieldSelector = configMapSelector.String() switch t := obj.(type) {
return e.client.CoreV1().ConfigMaps(options.ConfigMapNamespace).List(lo) case *v1.ConfigMap:
return t.Name == options.ConfigMapName && t.Namespace == options.ConfigMapNamespace
default:
utilruntime.HandleError(fmt.Errorf("object passed to %T that is not expected: %T", e, obj))
return false
}
}, },
WatchFunc: func(lo metav1.ListOptions) (watch.Interface, error) { Handler: cache.ResourceEventHandlerFuncs{
lo.FieldSelector = configMapSelector.String() AddFunc: func(_ interface{}) { e.pokeConfigMapSync() },
return e.client.CoreV1().ConfigMaps(options.ConfigMapNamespace).Watch(lo) UpdateFunc: func(_, _ interface{}) { e.pokeConfigMapSync() },
}, },
}, },
&v1.ConfigMap{},
options.ConfigMapResync, options.ConfigMapResync,
cache.ResourceEventHandlerFuncs{
AddFunc: func(_ interface{}) { e.pokeConfigMapSync() },
UpdateFunc: func(_, _ interface{}) { e.pokeConfigMapSync() },
},
) )
secretSelector := fields.SelectorFromSet(map[string]string{api.SecretTypeField: string(bootstrapapi.SecretTypeBootstrapToken)}) secrets.Informer().AddEventHandlerWithResyncPeriod(
e.secrets, e.secretsController = cache.NewInformer( cache.FilteringResourceEventHandler{
&cache.ListWatch{ FilterFunc: func(obj interface{}) bool {
ListFunc: func(lo metav1.ListOptions) (runtime.Object, error) { switch t := obj.(type) {
lo.FieldSelector = secretSelector.String() case *v1.Secret:
return e.client.CoreV1().Secrets(e.secretNamespace).List(lo) return t.Type == bootstrapapi.SecretTypeBootstrapToken && t.Namespace == e.secretNamespace
default:
utilruntime.HandleError(fmt.Errorf("object passed to %T that is not expected: %T", e, obj))
return false
}
}, },
WatchFunc: func(lo metav1.ListOptions) (watch.Interface, error) { Handler: cache.ResourceEventHandlerFuncs{
lo.FieldSelector = secretSelector.String() AddFunc: func(_ interface{}) { e.pokeConfigMapSync() },
return e.client.CoreV1().Secrets(e.secretNamespace).Watch(lo) UpdateFunc: func(_, _ interface{}) { e.pokeConfigMapSync() },
DeleteFunc: func(_ interface{}) { e.pokeConfigMapSync() },
}, },
}, },
&v1.Secret{},
options.SecretResync, options.SecretResync,
cache.ResourceEventHandlerFuncs{
AddFunc: func(_ interface{}) { e.pokeConfigMapSync() },
UpdateFunc: func(_, _ interface{}) { e.pokeConfigMapSync() },
DeleteFunc: func(_ interface{}) { e.pokeConfigMapSync() },
},
) )
return e, nil return e, nil
} }
// Run runs controller loops and returns when they are done // Run runs controller loops and returns when they are done
func (e *BootstrapSigner) Run(stopCh <-chan struct{}) { func (e *BootstrapSigner) Run(stopCh <-chan struct{}) {
go e.configMapsController.Run(stopCh) // Shut down queues
go e.secretsController.Run(stopCh) defer utilruntime.HandleCrash()
defer e.syncQueue.ShutDown()
if !controller.WaitForCacheSync("bootstrap_signer", stopCh, e.configMapSynced, e.secretSynced) {
return
}
glog.V(5).Infof("Starting workers")
go wait.Until(e.serviceConfigMapQueue, 0, stopCh) go wait.Until(e.serviceConfigMapQueue, 0, stopCh)
<-stopCh <-stopCh
glog.V(1).Infof("Shutting down")
} }
func (e *BootstrapSigner) pokeConfigMapSync() { func (e *BootstrapSigner) pokeConfigMapSync() {
@ -237,27 +250,32 @@ func (e *BootstrapSigner) updateConfigMap(cm *v1.ConfigMap) {
// getConfigMap gets the ConfigMap we are interested in // getConfigMap gets the ConfigMap we are interested in
func (e *BootstrapSigner) getConfigMap() *v1.ConfigMap { func (e *BootstrapSigner) getConfigMap() *v1.ConfigMap {
configMap, exists, err := e.configMaps.GetByKey(e.configMapKey) configMap, err := e.configMapLister.ConfigMaps(e.configMapNamespace).Get(e.configMapName)
// If we can't get the configmap just return nil. The resync will eventually // If we can't get the configmap just return nil. The resync will eventually
// sync things up. // sync things up.
if err != nil {
if !apierrors.IsNotFound(err) {
utilruntime.HandleError(err)
}
return nil
}
return configMap
}
func (e *BootstrapSigner) listSecrets() []*v1.Secret {
secrets, err := e.secretLister.Secrets(e.secretNamespace).List(labels.Everything())
if err != nil { if err != nil {
utilruntime.HandleError(err) utilruntime.HandleError(err)
return nil return nil
} }
if exists {
return configMap.(*v1.ConfigMap)
}
return nil
}
func (e *BootstrapSigner) listSecrets() []*v1.Secret {
secrets := e.secrets.List()
items := []*v1.Secret{} items := []*v1.Secret{}
for _, obj := range secrets { for _, secret := range secrets {
items = append(items, obj.(*v1.Secret)) if secret.Type == bootstrapapi.SecretTypeBootstrapToken {
items = append(items, secret)
}
} }
return items return items
} }

View File

@ -24,10 +24,13 @@ import (
"k8s.io/api/core/v1" "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema" "k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/client-go/informers"
coreinformers "k8s.io/client-go/informers/core/v1"
"k8s.io/client-go/kubernetes/fake" "k8s.io/client-go/kubernetes/fake"
core "k8s.io/client-go/testing" core "k8s.io/client-go/testing"
api "k8s.io/kubernetes/pkg/apis/core" api "k8s.io/kubernetes/pkg/apis/core"
bootstrapapi "k8s.io/kubernetes/pkg/bootstrap/api" bootstrapapi "k8s.io/kubernetes/pkg/bootstrap/api"
"k8s.io/kubernetes/pkg/controller"
) )
func init() { func init() {
@ -36,14 +39,17 @@ func init() {
const testTokenID = "abc123" const testTokenID = "abc123"
func newBootstrapSigner() (*BootstrapSigner, *fake.Clientset, error) { func newBootstrapSigner() (*BootstrapSigner, *fake.Clientset, coreinformers.SecretInformer, coreinformers.ConfigMapInformer, error) {
options := DefaultBootstrapSignerOptions() options := DefaultBootstrapSignerOptions()
cl := fake.NewSimpleClientset() cl := fake.NewSimpleClientset()
bsc, err := NewBootstrapSigner(cl, options) informers := informers.NewSharedInformerFactory(fake.NewSimpleClientset(), controller.NoResyncPeriodFunc())
secrets := informers.Core().V1().Secrets()
configMaps := informers.Core().V1().ConfigMaps()
bsc, err := NewBootstrapSigner(cl, secrets, configMaps, options)
if err != nil { if err != nil {
return nil, nil, err return nil, nil, nil, nil, err
} }
return bsc, cl, nil return bsc, cl, secrets, configMaps, nil
} }
func newConfigMap(tokenID, signature string) *v1.ConfigMap { func newConfigMap(tokenID, signature string) *v1.ConfigMap {
@ -64,7 +70,7 @@ func newConfigMap(tokenID, signature string) *v1.ConfigMap {
} }
func TestNoConfigMap(t *testing.T) { func TestNoConfigMap(t *testing.T) {
signer, cl, err := newBootstrapSigner() signer, cl, _, _, err := newBootstrapSigner()
if err != nil { if err != nil {
t.Fatalf("error creating BootstrapSigner: %v", err) t.Fatalf("error creating BootstrapSigner: %v", err)
} }
@ -73,17 +79,17 @@ func TestNoConfigMap(t *testing.T) {
} }
func TestSimpleSign(t *testing.T) { func TestSimpleSign(t *testing.T) {
signer, cl, err := newBootstrapSigner() signer, cl, secrets, configMaps, err := newBootstrapSigner()
if err != nil { if err != nil {
t.Fatalf("error creating BootstrapSigner: %v", err) t.Fatalf("error creating BootstrapSigner: %v", err)
} }
cm := newConfigMap("", "") cm := newConfigMap("", "")
signer.configMaps.Add(cm) configMaps.Informer().GetIndexer().Add(cm)
secret := newTokenSecret(testTokenID, "tokenSecret") secret := newTokenSecret(testTokenID, "tokenSecret")
addSecretSigningUsage(secret, "true") addSecretSigningUsage(secret, "true")
signer.secrets.Add(secret) secrets.Informer().GetIndexer().Add(secret)
signer.signConfigMap() signer.signConfigMap()
@ -97,17 +103,17 @@ func TestSimpleSign(t *testing.T) {
} }
func TestNoSignNeeded(t *testing.T) { func TestNoSignNeeded(t *testing.T) {
signer, cl, err := newBootstrapSigner() signer, cl, secrets, configMaps, err := newBootstrapSigner()
if err != nil { if err != nil {
t.Fatalf("error creating BootstrapSigner: %v", err) t.Fatalf("error creating BootstrapSigner: %v", err)
} }
cm := newConfigMap(testTokenID, "eyJhbGciOiJIUzI1NiIsImtpZCI6ImFiYzEyMyJ9..QSxpUG7Q542CirTI2ECPSZjvBOJURUW5a7XqFpNI958") cm := newConfigMap(testTokenID, "eyJhbGciOiJIUzI1NiIsImtpZCI6ImFiYzEyMyJ9..QSxpUG7Q542CirTI2ECPSZjvBOJURUW5a7XqFpNI958")
signer.configMaps.Add(cm) configMaps.Informer().GetIndexer().Add(cm)
secret := newTokenSecret(testTokenID, "tokenSecret") secret := newTokenSecret(testTokenID, "tokenSecret")
addSecretSigningUsage(secret, "true") addSecretSigningUsage(secret, "true")
signer.secrets.Add(secret) secrets.Informer().GetIndexer().Add(secret)
signer.signConfigMap() signer.signConfigMap()
@ -115,17 +121,17 @@ func TestNoSignNeeded(t *testing.T) {
} }
func TestUpdateSignature(t *testing.T) { func TestUpdateSignature(t *testing.T) {
signer, cl, err := newBootstrapSigner() signer, cl, secrets, configMaps, err := newBootstrapSigner()
if err != nil { if err != nil {
t.Fatalf("error creating BootstrapSigner: %v", err) t.Fatalf("error creating BootstrapSigner: %v", err)
} }
cm := newConfigMap(testTokenID, "old signature") cm := newConfigMap(testTokenID, "old signature")
signer.configMaps.Add(cm) configMaps.Informer().GetIndexer().Add(cm)
secret := newTokenSecret(testTokenID, "tokenSecret") secret := newTokenSecret(testTokenID, "tokenSecret")
addSecretSigningUsage(secret, "true") addSecretSigningUsage(secret, "true")
signer.secrets.Add(secret) secrets.Informer().GetIndexer().Add(secret)
signer.signConfigMap() signer.signConfigMap()
@ -139,13 +145,13 @@ func TestUpdateSignature(t *testing.T) {
} }
func TestRemoveSignature(t *testing.T) { func TestRemoveSignature(t *testing.T) {
signer, cl, err := newBootstrapSigner() signer, cl, _, configMaps, err := newBootstrapSigner()
if err != nil { if err != nil {
t.Fatalf("error creating BootstrapSigner: %v", err) t.Fatalf("error creating BootstrapSigner: %v", err)
} }
cm := newConfigMap(testTokenID, "old signature") cm := newConfigMap(testTokenID, "old signature")
signer.configMaps.Add(cm) configMaps.Informer().GetIndexer().Add(cm)
signer.signConfigMap() signer.signConfigMap()