l3plugin

package
v1.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 4, 2019 License: Apache-2.0 Imports: 19 Imported by: 0

README

L3 plugin

The l3plugin is a Core Agent Plugin that is designed to configure ARP entries and routes in the VPP. Configuration managed by this plugin is modelled by the proto file.

ARP entries

The configuration must be stored in etcd using the following key:

/vnf-agent/<agent-label>/vpp/config/v1/arp/<interface>/<ip-address>

An example of configuration in json format can be found here.

To insert config into etcd in json format vpp-agent-ctl can be used. We assume that we want to configure vpp with label vpp1 and config is stored in the arp.json file

vpp-agent-ctl -put "/vnf-agent/vpp1/vpp/config/v1/arp/tap1/192.168.10.21" json/arp.json

The vpp-agent-ctl also contains a simple predefined ARP entry config. It can be used for testing purposes. To setup the predefined ARP config run:

vpp-agent-ctl -arp

To remove it run:

vpp-agent-ctl -arpd

Proxy ARP

Proxy ARP configuration is composed from two parts; interfaces that are enabled and IP address ranges. Both of these configuration types are stored under separate keys.

For proxy arp interface array, use key:

/vnf-agent/<agent-label>/vpp/config/v1/proxyarp/interface/<if-cfg-label>

For proxy arp ranges:

/vnf-agent/<agent-label>/vpp/config/v1/proxyarp/range/<rng-cfg-label>

An example configuration for interfaces can be found here. An example configuration for IP ranges can be found here.

Predefined configuration in vpp-agent-ctl for interfaces:

vpp-agent-ctl -prxi

For ranges:

vpp-agent-ctl -prxd

Routes

The configuration must be stored in etcd using the following key:

/vnf-agent/<agent-label>/vpp/config/v1/vrf/0/fib/

An example of configuration in json format can be found here.

Note: Value 0 in vrfID field denotes default VRF in vpp. Since it is default value it is omitted in the config above. If you want to configure a route for a VRF other than default, make sure that the VRF has already been created.

To insert config into etcd in json format vpp-agent-ctl can be used. We assume that we want to configure vpp with label vpp1 and config is stored in the routes.json file

vpp-agent-ctl -put "/vnf-agent/vpp1/vpp/config/v1/vrf/0/fib" json/routes.json

The vpp-agent-ctl contains a simple predefined route config also. It can be used for testing purposes. To setup the predefined route config run:

vpp-agent-ctl -route

To remove it run:

vpp-agent-ctl -routed

Documentation

Overview

Package l3plugin implements the L3 plugin that handles L3 FIBs.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ArpConfigurator 

type ArpConfigurator struct {
	// contains filtered or unexported fields
}

ArpConfigurator runs in the background in its own goroutine where it watches for any changes in the configuration of L3 arp entries as modelled by the proto file "../model/l3/l3.proto" and stored in ETCD under the key "/vnf-agent/{vnf-agent}/vpp/config/v1/arp". Updates received from the northbound API are compared with the VPP run-time configuration and differences are applied through the VPP binary API.

func (*ArpConfigurator) AddArp 

func (c *ArpConfigurator) AddArp(entry *l3.ArpTable_ArpEntry) error

AddArp processes the NB config and propagates it to bin api call

func (*ArpConfigurator) ChangeArp 

func (c *ArpConfigurator) ChangeArp(entry *l3.ArpTable_ArpEntry, prevEntry *l3.ArpTable_ArpEntry) error

ChangeArp processes the NB config and propagates it to bin api call

func (*ArpConfigurator) Close 

func (c *ArpConfigurator) Close() error

Close GOVPP channel

func (*ArpConfigurator) DeleteArp 

func (c *ArpConfigurator) DeleteArp(entry *l3.ArpTable_ArpEntry) error

DeleteArp processes the NB config and propagates it to bin api call

func (*ArpConfigurator) GetArpCache 

func (c *ArpConfigurator) GetArpCache() l3idx.ARPIndexRW

