environment

Documentation

Overview

Package environment defines Environment, environment.Manager and other types and methods related to handling O² environments.

Index

• type ConfigureTransition
• type Environment
  • func (env *Environment) CreatedWhen() time.Time
  • func (env *Environment) CurrentState() string
  • func (env *Environment) GetCurrentRunNumber() (rn uint32)
  • func (env *Environment) GetPath() string
  • func (env *Environment) Id() uid.ID
  • func (env *Environment) IsSafeToStop() bool
  • func (env *Environment) NotifyEvent(e event.DeviceEvent)
  • func (env *Environment) QueryRoles(pathSpec string) (rs []workflow.Role)
  • func (env *Environment) TryTransition(t Transition) (err error)
  • func (env *Environment) Workflow() workflow.Role
• type Manager
  • func NewEnvManager(tm *task.Manager, incomingEventCh <-chan event.Event) *Manager
  • func (envs *Manager) CreateAutoEnvironment(workflowPath string, userVars map[string]string, sub Subscription)
  • func (envs *Manager) CreateEnvironment(workflowPath string, userVars map[string]string) (uid.ID, error)
  • func (envs *Manager) Environment(environmentId uid.ID) (env *Environment, err error)
  • func (envs *Manager) Ids() (keys []uid.ID)
  • func (envs *Manager) TeardownEnvironment(environmentId uid.ID, force bool) error
• type ResetTransition
• type StartActivityTransition
• type StopActivityTransition
• type Subscription
  • func SubscribeToStream(ch chan *pb.Event) Subscription
• type Transition
  • func MakeTransition(taskman *task.Manager, optype pb.ControlEnvironmentRequest_Optype) Transition
  • func NewConfigureTransition(taskman *task.Manager, addRoles []string, removeRoles []string, ...) Transition
  • func NewResetTransition(taskman *task.Manager) Transition
  • func NewStartActivityTransition(taskman *task.Manager) Transition
  • func NewStopActivityTransition(taskman *task.Manager) Transition

Types

type ConfigureTransition

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

type Environment

type Environment struct {
	Mu sync.RWMutex

	Sm *fsm.FSM

	GlobalDefaults gera.StringMap // From Consul
	GlobalVars     gera.StringMap // From Consul
	UserVars       gera.StringMap // From user input
	// contains filtered or unexported fields
}

func (*Environment) CreatedWhen

func (env *Environment) CreatedWhen() time.Time

func (*Environment) CurrentState

func (env *Environment) CurrentState() string

func (*Environment) GetCurrentRunNumber

func (env *Environment) GetCurrentRunNumber() (rn uint32)

func (*Environment) GetPath

func (env *Environment) GetPath() string

func (*Environment) Id

func (env *Environment) Id() uid.ID

func (*Environment) IsSafeToStop

func (env *Environment) IsSafeToStop() bool

func (*Environment) NotifyEvent

func (env *Environment) NotifyEvent(e event.DeviceEvent)

func (*Environment) QueryRoles

func (env *Environment) QueryRoles(pathSpec string) (rs []workflow.Role)

func (*Environment) TryTransition

func (env *Environment) TryTransition(t Transition) (err error)

func (*Environment) Workflow

func (env *Environment) Workflow() workflow.Role

type Manager

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

func NewEnvManager

func NewEnvManager(tm *task.Manager, incomingEventCh <-chan event.Event) *Manager

func (*Manager) CreateAutoEnvironment

func (envs *Manager) CreateAutoEnvironment(workflowPath string, userVars map[string]string, sub Subscription)

func (*Manager) CreateEnvironment

func (envs *Manager) CreateEnvironment(workflowPath string, userVars map[string]string) (uid.ID, error)

func (*Manager) Environment

func (envs *Manager) Environment(environmentId uid.ID) (env *Environment, err error)

func (*Manager) Ids

func (envs *Manager) Ids() (keys []uid.ID)

func (*Manager) TeardownEnvironment

func (envs *Manager) TeardownEnvironment(environmentId uid.ID, force bool) error

type ResetTransition

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

type StartActivityTransition

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

type StopActivityTransition

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

type Subscription

type Subscription interface {
	Unsubscribe()
	GetFeed() chan *pb.Event
	Send(event.Event)
	Err() <-chan error
}

func SubscribeToStream

func SubscribeToStream(ch chan *pb.Event) Subscription

type Transition

type Transition interface {
	// contains filtered or unexported methods
}

func MakeTransition

func MakeTransition(taskman *task.Manager, optype pb.ControlEnvironmentRequest_Optype) Transition

func NewConfigureTransition

func NewConfigureTransition(taskman *task.Manager, addRoles []string, removeRoles []string, reconfigureAll bool) Transition

func NewResetTransition

func NewResetTransition(taskman *task.Manager) Transition

func NewStartActivityTransition

func NewStartActivityTransition(taskman *task.Manager) Transition

func NewStopActivityTransition

func NewStopActivityTransition(taskman *task.Manager) Transition