local

Documentation

Overview

Package local defines flavor used for VPP agents managed only locally.

Index

• func NewAgent(opts ...core.Option) *core.Agent
• func WithPlugins(listPlugins func(local *FlavorVppLocal) []*core.NamedPlugin) core.WithPluginsOpt
• type FlavorVppLocal
  • func (f *FlavorVppLocal) Inject() bool
  • func (f *FlavorVppLocal) Plugins() []*core.NamedPlugin

Functions

func NewAgent

func NewAgent(opts ...core.Option) *core.Agent

NewAgent returns a new instance of the Agent with plugins. It is an alias for core.NewAgent() to implicit use of the FlavorVppLocal

func WithPlugins

func WithPlugins(listPlugins func(local *FlavorVppLocal) []*core.NamedPlugin) core.WithPluginsOpt

WithPlugins for adding custom plugins to SFC Controller <listPlugins> is a callback that uses flavor input to inject dependencies for custom plugins that are in output

Example:

   NewAgent(vppFlavor.WithPlugins(func(flavor) {
	       return []*core.NamedPlugin{{"my-plugin", &MyPlugin{DependencyXY: &flavor.FlavorXY}}}
   }))

Types

type FlavorVppLocal

type FlavorVppLocal struct {
	*local.FlavorLocal
	LinuxLocalClient localclient.Plugin
	GoVPP            govppmux.GOVPPPlugin
	Linux            linux.Plugin
	VPP              vpp.Plugin
	// contains filtered or unexported fields
}

FlavorVppLocal glues together multiple plugins to manage VPP and Linux configuration using the local client.

func (*FlavorVppLocal) Inject

func (f *FlavorVppLocal) Inject() bool

Inject sets inter-plugin references.

func (*FlavorVppLocal) Plugins

func (f *FlavorVppLocal) Plugins() []*core.NamedPlugin

Plugins combines all Plugins in the flavor to a list.