terraform

package
v0.6.15 Latest Latest
Warning

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

 Go to latest Published: Apr 22, 2016 License: MPL-2.0 Imports: 26 Imported by: 0

Documentation

Index

Constants

View Source 
const RootModuleName = "root"

RootModuleName is the name given to the root module implicitly.

View Source 
const (
	// StateVersion is the current version for our state file
	StateVersion = 1
)
View Source 
const (
	// VarEnvPrefix is the prefix of variables that are read from
	// the environment to set variables here.
	VarEnvPrefix = "TF_VAR_"
)
View Source 
const Version = "0.6.15"

The main version number that is being run at the moment.

View Source 
const VersionPrerelease = ""

A pre-release marker for the version. If this is "" (empty string) then it means that it is a final release. Otherwise, this is a pre-release such as "dev" (in development), "beta", "rc1", etc.

Variables

View Source 
var RootModulePath = []string{RootModuleName}

RootModulePath is the path for the root module.

Functions

func Eval added in v0.4.0 

func Eval(n EvalNode, ctx EvalContext) (interface{}, error)

Eval evaluates the given EvalNode with the given context, properly evaluating all args in the correct order.

func EvalRaw added in v0.4.0 

func EvalRaw(n EvalNode, ctx EvalContext) (interface{}, error)

EvalRaw is like Eval except that it returns all errors, even if they signal something normal such as EvalEarlyExitError.

func GraphDot 

func GraphDot(g *Graph, opts *GraphDotOpts) (string, error)

GraphDot returns the dot formatting of a visual representation of the given Terraform graph.

func ParseResourceIndex added in v0.5.0 

func ParseResourceIndex(s string) (int, error)

func ParseResourcePath added in v0.5.0 

func ParseResourcePath(s string) []string

func PathCacheKey added in v0.4.0 

func PathCacheKey(path []string) string

PathCacheKey returns a cache key for a module path.

TODO: test

func ProviderSatisfies 

func ProviderSatisfies(p ResourceProvider, n string) bool

func WritePlan 

func WritePlan(d *Plan, dst io.Writer) error

WritePlan writes a plan somewhere in a binary format.

func WriteState 

func WriteState(d *State, dst io.Writer) error

WriteState writes a state somewhere in a binary format.

Types

type AddOutputOrphanTransformer added in v0.5.0 

type AddOutputOrphanTransformer struct {
	State *State
}

AddOutputOrphanTransformer is a transformer that adds output orphans to the graph. Output orphans are outputs that are no longer in the configuration and therefore need to be removed from the state.

func (*AddOutputOrphanTransformer) Transform added in v0.5.0 

func (t *AddOutputOrphanTransformer) Transform(g *Graph) error

type BasicGraphBuilder added in v0.4.0 

type BasicGraphBuilder struct {
	Steps    []GraphTransformer
	Validate bool
}

BasicGraphBuilder is a GraphBuilder that builds a graph out of a series of transforms and (optionally) validates the graph is a valid structure.

func (*BasicGraphBuilder) Build added in v0.4.0 

func (b *BasicGraphBuilder) Build(path []string) (*Graph, error)

type BuiltinEvalContext added in v0.4.0 

type BuiltinEvalContext struct {
	// PathValue is the Path that this context is operating within.
	PathValue []string

	// Interpolater setting below affect the interpolation of variables.
	//
	// The InterpolaterVars are the exact value for ${var.foo} values.
	// The map is shared between all contexts and is a mapping of
	// PATH to KEY to VALUE. Because it is shared by all contexts as well
	// as the Interpolater itself, it is protected by InterpolaterVarLock
	// which must be locked during any access to the map.
	Interpolater        *Interpolater
	InterpolaterVars    map[string]map[string]string
	InterpolaterVarLock *sync.Mutex

	Hooks               []Hook
	InputValue          UIInput
	Providers           map[string]ResourceProviderFactory
	ProviderCache       map[string]ResourceProvider
	ProviderConfigCache map[string]*ResourceConfig
	ProviderInputConfig map[string]map[string]interface{}
	ProviderLock        *sync.Mutex
	Provisioners        map[string]ResourceProvisionerFactory
	ProvisionerCache    map[string]ResourceProvisioner
	ProvisionerLock     *sync.Mutex
	DiffValue           *Diff
	DiffLock            *sync.RWMutex
	StateValue          *State
	StateLock           *sync.RWMutex
	// contains filtered or unexported fields
}

BuiltinEvalContext is an EvalContext implementation that is used by Terraform by default.

func (*BuiltinEvalContext) CloseProvider added in v0.6.0 

func (ctx *BuiltinEvalContext) CloseProvider(n string) error

func (*BuiltinEvalContext) CloseProvisioner added in v0.6.0 

func (ctx *BuiltinEvalContext) CloseProvisioner(n string) error

func (*BuiltinEvalContext) ConfigureProvider added in v0.4.0 

func (ctx *BuiltinEvalContext) ConfigureProvider(
	n string, cfg *ResourceConfig) error

func (*BuiltinEvalContext) Diff added in v0.4.0 

func (ctx *BuiltinEvalContext) Diff() (*Diff, *sync.RWMutex)

func (*BuiltinEvalContext) Hook added in v0.4.0 

func (ctx *BuiltinEvalContext) Hook(fn func(Hook) (HookAction, error)) error

func (*BuiltinEvalContext) InitProvider added in v0.4.0 

func (ctx *BuiltinEvalContext) InitProvider(n string) (ResourceProvider, error)

func (*BuiltinEvalContext) InitProvisioner added in v0.4.0 

func (ctx *BuiltinEvalContext) InitProvisioner(
	n string) (ResourceProvisioner, error)

func (*BuiltinEvalContext) Input added in v0.4.0 

func (ctx *BuiltinEvalContext) Input() UIInput

func (*BuiltinEvalContext) Interpolate added in v0.4.0 

func (ctx *BuiltinEvalContext) Interpolate(
	cfg *config.RawConfig, r *Resource) (*ResourceConfig, error)

func (*BuiltinEvalContext) ParentProviderConfig added in v0.4.0 

func (ctx *BuiltinEvalContext) ParentProviderConfig(n string) *ResourceConfig

func (*BuiltinEvalContext) Path added in v0.4.0 

func (ctx *BuiltinEvalContext) Path() []string

func (*BuiltinEvalContext) Provider added in v0.4.0 

func (ctx *BuiltinEvalContext) Provider(n string) ResourceProvider

func (*BuiltinEvalContext) ProviderInput added in v0.4.0 

func (ctx *BuiltinEvalContext) ProviderInput(n string) map[string]interface{}

func (*BuiltinEvalContext) Provisioner added in v0.4.0 

func (ctx *BuiltinEvalContext) Provisioner(n string) ResourceProvisioner

func (*BuiltinEvalContext) SetProviderConfig added in v0.4.1 

func (ctx *BuiltinEvalContext) SetProviderConfig(
	n string, cfg *ResourceConfig) error

func (*BuiltinEvalContext) SetProviderInput added in v0.4.0 

func (ctx *BuiltinEvalContext) SetProviderInput(n string, c map[string]interface{})

func (*BuiltinEvalContext) SetVariables added in v0.4.0 

func (ctx *BuiltinEvalContext) SetVariables(n string, vs map[string]string)

func (*BuiltinEvalContext) State added in v0.4.0 

func (ctx *BuiltinEvalContext) State() (*State, *sync.RWMutex)

type BuiltinGraphBuilder added in v0.4.0 

type BuiltinGraphBuilder struct {
	// Root is the root module of the graph to build.
	Root *module.Tree

	// Diff is the diff. The proper module diffs will be looked up.
	Diff *Diff

	// State is the global state. The proper module states will be looked
	// up by graph path.
	State *State

	// Providers is the list of providers supported.
	Providers []string

	// Provisioners is the list of provisioners supported.
	Provisioners []string

	// Targets is the user-specified list of resources to target.
	Targets []string

	// Destroy is set to true when we're in a `terraform destroy` or a
	// `terraform plan -destroy`
	Destroy bool

	// Determines whether the GraphBuilder should perform graph validation before
	// returning the Graph. Generally you want this to be done, except when you'd
	// like to inspect a problematic graph.
	Validate bool

	// Verbose is set to true when the graph should be built "worst case",
	// skipping any prune steps. This is used for early cycle detection during
	// Validate and for manual inspection via `terraform graph -verbose`.
	Verbose bool
}

BuiltinGraphBuilder is responsible for building the complete graph that Terraform uses for execution. It is an opinionated builder that defines the step order required to build a complete graph as is used and expected by Terraform.

If you require a custom graph, you'll have to build it up manually on your own by building a new GraphBuilder implementation.

func (*BuiltinGraphBuilder) Build added in v0.4.0 

func (b *BuiltinGraphBuilder) Build(path []string) (*Graph, error)

Build builds the graph according to the steps returned by Steps.

func (*BuiltinGraphBuilder) Steps added in v0.4.0 

func (b *BuiltinGraphBuilder) Steps(path []string) []GraphTransformer

Steps returns the ordered list of GraphTransformers that must be executed to build a complete graph.

type CallbackUIOutput added in v0.3.0 

type CallbackUIOutput struct {
	OutputFn func(string)
}

func (*CallbackUIOutput) Output added in v0.4.0 

func (o *CallbackUIOutput) Output(v string)

type CloseProviderTransformer added in v0.6.0 

type CloseProviderTransformer struct{}

CloseProviderTransformer is a GraphTransformer that adds nodes to the graph that will close open provider connections that aren't needed anymore. A provider connection is not needed anymore once all depended resources in the graph are evaluated.

func (*CloseProviderTransformer) Transform added in v0.6.0 

func (t *CloseProviderTransformer) Transform(g *Graph) error

type CloseProvisionerTransformer added in v0.6.0 

type CloseProvisionerTransformer struct{}

CloseProvisionerTransformer is a GraphTransformer that adds nodes to the graph that will close open provisioner connections that aren't needed anymore. A provisioner connection is not needed anymore once all depended resources in the graph are evaluated.

func (*CloseProvisionerTransformer) Transform added in v0.6.0 

func (t *CloseProvisionerTransformer) Transform(g *Graph) error

type ConfigTransformer added in v0.4.0 

type ConfigTransformer struct {
	Module *module.Tree
}

ConfigTransformer is a GraphTransformer that adds the configuration to the graph. The module used to configure this transformer must be the root module. We'll look up the child module by the Path in the Graph.

func (*ConfigTransformer) Transform added in v0.4.0 

func (t *ConfigTransformer) Transform(g *Graph) error

type Context 

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

Context represents all the context that Terraform needs in order to perform operations on infrastructure. This structure is built using NewContext. See the documentation for that.

func NewContext 

func NewContext(opts *ContextOpts) *Context

NewContext creates a new Context structure.

Once a Context is creator, the pointer values within ContextOpts should not be mutated in any way, since the pointers are copied, not the values themselves.

func (*Context) Apply 

func (c *Context) Apply() (*State, error)

Apply applies the changes represented by this context and returns the resulting state.

In addition to returning the resulting state, this context is updated with the latest state.

func (*Context) Graph 

func (c *Context) Graph(g *ContextGraphOpts) (*Graph, error)

Graph returns the graph for this config.

func (*Context) Input added in v0.3.0 

func (c *Context) Input(mode InputMode) error

Input asks for input to fill variables and provider configurations. This modifies the configuration in-place, so asking for Input twice may result in different UI output showing different current values.

func (*Context) Module added in v0.4.0 

func (c *Context) Module() *module.Tree

Module returns the module tree associated with this context.

func (*Context) Plan 

func (c *Context) Plan() (*Plan, error)

Plan generates an execution plan for the given context.

The execution plan encapsulates the context and can be stored in order to reinstantiate a context later for Apply.

Plan also updates the diff of this context to be the diff generated by the plan, so Apply can be called after.

func (*Context) Refresh 

func (c *Context) Refresh() (*State, error)

Refresh goes through all the resources in the state and refreshes them to their latest state. This will update the state that this context works with, along with returning it.

Even in the case an error is returned, the state will be returned and will potentially be partially updated.

func (*Context) SetVariable added in v0.4.0 

func (c *Context) SetVariable(k, v string)

SetVariable sets a variable after a context has already been built.

func (*Context) Stop 

func (c *Context) Stop()

Stop stops the running task.

Stop will block until the task completes.

func (*Context) Validate 

func (c *Context) Validate() ([]string, []error)

Validate validates the configuration and returns any warnings or errors.

func (*Context) Variables added in v0.4.0 

func (c *Context) Variables() map[string]string

Variables will return the mapping of variables that were defined for this Context. If Input was called, this mapping may be different than what was given.

type ContextGraphOpts added in v0.5.0 

type ContextGraphOpts struct {
	Validate bool
	Verbose  bool
}

type ContextGraphWalker added in v0.4.0 

type ContextGraphWalker struct {
	NullGraphWalker

	// Configurable values
	Context   *Context
	Operation walkOperation

	// Outputs, do not set these. Do not read these while the graph
	// is being walked.
	ValidationWarnings []string
	ValidationErrors   []error
	// contains filtered or unexported fields
}

ContextGraphWalker is the GraphWalker implementation used with the Context struct to walk and evaluate the graph.

func (*ContextGraphWalker) EnterEvalTree added in v0.4.0 

func (w *ContextGraphWalker) EnterEvalTree(v dag.Vertex, n EvalNode) EvalNode

func (*ContextGraphWalker) EnterPath added in v0.5.0 

func (w *ContextGraphWalker) EnterPath(path []string) EvalContext

func (*ContextGraphWalker) ExitEvalTree added in v0.4.0 

func (w *ContextGraphWalker) ExitEvalTree(
	v dag.Vertex, output interface{}, err error) error

type ContextOpts 

type ContextOpts struct {
	Destroy      bool
	Diff         *Diff
	Hooks        []Hook
	Module       *module.Tree
	Parallelism  int
	State        *State
	Providers    map[string]ResourceProviderFactory
	Provisioners map[string]ResourceProvisionerFactory
	Targets      []string
	Variables    map[string]string

	UIInput UIInput
}

ContextOpts are the user-configurable options to create a context with NewContext.

type CreateBeforeDestroyTransformer added in v0.4.0 

type CreateBeforeDestroyTransformer struct{}

CreateBeforeDestroyTransformer is a GraphTransformer that modifies the destroys of some nodes so that the creation happens before the destroy.

func (*CreateBeforeDestroyTransformer) Transform added in v0.4.0 

func (t *CreateBeforeDestroyTransformer) Transform(g *Graph) error

type DeposedTransformer added in v0.4.0 

type DeposedTransformer struct {
	// State is the global state. We'll automatically find the correct
	// ModuleState based on the Graph.Path that is being transformed.
	State *State

	// View, if non-empty, is the ModuleState.View used around the state
	// to find deposed resources.
	View string
}

DeposedTransformer is a GraphTransformer that adds deposed resources to the graph.

func (*DeposedTransformer) Transform added in v0.4.0 

func (t *DeposedTransformer) Transform(g *Graph) error

type DestroyTransformer added in v0.4.0 

type DestroyTransformer struct {
	FullDestroy bool
}

DestroyTransformer is a GraphTransformer that creates the destruction nodes for things that _might_ be destroyed.

func (*DestroyTransformer) Transform added in v0.4.0 

func (t *DestroyTransformer) Transform(g *Graph) error

type Diff 

type Diff struct {
	// Modules contains all the modules that have a diff
	Modules []*ModuleDiff
}

Diff trackes the changes that are necessary to apply a configuration to an existing infrastructure.

func (*Diff) AddModule added in v0.3.0 

func (d *Diff) AddModule(path []string) *ModuleDiff

AddModule adds the module with the given path to the diff.

This should be the preferred method to add module diffs since it allows us to optimize lookups later as well as control sorting.

func (*Diff) Empty 

func (d *Diff) Empty() bool

Empty returns true if the diff has no changes.

func (*Diff) ModuleByPath added in v0.3.0 

func (d *Diff) ModuleByPath(path []string) *ModuleDiff

ModuleByPath is used to lookup the module diff for the given path. This should be the preferred lookup mechanism as it allows for future lookup optimizations.

func (*Diff) RootModule added in v0.3.0 

func (d *Diff) RootModule() *ModuleDiff

RootModule returns the ModuleState for the root module

func (*Diff) String 

func (d *Diff) String() string

type DiffAttrType 

type DiffAttrType byte

DiffAttrType is an enum type that says whether a resource attribute diff is an input attribute (comes from the configuration) or an output attribute (comes as a result of applying the configuration). An example input would be "ami" for AWS and an example output would be "private_ip". 

