types

Documentation

Index

• Constants
• func GetKeyField(keyString string, v reflect.Value) reflect.Value
• func LoadArgs(args string, container interface{}) error
• func ParseCIDR(s string) (*net.IPNet, error)
• func PrintResult(result Result, version string) error
• type CommonArgs
• type DNS
  • func (d *DNS) Copy() *DNS
  • func (d *DNS) IsEmpty() bool
• type Error
  • func NewError(code uint, msg, details string) *Error
  • func (e *Error) Error() string
  • func (e *Error) Print() error
• type GCAttachment
• type IPAM
  • func (i *IPAM) IsEmpty() bool
• type IPNet
  • func (n IPNet) MarshalJSON() ([]byte, error)
  • func (n *IPNet) UnmarshalJSON(data []byte) error
• type NetConf
• type NetConfList
• type NetConfType
  • func (n *NetConfType) MarshalJSON() ([]byte, error)
• type Result
• type Route
  • func (r *Route) Copy() *Route
  • func (r Route) MarshalJSON() ([]byte, error)
  • func (r *Route) String() string
  • func (r *Route) UnmarshalJSON(data []byte) error
• type UnmarshalableArgsError
• type UnmarshallableBool
  • func (b *UnmarshallableBool) UnmarshalText(data []byte) error
• type UnmarshallableString
  • func (s *UnmarshallableString) UnmarshalText(data []byte) error

Constants

const (
	ErrUnknown                     uint = iota // 0
	ErrIncompatibleCNIVersion                  // 1
	ErrUnsupportedField                        // 2
	ErrUnknownContainer                        // 3
	ErrInvalidEnvironmentVariables             // 4
	ErrIOFailure                               // 5
	ErrDecodingFailure                         // 6
	ErrInvalidNetworkConfig                    // 7
	ErrInvalidNetNS                            // 8
	ErrTryAgainLater               uint = 11
	ErrInternal                    uint = 999
)

Well known error codes see https://github.com/containernetworking/cni/blob/main/SPEC.md#well-known-error-codes

Functions

func GetKeyField

func GetKeyField(keyString string, v reflect.Value) reflect.Value

GetKeyField is a helper function to receive Values Values that represent a pointer to a struct

func LoadArgs

func LoadArgs(args string, container interface{}) error

LoadArgs parses args from a string in the form "K=V;K2=V2;..."

func ParseCIDR

func ParseCIDR(s string) (*net.IPNet, error)

ParseCIDR takes a string like "10.2.3.1/24" and return IPNet with "10.2.3.1" and /24 mask

func PrintResult

func PrintResult(result Result, version string) error

Types

type CommonArgs

type CommonArgs struct {
	IgnoreUnknown UnmarshallableBool `json:"ignoreunknown,omitempty"`
}

CommonArgs contains the IgnoreUnknown argument and must be embedded by all Arg structs

type DNS

type DNS struct {
	Nameservers []string `json:"nameservers,omitempty"`
	Domain      string   `json:"domain,omitempty"`
	Search      []string `json:"search,omitempty"`
	Options     []string `json:"options,omitempty"`
}

DNS contains values interesting for DNS resolvers

func (*DNS) Copy

func (d *DNS) Copy() *DNS

func (*DNS) IsEmpty

func (d *DNS) IsEmpty() bool

IsEmpty returns true if DNS structure has no value, otherwise return false

type Error

type Error struct {
	Code    uint   `json:"code"`
	Msg     string `json:"msg"`
	Details string `json:"details,omitempty"`
}

func NewError

func NewError(code uint, msg, details string) *Error

func (*Error) Error

func (e *Error) Error() string

func (*Error) Print

func (e *Error) Print() error

type GCAttachment

type GCAttachment struct {
	ContainerID string `json:"containerID"`
	IfName      string `json:"ifname"`
}

GCAttachment is the parameters to a GC call -- namely, the container ID and ifname pair that represents a still-valid attachment.

type IPAM

type IPAM struct {
	Type string `json:"type,omitempty"`
}

func (*IPAM) IsEmpty

func (i *IPAM) IsEmpty() bool

IsEmpty returns true if IPAM structure has no value, otherwise return false

type IPNet

type IPNet net.IPNet

like net.IPNet but adds JSON marshalling and unmarshalling

func (IPNet) MarshalJSON

func (n IPNet) MarshalJSON() ([]byte, error)

func (*IPNet) UnmarshalJSON

func (n *IPNet) UnmarshalJSON(data []byte) error

type NetConf

type NetConf NetConfType

NetConf is defined as different type as custom MarshalJSON() and issue #1096

type NetConfList

type NetConfList struct {
	CNIVersion string `json:"cniVersion,omitempty"`

	Name         string     `json:"name,omitempty"`
	DisableCheck bool       `json:"disableCheck,omitempty"`
	DisableGC    bool       `json:"disableGC,omitempty"`
	Plugins      []*NetConf `json:"plugins,omitempty"`
}

NetConfList describes an ordered list of networks.

type NetConfType

type NetConfType struct {
	CNIVersion string `json:"cniVersion,omitempty"`

	Name         string          `json:"name,omitempty"`
	Type         string          `json:"type,omitempty"`
	Capabilities map[string]bool `json:"capabilities,omitempty"`
	IPAM         IPAM            `json:"ipam,omitempty"`
	DNS          DNS             `json:"dns,omitempty"`

	RawPrevResult map[string]interface{} `json:"prevResult,omitempty"`
	PrevResult    Result                 `json:"-"`

	// ValidAttachments is only supplied when executing a GC operation
	ValidAttachments []GCAttachment `json:"cni.dev/valid-attachments,omitempty"`
}

NetConfType describes a network.

func (*NetConfType) MarshalJSON

func (n *NetConfType) MarshalJSON() ([]byte, error)

Note: DNS should be omit if DNS is empty but default Marshal function will output empty structure hence need to write a Marshal function

type Result

type Result interface {
	// The highest CNI specification result version the result supports
	// without having to convert
	Version() string

	// Returns the result converted into the requested CNI specification
	// result version, or an error if conversion failed
	GetAsVersion(version string) (Result, error)

	// Prints the result in JSON format to stdout
	Print() error

	// Prints the result in JSON format to provided writer
	PrintTo(writer io.Writer) error
}

Result is an interface that provides the result of plugin execution

type Route

type Route struct {
	Dst      net.IPNet
	GW       net.IP
	MTU      int
	AdvMSS   int
	Priority int
	Table    *int
	Scope    *int
}

func (*Route) Copy

func (r *Route) Copy() *Route

func (Route) MarshalJSON

func (r Route) MarshalJSON() ([]byte, error)

func (*Route) String

func (r *Route) String() string

func (*Route) UnmarshalJSON

func (r *Route) UnmarshalJSON(data []byte) error

type UnmarshalableArgsError

type UnmarshalableArgsError struct {
	// contains filtered or unexported fields
}

UnmarshalableArgsError is used to indicate error unmarshalling args from the args-string in the form "K=V;K2=V2;..."

type UnmarshallableBool

type UnmarshallableBool bool

UnmarshallableBool typedef for builtin bool because builtin type's methods can't be declared

func (*UnmarshallableBool) UnmarshalText

func (b *UnmarshallableBool) UnmarshalText(data []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface. Returns boolean true if the string is "1" or "true" or "True" Returns boolean false if the string is "0" or "false" or "False”

type UnmarshallableString

type UnmarshallableString string

UnmarshallableString typedef for builtin string

func (*UnmarshallableString) UnmarshalText

func (s *UnmarshallableString) UnmarshalText(data []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface. Returns the string