options

Documentation

Overview

Package options is used to specify options to MCM

Package options is used to specify options to MCM

Index

• func ConvertObjToConfigMap(name string, obj runtime.Object) (*v1.ConfigMap, error)
• type ClientConnectionConfiguration
• type IPVar
  • func (v IPVar) Set(s string) error
  • func (v IPVar) String() string
  • func (v IPVar) Type() string
• type LeaderElectionConfiguration
• type MachineControllerConfiguration
• type PortRangeVar
  • func (v PortRangeVar) Set(s string) error
  • func (v PortRangeVar) String() string
  • func (v PortRangeVar) Type() string
• type SafetyOptions

Functions

func ConvertObjToConfigMap

func ConvertObjToConfigMap(name string, obj runtime.Object) (*v1.ConfigMap, error)

ConvertObjToConfigMap converts an object to a ConfigMap. This is specifically meant for ComponentConfigs.

Types

type ClientConnectionConfiguration

type ClientConnectionConfiguration struct {
	// kubeConfigFile is the path to a kubeconfig file.
	KubeConfigFile string
	// acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the
	// default value of 'application/json'. This field will control all connections to the server used by a particular
	// client.
	AcceptContentTypes string
	// contentType is the content type used when sending data to the server from this client.
	ContentType string
	// qps controls the number of queries per second allowed for this connection.
	QPS float32
	// burst allows extra queries to accumulate when a client is exceeding its rate.
	Burst int
}

ClientConnectionConfiguration contains details for constructing a client.

type IPVar

type IPVar struct {
	Val *string
}

IPVar is used to store the IP Address as a string

func (IPVar) Set

func (v IPVar) Set(s string) error

Set is used to set IPVar

func (IPVar) String

func (v IPVar) String() string

String is used to get IPVar in string format

func (IPVar) Type

func (v IPVar) Type() string

Type is used to determine the type of IPVar

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 master 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.

type MachineControllerConfiguration

type MachineControllerConfiguration struct {
	metav1.TypeMeta

	// namespace in seed cluster in which controller would look for the resources.
	Namespace string

	// port is the port that the controller-manager's http service runs on.
	Port int32
	// address is the IP address to serve on (set to 0.0.0.0 for all interfaces).
	Address string
	// CloudProvider is the provider for cloud services.
	CloudProvider string
	// ConcurrentNodeSyncs is the number of node objects that are
	// allowed to sync concurrently. Larger number = more responsive nodes,
	// but more CPU (and network) load.
	ConcurrentNodeSyncs int32

	// enableProfiling enables profiling via web interface host:port/debug/pprof/
	EnableProfiling bool
	// enableContentionProfiling enables lock contention profiling, if enableProfiling is true.
	EnableContentionProfiling bool
	// contentType is contentType of requests sent to apiserver.
	ContentType string
	// kubeAPIQPS is the QPS to use while talking with kubernetes apiserver.
	KubeAPIQPS float32
	// kubeAPIBurst is the burst to use while talking with kubernetes apiserver.
	KubeAPIBurst int32
	// leaderElection defines the configuration of leader election client.
	LeaderElection mcmoptions.LeaderElectionConfiguration
	// How long to wait between starting controller managers
	ControllerStartInterval metav1.Duration
	// minResyncPeriod is the resync period in reflectors; will be random between
	// minResyncPeriod and 2*minResyncPeriod.
	MinResyncPeriod metav1.Duration

	// SafetyOptions is the set of options to set to ensure safety of controller
	SafetyOptions SafetyOptions

	//NodeCondition is the string of known NodeConditions. If any of these NodeCondition is set for a timeout period, the machine  will be declared failed and will replaced.
	NodeConditions string

	//BootstrapTokenAuthExtraGroups is a comma-separated string of groups to set bootstrap token's "auth-extra-groups" field to.
	BootstrapTokenAuthExtraGroups string
}

MachineControllerConfiguration contains machine configurations +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

type PortRangeVar

type PortRangeVar struct {
	Val *string
}

PortRangeVar is used to store the range of ports

func (PortRangeVar) Set

func (v PortRangeVar) Set(s string) error

Set is used to set the PortRangeVar

func (PortRangeVar) String

func (v PortRangeVar) String() string

String is used to get PortRangeVar in string format

func (PortRangeVar) Type

func (v PortRangeVar) Type() string

Type is used to determine the type of PortRangeVar

type SafetyOptions

type SafetyOptions struct {
	// Timeout (in durartion) used while creation of
	// a machine before it is declared as failed
	MachineCreationTimeout metav1.Duration
	// Timeout (in durartion) used while health-check of
	// a machine before it is declared as failed
	MachineHealthTimeout metav1.Duration
	// Deprecated. No effect. Timeout (in durartion) used while draining of machine before deletion,
	// beyond which it forcefully deletes machine
	MachineDrainTimeout metav1.Duration
	// Maximum number of times evicts would be attempted on a pod for it is forcibly deleted
	// during draining of a machine.
	MaxEvictRetries int32
	// Timeout (in duration) used while waiting for PV to detach
	PvDetachTimeout metav1.Duration
	// Timeout (in duration) used while waiting for PV to reattach on new node
	PvReattachTimeout metav1.Duration

	// Timeout (in duration) for which the APIServer can be down before
	// declare the machine controller frozen by safety controller
	MachineSafetyAPIServerStatusCheckTimeout metav1.Duration
	// Period (in durartion) used to poll for orphan VMs
	// by safety controller
	MachineSafetyOrphanVMsPeriod metav1.Duration
	// Period (in duration) used to poll for APIServer's health
	// by safety controller
	MachineSafetyAPIServerStatusCheckPeriod metav1.Duration

	// APIserverInactiveStartTime to keep track of the
	// start time of when the APIServers were not reachable
	APIserverInactiveStartTime time.Time
	// MachineControllerFrozen indicates if the machine controller
	// is frozen due to Unreachable APIServers
	MachineControllerFrozen bool
}

SafetyOptions are used to configure the upper-limit and lower-limit while configuring freezing of machineSet objects