uniter

package
v0.0.0-...-b0bff92 Latest Latest
Warning

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

 Go to latest Published: Dec 7, 2021 License: AGPL-3.0 Imports: 66 Imported by: 0

Documentation

Index

Constants

View Source 
const JujuExecEndpoint = "JujuExecServer.RunCommands"

Variables

View Source 
var (
	// ErrCAASUnitDead is the error returned from terminate or init
	// if the unit is Dead.
	ErrCAASUnitDead = errors.New("unit dead")
)

Functions

func Manifold 

func Manifold(config ManifoldConfig) dependency.Manifold

Manifold returns a dependency manifold that runs a uniter worker, using the resource names defined in the supplied config.

func NewPebblePoller 

func NewPebblePoller(logger Logger,
	clock clock.Clock,
	containerNames []string,
	workloadEventChan chan string,
	workloadEvents container.WorkloadEvents,
	newPebbleClient NewPebbleClientFunc) worker.Worker

NewPebblePoller starts a worker that polls the pebble interfaces of the supplied container list.

func NewRunListenerWrapper 

func NewRunListenerWrapper(rl *RunListener, logger Logger) worker.Worker

NewRunListenerWrapper returns a worker that will Close the supplied run listener when the worker is killed. The Wait() method will never return an error -- NewRunListener just drops the Run error on the floor and that's not what I'm fixing here.

func NewUniterResolver 

func NewUniterResolver(cfg ResolverConfig) resolver.Resolver

NewUniterResolver returns a new resolver.Resolver for the uniter.

func NewUpdateStatusTimer 

func NewUpdateStatusTimer() remotestate.UpdateStatusTimerFunc

NewUpdateStatusTimer returns a func returning timed signal suitable for update-status hook.

func StartUniter 

func StartUniter(runner *worker.Runner, params *UniterParams) error

StartUniter creates a new Uniter and starts it using the specified runner.

func TranslateFortressErrors 

func TranslateFortressErrors(err error) error

TranslateFortressErrors turns errors returned by dependent manifolds due to fortress lockdown (i.e. model migration) into an error which causes the resolver loop to be restarted. When this happens the uniter is about to be shut down anyway.

Types

type ChannelCommandRunner 

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

ChannelCommandRunner is a CommandRunner that registers command arguments in a runcommands.Commands, sends the returned IDs to a channel and waits for response callbacks.

func NewChannelCommandRunner 

func NewChannelCommandRunner(cfg ChannelCommandRunnerConfig) (*ChannelCommandRunner, error)

NewChannelCommandRunner returns a new ChannelCommandRunner with the given configuration.

func (*ChannelCommandRunner) RunCommands 

func (c *ChannelCommandRunner) RunCommands(args RunCommandsArgs) (results *exec.ExecResponse, err error)

RunCommands executes the supplied run commands by registering the arguments in a runcommands.Commands, and then sending the returned ID to a channel and waiting for a response callback.

type ChannelCommandRunnerConfig 

type ChannelCommandRunnerConfig struct {
	// Abort is a channel that will be closed when the runner should abort
	// the execution of run commands.
	Abort <-chan struct{}

	// Commands is used to add commands received from the listener.
	Commands runcommands.Commands

	// CommandChannel will be sent the IDs of commands added to Commands.
	CommandChannel chan<- string
}

ChannelCommandRunnerConfig contains the configuration for a ChannelCommandRunner.

func (ChannelCommandRunnerConfig) Validate 

func (cfg ChannelCommandRunnerConfig) Validate() error

type CommandRunner 

type CommandRunner interface {
	RunCommands(RunCommandsArgs RunCommandsArgs) (results *exec.ExecResponse, err error)
}

A CommandRunner is something that will actually execute the commands and return the results of that execution in the exec.ExecResponse (which contains stdout, stderr, and return code).

type JujuExecServer 

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

The JujuExecServer is the entity that has the methods that are called over the rpc connection.

func (*JujuExecServer) RunCommands 

func (r *JujuExecServer) RunCommands(args RunCommandsArgs, result *exec.ExecResponse) error

RunCommands delegates the actual running to the runner and populates the response structure.

type Logger 

type Logger interface {
	Errorf(string, ...interface{})
	Warningf(string, ...interface{})
	Infof(string, ...interface{})
	Debugf(string, ...interface{})
	Tracef(string, ...interface{})
	IsTraceEnabled() bool

	Child(string) loggo.Logger
}

Logger represents the methods used for logging messages.

type ManifoldConfig 

