types

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

type Endpoint struct {
	Node *NodeConfig
	// e1-x, eth, etc
	EndpointName string
	// mac address
	MAC string
}

type GenericContainer struct {
	Names           []string
	ID              string
	ShortID         string // trimmed ID for display purposes
	Image           string
	State           string
	Status          string
	Labels          map[string]string
	Pid             int
	NetworkSettings *GenericMgmtIPs
}

type GenericFilter struct {
	// defined by now "label"
	FilterType string
	// defines e.g. the label name for FilterType "label"
	Field string
	// = | != | exists
	Operator string
	// match value
	Match string
}

type GenericMgmtIPs struct {
	Set      bool
	IPv4addr string
	IPv4pLen int
	IPv6addr string
	IPv6pLen int
}

type Link struct {
	A      *Endpoint
	B      *Endpoint
	MTU    int
	Labels map[string]string
	Vars   map[string]string
}

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

type MgmtNet struct {
	Network    string `yaml:"network,omitempty"` // docker network name
	Bridge     string `yaml:"bridge,omitempty"`  // linux bridge backing the docker network (or containerd bridge net)
	IPv4Subnet string `yaml:"ipv4_subnet,omitempty"`
	IPv6Subnet string `yaml:"ipv6_subnet,omitempty"`
	MTU        string `yaml:"mtu,omitempty"`
}

type NodeConfig struct {
	ShortName        string // name of the Node inside topology YAML
	LongName         string // containerlab-prefixed unique container name
	Fqdn             string
	LabDir           string // LabDir is a directory related to the node, it contains config items and/or other persistent state
	Index            int
	Group            string
	Kind             string
	StartupConfig    string // path to config template file that is used for startup config generation
	ResStartupConfig string // path to config file that is actually mounted to the container and is a result of templation
	Config           *ConfigDispatcher
	ResConfig        string // path to config file that is actually mounted to the container and is a result of templation
	NodeType         string
	Position         string
	License          string
	Image            string
	Sysctls          map[string]string
	User             string
	Entrypoint       string
	Cmd              string
	Env              map[string]string
	Binds            []string    // Bind mounts strings (src:dest:options)
	PortBindings     nat.PortMap // PortBindings define the bindings between the container ports and host ports
	PortSet          nat.PortSet // PortSet define the ports that should be exposed on a container
	// container networking mode. if set to `host` the host networking will be used for this node, else bridged network
	NetworkMode          string
	MgmtNet              string // name of the docker network this node is connected to with its first interface
	MgmtIPv4Address      string
	MgmtIPv4PrefixLength int
	MgmtIPv6Address      string
	MgmtIPv6PrefixLength int
	MacAddress           string
	ContainerID          string
	TLSCert              string
	TLSKey               string
	TLSAnchor            string
	NSPath               string   // network namespace path for this node
	Publish              []string //list of ports to publish with mysocketctl
	// container labels
	Labels map[string]string
	// Slice of pointers to local endpoints
	Endpoints []*Endpoint
	// Ignite sandbox and kernel imageNames
	Sandbox, Kernel string
	// Configured container runtime
	Runtime string
}

type NodeDefinition struct {
	Kind          string            `yaml:"kind,omitempty"`
	Group         string            `yaml:"group,omitempty"`
	Type          string            `yaml:"type,omitempty"`
	StartupConfig string            `yaml:"startup-config,omitempty"`
	Config        *ConfigDispatcher `yaml:"config,omitempty"`
	Image         string            `yaml:"image,omitempty"`
	License       string            `yaml:"license,omitempty"`
	Position      string            `yaml:"position,omitempty"`
	Cmd           string            `yaml:"cmd,omitempty"`
	// list of bind mount compatible strings
	Binds []string `yaml:"binds,omitempty"`
	// list of port bindings
	Ports []string `yaml:"ports,omitempty"`
	// 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"`
	// 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"`
}

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