package options

import "k8s.io/kubernetes/cmd/kube-controller-manager/app/options"

Package options provides the flags used for the controller manager.

Index

Constants

const (
	// KubeControllerManagerUserAgent is the userAgent name when starting kube-controller managers.
	KubeControllerManagerUserAgent = "kube-controller-manager"
)

Functions

func NewDefaultComponentConfig

func NewDefaultComponentConfig() (kubectrlmgrconfig.KubeControllerManagerConfiguration, error)

NewDefaultComponentConfig returns kube-controller manager configuration object.

Types

type AttachDetachControllerOptions

type AttachDetachControllerOptions struct {
	*attachdetachconfig.AttachDetachControllerConfiguration
}

AttachDetachControllerOptions holds the AttachDetachController options.

func (*AttachDetachControllerOptions) AddFlags

func (o *AttachDetachControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to AttachDetachController for controller manager to the specified FlagSet.

func (*AttachDetachControllerOptions) ApplyTo

ApplyTo fills up AttachDetachController config with options.

func (*AttachDetachControllerOptions) Validate

func (o *AttachDetachControllerOptions) Validate() []error

Validate checks validation of AttachDetachControllerOptions.

type CSRSigningControllerOptions

type CSRSigningControllerOptions struct {
	*csrsigningconfig.CSRSigningControllerConfiguration
}

CSRSigningControllerOptions holds the CSRSigningController options.

func (*CSRSigningControllerOptions) AddFlags

func (o *CSRSigningControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to CSRSigningController for controller manager to the specified FlagSet.

func (*CSRSigningControllerOptions) ApplyTo

ApplyTo fills up CSRSigningController config with options.

func (*CSRSigningControllerOptions) Validate

func (o *CSRSigningControllerOptions) Validate() []error

Validate checks validation of CSRSigningControllerOptions.

type CronJobControllerOptions

type CronJobControllerOptions struct {
	*cronjobconfig.CronJobControllerConfiguration
}

CronJobControllerOptions holds the CronJobController options.

func (*CronJobControllerOptions) AddFlags

func (o *CronJobControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to JobController for controller manager to the specified FlagSet.

func (*CronJobControllerOptions) ApplyTo

ApplyTo fills up JobController config with options.

func (*CronJobControllerOptions) Validate

func (o *CronJobControllerOptions) Validate() []error

Validate checks validation of CronJobControllerOptions.

type DaemonSetControllerOptions

type DaemonSetControllerOptions struct {
	*daemonconfig.DaemonSetControllerConfiguration
}

DaemonSetControllerOptions holds the DaemonSetController options.

func (*DaemonSetControllerOptions) AddFlags

func (o *DaemonSetControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to DaemonSetController for controller manager to the specified FlagSet.

func (*DaemonSetControllerOptions) ApplyTo

ApplyTo fills up DaemonSetController config with options.

func (*DaemonSetControllerOptions) Validate

func (o *DaemonSetControllerOptions) Validate() []error

Validate checks validation of DaemonSetControllerOptions.

type DeploymentControllerOptions

type DeploymentControllerOptions struct {
	*deploymentconfig.DeploymentControllerConfiguration
}

DeploymentControllerOptions holds the DeploymentController options.

func (*DeploymentControllerOptions) AddFlags

func (o *DeploymentControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to DeploymentController for controller manager to the specified FlagSet.

func (*DeploymentControllerOptions) ApplyTo

ApplyTo fills up DeploymentController config with options.

func (*DeploymentControllerOptions) Validate

func (o *DeploymentControllerOptions) Validate() []error

Validate checks validation of DeploymentControllerOptions.

type DeprecatedControllerOptions

type DeprecatedControllerOptions struct {
	*kubectrlmgrconfig.DeprecatedControllerConfiguration
}

DeprecatedControllerOptions holds the DeprecatedController options, those option are deprecated. TODO remove these fields once the deprecated flags are removed.

func (*DeprecatedControllerOptions) AddFlags

func (o *DeprecatedControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to DeprecatedController for controller manager to the specified FlagSet.

func (*DeprecatedControllerOptions) ApplyTo

ApplyTo fills up DeprecatedController config with options.

func (*DeprecatedControllerOptions) Validate

func (o *DeprecatedControllerOptions) Validate() []error

Validate checks validation of DeprecatedControllerOptions.

type EndpointControllerOptions

type EndpointControllerOptions struct {
	*endpointconfig.EndpointControllerConfiguration
}

EndpointControllerOptions holds the EndPointController options.

func (*EndpointControllerOptions) AddFlags

func (o *EndpointControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to EndPointController for controller manager to the specified FlagSet.

func (*EndpointControllerOptions) ApplyTo

ApplyTo fills up EndPointController config with options.

func (*EndpointControllerOptions) Validate

func (o *EndpointControllerOptions) Validate() []error

Validate checks validation of EndpointControllerOptions.

type EndpointSliceControllerOptions

type EndpointSliceControllerOptions struct {
	*endpointsliceconfig.EndpointSliceControllerConfiguration
}

EndpointSliceControllerOptions holds the EndpointSliceController options.

func (*EndpointSliceControllerOptions) AddFlags

func (o *EndpointSliceControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to EndpointSliceController for controller manager to the specified FlagSet.

func (*EndpointSliceControllerOptions) ApplyTo

ApplyTo fills up EndpointSliceController config with options.

func (*EndpointSliceControllerOptions) Validate

func (o *EndpointSliceControllerOptions) Validate() []error

Validate checks validation of EndpointSliceControllerOptions.

type EndpointSliceMirroringControllerOptions

type EndpointSliceMirroringControllerOptions struct {
	*endpointslicemirroringconfig.EndpointSliceMirroringControllerConfiguration
}

EndpointSliceMirroringControllerOptions holds the EndpointSliceMirroringController options.

func (*EndpointSliceMirroringControllerOptions) AddFlags

AddFlags adds flags related to EndpointSliceMirroringController for controller manager to the specified FlagSet.

func (*EndpointSliceMirroringControllerOptions) ApplyTo

ApplyTo fills up EndpointSliceMirroringController config with options.

func (*EndpointSliceMirroringControllerOptions) Validate

Validate checks validation of EndpointSliceMirroringControllerOptions.

type EphemeralVolumeControllerOptions

type EphemeralVolumeControllerOptions struct {
	*ephemeralvolumeconfig.EphemeralVolumeControllerConfiguration
}

EphemeralVolumeControllerOptions holds the EphemeralVolumeController options.

func (*EphemeralVolumeControllerOptions) AddFlags

AddFlags adds flags related to EphemeralVolumeController for controller manager to the specified FlagSet.

func (*EphemeralVolumeControllerOptions) ApplyTo

ApplyTo fills up EphemeralVolumeController config with options.

func (*EphemeralVolumeControllerOptions) Validate

func (o *EphemeralVolumeControllerOptions) Validate() []error

Validate checks validation of EphemeralVolumeControllerOptions.

type GarbageCollectorControllerOptions

type GarbageCollectorControllerOptions struct {
	*garbagecollectorconfig.GarbageCollectorControllerConfiguration
}

GarbageCollectorControllerOptions holds the GarbageCollectorController options.

func (*GarbageCollectorControllerOptions) AddFlags

AddFlags adds flags related to GarbageCollectorController for controller manager to the specified FlagSet.

func (*GarbageCollectorControllerOptions) ApplyTo

ApplyTo fills up GarbageCollectorController config with options.

func (*GarbageCollectorControllerOptions) Validate

func (o *GarbageCollectorControllerOptions) Validate() []error

Validate checks validation of GarbageCollectorController.

type HPAControllerOptions

type HPAControllerOptions struct {
	*poautosclerconfig.HPAControllerConfiguration
}

HPAControllerOptions holds the HPAController options.

func (*HPAControllerOptions) AddFlags

func (o *HPAControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to HPAController for controller manager to the specified FlagSet.

func (*HPAControllerOptions) ApplyTo

ApplyTo fills up HPAController config with options.

func (*HPAControllerOptions) Validate

func (o *HPAControllerOptions) Validate() []error

Validate checks validation of HPAControllerOptions.

type JobControllerOptions

type JobControllerOptions struct {
	*jobconfig.JobControllerConfiguration
}

JobControllerOptions holds the JobController options.

func (*JobControllerOptions) AddFlags

func (o *JobControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to JobController for controller manager to the specified FlagSet.

func (*JobControllerOptions) ApplyTo

ApplyTo fills up JobController config with options.

func (*JobControllerOptions) Validate

func (o *JobControllerOptions) Validate() []error

Validate checks validation of JobControllerOptions.

type KubeControllerManagerOptions

type KubeControllerManagerOptions struct {
	Generic           *cmoptions.GenericControllerManagerConfigurationOptions
	KubeCloudShared   *cpoptions.KubeCloudSharedOptions
	ServiceController *cpoptions.ServiceControllerOptions

	AttachDetachController                    *AttachDetachControllerOptions
	CSRSigningController                      *CSRSigningControllerOptions
	DaemonSetController                       *DaemonSetControllerOptions
	DeploymentController                      *DeploymentControllerOptions
	StatefulSetController                     *StatefulSetControllerOptions
	DeprecatedFlags                           *DeprecatedControllerOptions
	EndpointController                        *EndpointControllerOptions
	EndpointSliceController                   *EndpointSliceControllerOptions
	EndpointSliceMirroringController          *EndpointSliceMirroringControllerOptions
	EphemeralVolumeController                 *EphemeralVolumeControllerOptions
	GarbageCollectorController                *GarbageCollectorControllerOptions
	HPAController                             *HPAControllerOptions
	JobController                             *JobControllerOptions
	CronJobController                         *CronJobControllerOptions
	LegacySATokenCleaner                      *LegacySATokenCleanerOptions
	NamespaceController                       *NamespaceControllerOptions
	NodeIPAMController                        *NodeIPAMControllerOptions
	NodeLifecycleController                   *NodeLifecycleControllerOptions
	PersistentVolumeBinderController          *PersistentVolumeBinderControllerOptions
	PodGCController                           *PodGCControllerOptions
	ReplicaSetController                      *ReplicaSetControllerOptions
	ReplicationController                     *ReplicationControllerOptions
	ResourceQuotaController                   *ResourceQuotaControllerOptions
	SAController                              *SAControllerOptions
	TTLAfterFinishedController                *TTLAfterFinishedControllerOptions
	ValidatingAdmissionPolicyStatusController *ValidatingAdmissionPolicyStatusControllerOptions

	SecureServing  *apiserveroptions.SecureServingOptionsWithLoopback
	Authentication *apiserveroptions.DelegatingAuthenticationOptions
	Authorization  *apiserveroptions.DelegatingAuthorizationOptions
	Metrics        *metrics.Options
	Logs           *logs.Options

	Master                      string
	ShowHiddenMetricsForVersion string

	// ComponentGlobalsRegistry is the registry where the effective versions and feature gates for all components are stored.
	ComponentGlobalsRegistry basecompatibility.ComponentGlobalsRegistry

	// Parsedflags holds the parsed CLI flags.
	ParsedFlags *cliflag.NamedFlagSets
}

KubeControllerManagerOptions is the main context object for the kube-controller manager.

func NewKubeControllerManagerOptions

func NewKubeControllerManagerOptions() (*KubeControllerManagerOptions, error)

NewKubeControllerManagerOptions creates a new KubeControllerManagerOptions with a default config.

func (*KubeControllerManagerOptions) ApplyTo

func (s *KubeControllerManagerOptions) ApplyTo(c *kubecontrollerconfig.Config, allControllers []string, disabledByDefaultControllers []string, controllerAliases map[string]string) error

ApplyTo fills up controller manager config with options.

func (KubeControllerManagerOptions) Config

func (s KubeControllerManagerOptions) Config(allControllers []string, disabledByDefaultControllers []string, controllerAliases map[string]string) (*kubecontrollerconfig.Config, error)

Config return a controller manager config objective

func (*KubeControllerManagerOptions) Flags

func (s *KubeControllerManagerOptions) Flags(allControllers []string, disabledByDefaultControllers []string, controllerAliases map[string]string) cliflag.NamedFlagSets

Flags returns flags for a specific KubeController by section name

func (*KubeControllerManagerOptions) Validate

func (s *KubeControllerManagerOptions) Validate(allControllers []string, disabledByDefaultControllers []string, controllerAliases map[string]string) error

Validate is used to validate the options and config before launching the controller manager

type LegacySATokenCleanerOptions

type LegacySATokenCleanerOptions struct {
	*serviceaccountconfig.LegacySATokenCleanerConfiguration
}

LegacySATokenCleanerOptions holds the LegacySATokenCleaner options.

func (*LegacySATokenCleanerOptions) AddFlags

func (o *LegacySATokenCleanerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to LegacySATokenCleaner for controller manager to the specified FlagSet

func (*LegacySATokenCleanerOptions) ApplyTo

ApplyTo fills up LegacySATokenCleaner config with options.

func (*LegacySATokenCleanerOptions) Validate

func (o *LegacySATokenCleanerOptions) Validate() []error

Validate checks validation of LegacySATokenCleanerOptions.

type NamespaceControllerOptions

type NamespaceControllerOptions struct {
	*namespaceconfig.NamespaceControllerConfiguration
}

NamespaceControllerOptions holds the NamespaceController options.

func (*NamespaceControllerOptions) AddFlags

func (o *NamespaceControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to NamespaceController for controller manager to the specified FlagSet.

func (*NamespaceControllerOptions) ApplyTo

ApplyTo fills up NamespaceController config with options.

func (*NamespaceControllerOptions) Validate

func (o *NamespaceControllerOptions) Validate() []error

Validate checks validation of NamespaceControllerOptions.

type NodeIPAMControllerOptions

type NodeIPAMControllerOptions struct {
	*nodeipamconfig.NodeIPAMControllerConfiguration
}

NodeIPAMControllerOptions holds the NodeIpamController options.

func (*NodeIPAMControllerOptions) AddFlags

func (o *NodeIPAMControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to NodeIpamController for controller manager to the specified FlagSet.

func (*NodeIPAMControllerOptions) ApplyTo

ApplyTo fills up NodeIpamController config with options.

func (*NodeIPAMControllerOptions) Validate

func (o *NodeIPAMControllerOptions) Validate() []error

Validate checks validation of NodeIPAMControllerOptions.

type NodeLifecycleControllerOptions

type NodeLifecycleControllerOptions struct {
	*nodelifecycleconfig.NodeLifecycleControllerConfiguration
}

NodeLifecycleControllerOptions holds the NodeLifecycleController options.

func (*NodeLifecycleControllerOptions) AddFlags

func (o *NodeLifecycleControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to NodeLifecycleController for controller manager to the specified FlagSet.

func (*NodeLifecycleControllerOptions) ApplyTo

ApplyTo fills up NodeLifecycleController config with options.

func (*NodeLifecycleControllerOptions) Validate

func (o *NodeLifecycleControllerOptions) Validate() []error

Validate checks validation of NodeLifecycleControllerOptions.

type PersistentVolumeBinderControllerOptions

type PersistentVolumeBinderControllerOptions struct {
	*persistentvolumeconfig.PersistentVolumeBinderControllerConfiguration
}

PersistentVolumeBinderControllerOptions holds the PersistentVolumeBinderController options.

func (*PersistentVolumeBinderControllerOptions) AddFlags

AddFlags adds flags related to PersistentVolumeBinderController for controller manager to the specified FlagSet.

func (*PersistentVolumeBinderControllerOptions) ApplyTo

ApplyTo fills up PersistentVolumeBinderController config with options.

func (*PersistentVolumeBinderControllerOptions) Validate

Validate checks validation of PersistentVolumeBinderControllerOptions.

type PodGCControllerOptions

type PodGCControllerOptions struct {
	*podgcconfig.PodGCControllerConfiguration
}

PodGCControllerOptions holds the PodGCController options.

func (*PodGCControllerOptions) AddFlags

func (o *PodGCControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to PodGCController for controller manager to the specified FlagSet.

func (*PodGCControllerOptions) ApplyTo

ApplyTo fills up PodGCController config with options.

func (*PodGCControllerOptions) Validate

func (o *PodGCControllerOptions) Validate() []error

Validate checks validation of PodGCControllerOptions.

type ReplicaSetControllerOptions

type ReplicaSetControllerOptions struct {
	*replicasetconfig.ReplicaSetControllerConfiguration
}

ReplicaSetControllerOptions holds the ReplicaSetController options.

func (*ReplicaSetControllerOptions) AddFlags

func (o *ReplicaSetControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to ReplicaSetController for controller manager to the specified FlagSet.

func (*ReplicaSetControllerOptions) ApplyTo

ApplyTo fills up ReplicaSetController config with options.

func (*ReplicaSetControllerOptions) Validate

func (o *ReplicaSetControllerOptions) Validate() []error

Validate checks validation of ReplicaSetControllerOptions.

type ReplicationControllerOptions

type ReplicationControllerOptions struct {
	*replicationconfig.ReplicationControllerConfiguration
}

ReplicationControllerOptions holds the ReplicationController options.

func (*ReplicationControllerOptions) AddFlags

func (o *ReplicationControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to ReplicationController for controller manager to the specified FlagSet.

func (*ReplicationControllerOptions) ApplyTo

ApplyTo fills up ReplicationController config with options.

func (*ReplicationControllerOptions) Validate

func (o *ReplicationControllerOptions) Validate() []error

Validate checks validation of ReplicationControllerOptions.

type ResourceQuotaControllerOptions

type ResourceQuotaControllerOptions struct {
	*resourcequotaconfig.ResourceQuotaControllerConfiguration
}

ResourceQuotaControllerOptions holds the ResourceQuotaController options.

func (*ResourceQuotaControllerOptions) AddFlags

func (o *ResourceQuotaControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to ResourceQuotaController for controller manager to the specified FlagSet.

func (*ResourceQuotaControllerOptions) ApplyTo

ApplyTo fills up ResourceQuotaController config with options.

func (*ResourceQuotaControllerOptions) Validate

func (o *ResourceQuotaControllerOptions) Validate() []error

Validate checks validation of ResourceQuotaControllerOptions.

type SAControllerOptions

type SAControllerOptions struct {
	*serviceaccountconfig.SAControllerConfiguration
}

SAControllerOptions holds the ServiceAccountController options.

func (*SAControllerOptions) AddFlags

func (o *SAControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to ServiceAccountController for controller manager to the specified FlagSet

func (*SAControllerOptions) ApplyTo

ApplyTo fills up ServiceAccountController config with options.

func (*SAControllerOptions) Validate

func (o *SAControllerOptions) Validate() []error

Validate checks validation of ServiceAccountControllerOptions.

type StatefulSetControllerOptions

type StatefulSetControllerOptions struct {
	*statefulsetconfig.StatefulSetControllerConfiguration
}

StatefulSetControllerOptions holds the StatefulSetController options.

func (*StatefulSetControllerOptions) AddFlags

func (o *StatefulSetControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to StatefulSetController for controller manager to the specified FlagSet.

func (*StatefulSetControllerOptions) ApplyTo

ApplyTo fills up StatefulSetController config with options.

func (*StatefulSetControllerOptions) Validate

func (o *StatefulSetControllerOptions) Validate() []error

Validate checks validation of StatefulSetControllerOptions.

type TTLAfterFinishedControllerOptions

type TTLAfterFinishedControllerOptions struct {
	*ttlafterfinishedconfig.TTLAfterFinishedControllerConfiguration
}

TTLAfterFinishedControllerOptions holds the TTLAfterFinishedController options.

func (*TTLAfterFinishedControllerOptions) AddFlags

AddFlags adds flags related to TTLAfterFinishedController for controller manager to the specified FlagSet.

func (*TTLAfterFinishedControllerOptions) ApplyTo

ApplyTo fills up TTLAfterFinishedController config with options.

func (*TTLAfterFinishedControllerOptions) Validate

func (o *TTLAfterFinishedControllerOptions) Validate() []error

Validate checks validation of TTLAfterFinishedControllerOptions.

type ValidatingAdmissionPolicyStatusControllerOptions

type ValidatingAdmissionPolicyStatusControllerOptions struct {
	*validatingadmissionpolicystatusconfig.ValidatingAdmissionPolicyStatusControllerConfiguration
}

ValidatingAdmissionPolicyStatusControllerOptions holds the ValidatingAdmissionPolicyStatusController options.

func (*ValidatingAdmissionPolicyStatusControllerOptions) AddFlags

AddFlags adds flags related to ValidatingAdmissionPolicyStatusController for controller manager to the specified FlagSet.

func (*ValidatingAdmissionPolicyStatusControllerOptions) ApplyTo

ApplyTo fills up ValidatingAdmissionPolicyStatusController config with options.

func (*ValidatingAdmissionPolicyStatusControllerOptions) Validate

Validate checks validation of ValidatingAdmissionPolicyStatusControllerOptions.

Source Files

attachdetachcontroller.go cronjobcontroller.go csrsigningcontroller.go daemonsetcontroller.go deploymentcontroller.go deprecatedcontroller.go endpointcontroller.go endpointslicecontroller.go endpointslicemirroringcontroller.go ephemeralcontroller.go garbagecollectorcontroller.go hpacontroller.go jobcontroller.go legacyserviceaccounttokencleaner.go namespacecontroller.go nodeipamcontroller.go nodelifecyclecontroller.go options.go persistentvolumebindercontroller.go podgccontroller.go replicasetcontroller.go replicationcontroller.go resourcequotacontroller.go serviceaccountcontroller.go statefulsetcontroller.go ttlafterfinishedcontroller.go validatingadmissionpolicycontroller.go

Version
v1.33.0 (latest)
Published
Apr 23, 2025
Platform
linux/amd64
Imports
60 packages
Last checked
3 hours ago

Tools for package owners.