type ManifoldConfig struct {
	AgentName                    string
	ModelType                    model.ModelType
	APICallerName                string
	MachineLock                  machinelock.Lock
	Clock                        clock.Clock
	LeadershipTrackerName        string
	CharmDirName                 string
	HookRetryStrategyName        string
	TranslateResolverErr         func(error) error
	Logger                       Logger
	Sidecar                      bool
	EnforcedCharmModifiedVersion int
	ContainerNames               []string
}

ManifoldConfig defines the names of the manifolds on which a Manifold will depend.

func (*ManifoldConfig) Validate 

func (config *ManifoldConfig) Validate() error

Validate ensures all the required values for the config are set.

type NewOperationExecutorFunc 

type NewOperationExecutorFunc func(string, operation.ExecutorConfig) (operation.Executor, error)

NewOperationExecutorFunc is a func which returns an operations.Executor.

type NewPebbleClientFunc 

type NewPebbleClientFunc func(*client.Config) (PebbleClient, error)

NewPebbleClientFunc is the function type used to create a PebbleClient.

type NewRunnerExecutorFunc 

type NewRunnerExecutorFunc func(ProviderIDGetter, Paths) runner.ExecFunc

NewRunnerExecutorFunc defines the type of the NewRunnerExecutor.

type Paths 

type Paths struct {

	// ToolsDir is the directory containing the jujud executable running this
	// process; and also containing jujuc tool symlinks to that executable. It's
	// the only path in this struct that is not typically pointing inside the
	// directory reserved for the exclusive use of this worker (typically
	// /var/lib/juju/agents/$UNIT_TAG/ )
	ToolsDir string

	// Runtime represents the set of paths that are relevant at runtime.
	Runtime RuntimePaths

	// State represents the set of paths that hold persistent local state for
	// the uniter.
	State StatePaths
}

Paths represents the set of filesystem paths a uniter worker has reason to care about.

func NewPaths 

func NewPaths(dataDir string, unitTag names.UnitTag, socketConfig *SocketConfig) Paths

NewPaths returns the set of filesystem paths that the supplied unit should use, given the supplied root juju data directory path. If socketConfig is specified, all sockets will be TLS over TCP.

func NewWorkerPaths 

func NewWorkerPaths(dataDir string, unitTag names.UnitTag, worker string, socketConfig *SocketConfig) Paths

NewWorkerPaths returns the set of filesystem paths that the supplied unit worker should use, given the supplied root juju data directory path and worker identifier. Distinct worker identifiers ensure that runtime paths of different worker do not interfere. If socketConfig is specified, all sockets will be TLS over TCP.

func (Paths) ComponentDir 

func (paths Paths) ComponentDir(name string) string

ComponentDir returns the filesystem path to the directory containing all data files for a component.

func (Paths) GetBaseDir 

func (paths Paths) GetBaseDir() string

GetBaseDir exists to satisfy the context.Paths interface.

func (Paths) GetCharmDir 

func (paths Paths) GetCharmDir() string

GetCharmDir exists to satisfy the context.Paths interface.

func (Paths) GetJujucClientSocket 

func (paths Paths) GetJujucClientSocket(remote bool) sockets.Socket

GetJujucClientSocket exists to satisfy the context.Paths interface.

func (Paths) GetJujucServerSocket 

func (paths Paths) GetJujucServerSocket(remote bool) sockets.Socket

GetJujucServerSocket exists to satisfy the context.Paths interface.

func (Paths) GetMetricsSpoolDir 

func (paths Paths) GetMetricsSpoolDir() string

GetMetricsSpoolDir exists to satisfy the runner.Paths interface.

func (Paths) GetToolsDir 

func (paths Paths) GetToolsDir() string

GetToolsDir exists to satisfy the context.Paths interface.

type PebbleClient 

type PebbleClient interface {
	SysInfo() (*client.SysInfo, error)
	CloseIdleConnections()
}

PebbleClient describes the subset of github.com/canonical/pebble/client.Client that we need for the PebblePoller.

type Probe 

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

func (*Probe) HasStarted 

func (p *Probe) HasStarted() bool

func (*Probe) SetHasStarted 

func (p *Probe) SetHasStarted()

type ProviderIDGetter 

type ProviderIDGetter interface {
	ProviderID() string
	Refresh() error
	Name() string
}

ProviderIDGetter defines the API to get provider ID.

type RebootQuerier 

type RebootQuerier interface {
	Query(tag names.Tag) (bool, error)
}

RebootQuerier is implemented by types that can deliver one-off machine reboot notifications to entities.

type RemoteInitFunc 

type RemoteInitFunc func(remotestate.ContainerRunningStatus, <-chan struct{}) error

