Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

🐛 Give permission claim controllers their own name #2190

Merged
merged 1 commit into from
Oct 19, 2022
Merged

🐛 Give permission claim controllers their own name #2190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions pkg/reconciler/apis/apibinding/apibinding_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ import (
)

const (
controllerName = "kcp-apibinding"
ControllerName = "kcp-apibinding"
)

var (
Expand All @@ -71,7 +71,7 @@ func NewController(
temporaryRemoteShardApiResourceSchemaInformer apisinformers.APIResourceSchemaInformer, /*TODO(p0lyn0mial): replace with multi-shard informers*/
crdInformer apiextensionsinformers.CustomResourceDefinitionInformer,
) (*controller, error) {
queue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), controllerName)
queue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), ControllerName)

c := &controller{
queue: queue,
Expand Down Expand Up @@ -130,7 +130,7 @@ func NewController(
commit: committer.NewCommitter[*APIBinding, *APIBindingSpec, *APIBindingStatus](kcpClusterClient.ApisV1alpha1().APIBindings()),
}

logger := logging.WithReconciler(klog.Background(), controllerName)
logger := logging.WithReconciler(klog.Background(), ControllerName)
apiBindingInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: func(obj interface{}) { c.enqueueAPIBinding(obj, logger, "") },
UpdateFunc: func(_, obj interface{}) { c.enqueueAPIBinding(obj, logger, "") },
Expand Down Expand Up @@ -342,7 +342,7 @@ func (c *controller) Start(ctx context.Context, numThreads int) {
defer runtime.HandleCrash()
defer c.queue.ShutDown()

logger := logging.WithReconciler(klog.FromContext(ctx), controllerName)
logger := logging.WithReconciler(klog.FromContext(ctx), ControllerName)
ctx = klog.NewContext(ctx, logger)
logger.Info("Starting controller")
defer logger.Info("Shutting down controller")
Expand Down Expand Up @@ -376,7 +376,7 @@ func (c *controller) processNextWorkItem(ctx context.Context) bool {
defer c.queue.Done(key)

if err := c.process(ctx, key); err != nil {
runtime.HandleError(fmt.Errorf("%q controller failed to sync %q, err: %w", controllerName, key, err))
runtime.HandleError(fmt.Errorf("%q controller failed to sync %q, err: %w", ControllerName, key, err))
c.queue.AddRateLimited(key)
return true
}
Expand Down
8 changes: 4 additions & 4 deletions pkg/reconciler/apis/apibindingdeletion/apibinding_deletion_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ import (
)

const (
controllerName = "kcp-apibindingdeletion"
ControllerName = "kcp-apibindingdeletion"

APIBindingFinalizer = "apis.kcp.dev/apibinding-finalizer"

Expand All @@ -75,7 +75,7 @@ func NewController(
kcpClusterClient kcpclient.Interface,
apiBindingInformer apisinformers.APIBindingInformer,
) *Controller {
queue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), controllerName)
queue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), ControllerName)

c := &Controller{
queue: queue,
Expand Down Expand Up @@ -117,7 +117,7 @@ func (c *Controller) enqueue(obj interface{}) {
runtime.HandleError(err)
return
}
logger := logging.WithQueueKey(logging.WithReconciler(klog.Background(), controllerName), key)
logger := logging.WithQueueKey(logging.WithReconciler(klog.Background(), ControllerName), key)
logger.V(2).Info("queueing APIBinding")
c.queue.Add(key)
}
Expand All @@ -126,7 +126,7 @@ func (c *Controller) Start(ctx context.Context, numThreads int) {
defer runtime.HandleCrash()
defer c.queue.ShutDown()

logger := logging.WithReconciler(klog.FromContext(ctx), controllerName)
logger := logging.WithReconciler(klog.FromContext(ctx), ControllerName)
ctx = klog.NewContext(ctx, logger)
logger.Info("Starting controller")
defer logger.Info("Shutting down controller")
Expand Down
16 changes: 8 additions & 8 deletions pkg/reconciler/apis/apiexport/apiexport_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ import (
)

const (
controllerName = "kcp-apiexport"
ControllerName = "kcp-apiexport"

DefaultIdentitySecretNamespace = "kcp-system"
)
Expand All @@ -67,7 +67,7 @@ func NewController(
secretInformer coreinformers.SecretInformer,
apiBindingInformer apisinformers.APIBindingInformer,
) (*controller, error) {
queue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), controllerName)
queue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), ControllerName)

