command

type ApplyCommand ¶

type ApplyCommand struct {
	Meta

	// If true, then this apply command will become the "destroy"
	// command. It is just like apply but only processes a destroy.
	Destroy bool

	// When this channel is closed, the apply will be cancelled.
	ShutdownCh <-chan struct{}
}

ApplyCommand is a Command implementation that applies a Terraform configuration and actually builds or changes infrastructure.

func (c *ApplyCommand) Help() string

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

func (c *ApplyCommand) Synopsis() string

type ColorizeUi ¶

type ColorizeUi struct {
	Colorize    *colorstring.Colorize
	OutputColor string
	InfoColor   string
	ErrorColor  string
	Ui          cli.Ui
}

ColoredUi is a Ui implementation that colors its output according to the given color schemes for the given type of output.

func (u *ColorizeUi) Ask(query string) (string, error)

func (u *ColorizeUi) Error(message string)

func (u *ColorizeUi) Info(message string)

func (u *ColorizeUi) Output(message string)

type Config ¶

type Config struct {
	Hooks     []terraform.Hook
	Providers map[string]terraform.ResourceProviderFactory
	Ui        cli.Ui
}

Config is a structure used to configure many commands with Terraform configurations.

func (c *Config) ContextOpts() *terraform.ContextOpts

type CountHook ¶

type CountHook struct {
	Added   int
	Changed int
	Removed int

	sync.Mutex
	terraform.NilHook
	// contains filtered or unexported fields
}

CountHook is a hook that counts the number of resources added, removed, changed during the course of an apply.

func (h *CountHook) PostApply(
	n *terraform.InstanceInfo,
	s *terraform.InstanceState,
	e error) (terraform.HookAction, error)

func (h *CountHook) PreApply(
	n *terraform.InstanceInfo,
	s *terraform.InstanceState,
	d *terraform.InstanceDiff) (terraform.HookAction, error)

func (h *CountHook) Reset()

type FlagVar ¶

type FlagVar map[string]string

FlagVar is a flag.Value implementation for parsing user variables from the command-line in the format of '-var key=value'.

func (v *FlagVar) Set(raw string) error

func (v *FlagVar) String() string

type FlagVarFile ¶

type FlagVarFile map[string]string

FlagVarFile is a flag.Value implementation for parsing user variables from the command line in the form of files. i.e. '-var-file=foo'

func (v *FlagVarFile) Set(raw string) error

func (v *FlagVarFile) String() string

type FormatPlanOpts ¶ added in v0.3.0

type FormatPlanOpts struct {
	// Plan is the plan to format. This is required.
	Plan *terraform.Plan

	// Color is the colorizer. This is optional.
	Color *colorstring.Colorize

	// ModuleDepth is the depth of the modules to expand. By default this
	// is zero which will not expand modules at all.
	ModuleDepth int
}

FormatPlanOpts are the options for formatting a plan.

type FormatStateOpts ¶ added in v0.3.0

type FormatStateOpts struct {
	// State is the state to format. This is required.
	State *terraform.State

	// Color is the colorizer. This is optional.
	Color *colorstring.Colorize

	// ModuleDepth is the depth of the modules to expand. By default this
	// is zero which will not expand modules at all.
	ModuleDepth int
}

FormatStateOpts are the options for formatting a state.

type GetCommand ¶ added in v0.3.0

type GetCommand struct {
	Meta
}

GetCommand is a Command implementation that takes a Terraform configuration and downloads all the modules.

func (c *GetCommand) Help() string

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

func (c *GetCommand) Synopsis() string

type GraphCommand ¶

type GraphCommand struct {
	Meta
}

GraphCommand is a Command implementation that takes a Terraform configuration and outputs the dependency tree in graphical form.

func (c *GraphCommand) Help() string

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

func (c *GraphCommand) Synopsis() string

type InitCommand ¶ added in v0.3.0

type InitCommand struct {
	Meta
}