const (
	DiffAttrUnknown DiffAttrType = iota
	DiffAttrInput
	DiffAttrOutput
)

type DiffChangeType added in v0.3.0 

type DiffChangeType byte

DiffChangeType is an enum with the kind of changes a diff has planned. 

const (
	DiffInvalid DiffChangeType = iota
	DiffNone
	DiffCreate
	DiffUpdate
	DiffDestroy
	DiffDestroyCreate
)

type DisableProviderTransformer added in v0.4.1 

type DisableProviderTransformer struct{}

DisableProviderTransformer "disables" any providers that are only depended on by modules.

func (*DisableProviderTransformer) Transform added in v0.4.1 

func (t *DisableProviderTransformer) Transform(g *Graph) error

type EphemeralState added in v0.3.0 

type EphemeralState struct {
	// ConnInfo is used for the providers to export information which is
	// used to connect to the resource for provisioning. For example,
	// this could contain SSH or WinRM credentials.
	ConnInfo map[string]string `json:"-"`
}

EphemeralState is used for transient state that is only kept in-memory

type EvalApply added in v0.4.0 

type EvalApply struct {
	Info      *InstanceInfo
	State     **InstanceState
	Diff      **InstanceDiff
	Provider  *ResourceProvider
	Output    **InstanceState
	CreateNew *bool
	Error     *error
}

EvalApply is an EvalNode implementation that writes the diff to the full diff.

func (*EvalApply) Eval added in v0.4.0 

func (n *EvalApply) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalApplyPost added in v0.4.0 

type EvalApplyPost struct {
	Info  *InstanceInfo
	State **InstanceState
	Error *error
}

EvalApplyPost is an EvalNode implementation that does the post-Apply work

func (*EvalApplyPost) Eval added in v0.4.0 

func (n *EvalApplyPost) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalApplyProvisioners added in v0.4.0 

type EvalApplyProvisioners struct {
	Info           *InstanceInfo
	State          **InstanceState
	Resource       *config.Resource
	InterpResource *Resource
	CreateNew      *bool
	Tainted        *bool
	Error          *error
}

EvalApplyProvisioners is an EvalNode implementation that executes the provisioners for a resource.

TODO(mitchellh): This should probably be split up into a more fine-grained ApplyProvisioner (single) that is looped over.

func (*EvalApplyProvisioners) Eval added in v0.4.0 

func (n *EvalApplyProvisioners) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalBuildProviderConfig added in v0.4.0 

type EvalBuildProviderConfig struct {
	Provider string
	Config   **ResourceConfig
	Output   **ResourceConfig
}

EvalBuildProviderConfig outputs a *ResourceConfig that is properly merged with parents and inputs on top of what is configured in the file.

func (*EvalBuildProviderConfig) Eval added in v0.4.0 

func (n *EvalBuildProviderConfig) Eval(ctx EvalContext) (interface{}, error)

type EvalCheckPreventDestroy added in v0.5.0 

type EvalCheckPreventDestroy struct {
	Resource *config.Resource
	Diff     **InstanceDiff
}

EvalPreventDestroy is an EvalNode implementation that returns an error if a resource has PreventDestroy configured and the diff would destroy the resource.

func (*EvalCheckPreventDestroy) Eval added in v0.5.0 

func (n *EvalCheckPreventDestroy) Eval(ctx EvalContext) (interface{}, error)

type EvalClearPrimaryState added in v0.4.0 

type EvalClearPrimaryState struct {
	Name string
}

EvalClearPrimaryState is an EvalNode implementation that clears the primary instance from a resource state.

func (*EvalClearPrimaryState) Eval added in v0.4.0 

func (n *EvalClearPrimaryState) Eval(ctx EvalContext) (interface{}, error)

type EvalCloseProvider added in v0.6.0 

type EvalCloseProvider struct {
	Name string
}

EvalCloseProvider is an EvalNode implementation that closes provider connections that aren't needed anymore.

func (*EvalCloseProvider) Eval added in v0.6.0 

func (n *EvalCloseProvider) Eval(ctx EvalContext) (interface{}, error)

type EvalCloseProvisioner added in v0.6.0 

type EvalCloseProvisioner struct {
	Name string
}

EvalCloseProvisioner is an EvalNode implementation that closes provisioner connections that aren't needed anymore.

func (*EvalCloseProvisioner) Eval added in v0.6.0 

func (n *EvalCloseProvisioner) Eval(ctx EvalContext) (interface{}, error)

type EvalCompareDiff added in v0.4.0 

type EvalCompareDiff struct {
	Info     *InstanceInfo
	One, Two **InstanceDiff
}

EvalCompareDiff is an EvalNode implementation that compares two diffs and errors if the diffs are not equal.

func (*EvalCompareDiff) Eval added in v0.4.0 

func (n *EvalCompareDiff) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalConfigProvider added in v0.4.0 

type EvalConfigProvider struct {
	Provider string
	Config   **ResourceConfig
}

EvalConfigProvider is an EvalNode implementation that configures a provider that is already initialized and retrieved.

func (*EvalConfigProvider) Eval added in v0.4.0 

func (n *EvalConfigProvider) Eval(ctx EvalContext) (interface{}, error)

type EvalContext added in v0.4.0 

type EvalContext interface {
	// Path is the current module path.
	Path() []string

	// Hook is used to call hook methods. The callback is called for each
	// hook and should return the hook action to take and the error.
	Hook(func(Hook) (HookAction, error)) error

	// Input is the UIInput object for interacting with the UI.
	Input() UIInput

	// InitProvider initializes the provider with the given name and
	// returns the implementation of the resource provider or an error.
	//
	// It is an error to initialize the same provider more than once.
	InitProvider(string) (ResourceProvider, error)

	// Provider gets the provider instance with the given name (already
	// initialized) or returns nil if the provider isn't initialized.
	Provider(string) ResourceProvider

	// CloseProvider closes provider connections that aren't needed anymore.
	CloseProvider(string) error

	// ConfigureProvider configures the provider with the given
	// configuration. This is a separate context call because this call
	// is used to store the provider configuration for inheritance lookups
	// with ParentProviderConfig().
	ConfigureProvider(string, *ResourceConfig) error
	SetProviderConfig(string, *ResourceConfig) error
	ParentProviderConfig(string) *ResourceConfig

	// ProviderInput and SetProviderInput are used to configure providers
	// from user input.
	ProviderInput(string) map[string]interface{}
	SetProviderInput(string, map[string]interface{})

	// InitProvisioner initializes the provisioner with the given name and
	// returns the implementation of the resource provisioner or an error.
	//
	// It is an error to initialize the same provisioner more than once.
	InitProvisioner(string) (ResourceProvisioner, error)

	// Provisioner gets the provisioner instance with the given name (already
	// initialized) or returns nil if the provisioner isn't initialized.
	Provisioner(string) ResourceProvisioner

	// CloseProvisioner closes provisioner connections that aren't needed
	// anymore.
	CloseProvisioner(string) error

	// Interpolate takes the given raw configuration and completes
	// the interpolations, returning the processed ResourceConfig.
	//
	// The resource argument is optional. If given, it is the resource
	// that is currently being acted upon.
	Interpolate(*config.RawConfig, *Resource) (*ResourceConfig, error)

	// SetVariables sets the variables for the module within
	// this context with the name n. This function call is additive:
	// the second parameter is merged with any previous call.
	SetVariables(string, map[string]string)

	// Diff returns the global diff as well as the lock that should
	// be used to modify that diff.
	Diff() (*Diff, *sync.RWMutex)

	// State returns the global state as well as the lock that should
	// be used to modify that state.
	State() (*State, *sync.RWMutex)
}

EvalContext is the interface that is given to eval nodes to execute.

type EvalCountFixZeroOneBoundary added in v0.4.0 

type EvalCountFixZeroOneBoundary struct {
	Resource *config.Resource
}

EvalCountFixZeroOneBoundary is an EvalNode that fixes up the state when there is a resource count with zero/one boundary, i.e. fixing a resource named "aws_instance.foo" to "aws_instance.foo.0" and vice-versa.

func (*EvalCountFixZeroOneBoundary) Eval added in v0.4.0 

func (n *EvalCountFixZeroOneBoundary) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalDeleteOutput added in v0.5.0 

type EvalDeleteOutput struct {
	Name string
}

EvalDeleteOutput is an EvalNode implementation that deletes an output from the state.

func (*EvalDeleteOutput) Eval added in v0.5.0 

func (n *EvalDeleteOutput) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalDeposeState added in v0.4.0 

type EvalDeposeState struct {
	Name string
}

EvalDeposeState is an EvalNode implementation that takes the primary out of a state and makes it Deposed. This is done at the beginning of create-before-destroy calls so that the create can create while preserving the old state of the to-be-destroyed resource.

func (*EvalDeposeState) Eval added in v0.4.0 

func (n *EvalDeposeState) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalDiff added in v0.4.0 

type EvalDiff struct {
	Info        *InstanceInfo
	Config      **ResourceConfig
	Provider    *ResourceProvider
	State       **InstanceState
	Output      **InstanceDiff
	OutputState **InstanceState
}

EvalDiff is an EvalNode implementation that does a refresh for a resource.

func (*EvalDiff) Eval added in v0.4.0 

func (n *EvalDiff) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalDiffDestroy added in v0.4.0 

type EvalDiffDestroy struct {
	Info   *InstanceInfo
	State  **InstanceState
	Output **InstanceDiff
}

EvalDiffDestroy is an EvalNode implementation that returns a plain destroy diff.

func (*EvalDiffDestroy) Eval added in v0.4.0 

func (n *EvalDiffDestroy) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalDiffDestroyModule added in v0.4.0 

type EvalDiffDestroyModule struct {
	Path []string
}

EvalDiffDestroyModule is an EvalNode implementation that writes the diff to the full diff.

func (*EvalDiffDestroyModule) Eval added in v0.4.0 

func (n *EvalDiffDestroyModule) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalDiffTainted added in v0.4.0 

type EvalDiffTainted struct {
	Name string
	Diff **InstanceDiff
}

EvalDiffTainted is an EvalNode implementation that writes the diff to the full diff.

func (*EvalDiffTainted) Eval added in v0.4.0 

func (n *EvalDiffTainted) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalEarlyExitError added in v0.4.0 

type EvalEarlyExitError struct{}

EvalEarlyExitError is a special error return value that can be returned by eval nodes that does an early exit.

func (EvalEarlyExitError) Error added in v0.4.0 

func (EvalEarlyExitError) Error() string

type EvalFilterDiff added in v0.4.0 

type EvalFilterDiff struct {
	// Input and output
	Diff   **InstanceDiff
	Output **InstanceDiff

	// Destroy, if true, will only include a destroy diff if it is set.
	Destroy bool
}

EvalFilterDiff is an EvalNode implementation that filters the diff according to some filter.

func (*EvalFilterDiff) Eval added in v0.4.0 

func (n *EvalFilterDiff) Eval(ctx EvalContext) (interface{}, error)

type EvalGetProvider added in v0.4.0 

type EvalGetProvider struct {
	Name   string
	Output *ResourceProvider
}

EvalGetProvider is an EvalNode implementation that retrieves an already initialized provider instance for the given name.

func (*EvalGetProvider) Eval added in v0.4.0 

func (n *EvalGetProvider) Eval(ctx EvalContext) (interface{}, error)

type EvalGetProvisioner added in v0.4.0 

type EvalGetProvisioner struct {
	Name   string
	Output *ResourceProvisioner
}

EvalGetProvisioner is an EvalNode implementation that retrieves an already initialized provisioner instance for the given name.

func (*EvalGetProvisioner) Eval added in v0.4.0 

func (n *EvalGetProvisioner) Eval(ctx EvalContext) (interface{}, error)

type EvalIf added in v0.4.0 

type EvalIf struct {
	If   func(EvalContext) (bool, error)
	Then EvalNode
	Else EvalNode
}

EvalIf is an EvalNode that is a conditional.

func (*EvalIf) Eval added in v0.4.0 

func (n *EvalIf) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalIgnoreChanges added in v0.6.4 

type EvalIgnoreChanges struct {
	Resource      *config.Resource
	Diff          **InstanceDiff
	WasChangeType *DiffChangeType
}

EvalIgnoreChanges is an EvalNode implementation that removes diff attributes if their name matches names provided by the resource's IgnoreChanges lifecycle.

func (*EvalIgnoreChanges) Eval added in v0.6.4 

func (n *EvalIgnoreChanges) Eval(ctx EvalContext) (interface{}, error)

type EvalInitProvider added in v0.4.0 

type EvalInitProvider struct {
	Name string
}

EvalInitProvider is an EvalNode implementation that initializes a provider and returns nothing. The provider can be retrieved again with the EvalGetProvider node.

func (*EvalInitProvider) Eval added in v0.4.0 

func (n *EvalInitProvider) Eval(ctx EvalContext) (interface{}, error)

type EvalInitProvisioner added in v0.4.0 

type EvalInitProvisioner struct {
	Name string
}

EvalInitProvisioner is an EvalNode implementation that initializes a provisioner and returns nothing. The provisioner can be retrieved again with the EvalGetProvisioner node.

func (*EvalInitProvisioner) Eval added in v0.4.0 

func (n *EvalInitProvisioner) Eval(ctx EvalContext) (interface{}, error)

type EvalInputProvider added in v0.4.0 

type EvalInputProvider struct {
	Name     string
	Provider *ResourceProvider
	Config   **ResourceConfig
}

EvalInputProvider is an EvalNode implementation that asks for input for the given provider configurations.

func (*EvalInputProvider) Eval added in v0.4.0 

func (n *EvalInputProvider) Eval(ctx EvalContext) (interface{}, error)

type EvalInstanceInfo added in v0.4.0 

type EvalInstanceInfo struct {
	Info *InstanceInfo
}

EvalInstanceInfo is an EvalNode implementation that fills in the InstanceInfo as much as it can.

func (*EvalInstanceInfo) Eval added in v0.4.0 

func (n *EvalInstanceInfo) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalInterpolate added in v0.4.0 

type EvalInterpolate struct {
	Config   *config.RawConfig
	Resource *Resource
	Output   **ResourceConfig
}

EvalInterpolate is an EvalNode implementation that takes a raw configuration and interpolates it.

func (*EvalInterpolate) Eval added in v0.4.0 

func (n *EvalInterpolate) Eval(ctx EvalContext) (interface{}, error)

type EvalNode added in v0.4.0 

type EvalNode interface {
	// Eval evaluates this node with the given context. The second parameter
	// are the argument values. These will match in order and 1-1 with the
	// results of the Args() return value.
	Eval(EvalContext) (interface{}, error)
}

EvalNode is the interface that must be implemented by graph nodes to evaluate/execute.

func CloseProviderEvalTree added in v0.6.0 

func CloseProviderEvalTree(n string) EvalNode

CloseProviderEvalTree returns the evaluation tree for closing provider connections that aren't needed anymore.

func EvalFilter added in v0.4.0 

func EvalFilter(node EvalNode, fn EvalNodeFilterFunc) EvalNode

EvalFilter runs the filter on the given node and returns the final filtered value. This should be called rather than checking the EvalNode directly since this will properly handle EvalNodeFilterables.

func ProviderEvalTree added in v0.4.0 

func ProviderEvalTree(n string, config *config.RawConfig) EvalNode

ProviderEvalTree returns the evaluation tree for initializing and configuring providers.

type EvalNodeFilterFunc added in v0.4.0 

type EvalNodeFilterFunc func(EvalNode) EvalNode

EvalNodeFilterFunc is the callback used to replace a node with another to node. To not do the replacement, just return the input node.

func EvalNodeFilterOp added in v0.4.0 

func EvalNodeFilterOp(op walkOperation) EvalNodeFilterFunc

EvalNodeFilterOp returns a filter function that filters nodes that include themselves in specific operations.

type EvalNodeFilterable added in v0.4.0 

type EvalNodeFilterable interface {
	EvalNode
	Filter(EvalNodeFilterFunc)
}

EvalNodeFilterable is an interface that can be implemented by EvalNodes to allow filtering of sub-elements. Note that this isn't a common thing to implement and you probably don't need it.

type EvalNodeOpFilterable added in v0.4.0 

type EvalNodeOpFilterable interface {
	IncludeInOp(walkOperation) bool
}

EvalNodeOpFilterable is an interface that EvalNodes can implement to be filterable by the operation that is being run on Terraform.

type EvalNoop added in v0.4.0 

type EvalNoop struct{}

EvalNoop is an EvalNode that does nothing.

func (EvalNoop) Eval added in v0.4.0 

func (EvalNoop) Eval(EvalContext) (interface{}, error)

type EvalOpFilter added in v0.4.0 