c := &controller{
queue: queue,
Expand Down Expand Up @@ -209,7 +209,7 @@ func (c *controller) enqueueAPIExport(obj interface{}) {
return
}

logger := logging.WithQueueKey(logging.WithReconciler(klog.Background(), controllerName), key)
logger := logging.WithQueueKey(logging.WithReconciler(klog.Background(), ControllerName), key)
logger.V(4).Info("queueing APIExport")
c.queue.Add(key)
}
Expand All @@ -221,7 +221,7 @@ func (c *controller) enqueueAllAPIExports(clusterWorkspaceShard interface{}) {
return
}

logger := logging.WithObject(logging.WithReconciler(klog.Background(), controllerName), clusterWorkspaceShard.(*tenancyv1alpha1.ClusterWorkspaceShard))
logger := logging.WithObject(logging.WithReconciler(klog.Background(), ControllerName), clusterWorkspaceShard.(*tenancyv1alpha1.ClusterWorkspaceShard))
for i := range list {
key, err := kcpcache.MetaClusterNamespaceKeyFunc(list[i])
if err != nil {
Expand All @@ -247,7 +247,7 @@ func (c *controller) enqueueSecret(obj interface{}) {
return
}

logger := logging.WithObject(logging.WithReconciler(klog.Background(), controllerName), obj.(*corev1.Secret))
logger := logging.WithObject(logging.WithReconciler(klog.Background(), ControllerName), obj.(*corev1.Secret))
for _, apiExport := range apiExports {
key, err := kcpcache.DeletionHandlingMetaClusterNamespaceKeyFunc(apiExport)
if err != nil {
Expand All @@ -270,7 +270,7 @@ func (c *controller) enqueueFromAPIBinding(obj interface{}) {
return
}

logger := logging.WithObject(logging.WithReconciler(klog.Background(), controllerName), binding)
logger := logging.WithObject(logging.WithReconciler(klog.Background(), ControllerName), binding)

if binding.Spec.Reference.Workspace == nil {
return
Expand All @@ -286,7 +286,7 @@ func (c *controller) Start(ctx context.Context, numThreads int) {
defer runtime.HandleCrash()
defer c.queue.ShutDown()

logger := logging.WithReconciler(klog.FromContext(ctx), controllerName)
logger := logging.WithReconciler(klog.FromContext(ctx), ControllerName)
ctx = klog.NewContext(ctx, logger)
logger.Info("Starting controller")
defer logger.Info("Shutting down controller")
Expand Down Expand Up @@ -320,7 +320,7 @@ func (c *controller) processNextWorkItem(ctx context.Context) bool {
defer c.queue.Done(key)

if err := c.process(ctx, key); err != nil {
runtime.HandleError(fmt.Errorf("%q controller failed to sync %q, err: %w", controllerName, key, err))
runtime.HandleError(fmt.Errorf("%q controller failed to sync %q, err: %w", ControllerName, key, err))
c.queue.AddRateLimited(key)
return true
}
Expand Down
6 changes: 3 additions & 3 deletions pkg/reconciler/apis/apiresource/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ import (
)

const clusterNameAndGVRIndexName = "clusterNameAndGVR"
const controllerName = "kcp-apiresource"
const ControllerName = "kcp-apiresource"

func GetClusterNameAndGVRIndexKey(clusterName logicalcluster.Name, gvr metav1.GroupVersionResource) string {
return clusterName.String() + "$" + gvr.String()
Expand Down Expand Up @@ -295,7 +295,7 @@ func (c *Controller) Start(ctx context.Context, numThreads int) {
defer runtime.HandleCrash()
defer c.queue.ShutDown()

logger := logging.WithReconciler(klog.FromContext(ctx), controllerName)
logger := logging.WithReconciler(klog.FromContext(ctx), ControllerName)
ctx = klog.NewContext(ctx, logger)
logger.Info("Starting controller")
defer logger.Info("Shutting down controller")
Expand Down Expand Up @@ -334,7 +334,7 @@ func (c *Controller) processNextWorkItem(ctx context.Context) bool {
defer c.queue.Done(key)

if err := c.process(ctx, key); err != nil {
runtime.HandleError(fmt.Errorf("%q controller failed to sync %v, err: %w", controllerName, key, err))
runtime.HandleError(fmt.Errorf("%q controller failed to sync %v, err: %w", ControllerName, key, err))
c.queue.AddRateLimited(key)
return true
}
Expand Down
10 changes: 5 additions & 5 deletions pkg/reconciler/apis/permissionclaimlabel/permissionclaimlabel_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ import (
)

const (
controllerName = "kcp-permissionclaimlabel"
ControllerName = "kcp-permissionclaimlabel"
)

// NewController returns a new controller for handling permission claims for an APIBinding.
Expand All @@ -61,9 +61,9 @@ func NewController(
apiBindingInformer apisinformers.APIBindingInformer,
apiExportInformer apisinformers.APIExportInformer,
) (*controller, error) {
logger := logging.WithReconciler(klog.Background(), controllerName)
logger := logging.WithReconciler(klog.Background(), ControllerName)

queue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), controllerName)
queue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), ControllerName)

c := &controller{
queue: queue,
Expand Down Expand Up @@ -124,7 +124,7 @@ func (c *controller) Start(ctx context.Context, numThreads int) {
defer runtime.HandleCrash()
defer c.queue.ShutDown()

logger := logging.WithReconciler(klog.FromContext(ctx), controllerName)
logger := logging.WithReconciler(klog.FromContext(ctx), ControllerName)
ctx = klog.NewContext(ctx, logger)
logger.Info("starting controller")
defer logger.Info("shutting down controller")
Expand Down Expand Up @@ -158,7 +158,7 @@ func (c *controller) processNextWorkItem(ctx context.Context) bool {
defer c.queue.Done(key)

if err := c.process(ctx, key); err != nil {
runtime.HandleError(fmt.Errorf("%q controller failed to sync %q, err: %w", controllerName, key, err))
runtime.HandleError(fmt.Errorf("%q controller failed to sync %q, err: %w", ControllerName, key, err))
c.queue.AddRateLimited(key)
return true
}
Expand Down
11 changes: 5 additions & 6 deletions pkg/reconciler/apis/permissionclaimlabel/permissionclaimlabel_resource_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ import (
)

const (
resourceControllerName = "kcp-resource-permissionclaimlabel"
ResourceControllerName = "kcp-resource-permissionclaimlabel"
)

// NewController returns a new controller for labeling resources for accepted permission claims.
Expand All @@ -63,15 +63,14 @@ func NewResourceController(
}

c := &resourceController{
queue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), resourceControllerName),
queue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), ResourceControllerName),
kcpClusterClient: kcpClusterClient,
dynamicClusterClient: dynamicClusterClient,
ddsif: dynamicDiscoverySharedInformerFactory,
permissionClaimLabeler: permissionclaim.NewLabeler(apiBindingInformer),
}

logger := logging.WithReconciler(klog.Background(), controllerName)

logger := logging.WithReconciler(klog.Background(), ControllerName)
c.ddsif.AddEventHandler(informer.GVREventHandlerFuncs{
AddFunc: func(gvr schema.GroupVersionResource, obj interface{}) { c.enqueueForResource(logger, gvr, obj) },
UpdateFunc: func(gvr schema.GroupVersionResource, _, obj interface{}) { c.enqueueForResource(logger, gvr, obj) },
Expand Down Expand Up @@ -112,7 +111,7 @@ func (c *resourceController) Start(ctx context.Context, numThreads int) {
defer utilruntime.HandleCrash()
defer c.queue.ShutDown()

logger := logging.WithReconciler(klog.FromContext(ctx), resourceControllerName)
logger := logging.WithReconciler(klog.FromContext(ctx), ResourceControllerName)
ctx = klog.NewContext(ctx, logger)
logger.Info("starting controller")
defer logger.Info("shutting down controller")
Expand Down Expand Up @@ -146,7 +145,7 @@ func (c *resourceController) processNextWorkItem(ctx context.Context) bool {
defer c.queue.Done(key)

if err := c.process(ctx, key); err != nil {
utilruntime.HandleError(fmt.Errorf("%q controller failed to sync %q, err: %w", resourceControllerName, key, err))
utilruntime.HandleError(fmt.Errorf("%q controller failed to sync %q, err: %w", ResourceControllerName, key, err))
c.queue.AddRateLimited(key)
return true
}
Expand Down
10 changes: 5 additions & 5 deletions pkg/reconciler/kubequota/kubequota_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ import (
)

const (
controllerName = "kcp-kube-quota"
ControllerName = "kcp-kube-quota"
)

// Controller manages per-workspace resource quota controllers.
Expand Down Expand Up @@ -92,7 +92,7 @@ func NewController(
informersStarted <-chan struct{},
) (*Controller, error) {
c := &Controller{
queue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), controllerName),
queue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), ControllerName),

dynamicDiscoverySharedInformerFactory: dynamicDiscoverySharedInformerFactory,
kubeClusterClient: kubeClusterClient,
Expand Down Expand Up @@ -154,7 +154,7 @@ func (c *Controller) enqueue(obj interface{}) {
return
}

logger := logging.WithQueueKey(logging.WithReconciler(klog.Background(), controllerName), key)
logger := logging.WithQueueKey(logging.WithReconciler(klog.Background(), ControllerName), key)
logger.V(2).Info("queueing ClusterWorkspace")
c.queue.Add(key)
}
Expand All @@ -164,7 +164,7 @@ func (c *Controller) Start(ctx context.Context, numThreads int) {
defer utilruntime.HandleCrash()
defer c.queue.ShutDown()

logger := logging.WithReconciler(klog.FromContext(ctx), controllerName)
logger := logging.WithReconciler(klog.FromContext(ctx), ControllerName)
ctx = klog.NewContext(ctx, logger)
logger.Info("Starting controller")
defer logger.Info("Shutting down controller")
Expand Down Expand Up @@ -200,7 +200,7 @@ func (c *Controller) processNextWorkItem(ctx context.Context) bool {
defer c.queue.Done(key)

if err := c.process(ctx, key); err != nil {
utilruntime.HandleError(fmt.Errorf("%q controller failed to sync %q, err: %w", controllerName, key, err))
utilruntime.HandleError(fmt.Errorf("%q controller failed to sync %q, err: %w", ControllerName, key, err))
c.queue.AddRateLimited(key)
return true
}
Expand Down
18 changes: 9 additions & 9 deletions pkg/reconciler/scheduling/placement/placement_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ import (
)

const (
controllerName = "kcp-scheduling-placement"
byWorkspace = controllerName + "-byWorkspace" // will go away with scoping
byLocationWorkspace = controllerName + "-byLocationWorkspace"
ControllerName = "kcp-scheduling-placement"
byWorkspace = ControllerName + "-byWorkspace" // will go away with scoping
byLocationWorkspace = ControllerName + "-byLocationWorkspace"
)

// NewController returns a new controller placing namespaces onto locations by create
Expand All @@ -63,7 +63,7 @@ func NewController(
locationInformer schedulinginformers.LocationInformer,
placementInformer schedulinginformers.PlacementInformer,
) (*controller, error) {
queue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), controllerName)
queue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), ControllerName)

c := &controller{
queue: queue,
Expand Down Expand Up @@ -176,14 +176,14 @@ func (c *controller) enqueuePlacement(obj interface{}) {
return
}

logger := logging.WithQueueKey(logging.WithReconciler(klog.Background(), controllerName), key)
logger := logging.WithQueueKey(logging.WithReconciler(klog.Background(), ControllerName), key)
logger.V(2).Info("queueing Placement")
c.queue.Add(key)
}

// enqueueNamespace enqueues all placements for the namespace.
func (c *controller) enqueueNamespace(obj interface{}) {
logger := logging.WithReconciler(klog.Background(), controllerName)
logger := logging.WithReconciler(klog.Background(), ControllerName)
key, err := kcpcache.DeletionHandlingMetaClusterNamespaceKeyFunc(obj)
if err != nil {
runtime.HandleError(err)
Expand Down Expand Up @@ -211,7 +211,7 @@ func (c *controller) enqueueNamespace(obj interface{}) {
}

func (c *controller) enqueueLocation(obj interface{}) {
logger := logging.WithReconciler(klog.Background(), controllerName)
logger := logging.WithReconciler(klog.Background(), ControllerName)
key, err := kcpcache.DeletionHandlingMetaClusterNamespaceKeyFunc(obj)
if err != nil {
runtime.HandleError(err)
Expand Down Expand Up @@ -243,7 +243,7 @@ func (c *controller) Start(ctx context.Context, numThreads int) {
defer runtime.HandleCrash()
defer c.queue.ShutDown()

logger := logging.WithReconciler(klog.FromContext(ctx), controllerName)
logger := logging.WithReconciler(klog.FromContext(ctx), ControllerName)
ctx = klog.NewContext(ctx, logger)
logger.Info("Starting controller")
defer logger.Info("Shutting down controller")
Expand Down Expand Up @@ -277,7 +277,7 @@ func (c *controller) processNextWorkItem(ctx context.Context) bool {
defer c.queue.Done(key)

if err := c.process(ctx, key); err != nil {
runtime.HandleError(fmt.Errorf("%q controller failed to sync %q, err: %w", controllerName, key, err))
runtime.HandleError(fmt.Errorf("%q controller failed to sync %q, err: %w", ControllerName, key, err))
c.queue.AddRateLimited(key)
return true
}
Expand Down
4 changes: 2 additions & 2 deletions pkg/reconciler/tenancy/bootstrap/bootstrap_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ import (
)

const (
controllerNameBase = "kcp-clusterworkspacetypes-bootstrap"
ControllerNameBase = "kcp-clusterworkspacetypes-bootstrap"
)

func NewController(
Expand All @@ -62,7 +62,7 @@ func NewController(
bootstrap func(context.Context, discovery.DiscoveryInterface, dynamic.Interface, kcpclient.Interface, sets.String) error,
batteriesIncluded sets.String,
) (*controller, error) {
controllerName := fmt.Sprintf("%s-%s", controllerNameBase, workspaceType)
controllerName := fmt.Sprintf("%s-%s", ControllerNameBase, workspaceType)
queue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), controllerName)

c := &controller{
Expand Down
Loading