GetArpCache exposes list of cached ARP entries (present in ETCD but not in VPP)

func (*ArpConfigurator) GetArpDeleted 

func (c *ArpConfigurator) GetArpDeleted() l3idx.ARPIndexRW

GetArpDeleted exposes arppDeleted mapping (unsuccessfully deleted ARP entries)

func (*ArpConfigurator) GetArpIndexes 

func (c *ArpConfigurator) GetArpIndexes() l3idx.ARPIndexRW

GetArpIndexes exposes arpIndexes mapping

func (*ArpConfigurator) Init 

func (c *ArpConfigurator) Init(logger logging.PluginLogger, goVppMux govppmux.API, swIfIndexes ifaceidx.SwIfIndex) (err error)

Init initializes ARP configurator

func (*ArpConfigurator) LogError added in v1.8.1 

func (c *ArpConfigurator) LogError(err error) error

LogError prints error if not nil, including stack trace. The same value is also returned, so it can be easily propagated further

func (*ArpConfigurator) ResolveCreatedInterface 

func (c *ArpConfigurator) ResolveCreatedInterface(ifName string) error

ResolveCreatedInterface handles case when new interface appears in the config

func (*ArpConfigurator) ResolveDeletedInterface 

func (c *ArpConfigurator) ResolveDeletedInterface(interfaceName string, interfaceIdx uint32) error

ResolveDeletedInterface handles case when interface is removed from the config

func (*ArpConfigurator) Resync 

func (c *ArpConfigurator) Resync(arpEntries []*l3.ArpTable_ArpEntry) error

Resync confgures the empty VPP (overwrites the arp entries)

type IPNeighConfigurator added in v1.8.1 

type IPNeighConfigurator struct {
	// contains filtered or unexported fields
}

IPNeighConfigurator runs in the background in its own goroutine where it watches for any changes in the configuration of L3 IP scan neighbor, as modelled by the proto file "../model/l3/l3.proto" and stored in ETCD under the key "/vnf-agent/{vnf-agent}/vpp/config/v1/ipneigh". Configuration uses single key, since the configuration is global-like.

func (*IPNeighConfigurator) Close added in v1.8.1 

func (c *IPNeighConfigurator) Close() error

Close VPP channel

func (*IPNeighConfigurator) Init added in v1.8.1 

func (c *IPNeighConfigurator) Init(logger logging.PluginLogger, goVppMux govppmux.API) (err error)

Init VPP channel and vppcalls handler

func (*IPNeighConfigurator) LogError added in v1.8.1 

func (c *IPNeighConfigurator) LogError(err error) error

LogError prints error if not nil, including stack trace. The same value is also returned, so it can be easily propagated further

func (*IPNeighConfigurator) Resync added in v1.8.1 

func (c *IPNeighConfigurator) Resync(config *l3.IPScanNeighbor) error

Resync configures the empty VPP (adds IP scan neigh config)

func (*IPNeighConfigurator) Set added in v1.8.1 

func (c *IPNeighConfigurator) Set(config *l3.IPScanNeighbor) error

Set puts desired IP scan neighbor configuration to the VPP

func (*IPNeighConfigurator) Unset added in v1.8.1 

func (c *IPNeighConfigurator) Unset() error

Unset returns IP scan neighbor configuration to default

type ProxyArpConfigurator 

type ProxyArpConfigurator struct {
	// contains filtered or unexported fields
}

ProxyArpConfigurator runs in the background in its own goroutine where it watches for any changes in the configuration of L3 proxy arp entries as modelled by the proto file "../model/l3/l3.proto" and stored in ETCD under the key "/vnf-agent/{vnf-agent}/vpp/config/v1/proxyarp". Configuration uses separate keys for proxy arp range and interfaces. Updates received from the northbound API are compared with the VPP run-time configuration and differences are applied through the VPP binary API.

func (*ProxyArpConfigurator) AddInterface 

