descriptor

package
v2.1.1+incompatible Latest Latest
Warning

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

 Go to latest Published: May 27, 2019 License: Apache-2.0 Imports: 25 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// BondInterfaceDescriptorName is the name of the descriptor for the bond-interface
	// config-subsection of VPP interfaces.
	BondedInterfaceDescriptorName = "bond-interface"
)
View Source 
const (
	// DHCPDescriptorName is the name of the descriptor configuring DHCP for VPP
	// interfaces.
	DHCPDescriptorName = "vpp-dhcp"
)
View Source 
const (
	// InterfaceAddressDescriptorName is the name of the descriptor for assigning
	// IP addresses to VPP interfaces.
	InterfaceAddressDescriptorName = "vpp-interface-address"
)
View Source 
const (
	// InterfaceDescriptorName is the name of the descriptor for VPP interfaces.
	InterfaceDescriptorName = "vpp-interface"
)
View Source 
const (
	// InterfaceVrfDescriptorName is the name of the descriptor for assigning
	// VPP interface into VRF table.
	InterfaceVrfDescriptorName = "vpp-interface-vrf"
)
View Source 
const (
	// UnnumberedIfDescriptorName is the name of the descriptor for the unnumbered
	// config-subsection of VPP interfaces.
	UnnumberedIfDescriptorName = "vpp-unnumbered-interface"
)

Variables

View Source 
var (
	// ErrUnsupportedVPPInterfaceType is returned for VPP interfaces of unknown type.
	ErrUnsupportedVPPInterfaceType = errors.New("unsupported VPP interface type")

	// ErrInterfaceWithoutName is returned when VPP interface configuration has undefined
	// Name attribute.
	ErrInterfaceWithoutName = errors.New("VPP interface defined without logical name")

	// ErrInterfaceNameTooLong is returned when VPP interface logical name exceeds the length limit.
	ErrInterfaceNameTooLong = errors.New("VPP interface logical name exceeds the length limit (63 characters)")

	// ErrInterfaceWithoutType is returned when VPP interface configuration has undefined
	// Type attribute.
	ErrInterfaceWithoutType = errors.New("VPP interface defined without type")

	// ErrUnnumberedWithIP is returned when configuration of a VPP unnumbered interface
	// includes an IP address.
	ErrUnnumberedWithIP = errors.New("VPP unnumbered interface was defined with IP address")

	// ErrAfPacketWithoutHostName is returned when AF-Packet configuration is missing host interface name.
	ErrAfPacketWithoutHostName = errors.New("VPP AF-Packet interface was defined without host interface name")

	// ErrInterfaceLinkMismatch is returned when interface type does not match the link configuration.
	ErrInterfaceLinkMismatch = errors.New("VPP interface type and link configuration do not match")

	// ErrUnsupportedRxMode is returned when the given interface type does not support the chosen
	// RX mode.
	ErrUnsupportedRxMode = errors.New("unsupported RX Mode")

	// ErrSubInterfaceWithoutParent is returned when interface of type sub-interface is defined without parent.
	ErrSubInterfaceWithoutParent = errors.Errorf("subinterface with no parent interface defined")

	// ErrDPDKInterfaceMissing is returned when the expected DPDK interface does not exist on the VPP.
	ErrDPDKInterfaceMissing = errors.Errorf("DPDK interface with given name does not exists")

	// ErrBondInterfaceIDExists is returned when the bond interface uses existing ID value
	ErrBondInterfaceIDExists = errors.Errorf("Bond interface ID already exists")
)

A list of non-retriable errors:

Functions

func NewInterfaceAddressDescriptor 

func NewInterfaceAddressDescriptor(ifHandler vppcalls.InterfaceVppAPI, ifIndex ifaceidx.IfaceMetadataIndex,
	log logging.PluginLogger) *kvs.KVDescriptor

NewInterfaceAddressDescriptor creates a new instance of InterfaceAddressDescriptor.

func NewInterfaceVrfDescriptor 

func NewInterfaceVrfDescriptor(ifHandler vppcalls.InterfaceVppAPI, ifIndex ifaceidx.IfaceMetadataIndex,
	log logging.PluginLogger) *kvs.KVDescriptor

