nodes

Documentation

Index

• Constants
• Variables
• func GetDefaultCredentialsForKind(kind string) ([]string, error)
• func Register(names []string, initFn Initializer)
• func SetDefaultCredentials(kindnames []string, user, password string) error
• func SetNonDefaultRuntimePerKind(kindnames []string, runtime string) error
• type DefaultNode
  • func (d *DefaultNode) Config() *types.NodeConfig
  • func (d *DefaultNode) Delete(ctx context.Context) error
  • func (d *DefaultNode) Deploy(ctx context.Context) error
  • func (d *DefaultNode) GetImages() map[string]string
  • func (d *DefaultNode) GetRuntime() runtime.ContainerRuntime
  • func (d *DefaultNode) PostDeploy(_ context.Context, _ map[string]Node) error
  • func (d *DefaultNode) PreDeploy(_, _, _ string) error
  • func (d *DefaultNode) SaveConfig(_ context.Context) error
  • func (d *DefaultNode) WithMgmtNet(mgmt *types.MgmtNet)
  • func (d *DefaultNode) WithRuntime(r runtime.ContainerRuntime)
• type Initializer
• type Node
• type NodeOption
  • func WithMgmtNet(mgmt *types.MgmtNet) NodeOption
  • func WithRuntime(r runtime.ContainerRuntime) NodeOption

Constants

const (
	// default connection mode for vrnetlab based containers.
	VrDefConnMode = "tc"
	// keys for the map returned by GetImages.
	ImageKey   = "image"
	KernelKey  = "kernel"
	SandboxKey = "sandbox"

	NodeKindBridge = "bridge"

	NodeKindHOST = "host"
	NodeKindOVS  = "ovs-bridge"
	NodeKindSRL  = "srl"
)

Variables

var (
	NodeKind string
	// a map of node kinds overriding the default global runtime.
	NonDefaultRuntimes = map[string]string{}

	// Nodes is a map of all supported kinds and their init functions.
	Nodes = map[string]Initializer{}

	DefaultConfigTemplates = map[string]string{
		"vr-sros": "",
	}

	// ErrCommandExecError is an error returned when a command is failed to execute on a given node.
	ErrCommandExecError = errors.New("command execution error")
)

Functions

func GetDefaultCredentialsForKind

func GetDefaultCredentialsForKind(kind string) ([]string, error)

GetDefaultCredentialsForKind retrieve the default credentials for a certain kind the first element in the slice is the Username, the second is the password.

func Register

func Register(names []string, initFn Initializer)

func SetDefaultCredentials

func SetDefaultCredentials(kindnames []string, user, password string) error

SetDefaultCredentials register default credentials per provided kindname.

func SetNonDefaultRuntimePerKind

func SetNonDefaultRuntimePerKind(kindnames []string, runtime string) error

SetNonDefaultRuntimePerKind sets a non default runtime for kinds that requires that (see cvx).

Types

type DefaultNode

type DefaultNode struct {
	Cfg     *types.NodeConfig
	Mgmt    *types.MgmtNet
	Runtime runtime.ContainerRuntime
}

func (*DefaultNode) Config

func (d *DefaultNode) Config() *types.NodeConfig

func (*DefaultNode) Delete

func (d *DefaultNode) Delete(ctx context.Context) error

func (*DefaultNode) Deploy

func (d *DefaultNode) Deploy(ctx context.Context) error

func (*DefaultNode) GetImages

func (d *DefaultNode) GetImages() map[string]string

func (*DefaultNode) GetRuntime

func (d *DefaultNode) GetRuntime() runtime.ContainerRuntime

func (*DefaultNode) PostDeploy

func (d *DefaultNode) PostDeploy(_ context.Context, _ map[string]Node) error

func (*DefaultNode) PreDeploy

func (d *DefaultNode) PreDeploy(_, _, _ string) error

func (*DefaultNode) SaveConfig

func (d *DefaultNode) SaveConfig(_ context.Context) error

func (*DefaultNode) WithMgmtNet

func (d *DefaultNode) WithMgmtNet(mgmt *types.MgmtNet)

func (*DefaultNode) WithRuntime

func (d *DefaultNode) WithRuntime(r runtime.ContainerRuntime)

type Initializer

type Initializer func() Node

type Node

type Node interface {
	Init(*types.NodeConfig, ...NodeOption) error
	Config() *types.NodeConfig
	PreDeploy(configName, labCADir, labCARoot string) error
	Deploy(context.Context) error
	PostDeploy(context.Context, map[string]Node) error
	WithMgmtNet(*types.MgmtNet)
	WithRuntime(runtime.ContainerRuntime)
	SaveConfig(context.Context) error
	Delete(context.Context) error
	GetImages() map[string]string
	GetRuntime() runtime.ContainerRuntime
}

type NodeOption

type NodeOption func(Node)

func WithMgmtNet

func WithMgmtNet(mgmt *types.MgmtNet) NodeOption

func WithRuntime

func WithRuntime(r runtime.ContainerRuntime) NodeOption