rootcmd

Documentation

Overview

Package rootcmd implements the cobra.Command that manages the controller manager lifecycle.

Index

• Constants
• func Execute()
• func GetRootCmd(cfg *manager.Config) *cobra.Command
• func GetVersionCmd() *cobra.Command
• func Run(ctx context.Context, c *manager.Config, output io.Writer) error
• func RunWithLogger(ctx context.Context, c *manager.Config, deprecatedLogger logrus.FieldLogger, ...) error
• func SetupSignalHandler(ctx context.Context, cfg *manager.Config, logger logr.Logger) (context.Context, error)
• func StartDiagnosticsServer(ctx context.Context, port int, c *manager.Config, logger logr.Logger) (diagnostics.Server, error)

Constants

const (
	// DiagnosticConfigBufferDepth is the size of the channel buffer for receiving diagnostic
	// config dumps from the proxy sync loop. The chosen size is essentially arbitrary: we don't
	// expect that the receive end will get backlogged (it only assigns the value to a local
	// variable) but do want a small amount of leeway to account for goroutine scheduling, so it
	// is not zero.
	DiagnosticConfigBufferDepth = 3
)

Functions

func Execute

func Execute()

Execute is the entry point to the controller manager.

func GetRootCmd

func GetRootCmd(cfg *manager.Config) *cobra.Command

func GetVersionCmd

func GetVersionCmd() *cobra.Command

func Run

func Run(ctx context.Context, c *manager.Config, output io.Writer) error

Run sets up a default stderr logger and starts the controller manager.

func RunWithLogger

func RunWithLogger(ctx context.Context, c *manager.Config, deprecatedLogger logrus.FieldLogger, logger logr.Logger) error

RunWithLogger starts the controller manager with a provided logger.

func SetupSignalHandler

func SetupSignalHandler(ctx context.Context, cfg *manager.Config, logger logr.Logger) (context.Context, error)

SetupSignalHandler registers for SIGTERM and SIGINT. A context is returned which is canceled on one of these signals. If a second signal is not caught, the program will delay for the configured period of time before terminating. If a second signal is caught, the program is terminated with exit code 1.

func StartDiagnosticsServer

func StartDiagnosticsServer(
	ctx context.Context,
	port int,
	c *manager.Config,
	logger logr.Logger,
) (diagnostics.Server, error)

StartDiagnosticsServer starts a goroutine that handles requests for the diagnostics server.