Documentation
¶
Index ¶
- Constants
- func GetPodIP(execer utilexec.Interface, nsenterPath, netnsPath, interfaceName string) (net.IP, error)
- func UnescapePluginName(in string) string
- type Host
- type LegacyHost
- type NamespaceGetter
- type NetworkPlugin
- type NoopNetworkPlugin
- func (plugin *NoopNetworkPlugin) Capabilities() utilsets.Int
- func (plugin *NoopNetworkPlugin) Event(name string, details map[string]interface{})
- func (plugin *NoopNetworkPlugin) GetPodNetworkStatus(namespace string, name string, id kubecontainer.ContainerID) (*PodNetworkStatus, error)
- func (plugin *NoopNetworkPlugin) Init(host Host, hairpinMode componentconfig.HairpinMode, nonMasqueradeCIDR string, ...) error
- func (plugin *NoopNetworkPlugin) Name() string
- func (plugin *NoopNetworkPlugin) SetUpPod(namespace string, name string, id kubecontainer.ContainerID, ...) error
- func (plugin *NoopNetworkPlugin) Status() error
- func (plugin *NoopNetworkPlugin) TearDownPod(namespace string, name string, id kubecontainer.ContainerID) error
- type NoopPortMappingGetter
- type PluginManager
- func (pm *PluginManager) Event(name string, details map[string]interface{})
- func (pm *PluginManager) GetPodNetworkStatus(podNamespace, podName string, id kubecontainer.ContainerID) (*PodNetworkStatus, error)
- func (pm *PluginManager) PluginName() string
- func (pm *PluginManager) SetUpPod(podNamespace, podName string, id kubecontainer.ContainerID, ...) error
- func (pm *PluginManager) Status() error
- func (pm *PluginManager) TearDownPod(podNamespace, podName string, id kubecontainer.ContainerID) error
- type PodNetworkStatus
- type PortMappingGetter
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"
const UseDefaultMTU = 0
UseDefaultMTU is a marker value that indicates the plugin should determine its own MTU It is the zero value, so a non-initialized value will mean "UseDefault"
Variables ¶
This section is empty.
Functions ¶
func GetPodIP ¶ added in v1.3.0
func GetPodIP(execer utilexec.Interface, nsenterPath, netnsPath, interfaceName string) (net.IP, error)
GetPodIP gets the IP of the pod by inspecting the network info inside the pod's network namespace.
func UnescapePluginName ¶
Types ¶
type Host ¶
type Host interface { // NamespaceGetter is a getter for sandbox namespace information. NamespaceGetter // PortMappingGetter is a getter for sandbox port mapping information. PortMappingGetter // LegacyHost contains methods that trap back into the Kubelet. Dependence // *do not* add more dependencies in this interface. In a post-cri world, // network plugins will be invoked by the runtime shim, and should only // require GetNetNS and GetPodPortMappings. LegacyHost }
Host is an interface that plugins can use to access the kubelet. TODO(#35457): get rid of this backchannel to the kubelet. The scope of the back channel is restricted to host-ports/testing, and restricted to kubenet. No other network plugin wrapper needs it. Other plugins only require a way to access namespace information and port mapping information , which they can do directly through the embedded interfaces.
type LegacyHost ¶ added in v1.5.1
type LegacyHost interface { // Get the pod structure by its name, namespace // Only used for hostport management and bw shaping GetPodByName(namespace, name string) (*v1.Pod, bool) // GetKubeClient returns a client interface // Only used in testing GetKubeClient() clientset.Interface // GetContainerRuntime returns the container runtime that implements the containers (e.g. docker/rkt) // Only used for hostport management GetRuntime() kubecontainer.Runtime // SupportsLegacyFeatures returns true if the network host support GetPodByName, KubeClient interface and kubelet // runtime interface. These interfaces will no longer be implemented by CRI shims. // This function helps network plugins to choose their behavior based on runtime. SupportsLegacyFeatures() bool }
LegacyHost implements the methods required by network plugins that were directly invoked by the kubelet. Implementations of this interface that do not wish to support these features can simply return false to SupportsLegacyFeatures.
type NamespaceGetter ¶ added in v1.5.1
type NamespaceGetter interface { // GetNetNS returns network namespace information for the given containerID. GetNetNS(containerID string) (string, error) }
NamespaceGetter is an interface to retrieve namespace information for a given sandboxID. Typically implemented by runtime shims that are closely coupled to CNI plugin wrappers like kubenet.
type NetworkPlugin ¶
type NetworkPlugin interface { // Init initializes the plugin. This will be called exactly once // before any other methods are called. Init(host Host, hairpinMode componentconfig.HairpinMode, nonMasqueradeCIDR string, mtu int) 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. // TODO: rename podInfraContainerID to sandboxID SetUpPod(namespace string, name string, podInfraContainerID kubecontainer.ContainerID, annotations map[string]string) error // TearDownPod is the method called before a pod's infra container will be deleted // TODO: rename podInfraContainerID to sandboxID TearDownPod(namespace string, name string, podInfraContainerID kubecontainer.ContainerID) error // Status is the method called to obtain the ipv4 or ipv6 addresses of the container // TODO: rename podInfraContainerID to sandboxID GetPodNetworkStatus(namespace string, name string, podInfraContainerID kubecontainer.ContainerID) (*PodNetworkStatus, error) // NetworkStatus returns error if the network plugin is in error state Status() error }
Plugin is an interface to network plugins for the kubelet
func InitNetworkPlugin ¶
func InitNetworkPlugin(plugins []NetworkPlugin, networkPluginName string, host Host, hairpinMode componentconfig.HairpinMode, nonMasqueradeCIDR string, mtu int) (NetworkPlugin, error)
InitNetworkPlugin inits the plugin that matches networkPluginName. Plugins must have unique names.
type NoopNetworkPlugin ¶ added in v1.3.0
type NoopNetworkPlugin struct { }
func (*NoopNetworkPlugin) Capabilities ¶ added in v1.3.0
func (plugin *NoopNetworkPlugin) Capabilities() utilsets.Int
func (*NoopNetworkPlugin) Event ¶ added in v1.3.0
func (plugin *NoopNetworkPlugin) Event(name string, details map[string]interface{})
func (*NoopNetworkPlugin) GetPodNetworkStatus ¶ added in v1.3.0
func (plugin *NoopNetworkPlugin) GetPodNetworkStatus(namespace string, name string, id kubecontainer.ContainerID) (*PodNetworkStatus, error)
func (*NoopNetworkPlugin) Init ¶ added in v1.3.0
func (plugin *NoopNetworkPlugin) Init(host Host, hairpinMode componentconfig.HairpinMode, nonMasqueradeCIDR string, mtu int) error
func (*NoopNetworkPlugin) Name ¶ added in v1.3.0
func (plugin *NoopNetworkPlugin) Name() string
func (*NoopNetworkPlugin) SetUpPod ¶ added in v1.3.0
func (plugin *NoopNetworkPlugin) SetUpPod(namespace string, name string, id kubecontainer.ContainerID, annotations map[string]string) error
func (*NoopNetworkPlugin) Status ¶ added in v1.3.0
func (plugin *NoopNetworkPlugin) Status() error
func (*NoopNetworkPlugin) TearDownPod ¶ added in v1.3.0
func (plugin *NoopNetworkPlugin) TearDownPod(namespace string, name string, id kubecontainer.ContainerID) error
type NoopPortMappingGetter ¶ added in v1.6.0
type NoopPortMappingGetter struct{}
func (*NoopPortMappingGetter) GetPodPortMappings ¶ added in v1.6.0
func (*NoopPortMappingGetter) GetPodPortMappings(containerID string) ([]*hostport.PortMapping, error)
type PluginManager ¶ added in v1.6.0
type PluginManager struct {
// contains filtered or unexported fields
}
The PluginManager wraps a kubelet network plugin and provides synchronization for a given pod's network operations. Each pod's setup/teardown/status operations are synchronized against each other, but network operations of other pods can proceed in parallel.
func NewPluginManager ¶ added in v1.6.0
func NewPluginManager(plugin NetworkPlugin) *PluginManager
func (*PluginManager) Event ¶ added in v1.6.0
func (pm *PluginManager) Event(name string, details map[string]interface{})
func (*PluginManager) GetPodNetworkStatus ¶ added in v1.6.0
func (pm *PluginManager) GetPodNetworkStatus(podNamespace, podName string, id kubecontainer.ContainerID) (*PodNetworkStatus, error)
func (*PluginManager) PluginName ¶ added in v1.6.0
func (pm *PluginManager) PluginName() string
func (*PluginManager) SetUpPod ¶ added in v1.6.0
func (pm *PluginManager) SetUpPod(podNamespace, podName string, id kubecontainer.ContainerID, annotations map[string]string) error
func (*PluginManager) Status ¶ added in v1.6.0
func (pm *PluginManager) Status() error
func (*PluginManager) TearDownPod ¶ added in v1.6.0
func (pm *PluginManager) TearDownPod(podNamespace, podName string, id kubecontainer.ContainerID) error
type PodNetworkStatus ¶ added in v1.2.3
type PodNetworkStatus struct { metav1.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"
type PortMappingGetter ¶ added in v1.6.0
type PortMappingGetter interface { // GetPodPortMappings returns sandbox port mappings information. GetPodPortMappings(containerID string) ([]*hostport.PortMapping, error) }
PortMappingGetter is an interface to retrieve port mapping information for a given sandboxID. Typically implemented by runtime shims that are closely coupled to CNI plugin wrappers like kubenet.