jujuc

package
v0.0.0-...-be26699 Latest Latest
Warning

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

 Go to latest Published: Jul 3, 2015 License: AGPL-3.0 Imports: 30 Imported by: 0

Documentation

Overview

The worker/uniter/runner/jujuc package 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.

Index

Constants

This section is empty.

Variables

View Source 
var ErrNoStdin = errors.New("hook tool requires stdin, none supplied")

ErrNoStdin is returned by Jujuc.Main if the hook tool requests stdin, and none is supplied.

View Source 
var StorageAddDoc = `` /* 303-byte string literal not displayed */

Functions

func CommandNames 

func CommandNames() (names []string)

CommandNames returns the names of all jujuc commands. 

func EnsureSymlinks(dir string) (err error)

EnsureSymlinks creates a symbolic link to jujuc within dir for each hook command. If the commands already exist, this operation does nothing. If dir is a symbolic link, it will be dereferenced first.

func NewActionFailCommand 

func NewActionFailCommand(ctx Context) cmd.Command

NewActionFailCommand returns a new ActionFailCommand with the given context.

func NewActionGetCommand 

func NewActionGetCommand(ctx Context) cmd.Command

NewActionGetCommand returns an ActionGetCommand for use with the given context.

func NewActionSetCommand 

func NewActionSetCommand(ctx Context) cmd.Command

NewActionSetCommand returns a new ActionSetCommand with the given context.

func NewAddMetricCommand 

func NewAddMetricCommand(ctx Context) cmd.Command

NewAddMetricCommand generates a new AddMetricCommand.

func NewClosePortCommand 

func NewClosePortCommand(ctx Context) cmd.Command

func NewCommand 

func NewCommand(ctx Context, name string) (cmd.Command, error)

NewCommand returns an instance of the named Command, initialized to execute against the supplied Context.

func NewConfigGetCommand 

func NewConfigGetCommand(ctx Context) cmd.Command

func NewIsLeaderCommand 

func NewIsLeaderCommand(ctx Context) cmd.Command

NewIsLeaderCommand returns a new isLeaderCommand with the given context.

func NewJujuLogCommand 

func NewJujuLogCommand(ctx Context) cmd.Command

func NewJujuRebootCommand 

func NewJujuRebootCommand(ctx Context) cmd.Command

func NewLeaderGetCommand 

func NewLeaderGetCommand(ctx Context) cmd.Command

NewLeaderGetCommand returns a new leaderGetCommand with the given context.

func NewLeaderSetCommand 

func NewLeaderSetCommand(ctx Context) cmd.Command

NewLeaderSetCommand returns a new leaderSetCommand with the given context.

func NewOpenPortCommand 

func NewOpenPortCommand(ctx Context) cmd.Command

func NewOpenedPortsCommand 

func NewOpenedPortsCommand(ctx Context) cmd.Command

func NewOwnerGetCommand 

func NewOwnerGetCommand(ctx Context) cmd.Command

func NewRelationGetCommand 

func NewRelationGetCommand(ctx Context) cmd.Command

func NewRelationIdsCommand 

func NewRelationIdsCommand(ctx Context) cmd.Command

func NewRelationListCommand 

func NewRelationListCommand(ctx Context) cmd.Command

func NewRelationSetCommand 

func NewRelationSetCommand(ctx Context) cmd.Command

func NewStatusGetCommand 

func NewStatusGetCommand(ctx Context) cmd.Command

func NewStatusSetCommand 

func NewStatusSetCommand(ctx Context) cmd.Command

NewStatusSetCommand makes a jujuc status-set command.

func NewStorageAddCommand 

func NewStorageAddCommand(ctx Context) cmd.Command

NewStorageAddCommand makes a jujuc storage-add command.

func NewStorageGetCommand 

func NewStorageGetCommand(ctx Context) cmd.Command

func NewUnitGetCommand 

func NewUnitGetCommand(ctx Context) cmd.Command

Types

type ActionFailCommand 

type ActionFailCommand struct {
	cmd.CommandBase
	// contains filtered or unexported fields
}

ActionFailCommand implements the action-fail command.

