command

Documentation

Index

• type DeployCommand
  • func (c *DeployCommand) Help() string
  • func (c *DeployCommand) Run(args []string) int
  • func (c *DeployCommand) Synopsis() string
• type DispatchCommand
  • func (c *DispatchCommand) Help() string
  • func (c *DispatchCommand) Run(args []string) int
  • func (c *DispatchCommand) Synopsis() string
• type FlagSetFlags
• type Meta
  • func (m *Meta) FlagSet(n string, fs FlagSetFlags) *flag.FlagSet
• type PlanCommand
  • func (c *PlanCommand) Help() string
  • func (c *PlanCommand) Run(args []string) int
  • func (c *PlanCommand) Synopsis() string
• type RenderCommand
  • func (c *RenderCommand) Help() string
  • func (c *RenderCommand) Run(args []string) int
  • func (c *RenderCommand) Synopsis() string
• type ScaleInCommand
  • func (c *ScaleInCommand) Help() string
  • func (c *ScaleInCommand) Run(args []string) int
  • func (c *ScaleInCommand) Synopsis() string
• type ScaleOutCommand
  • func (c *ScaleOutCommand) Help() string
  • func (c *ScaleOutCommand) Run(args []string) int
  • func (c *ScaleOutCommand) Synopsis() string
• type VersionCommand
  • func (c *VersionCommand) Help() string
  • func (c *VersionCommand) Run(_ []string) int
  • func (c *VersionCommand) Synopsis() string

Types

type DeployCommand

type DeployCommand struct {
	Meta
}

DeployCommand is the command implementation that allows users to deploy a Nomad job based on passed templates and variables.

func (*DeployCommand) Help

func (c *DeployCommand) Help() string

Help provides the help information for the deploy command.

func (*DeployCommand) Run

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

Run triggers a run of the Levant template and deploy functions.

func (*DeployCommand) Synopsis

func (c *DeployCommand) Synopsis() string

Synopsis is provides a brief summary of the deploy command.

type DispatchCommand

type DispatchCommand struct {
	Meta
}

DispatchCommand is the command implementation that allows users to dispatch a Nomad job.

func (*DispatchCommand) Help

func (c *DispatchCommand) Help() string

Help provides the help information for the dispatch command.

func (*DispatchCommand) Run

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

Run triggers a run of the Levant dispatch functions.

func (*DispatchCommand) Synopsis

func (c *DispatchCommand) Synopsis() string

Synopsis is provides a brief summary of the dispatch command.

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
	FlagSetBuildFilter FlagSetFlags = 1 << iota
	FlagSetVars
)

Consts which helps us track meta CLI falgs.

type Meta

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

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

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.

type PlanCommand

type PlanCommand struct {
	Meta
}

PlanCommand is the command implementation that allows users to plan a Nomad job based on passed templates and variables.

func (*PlanCommand) Help

func (c *PlanCommand) Help() string

Help provides the help information for the plan command.

func (*PlanCommand) Run

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

Run triggers a run of the Levant template and plan functions.

func (*PlanCommand) Synopsis

func (c *PlanCommand) Synopsis() string

Synopsis is provides a brief summary of the plan command.

type RenderCommand

type RenderCommand struct {
	Meta
}

RenderCommand is the command implementation that allows users to render a Nomad job template based on passed templates and variables.

func (*RenderCommand) Help

func (c *RenderCommand) Help() string

Help provides the help information for the template command.

func (*RenderCommand) Run

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

Run triggers a run of the Levant template functions.

func (*RenderCommand) Synopsis

func (c *RenderCommand) Synopsis() string

Synopsis is provides a brief summary of the template command.

type ScaleInCommand

type ScaleInCommand struct {
	Meta
}

ScaleInCommand is the command implementation that allows users to scale a Nomad job out.

func (*ScaleInCommand) Help

func (c *ScaleInCommand) Help() string

Help provides the help information for the scale-in command.

func (*ScaleInCommand) Run

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

Run triggers a run of the Levant scale-in functions.

func (*ScaleInCommand) Synopsis

func (c *ScaleInCommand) Synopsis() string

Synopsis is provides a brief summary of the scale-in command.

type ScaleOutCommand

type ScaleOutCommand struct {
	Meta
}

ScaleOutCommand is the command implementation that allows users to scale a Nomad job out.

func (*ScaleOutCommand) Help

func (c *ScaleOutCommand) Help() string

Help provides the help information for the scale-out command.

func (*ScaleOutCommand) Run

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

Run triggers a run of the Levant scale-out functions.

func (*ScaleOutCommand) Synopsis

func (c *ScaleOutCommand) Synopsis() string

Synopsis is provides a brief summary of the scale-out command.

type VersionCommand

type VersionCommand struct {
	Version string
	UI      cli.Ui
}

VersionCommand is a Command implementation that prints the version.

func (*VersionCommand) Help

func (c *VersionCommand) Help() string

Help provides the help information for the version command.

func (*VersionCommand) Run

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

Run executes the version command.

func (*VersionCommand) Synopsis

func (c *VersionCommand) Synopsis() string

Synopsis is provides a brief summary of the version command.