Merge pull request #425 from wking/maxRetries-docs

openshift-merge-robot · web-flow · commit 16d3d8465b8e · 2020-08-06T03:30:54.000+02:00
pkg/cvo: Fix maxRetries comment (not about machineconfig pools)
diff --git a/pkg/autoupdate/autoupdate.go b/pkg/autoupdate/autoupdate.go
@@ -27,11 +27,7 @@ import (
 )
 
 const (
-	// maxRetries is the number of times a machineconfig pool will be retried before it is dropped out of the queue.
-	// With the current rate-limiter in use (5ms*2^(maxRetries-1)) the following numbers represent the times
-	// a machineconfig pool is going to be requeued:
-	//
-	// 5ms, 10ms, 20ms, 40ms, 80ms, 160ms, 320ms, 640ms, 1.3s, 2.6s, 5.1s, 10.2s, 20.4s, 41s, 82s
+	// maxRetries is the number of times a work-item will be retried before it is dropped out of the queue.
 	maxRetries = 15
 )
 
@@ -141,13 +137,13 @@ func (ctrl *Controller) handleErr(err error, key interface{}) {
 	}
 
 	if ctrl.queue.NumRequeues(key) < maxRetries {
-		klog.V(2).Infof("Error syncing controller %v: %v", key, err)
+		klog.V(2).Infof("Error handling %v: %v", key, err)
 		ctrl.queue.AddRateLimited(key)
 		return
 	}
 
 	utilruntime.HandleError(err)
-	klog.V(2).Infof("Dropping controller %q out of the queue: %v", key, err)
+	klog.V(2).Infof("Dropping %q out of the queue: %v", key, err)
 	ctrl.queue.Forget(key)
 }
 
diff --git a/pkg/cvo/cvo.go b/pkg/cvo/cvo.go
@@ -52,11 +52,7 @@ import (
 )
 
 const (
-	// maxRetries is the number of times a machineconfig pool will be retried before it is dropped out of the queue.
-	// With the current rate-limiter in use (5ms*2^(maxRetries-1)) the following numbers represent the times
-	// a machineconfig pool is going to be requeued:
-	//
-	// 5ms, 10ms, 20ms, 40ms, 80ms, 160ms, 320ms, 640ms, 1.3s, 2.6s, 5.1s, 10.2s, 20.4s, 41s, 82s
+	// maxRetries is the number of times a work-item will be retried before it is dropped out of the queue.
 	maxRetries = 15
 )
 
@@ -400,14 +396,14 @@ func handleErr(ctx context.Context, queue workqueue.RateLimitingInterface, err e
 	}
 
 	if queue.NumRequeues(key) < maxRetries {
-		klog.V(2).Infof("Error syncing operator %v: %v", key, err)
+		klog.V(2).Infof("Error handling %v: %v", key, err)
 		queue.AddRateLimited(key)
 		return
 	}
 
 	err = syncFailingStatus(ctx, nil, err)
 	utilruntime.HandleError(err)
-	klog.V(2).Infof("Dropping operator %q out of the queue %v: %v", key, queue, err)
+	klog.V(2).Infof("Dropping %q out of the queue %v: %v", key, queue, err)
 	queue.Forget(key)
 }
 

Original file line number	Diff line number	Diff line change
`@@ -27,11 +27,7 @@ import (`
`27`	`27`	`)`
`28`	`28`
`29`	`29`	`const (`
`30`		`- // maxRetries is the number of times a machineconfig pool will be retried before it is dropped out of the queue.`
`31`		`- // With the current rate-limiter in use (5ms*2^(maxRetries-1)) the following numbers represent the times`
`32`		`- // a machineconfig pool is going to be requeued:`
`33`		`- //`
`34`		`- // 5ms, 10ms, 20ms, 40ms, 80ms, 160ms, 320ms, 640ms, 1.3s, 2.6s, 5.1s, 10.2s, 20.4s, 41s, 82s`
	`30`	`+ // maxRetries is the number of times a work-item will be retried before it is dropped out of the queue.`
`35`	`31`	`maxRetries = 15`
`36`	`32`	`)`
`37`	`33`
`@@ -141,13 +137,13 @@ func (ctrl *Controller) handleErr(err error, key interface{}) {`
`141`	`137`	`}`
`142`	`138`
`143`	`139`	`if ctrl.queue.NumRequeues(key) < maxRetries {`
`144`		`- klog.V(2).Infof("Error syncing controller %v: %v", key, err)`
	`140`	`+ klog.V(2).Infof("Error handling %v: %v", key, err)`
`145`	`141`	`ctrl.queue.AddRateLimited(key)`
`146`	`142`	`return`
`147`	`143`	`}`
`148`	`144`
`149`	`145`	`utilruntime.HandleError(err)`
`150`		`- klog.V(2).Infof("Dropping controller %q out of the queue: %v", key, err)`
	`146`	`+ klog.V(2).Infof("Dropping %q out of the queue: %v", key, err)`
`151`	`147`	`ctrl.queue.Forget(key)`
`152`	`148`	`}`
`153`	`149`
Original file line number	Diff line number	Diff line change
`@@ -52,11 +52,7 @@ import (`
`52`	`52`	`)`
`53`	`53`
`54`	`54`	`const (`
`55`		`- // maxRetries is the number of times a machineconfig pool will be retried before it is dropped out of the queue.`
`56`		`- // With the current rate-limiter in use (5ms*2^(maxRetries-1)) the following numbers represent the times`
`57`		`- // a machineconfig pool is going to be requeued:`
`58`		`- //`
`59`		`- // 5ms, 10ms, 20ms, 40ms, 80ms, 160ms, 320ms, 640ms, 1.3s, 2.6s, 5.1s, 10.2s, 20.4s, 41s, 82s`
	`55`	`+ // maxRetries is the number of times a work-item will be retried before it is dropped out of the queue.`
`60`	`56`	`maxRetries = 15`
`61`	`57`	`)`
`62`	`58`
`@@ -400,14 +396,14 @@ func handleErr(ctx context.Context, queue workqueue.RateLimitingInterface, err e`
`400`	`396`	`}`
`401`	`397`
`402`	`398`	`if queue.NumRequeues(key) < maxRetries {`
`403`		`- klog.V(2).Infof("Error syncing operator %v: %v", key, err)`
	`399`	`+ klog.V(2).Infof("Error handling %v: %v", key, err)`
`404`	`400`	`queue.AddRateLimited(key)`
`405`	`401`	`return`
`406`	`402`	`}`
`407`	`403`
`408`	`404`	`err = syncFailingStatus(ctx, nil, err)`
`409`	`405`	`utilruntime.HandleError(err)`
`410`		`- klog.V(2).Infof("Dropping operator %q out of the queue %v: %v", key, queue, err)`
	`406`	`+ klog.V(2).Infof("Dropping %q out of the queue %v: %v", key, queue, err)`
`411`	`407`	`queue.Forget(key)`
`412`	`408`	`}`
`413`	`409`