config

Documentation

Index

• Variables
• func Decode(target interface{}, config *DecodeOpts, raws ...interface{}) error
• func DetectContext(raws ...interface{}) (*interpolate.Context, error)
• func DetectContextData(raws ...interface{}) (map[interface{}]interface{}, []interface{})
• type DecodeOpts
• type Trilean
  • func TrileanFromBool(b bool) Trilean
  • func TrileanFromString(s string) (Trilean, error)
  • func (t Trilean) False() bool
  • func (t Trilean) ToBoolPointer() *bool
  • func (t Trilean) ToString() string
  • func (t Trilean) True() bool

Variables

var DefaultDecodeHookFuncs = []mapstructure.DecodeHookFunc{
	uint8ToStringHook,
	stringToTrilean,
	mapstructure.StringToSliceHookFunc(","),
	mapstructure.StringToTimeDurationHookFunc(),
}

var DeprecatedOptions = []string{
	"iso_md5",
	"guest_additions_attach",
	"headless",
	"parallels_tools_host_path",
	"guest_os_distribution",
	"ssh_key_path",
	"ssh_disable_agent",
	"access_key",
	"filename",
	"shutdown_behaviour",
	"enhanced_networking",
	"ssh_private_ip",
	"temporary_security_group_source_cidr",
	"login_email",
	"tag",
	"vhd_temp_path",
	"clone_from_vmxc_path",
	"cpu",
	"ram_size",
	"clean_image_name",
	"clean_ami_name",
	"spot_price_auto_product",
	"galaxycommand",
	"ssh_host_port_min",
	"ssh_host_port_max",
	"ssh_skip_nat_mapping",
	"ssh_wait_timeout",
	"network_card",
	"network",
	"networkCard",
	"disk_size",
	"disk_thin_provisioned",
	"disk_eagerly_scrub",
	"iso_checksum_url",
	"iso_checksum_type",
	"ssh_host_port_max",
	"ssh_host_port_min",
}

Functions

func Decode

func Decode(target interface{}, config *DecodeOpts, raws ...interface{}) error

Decode decodes the configuration into the target and optionally automatically interpolates all the configuration as it goes.

func DetectContext

func DetectContext(raws ...interface{}) (*interpolate.Context, error)

DetectContext builds a base interpolate.Context, automatically detecting things like user variables from the raw configuration params.

func DetectContextData

func DetectContextData(raws ...interface{}) (map[interface{}]interface{}, []interface{})

Types

type DecodeOpts

type DecodeOpts struct {
	// Metadata, if non-nil, will be set to the metadata post-decode
	Metadata *mapstructure.Metadata

	// Interpolate, if true, will automatically interpolate the
	// configuration with the given InterpolateContext. User variables
	// will be automatically detected and added in-place to the given
	// context.
	Interpolate        bool
	InterpolateContext *interpolate.Context
	InterpolateFilter  *interpolate.RenderFilter

	DecodeHooks []mapstructure.DecodeHookFunc
}

DecodeOpts are the options for decoding configuration.

type Trilean

type Trilean uint8

const (
	// This will assign unset to 0, which is the default value in interpolation
	TriUnset Trilean = iota
	TriTrue
	TriFalse
)

func TrileanFromBool

func TrileanFromBool(b bool) Trilean

func TrileanFromString

func TrileanFromString(s string) (Trilean, error)

func (Trilean) False

func (t Trilean) False() bool

func (Trilean) ToBoolPointer

func (t Trilean) ToBoolPointer() *bool

func (Trilean) ToString

func (t Trilean) ToString() string

func (Trilean) True

func (t Trilean) True() bool