utils

Documentation

Index

• Constants
• Variables
• func FetchSysAttrs() error
• func GetDockerClient() (*dockerclient.DockerClient, error)
• func GetStateDriver() (core.StateDriver, error)
• func NewNetworkDriver(name, configStr string, instInfo *core.InstanceInfo) (core.NetworkDriver, error)
• func NewStateDriver(name, configStr string) (core.StateDriver, error)
• func ReleaseStateDriver()
• type LLDPNeighbor
• type SystemAttributes

Constants

const (
	// EtcdNameStr is a string constant for etcd state-store
	EtcdNameStr = "etcd"
	// ConsulNameStr is a string constant for consul state-store
	ConsulNameStr = "consul"
	// OvsNameStr is a string constant for ovs driver
	OvsNameStr = "ovs"
)

Variables

var (
	// DefaultHTTPHost Default HTTP Host
	DefaultHTTPHost = "localhost"
	// DefaultHTTPPort Default HTTP Port
	DefaultHTTPPort = 2375
	// DefaultUnixSocket Path for the unix socket.
	DefaultUnixSocket = "/var/run/docker.sock"
)

Functions

func FetchSysAttrs

func FetchSysAttrs() error

FetchSysAttrs would read the system attributes and store them in the exported vars for the plugin to use; some of the attributes may need OS spefici methods to fetch, thus the first attribute to fetch is the OS type

func GetDockerClient

func GetDockerClient() (*dockerclient.DockerClient, error)

GetDockerClient returns a new Docker Client based on the environment settings

func GetStateDriver

func GetStateDriver() (core.StateDriver, error)

GetStateDriver returns the singleton instance of the state-driver

func NewNetworkDriver

func NewNetworkDriver(name, configStr string, instInfo *core.InstanceInfo) (core.NetworkDriver, error)

NewNetworkDriver instantiates a 'named' network-driver with specified configuration

func NewStateDriver

func NewStateDriver(name, configStr string) (core.StateDriver, error)

NewStateDriver instantiates a 'named' state-driver with specified configuration

func ReleaseStateDriver

func ReleaseStateDriver()

ReleaseStateDriver releases the singleton instance of the state-driver

Types

type LLDPNeighbor

type LLDPNeighbor struct {
	SystemName        string
	SystemDescription string
	PortID            string
	PortDesc          string
	CiscoACIPodID     string
	CiscoACINodeID    string
}

LLDPNeighbor lists the neighbor attributes as learned by the host

type SystemAttributes

type SystemAttributes struct {
	OsType      string
	TotalRAM    int
	TotalDiskGB int
	TotalNetBw  int
}

SystemAttributes enlist the system specific attributes and are read upon the system start

var SysAttrs SystemAttributes

SysAttrs are the exported system attributes