Documentation
¶
Overview ¶
The config package is responsible for loading and validating the configuration.
Index ¶
- Constants
- Variables
- func Funcs() map[string]ast.Function
- func IsEmptyDir(root string) (bool, error)
- func ProviderConfigName(t string, pcs []*ProviderConfig) string
- type AtlasConfig
- type Config
- type CountValueType
- type CountVariable
- type ErrNoConfigsFound
- type InterpolatedVariable
- type Module
- type ModuleVariable
- type Output
- type PathValueType
- type PathVariable
- type ProviderConfig
- type Provisioner
- type RawConfig
- func (r *RawConfig) Config() map[string]interface{}
- func (r *RawConfig) Copy() *RawConfig
- func (r *RawConfig) GobDecode(b []byte) error
- func (r *RawConfig) GobEncode() ([]byte, error)
- func (r *RawConfig) Interpolate(vs map[string]ast.Variable) error
- func (r *RawConfig) Merge(other *RawConfig) *RawConfig
- func (r *RawConfig) RawMap() map[string]interface{}
- func (r *RawConfig) UnknownKeys() []string
- func (r *RawConfig) Value() interface{}
- type Resource
- type ResourceLifecycle
- type ResourceMode
- type ResourceVariable
- type SelfVariable
- type SimpleVariable
- type Terraform
- type UserVariable
- type Variable
- type VariableType
Constants ¶
const UnknownVariableValue = "74D93920-ED26-11E3-AC10-0800200C9A66"
UnknownVariableValue is a sentinel value that can be used to denote that the value of a variable is unknown at this time. RawConfig uses this information to build up data about unknown keys.
Variables ¶
var NameRegexp = regexp.MustCompile(`(?i)\A[A-Z_][A-Z0-9\-\_]*\z`)
NameRegexp is the regular expression that all names (modules, providers, resources, etc.) must follow.
Functions ¶
func Funcs ¶
func Funcs() map[string]ast.Function
Funcs is the mapping of built-in functions for configuration.
func IsEmptyDir ¶ added in v0.3.0
func IsEmptyDir(root string) (bool, error)
IsEmptyDir returns true if the directory given has no Terraform configuration files.
func ProviderConfigName ¶
func ProviderConfigName(t string, pcs []*ProviderConfig) string
ProviderConfigName returns the name of the provider configuration in the given mapping that maps to the proper provider configuration for this resource.
Types ¶
type AtlasConfig ¶ added in v0.4.0
type AtlasConfig struct {
Name string
Include []string
Exclude []string
}
AtlasConfig is the configuration for building in HashiCorp's Atlas.
type Config ¶
type Config struct {
// Dir is the path to the directory where this configuration was
// loaded from. If it is blank, this configuration wasn't loaded from
// any meaningful directory.
Dir string
Terraform *Terraform
Atlas *AtlasConfig
Modules []*Module
ProviderConfigs []*ProviderConfig
Resources []*Resource
Variables []*Variable
Outputs []*Output
// contains filtered or unexported fields
}
Config is the configuration that comes from loading a collection of Terraform templates.
func Append ¶
func Append(c1, c2 *Config) (*Config, error)
Append appends one configuration to another.
Append assumes that both configurations will not have conflicting variables, resources, etc. If they do, the problems will be caught in the validation phase.
It is possible that c1, c2 on their own are not valid. For example, a resource in c2 may reference a variable in c1. But together, they would be valid.
func LoadDir ¶
func LoadDir(root string) (*Config, error)
LoadDir loads all the Terraform configuration files in a single directory and appends them together.
Special files known as "override files" can also be present, which are merged into the loaded configuration. That is, the non-override files are loaded first to create the configuration. Then, the overrides are merged into the configuration to create the final configuration.
Files are loaded in lexical order.
func LoadFile ¶ added in v0.6.0
func LoadFile(path string) (*Config, error)
LoadFile loads the Terraform configuration from a given file.
This file can be any format that Terraform recognizes, and import any other format that Terraform recognizes.
func LoadJSON ¶ added in v0.6.0
func LoadJSON(raw json.RawMessage) (*Config, error)
LoadJSON loads a single Terraform configuration from a given JSON document.
The document must be a complete Terraform configuration. This function will NOT try to load any additional modules so only the given document is loaded.
func Merge ¶
func Merge(c1, c2 *Config) (*Config, error)
Merge merges two configurations into a single configuration.
Merge allows for the two configurations to have duplicate resources, because the resources will be merged. This differs from a single Config which must only have unique resources.
func (*Config) InterpolatedVariables ¶ added in v0.3.0
func (c *Config) InterpolatedVariables() map[string][]InterpolatedVariable
InterpolatedVariables is a helper that returns a mapping of all the interpolated variables within the configuration. This is used to verify references are valid in the Validate step.
func (*Config) TestString ¶ added in v0.3.0
func (c *Config) TestString() string
TestString is a Stringer-like function that outputs a string that can be used to easily compare multiple Config structures in unit tests.
This function has no practical use outside of unit tests and debugging.
type CountValueType ¶ added in v0.3.0
type CountValueType byte
CountValueType is the type of the count variable that is referenced.
const (
CountValueInvalid CountValueType = iota
CountValueIndex
)
type CountVariable ¶ added in v0.3.0
type CountVariable struct {
Type CountValueType
// contains filtered or unexported fields
}
CountVariable is a variable for referencing information about the count.
func NewCountVariable ¶ added in v0.3.0
func NewCountVariable(key string) (*CountVariable, error)
type ErrNoConfigsFound ¶ added in v0.8.0
type ErrNoConfigsFound struct {
Dir string
}
ErrNoConfigsFound is the error returned by LoadDir if no Terraform configuration files were found in the given directory.
type InterpolatedVariable ¶
type InterpolatedVariable interface {
FullKey() string
}
An InterpolatedVariable is a variable reference within an interpolation.
Implementations of this interface represents various sources where variables can come from: user variables, resources, etc.
func DetectVariables ¶ added in v0.3.7
func DetectVariables(root ast.Node) ([]InterpolatedVariable, error)
DetectVariables takes an AST root and returns all the interpolated variables that are detected in the AST tree.
func NewInterpolatedVariable ¶
func NewInterpolatedVariable(v string) (InterpolatedVariable, error)
type Module ¶ added in v0.3.0
type Module struct {
Name string
Source string
RawConfig *RawConfig
}
Module is a module used within a configuration.
This does not represent a module itself, this represents a module call-site within an existing configuration.
type ModuleVariable ¶ added in v0.3.0
type ModuleVariable struct {
Name string
Field string
// contains filtered or unexported fields
}
A ModuleVariable is a variable that is referencing the output of a module, such as "${module.foo.bar}"
func NewModuleVariable ¶ added in v0.3.0
func NewModuleVariable(key string) (*ModuleVariable, error)
type Output ¶
type Output struct {
Name string
DependsOn []string
Description string
Sensitive bool
RawConfig *RawConfig
}
Output is an output defined within the configuration. An output is resulting data that is highlighted by Terraform when finished. An output marked Sensitive will be output in a masked form following application, but will still be available in state.
type PathValueType ¶ added in v0.3.0
type PathValueType byte
const (
PathValueInvalid PathValueType = iota
PathValueCwd
PathValueModule
PathValueRoot
)
type PathVariable ¶ added in v0.3.0
type PathVariable struct {
Type PathValueType
// contains filtered or unexported fields
}
A PathVariable is a variable that references path information about the module.
func NewPathVariable ¶ added in v0.3.0
func NewPathVariable(key string) (*PathVariable, error)
type ProviderConfig ¶
type ProviderConfig struct {
Name string
Alias string
RawConfig *RawConfig
}
ProviderConfig is the configuration for a resource provider.
For example, Terraform needs to set the AWS access keys for the AWS resource provider.
type Provisioner ¶
type Provisioner struct {
Type string
RawConfig *RawConfig
ConnInfo *RawConfig
}
Provisioner is a configured provisioner step on a resource.
type RawConfig ¶
type RawConfig struct {
Key string
Raw map[string]interface{}
Interpolations []ast.Node
Variables map[string]InterpolatedVariable
// contains filtered or unexported fields
}
RawConfig is a structure that holds a piece of configuration where the overall structure is unknown since it will be used to configure a plugin or some other similar external component.
RawConfigs can be interpolated with variables that come from other resources, user variables, etc.
RawConfig supports a query-like interface to request information from deep within the structure.
func NewRawConfig ¶
func NewRawConfig(raw map[string]interface{}) (*RawConfig, error)
NewRawConfig creates a new RawConfig structure and populates the publicly readable struct fields.
func TestRawConfig ¶ added in v0.7.8
func TestRawConfig(t *testing.T, c map[string]interface{}) *RawConfig
TestRawConfig is used to create a RawConfig for testing.
func (*RawConfig) Config ¶
func (r *RawConfig) Config() map[string]interface{}
Config returns the entire configuration with the variables interpolated from any call to Interpolate.
If any interpolated variables are unknown (value set to UnknownVariableValue), the first non-container (map, slice, etc.) element will be removed from the config. The keys of unknown variables can be found using the UnknownKeys function.
By pruning out unknown keys from the configuration, the raw structure will always successfully decode into its ultimate structure using something like mapstructure.
func (*RawConfig) Copy ¶ added in v0.4.1
func (r *RawConfig) Copy() *RawConfig
Copy returns a copy of this RawConfig, uninterpolated.
func (*RawConfig) GobEncode ¶
func (r *RawConfig) GobEncode() ([]byte, error)
GobEncode is a custom Gob encoder to use so that we only include the raw configuration. Interpolated variables and such are lost and the tree of interpolated variables is recomputed on decode, since it is referentially transparent.
func (*RawConfig) Interpolate ¶
func (r *RawConfig) Interpolate(vs map[string]ast.Variable) error
Interpolate uses the given mapping of variable values and uses those as the values to replace any variables in this raw configuration.
Any prior calls to Interpolate are replaced with this one.
If a variable key is missing, this will panic.
func (*RawConfig) Merge ¶ added in v0.4.0
func (r *RawConfig) Merge(other *RawConfig) *RawConfig
Merge merges another RawConfig into this one (overriding any conflicting values in this config) and returns a new config. The original config is not modified.
func (*RawConfig) RawMap ¶ added in v0.7.3
func (r *RawConfig) RawMap() map[string]interface{}
RawMap returns a copy of the RawConfig.Raw map.
func (*RawConfig) UnknownKeys ¶
func (r *RawConfig) UnknownKeys() []string
UnknownKeys returns the keys of the configuration that are unknown because they had interpolated variables that must be computed.
type Resource ¶
type Resource struct {
Mode ResourceMode // which operations the resource supports
Name string
Type string
RawCount *RawConfig
RawConfig *RawConfig
Provisioners []*Provisioner
Provider string
DependsOn []string
Lifecycle ResourceLifecycle
}
A resource represents a single Terraform resource in the configuration. A Terraform resource is something that supports some or all of the usual "create, read, update, delete" operations, depending on the given Mode.
func (*Resource) Copy ¶ added in v0.6.12
func (r *Resource) Copy() *Resource
Copy returns a copy of this Resource. Helpful for avoiding shared config pointers across multiple pieces of the graph that need to do interpolation.
type ResourceLifecycle ¶ added in v0.3.0
type ResourceLifecycle struct {
CreateBeforeDestroy bool `mapstructure:"create_before_destroy"`
PreventDestroy bool `mapstructure:"prevent_destroy"`
IgnoreChanges []string `mapstructure:"ignore_changes"`
}
ResourceLifecycle is used to store the lifecycle tuning parameters to allow customized behavior
type ResourceMode ¶ added in v0.7.0
type ResourceMode int
const (
ManagedResourceMode ResourceMode = iota
DataResourceMode
)
type ResourceVariable ¶
type ResourceVariable struct {
Mode ResourceMode
Type string // Resource type, i.e. "aws_instance"
Name string // Resource name
Field string // Resource field
Multi bool // True if multi-variable: aws_instance.foo.*.id
Index int // Index for multi-variable: aws_instance.foo.1.id == 1
// contains filtered or unexported fields
}
A ResourceVariable is a variable that is referencing the field of a resource, such as "${aws_instance.foo.ami}"
func NewResourceVariable ¶
func NewResourceVariable(key string) (*ResourceVariable, error)
func (*ResourceVariable) ResourceId ¶
func (v *ResourceVariable) ResourceId() string
type SelfVariable ¶ added in v0.4.0
type SelfVariable struct {
Field string
// contains filtered or unexported fields
}
SelfVariable is a variable that is referencing the same resource it is running on: "${self.address}"
func NewSelfVariable ¶ added in v0.4.0
func NewSelfVariable(key string) (*SelfVariable, error)
type SimpleVariable ¶ added in v0.6.7
type SimpleVariable struct {
Key string
}
SimpleVariable is an unprefixed variable, which can show up when users have strings they are passing down to resources that use interpolation internally. The template_file resource is an example of this.
func NewSimpleVariable ¶ added in v0.6.7
func NewSimpleVariable(key string) (*SimpleVariable, error)
type Terraform ¶ added in v0.8.0
type Terraform struct {
RequiredVersion string `hcl:"required_version"` // Required Terraform version (constraint)
}
Terraform is the Terraform meta-configuration that can be present in configuration files for configuring Terraform itself.
type UserVariable ¶
type UserVariable struct {
Name string
Elem string
// contains filtered or unexported fields
}
A UserVariable is a variable that is referencing a user variable that is inputted from outside the configuration. This looks like "${var.foo}"
func NewUserVariable ¶
func NewUserVariable(key string) (*UserVariable, error)
type Variable ¶
type Variable struct {
Name string
DeclaredType string `mapstructure:"type"`
Default interface{}
Description string
}
Variable is a variable defined within the configuration.
func (*Variable) Merge ¶
func (v *Variable) Merge(v2 *Variable) *Variable
Merge merges two variables to create a new third variable.
func (*Variable) Required ¶
func (v *Variable) Required() bool
Required tests whether a variable is required or not.
func (*Variable) Type ¶
func (v *Variable) Type() VariableType
Type returns the type of variable this is.
func (*Variable) ValidateTypeAndDefault ¶ added in v0.6.10
func (v *Variable) ValidateTypeAndDefault() error
ValidateTypeAndDefault ensures that default variable value is compatible with the declared type (if one exists), and that the type is one which is known to Terraform
type VariableType ¶
type VariableType byte
VariableType is the type of value a variable is holding, and returned by the Type() function on variables.
const (
VariableTypeUnknown VariableType = iota
VariableTypeString
VariableTypeList
VariableTypeMap
)
Source Files
Directories