command

package
v0.5.0-rc1 Latest Latest
Warning

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

Go to latest
Published: Nov 2, 2016 License: MPL-2.0 Imports: 35 Imported by: 0

Documentation

Index

Constants

View Source
const (
	HealthCritical = 2
	HealthWarn     = 1
	HealthPass     = 0
	HealthUnknown  = 3
)
View Source
const (
	// Names of environment variables used to supply various
	// config options to the Nomad CLI.
	EnvNomadAddress = "NOMAD_ADDR"
	EnvNomadRegion  = "NOMAD_REGION"
)
View Source
const (
	// DefaultInitName is the default name we use when
	// initializing the example file
	DefaultInitName = "example.nomad"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AgentCheckCommand

type AgentCheckCommand struct {
	Meta
}

func (*AgentCheckCommand) Help

func (c *AgentCheckCommand) Help() string

func (*AgentCheckCommand) Run

func (c *AgentCheckCommand) Run(args []string) int

func (*AgentCheckCommand) Synopsis

func (c *AgentCheckCommand) Synopsis() string

type AgentInfoCommand

type AgentInfoCommand struct {
	Meta
}

func (*AgentInfoCommand) Help

func (c *AgentInfoCommand) Help() string

func (*AgentInfoCommand) Run

func (c *AgentInfoCommand) Run(args []string) int

func (*AgentInfoCommand) Synopsis

func (c *AgentInfoCommand) Synopsis() string

type AllocStatusCommand

type AllocStatusCommand struct {
	Meta
	// contains filtered or unexported fields
}

func (*AllocStatusCommand) Help

func (c *AllocStatusCommand) Help() string

func (*AllocStatusCommand) Run

func (c *AllocStatusCommand) Run(args []string) int

func (*AllocStatusCommand) Synopsis

func (c *AllocStatusCommand) Synopsis() string

type ClientConfigCommand

type ClientConfigCommand struct {
	Meta
}

func (*ClientConfigCommand) Help

func (c *ClientConfigCommand) Help() string

func (*ClientConfigCommand) Run

func (c *ClientConfigCommand) Run(args []string) int

func (*ClientConfigCommand) Synopsis

func (c *ClientConfigCommand) Synopsis() string

type DataFormatter

type DataFormatter interface {
	// TransformData should return transformed string data.
	TransformData(interface{}) (string, error)
}

DataFormatter is a transformer of the data.

func DataFormat

func DataFormat(format, tmpl string) (DataFormatter, error)

DataFormat returns the data formatter specified format.

type EvalStatusCommand

type EvalStatusCommand struct {
	Meta
}

func (*EvalStatusCommand) Help

func (c *EvalStatusCommand) Help() string

func (*EvalStatusCommand) Run

func (c *EvalStatusCommand) Run(args []string) int

func (*EvalStatusCommand) Synopsis

func (c *EvalStatusCommand) Synopsis() string

type ExecutorPluginCommand

type ExecutorPluginCommand struct {
	Meta
}

func (*ExecutorPluginCommand) Help

func (e *ExecutorPluginCommand) Help() string

func (*ExecutorPluginCommand) Run

func (e *ExecutorPluginCommand) Run(args []string) int

func (*ExecutorPluginCommand) Synopsis

func (e *ExecutorPluginCommand) Synopsis() string

type FSCommand

type FSCommand struct {
	Meta
}

func (*FSCommand) Help

func (f *FSCommand) Help() string

func (*FSCommand) Run

func (f *FSCommand) Run(args []string) int

func (*FSCommand) Synopsis

func (f *FSCommand) Synopsis() string

type FlagSetFlags

type FlagSetFlags uint

FlagSetFlags is an enum to define what flags are present in the default FlagSet returned by Meta.FlagSet.

const (
	FlagSetNone    FlagSetFlags = 0
	FlagSetClient  FlagSetFlags = 1 << iota
	FlagSetDefault              = FlagSetClient
)

type InitCommand

type InitCommand struct {
	Meta
}

InitCommand generates a new job template that you can customize to your liking, like vagrant init

func (*InitCommand) Help

func (c *InitCommand) Help() string

func (*InitCommand) Run

func (c *InitCommand) Run(args []string) int

func (*InitCommand) Synopsis

func (c *InitCommand) Synopsis() string

type InspectCommand

type InspectCommand struct {
	Meta
}

func (*InspectCommand) Help

func (c *InspectCommand) Help() string

func (*InspectCommand) Run

func (c *InspectCommand) Run(args []string) int

func (*InspectCommand) Synopsis

func (c *InspectCommand) Synopsis() string

type JSONFormat

type JSONFormat struct {
}

func (*JSONFormat) TransformData

func (p *JSONFormat) TransformData(data interface{}) (string, error)

TransformData returns JSON format string data.

type JobGetter

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

func (*JobGetter) StructJob

func (j *JobGetter) StructJob(jpath string) (*structs.Job, error)

StructJob returns the Job struct from jobfile.

type KeygenCommand

type KeygenCommand struct {
	Meta
}

KeygenCommand is a Command implementation that generates an encryption key for use in `nomad agent`.

func (*KeygenCommand) Help

func (c *KeygenCommand) Help() string

func (*KeygenCommand) Run

func (c *KeygenCommand) Run(_ []string) int

func (*KeygenCommand) Synopsis

func (c *KeygenCommand) Synopsis() string

type KeyringCommand

type KeyringCommand struct {
	Meta
}

KeyringCommand is a Command implementation that handles querying, installing, and removing gossip encryption keys from a keyring.

func (*KeyringCommand) Help

func (c *KeyringCommand) Help() string

func (*KeyringCommand) Run

func (c *KeyringCommand) Run(args []string) int

func (*KeyringCommand) Synopsis

func (c *KeyringCommand) Synopsis() string

type LineLimitReader

type LineLimitReader struct {
	io.ReadCloser
	// contains filtered or unexported fields
}

LineLimitReader wraps another reader and provides `tail -n` like behavior. LineLimitReader buffers up to the searchLimit and returns `-n` number of lines. After those lines have been returned, LineLimitReader streams the underlying ReadCloser

func NewLineLimitReader

func NewLineLimitReader(r io.ReadCloser, lines, searchLimit int, timeLimit time.Duration) *LineLimitReader

NewLineLimitReader takes the ReadCloser to wrap, the number of lines to find searching backwards in the first searchLimit bytes. timeLimit can optionally be specified by passing a non-zero duration. When set, the search for the last n lines is aborted if no data has been read in the duration. This can be used to flush what is had if no extra data is being received. When used, the underlying reader must not block forever and must periodically unblock even when no data has been read.

func (*LineLimitReader) Read

func (l *LineLimitReader) Read(p []byte) (n int, err error)

type LogsCommand

type LogsCommand struct {
	Meta
}

func (*LogsCommand) Help

func (l *LogsCommand) Help() string

func (*LogsCommand) Run

func (l *LogsCommand) Run(args []string) int

func (*LogsCommand) Synopsis

func (l *LogsCommand) Synopsis() string

type Meta

type Meta struct {
	Ui cli.Ui
	// contains filtered or unexported fields
}

Meta contains the meta-options and functionality that nearly every Nomad command inherits.

func (*Meta) Client

func (m *Meta) Client() (*api.Client, error)

Client is used to initialize and return a new API client using the default command line arguments and env vars.

func (*Meta) Colorize

func (m *Meta) Colorize() *colorstring.Colorize

func (*Meta) FlagSet

func (m *Meta) FlagSet(n string, fs FlagSetFlags) *flag.FlagSet

FlagSet returns a FlagSet with the common flags that every command implements. The exact behavior of FlagSet can be configured using the flags as the second parameter, for example to disable server settings on the commands that don't talk to a server.

type NodeDrainCommand

type NodeDrainCommand struct {
	Meta
}

func (*NodeDrainCommand) Help

func (c *NodeDrainCommand) Help() string

func (*NodeDrainCommand) Run

func (c *NodeDrainCommand) Run(args []string) int

func (*NodeDrainCommand) Synopsis

func (c *NodeDrainCommand) Synopsis() string

type NodeStatusCommand

type NodeStatusCommand struct {
	Meta
	// contains filtered or unexported fields
}

func (*NodeStatusCommand) Help

func (c *NodeStatusCommand) Help() string

func (*NodeStatusCommand) Run

func (c *NodeStatusCommand) Run(args []string) int

func (*NodeStatusCommand) Synopsis

func (c *NodeStatusCommand) Synopsis() string

type PlanCommand

type PlanCommand struct {
	Meta
	JobGetter
	// contains filtered or unexported fields
}

func (*PlanCommand) Help

func (c *PlanCommand) Help() string

func (*PlanCommand) Run

func (c *PlanCommand) Run(args []string) int

func (*PlanCommand) Synopsis

func (c *PlanCommand) Synopsis() string

type RunCommand

type RunCommand struct {
	Meta
	JobGetter
}

func (*RunCommand) Help

func (c *RunCommand) Help() string

func (*RunCommand) Run

func (c *RunCommand) Run(args []string) int

func (*RunCommand) Synopsis

func (c *RunCommand) Synopsis() string

type ServerForceLeaveCommand

type ServerForceLeaveCommand struct {
	Meta
}

func (*ServerForceLeaveCommand) Help

func (c *ServerForceLeaveCommand) Help() string

func (*ServerForceLeaveCommand) Run

func (c *ServerForceLeaveCommand) Run(args []string) int

func (*ServerForceLeaveCommand) Synopsis

func (c *ServerForceLeaveCommand) Synopsis() string

type ServerJoinCommand

type ServerJoinCommand struct {
	Meta
}

func (*ServerJoinCommand) Help

func (c *ServerJoinCommand) Help() string

func (*ServerJoinCommand) Run

func (c *ServerJoinCommand) Run(args []string) int

func (*ServerJoinCommand) Synopsis

func (c *ServerJoinCommand) Synopsis() string

type ServerMembersCommand

type ServerMembersCommand struct {
	Meta
}

func (*ServerMembersCommand) Help

func (c *ServerMembersCommand) Help() string

func (*ServerMembersCommand) Run

func (c *ServerMembersCommand) Run(args []string) int

func (*ServerMembersCommand) Synopsis

func (c *ServerMembersCommand) Synopsis() string

type StatusCommand

type StatusCommand struct {
	Meta
	// contains filtered or unexported fields
}

func (*StatusCommand) Help

func (c *StatusCommand) Help() string

func (*StatusCommand) Run

func (c *StatusCommand) Run(args []string) int

func (*StatusCommand) Synopsis

func (c *StatusCommand) Synopsis() string

type StopCommand

type StopCommand struct {
	Meta
}

func (*StopCommand) Help

func (c *StopCommand) Help() string

func (*StopCommand) Run

func (c *StopCommand) Run(args []string) int

func (*StopCommand) Synopsis

func (c *StopCommand) Synopsis() string

type SyslogPluginCommand

type SyslogPluginCommand struct {
	Meta
}

func (*SyslogPluginCommand) Help

func (e *SyslogPluginCommand) Help() string

func (*SyslogPluginCommand) Run

func (s *SyslogPluginCommand) Run(args []string) int

func (*SyslogPluginCommand) Synopsis

func (s *SyslogPluginCommand) Synopsis() string

type TemplateFormat

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

func (*TemplateFormat) TransformData

func (p *TemplateFormat) TransformData(data interface{}) (string, error)

TransformData returns template format string data.

type ValidateCommand

type ValidateCommand struct {
	Meta
	JobGetter
}

func (*ValidateCommand) Help

func (c *ValidateCommand) Help() string

func (*ValidateCommand) Run

func (c *ValidateCommand) Run(args []string) int

func (*ValidateCommand) Synopsis

func (c *ValidateCommand) Synopsis() string

type VersionCommand

type VersionCommand struct {
	Revision          string
	Version           string
	VersionPrerelease string
	Ui                cli.Ui
}

VersionCommand is a Command implementation prints the version.

func (*VersionCommand) Help

func (c *VersionCommand) Help() string

func (*VersionCommand) Run

func (c *VersionCommand) Run(_ []string) int

func (*VersionCommand) Synopsis

func (c *VersionCommand) Synopsis() string

Directories

Path Synopsis
consul
Package consul is used by Nomad to register all services both static services and dynamic via allocations.
Package consul is used by Nomad to register all services both static services and dynamic via allocations.

Jump to

Keyboard shortcuts

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