type EvalOpFilter struct {
	// Ops is the list of operations to include this node in.
	Ops []walkOperation

	// Node is the node to execute
	Node EvalNode
}

EvalOpFilter is an EvalNode implementation that is a proxy to another node but filters based on the operation.

func (*EvalOpFilter) Eval added in v0.4.0 

func (n *EvalOpFilter) Eval(ctx EvalContext) (interface{}, error)

TODO: test

func (*EvalOpFilter) IncludeInOp added in v0.4.0 

func (n *EvalOpFilter) IncludeInOp(op walkOperation) bool

EvalNodeOpFilterable impl.

type EvalReadDiff added in v0.4.0 

type EvalReadDiff struct {
	Name string
	Diff **InstanceDiff
}

EvalReadDiff is an EvalNode implementation that writes the diff to the full diff.

func (*EvalReadDiff) Eval added in v0.4.0 

func (n *EvalReadDiff) Eval(ctx EvalContext) (interface{}, error)

type EvalReadState added in v0.4.0 

type EvalReadState struct {
	Name   string
	Output **InstanceState
}

EvalReadState is an EvalNode implementation that reads the primary InstanceState for a specific resource out of the state.

func (*EvalReadState) Eval added in v0.4.0 

func (n *EvalReadState) Eval(ctx EvalContext) (interface{}, error)

type EvalReadStateDeposed added in v0.4.0 

type EvalReadStateDeposed struct {
	Name   string
	Output **InstanceState
	// Index indicates which instance in the Deposed list to target, or -1 for
	// the last item.
	Index int
}

EvalReadStateDeposed is an EvalNode implementation that reads the deposed InstanceState for a specific resource out of the state

func (*EvalReadStateDeposed) Eval added in v0.4.0 

func (n *EvalReadStateDeposed) Eval(ctx EvalContext) (interface{}, error)

type EvalReadStateTainted added in v0.4.0 

type EvalReadStateTainted struct {
	Name   string
	Output **InstanceState
	// Index indicates which instance in the Tainted list to target, or -1 for
	// the last item.
	Index int
}

EvalReadStateTainted is an EvalNode implementation that reads a tainted InstanceState for a specific resource out of the state

func (*EvalReadStateTainted) Eval added in v0.4.0 

func (n *EvalReadStateTainted) Eval(ctx EvalContext) (interface{}, error)

type EvalRefresh added in v0.4.0 

type EvalRefresh struct {
	Provider *ResourceProvider
	State    **InstanceState
	Info     *InstanceInfo
	Output   **InstanceState
}

EvalRefresh is an EvalNode implementation that does a refresh for a resource.

func (*EvalRefresh) Eval added in v0.4.0 

func (n *EvalRefresh) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalRequireState added in v0.4.0 

type EvalRequireState struct {
	State **InstanceState
}

EvalRequireState is an EvalNode implementation that early exits if the state doesn't have an ID.

func (*EvalRequireState) Eval added in v0.4.0 

func (n *EvalRequireState) Eval(ctx EvalContext) (interface{}, error)

type EvalReturnError added in v0.4.0 

type EvalReturnError struct {
	Error *error
}

EvalReturnError is an EvalNode implementation that returns an error if it is present.

This is useful for scenarios where an error has been captured by another EvalNode (like EvalApply) for special EvalTree-based error handling, and that handling has completed, so the error should be returned normally.

func (*EvalReturnError) Eval added in v0.4.0 

func (n *EvalReturnError) Eval(ctx EvalContext) (interface{}, error)

type EvalSequence added in v0.4.0 

type EvalSequence struct {
	Nodes []EvalNode
}

EvalSequence is an EvalNode that evaluates in sequence.

func (*EvalSequence) Eval added in v0.4.0 

func (n *EvalSequence) Eval(ctx EvalContext) (interface{}, error)

func (*EvalSequence) Filter added in v0.4.0 

func (n *EvalSequence) Filter(fn EvalNodeFilterFunc)

EvalNodeFilterable impl.

type EvalSetProviderConfig added in v0.4.1 

type EvalSetProviderConfig struct {
	Provider string
	Config   **ResourceConfig
}

EvalSetProviderConfig sets the parent configuration for a provider without configuring that provider, validating it, etc.

func (*EvalSetProviderConfig) Eval added in v0.4.1 

func (n *EvalSetProviderConfig) Eval(ctx EvalContext) (interface{}, error)

type EvalSetVariables added in v0.4.0 

type EvalSetVariables struct {
	Module    *string
	Variables map[string]string
}

EvalSetVariables is an EvalNode implementation that sets the variables explicitly for interpolation later.

func (*EvalSetVariables) Eval added in v0.4.0 

func (n *EvalSetVariables) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalTypeCheckVariable added in v0.6.15 

type EvalTypeCheckVariable struct {
	Variables  map[string]string
	ModulePath []string
	ModuleTree *module.Tree
}

EvalTypeCheckVariable is an EvalNode which ensures that the variable values which are assigned as inputs to a module (including the root) match the types which are either declared for the variables explicitly or inferred from the default values.

In order to achieve this three things are required:

  • a map of the proposed variable values
  • the configuration tree of the module in which the variable is declared
  • the path to the module (so we know which part of the tree to compare the values against).

Currently since the type system is simple, we currently do not make use of the values since it is only valid to pass string values. The structure is in place for extension of the type system, however.

func (*EvalTypeCheckVariable) Eval added in v0.6.15 

func (n *EvalTypeCheckVariable) Eval(ctx EvalContext) (interface{}, error)

type EvalUndeposeState added in v0.4.0 

type EvalUndeposeState struct {
	Name string
}

EvalUndeposeState is an EvalNode implementation that reads the InstanceState for a specific resource out of the state.

func (*EvalUndeposeState) Eval added in v0.4.0 

func (n *EvalUndeposeState) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalUpdateStateHook added in v0.4.0 

type EvalUpdateStateHook struct{}

EvalUpdateStateHook is an EvalNode implementation that calls the PostStateUpdate hook with the current state.

func (*EvalUpdateStateHook) Eval added in v0.4.0 

func (n *EvalUpdateStateHook) Eval(ctx EvalContext) (interface{}, error)

type EvalValidateCount added in v0.4.0 

type EvalValidateCount struct {
	Resource *config.Resource
}

EvalValidateCount is an EvalNode implementation that validates the count of a resource.

func (*EvalValidateCount) Eval added in v0.4.0 

func (n *EvalValidateCount) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalValidateError added in v0.4.0 

type EvalValidateError struct {
	Warnings []string
	Errors   []error
}

EvalValidateError is the error structure returned if there were validation errors.

func (*EvalValidateError) Error added in v0.4.0 

func (e *EvalValidateError) Error() string

type EvalValidateProvider added in v0.4.0 

type EvalValidateProvider struct {
	Provider *ResourceProvider
	Config   **ResourceConfig
}

EvalValidateProvider is an EvalNode implementation that validates the configuration of a resource.

func (*EvalValidateProvider) Eval added in v0.4.0 

func (n *EvalValidateProvider) Eval(ctx EvalContext) (interface{}, error)

type EvalValidateProvisioner added in v0.4.0 

type EvalValidateProvisioner struct {
	Provisioner *ResourceProvisioner
	Config      **ResourceConfig
}

EvalValidateProvisioner is an EvalNode implementation that validates the configuration of a resource.

func (*EvalValidateProvisioner) Eval added in v0.4.0 

func (n *EvalValidateProvisioner) Eval(ctx EvalContext) (interface{}, error)

type EvalValidateResource added in v0.4.0 

type EvalValidateResource struct {
	Provider     *ResourceProvider
	Config       **ResourceConfig
	ResourceName string
	ResourceType string
}

EvalValidateResource is an EvalNode implementation that validates the configuration of a resource.

func (*EvalValidateResource) Eval added in v0.4.0 

func (n *EvalValidateResource) Eval(ctx EvalContext) (interface{}, error)

type EvalVariableBlock added in v0.4.0 

type EvalVariableBlock struct {
	Config    **ResourceConfig
	Variables map[string]string
}

EvalVariableBlock is an EvalNode implementation that evaluates the given configuration, and uses the final values as a way to set the mapping.

func (*EvalVariableBlock) Eval added in v0.4.0 

func (n *EvalVariableBlock) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalWriteDiff added in v0.4.0 

type EvalWriteDiff struct {
	Name string
	Diff **InstanceDiff
}

EvalWriteDiff is an EvalNode implementation that writes the diff to the full diff.

func (*EvalWriteDiff) Eval added in v0.4.0 

func (n *EvalWriteDiff) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalWriteOutput added in v0.4.0 

type EvalWriteOutput struct {
	Name  string
	Value *config.RawConfig
}

EvalWriteOutput is an EvalNode implementation that writes the output for the given name to the current state.

func (*EvalWriteOutput) Eval added in v0.4.0 

func (n *EvalWriteOutput) Eval(ctx EvalContext) (interface{}, error)

TODO: test

type EvalWriteState added in v0.4.0 

type EvalWriteState struct {
	Name         string
	ResourceType string
	Provider     string
	Dependencies []string
	State        **InstanceState
}

EvalWriteState is an EvalNode implementation that writes the primary InstanceState for a specific resource into the state.

func (*EvalWriteState) Eval added in v0.4.0 

func (n *EvalWriteState) Eval(ctx EvalContext) (interface{}, error)

type EvalWriteStateDeposed added in v0.4.0 

type EvalWriteStateDeposed struct {
	Name         string
	ResourceType string
	Provider     string
	Dependencies []string
	State        **InstanceState
	// Index indicates which instance in the Deposed list to target, or -1 to append.
	Index int
}

EvalWriteStateDeposed is an EvalNode implementation that writes an InstanceState out to the Deposed list of a resource in the state.

func (*EvalWriteStateDeposed) Eval added in v0.4.0 

func (n *EvalWriteStateDeposed) Eval(ctx EvalContext) (interface{}, error)

type EvalWriteStateTainted added in v0.4.0 

type EvalWriteStateTainted struct {
	Name         string
	ResourceType string
	Provider     string
	Dependencies []string
	State        **InstanceState
	// Index indicates which instance in the Tainted list to target, or -1 to append.
	Index int
}

EvalWriteStateTainted is an EvalNode implementation that writes an InstanceState out to the Tainted list of a resource in the state.

func (*EvalWriteStateTainted) Eval added in v0.4.0 

func (n *EvalWriteStateTainted) Eval(ctx EvalContext) (interface{}, error)

EvalWriteStateTainted is an EvalNode implementation that writes the one of the tainted InstanceStates for a specific resource out of the state.

type ExpandTransform added in v0.4.0 

type ExpandTransform struct {
	Builder GraphBuilder
}

ExpandTransform is a transformer that does a subgraph expansion at graph transform time (vs. at eval time). The benefit of earlier subgraph expansion is that errors with the graph build can be detected at an earlier stage.

func (*ExpandTransform) Transform added in v0.4.0 

func (t *ExpandTransform) Transform(v dag.Vertex) (dag.Vertex, error)

type FlattenTransformer added in v0.5.0 

type FlattenTransformer struct{}

FlattenTransformer is a transformer that goes through the graph, finds subgraphs that can be flattened, and flattens them into this graph, removing the prior subgraph node.

func (*FlattenTransformer) Transform added in v0.5.0 

func (t *FlattenTransformer) Transform(g *Graph) error

type Graph 

type Graph struct {
	// Graph is the actual DAG. This is embedded so you can call the DAG
	// methods directly.
	dag.AcyclicGraph

	// Path is the path in the module tree that this Graph represents.
	// The root is represented by a single element list containing
	// RootModuleName
	Path []string
	// contains filtered or unexported fields
}

Graph represents the graph that Terraform uses to represent resources and their dependencies. Each graph represents only one module, but it can contain further modules, which themselves have their own graph.

func (*Graph) Add added in v0.4.0 

func (g *Graph) Add(v dag.Vertex) dag.Vertex

Add is the same as dag.Graph.Add.

func (*Graph) ConnectDependent added in v0.4.0 

func (g *Graph) ConnectDependent(raw dag.Vertex) []string

ConnectDependent connects a GraphNodeDependent to all of its GraphNodeDependables. It returns the list of dependents it was unable to connect to.

func (*Graph) ConnectDependents added in v0.4.0 

func (g *Graph) ConnectDependents()

ConnectDependents goes through the graph, connecting all the GraphNodeDependents to GraphNodeDependables. This is safe to call multiple times.

To get details on whether dependencies could be found/made, the more specific ConnectDependent should be used.

func (*Graph) ConnectFrom added in v0.4.0 

func (g *Graph) ConnectFrom(source string, target dag.Vertex)

ConnectFrom creates an edge by finding the source from a DependableName and connecting it to the specific vertex.

func (*Graph) ConnectTo added in v0.4.0 

func (g *Graph) ConnectTo(v dag.Vertex, targets []string) []string

ConnectTo connects a vertex to a raw string of targets that are the result of DependableName, and returns the list of targets that are missing.

func (*Graph) Dependable added in v0.4.0 

func (g *Graph) Dependable(n string) dag.Vertex

Dependable finds the vertices in the graph that have the given dependable names and returns them.

func (*Graph) Remove added in v0.5.0 

func (g *Graph) Remove(v dag.Vertex) dag.Vertex

Remove is the same as dag.Graph.Remove

func (*Graph) Replace added in v0.5.0 

func (g *Graph) Replace(o, n dag.Vertex) bool

Replace is the same as dag.Graph.Replace

func (*Graph) Walk added in v0.4.0 

func (g *Graph) Walk(walker GraphWalker) error

Walk walks the graph with the given walker for callbacks. The graph will be walked with full parallelism, so the walker should expect to be called in concurrently.

type GraphBuilder added in v0.4.0 

type GraphBuilder interface {
	// Build builds the graph for the given module path. It is up to
	// the interface implementation whether this build should expand
	// the graph or not.
	Build(path []string) (*Graph, error)
}

GraphBuilder is an interface that can be implemented and used with Terraform to build the graph that Terraform walks.

type GraphDotOpts added in v0.3.0 

type GraphDotOpts struct {
	// Allows some nodes to decide to only show themselves when the user has
	// requested the "verbose" graph.
	Verbose bool

	// Highlight Cycles
	DrawCycles bool

	// How many levels to expand modules as we draw
	MaxDepth int
}

GraphDotOpts are the options for generating a dot formatted Graph.

type GraphNodeAddressable added in v0.4.0 

type GraphNodeAddressable interface {
	ResourceAddress() *ResourceAddress
	// contains filtered or unexported methods
}

GraphNodeAddressable is an interface that all graph nodes for the configuration graph need to implement in order to be be addressed / targeted properly.

type GraphNodeBasicSubgraph added in v0.4.0 

type GraphNodeBasicSubgraph struct {
	NameValue string
	Graph     *Graph
}

func (*GraphNodeBasicSubgraph) FlattenGraph added in v0.5.1 

func (n *GraphNodeBasicSubgraph) FlattenGraph() *Graph

func (*GraphNodeBasicSubgraph) Name added in v0.4.0 

func (n *GraphNodeBasicSubgraph) Name() string

func (*GraphNodeBasicSubgraph) Subgraph added in v0.4.0 

func (n *GraphNodeBasicSubgraph) Subgraph() *Graph

type GraphNodeCloseProvider added in v0.6.0 

type GraphNodeCloseProvider interface {
	CloseProviderName() string
}

GraphNodeCloseProvider is an interface that nodes that can be a close provider must implement. The CloseProviderName returned is the name of the provider they satisfy.

type GraphNodeCloseProvisioner added in v0.6.0 

type GraphNodeCloseProvisioner interface {
	CloseProvisionerName() string
}

GraphNodeCloseProvisioner is an interface that nodes that can be a close provisioner must implement. The CloseProvisionerName returned is the name of the provisioner they satisfy.

type GraphNodeConfigModule added in v0.4.0 

type GraphNodeConfigModule struct {
	Path   []string
	Module *config.Module
	Tree   *module.Tree
}

GraphNodeConfigModule represents a module within the configuration graph.

func (*GraphNodeConfigModule) ConfigType added in v0.4.1 

func (n *GraphNodeConfigModule) ConfigType() GraphNodeConfigType

func (*GraphNodeConfigModule) DependableName added in v0.4.0 

func (n *GraphNodeConfigModule) DependableName() []string

func (*GraphNodeConfigModule) DependentOn added in v0.4.0 

func (n *GraphNodeConfigModule) DependentOn() []string

func (*GraphNodeConfigModule) Expand added in v0.4.0 

func (n *GraphNodeConfigModule) Expand(b GraphBuilder) (GraphNodeSubgraph, error)

GraphNodeExpandable

