agent

package
v0.0.0-...-8ff1004 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 15, 2019 License: AGPL-3.0 Imports: 84 Imported by: 0

Documentation

Overview

agent contains jujud's machine agent.

Index

Constants

This section is empty.

Variables

View Source
var (
	// Should be an explicit dependency, can't do it cleanly yet.
	// Exported for testing.
	CaasOperatorManifolds = caasoperator.Manifolds
)
View Source
var ProductionMongoWriteConcern = true

Variable to override in tests, default is true

Functions

func ConnectAsAgent

func ConnectAsAgent(a agent.Agent) (io.Closer, error)

ConnectAsAgent really connects to the API specified in the agent config. It's extracted so tests can pass something else in.

func DefaultIntrospectionSocketName

func DefaultIntrospectionSocketName(entityTag names.Tag) string

DefaultIntrospectionSocketName returns the socket name to use for the abstract domain socket that the introspection worker serves requests over.

func GetJujuVersion

func GetJujuVersion(machineAgent string, dataDir string) (version.Number, error)

GetJujuVersion gets the version of the agent from agent's config file

func MachineAgentFactoryFn

func MachineAgentFactoryFn(
	agentConfWriter AgentConfigWriter,
	bufferedLogger *logsender.BufferedLogWriter,
	newIntrospectionSocketName func(names.Tag) string,
	preUpgradeSteps upgrades.PreUpgradeStepsFunc,
	rootDir string,
) func(string) (*MachineAgent, error)

MachineAgentFactoryFn returns a function which instantiates a MachineAgent given a machineId.

func NewCheckConnectionCommand

func NewCheckConnectionCommand(config AgentConf, connect ConnectFunc) cmd.Command

NewCheckConnectionCommand returns a command that will test connecting to the API with details from the agent's config.

func NewMachineAgentCmd

func NewMachineAgentCmd(
	ctx *cmd.Context,
	machineAgentFactory func(string) (*MachineAgent, error),
	agentInitializer AgentInitializer,
	configFetcher AgentConfigWriter,
) cmd.Command

NewMachineAgentCmd creates a Command which handles parsing command-line arguments and instantiating and running a MachineAgent.

Types

type AgentConf

type AgentConf interface {

	// AddFlags injects common agent flags into f.
	AddFlags(f *gnuflag.FlagSet)

	// CheckArgs reports whether the given args are valid for this agent.
	CheckArgs(args []string) error

	// DataDir returns the directory where this agent should store its data.
	DataDir() string

	// ReadConfig reads the agent's config from its config file.
	ReadConfig(tag string) error

	// CurrentConfig returns the agent config for this agent.
	CurrentConfig() agent.Config

	// ChangeConfig modifies this configuration using the given mutator.
	ChangeConfig(change agent.ConfigMutator) error
}

AgentConf is a terribly confused interface.

Parts of it are a mixin for cmd.Command implementations; others are a mixin for agent.Agent implementations; others bridge the two. We should be aiming to separate the cmd responsibilities from the agent responsibilities.

func NewAgentConf

func NewAgentConf(dataDir string) AgentConf

NewAgentConf returns a new value that satisfies AgentConf

type AgentConfigWriter

type AgentConfigWriter interface {
	// ReadConfig reads the config for the given tag from disk.
	ReadConfig(tag string) error
	// ChangeConfig executes the given agent.ConfigMutator in a
	// thread-safe context.
	ChangeConfig(agent.ConfigMutator) error
	// CurrentConfig returns a copy of the in-memory agent config.
	CurrentConfig() agent.Config
}

AgentConfigWriter encapsulates disk I/O operations with the agent config.

type AgentInitializer

type AgentInitializer interface {
	AddFlags(*gnuflag.FlagSet)
	CheckArgs([]string) error
}

AgentInitializer handles initializing a type for use as a Jujud agent.

type CaasOperatorAgent

type CaasOperatorAgent struct {
	cmd.CommandBase
	AgentConf

	ApplicationName string
	// contains filtered or unexported fields
}

CaasOperatorAgent is a cmd.Command responsible for running a CAAS operator agent.

func NewCaasOperatorAgent

func NewCaasOperatorAgent(ctx *cmd.Context, bufferedLogger *logsender.BufferedLogWriter) (*CaasOperatorAgent, error)

NewCaasOperatorAgent creates a new CAASOperatorAgent instance properly initialized.

func (*CaasOperatorAgent) ChangeConfig

func (a *CaasOperatorAgent) ChangeConfig(mutate agent.ConfigMutator) error

ChangeConfig implements Agent.

func (*CaasOperatorAgent) Done

func (op *CaasOperatorAgent) Done(err error)

Done signals the machine agent is finished

