antctl

Documentation

Overview

Package antctl provides the antctl framework and antctl command implementations.

Index

• Variables
• type Server
  • func NewLocalServer() (Server, error)

Variables

var CommandList = &commandList{
	definitions: []commandDefinition{
		{
			Use:                 "version",
			Short:               "Print version information",
			Long:                "Print version information of the antctl and the ${component}",
			HandlerFactory:      new(handlers.Version),
			GroupVersion:        &systemGroup,
			TransformedResponse: reflect.TypeOf(transformedVersionResponse{}),
			Agent:               true,
			Controller:          true,
			SingleObject:        true,
			CommandGroup:        flat,
			AddonTransform:      versionTransform,
		},
	},
	codec: scheme.Codecs,
}

CommandList defines all commands that could be used in the antctl for both agent and controller. The unit test "TestCommandListValidation" ensures it to be valid.

Types

type Server

type Server interface {
	// Start runs the antctl server. When invoking this method, either AgentQuerier
	// or ControllerQuerier must be passed, because implementations need to
	// use the value of AgentMonitor and Controller monitor to tell out which
	// component the server is running in. A running server can be stopped by
	// closing the stopCh.
	Start(aq monitor.AgentQuerier, cq monitor.ControllerQuerier, stopCh <-chan struct{})
}

Server defines operations of an antctl server.

func NewLocalServer

func NewLocalServer() (Server, error)

NewLocalServer creates an antctl server which listens on the local domain socket.