/* Copyright 2018 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 builder import ( "fmt" "strings" "k8s.io/apimachinery/pkg/runtime" "k8s.io/client-go/rest" "sigs.k8s.io/controller-runtime/pkg/client/apiutil" "sigs.k8s.io/controller-runtime/pkg/controller" "sigs.k8s.io/controller-runtime/pkg/handler" "sigs.k8s.io/controller-runtime/pkg/manager" "sigs.k8s.io/controller-runtime/pkg/predicate" "sigs.k8s.io/controller-runtime/pkg/reconcile" "sigs.k8s.io/controller-runtime/pkg/source" ) // Supporting mocking out functions for testing var newController = controller.New var getGvk = apiutil.GVKForObject // Builder builds a Controller. type Builder struct { apiType runtime.Object mgr manager.Manager predicates []predicate.Predicate managedObjects []runtime.Object watchRequest []watchRequest config *rest.Config ctrl controller.Controller ctrlOptions controller.Options name string } // ControllerManagedBy returns a new controller builder that will be started by the provided Manager func ControllerManagedBy(m manager.Manager) *Builder { return &Builder{mgr: m} } // ForType defines the type of Object being *reconciled*, and configures the ControllerManagedBy to respond to create / delete / // update events by *reconciling the object*. // This is the equivalent of calling // Watches(&source.Kind{Type: apiType}, &handler.EnqueueRequestForObject{}) // // Deprecated: Use For func (blder *Builder) ForType(apiType runtime.Object) *Builder { return blder.For(apiType) } // For defines the type of Object being *reconciled*, and configures the ControllerManagedBy to respond to create / delete / // update events by *reconciling the object*. // This is the equivalent of calling // Watches(&source.Kind{Type: apiType}, &handler.EnqueueRequestForObject{}) func (blder *Builder) For(apiType runtime.Object) *Builder { blder.apiType = apiType return blder } // Owns defines types of Objects being *generated* by the ControllerManagedBy, and configures the ControllerManagedBy to respond to // create / delete / update events by *reconciling the owner object*. This is the equivalent of calling // Watches(&handler.EnqueueRequestForOwner{&source.Kind{Type: }, &handler.EnqueueRequestForOwner{OwnerType: apiType, IsController: true}) func (blder *Builder) Owns(apiType runtime.Object) *Builder { blder.managedObjects = append(blder.managedObjects, apiType) return blder } type watchRequest struct { src source.Source eventhandler handler.EventHandler } // Watches exposes the lower-level ControllerManagedBy Watches functions through the builder. Consider using // Owns or For instead of Watches directly. func (blder *Builder) Watches(src source.Source, eventhandler handler.EventHandler) *Builder { blder.watchRequest = append(blder.watchRequest, watchRequest{src: src, eventhandler: eventhandler}) return blder } // WithConfig sets the Config to use for configuring clients. Defaults to the in-cluster config or to ~/.kube/config. // // Deprecated: Use ControllerManagedBy(Manager) and this isn't needed. func (blder *Builder) WithConfig(config *rest.Config) *Builder { blder.config = config return blder } // WithEventFilter sets the event filters, to filter which create/update/delete/generic events eventually // trigger reconciliations. For example, filtering on whether the resource version has changed. // Defaults to the empty list. func (blder *Builder) WithEventFilter(p predicate.Predicate) *Builder { blder.predicates = append(blder.predicates, p) return blder } // WithOptions overrides the controller options use in doController. Defaults to empty. func (blder *Builder) WithOptions(options controller.Options) *Builder { blder.ctrlOptions = options return blder } // Named sets the name of the controller to the given name. The name shows up // in metrics, among other things, and thus should be a prometheus compatible name // (underscores and alphanumeric characters only). // // By default, controllers are named using the lowercase version of their kind. func (blder *Builder) Named(name string) *Builder { blder.name = name return blder } // Complete builds the Application ControllerManagedBy. func (blder *Builder) Complete(r reconcile.Reconciler) error { _, err := blder.Build(r) return err } // Build builds the Application ControllerManagedBy and returns the Controller it created. func (blder *Builder) Build(r reconcile.Reconciler) (controller.Controller, error) { if r == nil { return nil, fmt.Errorf("must provide a non-nil Reconciler") } if blder.mgr == nil { return nil, fmt.Errorf("must provide a non-nil Manager") } // Set the Config blder.loadRestConfig() // Set the ControllerManagedBy if err := blder.doController(r); err != nil { return nil, err } // Set the Watch if err := blder.doWatch(); err != nil { return nil, err } return blder.ctrl, nil } func (blder *Builder) doWatch() error { // Reconcile type src := &source.Kind{Type: blder.apiType} hdler := &handler.EnqueueRequestForObject{} err := blder.ctrl.Watch(src, hdler, blder.predicates...) if err != nil { return err } // Watches the managed types for _, obj := range blder.managedObjects { src := &source.Kind{Type: obj} hdler := &handler.EnqueueRequestForOwner{ OwnerType: blder.apiType, IsController: true, } if err := blder.ctrl.Watch(src, hdler, blder.predicates...); err != nil { return err } } // Do the watch requests for _, w := range blder.watchRequest { if err := blder.ctrl.Watch(w.src, w.eventhandler, blder.predicates...); err != nil { return err } } return nil } func (blder *Builder) loadRestConfig() { if blder.config == nil { blder.config = blder.mgr.GetConfig() } } func (blder *Builder) getControllerName() (string, error) { if blder.name != "" { return blder.name, nil } gvk, err := getGvk(blder.apiType, blder.mgr.GetScheme()) if err != nil { return "", err } return strings.ToLower(gvk.Kind), nil } func (blder *Builder) doController(r reconcile.Reconciler) error { name, err := blder.getControllerName() if err != nil { return err } ctrlOptions := blder.ctrlOptions ctrlOptions.Reconciler = r blder.ctrl, err = newController(name, blder.mgr, ctrlOptions) return err }