containerlab

Documentation

Index

• func GetPortPattern() *regexp.Regexp
• type CertificateConfig
• type Config
  • func LoadContainerlabConfig(rawConfig string) (*Config, error)
• type ConfigDispatcher
• type DNSConfig
• type Extras
• type LinkConfig
• type LinkDefinition
• type MgmtNet
• type NodeDefinition
• type Topology
  • func (t *Topology) GetNodeImage(nodeName string) string
  • func (t *Topology) GetNodeKindType(nodeName string) (containerlabKind, containerlabType string)
  • func (t *Topology) GetNodeLicense(nodeName string) string
• type TypedPort
  • func ProcessPortDefinition(portDefinition string) (*TypedPort, error)
  • func (t *TypedPort) AsContainerlabPortDefinition() string

Functions

func GetPortPattern

func GetPortPattern() *regexp.Regexp

GetPortPattern returns a compiled regex to parse containerlab port definitions.

Types

type CertificateConfig

type CertificateConfig struct {
	// default false value indicates that the node does not use TLS
	Issue bool `yaml:"issue,omitempty"`
}

CertificateConfig represents the configuration of a TLS infrastructure used by a node.

type Config

type Config struct {
	// Lab name
	Name string `yaml:"name"`
	// Lab prefix
	Prefix *string `yaml:"prefix,omitempty"`
	// Management network configuration
	Mgmt *MgmtNet `yaml:"mgmt,omitempty"`
	// Topology definition
	Topology *Topology `yaml:"topology,omitempty"`
	// Debug mode flag
	Debug bool `yaml:"debug"`
}

Config defines lab configuration as it is provided in the YAML file.

func LoadContainerlabConfig

func LoadContainerlabConfig(rawConfig string) (*Config, error)

LoadContainerlabConfig loads a containerlab config definition from a raw containerlab config.

type ConfigDispatcher

type ConfigDispatcher struct {
	Vars map[string]interface{} `yaml:"vars,omitempty"`
}

ConfigDispatcher represents the config of a configuration machine that is responsible to execute configuration commands on the nodes after they started.

type DNSConfig

type DNSConfig struct {
	// DNS servers
	Servers []string `yaml:"servers,omitempty"`
	// DNS options
	Options []string `yaml:"options,omitempty"`
	// DNS Search Domains
	Search []string `yaml:"search,omitempty"`
}

DNSConfig represents DNS configuration options a node has.

type Extras

type Extras struct {
	SRLAgents []string `yaml:"srl-agents,omitempty"`
	// Nokia SR Linux agents. As of now just the agents spec files can be provided here
	MysocketProxy string `yaml:"mysocket-proxy,omitempty"`
	// Proxy address that mysocketctl will use
	CeosCopyToFlash []string `yaml:"ceos-copy-to-flash,omitempty"`
}

Extras contains extra node parameters which are not entitled to be part of a generic node config.

type LinkConfig

type LinkConfig struct {
	Endpoints []string
	Labels    map[string]string      `yaml:"labels,omitempty"`
	Vars      map[string]interface{} `yaml:"vars,omitempty"`
	MTU       int                    `yaml:"mtu,omitempty"`
}

LinkConfig is the vendor'd (ish) clab link config object.

type LinkDefinition

type LinkDefinition struct {
	Type       string `yaml:"type,omitempty"`
	LinkConfig `       yaml:",inline"`
}

LinkDefinition represents a link definition in the topology file.

type MgmtNet

type MgmtNet struct {
	Network        string `yaml:"network,omitempty"`
	IPv4Subnet     string `yaml:"ipv4-subnet,omitempty"`
	IPv4Gw         string `yaml:"ipv4-gw,omitempty"`
	IPv4Range      string `yaml:"ipv4-range,omitempty"`
	IPv6Subnet     string `yaml:"ipv6-subnet,omitempty"`
	IPv6Gw         string `yaml:"ipv6-gw,omitempty"`
	IPv6Range      string `yaml:"ipv6-range,omitempty"`
	MTU            int    `yaml:"mtu,omitempty"`
	ExternalAccess *bool  `yaml:"external-access,omitempty"`
}

MgmtNet struct defines the management network options.

type NodeDefinition