func (*GraphNodeConfigModule) Name added in v0.4.0 

func (n *GraphNodeConfigModule) Name() string

func (*GraphNodeConfigModule) ProvidedBy added in v0.4.0 

func (n *GraphNodeConfigModule) ProvidedBy() []string

GraphNodeExpandable

type GraphNodeConfigOutput added in v0.4.0 

type GraphNodeConfigOutput struct {
	Output *config.Output
}

GraphNodeConfigOutput represents an output configured within the configuration.

func (*GraphNodeConfigOutput) ConfigType added in v0.4.1 

func (n *GraphNodeConfigOutput) ConfigType() GraphNodeConfigType

func (*GraphNodeConfigOutput) DependableName added in v0.4.0 

func (n *GraphNodeConfigOutput) DependableName() []string

func (*GraphNodeConfigOutput) DependentOn added in v0.4.0 

func (n *GraphNodeConfigOutput) DependentOn() []string

func (*GraphNodeConfigOutput) DestroyEdgeInclude added in v0.5.0 

func (n *GraphNodeConfigOutput) DestroyEdgeInclude(dag.Vertex) bool

GraphNodeDestroyEdgeInclude impl.

func (*GraphNodeConfigOutput) EvalTree added in v0.4.0 

func (n *GraphNodeConfigOutput) EvalTree() EvalNode

GraphNodeEvalable impl.

func (*GraphNodeConfigOutput) Flatten added in v0.5.0 

func (n *GraphNodeConfigOutput) Flatten(p []string) (dag.Vertex, error)

GraphNodeFlattenable impl.

func (*GraphNodeConfigOutput) Name added in v0.4.0 

func (n *GraphNodeConfigOutput) Name() string

func (*GraphNodeConfigOutput) OutputName added in v0.5.0 

func (n *GraphNodeConfigOutput) OutputName() string

func (*GraphNodeConfigOutput) Proxy added in v0.5.0 

func (n *GraphNodeConfigOutput) Proxy() bool

GraphNodeProxy impl.

type GraphNodeConfigOutputFlat added in v0.5.0 

type GraphNodeConfigOutputFlat struct {
	*GraphNodeConfigOutput

	PathValue []string
}

Same as GraphNodeConfigOutput, but for flattening

func (*GraphNodeConfigOutputFlat) DependableName added in v0.5.0 

func (n *GraphNodeConfigOutputFlat) DependableName() []string

func (*GraphNodeConfigOutputFlat) DependentOn added in v0.5.0 

func (n *GraphNodeConfigOutputFlat) DependentOn() []string

func (*GraphNodeConfigOutputFlat) Name added in v0.5.0 

func (n *GraphNodeConfigOutputFlat) Name() string

func (*GraphNodeConfigOutputFlat) Path added in v0.5.0 

func (n *GraphNodeConfigOutputFlat) Path() []string

type GraphNodeConfigProvider added in v0.4.0 

type GraphNodeConfigProvider struct {
	Provider *config.ProviderConfig
}

GraphNodeConfigProvider represents a configured provider within the configuration graph. These are only immediately in the graph when an explicit `provider` configuration block is in the configuration.

func (*GraphNodeConfigProvider) ConfigType added in v0.4.1 

func (n *GraphNodeConfigProvider) ConfigType() GraphNodeConfigType

func (*GraphNodeConfigProvider) DependableName added in v0.4.0 

func (n *GraphNodeConfigProvider) DependableName() []string

func (*GraphNodeConfigProvider) DependentOn added in v0.4.0 

func (n *GraphNodeConfigProvider) DependentOn() []string

func (*GraphNodeConfigProvider) DotNode added in v0.5.0 

func (n *GraphNodeConfigProvider) DotNode(name string, opts *GraphDotOpts) *dot.Node

GraphNodeDotter impl.

func (*GraphNodeConfigProvider) DotOrigin added in v0.5.0 

func (n *GraphNodeConfigProvider) DotOrigin() bool

GraphNodeDotterOrigin impl.

func (*GraphNodeConfigProvider) EvalTree added in v0.4.0 

func (n *GraphNodeConfigProvider) EvalTree() EvalNode

GraphNodeEvalable impl.

func (*GraphNodeConfigProvider) Flatten added in v0.5.0 

func (n *GraphNodeConfigProvider) Flatten(p []string) (dag.Vertex, error)

GraphNodeFlattenable impl.

func (*GraphNodeConfigProvider) Name added in v0.4.0 

func (n *GraphNodeConfigProvider) Name() string

func (*GraphNodeConfigProvider) ProviderConfig added in v0.4.1 

func (n *GraphNodeConfigProvider) ProviderConfig() *config.RawConfig

GraphNodeProvider implementation

func (*GraphNodeConfigProvider) ProviderName added in v0.4.0 

func (n *GraphNodeConfigProvider) ProviderName() string

GraphNodeProvider implementation

type GraphNodeConfigProviderFlat added in v0.5.0 

type GraphNodeConfigProviderFlat struct {
	*GraphNodeConfigProvider

	PathValue []string
}

Same as GraphNodeConfigProvider, but for flattening

func (*GraphNodeConfigProviderFlat) DependableName added in v0.5.0 

func (n *GraphNodeConfigProviderFlat) DependableName() []string

func (*GraphNodeConfigProviderFlat) DependentOn added in v0.5.0 

func (n *GraphNodeConfigProviderFlat) DependentOn() []string

func (*GraphNodeConfigProviderFlat) Name added in v0.5.0 

func (n *GraphNodeConfigProviderFlat) Name() string

func (*GraphNodeConfigProviderFlat) Path added in v0.5.0 

func (n *GraphNodeConfigProviderFlat) Path() []string

func (*GraphNodeConfigProviderFlat) ProviderName added in v0.5.0 

func (n *GraphNodeConfigProviderFlat) ProviderName() string

type GraphNodeConfigResource added in v0.4.0 

type GraphNodeConfigResource struct {
	Resource *config.Resource

	// If this is set to anything other than destroyModeNone, then this
	// resource represents a resource that will be destroyed in some way.
	DestroyMode GraphNodeDestroyMode

	// Used during DynamicExpand to target indexes
	Targets []ResourceAddress

	Path []string
}

GraphNodeConfigResource represents a resource within the config graph.

func (*GraphNodeConfigResource) ConfigType added in v0.4.1 

func (n *GraphNodeConfigResource) ConfigType() GraphNodeConfigType

func (*GraphNodeConfigResource) Copy added in v0.6.12 

func (n *GraphNodeConfigResource) Copy() *GraphNodeConfigResource

func (*GraphNodeConfigResource) CountDependentOn added in v0.5.0 

func (n *GraphNodeConfigResource) CountDependentOn() []string

GraphNodeCountDependent impl.

func (*GraphNodeConfigResource) DependableName added in v0.4.0 

func (n *GraphNodeConfigResource) DependableName() []string

func (*GraphNodeConfigResource) DependentOn added in v0.4.0 

func (n *GraphNodeConfigResource) DependentOn() []string

GraphNodeDependent impl.

func (*GraphNodeConfigResource) DestroyNode added in v0.4.0 

func (n *GraphNodeConfigResource) DestroyNode(mode GraphNodeDestroyMode) GraphNodeDestroy

GraphNodeDestroyable

func (*GraphNodeConfigResource) DotNode added in v0.5.0 

func (n *GraphNodeConfigResource) DotNode(name string, opts *GraphDotOpts) *dot.Node

GraphNodeDotter impl.

func (*GraphNodeConfigResource) DynamicExpand added in v0.4.0 

func (n *GraphNodeConfigResource) DynamicExpand(ctx EvalContext) (*Graph, error)

GraphNodeDynamicExpandable impl.

func (*GraphNodeConfigResource) EvalTree added in v0.4.0 

func (n *GraphNodeConfigResource) EvalTree() EvalNode

GraphNodeEvalable impl.

func (*GraphNodeConfigResource) Flatten added in v0.5.0 

func (n *GraphNodeConfigResource) Flatten(p []string) (dag.Vertex, error)

GraphNodeFlattenable impl.

func (*GraphNodeConfigResource) Name added in v0.4.0 

func (n *GraphNodeConfigResource) Name() string

func (*GraphNodeConfigResource) Noop added in v0.6.1 

func (n *GraphNodeConfigResource) Noop(opts *NoopOpts) bool

GraphNodeNoopPrunable

func (*GraphNodeConfigResource) ProvidedBy added in v0.4.0 

func (n *GraphNodeConfigResource) ProvidedBy() []string

GraphNodeProviderConsumer

func (*GraphNodeConfigResource) ProvisionedBy added in v0.4.0 

func (n *GraphNodeConfigResource) ProvisionedBy() []string

GraphNodeProvisionerConsumer

func (*GraphNodeConfigResource) ResourceAddress added in v0.4.0 

func (n *GraphNodeConfigResource) ResourceAddress() *ResourceAddress

GraphNodeAddressable impl.

func (*GraphNodeConfigResource) SetTargets added in v0.4.0 

func (n *GraphNodeConfigResource) SetTargets(targets []ResourceAddress)

GraphNodeTargetable impl.

func (*GraphNodeConfigResource) VarWalk added in v0.5.0 

func (n *GraphNodeConfigResource) VarWalk(fn func(config.InterpolatedVariable))

VarWalk calls a callback for all the variables that this resource depends on.

type GraphNodeConfigResourceFlat added in v0.5.0 

type GraphNodeConfigResourceFlat struct {
	*GraphNodeConfigResource

	PathValue []string
}

Same as GraphNodeConfigResource, but for flattening

func (*GraphNodeConfigResourceFlat) DependableName added in v0.5.0 

func (n *GraphNodeConfigResourceFlat) DependableName() []string

func (*GraphNodeConfigResourceFlat) DependentOn added in v0.5.0 

func (n *GraphNodeConfigResourceFlat) DependentOn() []string

func (*GraphNodeConfigResourceFlat) DestroyNode added in v0.5.0 

func (n *GraphNodeConfigResourceFlat) DestroyNode(mode GraphNodeDestroyMode) GraphNodeDestroy

GraphNodeDestroyable impl.

func (*GraphNodeConfigResourceFlat) Name added in v0.5.0 

func (n *GraphNodeConfigResourceFlat) Name() string

func (*GraphNodeConfigResourceFlat) Path added in v0.5.0 

func (n *GraphNodeConfigResourceFlat) Path() []string

func (*GraphNodeConfigResourceFlat) ProvidedBy added in v0.5.0 

func (n *GraphNodeConfigResourceFlat) ProvidedBy() []string

func (*GraphNodeConfigResourceFlat) ProvisionedBy added in v0.5.0 

func (n *GraphNodeConfigResourceFlat) ProvisionedBy() []string

type GraphNodeConfigType added in v0.4.1 

type GraphNodeConfigType int

GraphNodeConfigType is an enum for the type of thing that a graph node represents from the configuration. 

const (
	GraphNodeConfigTypeInvalid  GraphNodeConfigType = 0
	GraphNodeConfigTypeResource GraphNodeConfigType = iota
	GraphNodeConfigTypeProvider
	GraphNodeConfigTypeModule
	GraphNodeConfigTypeOutput
	GraphNodeConfigTypeVariable
)

func (GraphNodeConfigType) String added in v0.4.1 

func (i GraphNodeConfigType) String() string

type GraphNodeConfigVariable added in v0.5.0 

type GraphNodeConfigVariable struct {
	Variable *config.Variable

	// Value, if non-nil, will be used to set the value of the variable
	// during evaluation. If this is nil, evaluation will do nothing.
	//
	// Module is the name of the module to set the variables on.
	Module string
	Value  *config.RawConfig

	ModuleTree *module.Tree
	ModulePath []string
}

GraphNodeConfigVariable represents a Variable in the config.

func (*GraphNodeConfigVariable) ConfigType added in v0.5.0 

func (n *GraphNodeConfigVariable) ConfigType() GraphNodeConfigType

func (*GraphNodeConfigVariable) DependableName added in v0.5.0 

func (n *GraphNodeConfigVariable) DependableName() []string

func (*GraphNodeConfigVariable) DependentOn added in v0.5.0 

func (n *GraphNodeConfigVariable) DependentOn() []string

func (*GraphNodeConfigVariable) DestroyEdgeInclude added in v0.5.0 

func (n *GraphNodeConfigVariable) DestroyEdgeInclude(v dag.Vertex) bool

GraphNodeDestroyEdgeInclude impl.

func (*GraphNodeConfigVariable) EvalTree added in v0.5.0 

func (n *GraphNodeConfigVariable) EvalTree() EvalNode

GraphNodeEvalable impl.

func (*GraphNodeConfigVariable) Flatten added in v0.5.0 

func (n *GraphNodeConfigVariable) Flatten(p []string) (dag.Vertex, error)

GraphNodeFlattenable impl.

func (*GraphNodeConfigVariable) Name added in v0.5.0 

func (n *GraphNodeConfigVariable) Name() string

func (*GraphNodeConfigVariable) Noop added in v0.6.1 

func (n *GraphNodeConfigVariable) Noop(opts *NoopOpts) bool

GraphNodeNoopPrunable

func (*GraphNodeConfigVariable) Proxy added in v0.5.0 

func (n *GraphNodeConfigVariable) Proxy() bool

GraphNodeProxy impl.

func (*GraphNodeConfigVariable) VariableName added in v0.5.0 

func (n *GraphNodeConfigVariable) VariableName() string

type GraphNodeConfigVariableFlat added in v0.5.0 

type GraphNodeConfigVariableFlat struct {
	*GraphNodeConfigVariable

	PathValue []string
}

func (*GraphNodeConfigVariableFlat) DependableName added in v0.5.0 

func (n *GraphNodeConfigVariableFlat) DependableName() []string

func (*GraphNodeConfigVariableFlat) DependentOn added in v0.5.0 

func (n *GraphNodeConfigVariableFlat) DependentOn() []string

func (*GraphNodeConfigVariableFlat) Name added in v0.5.0 

func (n *GraphNodeConfigVariableFlat) Name() string

func (*GraphNodeConfigVariableFlat) Path added in v0.5.0 

func (n *GraphNodeConfigVariableFlat) Path() []string

type GraphNodeCountDependent added in v0.5.0 

type GraphNodeCountDependent interface {
	CountDependentOn() []string
}

GraphNodeCountDependent is implemented by resources for giving only the dependencies they have from the "count" field.

type GraphNodeDependable added in v0.4.0 

type GraphNodeDependable interface {
	DependableName() []string
}

GraphNodeDependable is an interface which says that a node can be depended on (an edge can be placed between this node and another) according to the well-known name returned by DependableName.

DependableName can return multiple names it is known by.

type GraphNodeDependent added in v0.4.0 

type GraphNodeDependent interface {
	DependentOn() []string
}

GraphNodeDependent is an interface which says that a node depends on another GraphNodeDependable by some name. By implementing this interface, Graph.ConnectDependents() can be called multiple times safely and efficiently.

type GraphNodeDestroy added in v0.4.0 

type GraphNodeDestroy interface {
	dag.Vertex

	// CreateBeforeDestroy is called to check whether this node
	// should be created before it is destroyed. The CreateBeforeDestroy
	// transformer uses this information to setup the graph.
	CreateBeforeDestroy() bool

	// CreateNode returns the node used for the create side of this
	// destroy. This must already exist within the graph.
	CreateNode() dag.Vertex
}

GraphNodeDestroy is the interface that must implemented by nodes that destroy.

type GraphNodeDestroyEdgeInclude added in v0.5.0 

type GraphNodeDestroyEdgeInclude interface {
	DestroyEdgeInclude(dag.Vertex) bool
}

GraphNodeEdgeInclude can be implemented to not include something as an edge within the destroy graph. This is usually done because it might cause unnecessary cycles.

type GraphNodeDestroyMode added in v0.4.0 

type GraphNodeDestroyMode byte
const (
	DestroyNone    GraphNodeDestroyMode = 0
	DestroyPrimary GraphNodeDestroyMode = 1 << iota
	DestroyTainted
)

type GraphNodeDestroyPrunable added in v0.4.0 

type GraphNodeDestroyPrunable interface {
	// DestroyInclude is called to check if this node should be included
	// with the given state. The state and diff must NOT be modified.
	DestroyInclude(*ModuleDiff, *ModuleState) bool
}

GraphNodeDestroyPrunable is the interface that can be implemented to signal that this node can be pruned depending on state.

type GraphNodeDestroyable added in v0.4.0 

type GraphNodeDestroyable interface {
	// DestroyNode returns the node used for the destroy with the given
	// mode. If this returns nil, then a destroy node for that mode
	// will not be added.
	DestroyNode(GraphNodeDestroyMode) GraphNodeDestroy
}