RemoteInitFunc is used to init remote state

type ResolverConfig 

type ResolverConfig struct {
	ModelType           model.ModelType
	ClearResolved       func() error
	ReportHookError     func(hook.Info) error
	ShouldRetryHooks    bool
	StartRetryHookTimer func()
	StopRetryHookTimer  func()
	VerifyCharmProfile  resolver.Resolver
	UpgradeSeries       resolver.Resolver
	Reboot              resolver.Resolver
	Leadership          resolver.Resolver
	Actions             resolver.Resolver
	CreatedRelations    resolver.Resolver
	Relations           resolver.Resolver
	Storage             resolver.Resolver
	Commands            resolver.Resolver
	Secrets             resolver.Resolver
	OptionalResolvers   []resolver.Resolver
	Logger              Logger
}

ResolverConfig defines configuration for the uniter resolver.

type RunCommandsArgs 

type RunCommandsArgs struct {
	// Commands is the arbitrary commands to execute on the unit
	Commands string
	// RelationId is the relation context to execute the commands in.
	RelationId int
	// RemoteUnitName is the remote unit for the relation context.
	RemoteUnitName string
	// RemoteUnitName is the remote unit for the relation context.
	RemoteApplicationName string
	// ForceRemoteUnit skips relation membership and existence validation.
	ForceRemoteUnit bool
	// UnitName is the unit for which the command is being run.
	UnitName string
	// Token is the unit token when run under CAAS environments for auth.
	Token string
	// Operator is true when the command should be run on the operator.
	// This only affects k8s workload charms.
	Operator bool
}

RunCommandsArgs stores the arguments for a RunCommands call.

type RunListener 

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

RunListener is responsible for listening on the network connection and setting up the rpc server on that net connection. Also starts the go routine that listens and hands off the work.

func NewRunListener 

func NewRunListener(socket sockets.Socket, logger Logger) (*RunListener, error)

NewRunListener returns a new RunListener that is listening on given socket or named pipe passed in. If a valid RunListener is returned, is has the go routine running, and should be closed by the creator when they are done with it.

func (*RunListener) Close 

func (r *RunListener) Close() error

Close immediately stops accepting connections, and blocks until all existing connections have been closed.

func (*RunListener) RegisterRunner 

func (r *RunListener) RegisterRunner(unitName string, runner CommandRunner)

RegisterRunner registers a command runner for a given unit.

func (*RunListener) Run 

func (r *RunListener) Run() (err error)

Run accepts new connections until it encounters an error, or until Close is called, and then blocks until all existing connections have been closed.

func (*RunListener) RunCommands 

func (r *RunListener) RunCommands(args RunCommandsArgs) (results *exec.ExecResponse, err error)

RunCommands executes the supplied commands in a hook context.

func (*RunListener) UnregisterRunner 

func (r *RunListener) UnregisterRunner(unitName string)

UnregisterRunner unregisters a command runner for a given unit.

type RuntimePaths 

type RuntimePaths struct {
	// LocalJujuExecSocket listens for juju-exec invocations, and is always
	// active.
	LocalJujuExecSocket SocketPair

	// RemoteJujuExecSocket listens for remote juju-exec invocations.
	RemoteJujuExecSocket SocketPair

	// JujucServerSocket listens for jujuc invocations, and is only
	// active when supporting a jujuc execution context.
	LocalJujucServerSocket SocketPair

	// RemoteJujucServerSocket listens for remote jujuc invocations, and is only
	// active when supporting a jujuc execution context.
	RemoteJujucServerSocket SocketPair
}

RuntimePaths represents the set of paths that are relevant at runtime.

type SocketConfig 

type SocketConfig struct {
	ServiceAddress  string
	OperatorAddress string
	TLSConfig       *tls.Config
}

SocketConfig specifies information for remote sockets.

type SocketPair 

type SocketPair struct {
	Server sockets.Socket
	Client sockets.Socket
}

SocketPair is a server+client pair of socket descriptors.

type StatePaths 

type StatePaths struct {
	// BaseDir is the unit agent's base directory.
	BaseDir string

	// CharmDir is the directory to which the charm the uniter runs is deployed.
	CharmDir string

	// BundlesDir holds downloaded charms.
	BundlesDir string

	// DeployerDir holds metadata about charms that are installing or have
	// been installed.
	DeployerDir string

	// MetricsSpoolDir acts as temporary storage for metrics being sent from
	// the uniter to state.
	MetricsSpoolDir string
}

StatePaths represents the set of paths that hold persistent local state for the uniter.

type Uniter 

