Documentation ¶
Index ¶
- Constants
- type AgentCheckCommand
- type AgentInfoCommand
- type AllocStatusCommand
- type ClientConfigCommand
- type EvalStatusCommand
- type ExecutorPluginCommand
- type FSCommand
- type FlagSetFlags
- type InitCommand
- type InspectCommand
- type Meta
- type NodeDrainCommand
- type NodeStatusCommand
- type PlanCommand
- type RunCommand
- type ServerForceLeaveCommand
- type ServerJoinCommand
- type ServerMembersCommand
- type StatusCommand
- type StopCommand
- type SyslogPluginCommand
- type ValidateCommand
- type VersionCommand
Constants ¶
const ( HealthCritical = 2 HealthWarn = 1 HealthPass = 0 HealthUnknown = 3 )
const ( // Names of environment variables used to supply various // config options to the Nomad CLI. EnvNomadAddress = "NOMAD_ADDR" EnvNomadRegion = "NOMAD_REGION" )
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 ¶ added in v0.4.0
type AgentCheckCommand struct {
Meta
}
func (*AgentCheckCommand) Help ¶ added in v0.4.0
func (c *AgentCheckCommand) Help() string
func (*AgentCheckCommand) Run ¶ added in v0.4.0
func (c *AgentCheckCommand) Run(args []string) int
func (*AgentCheckCommand) Synopsis ¶ added in v0.4.0
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 EvalStatusCommand ¶ added in v0.4.0
type EvalStatusCommand struct {
Meta
}
func (*EvalStatusCommand) Help ¶ added in v0.4.0
func (c *EvalStatusCommand) Help() string
func (*EvalStatusCommand) Run ¶ added in v0.4.0
func (c *EvalStatusCommand) Run(args []string) int
func (*EvalStatusCommand) Synopsis ¶ added in v0.4.0
func (c *EvalStatusCommand) Synopsis() string
type ExecutorPluginCommand ¶ added in v0.3.0
type ExecutorPluginCommand struct {
Meta
}
func (*ExecutorPluginCommand) Help ¶ added in v0.3.0
func (e *ExecutorPluginCommand) Help() string
func (*ExecutorPluginCommand) Run ¶ added in v0.3.0
func (e *ExecutorPluginCommand) Run(args []string) int
func (*ExecutorPluginCommand) Synopsis ¶ added in v0.3.0
func (e *ExecutorPluginCommand) 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 ¶ added in v0.3.2
type InspectCommand struct {
Meta
}
func (*InspectCommand) Help ¶ added in v0.3.2
func (c *InspectCommand) Help() string
func (*InspectCommand) Run ¶ added in v0.3.2
func (c *InspectCommand) Run(args []string) int
func (*InspectCommand) Synopsis ¶ added in v0.3.2
func (c *InspectCommand) Synopsis() string
type Meta ¶
Meta contains the meta-options and functionality that nearly every Nomad command inherits.
func (*Meta) Client ¶
Client is used to initialize and return a new API client using the default command line arguments and env vars.
func (*Meta) Colorize ¶ added in v0.4.0
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 ¶ added in v0.4.0
type PlanCommand struct { Meta // contains filtered or unexported fields }
func (*PlanCommand) Help ¶ added in v0.4.0
func (c *PlanCommand) Help() string
func (*PlanCommand) Run ¶ added in v0.4.0
func (c *PlanCommand) Run(args []string) int
func (*PlanCommand) Synopsis ¶ added in v0.4.0
func (c *PlanCommand) Synopsis() string
type RunCommand ¶
type RunCommand struct { Meta // contains filtered or unexported fields }
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 ¶ added in v0.3.0
type SyslogPluginCommand struct {
Meta
}
func (*SyslogPluginCommand) Help ¶ added in v0.3.0
func (e *SyslogPluginCommand) Help() string
func (*SyslogPluginCommand) Run ¶ added in v0.3.0
func (s *SyslogPluginCommand) Run(args []string) int
func (*SyslogPluginCommand) Synopsis ¶ added in v0.3.0
func (s *SyslogPluginCommand) Synopsis() string
type ValidateCommand ¶
type ValidateCommand struct {
Meta
}
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 ¶
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
Source Files ¶
- agent_info.go
- alloc_status.go
- check.go
- client_config.go
- eval_status.go
- executor_plugin.go
- fs.go
- helpers.go
- init.go
- inspect.go
- meta.go
- monitor.go
- node_drain.go
- node_status.go
- plan.go
- run.go
- server_force_leave.go
- server_join.go
- server_members.go
- status.go
- stop.go
- syslog_plugin.go
- validate.go
- version.go