server

Documentation

Index

• func RegisterAdditionalAgent(i AgentInitializer)
• func RegisterAdditionalAgentProvider(p AgentProvider)
• type AgentInitializer
• type AgentManager
• type AgentProvider
• type Instance
  • func NewInstance(fw *choria.Framework) (i *Instance, err error)
  • func (srv *Instance) AgentMetadata(agent string) (agents.Metadata, bool)
  • func (srv *Instance) Choria() *choria.Framework
  • func (srv *Instance) Classes() []string
  • func (srv *Instance) ConfigFile() string
  • func (srv *Instance) ConnectedServer() string
  • func (srv *Instance) DenyAgent(agent string)
  • func (srv *Instance) Facts() json.RawMessage
  • func (srv *Instance) Identity() string
  • func (srv *Instance) KnownAgents() []string
  • func (srv *Instance) LastProcessedMessage() time.Time
  • func (srv *Instance) Logger(component string) *log.Entry
  • func (srv *Instance) MachineTransition(name string, version string, path string, id string, transition string) error
  • func (srv *Instance) MachinesStatus() ([]aagent.MachineState, error)
  • func (srv *Instance) NewEvent(t lifecycle.Type, opts ...lifecycle.Option) error
  • func (srv *Instance) Provisioning() bool
  • func (srv *Instance) PublishEvent(e lifecycle.Event) error
  • func (srv *Instance) PublishRaw(target string, data []byte) error
  • func (srv *Instance) RegisterAgent(ctx context.Context, name string, agent agents.Agent) error
  • func (srv *Instance) RegisterRegistrationProvider(ctx context.Context, wg *sync.WaitGroup, ...) error
  • func (srv *Instance) Run(ctx context.Context, wg *sync.WaitGroup) error
  • func (srv *Instance) SetComponent(c string)
  • func (srv *Instance) StartMachine(ctx context.Context, wg *sync.WaitGroup) (err error)
  • func (srv *Instance) StartTime() time.Time
  • func (srv *Instance) Stats() agents.ServerStats
  • func (srv *Instance) Status() *InstanceStatus
  • func (srv *Instance) UpTime() int64
  • func (srv *Instance) WriteServerStatus(ctx context.Context, wg *sync.WaitGroup)
• type InstanceStatus

Functions

func RegisterAdditionalAgent

func RegisterAdditionalAgent(i AgentInitializer)

RegisterAdditionalAgent adds an agent to a running server this should be used for compile time injection of agents other than the ones that ship with choria

func RegisterAdditionalAgentProvider

func RegisterAdditionalAgentProvider(p AgentProvider)

RegisterAdditionalAgentProvider registers an agent provider as a subsystem capable of delivering new types of agent like the legacy mcollective ruby compatible ones

Custom builders can use this to extend choria with new agent capabilities

Types

type AgentInitializer

type AgentInitializer func(context.Context, *agents.Manager, choria.InstanceConnector, *logrus.Entry) error

AgentInitializer is a function signature for a function that can register an agent

type AgentManager

type AgentManager interface {
	RegisterAgent(ctx context.Context, name string, agent agents.Agent, conn choria.AgentConnector) error
	Logger() *logrus.Entry
	Choria() *choria.Framework
}

type AgentProvider

type AgentProvider interface {
	Initialize(fw *choria.Framework, log *logrus.Entry)
	RegisterAgents(ctx context.Context, mgr AgentManager, connector choria.InstanceConnector, log *logrus.Entry) error
	Version() string
}

AgentProvider is capable of adding agents into a running instance

type Instance

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

Instance is an independant copy of Choria

func NewInstance

func NewInstance(fw *choria.Framework) (i *Instance, err error)

NewInstance creates a new choria server instance

func (*Instance) AgentMetadata

func (srv *Instance) AgentMetadata(agent string) (agents.Metadata, bool)

AgentMetadata looks up the metadata for a specific agent

func (*Instance) Choria

func (srv *Instance) Choria() *choria.Framework

Choria returns the choria framework

func (*Instance) Classes

func (srv *Instance) Classes() []string

