cmd/bpa-operator/vendor/sigs.k8s.io/controller-runtime/pkg/handler/doc.go

   1 /*
   2 Copyright 2018 The Kubernetes Authors.
   3
   4 Licensed under the Apache License, Version 2.0 (the "License");
   5 you may not use this file except in compliance with the License.
   6 You may obtain a copy of the License at
   7
   8     http://www.apache.org/licenses/LICENSE-2.0
   9
  10 Unless required by applicable law or agreed to in writing, software
  11 distributed under the License is distributed on an "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 See the License for the specific language governing permissions and
  14 limitations under the License.
  15 */
  16
  17 /*
  18 Package handler defines EventHandlers that enqueue reconcile.Requests in response to Create, Update, Deletion Events
  19 observed from Watching Kubernetes APIs.  Users should provide a source.Source and handler.EventHandler to
  20 Controller.Watch in order to generate and enqueue reconcile.Request work items.
  21
  22 EventHandlers
  23
  24 EnqueueRequestForObject - Enqueues a reconcile.Request containing the Name and Namespace of the object in the Event.  This will
  25 cause the object that was the source of the Event (e.g. the created / deleted / updated object) to be
  26 reconciled.
  27
  28 EnqueueRequestForOwner - Enqueues a reconcile.Request containing the Name and Namespace of the Owner of the object in the Event.
  29 This will cause owner of the object that was the source of the Event (e.g. the owner object that created the object)
  30 to be reconciled.
  31
  32 EnqueueRequestsFromMapFunc - Enqueues Reconciler.Requests resulting from a user provided transformation function run against the
  33 object in the Event.  This will cause an arbitrary collection of objects (defined from a transformation of the
  34 source object) to be reconciled.
  35 */
  36 package handler