unit

Documentation

Index

• func DefaultUnitType(name string) string
• func RecognizedUnitType(name string) bool
• type Hash
  • func (h *Hash) Empty() bool
  • func (h Hash) String() string
• type Unit
  • func NewUnit(raw string) *Unit
  • func NewUnitFromLegacyContents(contents map[string]map[string]string) *Unit
  • func (u *Unit) Description() string
  • func (u *Unit) Hash() Hash
  • func (u *Unit) String() string
• type UnitState
  • func NewUnitState(loadState, activeState, subState string, ms *machine.MachineState) *UnitState

Functions

func DefaultUnitType

func DefaultUnitType(name string) string

DefaultUnitType appends the default unit type to a given unit name, ignoring any file extensions that already exist.

func RecognizedUnitType

func RecognizedUnitType(name string) bool

RecognizedUnitType determines whether or not the given unit name represents a recognized unit type.

Types

type Hash

type Hash [sha1.Size]byte

SHA1 sum

func (*Hash) Empty

func (h *Hash) Empty() bool

func (Hash) String

func (h Hash) String() string

type Unit

type Unit struct {
	// Contents represents the parsed unit file.
	// This field must be considered readonly.
	Contents map[string]map[string][]string

	// Raw represents the entire contents of the unit file.
	Raw string
}

A Unit represents a systemd configuration which encodes information about any of the unit types that fleet supports (as defined in SupportedUnitTypes()). Units are linked to Jobs by the Hash of their contents. Similar to systemd, a Unit configuration has no inherent name, but is rather named through the reference to it; in the case of systemd, the reference is the filename, and in the case of fleet, the reference is the name of the job that references this Unit.

func NewUnit

func NewUnit(raw string) *Unit

func NewUnitFromLegacyContents

func NewUnitFromLegacyContents(contents map[string]map[string]string) *Unit

NewUnitFromLegacyContents creates a Unit object from an obsolete unit file datastructure. This should only be used to remain backwards-compatible where necessary.

func (*Unit) Description

func (u *Unit) Description() string

Description returns the first Description option found in the Unit section. If the option is not defined, an empty string is returned.

func (*Unit) Hash

func (u *Unit) Hash() Hash

Hash returns the SHA1 hash of the raw contents of the Unit

func (*Unit) String

func (u *Unit) String() string

type UnitState

type UnitState struct {
	LoadState    string                `json:"loadState"`
	ActiveState  string                `json:"activeState"`
	SubState     string                `json:"subState"`
	MachineState *machine.MachineState `json:"machineState"`
}

UnitState encodes the current state of a unit loaded into systemd

func NewUnitState

func NewUnitState(loadState, activeState, subState string, ms *machine.MachineState) *UnitState