system

Documentation

Index

• func AuthorizeSSHKeys(user string, keysName string, keys []string) error
• func CreateUser(u *User) error
• func DaemonReload() error
• func EnableUnitFile(unit string, runtime bool) error
• func EnsureDirectoryExists(dir string) error
• func ExecuteScript(scriptPath string) (string, error)
• func Hostname() (string, error)
• func MachineID(root string) string
• func MaskUnit(unit *Unit, root string) error
• func PlaceUnit(u *Unit, dst string) error
• func RestartNetwork(interfaces []network.InterfaceGenerator) (err error)
• func RunUnitCommand(command, unit string) (string, error)
• func SetHostname(hostname string) error
• func SetUserPassword(user, hash string) error
• func UnmaskUnit(unit *Unit, root string) error
• func UserExists(u *User) bool
• func WriteEnvFile(ef *EnvFile, root string) error
• func WriteFile(f *File, root string) (string, error)
• func WriteNetworkdConfigs(interfaces []network.InterfaceGenerator) error
• type EnvFile
• type File
  • func (f *File) Permissions() (os.FileMode, error)
• type Script
• type Unit
  • func (u *Unit) Destination(root string) string
  • func (u *Unit) Group() (group string)
  • func (u *Unit) Type() string
• type User

Functions

func AuthorizeSSHKeys

func AuthorizeSSHKeys(user string, keysName string, keys []string) error

Add the provide SSH public key to the core user's list of authorized keys

func CreateUser

func CreateUser(u *User) error

func DaemonReload

func DaemonReload() error

func EnableUnitFile

func EnableUnitFile(unit string, runtime bool) error

func EnsureDirectoryExists

func EnsureDirectoryExists(dir string) error

func ExecuteScript

func ExecuteScript(scriptPath string) (string, error)

func Hostname

func Hostname() (string, error)

func MachineID

func MachineID(root string) string

func MaskUnit

func MaskUnit(unit *Unit, root string) error

MaskUnit masks the given Unit by symlinking its unit file to /dev/null, analogous to `systemctl mask`. N.B.: Unlike `systemctl mask`, this function will *remove any existing unit file at the location*, to ensure that the mask will succeed.

func PlaceUnit

func PlaceUnit(u *Unit, dst string) error

PlaceUnit writes a unit file at the provided destination, creating parent directories as necessary.

func RestartNetwork

func RestartNetwork(interfaces []network.InterfaceGenerator) (err error)

func RunUnitCommand

func RunUnitCommand(command, unit string) (string, error)

func SetHostname

func SetHostname(hostname string) error

func SetUserPassword

func SetUserPassword(user, hash string) error

func UnmaskUnit

func UnmaskUnit(unit *Unit, root string) error

UnmaskUnit is analogous to systemd's unit_file_unmask. If the file associated with the given Unit is empty or appears to be a symlink to /dev/null, it is removed.

func UserExists

func UserExists(u *User) bool

func WriteEnvFile

func WriteEnvFile(ef *EnvFile, root string) error

WriteEnvFile updates an existing env `KEY=value` formated file with new values provided in EnvFile.Vars; File.Content is ignored. Existing ordering and any unknown formatting such as comments are preserved. If no changes are required the file is untouched.

func WriteFile

func WriteFile(f *File, root string) (string, error)

func WriteNetworkdConfigs

func WriteNetworkdConfigs(interfaces []network.InterfaceGenerator) error

Types

type EnvFile

type EnvFile struct {
	Vars map[string]string
	// mask File.Content, it shouldn't be used.
	Content interface{} `json:"-" yaml:"-"`
	*File
}

type File

type File struct {
	Encoding           string
	Content            string
	Owner              string
	Path               string
	RawFilePermissions string `yaml:"permissions"`
}

func (*File) Permissions

func (f *File) Permissions() (os.FileMode, error)

type Script

type Script []byte

type Unit

type Unit struct {
	Name    string
	Mask    bool
	Enable  bool
	Runtime bool
	Content string
	Command string

	// For drop-in units, a cloudinit.conf is generated.
	// This is currently unbound in YAML (and hence unsettable in cloud-config files)
	// until the correct behaviour for multiple drop-in units is determined.
	DropIn bool `yaml:"-"`
}

func (*Unit) Destination

func (u *Unit) Destination(root string) string

Destination builds the appropriate absolute file path for the Unit. The root argument indicates the effective base directory of the system (similar to a chroot).

func (*Unit) Group

func (u *Unit) Group() (group string)

func (*Unit) Type

func (u *Unit) Type() string

type User

type User struct {
	Name                string   `yaml:"name"`
	PasswordHash        string   `yaml:"passwd"`
	SSHAuthorizedKeys   []string `yaml:"ssh-authorized-keys"`
	SSHImportGithubUser string   `yaml:"coreos-ssh-import-github"`
	SSHImportURL        string   `yaml:"coreos-ssh-import-url"`
	GECOS               string   `yaml:"gecos"`
	Homedir             string   `yaml:"homedir"`
	NoCreateHome        bool     `yaml:"no-create-home"`
	PrimaryGroup        string   `yaml:"primary-group"`
	Groups              []string `yaml:"groups"`
	NoUserGroup         bool     `yaml:"no-user-group"`
	System              bool     `yaml:"system"`
	NoLogInit           bool     `yaml:"no-log-init"`
}