func (*CaasOperatorAgent) Info

func (op *CaasOperatorAgent) Info() *cmd.Info

Info implements Command.

func (*CaasOperatorAgent) Init

func (op *CaasOperatorAgent) Init(args []string) error

Init initializes the command for running.

func (*CaasOperatorAgent) Run

func (op *CaasOperatorAgent) Run(ctx *cmd.Context) (err error)

Run implements Command.

func (*CaasOperatorAgent) SetFlags

func (op *CaasOperatorAgent) SetFlags(f *gnuflag.FlagSet)

SetFlags implements Command.

func (*CaasOperatorAgent) Stop

func (op *CaasOperatorAgent) Stop() error

Stop implements Worker.

func (*CaasOperatorAgent) Tag

func (op *CaasOperatorAgent) Tag() names.Tag

Tag implements Agent.

func (*CaasOperatorAgent) Wait

func (op *CaasOperatorAgent) Wait() error

Wait waits for the CaasOperator agent to finish.

func (*CaasOperatorAgent) Workers

func (op *CaasOperatorAgent) Workers() (worker.Worker, error)

Workers returns a dependency.Engine running the operator's responsibilities.

type ConnectFunc

type ConnectFunc func(agent.Agent) (io.Closer, error)

ConnectFunc connects to the API as the given agent.

type MachineAgent

type MachineAgent struct {
	AgentConfigWriter
	// contains filtered or unexported fields
}

MachineAgent is responsible for tying together all functionality needed to orchestrate a Jujud instance which controls a machine.

func NewMachineAgent

func NewMachineAgent(
	machineId string,
	agentConfWriter AgentConfigWriter,
	bufferedLogger *logsender.BufferedLogWriter,
	runner *worker.Runner,
	loopDeviceManager looputil.LoopDeviceManager,
	newIntrospectionSocketName func(names.Tag) string,
	preUpgradeSteps upgrades.PreUpgradeStepsFunc,
	rootDir string,
) (*MachineAgent, error)

NewMachineAgent instantiates a new MachineAgent.

func (*MachineAgent) ChangeConfig

func (a *MachineAgent) ChangeConfig(mutate agent.ConfigMutator) error

func (*MachineAgent) Done

func (a *MachineAgent) Done(err error)

Done signals the machine agent is finished

func (*MachineAgent) Restart

func (a *MachineAgent) Restart() error

Restart restarts the agent's service.

func (*MachineAgent) Run

func (a *MachineAgent) Run(*cmd.Context) (err error)

Run runs a machine agent.

func (*MachineAgent) Stop

func (a *MachineAgent) Stop() error

Stop stops the machine agent.

func (*MachineAgent) Tag

func (a *MachineAgent) Tag() names.Tag

func (*MachineAgent) Wait

func (a *MachineAgent) Wait() error

Wait waits for the machine agent to finish.

func (*MachineAgent) WorkersStarted

func (a *MachineAgent) WorkersStarted() <-chan struct{}

WorkersStarted returns a channel that's closed once all top level workers have been started. This is provided for testing purposes.

type UnitAgent

type UnitAgent struct {
	cmd.CommandBase
	AgentConf

	UnitName string
	// contains filtered or unexported fields
}

UnitAgent is a cmd.Command responsible for running a unit agent.

func NewUnitAgent

func NewUnitAgent(ctx *cmd.Context, bufferedLogger *logsender.BufferedLogWriter) (*UnitAgent, error)

NewUnitAgent creates a new UnitAgent value properly initialized.

func (*UnitAgent) APIWorkers

func (a *UnitAgent) APIWorkers() (worker.Worker, error)

APIWorkers returns a dependency.Engine running the unit agent's responsibilities.

func (*UnitAgent) ChangeConfig

func (a *UnitAgent) ChangeConfig(mutate agent.ConfigMutator) error

func (*UnitAgent) Done

func (a *UnitAgent) Done(err error)

Done signals the unit agent is finished

func (*UnitAgent) Info

func (a *UnitAgent) Info() *cmd.Info

Info returns usage information for the command.

func (*UnitAgent) Init

func (a *UnitAgent) Init(args []string) error

Init initializes the command for running.

func (*UnitAgent) Run

func (a *UnitAgent) Run(ctx *cmd.Context) (err error)

Run runs a unit agent.

func (*UnitAgent) SetFlags

func (a *UnitAgent) SetFlags(f *gnuflag.FlagSet)

func (*UnitAgent) Stop

func (a *UnitAgent) Stop() error

Stop stops the unit agent.

func (*UnitAgent) Tag

func (a *UnitAgent) Tag() names.Tag

func (*UnitAgent) Wait

func (a *UnitAgent) Wait() error

Wait waits for the unit agent to finish

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL