skel

Documentation

Overview

Package skel provides skeleton code for a CNI plugin. In particular, it implements argument parsing and validation.

Index

• func PluginMain(cmdAdd, cmdCheck, cmdDel func(_ *CmdArgs) error, ...)
• func PluginMainWithError(cmdAdd, cmdCheck, cmdDel func(_ *CmdArgs) error, ...) *types.Error
• type CmdArgs

Functions

func PluginMain

func PluginMain(cmdAdd, cmdCheck, cmdDel func(_ *CmdArgs) error, versionInfo version.PluginInfo, about string)

PluginMain is the core "main" for a plugin which includes automatic error handling.

The caller must also specify what CNI spec versions the plugin supports.

The caller can specify an "about" string, which is printed on stderr when no CNI_COMMAND is specified. The recommended output is "CNI plugin <foo> v<version>"

When an error occurs in either cmdAdd, cmdCheck, or cmdDel, PluginMain will print the error as JSON to stdout and call os.Exit(1).

To have more control over error handling, use PluginMainWithError() instead.

func PluginMainWithError

func PluginMainWithError(cmdAdd, cmdCheck, cmdDel func(_ *CmdArgs) error, versionInfo version.PluginInfo, about string) *types.Error

PluginMainWithError is the core "main" for a plugin. It accepts callback functions for add, check, and del CNI commands and returns an error.

The caller must also specify what CNI spec versions the plugin supports.

It is the responsibility of the caller to check for non-nil error return.

For a plugin to comply with the CNI spec, it must print any error to stdout as JSON and then exit with nonzero status code.

To let this package automatically handle errors and call os.Exit(1) for you, use PluginMain() instead.

Types

type CmdArgs

type CmdArgs struct {
	ContainerID string
	Netns       string
	IfName      string
	Args        string
	Path        string
	StdinData   []byte
}

CmdArgs captures all the arguments passed in to the plugin via both env vars and stdin