butler

Documentation

Index

• type Butler
  • func (b *Butler) Runner()
• type Msg

Types

type Butler

type Butler struct {
	Config     *config.Params // bmcbutler config + CLI params passed by the user.
	ButlerChan <-chan Msg
	Log        *logrus.Logger
	StopChan   <-chan struct{}
	SyncWG     *sync.WaitGroup
	WorkerPool *workerpool.WorkerPool

	Secrets *secrets.Store
	// contains filtered or unexported fields
}

Holds attributes required to spawn butlers.

func (*Butler) Runner

func (b *Butler) Runner()

Runner spawns a pool of butlers, waits until they are done.

type Msg

type Msg struct {
	Asset        asset.Asset // Asset to be configured
	AssetConfig  []byte      // The BMC configuration read in from configuration.yml
	AssetSetup   []byte      // The one-time-setup configuration read from setup.yml
	AssetExecute string      // Commands to be executed on the BMC
}

Represents butler messages passed over the butlerChan. These declare assets for butlers to carry actions on.