jujuc

package
v0.0.0-...-9ec3720 Latest Latest
Warning

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

 Go to latest Published: Apr 6, 2021 License: AGPL-3.0 Imports: 34 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

View Source 
const CmdSuffix = cmdSuffix

CmdSuffix is the filename suffix to use for executables.

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 ErrRestrictedContext = errors.NotImplementedf("not implemented for restricted context")

ErrRestrictedContext indicates a method is not implemented in the given context.

View Source 
var StorageAddDoc = `
Storage add adds storage instances to unit using provided storage directives.
A storage directive consists of a storage name as per charm specification
and optional storage COUNT.

COUNT is a positive integer indicating how many instances
of the storage to create. If unspecified, COUNT defaults to 1.
`[1:]

Functions

func CommandNames 

func CommandNames() (names []string)

CommandNames returns the names of all jujuc commands.

func IsNotAvailable 

func IsNotAvailable(err error) bool

IsNotAvailable reports whether err was creates with NotAvailable().

func NewActionFailCommand 

func NewActionFailCommand(ctx Context) (cmd.Command, error)

NewActionFailCommand returns a new ActionFailCommand with the given context.

func NewActionGetCommand 

func NewActionGetCommand(ctx Context) (cmd.Command, error)

NewActionGetCommand returns an ActionGetCommand for use with the given context.

func NewActionLogCommand 

func NewActionLogCommand(ctx Context) (cmd.Command, error)

func NewActionSetCommand 

func NewActionSetCommand(ctx Context) (cmd.Command, error)

NewActionSetCommand returns a new ActionSetCommand with the given context.

func NewAddMetricCommand 

func NewAddMetricCommand(ctx Context) (cmd.Command, error)

NewAddMetricCommand generates a new AddMetricCommand.

func NewApplicationVersionSetCommand 

func NewApplicationVersionSetCommand(ctx Context) (cmd.Command, error)

NewApplicationVersionSetCommand creates an application-version-set command.

func NewClosePortCommand 

func NewClosePortCommand(ctx Context) (cmd.Command, error)

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, error)

func NewCredentialGetCommand 

func NewCredentialGetCommand(ctx Context) (cmd.Command, error)

NewCredentialGetCommand returns a new CredentialGetCommand with the given context.

func NewGoalStateCommand 

func NewGoalStateCommand(ctx Context) (cmd.Command, error)

func NewIsLeaderCommand 

func NewIsLeaderCommand(ctx Context) (cmd.Command, error)

NewIsLeaderCommand returns a new isLeaderCommand with the given context.

func NewJujuLogCommand 

func NewJujuLogCommand(ctx Context) (cmd.Command, error)

func NewJujuRebootCommand 

func NewJujuRebootCommand(ctx Context) (cmd.Command, error)

func NewK8sRawGetCommand 

func NewK8sRawGetCommand(ctx Context) (cmd.Command, error)

NewK8sRawGetCommand makes a k8s-raw-get command.

func NewK8sRawSetCommand 

func NewK8sRawSetCommand(ctx Context) (cmd.Command, error)

NewK8sRawSetCommand makes a k8s-raw-set command.

func NewK8sSpecGetCommand 

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

NewK8sSpecGetCommand makes a k8s-spec-get command.

func NewK8sSpecSetCommand 

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

NewK8sSpecSetCommand makes a k8s-spec-set command.

func NewLeaderGetCommand 

func NewLeaderGetCommand(ctx Context) (cmd.Command, error)

NewLeaderGetCommand returns a new leaderGetCommand with the given context.

func NewLeaderSetCommand 

func NewLeaderSetCommand(ctx Context) (cmd.Command, error)

NewLeaderSetCommand returns a new leaderSetCommand with the given context.

func NewNetworkGetCommand 

func NewNetworkGetCommand(ctx Context) (_ cmd.Command, err error)

func NewOpenPortCommand 

func NewOpenPortCommand(ctx Context) (cmd.Command, error)

func NewOpenedPortsCommand 

func NewOpenedPortsCommand(ctx Context) (cmd.Command, error)

func NewRelationGetCommand 

func NewRelationGetCommand(ctx Context) (cmd.Command, error)

func NewRelationIdValue 

func NewRelationIdValue(ctx Context, result *int) (*relationIdValue, error)

NewRelationIdValue returns a gnuflag.Value for convenient parsing of relation ids in ctx.

