network

Documentation

Index

• Constants
• func UnescapePluginName(in string) string
• type Host
• type NetworkPlugin
  • func InitNetworkPlugin(plugins []NetworkPlugin, networkPluginName string, host Host) (NetworkPlugin, error)
• type NoopNetworkPlugin
  • func (plugin *NoopNetworkPlugin) Capabilities() utilsets.Int
  • func (plugin *NoopNetworkPlugin) Event(name string, details map[string]interface{})
  • func (plugin *NoopNetworkPlugin) Init(host Host) error
  • func (plugin *NoopNetworkPlugin) Name() string
  • func (plugin *NoopNetworkPlugin) SetUpPod(namespace string, name string, id kubecontainer.ContainerID) error
  • func (plugin *NoopNetworkPlugin) Status(namespace string, name string, id kubecontainer.ContainerID) (*PodNetworkStatus, error)
  • func (plugin *NoopNetworkPlugin) TearDownPod(namespace string, name string, id kubecontainer.ContainerID) error
• type PodNetworkStatus

Constants

const DefaultInterfaceName = "eth0"

TODO: Consider making this value configurable.

const DefaultPluginName = "kubernetes.io/no-op"

const (
	// Indicates the plugin handles Kubernetes bandwidth shaping annotations internally
	NET_PLUGIN_CAPABILITY_SHAPING int = 1
)

Plugin capabilities

const NET_PLUGIN_EVENT_POD_CIDR_CHANGE = "pod-cidr-change"

Called when the node's Pod CIDR is known when using the controller manager's --allocate-node-cidrs=true option

const NET_PLUGIN_EVENT_POD_CIDR_CHANGE_DETAIL_CIDR = "pod-cidr"

Functions

func UnescapePluginName

func UnescapePluginName(in string) string

Types

type Host

type Host interface {
	// Get the pod structure by its name, namespace
	GetPodByName(namespace, name string) (*api.Pod, bool)

	// GetKubeClient returns a client interface
	GetKubeClient() clientset.Interface

	// GetContainerRuntime returns the container runtime that implements the containers (e.g. docker/rkt)
	GetRuntime() kubecontainer.Runtime
}

Host is an interface that plugins can use to access the kubelet.

type NetworkPlugin

type NetworkPlugin interface {
	// Init initializes the plugin.  This will be called exactly once
	// before any other methods are called.
	Init(host Host) error

	// Called on various events like:
	// NET_PLUGIN_EVENT_POD_CIDR_CHANGE
	Event(name string, details map[string]interface{})

	// Name returns the plugin's name. This will be used when searching
	// for a plugin by name, e.g.
	Name() string

	// Returns a set of NET_PLUGIN_CAPABILITY_*
	Capabilities() utilsets.Int

	// SetUpPod is the method called after the infra container of
	// the pod has been created but before the other containers of the
	// pod are launched.
	SetUpPod(namespace string, name string, podInfraContainerID kubecontainer.ContainerID) error

	// TearDownPod is the method called before a pod's infra container will be deleted
	TearDownPod(namespace string, name string, podInfraContainerID kubecontainer.ContainerID) error

	// Status is the method called to obtain the ipv4 or ipv6 addresses of the container
	Status(namespace string, name string, podInfraContainerID kubecontainer.ContainerID) (*PodNetworkStatus, error)
}

Plugin is an interface to network plugins for the kubelet

func InitNetworkPlugin

func InitNetworkPlugin(plugins []NetworkPlugin, networkPluginName string, host Host) (NetworkPlugin, error)

InitNetworkPlugin inits the plugin that matches networkPluginName. Plugins must have unique names.

type NoopNetworkPlugin

type NoopNetworkPlugin struct {
}

func (*NoopNetworkPlugin) Capabilities

func (plugin *NoopNetworkPlugin) Capabilities() utilsets.Int

func (*NoopNetworkPlugin) Event

func (plugin *NoopNetworkPlugin) Event(name string, details map[string]interface{})

func (*NoopNetworkPlugin) Init

func (plugin *NoopNetworkPlugin) Init(host Host) error

func (*NoopNetworkPlugin) Name

func (plugin *NoopNetworkPlugin) Name() string

func (*NoopNetworkPlugin) SetUpPod

func (plugin *NoopNetworkPlugin) SetUpPod(namespace string, name string, id kubecontainer.ContainerID) error

func (*NoopNetworkPlugin) Status

func (plugin *NoopNetworkPlugin) Status(namespace string, name string, id kubecontainer.ContainerID) (*PodNetworkStatus, error)

func (*NoopNetworkPlugin) TearDownPod

func (plugin *NoopNetworkPlugin) TearDownPod(namespace string, name string, id kubecontainer.ContainerID) error

type PodNetworkStatus

type PodNetworkStatus struct {
	unversioned.TypeMeta `json:",inline"`

	// IP is the primary ipv4/ipv6 address of the pod. Among other things it is the address that -
	//   - kube expects to be reachable across the cluster
	//   - service endpoints are constructed with
	//   - will be reported in the PodStatus.PodIP field (will override the IP reported by docker)
	IP net.IP `json:"ip" description:"Primary IP address of the pod"`
}

PodNetworkStatus stores the network status of a pod (currently just the primary IP address) This struct represents version "v1beta1"