type Uniter struct {
	Probe Probe
	// contains filtered or unexported fields
}

Uniter implements the capabilities of the unit agent. It is not intended to implement the actual *behaviour* of the unit agent; that responsibility is delegated to Mode values, which are expected to react to events and direct the uniter's responses to them.

func NewUniter 

func NewUniter(uniterParams *UniterParams) (*Uniter, error)

NewUniter creates a new Uniter which will install, run, and upgrade a charm on behalf of the unit with the given unitTag, by executing hooks and operations provoked by changes in st.

func (*Uniter) Kill 

func (u *Uniter) Kill()

func (*Uniter) Report 

func (u *Uniter) Report() map[string]interface{}

Report provides information for the engine report.

func (*Uniter) RunCommands 

func (u *Uniter) RunCommands(args RunCommandsArgs) (results *exec.ExecResponse, err error)

RunCommands executes the supplied commands in a hook context.

func (*Uniter) Terminate 

func (u *Uniter) Terminate() error

Terminate terminates the Uniter worker, ensuring the stop hook is fired before exiting with ErrTerminateAgent.

func (*Uniter) Wait 

func (u *Uniter) Wait() error

type UniterExecutionObserver 

type UniterExecutionObserver interface {
	HookCompleted(hookName string)
	HookFailed(hookName string)
}

A UniterExecutionObserver gets the appropriate methods called when a hook is executed and either succeeds or fails. Missing hooks don't get reported in this way.

type UniterParams 

type UniterParams struct {
	UniterFacade                  *uniter.State
	SecretsFacade                 *secretsmanager.Client
	UnitTag                       names.UnitTag
	ModelType                     model.ModelType
	LeadershipTrackerFunc         func(names.UnitTag) leadership.TrackerWorker
	SecretRotateWatcherFunc       remotestate.SecretRotateWatcherFunc
	DataDir                       string
	Downloader                    charm.Downloader
	MachineLock                   machinelock.Lock
	CharmDirGuard                 fortress.Guard
	UpdateStatusSignal            remotestate.UpdateStatusTimerFunc
	HookRetryStrategy             params.RetryStrategy
	NewOperationExecutor          NewOperationExecutorFunc
	NewProcessRunner              runner.NewRunnerFunc
	NewDeployer                   charm.NewDeployerFunc
	NewRemoteRunnerExecutor       NewRunnerExecutorFunc
	RemoteInitFunc                RemoteInitFunc
	RunListener                   *RunListener
	TranslateResolverErr          func(error) error
	Clock                         clock.Clock
	ContainerRunningStatusChannel watcher.NotifyChannel
	ContainerRunningStatusFunc    remotestate.ContainerRunningStatusFunc
	IsRemoteUnit                  bool
	SocketConfig                  *SocketConfig
	// TODO (mattyw, wallyworld, fwereade) Having the observer here make this approach a bit more legitimate, but it isn't.
	// the observer is only a stop gap to be used in tests. A better approach would be to have the uniter tests start hooks
	// that write to files, and have the tests watch the output to know that hooks have finished.
	Observer                     UniterExecutionObserver
	RebootQuerier                RebootQuerier
	Logger                       Logger
	Sidecar                      bool
	EnforcedCharmModifiedVersion int
	ContainerNames               []string
	NewPebbleClient              NewPebbleClientFunc
}

UniterParams hold all the necessary parameters for a new Uniter.

Source Files

View all Source files

Directories

Path Synopsis
mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
Package hook provides types that define the hooks known to the Uniter
 Package hook provides types that define the hooks known to the Uniter
mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
Package relation implements persistent local storage of a unit's relation state, and translation of relation changes into hooks that need to be run.
 Package relation implements persistent local storage of a unit's relation state, and translation of relation changes into hooks that need to be run.
mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
context
Package context contains the ContextFactory and Context definitions.
 Package context contains the ContextFactory and Context definitions.
context/mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
debug
jujuc
Package jujuc implements the server side of the jujuc proxy tool, which forwards command invocations to the unit agent process so that they can be executed against specific state.
 Package jujuc implements the server side of the jujuc proxy tool, which forwards command invocations to the unit agent process so that they can be executed against specific state.
jujuc/jujuctesting
jujuc/mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
testing
Package storage contains the storage subsystem for the uniter, responding to changes in storage attachments (lifecycle, volume/filesystem details) by queuing hooks and managing the storage attachments' lifecycle.
 Package storage contains the storage subsystem for the uniter, responding to changes in storage attachments (lifecycle, volume/filesystem details) by queuing hooks and managing the storage attachments' lifecycle.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.