NewInterfaceVrfDescriptor creates a new instance of InterfaceVrfDescriptor.

func NewUnnumberedIfDescriptor 

func NewUnnumberedIfDescriptor(ifHandler vppcalls.InterfaceVppAPI, ifIndex ifaceidx.IfaceMetadataIndex,
	log logging.PluginLogger) *kvs.KVDescriptor

NewUnnumberedIfDescriptor creates a new instance of UnnumberedIfDescriptor.

Types

type BondedInterfaceDescriptor 

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

BondedInterfaceDescriptor sets/unsets VPP interfaces as a slave for the bond interface.

func NewBondedInterfaceDescriptor 

func NewBondedInterfaceDescriptor(ifHandler vppcalls.InterfaceVppAPI, ifIndex ifaceidx.IfaceMetadataIndex,
	log logging.PluginLogger) (*kvs.KVDescriptor, *BondedInterfaceDescriptor)

NewBondedInterfaceDescriptor creates a new instance of BondedInterfaceDescriptor.

func (*BondedInterfaceDescriptor) Create 

func (d *BondedInterfaceDescriptor) Create(key string, bondedIf *interfaces.BondLink_BondedInterface) (metadata interface{}, err error)

Create sets an interface as a bond interface slave.

func (*BondedInterfaceDescriptor) Delete 

func (d *BondedInterfaceDescriptor) Delete(key string, bondedIf *interfaces.BondLink_BondedInterface, metadata interface{}) error

Delete detaches interface as a bond slave

func (*BondedInterfaceDescriptor) Dependencies 

func (d *BondedInterfaceDescriptor) Dependencies(key string, bondedIf *interfaces.BondLink_BondedInterface) []kvs.Dependency

Dependencies lists dependencies for an bond slave VPP interface.

func (*BondedInterfaceDescriptor) IsBondEnslaveKey 

func (d *BondedInterfaceDescriptor) IsBondEnslaveKey(key string) bool

IsBondEnslaveKey returns true if the key is identifying bond VPP interface.

type DHCPDescriptor 

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

DHCPDescriptor enables/disables DHCP for VPP interfaces and notifies about new DHCP leases.

func NewDHCPDescriptor 

func NewDHCPDescriptor(kvscheduler kvs.KVScheduler, ifHandler vppcalls.InterfaceVppAPI,
	ifIndex ifaceidx.IfaceMetadataIndex, log logging.PluginLogger) (descr *kvs.KVDescriptor, ctx *DHCPDescriptor)

NewDHCPDescriptor creates a new instance of DHCPDescriptor.

func (*DHCPDescriptor) Close 

func (d *DHCPDescriptor) Close() error

Close stops watching of DHCP notifications.

func (*DHCPDescriptor) Create 

func (d *DHCPDescriptor) Create(key string, emptyVal proto.Message) (metadata kvs.Metadata, err error)

Create enables DHCP client.

func (*DHCPDescriptor) Delete 

func (d *DHCPDescriptor) Delete(key string, emptyVal proto.Message, metadata kvs.Metadata) error

Delete disables DHCP client.

func (*DHCPDescriptor) DerivedValues 

func (d *DHCPDescriptor) DerivedValues(key string, dhcpData proto.Message) (derValues []kvs.KeyValuePair)

DerivedValues derives empty value for leased IP address.

func (*DHCPDescriptor) InterfaceNameFromKey 

func (d *DHCPDescriptor) InterfaceNameFromKey(key string) string

InterfaceNameFromKey returns interface name from DHCP-related key.

func (*DHCPDescriptor) IsDHCPRelatedKey 

func (d *DHCPDescriptor) IsDHCPRelatedKey(key string) bool

IsDHCPRelatedKey returns true if the key is identifying DHCP client (derived value) or DHCP lease (notification).

func (*DHCPDescriptor) Retrieve 

func (d *DHCPDescriptor) Retrieve(correlate []kvs.KVWithMetadata) (
	leases []kvs.KVWithMetadata, err error,
)