func (*ActionFailCommand) Info 

func (c *ActionFailCommand) Info() *cmd.Info

Info returns the content for --help.

func (*ActionFailCommand) Init 

func (c *ActionFailCommand) Init(args []string) error

Init sets the fail message and checks for malformed invocations.

func (*ActionFailCommand) Run 

func (c *ActionFailCommand) Run(ctx *cmd.Context) error

Run sets the Action's fail state.

func (*ActionFailCommand) SetFlags 

func (c *ActionFailCommand) SetFlags(f *gnuflag.FlagSet)

SetFlags handles any option flags, but there are none.

type ActionGetCommand 

type ActionGetCommand struct {
	cmd.CommandBase
	// contains filtered or unexported fields
}

ActionGetCommand implements the action-get command.

func (*ActionGetCommand) Info 

func (c *ActionGetCommand) Info() *cmd.Info

Info returns the content for --help.

func (*ActionGetCommand) Init 

func (c *ActionGetCommand) Init(args []string) error

Init makes sure there are no additional unknown arguments to action-get.

func (*ActionGetCommand) Run 

func (c *ActionGetCommand) Run(ctx *cmd.Context) error

Run recurses into the params map for the Action, given the list of keys into the map, and returns either the keyed value, or nothing. In the case of an empty keys list, the entire params map will be returned.

func (*ActionGetCommand) SetFlags 

func (c *ActionGetCommand) SetFlags(f *gnuflag.FlagSet)

SetFlags handles known option flags; in this case, [--output={json|yaml}] and --help.

type ActionHookContext 

type ActionHookContext interface {
	HookContext
	// contains filtered or unexported methods
}

ActionHookContext is the context for an action hook.

type ActionSetCommand 

type ActionSetCommand struct {
	cmd.CommandBase
	// contains filtered or unexported fields
}

ActionSetCommand implements the action-set command.

func (*ActionSetCommand) Info 

func (c *ActionSetCommand) Info() *cmd.Info

Info returns the content for --help.

func (*ActionSetCommand) Init 

func (c *ActionSetCommand) Init(args []string) error

Init accepts maps in the form of key=value, key.key2.keyN....=value

func (*ActionSetCommand) Run 

func (c *ActionSetCommand) Run(ctx *cmd.Context) error

Run adds the given <key list>/<value> pairs, such as foo.bar=baz to the existing map of results for the Action.

func (*ActionSetCommand) SetFlags 

func (c *ActionSetCommand) SetFlags(f *gnuflag.FlagSet)

SetFlags handles known option flags.

type AddMetricCommand 

type AddMetricCommand struct {
	cmd.CommandBase

	Metrics []Metric
	// contains filtered or unexported fields
}

AddMetricCommand implements the add-metric command.

func (*AddMetricCommand) Info 

func (c *AddMetricCommand) Info() *cmd.Info

Info returns the command infor structure for the add-metric command.

func (*AddMetricCommand) Init 

func (c *AddMetricCommand) Init(args []string) error

Init parses the command's parameters.

func (*AddMetricCommand) Run 

func (c *AddMetricCommand) Run(ctx *cmd.Context) (err error)

Run adds metrics to the hook context.

type CmdGetter 

type CmdGetter func(contextId, cmdName string) (cmd.Command, error)

CmdGetter looks up a Command implementation connected to a particular Context.

type ConfigGetCommand 

type ConfigGetCommand struct {
	cmd.CommandBase

	Key string // The key to show. If empty, show all.
	All bool
	// contains filtered or unexported fields
}

ConfigGetCommand implements the config-get command.

func (*ConfigGetCommand) Info 

func (c *ConfigGetCommand) Info() *cmd.Info

func (*ConfigGetCommand) Init 

func (c *ConfigGetCommand) Init(args []string) error

func (*ConfigGetCommand) Run 

func (c *ConfigGetCommand) Run(ctx *cmd.Context) error

func (*ConfigGetCommand) SetFlags 

func (c *ConfigGetCommand) SetFlags(f *gnuflag.FlagSet)

type Context 

type Context interface {
	HookContext
	// contains filtered or unexported methods
}

