unit

Documentation

Index

• func DefaultUnitType(name string) string
• func RecognizedUnitType(name string) bool
• type FakeUnitManager
  • func NewFakeUnitManager() *FakeUnitManager
  • func (fum *FakeUnitManager) GetUnitState(name string) (us *UnitState, err error)
  • func (fum *FakeUnitManager) GetUnitStates(filter pkg.Set) (map[string]*UnitState, error)
  • func (fum *FakeUnitManager) Load(name string, u Unit) error
  • func (fum *FakeUnitManager) MarshalJSON() ([]byte, error)
  • func (fum *FakeUnitManager) Start(string)
  • func (fum *FakeUnitManager) Stop(string)
  • func (fum *FakeUnitManager) Units() ([]string, error)
  • func (fum *FakeUnitManager) Unload(name string)
• type Hash
  • func (h *Hash) Empty() bool
  • func (h Hash) Short() string
  • func (h Hash) String() string
• type Unit
  • func NewUnit(raw string) (*Unit, error)
  • func NewUnitFromLegacyContents(contents map[string]map[string]string) (*Unit, error)
  • func (u *Unit) Description() string
  • func (u *Unit) Hash() Hash
  • func (u *Unit) String() string
• type UnitManager
• type UnitNameInfo
  • func NewUnitNameInfo(un string) *UnitNameInfo
  • func (nu UnitNameInfo) IsInstance() bool
• type UnitState
  • func NewUnitState(loadState, activeState, subState, mID string) *UnitState
• type UnitStateGenerator
  • func NewUnitStateGenerator(mgr UnitManager) *UnitStateGenerator
  • func (g *UnitStateGenerator) Generate() (<-chan *UnitStateHeartbeat, error)
  • func (g *UnitStateGenerator) Run(receiver chan<- *UnitStateHeartbeat, stop chan bool)
  • func (g *UnitStateGenerator) Subscribe(name string)
  • func (g *UnitStateGenerator) Unsubscribe(name string)
• type UnitStateHeartbeat

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 FakeUnitManager

type FakeUnitManager struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewFakeUnitManager

func NewFakeUnitManager() *FakeUnitManager

func (*FakeUnitManager) GetUnitState

func (fum *FakeUnitManager) GetUnitState(name string) (us *UnitState, err error)

func (*FakeUnitManager) GetUnitStates

func (fum *FakeUnitManager) GetUnitStates(filter pkg.Set) (map[string]*UnitState, error)

func (*FakeUnitManager) Load

func (fum *FakeUnitManager) Load(name string, u Unit) error

func (*FakeUnitManager) MarshalJSON

func (fum *FakeUnitManager) MarshalJSON() ([]byte, error)

func (*FakeUnitManager) Start

func (fum *FakeUnitManager) Start(string)

func (*FakeUnitManager) Stop

func (fum *FakeUnitManager) Stop(string)

func (*FakeUnitManager) Units

func (fum *FakeUnitManager) Units() ([]string, error)

func (*FakeUnitManager) Unload

func (fum *FakeUnitManager) Unload(name string)

type Hash

type Hash [sha1.Size]byte

SHA1 sum

func (*Hash) Empty

func (h *Hash) Empty() bool

func (Hash) Short

func (h Hash) Short() string

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, error)

func NewUnitFromLegacyContents

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

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 UnitManager

type UnitManager interface {
	Load(string, Unit) error
	Unload(string)

	Start(string)
	Stop(string)

	Units() ([]string, error)
	GetUnitStates(pkg.Set) (map[string]*UnitState, error)
	GetUnitState(string) (*UnitState, error)
}

type UnitNameInfo

type UnitNameInfo struct {
	FullName string // Original complete name of the unit (e.g. foo.socket, foo@bar.service)
	Name     string // Name of the unit without suffix (e.g. foo, foo@bar)
	Prefix   string // Prefix of the template unit (e.g. foo)

	// If the unit represents an instance or a template, the following values are set
	Template string // Name of the canonical template unit (e.g. foo@.service)
	Instance string // Instance name (e.g. bar)
}

UnitNameInfo exposes certain interesting items about a Unit based on its name. For example, a unit with the name "foo@.service" constitutes a template unit, and a unit named "foo@1.service" would represent an instance unit of that template.

func NewUnitNameInfo

func NewUnitNameInfo(un string) *UnitNameInfo

NewUnitNameInfo generates a UnitNameInfo from the given name. If the given string is not a correct unit name, nil is returned.

func (UnitNameInfo) IsInstance

func (nu UnitNameInfo) IsInstance() bool

IsInstance returns a boolean indicating whether the UnitNameInfo appears to be an Instance of a Template unit

type UnitState

type UnitState struct {
	LoadState   string
	ActiveState string
	SubState    string
	MachineID   string
	UnitHash    string
}

UnitState encodes the current state of a unit loaded into a fleet agent

func NewUnitState

func NewUnitState(loadState, activeState, subState, mID string) *UnitState

type UnitStateGenerator

type UnitStateGenerator struct {
	// contains filtered or unexported fields
}

func NewUnitStateGenerator

func NewUnitStateGenerator(mgr UnitManager) *UnitStateGenerator

func (*UnitStateGenerator) Generate

func (g *UnitStateGenerator) Generate() (<-chan *UnitStateHeartbeat, error)

Generate returns and fills a channel with *UnitStateHeartbeat objects. Objects will only be returned for units to which this generator is currently subscribed.

func (*UnitStateGenerator) Run

func (g *UnitStateGenerator) Run(receiver chan<- *UnitStateHeartbeat, stop chan bool)

Run periodically calls Generate and sends received *UnitStateHeartbeat objects to the provided channel.

func (*UnitStateGenerator) Subscribe

func (g *UnitStateGenerator) Subscribe(name string)

Subscribe adds a unit to the internal state filter

func (*UnitStateGenerator) Unsubscribe

func (g *UnitStateGenerator) Unsubscribe(name string)

Unsubscribe removes a unit from the internal state filter

type UnitStateHeartbeat

type UnitStateHeartbeat struct {
	Name  string
	State *UnitState
}