Retrieve returns all existing DHCP leases.

func (*DHCPDescriptor) WatchDHCPNotifications 

func (d *DHCPDescriptor) WatchDHCPNotifications(ctx context.Context)

WatchDHCPNotifications starts watching for DHCP notifications.

type InterfaceAddressDescriptor 

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

InterfaceAddressDescriptor (un)assigns IP address to/from VPP interface.

func (*InterfaceAddressDescriptor) Create 

func (d *InterfaceAddressDescriptor) Create(key string, emptyVal proto.Message) (metadata kvs.Metadata, err error)

Create assigns IP address to an interface.

func (*InterfaceAddressDescriptor) Delete 

func (d *InterfaceAddressDescriptor) Delete(key string, emptyVal proto.Message, metadata kvs.Metadata) (err error)

Delete unassigns IP address from an interface.

func (*InterfaceAddressDescriptor) Dependencies 

func (d *InterfaceAddressDescriptor) Dependencies(key string, emptyVal proto.Message) []kvs.Dependency

Dependencies lists assignment of the interface into the VRF table as the only dependency.

func (*InterfaceAddressDescriptor) IsInterfaceAddressKey 

func (d *InterfaceAddressDescriptor) IsInterfaceAddressKey(key string) bool

IsInterfaceVrfKey returns true if the key represents assignment of an IP address to a VPP interface.

func (*InterfaceAddressDescriptor) Validate 

func (d *InterfaceAddressDescriptor) Validate(key string, emptyVal proto.Message) (err error)

Validate validates IP address to be assigned to an interface.

type InterfaceDescriptor 

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

InterfaceDescriptor teaches KVScheduler how to configure VPP interfaces.

func NewInterfaceDescriptor 

func NewInterfaceDescriptor(ifHandler vppcalls.InterfaceVppAPI, defaultMtu uint32,
	linuxIfHandler NetlinkAPI, linuxIfPlugin LinuxPluginAPI, nsPlugin nsplugin.API,
	log logging.PluginLogger) (descr *kvs.KVDescriptor, ctx *InterfaceDescriptor)

NewInterfaceDescriptor creates a new instance of the Interface descriptor.

func (*InterfaceDescriptor) Create 

func (d *InterfaceDescriptor) Create(key string, intf *interfaces.Interface) (metadata *ifaceidx.IfaceMetadata, err error)

Create creates a VPP interface.

func (*InterfaceDescriptor) Delete 

func (d *InterfaceDescriptor) Delete(key string, intf *interfaces.Interface, metadata *ifaceidx.IfaceMetadata) error

Delete removes VPP interface.

func (*InterfaceDescriptor) Dependencies 

func (d *InterfaceDescriptor) Dependencies(key string, intf *interfaces.Interface) (dependencies []kvs.Dependency)

Dependencies lists dependencies for a VPP interface.

func (*InterfaceDescriptor) DerivedValues 

func (d *InterfaceDescriptor) DerivedValues(key string, intf *interfaces.Interface) (derValues []kvs.KeyValuePair)

DerivedValues derives:

  • key-value for unnumbered configuration sub-section
  • empty value for enabled DHCP client
  • configuration for every slave of a bonded interface
  • one empty value for every IP address to be assigned to the interface
  • one empty value for VRF table to put the interface into.

func (*InterfaceDescriptor) EquivalentInterfaces 

func (d *InterfaceDescriptor) EquivalentInterfaces(key string, oldIntf, newIntf *interfaces.Interface) bool

EquivalentInterfaces is case-insensitive comparison function for interfaces.Interface, also ignoring the order of assigned IP addresses.

func (*InterfaceDescriptor) MetadataFactory 

func (d *InterfaceDescriptor) MetadataFactory() idxmap.NamedMappingRW

MetadataFactory is a factory for index-map customized for VPP interfaces.

func (*InterfaceDescriptor) Retrieve 

func (d *InterfaceDescriptor) Retrieve(correlate []adapter.InterfaceKVWithMetadata) (retrieved []adapter.InterfaceKVWithMetadata, err error)

Retrieve returns all configured VPP interfaces.

