butler

Documentation

Index

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

Types

type Butler

type Butler struct {
	Config     *config.Params //bmcbutler config, cli params
	ButlerChan <-chan Msg
	Log        *logrus.Logger
	StopChan   <-chan struct{}
	SyncWG     *sync.WaitGroup
	WorkerPool *workerpool.WorkerPool

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

Butler struct 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
}

Msg (butler messages) are passed over the butlerChan they declare assets for butlers to carry actions on.