GraphNodeDestroyable is the interface that nodes that can be destroyed must implement. This is used to automatically handle the creation of destroy nodes in the graph and the dependency ordering of those destroys.

type GraphNodeDotOrigin added in v0.5.0 

type GraphNodeDotOrigin interface {
	DotOrigin() bool
}

type GraphNodeDotter added in v0.4.0 

type GraphNodeDotter interface {
	// Dot is called to return the dot formatting for the node.
	// The first parameter is the title of the node.
	// The second parameter includes user-specified options that affect the dot
	// graph. See GraphDotOpts below for details.
	DotNode(string, *GraphDotOpts) *dot.Node
}

GraphNodeDotter can be implemented by a node to cause it to be included in the dot graph. The Dot method will be called which is expected to return a representation of this node.

type GraphNodeDynamicExpandable added in v0.4.0 

type GraphNodeDynamicExpandable interface {
	DynamicExpand(EvalContext) (*Graph, error)
}

GraphNodeDynamicExpandable is an interface that nodes can implement to signal that they can be expanded at eval-time (hence dynamic). These nodes are given the eval context and are expected to return a new subgraph.

type GraphNodeEvalable added in v0.4.0 

type GraphNodeEvalable interface {
	EvalTree() EvalNode
}

GraphNodeEvalable is the interface that graph nodes must implement to enable valuation.

type GraphNodeExpandable added in v0.4.0 

type GraphNodeExpandable interface {
	Expand(GraphBuilder) (GraphNodeSubgraph, error)
}

GraphNodeExapndable is an interface that nodes can implement to signal that they can be expanded. Expanded nodes turn into GraphNodeSubgraph nodes within the graph.

type GraphNodeFlatGraph added in v0.5.0 

type GraphNodeFlatGraph interface {
	FlattenGraph() *Graph
}

GraphNodeFlatGraph must be implemented by nodes that have subgraphs that they want flattened into the graph.

type GraphNodeFlattenable added in v0.5.0 

type GraphNodeFlattenable interface {
	Flatten(path []string) (dag.Vertex, error)
}

GraphNodeFlattenable must be implemented by all nodes that can be flattened. If a FlattenGraph returns any nodes that can't be flattened, it will be an error.

If Flatten returns nil for the Vertex along with a nil error, it will removed from the graph.

type GraphNodeNoopPrunable added in v0.6.1 

type GraphNodeNoopPrunable interface {
	Noop(*NoopOpts) bool
}

GraphNodeNoopPrunable can be implemented by nodes that can be pruned if they are noops.

type GraphNodeOutput added in v0.5.0 

type GraphNodeOutput interface {
	OutputName() string
}

GraphNodeOutput is an interface that nodes that are outputs must implement. The OutputName returned is the name of the output key that they manage.

type GraphNodeProvider added in v0.4.0 

type GraphNodeProvider interface {
	ProviderName() string
	ProviderConfig() *config.RawConfig
}

GraphNodeProvider is an interface that nodes that can be a provider must implement. The ProviderName returned is the name of the provider they satisfy.

type GraphNodeProviderConsumer added in v0.4.0 

type GraphNodeProviderConsumer interface {
	ProvidedBy() []string
}

GraphNodeProviderConsumer is an interface that nodes that require a provider must implement. ProvidedBy must return the name of the provider to use.

type GraphNodeProvisioner added in v0.4.0 

type GraphNodeProvisioner interface {
	ProvisionerName() string
}

GraphNodeProvisioner is an interface that nodes that can be a provisioner must implement. The ProvisionerName returned is the name of the provisioner they satisfy.

type GraphNodeProvisionerConsumer added in v0.4.0 

type GraphNodeProvisionerConsumer interface {
	ProvisionedBy() []string
}

GraphNodeProvisionerConsumer is an interface that nodes that require a provisioner must implement. ProvisionedBy must return the name of the provisioner to use.

type GraphNodeProxy added in v0.5.0 

type GraphNodeProxy interface {
	Proxy() bool
}

GraphNodeProxy must be implemented by nodes that are proxies.

A node that is a proxy says that anything that depends on this node (the proxy), should also copy all the things that the proxy itself depends on. Example: 

A => proxy => C

Should transform into (two edges): 

A => proxy => C
A => C

The purpose for this is because some transforms only look at direct edge connections and the proxy generally isn't meaningful in those situations, so we should complete all the edges.

type GraphNodeStateRepresentative added in v0.4.0 

type GraphNodeStateRepresentative interface {
	StateId() []string
}

GraphNodeStateRepresentative is an interface that can be implemented by a node to say that it is representing a resource in the state.

type GraphNodeSubPath added in v0.5.0 

type GraphNodeSubPath interface {
	Path() []string
}

GraphNodeSubPath says that a node is part of a graph with a different path, and the context should be adjusted accordingly.

type GraphNodeSubgraph added in v0.4.0 

type GraphNodeSubgraph interface {
	Subgraph() *Graph
}

GraphNodeSubgraph is an interface a node can implement if it has a larger subgraph that should be walked.

type GraphNodeTargetable added in v0.4.0 

type GraphNodeTargetable interface {
	GraphNodeAddressable

	SetTargets([]ResourceAddress)
}

GraphNodeTargetable is an interface for graph nodes to implement when they need to be told about incoming targets. This is useful for nodes that need to respect targets as they dynamically expand. Note that the list of targets provided will contain every target provided, and each implementing graph node must filter this list to targets considered relevant.

type GraphProxyEdge added in v0.5.0 

type GraphProxyEdge struct {
	dag.Edge
}

GraphProxyEdge is the edge that is used for proxied edges.

type GraphSemanticChecker added in v0.4.0 

type GraphSemanticChecker interface {
	Check(*dag.Graph) error
}

GraphSemanticChecker is the interface that semantic checks across the entire Terraform graph implement.

The graph should NOT be modified by the semantic checker.

type GraphTransformer added in v0.4.0 

type GraphTransformer interface {
	Transform(*Graph) error
}

GraphTransformer is the interface that transformers implement. This interface is only for transforms that need entire graph visibility.

type GraphVertexTransformer added in v0.4.0 

type GraphVertexTransformer interface {
	Transform(dag.Vertex) (dag.Vertex, error)
}

GraphVertexTransformer is an interface that transforms a single Vertex within with graph. This is a specialization of GraphTransformer that makes it easy to do vertex replacement.

The GraphTransformer that runs through the GraphVertexTransformers is VertexTransformer.

type GraphWalker added in v0.4.0 

type GraphWalker interface {
	EnterPath([]string) EvalContext
	ExitPath([]string)
	EnterVertex(dag.Vertex)
	ExitVertex(dag.Vertex, error)
	EnterEvalTree(dag.Vertex, EvalNode) EvalNode
	ExitEvalTree(dag.Vertex, interface{}, error) error
}

GraphWalker is an interface that can be implemented that when used with Graph.Walk will invoke the given callbacks under certain events.

type Hook 

type Hook interface {
	// PreApply and PostApply are called before and after a single
	// resource is applied. The error argument in PostApply is the
	// error, if any, that was returned from the provider Apply call itself.
	PreApply(*InstanceInfo, *InstanceState, *InstanceDiff) (HookAction, error)
	PostApply(*InstanceInfo, *InstanceState, error) (HookAction, error)

	// PreDiff and PostDiff are called before and after a single resource
	// resource is diffed.
	PreDiff(*InstanceInfo, *InstanceState) (HookAction, error)
	PostDiff(*InstanceInfo, *InstanceDiff) (HookAction, error)

	// Provisioning hooks
	//
	// All should be self-explanatory. ProvisionOutput is called with
	// output sent back by the provisioners. This will be called multiple
	// times as output comes in, but each call should represent a line of
	// output. The ProvisionOutput method cannot control whether the
	// hook continues running.
	PreProvisionResource(*InstanceInfo, *InstanceState) (HookAction, error)
	PostProvisionResource(*InstanceInfo, *InstanceState) (HookAction, error)
	PreProvision(*InstanceInfo, string) (HookAction, error)
	PostProvision(*InstanceInfo, string) (HookAction, error)
	ProvisionOutput(*InstanceInfo, string, string)

	// PreRefresh and PostRefresh are called before and after a single
	// resource state is refreshed, respectively.
	PreRefresh(*InstanceInfo, *InstanceState) (HookAction, error)
	PostRefresh(*InstanceInfo, *InstanceState) (HookAction, error)

	// PostStateUpdate is called after the state is updated.
	PostStateUpdate(*State) (HookAction, error)
}

Hook is the interface that must be implemented to hook into various parts of Terraform, allowing you to inspect or change behavior at runtime.

There are MANY hook points into Terraform. If you only want to implement some hook points, but not all (which is the likely case), then embed the NilHook into your struct, which implements all of the interface but does nothing. Then, override only the functions you want to implement.

type HookAction 

type HookAction byte

HookAction is an enum of actions that can be taken as a result of a hook callback. This allows you to modify the behavior of Terraform at runtime. 

const (
	// HookActionContinue continues with processing as usual.
	HookActionContinue HookAction = iota

	// HookActionHalt halts immediately: no more hooks are processed
	// and the action that Terraform was about to take is cancelled.
	HookActionHalt
)

type InputMode added in v0.3.0 

type InputMode byte

InputMode defines what sort of input will be asked for when Input is called on Context. 

const (
	// InputModeVar asks for all variables
	InputModeVar InputMode = 1 << iota

	// InputModeVarUnset asks for variables which are not set yet
	InputModeVarUnset

	// InputModeProvider asks for provider variables
	InputModeProvider

	// InputModeStd is the standard operating mode and asks for both variables
	// and providers.
	InputModeStd = InputModeVar | InputModeProvider
)

type InputOpts added in v0.3.0 

type InputOpts struct {
	// Id is a unique ID for the question being asked that might be
	// used for logging or to look up a prior answered question.
	Id string

	// Query is a human-friendly question for inputting this value.
	Query string

	// Description is a description about what this option is. Be wary
	// that this will probably be in a terminal so split lines as you see
	// necessary.
	Description string

	// Default will be the value returned if no data is entered.
	Default string
}

InputOpts are options for asking for input.

type InstanceDiff added in v0.3.0 

type InstanceDiff struct {
	Attributes     map[string]*ResourceAttrDiff
	Destroy        bool
	DestroyTainted bool
}

InstanceDiff is the diff of a resource from some state to another.

func (*InstanceDiff) ChangeType added in v0.3.0 

func (d *InstanceDiff) ChangeType() DiffChangeType

ChangeType returns the DiffChangeType represented by the diff for this single instance.

func (*InstanceDiff) Empty added in v0.3.0 

func (d *InstanceDiff) Empty() bool

Empty returns true if this diff encapsulates no changes.

func (*InstanceDiff) GoString added in v0.4.0 

func (d *InstanceDiff) GoString() string

func (*InstanceDiff) RequiresNew added in v0.3.0 

func (d *InstanceDiff) RequiresNew() bool

RequiresNew returns true if the diff requires the creation of a new resource (implying the destruction of the old).

func (*InstanceDiff) Same added in v0.3.0 

func (d *InstanceDiff) Same(d2 *InstanceDiff) (bool, string)

Same checks whether or not two InstanceDiff's are the "same". When we say "same", it is not necessarily exactly equal. Instead, it is just checking that the same attributes are changing, a destroy isn't suddenly happening, etc.

type InstanceInfo added in v0.3.0 

type InstanceInfo struct {
	// Id is a unique name to represent this instance. This is not related
	// to InstanceState.ID in any way.
	Id string

	// ModulePath is the complete path of the module containing this
	// instance.
	ModulePath []string

	// Type is the resource type of this instance
	Type string
}

InstanceInfo is used to hold information about the instance and/or resource being modified.

func (*InstanceInfo) HumanId added in v0.3.0 

func (i *InstanceInfo) HumanId() string

HumanId is a unique Id that is human-friendly and useful for UI elements.

type InstanceState added in v0.3.0 

type InstanceState struct {
	// A unique ID for this resource. This is opaque to Terraform
	// and is only meant as a lookup mechanism for the providers.
	ID string `json:"id"`

	// Attributes are basic information about the resource. Any keys here
	// are accessible in variable format within Terraform configurations:
	// ${resourcetype.name.attribute}.
	Attributes map[string]string `json:"attributes,omitempty"`

	// Ephemeral is used to store any state associated with this instance
	// that is necessary for the Terraform run to complete, but is not
	// persisted to a state file.
	Ephemeral EphemeralState `json:"-"`

	// Meta is a simple K/V map that is persisted to the State but otherwise
	// ignored by Terraform core. It's meant to be used for accounting by
	// external client code.
	Meta map[string]string `json:"meta,omitempty"`
}

InstanceState is used to track the unique state information belonging to a given instance.

func (*InstanceState) Empty added in v0.4.0 

func (s *InstanceState) Empty() bool

func (*InstanceState) Equal added in v0.4.0 

func (s *InstanceState) Equal(other *InstanceState) bool

func (*InstanceState) GoString added in v0.3.0 

func (i *InstanceState) GoString() string

func (*InstanceState) MergeDiff added in v0.3.0 

func (s *InstanceState) MergeDiff(d *InstanceDiff) *InstanceState

MergeDiff takes a ResourceDiff and merges the attributes into this resource state in order to generate a new state. This new state can be used to provide updated attribute lookups for variable interpolation.

If the diff attribute requires computing the value, and hence won't be available until apply, the value is replaced with the computeID.

func (*InstanceState) String added in v0.3.0 

func (i *InstanceState) String() string

type InstanceType added in v0.4.0 

type InstanceType int

InstanceType is an enum of the various types of instances store in the State 

const (
	TypeInvalid InstanceType = iota
	TypePrimary
	TypeTainted
	TypeDeposed
)

func ParseInstanceType added in v0.4.0 

func ParseInstanceType(s string) (InstanceType, error)

func (InstanceType) String added in v0.4.0 

func (i InstanceType) String() string

type Interpolater added in v0.4.0 

type Interpolater struct {
	Operation     walkOperation
	Module        *module.Tree
	State         *State
	StateLock     *sync.RWMutex
	Variables     map[string]string
	VariablesLock *sync.Mutex
}

Interpolater is the structure responsible for determining the values for interpolations such as `aws_instance.foo.bar`.

func (*Interpolater) Values added in v0.4.0 

func (i *Interpolater) Values(
	scope *InterpolationScope,
	vars map[string]config.InterpolatedVariable) (map[string]ast.Variable, error)

Values returns the values for all the variables in the given map.

type InterpolationScope added in v0.4.0 

type InterpolationScope struct {
	Path     []string
	Resource *Resource
}

InterpolationScope is the current scope of execution. This is required since some variables which are interpolated are dependent on what we're operating on and where we are.

type MissingProviderTransformer added in v0.4.0 

type MissingProviderTransformer struct {
	// Providers is the list of providers we support.
	Providers []string
}

MissingProviderTransformer is a GraphTransformer that adds nodes for missing providers into the graph. Specifically, it creates provider configuration nodes for all the providers that we support. These are pruned later during an optimization pass.

func (*MissingProviderTransformer) Transform added in v0.4.0 

func (t *MissingProviderTransformer) Transform(g *Graph) error

type MissingProvisionerTransformer added in v0.4.0 

type MissingProvisionerTransformer struct {
	// Provisioners is the list of provisioners we support.
	Provisioners []string
}

MissingProvisionerTransformer is a GraphTransformer that adds nodes for missing provisioners into the graph.

func (*MissingProvisionerTransformer) Transform added in v0.4.0 

func (t *MissingProvisionerTransformer) Transform(g *Graph) error

type MockEvalContext added in v0.4.0 

