contiv

Documentation

Overview

Package contiv implements plugin providing GRPC-server that accepts requests from CNI plugin.

+-------------------------------------------------+ | vSwitch VPP host.go | +--------------+ | +--------------+ | | vethVPP |____________| veth Host | | routing | | | | | | +--------------+ | +--------------+ | +------+ +------+ | | | AF1 | | AFn | | | | | ... | | | | +------+ +------+ | | ^ | | | | +------|------------------------------------------+

v

+------------+ | | | Veth2 | | | +------------+

^
|                   pod.go

+------|------------+ | NS1 v | | +------------+ | | | | | | | Veth1 | | | | | | | +------------+ | | | +-------------------+

Index

• type API
• type Config
• type Deps
• type Plugin
  • func (plugin *Plugin) AfterInit() error
  • func (plugin *Plugin) Close() error
  • func (plugin *Plugin) GetIfName(podNamespace string, podName string) (name string, exists bool)
  • func (plugin *Plugin) Init() error

Types

type API

type API interface {
	// GetIfName looks up logical interface name that corresponds to the interface
	// associated with the given pod.
	GetIfName(podNamespace string, podName string) (name string, exists bool)
}

API for other plugins to query network-related information.

type Config

type Config struct {
	IPAMConfig ipam.Config
}

Config is configuration for Contiv plugin. It can be injected or loaded from external config. Injection has priority to external config. To use external config add `<Contiv plugin name> + "-config="<absolute path to config>` in go run command flags.

type Deps

type Deps struct {
	local.PluginInfraDeps
	GRPC    grpc.Server
	Proxy   *kvdbproxy.Plugin
	VPP     *defaultplugins.Plugin
	GoVPP   govppmux.API
	Resync  resync.Subscriber
	ETCD    *etcdv3.Plugin
	Watcher datasync.KeyValProtoWatcher
}

Deps groups the dependencies of the Plugin.

type Plugin

type Plugin struct {
	Deps

	Config *Config
	// contains filtered or unexported fields
}

Plugin transforms GRPC requests into configuration for the VPP in order to connect a container into the network.

func (*Plugin) AfterInit

func (plugin *Plugin) AfterInit() error

AfterInit registers to the ResyncOrchestrator. The registration is done in this phase in order to trigger the resync for this plugin once the resync of defaultVPP plugins is finished.

func (*Plugin) Close

func (plugin *Plugin) Close() error

Close cleans up the resources allocated by the plugin

func (*Plugin) GetIfName

func (plugin *Plugin) GetIfName(podNamespace string, podName string) (name string, exists bool)

GetIfName looks up logical interface name that corresponds to the interface associated with the given pod.

func (*Plugin) Init

func (plugin *Plugin) Init() error

Init initializes the grpc server handling the request from the CNI.