func NewRelationIdsCommand 

func NewRelationIdsCommand(ctx Context) (cmd.Command, error)

func NewRelationListCommand 

func NewRelationListCommand(ctx Context) (cmd.Command, error)

func NewRelationSetCommand 

func NewRelationSetCommand(ctx Context) (cmd.Command, error)

func NewStateDeleteCommand 

func NewStateDeleteCommand(ctx Context) (cmd.Command, error)

NewStateDeleteCommand returns a state-delete command.

func NewStateGetCommand 

func NewStateGetCommand(ctx Context) (cmd.Command, error)

NewStateGetCommand returns a state-get command.

func NewStateSetCommand 

func NewStateSetCommand(ctx Context) (cmd.Command, error)

NewStateSetCommand returns a state-set command.

func NewStatusGetCommand 

func NewStatusGetCommand(ctx Context) (cmd.Command, error)

func NewStatusSetCommand 

func NewStatusSetCommand(ctx Context) (cmd.Command, error)

NewStatusSetCommand makes a jujuc status-set command.

func NewStorageAddCommand 

func NewStorageAddCommand(ctx Context) (cmd.Command, error)

NewStorageAddCommand makes a jujuc storage-add command.

func NewStorageGetCommand 

func NewStorageGetCommand(ctx Context) (cmd.Command, error)

func NewStorageListCommand 

func NewStorageListCommand(ctx Context) (cmd.Command, error)

func NewUnitGetCommand 

func NewUnitGetCommand(ctx Context) (cmd.Command, error)

func NotAvailable 

func NotAvailable(thing string) error

NotAvailable returns an error which satisfies IsNotAvailable.

func RegisterCommand 

func RegisterCommand(name string, f creator)

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 ActionLogCommand 

type ActionLogCommand struct {
	cmd.CommandBase

	Message string
	// contains filtered or unexported fields
}

ActionLogCommand implements the action-log command.

func (*ActionLogCommand) Info 

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

func (*ActionLogCommand) Init 

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

func (*ActionLogCommand) Run 

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

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

	Labels  string
	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 info 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.

func (*AddMetricCommand) SetFlags 

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

SetFlags implements Command.

type ApplicationStatusInfo 

type ApplicationStatusInfo struct {
	Application StatusInfo
	Units       []StatusInfo
}

ApplicationStatusInfo holds StatusInfo for an Application and all its Units.

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 ContextComponent 

type ContextComponent interface {
	// Flush pushes the component's data to Juju state.
	// In the Flush implementation, call your components API.
	Flush() error
}

ContextComponent is a single modular Juju component as it relates to the current unit and hook. Components should implement this interfaces in a type-safe way. Ensuring checked type-conversions are preformed on the result and value interfaces. You will use the runner.RegisterComponentFunc to register a your components concrete ContextComponent implementation.

See: process/context/context.go for an implementation example.

type ContextComponents 

type ContextComponents interface {
	// Component returns the ContextComponent with the supplied name if
	// it was found.
	Component(name string) (ContextComponent, error)
}

ContextComponents exposes modular Juju components as they relate to the unit in the context of the hook.

type ContextInstance 

type ContextInstance interface {
	// AvailabilityZone returns the executing unit's availability zone or an error
	// if it was not found (or is not available).
	AvailabilityZone() (string, error)

	// 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 instance.

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 application'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
	// AddMetricLabels records a metric with tags to return after hook execution.
	AddMetricLabels(string, string, time.Time, map[string]string) 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 or an
	// error if it is not available.
	PublicAddress() (string, error)

	// PrivateAddress returns the executing unit's private address or an
	// error if it is not available.
	PrivateAddress() (string, error)

	// OpenPortRange marks the supplied port range for opening.
	OpenPortRange(endpointName string, portRange network.PortRange) error

	// ClosePortRange ensures the supplied port range is closed even when
	// the executing unit's application is exposed (unless it is opened
	// separately by a co- located unit).
	ClosePortRange(endpointName string, portRange network.PortRange) error

	// OpenedPortRanges returns all port ranges currently opened by this
	// unit on its assigned machine grouped by endpoint name.
	OpenedPortRanges() network.GroupedPortRanges

	// NetworkInfo returns the network info for the given bindings on the given relation.
	NetworkInfo(bindingNames []string, relationId int) (map[string]params.NetworkInfoResult, error)
}

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)

	// ApplicationSettings allows read/write access to the application settings in
	// this relation, but only if the current unit is leader.
	ApplicationSettings() (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)

	// ReadApplicationSettings returns the application settings of any remote unit in the relation.
	ReadApplicationSettings(app string) (params.Settings, error)

	// Suspended returns true if the relation is suspended.
	Suspended() bool

	// SetStatus sets the relation's status.
	SetStatus(relation.Status) error

	// RemoteApplicationName returns the application on the other end of
	// the relation from the perspective of this unit.
	RemoteApplicationName() string

	// Life returns the relation's current life state.
	Life() life.Value
}

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
	// an error if it was not found or is not available.
	Relation(id int) (ContextRelation, error)

	// RelationIds returns the ids of all relations the executing unit is
	// currently participating in or an error if they are not available.
	RelationIds() ([]int, error)
}

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

	// ApplicationStatus returns the executing unit's application status
	// (including all units).
	ApplicationStatus() (ApplicationStatusInfo, error)

	// SetApplicationStatus updates the status for the unit's application.
	SetApplicationStatus(StatusInfo) error
}

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