func (c *ProxyArpConfigurator) AddInterface(pArpIf *l3.ProxyArpInterfaces_InterfaceList) error

AddInterface implements proxy arp handler.

func (*ProxyArpConfigurator) AddRange 

func (c *ProxyArpConfigurator) AddRange(pArpRng *l3.ProxyArpRanges_RangeList) error

AddRange configures new IP range for proxy ARP

func (*ProxyArpConfigurator) Close 

func (c *ProxyArpConfigurator) Close() error

Close VPP channel

func (*ProxyArpConfigurator) DeleteInterface 

func (c *ProxyArpConfigurator) DeleteInterface(pArpIf *l3.ProxyArpInterfaces_InterfaceList) error

DeleteInterface disables proxy ARP interface or removes it from cache

func (*ProxyArpConfigurator) DeleteRange 

func (c *ProxyArpConfigurator) DeleteRange(pArpRng *l3.ProxyArpRanges_RangeList) error

DeleteRange implements proxy arp handler.

func (*ProxyArpConfigurator) GetArpIfCache 

func (c *ProxyArpConfigurator) GetArpIfCache() []string

GetArpIfCache exposes list of cached ARP interfaces

func (*ProxyArpConfigurator) GetArpIfIndexes 

func (c *ProxyArpConfigurator) GetArpIfIndexes() idxvpp.NameToIdxRW

GetArpIfIndexes exposes list of proxy ARP interface indexes

func (*ProxyArpConfigurator) GetArpRngIndexes 

func (c *ProxyArpConfigurator) GetArpRngIndexes() idxvpp.NameToIdxRW

GetArpRngIndexes exposes list of proxy ARP range indexes

func (*ProxyArpConfigurator) Init 

func (c *ProxyArpConfigurator) Init(logger logging.PluginLogger, goVppMux govppmux.API, swIfIndexes ifaceidx.SwIfIndex) (err error)

Init VPP channel and vppcalls handler

func (*ProxyArpConfigurator) LogError added in v1.8.1 

func (c *ProxyArpConfigurator) LogError(err error) error

LogError prints error if not nil, including stack trace. The same value is also returned, so it can be easily propagated further

func (*ProxyArpConfigurator) ModifyInterface 

func (c *ProxyArpConfigurator) ModifyInterface(newPArpIf, oldPArpIf *l3.ProxyArpInterfaces_InterfaceList) error

ModifyInterface does nothing

func (*ProxyArpConfigurator) ModifyRange 

func (c *ProxyArpConfigurator) ModifyRange(newPArpRng, oldPArpRng *l3.ProxyArpRanges_RangeList) error

ModifyRange does nothing

func (*ProxyArpConfigurator) ResolveCreatedInterface 

func (c *ProxyArpConfigurator) ResolveCreatedInterface(ifName string, ifIdx uint32) error

ResolveCreatedInterface handles new registered interface for proxy ARP

func (*ProxyArpConfigurator) ResolveDeletedInterface 

func (c *ProxyArpConfigurator) ResolveDeletedInterface(ifName string) error

ResolveDeletedInterface handles new registered interface for proxy ARP

func (*ProxyArpConfigurator) ResyncInterfaces 

func (c *ProxyArpConfigurator) ResyncInterfaces(nbProxyArpIfs []*l3.ProxyArpInterfaces_InterfaceList) error

ResyncInterfaces confgures the empty VPP (overwrites the proxy arp entries)

func (*ProxyArpConfigurator) ResyncRanges 

func (c *ProxyArpConfigurator) ResyncRanges(nbProxyArpRanges []*l3.ProxyArpRanges_RangeList) error

ResyncRanges confgures the empty VPP (overwrites the proxy arp ranges)

type RouteConfigurator 

type RouteConfigurator struct {
	// contains filtered or unexported fields
}