type MockEvalContext struct {
	HookCalled bool
	HookHook   Hook
	HookError  error

	InputCalled bool
	InputInput  UIInput

	InitProviderCalled   bool
	InitProviderName     string
	InitProviderProvider ResourceProvider
	InitProviderError    error

	ProviderCalled   bool
	ProviderName     string
	ProviderProvider ResourceProvider

	CloseProviderCalled   bool
	CloseProviderName     string
	CloseProviderProvider ResourceProvider

	ProviderInputCalled bool
	ProviderInputName   string
	ProviderInputConfig map[string]interface{}

	SetProviderInputCalled bool
	SetProviderInputName   string
	SetProviderInputConfig map[string]interface{}

	ConfigureProviderCalled bool
	ConfigureProviderName   string
	ConfigureProviderConfig *ResourceConfig
	ConfigureProviderError  error

	SetProviderConfigCalled bool
	SetProviderConfigName   string
	SetProviderConfigConfig *ResourceConfig

	ParentProviderConfigCalled bool
	ParentProviderConfigName   string
	ParentProviderConfigConfig *ResourceConfig

	InitProvisionerCalled      bool
	InitProvisionerName        string
	InitProvisionerProvisioner ResourceProvisioner
	InitProvisionerError       error

	ProvisionerCalled      bool
	ProvisionerName        string
	ProvisionerProvisioner ResourceProvisioner

	CloseProvisionerCalled      bool
	CloseProvisionerName        string
	CloseProvisionerProvisioner ResourceProvisioner

	InterpolateCalled       bool
	InterpolateConfig       *config.RawConfig
	InterpolateResource     *Resource
	InterpolateConfigResult *ResourceConfig
	InterpolateError        error

	PathCalled bool
	PathPath   []string

	SetVariablesCalled    bool
	SetVariablesModule    string
	SetVariablesVariables map[string]string

	DiffCalled bool
	DiffDiff   *Diff
	DiffLock   *sync.RWMutex

	StateCalled bool
	StateState  *State
	StateLock   *sync.RWMutex
}

MockEvalContext is a mock version of EvalContext that can be used for tests.

func (*MockEvalContext) CloseProvider added in v0.6.0 

func (c *MockEvalContext) CloseProvider(n string) error

func (*MockEvalContext) CloseProvisioner added in v0.6.0 

func (c *MockEvalContext) CloseProvisioner(n string) error

func (*MockEvalContext) ConfigureProvider added in v0.4.0 

func (c *MockEvalContext) ConfigureProvider(n string, cfg *ResourceConfig) error

func (*MockEvalContext) Diff added in v0.4.0 

func (c *MockEvalContext) Diff() (*Diff, *sync.RWMutex)

func (*MockEvalContext) Hook added in v0.4.0 

func (c *MockEvalContext) Hook(fn func(Hook) (HookAction, error)) error

func (*MockEvalContext) InitProvider added in v0.4.0 

func (c *MockEvalContext) InitProvider(n string) (ResourceProvider, error)

func (*MockEvalContext) InitProvisioner added in v0.4.0 

func (c *MockEvalContext) InitProvisioner(n string) (ResourceProvisioner, error)

func (*MockEvalContext) Input added in v0.4.0 

func (c *MockEvalContext) Input() UIInput

func (*MockEvalContext) Interpolate added in v0.4.0 

func (c *MockEvalContext) Interpolate(
	config *config.RawConfig, resource *Resource) (*ResourceConfig, error)

func (*MockEvalContext) ParentProviderConfig added in v0.4.0 

func (c *MockEvalContext) ParentProviderConfig(n string) *ResourceConfig

func (*MockEvalContext) Path added in v0.4.0 

func (c *MockEvalContext) Path() []string

func (*MockEvalContext) Provider added in v0.4.0 

func (c *MockEvalContext) Provider(n string) ResourceProvider

func (*MockEvalContext) ProviderInput added in v0.4.0 

func (c *MockEvalContext) ProviderInput(n string) map[string]interface{}

func (*MockEvalContext) Provisioner added in v0.4.0 

func (c *MockEvalContext) Provisioner(n string) ResourceProvisioner

func (*MockEvalContext) SetProviderConfig added in v0.4.1 

func (c *MockEvalContext) SetProviderConfig(
	n string, cfg *ResourceConfig) error

func (*MockEvalContext) SetProviderInput added in v0.4.0 

func (c *MockEvalContext) SetProviderInput(n string, cfg map[string]interface{})

func (*MockEvalContext) SetVariables added in v0.4.0 

func (c *MockEvalContext) SetVariables(n string, vs map[string]string)

func (*MockEvalContext) State added in v0.4.0 

func (c *MockEvalContext) State() (*State, *sync.RWMutex)

type MockHook 

type MockHook struct {
	PreApplyCalled bool
	PreApplyInfo   *InstanceInfo
	PreApplyDiff   *InstanceDiff
	PreApplyState  *InstanceState
	PreApplyReturn HookAction
	PreApplyError  error

	PostApplyCalled      bool
	PostApplyInfo        *InstanceInfo
	PostApplyState       *InstanceState
	PostApplyError       error
	PostApplyReturn      HookAction
	PostApplyReturnError error

	PreDiffCalled bool
	PreDiffInfo   *InstanceInfo
	PreDiffState  *InstanceState
	PreDiffReturn HookAction
	PreDiffError  error

	PostDiffCalled bool
	PostDiffInfo   *InstanceInfo
	PostDiffDiff   *InstanceDiff
	PostDiffReturn HookAction
	PostDiffError  error

	PreProvisionResourceCalled bool
	PreProvisionResourceInfo   *InstanceInfo
	PreProvisionInstanceState  *InstanceState
	PreProvisionResourceReturn HookAction
	PreProvisionResourceError  error

	PostProvisionResourceCalled bool
	PostProvisionResourceInfo   *InstanceInfo
	PostProvisionInstanceState  *InstanceState
	PostProvisionResourceReturn HookAction
	PostProvisionResourceError  error

	PreProvisionCalled        bool
	PreProvisionInfo          *InstanceInfo
	PreProvisionProvisionerId string
	PreProvisionReturn        HookAction
	PreProvisionError         error

	PostProvisionCalled        bool
	PostProvisionInfo          *InstanceInfo
	PostProvisionProvisionerId string
	PostProvisionReturn        HookAction
	PostProvisionError         error

	ProvisionOutputCalled        bool
	ProvisionOutputInfo          *InstanceInfo
	ProvisionOutputProvisionerId string
	ProvisionOutputMessage       string

	PostRefreshCalled bool
	PostRefreshInfo   *InstanceInfo
	PostRefreshState  *InstanceState
	PostRefreshReturn HookAction
	PostRefreshError  error

	PreRefreshCalled bool
	PreRefreshInfo   *InstanceInfo
	PreRefreshState  *InstanceState
	PreRefreshReturn HookAction
	PreRefreshError  error

	PostStateUpdateCalled bool
	PostStateUpdateState  *State
	PostStateUpdateReturn HookAction
	PostStateUpdateError  error
}

MockHook is an implementation of Hook that can be used for tests. It records all of its function calls.

func (*MockHook) PostApply 

func (h *MockHook) PostApply(n *InstanceInfo, s *InstanceState, e error) (HookAction, error)

func (*MockHook) PostDiff 

func (h *MockHook) PostDiff(n *InstanceInfo, d *InstanceDiff) (HookAction, error)

func (*MockHook) PostProvision 

func (h *MockHook) PostProvision(n *InstanceInfo, provId string) (HookAction, error)

func (*MockHook) PostProvisionResource 

func (h *MockHook) PostProvisionResource(n *InstanceInfo, s *InstanceState) (HookAction, error)

func (*MockHook) PostRefresh 

func (h *MockHook) PostRefresh(n *InstanceInfo, s *InstanceState) (HookAction, error)

func (*MockHook) PostStateUpdate added in v0.4.0 

func (h *MockHook) PostStateUpdate(s *State) (HookAction, error)

func (*MockHook) PreApply 

func (h *MockHook) PreApply(n *InstanceInfo, s *InstanceState, d *InstanceDiff) (HookAction, error)

func (*MockHook) PreDiff 

func (h *MockHook) PreDiff(n *InstanceInfo, s *InstanceState) (HookAction, error)

func (*MockHook) PreProvision 

func (h *MockHook) PreProvision(n *InstanceInfo, provId string) (HookAction, error)

func (*MockHook) PreProvisionResource 

func (h *MockHook) PreProvisionResource(n *InstanceInfo, s *InstanceState) (HookAction, error)

func (*MockHook) PreRefresh 

func (h *MockHook) PreRefresh(n *InstanceInfo, s *InstanceState) (HookAction, error)

func (*MockHook) ProvisionOutput added in v0.3.0 

func (h *MockHook) ProvisionOutput(
	n *InstanceInfo,
	provId string,
	msg string)

type MockResourceProvider 

type MockResourceProvider struct {
	sync.Mutex

	// Anything you want, in case you need to store extra data with the mock.
	Meta interface{}

	CloseCalled                  bool
	CloseError                   error
	InputCalled                  bool
	InputInput                   UIInput
	InputConfig                  *ResourceConfig
	InputReturnConfig            *ResourceConfig
	InputReturnError             error
	InputFn                      func(UIInput, *ResourceConfig) (*ResourceConfig, error)
	ApplyCalled                  bool
	ApplyInfo                    *InstanceInfo
	ApplyState                   *InstanceState
	ApplyDiff                    *InstanceDiff
	ApplyFn                      func(*InstanceInfo, *InstanceState, *InstanceDiff) (*InstanceState, error)
	ApplyReturn                  *InstanceState
	ApplyReturnError             error
	ConfigureCalled              bool
	ConfigureConfig              *ResourceConfig
	ConfigureFn                  func(*ResourceConfig) error
	ConfigureReturnError         error
	DiffCalled                   bool
	DiffInfo                     *InstanceInfo
	DiffState                    *InstanceState
	DiffDesired                  *ResourceConfig
	DiffFn                       func(*InstanceInfo, *InstanceState, *ResourceConfig) (*InstanceDiff, error)
	DiffReturn                   *InstanceDiff
	DiffReturnError              error
	RefreshCalled                bool
	RefreshInfo                  *InstanceInfo
	RefreshState                 *InstanceState
	RefreshFn                    func(*InstanceInfo, *InstanceState) (*InstanceState, error)
	RefreshReturn                *InstanceState
	RefreshReturnError           error
	ResourcesCalled              bool
	ResourcesReturn              []ResourceType
	ValidateCalled               bool
	ValidateConfig               *ResourceConfig
	ValidateFn                   func(*ResourceConfig) ([]string, []error)
	ValidateReturnWarns          []string
	ValidateReturnErrors         []error
	ValidateResourceFn           func(string, *ResourceConfig) ([]string, []error)
	ValidateResourceCalled       bool
	ValidateResourceType         string
	ValidateResourceConfig       *ResourceConfig
	ValidateResourceReturnWarns  []string
	ValidateResourceReturnErrors []error
}

MockResourceProvider implements ResourceProvider but mocks out all the calls for testing purposes.

func (*MockResourceProvider) Apply 

func (p *MockResourceProvider) Apply(
	info *InstanceInfo,
	state *InstanceState,
	diff *InstanceDiff) (*InstanceState, error)

func (*MockResourceProvider) Close added in v0.6.0 

func (p *MockResourceProvider) Close() error

func (*MockResourceProvider) Configure 

func (p *MockResourceProvider) Configure(c *ResourceConfig) error

func (*MockResourceProvider) Diff 

func (p *MockResourceProvider) Diff(
	info *InstanceInfo,
	state *InstanceState,
	desired *ResourceConfig) (*InstanceDiff, error)

func (*MockResourceProvider) Input added in v0.3.0 

func (p *MockResourceProvider) Input(
	input UIInput, c *ResourceConfig) (*ResourceConfig, error)

func (*MockResourceProvider) Refresh 

func (p *MockResourceProvider) Refresh(
	info *InstanceInfo,
	s *InstanceState) (*InstanceState, error)

func (*MockResourceProvider) Resources 

func (p *MockResourceProvider) Resources() []ResourceType

func (*MockResourceProvider) Validate 

func (p *MockResourceProvider) Validate(c *ResourceConfig) ([]string, []error)

func (*MockResourceProvider) ValidateResource 

func (p *MockResourceProvider) ValidateResource(t string, c *ResourceConfig) ([]string, []error)

type MockResourceProvisioner 

type MockResourceProvisioner struct {
	// Anything you want, in case you need to store extra data with the mock.
	Meta interface{}

	ApplyCalled      bool
	ApplyOutput      UIOutput
	ApplyState       *InstanceState
	ApplyConfig      *ResourceConfig
	ApplyFn          func(*InstanceState, *ResourceConfig) error
	ApplyReturnError error

	ValidateCalled       bool
	ValidateConfig       *ResourceConfig
	ValidateFn           func(c *ResourceConfig) ([]string, []error)
	ValidateReturnWarns  []string
	ValidateReturnErrors []error
}

MockResourceProvisioner implements ResourceProvisioner but mocks out all the calls for testing purposes.

func (*MockResourceProvisioner) Apply 

func (p *MockResourceProvisioner) Apply(
	output UIOutput,
	state *InstanceState,
	c *ResourceConfig) error

func (*MockResourceProvisioner) Validate 

func (p *MockResourceProvisioner) Validate(c *ResourceConfig) ([]string, []error)

type MockUIInput added in v0.3.0 

type MockUIInput struct {
	InputCalled       bool
	InputOpts         *InputOpts
	InputReturnMap    map[string]string
	InputReturnString string
	InputReturnError  error
	InputFn           func(*InputOpts) (string, error)
}

MockUIInput is an implementation of UIInput that can be used for tests.

func (*MockUIInput) Input added in v0.3.0 

func (i *MockUIInput) Input(opts *InputOpts) (string, error)

type MockUIOutput added in v0.3.0 

type MockUIOutput struct {
	OutputCalled  bool
	OutputMessage string
	OutputFn      func(string)
}

MockUIOutput is an implementation of UIOutput that can be used for tests.

func (*MockUIOutput) Output added in v0.3.0 

func (o *MockUIOutput) Output(v string)

type ModuleDestroyTransformer added in v0.5.0 

type ModuleDestroyTransformer struct{}

ModuleDestroyTransformer is a GraphTransformer that adds a node to the graph that will just mark the full module for destroy in the destroy scenario.

func (*ModuleDestroyTransformer) Transform added in v0.5.0 

func (t *ModuleDestroyTransformer) Transform(g *Graph) error

type ModuleDiff added in v0.3.0 

type ModuleDiff struct {
	Path      []string
	Resources map[string]*InstanceDiff
	Destroy   bool // Set only by the destroy plan
}

ModuleDiff tracks the differences between resources to apply within a single module.

func (*ModuleDiff) ChangeType added in v0.3.0 

func (d *ModuleDiff) ChangeType() DiffChangeType

ChangeType returns the type of changes that the diff for this module includes.

At a module level, this will only be DiffNone, DiffUpdate, DiffDestroy, or DiffCreate. If an instance within the module has a DiffDestroyCreate then this will register as a DiffCreate for a module.

func (*ModuleDiff) Empty added in v0.3.0 

func (d *ModuleDiff) Empty() bool

Empty returns true if the diff has no changes within this module.

func (*ModuleDiff) Instances added in v0.3.0 

func (d *ModuleDiff) Instances(id string) []*InstanceDiff

Instances returns the instance diffs for the id given. This can return multiple instance diffs if there are counts within the resource.

func (*ModuleDiff) IsRoot added in v0.3.0 

func (d *ModuleDiff) IsRoot() bool

IsRoot says whether or not this module diff is for the root module.

func (*ModuleDiff) String added in v0.3.0 

func (d *ModuleDiff) String() string

String outputs the diff in a long but command-line friendly output format that users can read to quickly inspect a diff.

type ModuleState added in v0.3.0 

type ModuleState struct {
	// Path is the import path from the root module. Modules imports are
	// always disjoint, so the path represents amodule tree
	Path []string `json:"path"`

	// Outputs declared by the module and maintained for each module
	// even though only the root module technically needs to be kept.
	// This allows operators to inspect values at the boundaries.
	Outputs map[string]string `json:"outputs"`

	// Resources is a mapping of the logically named resource to
	// the state of the resource. Each resource may actually have
	// N instances underneath, although a user only needs to think
	// about the 1:1 case.
	Resources map[string]*ResourceState `json:"resources"`

	// Dependencies are a list of things that this module relies on
	// existing to remain intact. For example: an module may depend
	// on a VPC ID given by an aws_vpc resource.
	//
	// Terraform uses this information to build valid destruction
	// orders and to warn the user if they're destroying a module that
	// another resource depends on.
	//
	// Things can be put into this list that may not be managed by
	// Terraform. If Terraform doesn't find a matching ID in the
	// overall state, then it assumes it isn't managed and doesn't
	// worry about it.
	Dependencies []string `json:"depends_on,omitempty"`
}

ModuleState is used to track all the state relevant to a single module. Previous to Terraform 0.3, all state belonged to the "root" module.

func (*ModuleState) Equal added in v0.4.0 

func (m *ModuleState) Equal(other *ModuleState) bool

Equal tests whether one module state is equal to another.

func (*ModuleState) GoString added in v0.3.0 

func (m *ModuleState) GoString() string

func (*ModuleState) IsRoot added in v0.3.0 

func (m *ModuleState) IsRoot() bool

IsRoot says whether or not this module diff is for the root module.

func (*ModuleState) Orphans added in v0.3.0 

func (m *ModuleState) Orphans(c *config.Config) []string

