cli

Documentation

Index

• Variables
• func EnsureDirExists(dir string)
• func RegisterInfo(key string, data map[string]interface{})
• func RunPlugin(name string, plugin server.VersionedInterface, ...)
• func SetLogLevel(level int)
• func VersionCommand() *cobra.Command

Variables

var (
	// Version is the build release identifier.
	Version = "Unspecified"

	// Revision is the build source control revision.
	Revision = "Unspecified"
)

var DefaultLogLevel = len(log.AllLevels) - 2

DefaultLogLevel is the default log level value.

Functions

func EnsureDirExists

func EnsureDirExists(dir string)

EnsureDirExists makes sure the directory where the socket file will be placed exists.

func RegisterInfo

func RegisterInfo(key string, data map[string]interface{})

RegisterInfo allows any packages that use this register additional information to be displayed by the command. For example, a swarm flavor could register the docker api version. This allows us to selectively incorporate only required dependencies based on package registration (in their init()) without explicitly pulling unused dependencies.

func RunPlugin

func RunPlugin(name string, plugin server.VersionedInterface, more ...server.VersionedInterface)

RunPlugin runs a plugin server, advertising with the provided name for discovery. The plugin should conform to the rpc call convention as implemented in the rpc package.

func SetLogLevel

func SetLogLevel(level int)

SetLogLevel adjusts the logrus level.

func VersionCommand

func VersionCommand() *cobra.Command

VersionCommand creates a cobra Command that prints build version information.