Use the generic/typed workqueue throughout

This change makes us use the generic workqueue throughout the project in
order to improve type safety and readability of the code.
This commit is contained in:
Alvaro Aleman
2024-04-28 18:26:18 +02:00
parent d387c0c903
commit 6d0ac8c561
94 changed files with 830 additions and 603 deletions

View File

@@ -61,7 +61,7 @@ type Controller struct {
// queue is where incoming work is placed to de-dup and to allow "easy" rate limited requeues on errors.
// we only ever place one entry in here, but it is keyed as usual: namespace/name
queue workqueue.RateLimitingInterface
queue workqueue.TypedRateLimitingInterface[string]
// kubeSystemConfigMapInformer is tracked so that we can start these on Run
kubeSystemConfigMapInformer cache.SharedIndexInformer
@@ -94,11 +94,14 @@ func NewClusterAuthenticationTrustController(requiredAuthenticationData ClusterA
kubeSystemConfigMapInformer := corev1informers.NewConfigMapInformer(kubeClient, configMapNamespace, 12*time.Hour, cache.Indexers{cache.NamespaceIndex: cache.MetaNamespaceIndexFunc})
c := &Controller{
requiredAuthenticationData: requiredAuthenticationData,
configMapLister: corev1listers.NewConfigMapLister(kubeSystemConfigMapInformer.GetIndexer()),
configMapClient: kubeClient.CoreV1(),
namespaceClient: kubeClient.CoreV1(),
queue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "cluster_authentication_trust_controller"),
requiredAuthenticationData: requiredAuthenticationData,
configMapLister: corev1listers.NewConfigMapLister(kubeSystemConfigMapInformer.GetIndexer()),
configMapClient: kubeClient.CoreV1(),
namespaceClient: kubeClient.CoreV1(),
queue: workqueue.NewTypedRateLimitingQueueWithConfig(
workqueue.DefaultTypedControllerRateLimiter[string](),
workqueue.TypedRateLimitingQueueConfig[string]{Name: "cluster_authentication_trust_controller"},
),
preRunCaches: []cache.InformerSynced{kubeSystemConfigMapInformer.HasSynced},
kubeSystemConfigMapInformer: kubeSystemConfigMapInformer,
}

View File

@@ -56,7 +56,7 @@ type crdRegistrationController struct {
// queue is where incoming work is placed to de-dup and to allow "easy" rate limited requeues on errors
// this is actually keyed by a groupVersion
queue workqueue.RateLimitingInterface
queue workqueue.TypedRateLimitingInterface[schema.GroupVersion]
}
// NewCRDRegistrationController returns a controller which will register CRD GroupVersions with the auto APIService registration
@@ -67,7 +67,10 @@ func NewCRDRegistrationController(crdinformer crdinformers.CustomResourceDefinit
crdSynced: crdinformer.Informer().HasSynced,
apiServiceRegistration: apiServiceRegistration,
syncedInitialSet: make(chan struct{}),
queue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "crd_autoregistration_controller"),
queue: workqueue.NewTypedRateLimitingQueueWithConfig(
workqueue.DefaultTypedControllerRateLimiter[schema.GroupVersion](),
workqueue.TypedRateLimitingQueueConfig[schema.GroupVersion]{Name: "crd_autoregistration_controller"},
),
}
c.syncHandler = c.handleVersionUpdate
@@ -164,7 +167,7 @@ func (c *crdRegistrationController) processNextWorkItem() bool {
defer c.queue.Done(key)
// do your work on the key. This method will contains your "do stuff" logic
err := c.syncHandler(key.(schema.GroupVersion))
err := c.syncHandler(key)
if err == nil {
// if you had no error, tell the queue to stop tracking history for your key. This will
// reset things like failure counts for per-item rate limiting

View File

@@ -58,7 +58,7 @@ type Controller struct {
configMapInformer cache.SharedIndexInformer
configMapCache cache.Indexer
configMapSynced cache.InformerSynced
queue workqueue.RateLimitingInterface
queue workqueue.TypedRateLimitingInterface[string]
// rate limiter controls the rate limit of the creation of the configmap.
// this is useful in multi-apiserver cluster to prevent config existing in a
@@ -80,8 +80,11 @@ func newController(cs kubernetes.Interface, cl clock.Clock, limiter *rate.Limite
})
c := &Controller{
configMapClient: cs.CoreV1(),
queue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "legacy_token_tracking_controller"),
configMapClient: cs.CoreV1(),
queue: workqueue.NewTypedRateLimitingQueueWithConfig(
workqueue.DefaultTypedControllerRateLimiter[string](),
workqueue.TypedRateLimitingQueueConfig[string]{Name: "legacy_token_tracking_controller"},
),
configMapInformer: informer,
configMapCache: informer.GetIndexer(),
configMapSynced: informer.HasSynced,