type ContextStorage 

type ContextStorage interface {
	// StorageTags returns a list of tags for storage instances
	// attached to the unit or an error if they are not available.
	StorageTags() ([]names.StorageTag, error)

	// Storage returns the ContextStorageAttachment with the supplied
	// tag if it was found, and an error if it was not found or is not
	// available to the context.
	Storage(names.StorageTag) (ContextStorageAttachment, error)

	// HookStorage returns the storage attachment associated
	// the executing hook if it was found, and an error if it
	// was not found or is not available.
	HookStorage() (ContextStorageAttachment, error)

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

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

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

	// GoalState returns the goal state for the current unit.
	GoalState() (*application.GoalState, error)

	// SetPodSpec updates the yaml spec used to create a pod.
	// TODO(wallyworld) - rename to SetK8sSpec (here and elsewhere)
	SetPodSpec(specYaml string) error

	// GetPodSpec returns the yaml spec used to create a pod.
	// TODO(wallyworld) - rename to GetK8sSpec (here and elsewhere)
	GetPodSpec() (string, error)

	// SetRawK8sSpec updates the raw yaml spec used to create a pod.
	SetRawK8sSpec(specYaml string) error

	// GetRawK8sSpec returns the raw yaml spec used to create a pod.
	GetRawK8sSpec() (string, error)

	// CloudSpec returns the unit's cloud specification
	CloudSpec() (*params.CloudSpec, error)
}

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

type ContextVersion 

type ContextVersion interface {

	// UnitWorkloadVersion returns the currently set workload version for
	// the unit.
	UnitWorkloadVersion() (string, error)

	// SetUnitWorkloadVersion updates the workload version for the unit.
	SetUnitWorkloadVersion(string) error
}

ContextVersion expresses the parts of a hook context related to reporting workload versions.

type CredentialGetCommand 

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

CredentialGetCommand implements the leader-get command.

func (*CredentialGetCommand) Info 

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

Info is part of the cmd.Command interface.

func (*CredentialGetCommand) Init 

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

Init is part of the cmd.Command interface.

func (*CredentialGetCommand) Run 

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

Run is part of the cmd.Command interface.

func (*CredentialGetCommand) SetFlags 

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

SetFlags is part of the cmd.Command interface.

type GoalStateCommand 

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

GoalStateCommand implements the config-get command.

func (*GoalStateCommand) Info 

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

func (*GoalStateCommand) Init 

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

func (*GoalStateCommand) Run 

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

func (*GoalStateCommand) SetFlags 

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

type HookContext 

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

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 JujuLogCommandLogger 

type JujuLogCommandLogger interface {
	Logf(level loggo.Level, message string, args ...interface{})
	Warningf(message string, args ...interface{})
}

JujuLogCommandLogger provides a Logger interface for the juju-log command.

type JujuLogCommandLoggerFactory 

type JujuLogCommandLoggerFactory interface {
	GetLogger(name string) JujuLogCommandLogger
}

JujuLogCommandLoggerFactory is used to create new loggers (stickupkid) We should derive this from the context itself.

type JujuLogContext 

type JujuLogContext interface {
	UnitName() string
	HookRelation() (ContextRelation, error)
}