InitCommand is a Command implementation that takes a Terraform module and clones it to the working directory.

func (c *InitCommand) Help() string

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

func (c *InitCommand) Synopsis() string

type Meta ¶

type Meta struct {
	Color       bool
	ContextOpts *terraform.ContextOpts
	Ui          cli.Ui
	// contains filtered or unexported fields
}

Meta are the meta-options that are available on all or most commands.

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

func (m *Meta) Context(copts contextOpts) (*terraform.Context, bool, error)

func (m *Meta) InputMode() terraform.InputMode

func (m *Meta) UIInput() terraform.UIInput

type OutputCommand ¶

type OutputCommand struct {
	Meta
}

OutputCommand is a Command implementation that reads an output from a Terraform state and prints it.

func (c *OutputCommand) Help() string

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

func (c *OutputCommand) Synopsis() string

type PlanCommand ¶

type PlanCommand struct {
	Meta
}

PlanCommand is a Command implementation that compares a Terraform configuration to an actual infrastructure and shows the differences.

func (c *PlanCommand) Help() string

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

func (c *PlanCommand) Synopsis() string

type RefreshCommand ¶

type RefreshCommand struct {
	Meta
}

RefreshCommand is a cli.Command implementation that refreshes the state file.

func (c *RefreshCommand) Help() string

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

func (c *RefreshCommand) Synopsis() string

type ShowCommand ¶

type ShowCommand struct {
	Meta
}

ShowCommand is a Command implementation that reads and outputs the contents of a Terraform plan or state file.

func (c *ShowCommand) Help() string

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

func (c *ShowCommand) Synopsis() string

type UIInput ¶ added in v0.3.0

type UIInput struct {
	// Colorize will color the output.
	Colorize *colorstring.Colorize

	// Reader and Writer for IO. If these aren't set, they will default to
	// Stdout and Stderr respectively.
	Reader io.Reader
	Writer io.Writer
	// contains filtered or unexported fields
}

UIInput is an implementation of terraform.UIInput that asks the CLI for input stdin.

func (i *UIInput) Input(opts *terraform.InputOpts) (string, error)

type UiHook ¶

type UiHook struct {
	terraform.NilHook

	Colorize *colorstring.Colorize
	Ui       cli.Ui
	// contains filtered or unexported fields
}

func (h *UiHook) PostApply(
	n *terraform.InstanceInfo,
	s *terraform.InstanceState,
	applyerr error) (terraform.HookAction, error)

func (h *UiHook) PreApply(
	n *terraform.InstanceInfo,
	s *terraform.InstanceState,
	d *terraform.InstanceDiff) (terraform.HookAction, error)

func (h *UiHook) PreDiff(
	n *terraform.InstanceInfo,
	s *terraform.InstanceState) (terraform.HookAction, error)

func (h *UiHook) PreProvision(
	n *terraform.InstanceInfo,
	provId string) (terraform.HookAction, error)

func (h *UiHook) PreRefresh(
	n *terraform.InstanceInfo,
	s *terraform.InstanceState) (terraform.HookAction, error)

func (h *UiHook) ProvisionOutput(
	n *terraform.InstanceInfo,
	provId string,
	msg string)

type VersionCheckFunc ¶ added in v0.3.0

type VersionCheckFunc func() (VersionCheckInfo, error)

VersionCheckFunc is the callback called by the Version command to check if there is a new version of Terraform.

type VersionCheckInfo ¶ added in v0.3.0

type VersionCheckInfo struct {
	Outdated bool
	Latest   string
	Alerts   []string
}

VersionCheckInfo is the return value for the VersionCheckFunc callback and tells the Version command information about the latest version of Terraform.

type VersionCommand ¶

type VersionCommand struct {
	Meta

	Revision          string
	Version           string
	VersionPrerelease string
	CheckFunc         VersionCheckFunc
}

VersionCommand is a Command implementation prints the version.

func (c *VersionCommand) Help() string

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

func (c *VersionCommand) Synopsis() string