func (*InterfaceDescriptor) SetInterfaceIndex 

func (d *InterfaceDescriptor) SetInterfaceIndex(intfIndex ifaceidx.IfaceMetadataIndex)

SetInterfaceIndex should be used to provide interface index immediately after the descriptor registration.

func (*InterfaceDescriptor) Update 

func (d *InterfaceDescriptor) Update(key string, oldIntf, newIntf *interfaces.Interface, oldMetadata *ifaceidx.IfaceMetadata) (newMetadata *ifaceidx.IfaceMetadata, err error)

Update is able to change Type-unspecific attributes.

func (*InterfaceDescriptor) UpdateWithRecreate 

func (d *InterfaceDescriptor) UpdateWithRecreate(key string, oldIntf, newIntf *interfaces.Interface, metadata *ifaceidx.IfaceMetadata) bool

UpdateWithRecreate returns true if Type or Type-specific attributes are different.

func (*InterfaceDescriptor) Validate 

func (d *InterfaceDescriptor) Validate(key string, intf *interfaces.Interface) error

Validate validates VPP interface configuration.

type InterfaceVrfDescriptor 

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

InterfaceVrfDescriptor (un)assigns VPP interface to IPv4/IPv6 VRF table.

func (*InterfaceVrfDescriptor) Create 

func (d *InterfaceVrfDescriptor) Create(key string, emptyVal proto.Message) (metadata kvs.Metadata, err error)

Create puts interface into the given VRF table.

func (*InterfaceVrfDescriptor) Delete 

func (d *InterfaceVrfDescriptor) Delete(key string, emptyVal proto.Message, metadata kvs.Metadata) (err error)

Delete removes interface from the given VRF table.

func (*InterfaceVrfDescriptor) Dependencies 

func (d *InterfaceVrfDescriptor) Dependencies(key string, emptyVal proto.Message) (deps []kvs.Dependency)

Dependencies lists the target non-zero VRF as the only dependency.

func (*InterfaceVrfDescriptor) IsInterfaceVrfKey 

func (d *InterfaceVrfDescriptor) IsInterfaceVrfKey(key string) bool

IsInterfaceVrfKey returns true if the key represents assignment of an interface into a VRF table.

type LinuxPluginAPI 

type LinuxPluginAPI interface {
	// GetInterfaceIndex gives read-only access to map with metadata of all configured
	// linux interfaces.
	GetInterfaceIndex() linux_ifaceidx.LinuxIfMetadataIndex
}

LinuxPluginAPI is defined here to avoid import cycles.

type NetlinkAPI 

type NetlinkAPI interface {
	// InterfaceExists verifies interface existence
	InterfaceExists(ifName string) (bool, error)
}

NetlinkAPI here lists only those Netlink methods that are actually used by InterfaceDescriptor.

type UnnumberedIfDescriptor 

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

UnnumberedIfDescriptor sets/unsets VPP interfaces as unnumbered. Values = Interface_Unnumbered{} derived from interfaces where IsUnnumbered==true

func (*UnnumberedIfDescriptor) Create 

func (d *UnnumberedIfDescriptor) Create(key string, unIntf *interfaces.Interface_Unnumbered) (metadata interface{}, err error)

Create sets interface as unnumbered.

func (*UnnumberedIfDescriptor) Delete 

func (d *UnnumberedIfDescriptor) Delete(key string, unIntf *interfaces.Interface_Unnumbered, metadata interface{}) error

Delete un-sets interface as unnumbered.

func (*UnnumberedIfDescriptor) Dependencies 

func (d *UnnumberedIfDescriptor) Dependencies(key string, unIntf *interfaces.Interface_Unnumbered) (deps []kvs.Dependency)

Dependencies lists dependencies for an unnumbered VPP interface.

func (*UnnumberedIfDescriptor) IsUnnumberedInterfaceKey 

func (d *UnnumberedIfDescriptor) IsUnnumberedInterfaceKey(key string) bool

IsUnnumberedInterfaceKey returns true if the key is identifying unnumbered VPP interface.

Source Files

View all Source files

Directories

Path Synopsis

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.