JujuLogContext is the Context for the JujuLogCommand

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 K8sRawGetCommand 

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

K8sRawGetCommand implements the k8s-raw-get command.

func (*K8sRawGetCommand) Info 

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

func (*K8sRawGetCommand) Run 

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

type K8sRawSetCommand 

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

K8sRawSetCommand implements the k8s-raw-set command.

func (*K8sRawSetCommand) Info 

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

func (*K8sRawSetCommand) Init 

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

func (*K8sRawSetCommand) Run 

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

func (*K8sRawSetCommand) SetFlags 

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

type K8sSpecGetCommand 

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

K8sSpecGetCommand implements the k8s-spec-get command.

func (*K8sSpecGetCommand) Info 

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

func (*K8sSpecGetCommand) Run 

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

type K8sSpecSetCommand 

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

K8sSpecSetCommand implements the k8s-spec-set command.

func (*K8sSpecSetCommand) Info 

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

func (*K8sSpecSetCommand) Init 

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

func (*K8sSpecSetCommand) Run 

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

func (*K8sSpecSetCommand) SetFlags 

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

type Metric 

type Metric struct {
	Key    string
	Value  string
	Time   time.Time
	Labels map[string]string `json:",omitempty"`
}

Metric represents a single metric set by the charm.

type NetworkGetCommand 

type NetworkGetCommand struct {
	cmd.CommandBase

	RelationId int
	// contains filtered or unexported fields
}

NetworkGetCommand implements the network-get command.

func (*NetworkGetCommand) Info 

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

Info is part of the cmd.Command interface.

func (*NetworkGetCommand) Init 

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

Init is part of the cmd.Command interface.

func (*NetworkGetCommand) Run 

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

func (*NetworkGetCommand) SetFlags 

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

SetFlags is part of the cmd.Command interface.

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 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

	Application bool

	Key           string
	UnitOrAppName string
	// contains filtered or unexported fields
}

RelationGetCommand implements the relation-get command.

func (*RelationGetCommand) Info 

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

Info is part of the cmd.Command interface.

func (*RelationGetCommand) Init 

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

Init is part of the cmd.Command interface.

func (*RelationGetCommand) Run 

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

func (*RelationGetCommand) SetFlags 

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

SetFlags is part of the cmd.Command interface.

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

	ListRemoteApplication bool
	// 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

	Application bool
	// 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

	Token string
}

Request contains the information necessary to run a Command remotely.

type RestrictedContext 

type RestrictedContext struct{}

RestrictedContext is a base implementation for restricted contexts to embed, so that an error is returned for methods that are not explicitly implemented.

func (*RestrictedContext) ActionParams 

func (*RestrictedContext) ActionParams() (map[string]interface{}, error)

ActionParams implements hooks.Context.

func (*RestrictedContext) AddMetric 

func (*RestrictedContext) AddMetric(string, string, time.Time) error

AddMetric implements hooks.Context.

func (*RestrictedContext) AddMetricLabels 

func (*RestrictedContext) AddMetricLabels(string, string, time.Time, map[string]string) error

AddMetricLabels implements hooks.Context.

func (*RestrictedContext) AddUnitStorage 

func (*RestrictedContext) AddUnitStorage(map[string]params.StorageConstraints) error

AddUnitStorage implements hooks.Context.

func (*RestrictedContext) ApplicationStatus 

func (*RestrictedContext) ApplicationStatus() (ApplicationStatusInfo, error)

ApplicationStatus implements hooks.Context.

func (*RestrictedContext) AvailabilityZone 

func (*RestrictedContext) AvailabilityZone() (string, error)

AvailabilityZone implements hooks.Context.

func (*RestrictedContext) ClosePortRange 

func (*RestrictedContext) ClosePortRange(string, network.PortRange) error

ClosePortRange implements hooks.Context.

func (*RestrictedContext) CloudSpec 

func (c *RestrictedContext) CloudSpec() (*params.CloudSpec, error)

CloudSpec implements hooks.Context.

func (*RestrictedContext) Component 

func (*RestrictedContext) Component(string) (ContextComponent, error)

Component implements jujc.Context.

func (*RestrictedContext) ConfigSettings 

func (*RestrictedContext) ConfigSettings() (charm.Settings, error)

ConfigSettings implements hooks.Context.

func (*RestrictedContext) DeleteCharmStateValue 