Context is the interface that all hook helper commands depend on to interact with the rest of the system.

type ContextInstance 

type ContextInstance interface {
	// AvailabilityZone returns the executing unit's availablilty zone.
	AvailabilityZone() (string, bool)

	// RequestReboot will set the reboot flag to true on the machine agent
	RequestReboot(prio RebootPriority) error
}

ContextInstance is the part of a hook context related to the unit's intance.

type ContextLeadership 

type ContextLeadership interface {
	// IsLeader returns true if the local unit is known to be leader for at
	// least the next 30s.
	IsLeader() (bool, error)

	// LeaderSettings returns the current leader settings. Once leader settings
	// have been read in a given context, they will not be updated other than
	// via successful calls to WriteLeaderSettings.
	LeaderSettings() (map[string]string, error)

	// WriteLeaderSettings writes the supplied settings directly to state, or
	// fails if the local unit is not the service's leader.
	WriteLeaderSettings(map[string]string) error
}

ContextLeadership is the part of a hook context related to the unit leadership.

type ContextMetrics 

type ContextMetrics interface {
	// AddMetric records a metric to return after hook execution.
	AddMetric(string, string, time.Time) error
}

ContextMetrics is the part of a hook context related to metrics.

type ContextNetworking 

type ContextNetworking interface {
	// PublicAddress returns the executing unit's public address.
	PublicAddress() (string, bool)

	// PrivateAddress returns the executing unit's private address.
	PrivateAddress() (string, bool)

	// OpenPorts marks the supplied port range for opening when the
	// executing unit's service is exposed.
	OpenPorts(protocol string, fromPort, toPort int) error

	// ClosePorts ensures the supplied port range is closed even when
	// the executing unit's service is exposed (unless it is opened
	// separately by a co- located unit).
	ClosePorts(protocol string, fromPort, toPort int) error

	// OpenedPorts returns all port ranges currently opened by this
	// unit on its assigned machine. The result is sorted first by
	// protocol, then by number.
	OpenedPorts() []network.PortRange
}

ContextNetworking is the part of a hook context related to network interface of the unit's instance.

type ContextRelation 

type ContextRelation interface {

	// Id returns an integer which uniquely identifies the relation.
	Id() int

	// Name returns the name the locally executing charm assigned to this relation.
	Name() string

	// FakeId returns a string of the form "relation-name:123", which uniquely
	// identifies the relation to the hook. In reality, the identification
	// of the relation is the integer following the colon, but the composed
	// name is useful to humans observing it.
	FakeId() string

	// Settings allows read/write access to the local unit's settings in
	// this relation.
	Settings() (Settings, error)

	// UnitNames returns a list of the remote units in the relation.
	UnitNames() []string

	// ReadSettings returns the settings of any remote unit in the relation.
	ReadSettings(unit string) (params.Settings, error)
}

ContextRelation expresses the capabilities of a hook with respect to a relation.

type ContextRelations 

type ContextRelations interface {
	// Relation returns the relation with the supplied id if it was found, and
	// whether it was found.
	Relation(id int) (ContextRelation, bool)

	// RelationIds returns the ids of all relations the executing unit is
	// currently participating in.
	RelationIds() []int
}

ContextRelations exposes the relations associated with the unit.

type ContextStatus 

type ContextStatus interface {
	// UnitStatus returns the executing unit's current status.
	UnitStatus() (*StatusInfo, error)

	// SetUnitStatus updates the unit's status.
	SetUnitStatus(StatusInfo) error

	// ServiceStatus returns the executing unit's service status
	// (including all units).
	ServiceStatus() (ServiceStatusInfo, error)

	// SetServiceStatus updates the status for the unit's service.
	SetServiceStatus(StatusInfo) error
}

ContextStatus is the part of a hook context related to the unit's status.

type ContextStorage 

type ContextStorage interface {
	// Storage returns the ContextStorageAttachment with the supplied
	// tag if it was found, and whether it was found.
	Storage(names.StorageTag) (ContextStorageAttachment, bool)

	// HookStorage returns the storage attachment associated
	// the executing hook if it was found, and whether it was found.
	HookStorage() (ContextStorageAttachment, bool)

	// AddUnitStorage saves storage constraints in the context.
	AddUnitStorage(map[string]params.StorageConstraints)
}

