types

Documentation

Index

• func CheckSystemNamespaces(namespace string, systemNamespaces []string) bool
• func CreateCNIRuntimeConf(args *skel.CmdArgs, k8sArgs *K8sArgs, ifName string, rc *RuntimeConfig) *libcni.RuntimeConf
• func LoadDelegateNetConfList(bytes []byte, delegateConf *DelegateNetConf) error
• type DelegateNetConf
  • func LoadDelegateNetConf(bytes []byte, net *NetworkSelectionElement, deviceID string) (*DelegateNetConf, error)
• type K8sArgs
• type NetConf
  • func LoadNetConf(bytes []byte) (*NetConf, error)
  • func (n *NetConf) AddDelegates(newDelegates []*DelegateNetConf) error
• type NetworkAttachmentDefinitionSpec
• type NetworkDefinition
• type NetworkSelectionElement
• type NetworkStatus
  • func LoadNetworkStatus(r types.Result, netName string, defaultNet bool) (*NetworkStatus, error)
• type PortMapEntry
• type ResourceClient
• type ResourceInfo
• type RuntimeConfig

Functions

func CheckSystemNamespaces

func CheckSystemNamespaces(namespace string, systemNamespaces []string) bool

CheckSystemNamespaces checks whether given namespace is in systemNamespaces or not.

func CreateCNIRuntimeConf

func CreateCNIRuntimeConf(args *skel.CmdArgs, k8sArgs *K8sArgs, ifName string, rc *RuntimeConfig) *libcni.RuntimeConf

CreateCNIRuntimeConf create CNI RuntimeConf

func LoadDelegateNetConfList

func LoadDelegateNetConfList(bytes []byte, delegateConf *DelegateNetConf) error

LoadDelegateNetConfList reads DelegateNetConf from bytes

Types

type DelegateNetConf

type DelegateNetConf struct {
	Conf          types.NetConf
	ConfList      types.NetConfList
	IfnameRequest string `json:"ifnameRequest,omitempty"`
	MacRequest    string `json:"macRequest,omitempty"`
	IPRequest     string `json:"ipRequest,omitempty"`
	// MasterPlugin is only used internal housekeeping
	MasterPlugin bool `json:"-"`
	// Conflist plugin is only used internal housekeeping
	ConfListPlugin bool `json:"-"`

	// Raw JSON
	Bytes []byte
}

DelegateNetConf for net-attach-def for pod

func LoadDelegateNetConf

func LoadDelegateNetConf(bytes []byte, net *NetworkSelectionElement, deviceID string) (*DelegateNetConf, error)

LoadDelegateNetConf converts raw CNI JSON into a DelegateNetConf structure

type K8sArgs

type K8sArgs struct {
	types.CommonArgs
	IP                         net.IP
	K8S_POD_NAME               types.UnmarshallableString
	K8S_POD_NAMESPACE          types.UnmarshallableString
	K8S_POD_INFRA_CONTAINER_ID types.UnmarshallableString
}

K8sArgs is the valid CNI_ARGS used for Kubernetes

type NetConf

type NetConf struct {
	types.NetConf

	// support chaining for master interface and IP decisions
	// occurring prior to running ipvlan plugin
	RawPrevResult *map[string]interface{} `json:"prevResult"`
	PrevResult    *current.Result         `json:"-"`

	ConfDir string `json:"confDir"`
	CNIDir  string `json:"cniDir"`
	BinDir  string `json:"binDir"`
	// RawDelegates is private to the NetConf class; use Delegates instead
	RawDelegates    []map[string]interface{} `json:"delegates"`
	Delegates       []*DelegateNetConf       `json:"-"`
	NetStatus       []*NetworkStatus         `json:"-"`
	Kubeconfig      string                   `json:"kubeconfig"`
	ClusterNetwork  string                   `json:"clusterNetwork"`
	DefaultNetworks []string                 `json:"defaultNetworks"`
	LogFile         string                   `json:"logFile"`
	LogLevel        string                   `json:"logLevel"`
	RuntimeConfig   *RuntimeConfig           `json:"runtimeConfig,omitempty"`
	// Default network readiness options
	ReadinessIndicatorFile string `json:"readinessindicatorfile"`
	// Option to isolate the usage of CR's to the namespace in which a pod resides.
	NamespaceIsolation bool `json:"namespaceIsolation"`
	// Option to set system namespaces (to avoid to add defaultNetworks)
	SystemNamespaces []string `json:"systemNamespaces"`
	// Option to set the namespace that multus-cni uses (clusterNetwork/defaultNetworks)
	MultusNamespace string `json:"multusNamespace"`
}