func (*RestrictedContext) DeleteCharmStateValue(string) error

DeleteCharmStateValue implements jujuc.unitCharmStateContext.

func (*RestrictedContext) GetCharmState 

func (*RestrictedContext) GetCharmState() (map[string]string, error)

GetCharmState implements jujuc.unitCharmStateContext.

func (*RestrictedContext) GetCharmStateValue 

func (*RestrictedContext) GetCharmStateValue(string) (string, error)

GetSingleCharmStateValue implements jujuc.unitCharmStateContext.

func (*RestrictedContext) GetPodSpec 

func (c *RestrictedContext) GetPodSpec() (string, error)

GetPodSpec implements hooks.Context.

func (*RestrictedContext) GetRawK8sSpec 

func (c *RestrictedContext) GetRawK8sSpec() (string, error)

GetRawK8sSpec implements hooks.Context.

func (*RestrictedContext) GoalState 

func (*RestrictedContext) GoalState() (*application.GoalState, error)

GoalState implements hooks.Context.

func (*RestrictedContext) HookRelation 

func (*RestrictedContext) HookRelation() (ContextRelation, error)

HookRelation implements hooks.Context.

func (*RestrictedContext) HookStorage 

func (*RestrictedContext) HookStorage() (ContextStorageAttachment, error)

HookStorage implements hooks.Context.

func (*RestrictedContext) IsLeader 

func (*RestrictedContext) IsLeader() (bool, error)

IsLeader implements hooks.Context.

func (*RestrictedContext) LeaderSettings 

func (*RestrictedContext) LeaderSettings() (map[string]string, error)

LeaderSettings implements hooks.Context.

func (*RestrictedContext) LogActionMessage 

func (*RestrictedContext) LogActionMessage(string) error

LogActionMessage implements hooks.Context.

func (*RestrictedContext) NetworkInfo 

func (*RestrictedContext) NetworkInfo(bindingNames []string, relationId int) (map[string]params.NetworkInfoResult, error)

NetworkInfo implements hooks.Context.

func (*RestrictedContext) OpenPortRange 

func (*RestrictedContext) OpenPortRange(string, network.PortRange) error

OpenPortRange implements hooks.Context.

func (*RestrictedContext) OpenedPortRanges 

func (*RestrictedContext) OpenedPortRanges() network.GroupedPortRanges

OpenedPortRanges implements hooks.Context.

func (*RestrictedContext) PrivateAddress 

func (*RestrictedContext) PrivateAddress() (string, error)

PrivateAddress implements hooks.Context.

func (*RestrictedContext) PublicAddress 

func (*RestrictedContext) PublicAddress() (string, error)

PublicAddress implements hooks.Context.

func (*RestrictedContext) Relation 

func (*RestrictedContext) Relation(id int) (ContextRelation, error)

Relation implements hooks.Context.

func (*RestrictedContext) RelationIds 

func (*RestrictedContext) RelationIds() ([]int, error)

RelationIds implements hooks.Context.

func (*RestrictedContext) RemoteApplicationName 

func (*RestrictedContext) RemoteApplicationName() (string, error)

RemoteApplicationName implements hooks.Context.

func (*RestrictedContext) RemoteUnitName 

func (*RestrictedContext) RemoteUnitName() (string, error)

RemoteUnitName implements hooks.Context.

func (*RestrictedContext) RequestReboot 

func (*RestrictedContext) RequestReboot(prio RebootPriority) error

RequestReboot implements hooks.Context.

func (*RestrictedContext) SetActionFailed 

func (*RestrictedContext) SetActionFailed() error

SetActionFailed implements hooks.Context.

func (*RestrictedContext) SetActionMessage 

func (*RestrictedContext) SetActionMessage(string) error

SetActionMessage implements hooks.Context.

func (*RestrictedContext) SetApplicationStatus 

func (*RestrictedContext) SetApplicationStatus(StatusInfo) error

SetApplicationStatus implements hooks.Context.

func (*RestrictedContext) SetCharmStateValue 

func (*RestrictedContext) SetCharmStateValue(string, string) error

SetCharmStateValue implements jujuc.unitCharmStateContext.

func (*RestrictedContext) SetPodSpec 

func (c *RestrictedContext) SetPodSpec(specYaml string) error

SetPodSpec implements hooks.Context.

func (*RestrictedContext) SetRawK8sSpec 

