cni

package module

v0.0.0-...-ef98665 Latest Latest Go to latest Published: Apr 24, 2020 License: Apache-2.0 Imports: 5 Imported by: 4

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/phdata/go-libcni

Links

Open Source Insights

README ¶

This repository holds some common structs and functions to use when working with CNI in Go.

Documentation ¶

Constants ¶

View Source

const (
	//CNIVersion is the cniVersion
	CNIVersion = "0.4.0"
)

Variables ¶

This section is empty.

Functions ¶

func PrepareExit ¶

func PrepareExit(err error, code int, message string) (int, []byte)

PrepareExit returns the error code and json bytes to be printed to stdout by the calling program

Types ¶

type Args ¶

type Args struct {
	Annotations map[string]string `json:"annotations"`
}

Args are additional arguments provided by the container runtime

type Config ¶

type Config struct {
	CNIVersion     string      `json:"cniVersion"`
	Name           string      `json:"name"`
	Type           string      `json:"type"`
	PreviousResult *Result     `json:"prevResult,omitempty"`
	Ipam           *IpamConfig `json:"ipam"`
	Args           *Args       `json:"args"`
}

Config represents the cni network config file

func NewConfig ¶

func NewConfig(confBytes []byte) (*Config, error)

NewConfig returns a new standard cni config object

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 represents the DNS structure in the Result

type Error ¶

type Error struct {
	Version string `json:"cniVersion"`
	Code    int    `json:"code"`
	Message string `json:"msg"`
	Details string `json:"details,omitempty"`
}

Error represents the object we return to runtime in the case of a failure

func NewDetailedError ¶

func NewDetailedError(code int, message, details string) *Error

NewDetailedError generates a new CNIError with details

func NewError ¶

func NewError(code int, message string) *Error

NewError generates a new CNIError

func (*Error) Marshal ¶

func (e *Error) Marshal() []byte

Marshal marshals the error into a json string

type IP ¶

type IP struct {
	Version   string `json:"version"`
	Address   string `json:"address"`
	Gateway   string `json:"gateway,omitempty"`
	Interface *int   `json:"interface,omitempty"`
}

IP represents the ip address in the Result

type Interface ¶

type Interface struct {
	Name    string `json:"name"`
	MAC     string `json:"mac,omitempty"`
	Sandbox string `json:"sandbox,omitempty"`
}

Interface represents the interface in the Result

type IpamConfig ¶

type IpamConfig struct {
	Type string `json:"type"`
}

IpamConfig represents the cni ipam config

type Result ¶

type Result struct {
	CNIVersion string       `json:"cniVersion"`
	Interfaces []*Interface `json:"interfaces,omitempty"`
	IPs        []*IP        `json:"ips"`
	Routes     []*Route     `json:"route,omitempty"`
	DNS        *DNS         `json:"dns,omitempty"`
}

Result represents the cni result given back to the caller

func (*Result) Marshal ¶

func (r *Result) Marshal() []byte