Orphans returns a list of keys of resources that are in the State but aren't present in the configuration itself. Hence, these keys represent the state of resources that are orphans.

func (*ModuleState) String added in v0.3.0 

func (m *ModuleState) String() string

func (*ModuleState) View added in v0.3.0 

func (m *ModuleState) View(id string) *ModuleState

View returns a view with the given resource prefix.

type NilHook 

type NilHook struct{}

NilHook is a Hook implementation that does nothing. It exists only to simplify implementing hooks. You can embed this into your Hook implementation and only implement the functions you are interested in.

func (*NilHook) PostApply 

func (*NilHook) PostApply(*InstanceInfo, *InstanceState, error) (HookAction, error)

func (*NilHook) PostDiff 

func (*NilHook) PostDiff(*InstanceInfo, *InstanceDiff) (HookAction, error)

func (*NilHook) PostProvision 

func (*NilHook) PostProvision(*InstanceInfo, string) (HookAction, error)

func (*NilHook) PostProvisionResource 

func (*NilHook) PostProvisionResource(*InstanceInfo, *InstanceState) (HookAction, error)

func (*NilHook) PostRefresh 

func (*NilHook) PostRefresh(*InstanceInfo, *InstanceState) (HookAction, error)

func (*NilHook) PostStateUpdate added in v0.4.0 

func (*NilHook) PostStateUpdate(*State) (HookAction, error)

func (*NilHook) PreApply 

func (*NilHook) PreApply(*InstanceInfo, *InstanceState, *InstanceDiff) (HookAction, error)

func (*NilHook) PreDiff 

func (*NilHook) PreDiff(*InstanceInfo, *InstanceState) (HookAction, error)

func (*NilHook) PreProvision 

func (*NilHook) PreProvision(*InstanceInfo, string) (HookAction, error)

func (*NilHook) PreProvisionResource 

func (*NilHook) PreProvisionResource(*InstanceInfo, *InstanceState) (HookAction, error)

func (*NilHook) PreRefresh 

func (*NilHook) PreRefresh(*InstanceInfo, *InstanceState) (HookAction, error)

func (*NilHook) ProvisionOutput added in v0.3.0 

func (*NilHook) ProvisionOutput(
	*InstanceInfo, string, string)

type NoopOpts added in v0.6.1 

type NoopOpts struct {
	Graph    *Graph
	Vertex   dag.Vertex
	Diff     *Diff
	State    *State
	ModDiff  *ModuleDiff
	ModState *ModuleState
}

NoopOpts are the options available to determine if your node is a noop.

type NullGraphWalker added in v0.4.0 

type NullGraphWalker struct{}

NullGraphWalker is a GraphWalker implementation that does nothing. This can be embedded within other GraphWalker implementations for easily implementing all the required functions.

func (NullGraphWalker) EnterEvalTree added in v0.4.0 

func (NullGraphWalker) EnterEvalTree(v dag.Vertex, n EvalNode) EvalNode

func (NullGraphWalker) EnterPath added in v0.5.0 

func (NullGraphWalker) EnterPath([]string) EvalContext

func (NullGraphWalker) EnterVertex added in v0.4.0 

func (NullGraphWalker) EnterVertex(dag.Vertex)

func (NullGraphWalker) ExitEvalTree added in v0.4.0 

func (NullGraphWalker) ExitEvalTree(dag.Vertex, interface{}, error) error

func (NullGraphWalker) ExitPath added in v0.5.0 

func (NullGraphWalker) ExitPath([]string)

func (NullGraphWalker) ExitVertex added in v0.4.0 

func (NullGraphWalker) ExitVertex(dag.Vertex, error)

type OrphanTransformer added in v0.4.0 

type OrphanTransformer struct {
	// State is the global state. We require the global state to
	// properly find module orphans at our path.
	State *State

	// Module is the root module. We'll look up the proper configuration
	// using the graph path.
	Module *module.Tree

	// View, if non-nil will set a view on the module state.
	View string
}

OrphanTransformer is a GraphTransformer that adds orphans to the graph. This transformer adds both resource and module orphans.

func (*OrphanTransformer) Transform added in v0.4.0 

func (t *OrphanTransformer) Transform(g *Graph) error

type Plan 

type Plan struct {
	Diff    *Diff
	Module  *module.Tree
	State   *State
	Vars    map[string]string
	Targets []string
	// contains filtered or unexported fields
}

Plan represents a single Terraform execution plan, which contains all the information necessary to make an infrastructure change.

func ReadPlan 

func ReadPlan(src io.Reader) (*Plan, error)

ReadPlan reads a plan structure out of a reader in the format that was written by WritePlan.

func (*Plan) Context 

func (p *Plan) Context(opts *ContextOpts) *Context

Context returns a Context with the data encapsulated in this plan.

The following fields in opts are overridden by the plan: Config, Diff, State, Variables.

func (*Plan) String 

func (p *Plan) String() string

type PrefixUIInput added in v0.3.0 

type PrefixUIInput struct {
	IdPrefix    string
	QueryPrefix string
	UIInput     UIInput
}

PrefixUIInput is an implementation of UIInput that prefixes the ID with a string, allowing queries to be namespaced.

func (*PrefixUIInput) Input added in v0.3.0 

func (i *PrefixUIInput) Input(opts *InputOpts) (string, error)

type ProviderTransformer added in v0.4.0 

type ProviderTransformer struct{}

ProviderTransformer is a GraphTransformer that maps resources to providers within the graph. This will error if there are any resources that don't map to proper resources.

func (*ProviderTransformer) Transform added in v0.4.0 

func (t *ProviderTransformer) Transform(g *Graph) error

type ProvisionerTransformer added in v0.4.0 

type ProvisionerTransformer struct{}

ProvisionerTransformer is a GraphTransformer that maps resources to provisioners within the graph. This will error if there are any resources that don't map to proper resources.

func (*ProvisionerTransformer) Transform added in v0.4.0 

func (t *ProvisionerTransformer) Transform(g *Graph) error

type ProvisionerUIOutput added in v0.3.0 

type ProvisionerUIOutput struct {
	Info  *InstanceInfo
	Type  string
	Hooks []Hook
}

ProvisionerUIOutput is an implementation of UIOutput that calls a hook for the output so that the hooks can handle it.

func (*ProvisionerUIOutput) Output added in v0.3.0 

func (o *ProvisionerUIOutput) Output(msg string)

type ProxyTransformer added in v0.5.0 

type ProxyTransformer struct{}

ProxyTransformer is a transformer that goes through the graph, finds vertices that are marked as proxies, and connects through their dependents. See above for what a proxy is.

func (*ProxyTransformer) Transform added in v0.5.0 

func (t *ProxyTransformer) Transform(g *Graph) error

type PruneDestroyTransformer added in v0.4.0 

type PruneDestroyTransformer struct {
	Diff  *Diff
	State *State
}

PruneDestroyTransformer is a GraphTransformer that removes the destroy nodes that aren't in the diff.

func (*PruneDestroyTransformer) Transform added in v0.4.0 

func (t *PruneDestroyTransformer) Transform(g *Graph) error

type PruneNoopTransformer added in v0.6.1 

type PruneNoopTransformer struct {
	Diff  *Diff
	State *State
}

PruneNoopTransformer is a graph transform that prunes nodes that consider themselves no-ops. This is done to both simplify the graph as well as to remove graph nodes that might otherwise cause problems during the graph run. Therefore, this transformer isn't completely an optimization step, and can instead be considered critical to Terraform operations.

Example of the above case: variables for modules interpolate their values. Interpolation will fail on destruction (since attributes are being deleted), but variables shouldn't even eval if there is nothing that will consume the variable. Therefore, variables can note that they can be omitted safely in this case.

The PruneNoopTransformer will prune nodes depth first, and will automatically create connect through the dependencies of pruned nodes. For example, if we have a graph A => B => C (A depends on B, etc.), and B decides to be removed, we'll still be left with A => C; the edge will be properly connected.

func (*PruneNoopTransformer) Transform added in v0.6.1 

func (t *PruneNoopTransformer) Transform(g *Graph) error

type PruneProviderTransformer added in v0.4.0 

type PruneProviderTransformer struct{}

PruneProviderTransformer is a GraphTransformer that prunes all the providers that aren't needed from the graph. A provider is unneeded if no resource or module is using that provider.

func (*PruneProviderTransformer) Transform added in v0.4.0 

func (t *PruneProviderTransformer) Transform(g *Graph) error

type RemoteState added in v0.3.5 

type RemoteState struct {
	// Type controls the client we use for the remote state
	Type string `json:"type"`

	// Config is used to store arbitrary configuration that
	// is type specific
	Config map[string]string `json:"config"`
}

RemoteState is used to track the information about a remote state store that we push/pull state to.

func (*RemoteState) Empty added in v0.3.5 

func (r *RemoteState) Empty() bool

func (*RemoteState) Equals added in v0.3.5 

func (r *RemoteState) Equals(other *RemoteState) bool

func (*RemoteState) GoString added in v0.4.0 

func (r *RemoteState) GoString() string

type Resource 

type Resource struct {
	// These are all used by the new EvalNode stuff.
	Name       string
	Type       string
	CountIndex int

	// These aren't really used anymore anywhere, but we keep them around
	// since we haven't done a proper cleanup yet.
	Id           string
	Info         *InstanceInfo
	Config       *ResourceConfig
	Dependencies []string
	Diff         *InstanceDiff
	Provider     ResourceProvider
	State        *InstanceState
	Provisioners []*ResourceProvisionerConfig
	Flags        ResourceFlag
	TaintedIndex int
}

Resource encapsulates a resource, its configuration, its provider, its current state, and potentially a desired diff from the state it wants to reach.

type ResourceAddress added in v0.4.0 

type ResourceAddress struct {
	// Addresses a resource falling somewhere in the module path
	// When specified alone, addresses all resources within a module path
	Path []string

	// Addresses a specific resource that occurs in a list
	Index int

	InstanceType InstanceType
	Name         string
	Type         string
}

ResourceAddress is a way of identifying an individual resource (or, eventually, a subset of resources) within the state. It is used for Targets.

func ParseResourceAddress added in v0.4.0 

func ParseResourceAddress(s string) (*ResourceAddress, error)

func (*ResourceAddress) Copy added in v0.6.12 

func (r *ResourceAddress) Copy() *ResourceAddress

Copy returns a copy of this ResourceAddress

func (*ResourceAddress) Equals added in v0.4.0 

func (addr *ResourceAddress) Equals(raw interface{}) bool

type ResourceAttrDiff 

type ResourceAttrDiff struct {
	Old         string      // Old Value
	New         string      // New Value
	NewComputed bool        // True if new value is computed (unknown currently)
	NewRemoved  bool        // True if this attribute is being removed
	NewExtra    interface{} // Extra information for the provider
	RequiresNew bool        // True if change requires new resource
	Type        DiffAttrType
}

ResourceAttrDiff is the diff of a single attribute of a resource.

func (*ResourceAttrDiff) Empty added in v0.6.14 

func (d *ResourceAttrDiff) Empty() bool

Empty returns true if the diff for this attr is neutral

func (*ResourceAttrDiff) GoString 

func (d *ResourceAttrDiff) GoString() string

type ResourceConfig 

type ResourceConfig struct {
	ComputedKeys []string
	Raw          map[string]interface{}
	Config       map[string]interface{}
	// contains filtered or unexported fields
}

ResourceConfig holds the configuration given for a resource. This is done instead of a raw `map[string]interface{}` type so that rich methods can be added to it to make dealing with it easier.

func NewResourceConfig 

func NewResourceConfig(c *config.RawConfig) *ResourceConfig

NewResourceConfig creates a new ResourceConfig from a config.RawConfig.

func (*ResourceConfig) CheckSet 

func (c *ResourceConfig) CheckSet(keys []string) []error

CheckSet checks that the given list of configuration keys is properly set. If not, errors are returned for each unset key.

This is useful to be called in the Validate method of a ResourceProvider.

func (*ResourceConfig) Get 

func (c *ResourceConfig) Get(k string) (interface{}, bool)

Get looks up a configuration value by key and returns the value.

The second return value is true if the get was successful. Get will not succeed if the value is being computed.

func (*ResourceConfig) GetRaw added in v0.5.0 

func (c *ResourceConfig) GetRaw(k string) (interface{}, bool)

GetRaw looks up a configuration value by key and returns the value, from the raw, uninterpolated config.

The second return value is true if the get was successful. Get will not succeed if the value is being computed.

func (*ResourceConfig) IsComputed added in v0.3.0 

func (c *ResourceConfig) IsComputed(k string) bool

IsComputed returns whether the given key is computed or not.

func (*ResourceConfig) IsSet 

func (c *ResourceConfig) IsSet(k string) bool

IsSet checks if the key in the configuration is set. A key is set if it has a value or the value is being computed (is unknown currently).

This function should be used rather than checking the keys of the raw configuration itself, since a key may be omitted from the raw configuration if it is being computed.

type ResourceCountTransformer added in v0.4.0 

type ResourceCountTransformer struct {
	Resource *config.Resource
	Destroy  bool
	Targets  []ResourceAddress
}

ResourceCountTransformer is a GraphTransformer that expands the count out for a specific resource.

func (*ResourceCountTransformer) Transform added in v0.4.0 

func (t *ResourceCountTransformer) Transform(g *Graph) error

type ResourceDependency 

type ResourceDependency struct {
	// ID of the resource that we depend on. This ID should map
	// directly to another ResourceState's ID.
	ID string
}

ResourceDependency maps a resource to another resource that it depends on to remain intact and uncorrupted.

type ResourceFlag added in v0.3.0 

type ResourceFlag byte

ResourceKind specifies what kind of instance we're working with, whether its a primary instance, a tainted instance, or an orphan. 

const (
	FlagPrimary ResourceFlag = 1 << iota
	FlagTainted
	FlagOrphan
	FlagHasTainted
	FlagReplacePrimary
	FlagDeposed
)

type ResourceProvider 

type ResourceProvider interface {
	// Input is called to ask the provider to ask the user for input
	// for completing the configuration if necesarry.
	//
	// This may or may not be called, so resource provider writers shouldn't
	// rely on this being available to set some default values for validate
	// later. Example of a situation where this wouldn't be called is if
	// the user is not using a TTY.
	Input(UIInput, *ResourceConfig) (*ResourceConfig, error)

	// Validate is called once at the beginning with the raw configuration
	// (no interpolation done) and can return a list of warnings and/or
	// errors.
	//
	// This is called once with the provider configuration only. It may not
	// be called at all if no provider configuration is given.
	//
	// This should not assume that any values of the configurations are valid.
	// The primary use case of this call is to check that required keys are
	// set.
	Validate(*ResourceConfig) ([]string, []error)

	// ValidateResource is called once at the beginning with the raw
	// configuration (no interpolation done) and can return a list of warnings
	// and/or errors.
	//
	// This is called once per resource.
	//
	// This should not assume any of the values in the resource configuration
	// are valid since it is possible they have to be interpolated still.
	// The primary use case of this call is to check that the required keys
	// are set and that the general structure is correct.
	ValidateResource(string, *ResourceConfig) ([]string, []error)

	// Configure configures the provider itself with the configuration
	// given. This is useful for setting things like access keys.
	//
	// This won't be called at all if no provider configuration is given.
	//
	// Configure returns an error if it occurred.
	Configure(*ResourceConfig) error

	// Resources returns all the available resource types that this provider
	// knows how to manage.
	Resources() []ResourceType

	// Apply applies a diff to a specific resource and returns the new
	// resource state along with an error.
	//
	// If the resource state given has an empty ID, then a new resource
	// is expected to be created.
	Apply(
		*InstanceInfo,
		*InstanceState,
		*InstanceDiff) (*InstanceState, error)

	// Diff diffs a resource versus a desired state and returns
	// a diff.
	Diff(
		*InstanceInfo,
		*InstanceState,
		*ResourceConfig) (*InstanceDiff, error)

	// Refresh refreshes a resource and updates all of its attributes
	// with the latest information.
	Refresh(*InstanceInfo, *InstanceState) (*InstanceState, error)
}

ResourceProvider is an interface that must be implemented by any resource provider: the thing that creates and manages the resources in a Terraform configuration.

type ResourceProviderCloser added in v0.6.0 

type ResourceProviderCloser interface {
	Close() error
}

ResourceProviderCloser is an interface that providers that can close connections that aren't needed anymore must implement.

type ResourceProviderFactory 

type ResourceProviderFactory func() (ResourceProvider, error)

ResourceProviderFactory is a function type that creates a new instance of a resource provider.

func ResourceProviderFactoryFixed 

