forge

Documentation

Index

• Constants
• func AddGroup(name string) error
• func AddMounts(mounts []*api.Mount) error
• func AddSshAuthorizedKeys(user string, keys []string) error
• func AddUser(name, passwd string) error
• func AddUserToGroup(name, group string) error
• func Error(message string) error
• func ErrorE(message string, err error) error
• func ErrorEF(message string, err error, fields log.Fields) error
• func ErrorF(message string, fields log.Fields) error
• func Forge(mc *api.MachineConfig) error
• func ForgeHostname(hostname string) error
• func ForgeInterfaces(interfaces []*api.Interface) error
• func ForgePhy(ifx *api.Interface) error
• func ForgeRootfs() error
• func ForgeRoutes() error
• func ForgeStaticRoutes(routes []*api.Route, interfaces []*api.Interface) error
• func ForgeUsers(users []*api.User) error
• func ForgeVlan(ifx *api.Interface) error
• func ForgeVxlan(ifx *api.Interface) error
• func GetIds() ([]string, error)
• func ValidateAddress(addr string) bool
• func ValidateDHCP(dhcp string) bool
• type FSTab
• type FSTabFile
  • func (f *FSTabFile) AddFSTabEntry(mount *api.Mount) error
  • func (f *FSTabFile) FSTabParse() error
  • func (f *FSTabFile) FSTabWrite() error
  • func (f *FSTabFile) FindEntryByDevice(device string) *FSTab
  • func (f *FSTabFile) RunMount() error
• type PosixUser
  • func GetPosixUser(name string) (*PosixUser, error)
• type SystemdConfig
  • func Read(filename string) (SystemdConfig, error)
  • func (c SystemdConfig) MatchName(name string)
  • func (c SystemdConfig) Netdev(name, kind string)
  • func (c SystemdConfig) NetdevVlan(vid int)
  • func (c SystemdConfig) PushSection(section string)
  • func (c SystemdConfig) SetAddress(value string)
  • func (c SystemdConfig) SetDHCP(value string)
  • func (c SystemdConfig) SetEntry(section, name, value string)
  • func (c SystemdConfig) SetMtu(value int)
  • func (c SystemdConfig) SetVlan(name string, vid int)
  • func (c SystemdConfig) Write(name, kind string) error

Constants

const (
	WireguardSubnet = "192.168.254.0/24"

	//TODO get from foundryd
	InfranetGateway = "172.30.0.1"
)

Functions

func AddGroup

func AddGroup(name string) error

func AddMounts

func AddMounts(mounts []*api.Mount) error

AddMounts adds mounts to node

func AddSshAuthorizedKeys

func AddSshAuthorizedKeys(user string, keys []string) error

func AddUser

func AddUser(name, passwd string) error

func AddUserToGroup

func AddUserToGroup(name, group string) error

func Error

func Error(message string) error

Error creates an error, and logs it righteously

func ErrorE

func ErrorE(message string, err error) error

Encapsulate err in a structured log and return an abstracted high-level error with message as the payload

func ErrorEF

func ErrorEF(message string, err error, fields log.Fields) error

Encapsulate fields and err in a structured log and return an abstracted high-level error with message as the payload

func ErrorF

func ErrorF(message string, fields log.Fields) error

Encapsulate fields in a structured log and return an abstracted high-level error with message as the payload

func Forge

func Forge(mc *api.MachineConfig) error

Forge is the top level function responsible for implementing "forging" a set of foundry instructions onto a node

func ForgeHostname

func ForgeHostname(hostname string) error

func ForgeInterfaces

func ForgeInterfaces(interfaces []*api.Interface) error

func ForgePhy

func ForgePhy(ifx *api.Interface) error

func ForgeRootfs

func ForgeRootfs() error

func ForgeRoutes

func ForgeRoutes() error

func ForgeStaticRoutes

func ForgeStaticRoutes(routes []*api.Route, interfaces []*api.Interface) error

func ForgeUsers

func ForgeUsers(users []*api.User) error

func ForgeVlan

func ForgeVlan(ifx *api.Interface) error

func ForgeVxlan

func ForgeVxlan(ifx *api.Interface) error

TODO

func GetIds

func GetIds() ([]string, error)

func ValidateAddress

func ValidateAddress(addr string) bool

func ValidateDHCP

func ValidateDHCP(dhcp string) bool

Types

type FSTab

type FSTab struct {
	Device    string
	Directory string
	Type      string
	Options   []string
	Dump      int
	Fsck      int
}

FSTab is the internal fstab format

type FSTabFile

type FSTabFile struct {
	// Entries is a linux user to FsTab Entry, the user key, tells us how to chown the directory
	// username: /mnt, /dev, ...
	Entries map[string][]*FSTab
}

FSTabFile wraps all the FSTab entries in /etc/fstab

func (*FSTabFile) AddFSTabEntry

func (f *FSTabFile) AddFSTabEntry(mount *api.Mount) error

AddFSTabEntry places entries into fstab for durability

func (*FSTabFile) FSTabParse

func (f *FSTabFile) FSTabParse() error

FSTabParse parses fstab file

func (*FSTabFile) FSTabWrite

func (f *FSTabFile) FSTabWrite() error

FSTabWrite writes out the fstab file

func (*FSTabFile) FindEntryByDevice

func (f *FSTabFile) FindEntryByDevice(device string) *FSTab

FindEntryByDevice checks fstab file for an entry using specified device

func (*FSTabFile) RunMount

func (f *FSTabFile) RunMount() error

RunMount runs the mount command to mount all items in fstab

type PosixUser

type PosixUser struct {
	Uid      int
	Gid      int
	Username string
	Name     string
	HomeDir  string
}

func GetPosixUser

func GetPosixUser(name string) (*PosixUser, error)

type SystemdConfig

type SystemdConfig map[string][]*unit.UnitSection

SystemdConfig keeps track of the UnitSections we are writing and updating.

func Read

func Read(filename string) (SystemdConfig, error)

Read and parse the given unit file into a SystemdConfig instance.

func (SystemdConfig) MatchName

func (c SystemdConfig) MatchName(name string)

MatchName creates Match Name unit file entry.

func (SystemdConfig) Netdev

func (c SystemdConfig) Netdev(name, kind string)

Netdev creates two unit file NetDev entries, Name and Kind.

func (SystemdConfig) NetdevVlan

func (c SystemdConfig) NetdevVlan(vid int)

NetdevVlan creates a VLAN Id unit file entry.

func (SystemdConfig) PushSection

func (c SystemdConfig) PushSection(section string)

PushSection starts a new section. Any SetEntries will be applied to the new section.

func (SystemdConfig) SetAddress

func (c SystemdConfig) SetAddress(value string)

SetAddress creates a Network Address unit file entry.

func (SystemdConfig) SetDHCP

func (c SystemdConfig) SetDHCP(value string)

SetDHCP configues systemd-networkd's dhcp value

func (SystemdConfig) SetEntry

func (c SystemdConfig) SetEntry(section, name, value string)

SetEntry appends the given name, value pair to newest section given.

func (SystemdConfig) SetMtu

func (c SystemdConfig) SetMtu(value int)

SetMtu creates a Link MTUBytes unit file entry.

func (SystemdConfig) SetVlan

func (c SystemdConfig) SetVlan(name string, vid int)

SetVlan creates a Network VLAN unti file entry.

func (SystemdConfig) Write

func (c SystemdConfig) Write(name, kind string) error

Write the current unit file entries to the appropriate Network config file.