ContextStorage is the part of a hook context related to storage resources associated with the unit.

type ContextStorageAttachment 

type ContextStorageAttachment interface {

	// Tag returns a tag which uniquely identifies the storage attachment
	// in the context of the unit.
	Tag() names.StorageTag

	// Kind returns the kind of the storage.
	Kind() storage.StorageKind

	// Location returns the location of the storage: the mount point for
	// filesystem-kind stores, and the device path for block-kind stores.
	Location() string
}

ContextStorageAttachment expresses the capabilities of a hook with respect to a storage attachment.

type ContextUnit 

type ContextUnit interface {
	// UnitName returns the executing unit's name.
	UnitName() string

	// OwnerTag returns the user tag of the service the executing
	// units belongs to.
	OwnerTag() string

	// Config returns the current service configuration of the executing unit.
	ConfigSettings() (charm.Settings, error)
}

ContextUnit is the part of a hook context related to the unit.

type HookContext 

type HookContext interface {
	ContextUnit
	ContextStatus
	ContextInstance
	ContextNetworking
	ContextLeadership
	ContextMetrics
	ContextStorage
	ContextRelations
}

HookContext represents the information and functionality that is common to all charm hooks.

type JujuLogCommand 

type JujuLogCommand struct {
	cmd.CommandBase

	Message string
	Debug   bool
	Level   string
	// contains filtered or unexported fields
}

JujuLogCommand implements the juju-log command.

func (*JujuLogCommand) Info 

func (c *JujuLogCommand) Info() *cmd.Info

func (*JujuLogCommand) Init 

func (c *JujuLogCommand) Init(args []string) error

func (*JujuLogCommand) Run 

func (c *JujuLogCommand) Run(ctx *cmd.Context) error

func (*JujuLogCommand) SetFlags 

func (c *JujuLogCommand) SetFlags(f *gnuflag.FlagSet)

type JujuRebootCommand 

type JujuRebootCommand struct {
	cmd.CommandBase

	Now bool
	// contains filtered or unexported fields
}

JujuRebootCommand implements the juju-reboot command.

func (*JujuRebootCommand) Info 

func (c *JujuRebootCommand) Info() *cmd.Info

func (*JujuRebootCommand) Init 

func (c *JujuRebootCommand) Init(args []string) error

func (*JujuRebootCommand) Run 

func (c *JujuRebootCommand) Run(ctx *cmd.Context) error

func (*JujuRebootCommand) SetFlags 

func (c *JujuRebootCommand) SetFlags(f *gnuflag.FlagSet)

type Jujuc 

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

Jujuc implements the jujuc command in the form required by net/rpc.

func (*Jujuc) Main 

func (j *Jujuc) Main(req Request, resp *exec.ExecResponse) error

Main runs the Command specified by req, and fills in resp. A single command is run at a time.

type Metric 

type Metric struct {
	Key   string
	Value string
	Time  time.Time
}

Metric represents a single metric set by the charm.

type OpenedPortsCommand 

type OpenedPortsCommand struct {
	cmd.CommandBase
	// contains filtered or unexported fields
}

OpenedPortsCommand implements the opened-ports command.

func (*OpenedPortsCommand) Info 

func (c *OpenedPortsCommand) Info() *cmd.Info

func (*OpenedPortsCommand) Init 

func (c *OpenedPortsCommand) Init(args []string) error

func (*OpenedPortsCommand) Run 

func (c *OpenedPortsCommand) Run(ctx *cmd.Context) error

func (*OpenedPortsCommand) SetFlags 

func (c *OpenedPortsCommand) SetFlags(f *gnuflag.FlagSet)

type OwnerGetCommand 

type OwnerGetCommand struct {
	cmd.CommandBase

	Key string
	// contains filtered or unexported fields
}

OwnerGetCommand implements the owner-get command.

func (*OwnerGetCommand) Info 