func ResourceProviderFactoryFixed(p ResourceProvider) ResourceProviderFactory

ResourceProviderFactoryFixed is a helper that creates a ResourceProviderFactory that just returns some fixed provider.

type ResourceProvisioner 

type ResourceProvisioner interface {
	// Validate is called once at the beginning with the raw
	// configuration (no interpolation done) and can return a list of warnings
	// and/or errors.
	//
	// This is called once per resource.
	//
	// This should not assume any of the values in the resource configuration
	// are valid since it is possible they have to be interpolated still.
	// The primary use case of this call is to check that the required keys
	// are set and that the general structure is correct.
	Validate(*ResourceConfig) ([]string, []error)

	// Apply runs the provisioner on a specific resource and returns the new
	// resource state along with an error. Instead of a diff, the ResourceConfig
	// is provided since provisioners only run after a resource has been
	// newly created.
	Apply(UIOutput, *InstanceState, *ResourceConfig) error
}

ResourceProvisioner is an interface that must be implemented by any resource provisioner: the thing that initializes resources in a Terraform configuration.

type ResourceProvisionerCloser added in v0.6.0 

type ResourceProvisionerCloser interface {
	Close() error
}

ResourceProvisionerCloser is an interface that provisioners that can close connections that aren't needed anymore must implement.

type ResourceProvisionerConfig 

type ResourceProvisionerConfig struct {
	Type        string
	Provisioner ResourceProvisioner
	Config      *ResourceConfig
	RawConfig   *config.RawConfig
	ConnInfo    *config.RawConfig
}

ResourceProvisionerConfig is used to pair a provisioner with its provided configuration. This allows us to use singleton instances of each ResourceProvisioner and to keep the relevant configuration instead of instantiating a new Provisioner for each resource.

type ResourceProvisionerFactory 

type ResourceProvisionerFactory func() (ResourceProvisioner, error)

ResourceProvisionerFactory is a function type that creates a new instance of a resource provisioner.

type ResourceState 

type ResourceState struct {
	// This is filled in and managed by Terraform, and is the resource
	// type itself such as "mycloud_instance". If a resource provider sets
	// this value, it won't be persisted.
	Type string `json:"type"`

	// Dependencies are a list of things that this resource relies on
	// existing to remain intact. For example: an AWS instance might
	// depend on a subnet (which itself might depend on a VPC, and so
	// on).
	//
	// Terraform uses this information to build valid destruction
	// orders and to warn the user if they're destroying a resource that
	// another resource depends on.
	//
	// Things can be put into this list that may not be managed by
	// Terraform. If Terraform doesn't find a matching ID in the
	// overall state, then it assumes it isn't managed and doesn't
	// worry about it.
	Dependencies []string `json:"depends_on,omitempty"`

	// Primary is the current active instance for this resource.
	// It can be replaced but only after a successful creation.
	// This is the instances on which providers will act.
	Primary *InstanceState `json:"primary"`

	// Tainted is used to track any underlying instances that
	// have been created but are in a bad or unknown state and
	// need to be cleaned up subsequently.  In the
	// standard case, there is only at most a single instance.
	// However, in pathological cases, it is possible for the number
	// of instances to accumulate.
	Tainted []*InstanceState `json:"tainted,omitempty"`

	// Deposed is used in the mechanics of CreateBeforeDestroy: the existing
	// Primary is Deposed to get it out of the way for the replacement Primary to
	// be created by Apply. If the replacement Primary creates successfully, the
	// Deposed instance is cleaned up. If there were problems creating the
	// replacement, the instance remains in the Deposed list so it can be
	// destroyed in a future run. Functionally, Deposed instances are very
	// similar to Tainted instances in that Terraform is only tracking them in
	// order to remember to destroy them.
	Deposed []*InstanceState `json:"deposed,omitempty"`

	// Provider is used when a resource is connected to a provider with an alias.
	// If this string is empty, the resource is connected to the default provider,
	// e.g. "aws_instance" goes with the "aws" provider.
	// If the resource block contained a "provider" key, that value will be set here.
	Provider string `json:"provider,omitempty"`
}

ResourceState holds the state of a resource that is used so that a provider can find and manage an existing resource as well as for storing attributes that are used to populate variables of child resources.

Attributes has attributes about the created resource that are queryable in interpolation: "${type.id.attr}"

Extra is just extra data that a provider can return that we store for later, but is not exposed in any way to the user.

func (*ResourceState) Equal added in v0.4.0 

func (s *ResourceState) Equal(other *ResourceState) bool

Equal tests whether two ResourceStates are equal.

func (*ResourceState) GoString added in v0.2.0 

func (s *ResourceState) GoString() string

func (*ResourceState) String added in v0.3.0 

func (s *ResourceState) String() string

func (*ResourceState) Taint added in v0.4.0 

func (r *ResourceState) Taint()

Taint takes the primary state and marks it as tainted. If there is no primary state, this does nothing.

func (*ResourceState) Untaint added in v0.6.13 

func (r *ResourceState) Untaint(index int) error

Untaint takes a tainted InstanceState and marks it as primary. The index argument is used to select a single InstanceState from the array of Tainted when there are more than one. If index is -1, the first Tainted InstanceState will be untainted iff there is only one Tainted InstanceState. Index must be >= 0 to specify an InstanceState when Tainted has more than one member.

type ResourceStateKey added in v0.6.10 

type ResourceStateKey struct {
	Name  string
	Type  string
	Index int
}

ResourceStateKey is a structured representation of the key used for the ModuleState.Resources mapping

func ParseResourceStateKey added in v0.6.10 

func ParseResourceStateKey(k string) (*ResourceStateKey, error)

ParseResourceStateKey accepts a key in the format used by ModuleState.Resources and returns a resource name and resource index. In the state, a resource has the format "type.name.index" or "type.name". In the latter case, the index is returned as -1.

func (*ResourceStateKey) Equal added in v0.6.10 

func (rsk *ResourceStateKey) Equal(other *ResourceStateKey) bool

Equal determines whether two ResourceStateKeys are the same

func (*ResourceStateKey) String added in v0.6.10 

func (rsk *ResourceStateKey) String() string

type ResourceStateV1 added in v0.3.0 

type ResourceStateV1 struct {
	// This is filled in and managed by Terraform, and is the resource
	// type itself such as "mycloud_instance". If a resource provider sets
	// this value, it won't be persisted.
	Type string

	// A unique ID for this resource. This is opaque to Terraform
	// and is only meant as a lookup mechanism for the providers.
	ID string

	// Attributes are basic information about the resource. Any keys here
	// are accessible in variable format within Terraform configurations:
	// ${resourcetype.name.attribute}.
	Attributes map[string]string

	// ConnInfo is used for the providers to export information which is
	// used to connect to the resource for provisioning. For example,
	// this could contain SSH or WinRM credentials.
	ConnInfo map[string]string

	// Extra information that the provider can store about a resource.
	// This data is opaque, never shown to the user, and is sent back to
	// the provider as-is for whatever purpose appropriate.
	Extra map[string]interface{}

	// Dependencies are a list of things that this resource relies on
	// existing to remain intact. For example: an AWS instance might
	// depend on a subnet (which itself might depend on a VPC, and so
	// on).
	//
	// Terraform uses this information to build valid destruction
	// orders and to warn the user if they're destroying a resource that
	// another resource depends on.
	//
	// Things can be put into this list that may not be managed by
	// Terraform. If Terraform doesn't find a matching ID in the
	// overall state, then it assumes it isn't managed and doesn't
	// worry about it.
	Dependencies []ResourceDependency
}

/ ResourceState holds the state of a resource that is used so that a provider can find and manage an existing resource as well as for storing attributes that are uesd to populate variables of child resources.

Attributes has attributes about the created resource that are queryable in interpolation: "${type.id.attr}"

Extra is just extra data that a provider can return that we store for later, but is not exposed in any way to the user.

func (*ResourceStateV1) GoString added in v0.3.0 

func (s *ResourceStateV1) GoString() string

func (*ResourceStateV1) MergeDiff added in v0.3.0 

func (s *ResourceStateV1) MergeDiff(d *InstanceDiff) *ResourceStateV1

MergeDiff takes a ResourceDiff and merges the attributes into this resource state in order to generate a new state. This new state can be used to provide updated attribute lookups for variable interpolation.

If the diff attribute requires computing the value, and hence won't be available until apply, the value is replaced with the computeID.

type ResourceType 

type ResourceType struct {
	Name string
}

ResourceType is a type of resource that a resource provider can manage.

type RootTransformer added in v0.4.0 

type RootTransformer struct{}

RootTransformer is a GraphTransformer that adds a root to the graph.

func (*RootTransformer) Transform added in v0.4.0 

func (t *RootTransformer) Transform(g *Graph) error

type SemanticCheckModulesExist added in v0.4.0 

type SemanticCheckModulesExist struct{}

SemanticCheckModulesExist is an implementation of SemanticChecker that verifies that all the modules that are referenced in the graph exist.

func (*SemanticCheckModulesExist) Check added in v0.4.0 

func (*SemanticCheckModulesExist) Check(g *dag.Graph, v dag.Vertex) error

TODO: test

type SemanticChecker added in v0.4.0 

type SemanticChecker interface {
	Check(*dag.Graph, dag.Vertex) error
}

SemanticChecker is the interface that semantic checks across the Terraform graph implement. Errors are accumulated. Even after an error is returned, child vertices in the graph will still be visited.

The graph should NOT be modified by the semantic checker.

The order in which vertices are visited is left unspecified, so the semantic checks should not rely on that.

type Semaphore added in v0.3.1 

type Semaphore chan struct{}

Semaphore is a wrapper around a channel to provide utility methods to clarify that we are treating the channel as a semaphore

func NewSemaphore added in v0.3.1 

func NewSemaphore(n int) Semaphore

NewSemaphore creates a semaphore that allows up to a given limit of simultaneous acquisitions

func (Semaphore) Acquire added in v0.3.1 

func (s Semaphore) Acquire()

Acquire is used to acquire an available slot. Blocks until available.

func (Semaphore) Release added in v0.3.1 

func (s Semaphore) Release()

Release is used to return a slot. Acquire must be called as a pre-condition.

func (Semaphore) TryAcquire added in v0.3.1 

func (s Semaphore) TryAcquire() bool

TryAcquire is used to do a non-blocking acquire. Returns a bool indicating success

type State 

type State struct {
	// Version is the protocol version. Currently only "1".
	Version int `json:"version"`

	// Serial is incremented on any operation that modifies
	// the State file. It is used to detect potentially conflicting
	// updates.
	Serial int64 `json:"serial"`

	// Remote is used to track the metadata required to
	// pull and push state files from a remote storage endpoint.
	Remote *RemoteState `json:"remote,omitempty"`

	// Modules contains all the modules in a breadth-first order
	Modules []*ModuleState `json:"modules"`
}

State keeps track of a snapshot state-of-the-world that Terraform can use to keep track of what real world resources it is actually managing. This is the latest format as of Terraform 0.3

func NewState added in v0.3.5 

func NewState() *State

NewState is used to initialize a blank state

func ReadState 

func ReadState(src io.Reader) (*State, error)

ReadState reads a state structure out of a reader in the format that was written by WriteState.

func (*State) AddModule added in v0.3.0 

func (s *State) AddModule(path []string) *ModuleState

AddModule adds the module with the given path to the state.

This should be the preferred method to add module states since it allows us to optimize lookups later as well as control sorting.

func (*State) Children added in v0.3.0 

func (s *State) Children(path []string) []*ModuleState

Children returns the ModuleStates that are direct children of the given path. If the path is "root", for example, then children returned might be "root.child", but not "root.child.grandchild".

func (*State) DeepCopy added in v0.4.0 

func (s *State) DeepCopy() *State

DeepCopy performs a deep copy of the state structure and returns a new structure.

func (*State) Empty added in v0.4.0 

func (s *State) Empty() bool

Empty returns true if the state is empty.

func (*State) Equal added in v0.4.0 

func (s *State) Equal(other *State) bool

Equal tests if one state is equal to another.

func (*State) GoString added in v0.3.0 

func (s *State) GoString() string

func (*State) IncrementSerialMaybe added in v0.4.0 

func (s *State) IncrementSerialMaybe(other *State)

IncrementSerialMaybe increments the serial number of this state if it different from the other state.

func (*State) IsRemote added in v0.4.0 

func (s *State) IsRemote() bool

IsRemote returns true if State represents a state that exists and is remote.

func (*State) ModuleByPath added in v0.3.0 

func (s *State) ModuleByPath(path []string) *ModuleState

ModuleByPath is used to lookup the module state for the given path. This should be the preferred lookup mechanism as it allows for future lookup optimizations.

func (*State) ModuleOrphans added in v0.4.0 

func (s *State) ModuleOrphans(path []string, c *config.Config) [][]string

ModuleOrphans returns all the module orphans in this state by returning their full paths. These paths can be used with ModuleByPath to return the actual state.

func (*State) RootModule added in v0.3.0 

func (s *State) RootModule() *ModuleState

RootModule returns the ModuleState for the root module

func (*State) String 

func (s *State) String() string

type StateV1 added in v0.3.0 

type StateV1 struct {
	Outputs   map[string]string
	Resources map[string]*ResourceStateV1
	Tainted   map[string]struct{}
	// contains filtered or unexported fields
}

StateV1 is used to represent the state of Terraform files before 0.3. It is automatically upgraded to a modern State representation on start.

func ReadStateV1 added in v0.3.0 

func ReadStateV1(src io.Reader) (*StateV1, error)

ReadStateV1 reads a state structure out of a reader in the format that was written by WriteState.

func (*StateV1) Orphans added in v0.3.0 

func (s *StateV1) Orphans(c *config.Config) []string

Orphans returns a list of keys of resources that are in the State but aren't present in the configuration itself. Hence, these keys represent the state of resources that are orphans.

func (*StateV1) String added in v0.3.0 

func (s *StateV1) String() string

type TaintedTransformer added in v0.4.0 

type TaintedTransformer struct {
	// State is the global state. We'll automatically find the correct
	// ModuleState based on the Graph.Path that is being transformed.
	State *State

	// View, if non-empty, is the ModuleState.View used around the state
	// to find tainted resources.
	View string
}

TaintedTransformer is a GraphTransformer that adds tainted resources to the graph.

func (*TaintedTransformer) Transform added in v0.4.0 

func (t *TaintedTransformer) Transform(g *Graph) error

type TargetsTransformer added in v0.4.0 

type TargetsTransformer struct {
	// List of targeted resource names specified by the user
	Targets []string

	// List of parsed targets, provided by callers like ResourceCountTransform
	// that already have the targets parsed
	ParsedTargets []ResourceAddress

	// Set to true when we're in a `terraform destroy` or a
	// `terraform plan -destroy`
	Destroy bool
}

TargetsTransformer is a GraphTransformer that, when the user specifies a list of resources to target, limits the graph to only those resources and their dependencies.

func (*TargetsTransformer) Transform added in v0.4.0 

func (t *TargetsTransformer) Transform(g *Graph) error

type TransitiveReductionTransformer added in v0.4.0 

type TransitiveReductionTransformer struct{}

TransitiveReductionTransformer is a GraphTransformer that performs finds the transitive reduction of the graph. For a definition of transitive reduction, see Wikipedia.

func (*TransitiveReductionTransformer) Transform added in v0.4.0 

func (t *TransitiveReductionTransformer) Transform(g *Graph) error

type UIInput added in v0.3.0 

type UIInput interface {
	Input(*InputOpts) (string, error)
}

UIInput is the interface that must be implemented to ask for input from this user. This should forward the request to wherever the user inputs things to ask for values.

type UIOutput added in v0.3.0 

type UIOutput interface {
	Output(string)
}

UIOutput is the interface that must be implemented to output data to the end user.

type UnorderedSemanticCheckRunner added in v0.4.0 

type UnorderedSemanticCheckRunner struct {
	Checks []SemanticChecker
}

UnorderedSemanticCheckRunner is an implementation of GraphSemanticChecker that runs a list of SemanticCheckers against the vertices of the graph in no specified order.

func (*UnorderedSemanticCheckRunner) Check added in v0.4.0 

func (sc *UnorderedSemanticCheckRunner) Check(g *dag.Graph) error

type VertexTransformer added in v0.4.0 

type VertexTransformer struct {
	Transforms []GraphVertexTransformer
}

VertexTransformer is a GraphTransformer that transforms vertices using the GraphVertexTransformers. The Transforms are run in sequential order. If a transform replaces a vertex then the next transform will see the new vertex.

func (*VertexTransformer) Transform added in v0.4.0 

func (t *VertexTransformer) Transform(g *Graph) error

Source Files

View all Source files

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.