type NodeDefinition struct {
	Kind                 string            `yaml:"kind,omitempty"`
	Group                string            `yaml:"group,omitempty"`
	Type                 string            `yaml:"type,omitempty"`
	StartupConfig        string            `yaml:"startup-config,omitempty"`
	StartupDelay         uint              `yaml:"startup-delay,omitempty"`
	EnforceStartupConfig bool              `yaml:"enforce-startup-config,omitempty"`
	AutoRemove           *bool             `yaml:"auto-remove,omitempty"`
	Config               *ConfigDispatcher `yaml:"config,omitempty"`
	Image                string            `yaml:"image,omitempty"`
	ImagePullPolicy      string            `yaml:"image-pull-policy,omitempty"`
	License              string            `yaml:"license,omitempty"`
	Position             string            `yaml:"position,omitempty"`
	Entrypoint           string            `yaml:"entrypoint,omitempty"`
	Cmd                  string            `yaml:"cmd,omitempty"`
	// list of subject Alternative Names (SAN) to be added to the node's certificate
	SANs []string `yaml:"SANs,omitempty"`
	// list of commands to run in container
	Exec []string `yaml:"exec,omitempty"`
	// list of bind mount compatible strings
	Binds []string `yaml:"binds,omitempty"`
	// list of port bindings -- *NOTE* we dropped omitempty, this is different than normal clab, we
	// do this because when comparing topos during reconciliation we had some nil and some empty
	// slices which reflect deep equal says are not the same (because duh, but also come on man!)
	Ports []string `yaml:"ports"`
	// user-defined IPv4 address in the management network
	MgmtIPv4 string `yaml:"mgmt-ipv4,omitempty"`
	// user-defined IPv6 address in the management network
	MgmtIPv6 string `yaml:"mgmt-ipv6,omitempty"`
	// list of ports to publish with mysocketctl
	Publish []string `yaml:"publish,omitempty"`
	// environment variables
	Env map[string]string `yaml:"env,omitempty"`
	// external file containing environment variables
	EnvFiles []string `yaml:"env-files,omitempty"`
	// linux user used in a container
	User string `yaml:"user,omitempty"`
	// container labels
	Labels map[string]string `yaml:"labels,omitempty"`
	// container networking mode. if set to `host` the host networking will be used for this
	// node, else bridged network
	NetworkMode string `yaml:"network-mode,omitempty"`
	// Ignite sandbox and kernel imageNames
	Sandbox string `yaml:"sandbox,omitempty"`
	Kernel  string `yaml:"kernel,omitempty"`
	// Override container runtime
	Runtime string `yaml:"runtime,omitempty"`
	// Set node CPU (cgroup or hypervisor)
	CPU float64 `yaml:"cpu,omitempty"`
	// Set node CPUs to use
	CPUSet string `yaml:"cpu-set,omitempty"`
	// Set node Memory (cgroup or hypervisor)
	Memory string `yaml:"memory,omitempty"`
	// Set the nodes Sysctl
	Sysctls map[string]string `yaml:"sysctls,omitempty"`
	// Extra options, may be kind specific
	Extras *Extras `yaml:"extras,omitempty"`
	// List of node names to wait for before satarting this particular node
	WaitFor []string `yaml:"wait-for,omitempty"`
	// DNS configuration
	DNS *DNSConfig `yaml:"dns,omitempty"`
	// Certificate Configuration
	Certificate *CertificateConfig `yaml:"certificate,omitempty"`
}

NodeDefinition represents a configuration a given node can have in the lab definition file.

type Topology

type Topology struct {
	Defaults *NodeDefinition            `yaml:"defaults"`
	Kinds    map[string]*NodeDefinition `yaml:"kinds,omitempty"`
	Nodes    map[string]*NodeDefinition `yaml:"nodes,omitempty"`
	Links    []*LinkDefinition          `yaml:"links,omitempty"`
}

Topology represents a lab topology.

func (*Topology) GetNodeImage

func (t *Topology) GetNodeImage(nodeName string) string

GetNodeImage returns the resolved image for the given node.

func (*Topology) GetNodeKindType

func (t *Topology) GetNodeKindType(nodeName string) (
	containerlabKind,
	containerlabType string,
)

GetNodeKindType returns the kind and type of the given node name -- it cannot fail, it can only return empty strings.

func (*Topology) GetNodeLicense

func (t *Topology) GetNodeLicense(nodeName string) string

GetNodeLicense returns the resolved license for the given node.

type TypedPort

type TypedPort struct {
	Protocol        string
	ExposePort      int64
	DestinationPort int64
}

TypedPort holds typed data about a containerlab port entry.

func ProcessPortDefinition

func ProcessPortDefinition(portDefinition string) (*TypedPort, error)

ProcessPortDefinition accepts a "portDefinition" from a containerlab topology and returns a `TypedPort` object. It returns an error if it cannot cast a port value to an integer.

func (*TypedPort) AsContainerlabPortDefinition

func (t *TypedPort) AsContainerlabPortDefinition() string

AsContainerlabPortDefinition returns the `TypedPort` object as a valid containerlab port entry.