Documentation ¶
Overview ¶
Package app implements a server that runs a set of active components. This includes node controllers, service and route controller, and so on.
Index ¶
- Constants
- Variables
- func ConstructControllerInitializers(controllerInitFuncConstructors map[string]ControllerInitFuncConstructor, ...) map[string]InitFunc
- func ControllerNames(controllerInitFuncConstructors map[string]ControllerInitFuncConstructor) []string
- func CreateControllerContext(s *cloudcontrollerconfig.CompletedConfig, ...) (genericcontrollermanager.ControllerContext, error)
- func NewCloudControllerManagerCommand(s *options.CloudControllerManagerOptions, cloudInitializer InitCloudFunc, ...) *cobra.Command
- func NewWebhookHandlers(webhookConfigs map[string]WebhookConfig, ...) map[string]WebhookHandler
- func ResyncPeriod(c *cloudcontrollerconfig.CompletedConfig) func() time.Duration
- func Run(c *cloudcontrollerconfig.CompletedConfig, cloud cloudprovider.Interface, ...) error
- func WebhookNames(webhooks map[string]WebhookConfig) []string
- type CommandBuilder
- func (cb *CommandBuilder) AddFlags(additionalFlags cliflag.NamedFlagSets)
- func (cb *CommandBuilder) BuildCommand() *cobra.Command
- func (cb *CommandBuilder) RegisterController(name string, constructor ControllerInitFuncConstructor, ...)
- func (cb *CommandBuilder) RegisterDefaultControllers()
- func (cb *CommandBuilder) RegisterWebhook(name string, config WebhookConfig)
- func (cb *CommandBuilder) SetCloudInitializer(cloudInitializer InitCloudFunc)
- func (cb *CommandBuilder) SetCmdName(name string)
- func (cb *CommandBuilder) SetLongDesc(long string)
- func (cb *CommandBuilder) SetOptions(options *options.CloudControllerManagerOptions)
- func (cb *CommandBuilder) SetProviderDefaults(defaults options.ProviderDefaults)
- func (cb *CommandBuilder) SetStopChannel(stopCh <-chan struct{})
- type ControllerInitContext
- type ControllerInitFuncConstructor
- type InitCloudFunc
- type InitFunc
- func StartCloudNodeControllerWrapper(initContext ControllerInitContext, ...) InitFunc
- func StartCloudNodeLifecycleControllerWrapper(initContext ControllerInitContext, ...) InitFunc
- func StartRouteControllerWrapper(initContext ControllerInitContext, ...) InitFunc
- func StartServiceControllerWrapper(initContext ControllerInitContext, ...) InitFunc
- type InitFuncConstructor
- type WebhookConfig
- type WebhookHandler
Constants ¶
const ( // ControllerStartJitter is the jitter value used when starting controller managers. ControllerStartJitter = 1.0 // ConfigzName is the name used for register cloud-controller manager /configz, same with GroupName. ConfigzName = "cloudcontrollermanager.config.k8s.io" )
Variables ¶
var ( // ControllersDisabledByDefault is the controller disabled default when starting cloud-controller managers. ControllersDisabledByDefault = sets.NewString() // AllWebhooks represents the list of all webhook options configured in // this package. This is empty because no webhooks are currently // configured in this package. AllWebhooks = []string{} // DisabledByDefaultWebhooks represents the list of webhooks which must be // explicitly enabled. This is empty because no webhooks are currently // configured in this package. DisabledByDefaultWebhooks = []string{} )
var DefaultInitFuncConstructors = map[string]ControllerInitFuncConstructor{ names.CloudNodeController: { InitContext: ControllerInitContext{ ClientName: "node-controller", }, Constructor: StartCloudNodeControllerWrapper, }, names.CloudNodeLifecycleController: { InitContext: ControllerInitContext{ ClientName: "node-controller", }, Constructor: StartCloudNodeLifecycleControllerWrapper, }, names.ServiceLBController: { InitContext: ControllerInitContext{ ClientName: "service-controller", }, Constructor: StartServiceControllerWrapper, }, names.NodeRouteController: { InitContext: ControllerInitContext{ ClientName: "route-controller", }, Constructor: StartRouteControllerWrapper, }, }
DefaultInitFuncConstructors is a map of default named controller groups paired with InitFuncConstructor
var WebhooksDisabledByDefault = sets.NewString()
WebhooksDisabledByDefault is the webhooks disabled default when starting cloud-controller managers.
Functions ¶
func ConstructControllerInitializers ¶ added in v0.20.6
func ConstructControllerInitializers(controllerInitFuncConstructors map[string]ControllerInitFuncConstructor, completedConfig *cloudcontrollerconfig.CompletedConfig, cloud cloudprovider.Interface) map[string]InitFunc
ConstructControllerInitializers is a map of controller name(as defined by controllers flag in https://kubernetes.io/docs/reference/command-line-tools-reference/kube-controller-manager/#options) to their InitFuncConstructor. paired to their InitFunc. This allows for structured downstream composition and subdivision.
func ControllerNames ¶ added in v0.20.6
func ControllerNames(controllerInitFuncConstructors map[string]ControllerInitFuncConstructor) []string
ControllerNames indicate the default controller we are known.
func CreateControllerContext ¶
func CreateControllerContext(s *cloudcontrollerconfig.CompletedConfig, clientBuilder clientbuilder.ControllerClientBuilder, stop <-chan struct{}) (genericcontrollermanager.ControllerContext, error)
CreateControllerContext creates a context struct containing references to resources needed by the controllers such as the cloud provider and clientBuilder. rootClientBuilder is only used for the shared-informers client and token controller.
func NewCloudControllerManagerCommand ¶
func NewCloudControllerManagerCommand(s *options.CloudControllerManagerOptions, cloudInitializer InitCloudFunc, controllerInitFuncConstructors map[string]ControllerInitFuncConstructor, controllerAliases map[string]string, additionalFlags cliflag.NamedFlagSets, stopCh <-chan struct{}) *cobra.Command
NewCloudControllerManagerCommand creates a *cobra.Command object with default parameters controllerInitFuncConstructors is a map of controller name(as defined by controllers flag in https://kubernetes.io/docs/reference/command-line-tools-reference/kube-controller-manager/#options) to their InitFuncConstructor. additionalFlags provides controller specific flags to be included in the complete set of controller manager flags
func NewWebhookHandlers ¶ added in v0.27.0
func NewWebhookHandlers(webhookConfigs map[string]WebhookConfig, completedConfig *config.CompletedConfig, cloud cloudprovider.Interface) map[string]WebhookHandler
func ResyncPeriod ¶
func ResyncPeriod(c *cloudcontrollerconfig.CompletedConfig) func() time.Duration
ResyncPeriod returns a function which generates a duration each time it is invoked; this is so that multiple controllers don't get into lock-step and all hammer the apiserver with list requests simultaneously.
func Run ¶
func Run(c *cloudcontrollerconfig.CompletedConfig, cloud cloudprovider.Interface, controllerInitializers map[string]InitFunc, webhooks map[string]WebhookHandler, stopCh <-chan struct{}) error
Run runs the ExternalCMServer. This should never exit.
func WebhookNames ¶ added in v0.27.0
func WebhookNames(webhooks map[string]WebhookConfig) []string
Types ¶
type CommandBuilder ¶ added in v0.27.0
type CommandBuilder struct {
// contains filtered or unexported fields
}
func NewBuilder ¶ added in v0.27.0
func NewBuilder() *CommandBuilder
func (*CommandBuilder) AddFlags ¶ added in v0.27.0
func (cb *CommandBuilder) AddFlags(additionalFlags cliflag.NamedFlagSets)
func (*CommandBuilder) BuildCommand ¶ added in v0.27.0
func (cb *CommandBuilder) BuildCommand() *cobra.Command
func (*CommandBuilder) RegisterController ¶ added in v0.27.0
func (cb *CommandBuilder) RegisterController(name string, constructor ControllerInitFuncConstructor, aliases map[string]string)
func (*CommandBuilder) RegisterDefaultControllers ¶ added in v0.27.0
func (cb *CommandBuilder) RegisterDefaultControllers()
func (*CommandBuilder) RegisterWebhook ¶ added in v0.27.0
func (cb *CommandBuilder) RegisterWebhook(name string, config WebhookConfig)
func (*CommandBuilder) SetCloudInitializer ¶ added in v0.27.0
func (cb *CommandBuilder) SetCloudInitializer(cloudInitializer InitCloudFunc)
func (*CommandBuilder) SetCmdName ¶ added in v0.27.0
func (cb *CommandBuilder) SetCmdName(name string)
func (*CommandBuilder) SetLongDesc ¶ added in v0.27.0
func (cb *CommandBuilder) SetLongDesc(long string)
func (*CommandBuilder) SetOptions ¶ added in v0.27.0
func (cb *CommandBuilder) SetOptions(options *options.CloudControllerManagerOptions)
func (*CommandBuilder) SetProviderDefaults ¶ added in v0.27.0
func (cb *CommandBuilder) SetProviderDefaults(defaults options.ProviderDefaults)
SetProviderDefaults can be called to change the default values for some options when a flag is not set
func (*CommandBuilder) SetStopChannel ¶ added in v0.27.0
func (cb *CommandBuilder) SetStopChannel(stopCh <-chan struct{})
type ControllerInitContext ¶ added in v0.23.0
type ControllerInitContext struct {
ClientName string
}
type ControllerInitFuncConstructor ¶ added in v0.23.0
type ControllerInitFuncConstructor struct { InitContext ControllerInitContext Constructor InitFuncConstructor }
type InitCloudFunc ¶ added in v0.20.6
type InitCloudFunc func(config *cloudcontrollerconfig.CompletedConfig) cloudprovider.Interface
InitCloudFunc is used to initialize cloud
type InitFunc ¶
type InitFunc func(ctx context.Context, controllerContext genericcontrollermanager.ControllerContext) (controller controller.Interface, enabled bool, err error)
InitFunc is used to launch a particular controller. It returns a controller that can optionally implement other interfaces so that the controller manager can support the requested features. The returned controller may be nil, which will be considered an anonymous controller that requests no additional features from the controller manager. Any error returned will cause the controller process to `Fatal` The bool indicates whether the controller was enabled.
func StartCloudNodeControllerWrapper ¶
func StartCloudNodeControllerWrapper(initContext ControllerInitContext, completedConfig *cloudcontrollerconfig.CompletedConfig, cloud cloudprovider.Interface) InitFunc
StartCloudNodeControllerWrapper is used to take cloud config as input and start cloud node controller
func StartCloudNodeLifecycleControllerWrapper ¶ added in v0.23.0
func StartCloudNodeLifecycleControllerWrapper(initContext ControllerInitContext, completedConfig *cloudcontrollerconfig.CompletedConfig, cloud cloudprovider.Interface) InitFunc
StartCloudNodeLifecycleControllerWrapper is used to take cloud config as input and start cloud node lifecycle controller
func StartRouteControllerWrapper ¶ added in v0.23.0
func StartRouteControllerWrapper(initContext ControllerInitContext, completedConfig *cloudcontrollerconfig.CompletedConfig, cloud cloudprovider.Interface) InitFunc
StartRouteControllerWrapper is used to take cloud config as input and start route controller
func StartServiceControllerWrapper ¶ added in v0.23.0
func StartServiceControllerWrapper(initContext ControllerInitContext, completedConfig *cloudcontrollerconfig.CompletedConfig, cloud cloudprovider.Interface) InitFunc
StartServiceControllerWrapper is used to take cloud config as input and start service controller
type InitFuncConstructor ¶ added in v0.20.6
type InitFuncConstructor func(initcontext ControllerInitContext, completedConfig *cloudcontrollerconfig.CompletedConfig, cloud cloudprovider.Interface) InitFunc
InitFuncConstructor is used to construct InitFunc
type WebhookConfig ¶ added in v0.27.0
type WebhookConfig struct { Path string AdmissionHandler func(*admissionv1.AdmissionRequest) (*admissionv1.AdmissionResponse, error) }
type WebhookHandler ¶ added in v0.27.0
type WebhookHandler struct { Name string Path string http.Handler AdmissionHandler func(*admissionv1.AdmissionRequest) (*admissionv1.AdmissionResponse, error) CompletedConfig *config.CompletedConfig Cloud cloudprovider.Interface }
func (WebhookHandler) ServeHTTP ¶ added in v0.27.0
func (h WebhookHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)