func (c *OwnerGetCommand) Info() *cmd.Info

func (*OwnerGetCommand) Init 

func (c *OwnerGetCommand) Init(args []string) error

func (*OwnerGetCommand) Run 

func (c *OwnerGetCommand) Run(ctx *cmd.Context) error

func (*OwnerGetCommand) SetFlags 

func (c *OwnerGetCommand) SetFlags(f *gnuflag.FlagSet)

type RebootPriority 

type RebootPriority int

RebootPriority is the type used for reboot requests. 

const (
	// RebootSkip is a noop.
	RebootSkip RebootPriority = iota
	// RebootAfterHook means wait for current hook to finish before
	// rebooting.
	RebootAfterHook
	// RebootNow means reboot immediately, killing and requeueing the
	// calling hook
	RebootNow
)

type RelationGetCommand 

type RelationGetCommand struct {
	cmd.CommandBase

	RelationId int
	Key        string
	UnitName   string
	// contains filtered or unexported fields
}

RelationGetCommand implements the relation-get command.

func (*RelationGetCommand) Info 

func (c *RelationGetCommand) Info() *cmd.Info

func (*RelationGetCommand) Init 

func (c *RelationGetCommand) Init(args []string) error

func (*RelationGetCommand) Run 

func (c *RelationGetCommand) Run(ctx *cmd.Context) error

func (*RelationGetCommand) SetFlags 

func (c *RelationGetCommand) SetFlags(f *gnuflag.FlagSet)

type RelationHookContext 

type RelationHookContext interface {
	HookContext
	// contains filtered or unexported methods
}

RelationHookContext is the context for a relation hook.

type RelationIdsCommand 

type RelationIdsCommand struct {
	cmd.CommandBase

	Name string
	// contains filtered or unexported fields
}

RelationIdsCommand implements the relation-ids command.

func (*RelationIdsCommand) Info 

func (c *RelationIdsCommand) Info() *cmd.Info

func (*RelationIdsCommand) Init 

func (c *RelationIdsCommand) Init(args []string) error

func (*RelationIdsCommand) Run 

func (c *RelationIdsCommand) Run(ctx *cmd.Context) error

func (*RelationIdsCommand) SetFlags 

func (c *RelationIdsCommand) SetFlags(f *gnuflag.FlagSet)

type RelationListCommand 

type RelationListCommand struct {
	cmd.CommandBase

	RelationId int
	// contains filtered or unexported fields
}

RelationListCommand implements the relation-list command.

func (*RelationListCommand) Info 

func (c *RelationListCommand) Info() *cmd.Info

func (*RelationListCommand) Init 

func (c *RelationListCommand) Init(args []string) (err error)

func (*RelationListCommand) Run 

func (c *RelationListCommand) Run(ctx *cmd.Context) error

func (*RelationListCommand) SetFlags 

func (c *RelationListCommand) SetFlags(f *gnuflag.FlagSet)

type RelationSetCommand 

type RelationSetCommand struct {
	cmd.CommandBase

	RelationId int
	Settings   map[string]string
	// contains filtered or unexported fields
}

RelationSetCommand implements the relation-set command.

func (*RelationSetCommand) Info 

func (c *RelationSetCommand) Info() *cmd.Info

func (*RelationSetCommand) Init 

func (c *RelationSetCommand) Init(args []string) error

func (*RelationSetCommand) Run 

func (c *RelationSetCommand) Run(ctx *cmd.Context) (err error)

func (*RelationSetCommand) SetFlags 

func (c *RelationSetCommand) SetFlags(f *gnuflag.FlagSet)

type Request 

type Request struct {
	ContextId   string
	Dir         string
	CommandName string
	Args        []string

	// StdinSet indicates whether or not the client supplied stdin. This is
	// necessary as Stdin will be nil if the client supplied stdin but it
	// is empty.
	StdinSet bool
	Stdin    []byte
}

Request contains the information necessary to run a Command remotely.

type Server 

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

Server implements a server that serves command invocations via a unix domain socket.

func NewServer 

func NewServer(getCmd CmdGetter, socketPath string) (*Server, error)

