actions-runner-controller/controllers/actions.github.com/options.go

package actionsgithubcom

import (
	"k8s.io/client-go/util/workqueue"
	"sigs.k8s.io/controller-runtime/pkg/builder"
	"sigs.k8s.io/controller-runtime/pkg/controller"
	"sigs.k8s.io/controller-runtime/pkg/reconcile"
)

// Options is the optional configuration for the controllers, which can be
// set via command-line flags or environment variables.
type Options struct {
	// DefaultMaxConcurrentReconciles is the maximum number of concurrent Reconciles
	// applied to every controller that does not have its own value set below.
	DefaultMaxConcurrentReconciles int

	// AutoscalingRunnerSetMaxConcurrentReconciles is the maximum number of concurrent Reconciles
	// which can be run by the AutoscalingRunnerSetController. Zero means DefaultMaxConcurrentReconciles.
	AutoscalingRunnerSetMaxConcurrentReconciles int

	// AutoscalingListenerMaxConcurrentReconciles is the maximum number of concurrent Reconciles
	// which can be run by the AutoscalingListenerController. Zero means DefaultMaxConcurrentReconciles.
	AutoscalingListenerMaxConcurrentReconciles int

	// EphemeralRunnerSetMaxConcurrentReconciles is the maximum number of concurrent Reconciles
	// which can be run by the EphemeralRunnerSetController. Zero means DefaultMaxConcurrentReconciles.
	EphemeralRunnerSetMaxConcurrentReconciles int

	// EphemeralRunnerMaxConcurrentReconciles is the maximum number of concurrent Reconciles
	// which can be run by the EphemeralRunnerController. Zero means DefaultMaxConcurrentReconciles.
	EphemeralRunnerMaxConcurrentReconciles int
}

// OptionsWithDefault returns the default options.
// This is here to maintain the options and their default values in one place,
// rather than having to correlate those in multiple places.
func OptionsWithDefault() Options {
	return Options{
		DefaultMaxConcurrentReconciles: 1,
	}
}

// Resolve returns a copy of the options where a DefaultMaxConcurrentReconciles
// of zero or less is replaced by 1, and every per-controller
// MaxConcurrentReconciles that is left at zero is replaced by
// DefaultMaxConcurrentReconciles.
func (o Options) Resolve() Options {
	if o.DefaultMaxConcurrentReconciles <= 0 {
		o.DefaultMaxConcurrentReconciles = 1
	}
	orDefault := func(n int) int {
		if n > 0 {
			return n
		}
		return o.DefaultMaxConcurrentReconciles
	}
	o.AutoscalingRunnerSetMaxConcurrentReconciles = orDefault(o.AutoscalingRunnerSetMaxConcurrentReconciles)
	o.AutoscalingListenerMaxConcurrentReconciles = orDefault(o.AutoscalingListenerMaxConcurrentReconciles)
	o.EphemeralRunnerSetMaxConcurrentReconciles = orDefault(o.EphemeralRunnerSetMaxConcurrentReconciles)
	o.EphemeralRunnerMaxConcurrentReconciles = orDefault(o.EphemeralRunnerMaxConcurrentReconciles)
	return o
}

type Option func(*controller.Options)

// WithMaxConcurrentReconciles sets the maximum number of concurrent Reconciles which can be run.
//
// This is useful to improve the throughput of the controller, but it may also increase the load on the API server and
// the external service (e.g. GitHub API). The default value is 1, as defined by the controller-runtime.
//
// See https://github.com/actions/actions-runner-controller/issues/3021 for more information
// on real-world use cases and the potential impact of this option.
func WithMaxConcurrentReconciles(n int) Option {
	return func(b *controller.Options) {
		b.MaxConcurrentReconciles = n
	}
}

// WithTypedRateLimiter sets the rate limiter for the controller's workqueue.
//
// By default, the controller-runtime uses
// workqueue.DefaultTypedControllerRateLimiter[reconcile.Request], which combines
// an exponential backoff per-item limiter with a token bucket overall limiter
// (10 QPS, 100 bucket size). In large-scale environments with many runner
// scale sets, the token bucket limiter can become a bottleneck for
// reconciliation throughput.
//
// Use this option to override the default rate limiter, for example, to use
// workqueue.DefaultTypedItemBasedRateLimiter[reconcile.Request], which removes
// the overall token bucket constraint while keeping the per-item exponential
// backoff.
func WithTypedRateLimiter(rateLimiter workqueue.TypedRateLimiter[reconcile.Request]) Option {
	return func(b *controller.Options) {
		b.RateLimiter = rateLimiter
	}
}

// builderWithOptions applies the given options to the provided builder, if any.
// This is a helper function to avoid the need to import the controller-runtime package in every reconciler source file
// and the command package that creates the controller.
// This is also useful for reducing code duplication around setting controller options in
// multiple reconcilers.
func builderWithOptions(b *builder.Builder, opts []Option) *builder.Builder {
	if len(opts) == 0 {
		return b
	}

	var controllerOpts controller.Options
	for _, opt := range opts {
		opt(&controllerOpts)
	}

	return b.WithOptions(controllerOpts)
}