unit

Documentation

Index

• Constants
• type SystemdUnitFile
  • func NewSystemdUnitFile(raw string) *SystemdUnitFile
  • func NewSystemdUnitFileFromLegacyContents(contents map[string]map[string]string) *SystemdUnitFile
  • func (self *SystemdUnitFile) Description() string
  • func (self *SystemdUnitFile) LegacyContents() map[string]map[string]string
  • func (self *SystemdUnitFile) Requirements() map[string][]string
  • func (self *SystemdUnitFile) String() string

Constants

const (
	// Require the unit be scheduled to a specific machine defined by given boot ID.
	FleetXConditionMachineBootID = "ConditionMachineBootID"
	// Limit eligible machines to the one that hosts a specific unit.
	FleetXConditionMachineOf = "ConditionMachineOf"
	// Prevent a unit from being collocated with other units using glob-matching on the other unit names.
	FleetXConflicts = "Conflicts"
)

Fleet specific unit file requirement keys. "X-" prefix only appears in unit file and dropped in code before value is used.

Types

type SystemdUnitFile

type SystemdUnitFile struct {
	// Contents represents the parsed unit file.
	// This field must be considered readonly.
	Contents map[string]map[string][]string
	// contains filtered or unexported fields
}

func NewSystemdUnitFile

func NewSystemdUnitFile(raw string) *SystemdUnitFile

func NewSystemdUnitFileFromLegacyContents

func NewSystemdUnitFileFromLegacyContents(contents map[string]map[string]string) *SystemdUnitFile

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

func (*SystemdUnitFile) Description

func (self *SystemdUnitFile) 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 (*SystemdUnitFile) LegacyContents

func (self *SystemdUnitFile) LegacyContents() map[string]map[string]string

LegacyContents serializes the contents of a unit file into an obsolete datastructure. This datastructure is lossy and should only be used to remain backwards-compatible where necessary.

func (*SystemdUnitFile) Requirements

func (self *SystemdUnitFile) Requirements() map[string][]string

Requirements returns all relevant options from the [X-Fleet] section of a unit file. Relevant options are identified with a `X-` prefix.

func (*SystemdUnitFile) String

func (self *SystemdUnitFile) String() string