Classes is a list of classification classes this node matches

func (*Instance) ConfigFile

func (srv *Instance) ConfigFile() string

ConfigFile determines the config file used to start the instance

func (*Instance) ConnectedServer

func (srv *Instance) ConnectedServer() string

ConnectedServer returns the URL of the broker this instance is connected to, "unknown" when not connected

func (*Instance) DenyAgent

func (srv *Instance) DenyAgent(agent string)

DenyAgent prevents an agent from being loaded, if it was already loaded this has no effect

func (*Instance) Facts

func (srv *Instance) Facts() json.RawMessage

Facts are all the known facts to this instance

func (*Instance) Identity

func (srv *Instance) Identity() string

Identity is the configured identity of the running server

func (*Instance) KnownAgents

func (srv *Instance) KnownAgents() []string

KnownAgents is a list of agents loaded into the server instance

func (*Instance) LastProcessedMessage

func (srv *Instance) LastProcessedMessage() time.Time

LastProcessedMessage is the time that the last message was processed in local time

func (*Instance) Logger

func (srv *Instance) Logger(component string) *log.Entry

Logger creates a new logger instance

func (*Instance) MachineTransition

func (srv *Instance) MachineTransition(name string, version string, path string, id string, transition string) error

MachineTransition sends a transition event to a specific running machine instance

func (*Instance) MachinesStatus

func (srv *Instance) MachinesStatus() ([]aagent.MachineState, error)

MachinesStatus returns the status of all loaded autonomous agents

func (*Instance) NewEvent

func (srv *Instance) NewEvent(t lifecycle.Type, opts ...lifecycle.Option) error

NewEvent creates a new event with the server component and identity set and publishes it

func (*Instance) Provisioning

func (srv *Instance) Provisioning() bool

Provisioning determines if this is an instance running in provisioning mode

func (*Instance) PublishEvent

func (srv *Instance) PublishEvent(e lifecycle.Event) error

PublishEvent publishes a lifecycle event to the network

func (*Instance) PublishRaw

func (srv *Instance) PublishRaw(target string, data []byte) error

PublishRaw allows publishing to the connected middleware

func (*Instance) RegisterAgent

func (srv *Instance) RegisterAgent(ctx context.Context, name string, agent agents.Agent) error

RegisterAgent adds a new agent to the running instance

func (*Instance) RegisterRegistrationProvider

func (srv *Instance) RegisterRegistrationProvider(ctx context.Context, wg *sync.WaitGroup, provider registration.RegistrationDataProvider) error

RegisterRegistrationProvider adds a new provider for registration data to the registration subsystem

func (*Instance) Run

func (srv *Instance) Run(ctx context.Context, wg *sync.WaitGroup) error

func (*Instance) SetComponent

func (srv *Instance) SetComponent(c string)

SetComponent sets the component name this server will report in its lifecycle events. "server" and "provision_mode_server" are the defaults

func (*Instance) StartMachine

func (srv *Instance) StartMachine(ctx context.Context, wg *sync.WaitGroup) (err error)

StartMachine starts the choria machine instances

func (*Instance) StartTime

func (srv *Instance) StartTime() time.Time

StartTime is the time this instance were created

func (*Instance) Stats

func (srv *Instance) Stats() agents.ServerStats

Stats expose server statistics

func (*Instance) Status

func (srv *Instance) Status() *InstanceStatus

Status calculates the current server status

func (*Instance) UpTime

func (srv *Instance) UpTime() int64

UpTime returns how long the server has been running

func (*Instance) WriteServerStatus

func (srv *Instance) WriteServerStatus(ctx context.Context, wg *sync.WaitGroup)

WriteServerStatus periodically writes the server status to a file

type InstanceStatus

type InstanceStatus struct {
	Identity        string              `json:"identity"`
	Uptime          int64               `json:"uptime"`
	ConnectedServer string              `json:"connected_server"`
	LastMessage     int64               `json:"last_message"`
	Provisioning    bool                `json:"provisioning_mode"`
	Stats           *agents.ServerStats `json:"stats"`
}

InstanceStatus describes the current instance status