NewServer creates an RPC server bound to socketPath, which can execute remote command invocations against an appropriate Context. It will not actually do so until Run is called.

func (*Server) Close 

func (s *Server) Close()

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

func (*Server) Run 

func (s *Server) 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.

type ServiceStatusInfo 

type ServiceStatusInfo struct {
	Service StatusInfo
	Units   []StatusInfo
}

ServiceStatusInfo holds StatusInfo for a Service and all its Units.

type Settings 

type Settings interface {
	Map() params.Settings
	Set(string, string)
	Delete(string)
}

Settings is implemented by types that manipulate unit settings.

type StatusGetCommand 

type StatusGetCommand struct {
	cmd.CommandBase
	// contains filtered or unexported fields
}

StatusGetCommand implements the status-get command.

func (*StatusGetCommand) Info 

func (c *StatusGetCommand) Info() *cmd.Info

func (*StatusGetCommand) Init 

func (c *StatusGetCommand) Init(args []string) error

func (*StatusGetCommand) Run 

func (c *StatusGetCommand) Run(ctx *cmd.Context) error

func (*StatusGetCommand) ServiceStatus 

func (c *StatusGetCommand) ServiceStatus(ctx *cmd.Context) error

func (*StatusGetCommand) SetFlags 

func (c *StatusGetCommand) SetFlags(f *gnuflag.FlagSet)

type StatusInfo 

type StatusInfo struct {
	Tag    string
	Status string
	Info   string
	Data   map[string]interface{}
}

StatusInfo is a record of the status information for a service or a unit's workload.

type StatusSetCommand 

type StatusSetCommand struct {
	cmd.CommandBase
	// contains filtered or unexported fields
}

StatusSetCommand implements the status-set command.

func (*StatusSetCommand) Info 

func (c *StatusSetCommand) Info() *cmd.Info

func (*StatusSetCommand) Init 

func (c *StatusSetCommand) Init(args []string) error

func (*StatusSetCommand) Run 

func (c *StatusSetCommand) Run(ctx *cmd.Context) error

func (*StatusSetCommand) SetFlags 

func (c *StatusSetCommand) SetFlags(f *gnuflag.FlagSet)

type StorageAddCommand 

type StorageAddCommand struct {
	cmd.CommandBase
	// contains filtered or unexported fields
}

StorageAddCommand implements the status-set command.

func (*StorageAddCommand) Info 

func (s *StorageAddCommand) Info() *cmd.Info

func (*StorageAddCommand) Init 

func (s *StorageAddCommand) Init(args []string) error

func (*StorageAddCommand) Run 

func (s *StorageAddCommand) Run(ctx *cmd.Context) error

type StorageGetCommand 

type StorageGetCommand struct {
	cmd.CommandBase
	// contains filtered or unexported fields
}

StorageGetCommand implements the storage-get command.

func (*StorageGetCommand) Info 

func (c *StorageGetCommand) Info() *cmd.Info

func (*StorageGetCommand) Init 

func (c *StorageGetCommand) Init(args []string) error

func (*StorageGetCommand) Run 

func (c *StorageGetCommand) Run(ctx *cmd.Context) error

func (*StorageGetCommand) SetFlags 

func (c *StorageGetCommand) SetFlags(f *gnuflag.FlagSet)

type UnitGetCommand 

type UnitGetCommand struct {
	cmd.CommandBase

	Key string
	// contains filtered or unexported fields
}

UnitGetCommand implements the unit-get command.

func (*UnitGetCommand) Info 

func (c *UnitGetCommand) Info() *cmd.Info

func (*UnitGetCommand) Init 

func (c *UnitGetCommand) Init(args []string) error

func (*UnitGetCommand) Run 

func (c *UnitGetCommand) Run(ctx *cmd.Context) error

func (*UnitGetCommand) SetFlags 

func (c *UnitGetCommand) SetFlags(f *gnuflag.FlagSet)

type UnitHookContext 

type UnitHookContext interface {
	HookContext
}

UnitHookContext is the context for a unit hook.

Source Files

View all Source files

Directories

Path Synopsis

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.