ovsclient

Documentation

Index

• type BridgeDataPathType
• type OVSClient
  • func New(exec kexec.Interface) (OVSClient, error)
• type PortType

Types

type BridgeDataPathType

type BridgeDataPathType string

BridgeDataPathType represents the various datapath types a bridge can be configured with

const (
	NetDev BridgeDataPathType = "netdev"
)

type OVSClient

type OVSClient interface {
	// BridgeExists checks if a bridge exists
	BridgeExists(name string) (bool, error)
	// AddBridgeIfNotExists adds a bridge if it doesn't exist
	AddBridgeIfNotExists(name string) error
	// DeleteBridgeIfExists deletes a bridge if it exists
	DeleteBridgeIfExists(name string) error
	// SetBridgeDataPathType sets the datapath type of a bridge
	SetBridgeDataPathType(bridge string, bridgeType BridgeDataPathType) error
	// SetBridgeMAC sets the MAC address for the bridge interface
	SetBridgeMAC(bridge string, mac net.HardwareAddr) error
	// SetBridgeUplink sets the bridge-uplink external ID of the bridge. It overrides if already exists.
	SetBridgeUplinkPort(bridge string, port string) error
	// SetBridgeHostToServicePort sets the host-to-service external ID of the bridge. It overrides if already exists.
	SetBridgeHostToServicePort(bridge string, port string) error
	// SetBridgeController sets the controller for a bridge
	SetBridgeController(bridge string, controller string) error

	// AddPortIfNotExists adds a port to a bridge if it doesn't exist
	AddPortIfNotExists(bridge string, port string) error
	// SetPortType sets the type of a port
	SetPortType(port string, portType PortType) error
	// SetPatchPortPeer sets the peer for a patch port
	SetPatchPortPeer(port string, peer string) error

	// SetOVNEncapIP sets the ovn-encap-ip external ID in the Open_vSwitch table in OVS
	SetOVNEncapIP(ip net.IP) error
	// SetDOCAInit sets the doca-init other_config in the Open_vSwitch table in OVS. Requires OVS daemon restart.
	SetDOCAInit(enable bool) error
	// SetKubernetesHostNodeName sets the host-k8s-nodename external ID in the Open_vSwitch table in OVS
	SetKubernetesHostNodeName(name string) error

	// InterfaceToBridge returns the bridge an interface exists in
	InterfaceToBridge(iface string) (string, error)
	// DeletePort deletes a port
	DeletePort(port string) error
	// GetInterfaceOfPort returns the ofport number of a port
	GetInterfaceOfPort(port string) (int, error)
	// GetPortExternalIDs returns the external_ids of an OVS port
	GetPortExternalIDs(port string) (map[string]string, error)
	// GetInterfaceExternalIDs returns the external_ids of an OVS interface
	GetInterfaceExternalIDs(iface string) (map[string]string, error)
	// AddPortWithMetadata adds a port to the given bridge with the specified external IDs and ofport request in a single
	// transaction
	AddPortWithMetadata(bridge string, port string, portType PortType, portExternalIDs map[string]string, interfaceExternalIDs map[string]string, ofport int) error
	// ListInterfaces lists all the interfaces that exist in OVS of a particular type
	ListInterfaces(portType PortType) (map[string]interface{}, error)
	// GetInterfacesWithPMDRXQueue returns all the interfaces that have a PMD Rx queue
	GetInterfacesWithPMDRXQueue() (map[string]interface{}, error)
}

OVSClient is a client that can be used to do specific actions on OVS.

func New

func New(exec kexec.Interface) (OVSClient, error)

New creates a new OVSClient

type PortType

type PortType string

PortType represents the various types a port can be configured with

const (
	DPDK     PortType = "dpdk"
	Internal PortType = "internal"
	Patch    PortType = "patch"
)