NetConf for cni config file written in json

func LoadNetConf

func LoadNetConf(bytes []byte) (*NetConf, error)

LoadNetConf converts inputs (i.e. stdin) to NetConf

func (*NetConf) AddDelegates

func (n *NetConf) AddDelegates(newDelegates []*DelegateNetConf) error

AddDelegates appends the new delegates to the delegates list

type NetworkAttachmentDefinitionSpec

type NetworkAttachmentDefinitionSpec struct {
	// Config contains a standard JSON-encoded CNI configuration
	// or configuration list which defines the plugin chain to
	// execute.  If present, this key takes precedence over
	// ‘Plugin’.
	// +optional
	Config string `json:"config"`
}

NetworkAttachmentDefinitionSpec represents net-attach-def spec of K8s NPWG spec

type NetworkDefinition

type NetworkDefinition struct {
	metav1.TypeMeta `json:",inline"`
	// Note that ObjectMeta is mandatory, as an object
	// name is required
	Metadata metav1.ObjectMeta `json:"metadata,omitempty" description:"standard object metadata"`

	// Specification describing how to invoke a CNI plugin to
	// add or remove network attachments for a Pod.
	// In the absence of valid keys in a Spec, the runtime (or
	// meta-plugin) should load and execute a CNI .configlist
	// or .config (in that order) file on-disk whose JSON
	// “name” key matches this Network object’s name.
	// +optional
	Spec NetworkAttachmentDefinitionSpec `json:"spec"`
}

NetworkDefinition represents net-attach-def of K8s NPWG spec

type NetworkSelectionElement

type NetworkSelectionElement struct {
	// Name contains the name of the Network object this element selects
	Name string `json:"name"`
	// Namespace contains the optional namespace that the network referenced
	// by Name exists in
	Namespace string `json:"namespace,omitempty"`
	// IPRequest contains an optional requested IP address for this network
	// attachment
	IPRequest string `json:"ips,omitempty"`
	// MacRequest contains an optional requested MAC address for this
	// network attachment
	MacRequest string `json:"mac,omitempty"`
	// InterfaceRequest contains an optional requested name for the
	// network interface this attachment will create in the container
	InterfaceRequest string `json:"interface,omitempty"`
	// ObsoateInterfaceRequest is obsolated parameter at pre 3.2.
	// This will be removed in 4.0 release.
	ObsolatedInterfaceRequest string `json:"interfaceRequest,omitempty"`
}

NetworkSelectionElement represents one element of the JSON format Network Attachment Selection Annotation as described in section 4.1.2 of the CRD specification.

type NetworkStatus

type NetworkStatus struct {
	Name      string    `json:"name"`
	Interface string    `json:"interface,omitempty"`
	IPs       []string  `json:"ips,omitempty"`
	Mac       string    `json:"mac,omitempty"`
	Default   bool      `json:"default,omitempty"`
	DNS       types.DNS `json:"dns,omitempty"`
}

NetworkStatus is for network status annotation for pod

func LoadNetworkStatus

func LoadNetworkStatus(r types.Result, netName string, defaultNet bool) (*NetworkStatus, error)

LoadNetworkStatus create network status from CNI result

type PortMapEntry

type PortMapEntry struct {
	HostPort      int    `json:"hostPort"`
	ContainerPort int    `json:"containerPort"`
	Protocol      string `json:"protocol"`
	HostIP        string `json:"hostIP,omitempty"`
}

PortMapEntry for CNI PortMapEntry

type ResourceClient

type ResourceClient interface {
	// GetPodResourceMap returns an instance of a map of Pod ResourceInfo given a (Pod name, namespace) tuple
	GetPodResourceMap(*v1.Pod) (map[string]*ResourceInfo, error)
}

ResourceClient provides a kubelet Pod resource handle

type ResourceInfo

type ResourceInfo struct {
	Index     int
	DeviceIDs []string
}

ResourceInfo is struct to hold Pod device allocation information

type RuntimeConfig

type RuntimeConfig struct {
	PortMaps []PortMapEntry `json:"portMappings,omitempty"`
}

RuntimeConfig specifies CNI RuntimeConfig