github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-16 07:13:53 +00:00
Code Issues Projects Releases Wiki Activity

dra resourceclaim controller: enhance logging

Browse Source 
Adding logging to event handlers makes it more obvious why (or why not) claims
and pods need to be processed.
This commit is contained in:
Patrick Ohly 2023-06-22 14:10:15 +02:00
parent d1ba893ad8
commit 7f5a02fc7e
4 changed files with 37 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
cmd/kube-controller-manager/app/core.go
View File

@ -353,6 +353,7 @@ const defaultResourceClaimControllerWorkers = 10
func startResourceClaimController(ctx context.Context, controllerContext ControllerContext) (controller.Interface, bool, error) { func startResourceClaimController(ctx context.Context, controllerContext ControllerContext) (controller.Interface, bool, error) {
ephemeralController, err := resourceclaim.NewController( ephemeralController, err := resourceclaim.NewController(
klog.FromContext(ctx),
controllerContext.ClientBuilder.ClientOrDie("resource-claim-controller"), controllerContext.ClientBuilder.ClientOrDie("resource-claim-controller"),
controllerContext.InformerFactory.Core().V1().Pods(), controllerContext.InformerFactory.Core().V1().Pods(),
controllerContext.InformerFactory.Resource().V1alpha2().ResourceClaims(), controllerContext.InformerFactory.Resource().V1alpha2().ResourceClaims(),

49
pkg/controller/resourceclaim/controller.go
View File

@ -98,6 +98,7 @@ const (
// NewController creates a ResourceClaim controller. // NewController creates a ResourceClaim controller.
func NewController( func NewController(
logger klog.Logger,
kubeClient clientset.Interface, kubeClient clientset.Interface,
podInformer v1informers.PodInformer, podInformer v1informers.PodInformer,
claimInformer resourcev1alpha2informers.ResourceClaimInformer, claimInformer resourcev1alpha2informers.ResourceClaimInformer,
@ -120,23 +121,27 @@ func NewController(
if _, err := podInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{ if _, err := podInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: func(obj interface{}) { AddFunc: func(obj interface{}) {
ec.enqueuePod(obj, false) ec.enqueuePod(logger, obj, false)
}, },
UpdateFunc: func(old, updated interface{}) { UpdateFunc: func(old, updated interface{}) {
ec.enqueuePod(updated, false) ec.enqueuePod(logger, updated, false)
}, },
DeleteFunc: func(obj interface{}) { DeleteFunc: func(obj interface{}) {
ec.enqueuePod(obj, true) ec.enqueuePod(logger, obj, true)
}, },
}); err != nil { }); err != nil {
return nil, err return nil, err
} }
if _, err := claimInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{ if _, err := claimInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: ec.onResourceClaimAddOrUpdate, AddFunc: func(obj interface{}) {
UpdateFunc: func(old, updated interface{}) { ec.onResourceClaimAddOrUpdate(logger, obj)
ec.onResourceClaimAddOrUpdate(updated) },
UpdateFunc: func(old, updated interface{}) {
ec.onResourceClaimAddOrUpdate(logger, updated)
},
DeleteFunc: func(obj interface{}) {
ec.onResourceClaimDelete(logger, obj)
}, },
DeleteFunc: ec.onResourceClaimDelete,
}); err != nil { }); err != nil {
return nil, err return nil, err
} }
@ -147,7 +152,7 @@ func NewController(
return ec, nil return ec, nil
} }
func (ec *Controller) enqueuePod(obj interface{}, deleted bool) { func (ec *Controller) enqueuePod(logger klog.Logger, obj interface{}, deleted bool) {
if d, ok := obj.(cache.DeletedFinalStateUnknown); ok { if d, ok := obj.(cache.DeletedFinalStateUnknown); ok {
obj = d.Obj obj = d.Obj
} }
@ -166,11 +171,15 @@ func (ec *Controller) enqueuePod(obj interface{}, deleted bool) {
return return
} }
logger.V(6).Info("pod with resource claims changed", "pod", klog.KObj(pod), "deleted", deleted)
// Release reservations of a deleted or completed pod? // Release reservations of a deleted or completed pod?
if deleted || isPodDone(pod) { if deleted || isPodDone(pod) {
for _, podClaim := range pod.Spec.ResourceClaims { for _, podClaim := range pod.Spec.ResourceClaims {
claimName := resourceclaim.Name(pod, &podClaim) claimName := resourceclaim.Name(pod, &podClaim)
ec.queue.Add(claimKeyPrefix + pod.Namespace + "/" + claimName) key := claimKeyPrefix + pod.Namespace + "/" + claimName
logger.V(6).Info("pod is deleted or done, process claim", "pod", klog.KObj(pod), "key", key)
ec.queue.Add(key)
} }
} }
@ -179,14 +188,16 @@ func (ec *Controller) enqueuePod(obj interface{}, deleted bool) {
for _, podClaim := range pod.Spec.ResourceClaims { for _, podClaim := range pod.Spec.ResourceClaims {
if podClaim.Source.ResourceClaimTemplateName != nil { if podClaim.Source.ResourceClaimTemplateName != nil {
// It has at least one inline template, work on it. // It has at least one inline template, work on it.
ec.queue.Add(podKeyPrefix + pod.Namespace + "/" + pod.Name) key := podKeyPrefix + pod.Namespace + "/" + pod.Name
logger.V(6).Info("pod is not deleted, process it", "pod", klog.KObj(pod), "key", key)
ec.queue.Add(key)
break break
} }
} }
} }
} }
func (ec *Controller) onResourceClaimAddOrUpdate(obj interface{}) { func (ec *Controller) onResourceClaimAddOrUpdate(logger klog.Logger, obj interface{}) {
claim, ok := obj.(*resourcev1alpha2.ResourceClaim) claim, ok := obj.(*resourcev1alpha2.ResourceClaim)
if !ok { if !ok {
return return
@ -195,10 +206,12 @@ func (ec *Controller) onResourceClaimAddOrUpdate(obj interface{}) {
// When starting up, we have to check all claims to find those with // When starting up, we have to check all claims to find those with
// stale pods in ReservedFor. During an update, a pod might get added // stale pods in ReservedFor. During an update, a pod might get added
// that already no longer exists. // that already no longer exists.
ec.queue.Add(claimKeyPrefix + claim.Namespace + "/" + claim.Name) key := claimKeyPrefix + claim.Namespace + "/" + claim.Name
logger.V(6).Info("claim is new or updated, process it", "key", key)
ec.queue.Add(key)
} }
func (ec *Controller) onResourceClaimDelete(obj interface{}) { func (ec *Controller) onResourceClaimDelete(logger klog.Logger, obj interface{}) {
claim, ok := obj.(*resourcev1alpha2.ResourceClaim) claim, ok := obj.(*resourcev1alpha2.ResourceClaim)
if !ok { if !ok {
return return
@ -215,8 +228,13 @@ func (ec *Controller) onResourceClaimDelete(obj interface{}) {
runtime.HandleError(fmt.Errorf("listing pods from cache: %v", err)) runtime.HandleError(fmt.Errorf("listing pods from cache: %v", err))
return return
} }
if len(objs) == 0 {
logger.V(6).Info("claim got deleted while not needed by any pod, nothing to do", "claim", klog.KObj(claim))
return
}
logger = klog.LoggerWithValues(logger, "claim", klog.KObj(claim))
for _, obj := range objs { for _, obj := range objs {
ec.enqueuePod(obj, false) ec.enqueuePod(logger, obj, false)
} }
} }
@ -382,7 +400,7 @@ func (ec *Controller) handleClaim(ctx context.Context, pod *v1.Pod, podClaim v1.
} }
func (ec *Controller) syncClaim(ctx context.Context, namespace, name string) error { func (ec *Controller) syncClaim(ctx context.Context, namespace, name string) error {
logger := klog.LoggerWithValues(klog.FromContext(ctx), "PVC", klog.KRef(namespace, name)) logger := klog.LoggerWithValues(klog.FromContext(ctx), "claim", klog.KRef(namespace, name))
ctx = klog.NewContext(ctx, logger) ctx = klog.NewContext(ctx, logger)
claim, err := ec.claimLister.ResourceClaims(namespace).Get(name) claim, err := ec.claimLister.ResourceClaims(namespace).Get(name)
if err != nil { if err != nil {
@ -449,6 +467,7 @@ func (ec *Controller) syncClaim(ctx context.Context, namespace, name string) err
return fmt.Errorf("unsupported ReservedFor entry: %v", reservedFor) return fmt.Errorf("unsupported ReservedFor entry: %v", reservedFor)
} }
logger.V(5).Info("claim reserved for counts", "currentCount", len(claim.Status.ReservedFor), "claim", klog.KRef(namespace, name), "updatedCount", len(valid))
if len(valid) < len(claim.Status.ReservedFor) { if len(valid) < len(claim.Status.ReservedFor) {
// TODO (#113700): patch // TODO (#113700): patch
claim := claim.DeepCopy() claim := claim.DeepCopy()

2
pkg/controller/resourceclaim/controller_test.go
View File

@ -226,7 +226,7 @@ func TestSyncHandler(t *testing.T) {
claimInformer := informerFactory.Resource().V1alpha2().ResourceClaims() claimInformer := informerFactory.Resource().V1alpha2().ResourceClaims()
templateInformer := informerFactory.Resource().V1alpha2().ResourceClaimTemplates() templateInformer := informerFactory.Resource().V1alpha2().ResourceClaimTemplates()
ec, err := NewController(fakeKubeClient, podInformer, claimInformer, templateInformer) ec, err := NewController(klog.TODO(), fakeKubeClient, podInformer, claimInformer, templateInformer)
if err != nil { if err != nil {
t.Fatalf("error creating ephemeral controller : %v", err) t.Fatalf("error creating ephemeral controller : %v", err)
} }

2
test/integration/util/util.go
View File

@ -108,7 +108,7 @@ func CreateResourceClaimController(ctx context.Context, tb testing.TB, clientSet
podInformer := informerFactory.Core().V1().Pods() podInformer := informerFactory.Core().V1().Pods()
claimInformer := informerFactory.Resource().V1alpha2().ResourceClaims() claimInformer := informerFactory.Resource().V1alpha2().ResourceClaims()
claimTemplateInformer := informerFactory.Resource().V1alpha2().ResourceClaimTemplates() claimTemplateInformer := informerFactory.Resource().V1alpha2().ResourceClaimTemplates()
claimController, err := resourceclaim.NewController(clientSet, podInformer, claimInformer, claimTemplateInformer) claimController, err := resourceclaim.NewController(klog.FromContext(ctx), clientSet, podInformer, claimInformer, claimTemplateInformer)
if err != nil { if err != nil {
tb.Fatalf("Error creating claim controller: %v", err) tb.Fatalf("Error creating claim controller: %v", err)
} }