config

Documentation

Index

• Constants
• Variables
• func AddLeaderElectionFlags(l *LeaderElectionConfiguration, fs *pflag.FlagSet)
• type Configuration
  • func (c *Configuration) AddFlags(fs *pflag.FlagSet)
• type LeaderElectionConfiguration
  • func GetLeaderElectionConfig() *LeaderElectionConfiguration

Constants

const (
	// DefaultLeaseDuration is the default lease duration for leader election
	DefaultLeaseDuration = 15 * time.Second
	// DefaultRenewDeadline is the default renew duration for leader election
	DefaultRenewDeadline = 10 * time.Second
	// DefaultRetryPeriod is the default retry period for leader election
	DefaultRetryPeriod = 2 * time.Second
)

Variables

var ControllerConfig = Configuration{
	WorkerCount: 5,
	// contains filtered or unexported fields
}

Functions

func AddLeaderElectionFlags

func AddLeaderElectionFlags(l *LeaderElectionConfiguration, fs *pflag.FlagSet)

Types

type Configuration

type Configuration struct {
	Kubeconfig  string
	WorkerCount int
	// contains filtered or unexported fields
}

func (*Configuration) AddFlags

func (c *Configuration) AddFlags(fs *pflag.FlagSet)

type LeaderElectionConfiguration

type LeaderElectionConfiguration struct {
	// LeaderElect enables a leader election client to gain leadership
	// before executing the main loop. Enable this when running replicated
	// components for high availability.
	LeaderElect bool
	// LeaseDuration is the duration that non-leader candidates will wait
	// after observing a leadership renewal until attempting to acquire
	// leadership of a led but unrenewed leader slot. This is effectively the
	// maximum duration that a leader can be stopped before it is replaced
	// by another candidate. This is only applicable if leader election is
	// enabled.
	LeaseDuration metav1.Duration
	// RenewDeadline is the interval between attempts by the acting control plane to
	// renew a leadership slot before it stops leading. This must be less
	// than or equal to the lease duration. This is only applicable if leader
	// election is enabled.
	RenewDeadline metav1.Duration
	// RetryPeriod is the duration the clients should wait between attempting
	// acquisition and renewal of a leadership. This is only applicable if
	// leader election is enabled.
	RetryPeriod metav1.Duration
	// ResourceLock indicates the resource object type that will be used to lock
	// during leader election cycles.
	ResourceLock string
}

LeaderElectionConfiguration defines the configuration of leader election clients for components that can run with leader election enabled.

func GetLeaderElectionConfig

func GetLeaderElectionConfig() *LeaderElectionConfiguration