RouteConfigurator runs in the background in its own goroutine where it watches for any changes in the configuration of L3 routes as modelled by the proto file "../model/l3/l3.proto" and stored in ETCD under the key "/vnf-agent/{vnf-agent}/vpp/config/v1routes". Updates received from the northbound API are compared with the VPP run-time configuration and differences are applied through the VPP binary API.

func (*RouteConfigurator) Close 

func (c *RouteConfigurator) Close() error

Close GOVPP channel.

func (*RouteConfigurator) ConfigureRoute 

func (c *RouteConfigurator) ConfigureRoute(route *l3.StaticRoutes_Route, vrfFromKey string) error

ConfigureRoute processes the NB config and propagates it to bin api calls.

func (*RouteConfigurator) DeleteRoute 

func (c *RouteConfigurator) DeleteRoute(route *l3.StaticRoutes_Route, vrfFromKey string) (wasError error)

DeleteRoute processes the NB config and propagates it to bin api calls.

func (*RouteConfigurator) DiffRoutes added in v1.8.1 

func (c *RouteConfigurator) DiffRoutes(new, old []*l3.StaticRoutes_Route) (toBeDeleted, toBeAdded []*l3.StaticRoutes_Route)

DiffRoutes calculates route diff from two sets of routes and returns routes to be added and removed

func (*RouteConfigurator) GetCachedRouteIndexes 

func (c *RouteConfigurator) GetCachedRouteIndexes() l3idx.RouteIndex

GetCachedRouteIndexes exposes rtCachedIndexes mapping

func (*RouteConfigurator) GetRouteIndexes 

func (c *RouteConfigurator) GetRouteIndexes() l3idx.RouteIndex

GetRouteIndexes exposes rtIndexes mapping

func (*RouteConfigurator) Init 

func (c *RouteConfigurator) Init(logger logging.PluginLogger, goVppMux govppmux.API, swIfIndexes ifaceidx.SwIfIndex) (err error)

Init members (channels...) and start go routines.

func (*RouteConfigurator) LogError added in v1.8.1 

func (c *RouteConfigurator) LogError(err error) error

LogError prints error if not nil, including stack trace. The same value is also returned, so it can be easily propagated further

func (*RouteConfigurator) ModifyRoute 

func (c *RouteConfigurator) ModifyRoute(newConfig *l3.StaticRoutes_Route, oldConfig *l3.StaticRoutes_Route, vrfFromKey string) error

ModifyRoute processes the NB config and propagates it to bin api calls.

func (*RouteConfigurator) ResolveCreatedInterface 

func (c *RouteConfigurator) ResolveCreatedInterface(ifName string, swIdx uint32) error

ResolveCreatedInterface is responsible for reconfiguring cached routes and then from removing them from route cache

func (*RouteConfigurator) ResolveDeletedInterface 

func (c *RouteConfigurator) ResolveDeletedInterface(ifName string, swIdx uint32) error

ResolveDeletedInterface is responsible for moving routes of deleted interface to cache

func (*RouteConfigurator) Resync 

func (c *RouteConfigurator) Resync(nbRoutes []*l3.StaticRoutes_Route) error

Resync configures the VPP static routes.

type SortedRoutes 

type SortedRoutes []*l3.StaticRoutes_Route

SortedRoutes type is used to implement sort interface for slice of Route.

func (SortedRoutes) Len 

func (arr SortedRoutes) Len() int

Return length of slice. Implements sort.Interface

func (SortedRoutes) Less 

func (arr SortedRoutes) Less(i, j int) bool

Less returns true if the item at index i in slice should be sorted before the element with index j. Implements sort.Interface

func (SortedRoutes) Swap 

func (arr SortedRoutes) Swap(i, j int)

Swap swaps two items in slice identified by indices. Implements sort.Interface

Source Files

View all Source files

Directories

Path Synopsis
Package vppcalls contains wrappers over VPP binary APIs for ARPs, proxy ARPs, L3 FIBs and helpers for dumping them.
 Package vppcalls contains wrappers over VPP binary APIs for ARPs, proxy ARPs, L3 FIBs and helpers for dumping them.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.