net

type MacvtapMode string

type Net interface {
	// Init performs any initialization that may be required by the virtualization
	// network sub-system.
	Init() error

	// Fingerprint interrogates the host system and populates the attribute
	// mapping with relevant network information. Any errors performing this
	// should be logged by the implementor, but not considered terminal, which
	// explains the lack of error response. Each entry should use
	// FingerprintAttributeKeyPrefix as a base.
	Fingerprint(map[string]*structs.Attribute)

	// VMStartedBuild performs any network configuration required once the
	// driver has successfully started a VM. Any error returned will be
	// considered terminal to the start of the VM and therefore halt any
	// further progress and result in the task being restarted.
	VMStartedBuild(*VMStartedBuildRequest) (*VMStartedBuildResponse, error)

	// VMTerminatedTeardown performs all the network teardown required to clean
	// the host and any systems of configuration specific to the task. If an
	// error is encountered, Nomad will retry the stop/kill process, so all
	// implementations must be able to support this and not enter death spirals
	// when an error occurs.
	VMTerminatedTeardown(*VMTerminatedTeardownRequest) (*VMTerminatedTeardownResponse, error)
}

type NetworkInterfaceBridgeConfig struct {

	// Name is the name of the bridge interface to use. This relates to the
	// output seen from commands such as "ip addr show" or "virsh net-info".
	Name string `codec:"name"`

	// Ports contains a list of port labels which will be exposed on the host
	// via mapping to the network interface. These labels must exist within the
	// job specification network block.
	Ports []string `codec:"ports"`
}

type NetworkInterfaceConfig struct {
	Bridge  *NetworkInterfaceBridgeConfig  `codec:"bridge"`
	Macvtap *NetworkInterfaceMacvtapConfig `codec:"macvtap"`
}

type NetworkInterfaceMacvtapConfig struct {

	// Device is the name of the lower (physical or virtual) network device
	// that the macvtap interface will be created on top of. This should match
	// an interface visible in "ip addr show" output (e.g. "eth0", "ens3").
	Device string `codec:"device"`

	// Mode controls the traffic isolation policy of the macvtap interface.
	// Accepted values are: "bridge", "private", "vepa", and "passthrough".
	// Defaults to "bridge" when not specified.
	Mode MacvtapMode `codec:"mode"`
}

type NetworkInterfacesConfig []*NetworkInterfaceConfig

type TeardownSpec struct {

	// IPTablesRules specifies the rules used to build the initial VM
	// networking. Each entry is a rule, the rule is a list of strings which
	// mimics how iptables is called.
	//   i[0] is the table name.
	//   i[1] is the chain name.
	//   i[2:] is the rule args.
	IPTablesRules [][]string

	// DHCPReservation specifies the reservation string used for registering
	// a DHCP address for a virtual machine.
	DHCPReservation string

	// Network is the name of the network used and which provided the
	// DHCP lease.
	Network string
}

type VMStartedBuildRequest struct {
	VMName    string
	Hostname  string
	NetConfig NetworkInterfacesConfig
	Resources *drivers.Resources
	Hwaddrs   []string
}

type VMStartedBuildResponse struct {

	// DriverNetwork is the object returned to Nomad once the task is started
	// and is used to populate service discovery. The network sub-system should
	// fill in all details; the driver will not do this and simply pass the
	// object straight onto Nomad.
	DriverNetwork *drivers.DriverNetwork

	// TeardownSpec contains a specification which will be stored in the task
	// handle and used when stopping/killing the task. It should include
	// information which either expedites the process or is critical to the
	// process.
	TeardownSpec *TeardownSpec
}

type VMTerminatedTeardownRequest struct {
	TeardownSpec *TeardownSpec
}

type VMTerminatedTeardownResponse struct{}