func (c *RestrictedContext) SetRawK8sSpec(specYaml string) error

SetRawK8sSpec implements hooks.Context.

func (*RestrictedContext) SetUnitStatus 

func (*RestrictedContext) SetUnitStatus(StatusInfo) error

SetUnitStatus implements hooks.Context.

func (*RestrictedContext) SetUnitWorkloadVersion 

func (*RestrictedContext) SetUnitWorkloadVersion(string) error

SetUnitWorkloadVersion implements hooks.Context.

func (*RestrictedContext) Storage 

func (*RestrictedContext) Storage(names.StorageTag) (ContextStorageAttachment, error)

Storage implements hooks.Context.

func (*RestrictedContext) StorageTags 

func (*RestrictedContext) StorageTags() ([]names.StorageTag, error)

StorageTags implements hooks.Context.

func (*RestrictedContext) UnitStatus 

func (*RestrictedContext) UnitStatus() (*StatusInfo, error)

UnitStatus implements hooks.Context.

func (*RestrictedContext) UnitWorkloadVersion 

func (*RestrictedContext) UnitWorkloadVersion() (string, error)

UnitWorkloadVersion implements hooks.Context.

func (*RestrictedContext) UpdateActionResults 

func (*RestrictedContext) UpdateActionResults(keys []string, value interface{}) error

UpdateActionResults implements hooks.Context.

func (*RestrictedContext) WorkloadName 

func (*RestrictedContext) WorkloadName() (string, error)

WorkloadName implements hooks.Context.

func (*RestrictedContext) WriteLeaderSettings 

func (*RestrictedContext) WriteLeaderSettings(map[string]string) error

WriteLeaderSettings implements hooks.Context.

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, socket sockets.Socket, token 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 Settings 

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

Settings is implemented by types that manipulate unit settings.

type StateDeleteCommand 

type StateDeleteCommand struct {
	cmd.CommandBase

	Key string // The key to delete
	// contains filtered or unexported fields
}

StateDeleteCommand implements the state-delete command.

func (*StateDeleteCommand) Info 

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

Info returns information about the Command. Info implements part of the cmd.Command interface.

func (*StateDeleteCommand) Init 

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

Init initializes the Command before running. Init implements part of the cmd.Command interface.

func (*StateDeleteCommand) Run 

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

Run will execute the Command as directed by the options and positional arguments passed to Init. Run implements part of the cmd.Command interface.

type StateGetCommand 

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

StateGetCommand implements the state-get command.

func (*StateGetCommand) Info 

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

Info returns information about the Command. Info implements part of the cmd.Command interface.

func (*StateGetCommand) Init 

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

Init initializes the Command before running. Init implements part of the cmd.Command interface.

func (*StateGetCommand) Run 

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

Run will execute the Command as directed by the options and positional arguments passed to Init. Run implements part of the cmd.Command interface.

func (*StateGetCommand) SetFlags 

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

SetFlags adds command specific flags to the flag set. SetFlags implements part of the cmd.Command interface.

type StateSetCommand 

type StateSetCommand struct {
	cmd.CommandBase

	StateValues map[string]string
	// contains filtered or unexported fields
}

StateSetCommand implements the state-set command.

func (*StateSetCommand) Info 

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

Info returns information about the Command. Info implements part of the cmd.Command interface.

func (*StateSetCommand) Init 

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

Init initializes the Command before running. Init implements part of the cmd.Command interface.

func (*StateSetCommand) Run 

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

Run will execute the Command as directed by the options and positional arguments passed to Init. Run implements part of the cmd.Command interface.

func (*StateSetCommand) SetFlags 

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

SetFlags adds command specific flags to the flag set. SetFlags implements part of the cmd.Command interface.

type StatusGetCommand 

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

StatusGetCommand implements the status-get command.

func (*StatusGetCommand) ApplicationStatus 

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

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) 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 application 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 StorageListCommand 

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

StorageListCommand implements the storage-list command.

StorageListCommand implements cmd.Command.

func (*StorageListCommand) Info 

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

func (*StorageListCommand) Init 

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

func (*StorageListCommand) Run 

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

func (*StorageListCommand) SetFlags 

func (c *StorageListCommand) 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.

type WorkloadHookContext 

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

WorkloadHookContext is the context for a workload hook.

Source Files

View all Source files

Directories

Path Synopsis
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.

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.