networks

Documentation

Index

• Constants
• func ConfigFile() (string, error)
• func IsUsernet(name string) bool
• func Sock(name string) (string, error)
• func Sudoers() (string, error)
• type Config
  • func DefaultConfig() (Config, error)
  • func LoadConfig() (Config, error)
  • func (c *Config) Check(name string) error
  • func (c *Config) DaemonPath(daemon string) (string, error)
  • func (c *Config) IsDaemonInstalled(daemon string) (bool, error)
  • func (c *Config) LogFile(name, daemon, stream string) string
  • func (c *Config) MkdirCmd() string
  • func (c *Config) PIDFile(name, daemon string) string
  • func (c *Config) Sock(name string) string
  • func (c *Config) StartCmd(name, daemon string) string
  • func (c *Config) StopCmd(name, daemon string) string
  • func (c *Config) User(daemon string) (osutil.User, error)
  • func (c *Config) Usernet(name string) (bool, error)
  • func (c *Config) Validate() error
  • func (c *Config) VerifySudoAccess(sudoersFile string) error
• type Network
• type Paths

Constants

const (
	SlirpNICName = "eth0"
	// CIDR is intentionally hardcoded to 192.168.5.0/24, as each of QEMU has its own independent slirp network.
	SlirpNetwork   = "192.168.5.0/24"
	SlirpGateway   = "192.168.5.2"
	SlirpIPAddress = "192.168.5.15"
)

const (
	ModeUserV2  = "user-v2"
	ModeHost    = "host"
	ModeShared  = "shared"
	ModeBridged = "bridged"
)

const (
	SocketVMNet = "socket_vmnet"
)

Functions

func ConfigFile

func ConfigFile() (string, error)

func IsUsernet

func IsUsernet(name string) bool

IsUsernet returns true if the given network name is a usernet network. It return false if the cache cannot be loaded or the network is not defined.

func Sock

func Sock(name string) (string, error)

Sock returns a socket_vmnet socket.

func Sudoers

func Sudoers() (string, error)

Types

type Config

type Config struct {
	Paths    Paths              `yaml:"paths"`
	Group    string             `yaml:"group,omitempty"` // default: "everyone"
	Networks map[string]Network `yaml:"networks"`
}

func DefaultConfig

func DefaultConfig() (Config, error)

func LoadConfig

func LoadConfig() (Config, error)

LoadConfig returns the network cfg from the _config/networks.yaml file.

func (*Config) Check

func (c *Config) Check(name string) error

func (*Config) DaemonPath

func (c *Config) DaemonPath(daemon string) (string, error)

DaemonPath returns the daemon path.

func (*Config) IsDaemonInstalled

func (c *Config) IsDaemonInstalled(daemon string) (bool, error)

IsDaemonInstalled checks whether the daemon is installed.

func (*Config) LogFile

func (c *Config) LogFile(name, daemon, stream string) string

func (*Config) MkdirCmd

func (c *Config) MkdirCmd() string

func (*Config) PIDFile

func (c *Config) PIDFile(name, daemon string) string

func (*Config) Sock

func (c *Config) Sock(name string) string

Sock returns a socket_vmnet socket.

func (*Config) StartCmd

func (c *Config) StartCmd(name, daemon string) string

func (*Config) StopCmd

func (c *Config) StopCmd(name, daemon string) string

func (*Config) User

func (c *Config) User(daemon string) (osutil.User, error)

func (*Config) Usernet

func (c *Config) Usernet(name string) (bool, error)

Usernet returns true if the mode of given network is ModeUserV2.

func (*Config) Validate

func (c *Config) Validate() error

func (*Config) VerifySudoAccess

func (c *Config) VerifySudoAccess(sudoersFile string) error

type Network

type Network struct {
	Mode      string `yaml:"mode"`                // "host", "shared", or "bridged"
	Interface string `yaml:"interface,omitempty"` // only used by "bridged" networks
	Gateway   net.IP `yaml:"gateway,omitempty"`   // only used by "host" and "shared" networks
	DHCPEnd   net.IP `yaml:"dhcpEnd,omitempty"`   // default: same as Gateway, last byte is 254
	NetMask   net.IP `yaml:"netmask,omitempty"`   // default: 255.255.255.0
}

type Paths

type Paths struct {
	SocketVMNet string `yaml:"socketVMNet"`
	VarRun      string `yaml:"varRun"`
	Sudoers     string `yaml:"sudoers,omitempty"`
}