bolt

Documentation

Overview

Code generated by "mapstructure-to-hcl2 -type Config"; DO NOT EDIT.

Index

• Constants
• type Config
  • func (*Config) FlatMapstructure() interface{ ... }
• type FlatConfig
  • func (*FlatConfig) HCL2Spec() map[string]hcldec.Spec
• type Provisioner
  • func (p *Provisioner) ConfigSpec() hcldec.ObjectSpec
  • func (p *Provisioner) Prepare(raws ...interface{}) error
  • func (p *Provisioner) Provision(ctx context.Context, ui packer.Ui, comm packer.Communicator, ...) error

Constants

const WinRMInventory = `` /* 137-byte string literal not displayed */

WinRMInventory defines the default Bolt inventory used for WinRM connections

Types

type Config

type Config struct {
	common.PackerConfig `mapstructure:",squash"`

	// The command to run bolt
	Command string

	// The Backend to run bolt on
	Backend string `mapstructure:"backend"`

	// The host to run bolt on
	Host string `mapstructure:"host"`

	// The Password to run with bolt. Only used for WinRM
	Password string `mapstructure:"password"`

	// Extra options to pass to the bolt command
	ExtraArguments []string `mapstructure:"extra_arguments"`

	// Bolt environment variables
	BoltEnvVars []string `mapstructure:"bolt_env_vars"`

	// Bolt command parameters
	BoltParams map[interface{}]interface{} `mapstructure:"bolt_params"`

	// The bolt task to execute.
	BoltTask string `mapstructure:"bolt_task"`

	// The bolt plan to execute.
	BoltPlan string `mapstructure:"bolt_plan"`

	// The bolt module path
	BoltModulePath string `mapstructure:"bolt_module_path"`

	// The bolt project path
	ProjectPath string `mapstructure:"project_path"`

	// The bolt inventory file
	InventoryFile string `mapstructure:"inventory_file"`

	// Connection Timeout value
	ConnectTimeout int `mapstructure:"connect_timeout"`

	// The directory in which to place the
	//  temporary generated Bolt inventory file. By default, this is the
	//  system-specific temporary file location. The fully-qualified name of this
	//  temporary file will be passed to the `-i` argument of the `Bolt` command
	//  when this provisioner runs Bolt. Specify this if you have an existing
	//  inventory directory with `host_vars` `group_vars` that you would like to
	//  use in the playbook that this provisioner will run.
	InventoryDirectory string `mapstructure:"inventory_directory"`

	LocalPort            int    `mapstructure:"local_port"`
	SkipVersionCheck     bool   `mapstructure:"skip_version_check"`
	RunAs                string `mapstructure:"run_as"`
	User                 string `mapstructure:"user"`
	SSHHostKeyFile       string `mapstructure:"ssh_host_key_file"`
	SSHAuthorizedKeyFile string `mapstructure:"ssh_authorized_key_file"`
	NoWinRMSSLVerify     bool   `mapstructure:"no_winrm_ssl_verify"`
	NoWinRMSSL           bool   `mapstructure:"no_winrm_ssl"`
	LogLevel             string `mapstructure:"log_level"`
	InstallModules       bool   `mapstructure:"install_modules"`
	// contains filtered or unexported fields
}

Config data passed from the template JSON

func (*Config) FlatMapstructure

func (*Config) FlatMapstructure() interface{ HCL2Spec() map[string]hcldec.Spec }

FlatMapstructure returns a new FlatConfig. FlatConfig is an auto-generated flat version of Config. Where the contents a fields with a `mapstructure:,squash` tag are bubbled up.

type FlatConfig

type FlatConfig struct {
	PackerBuildName      *string                     `mapstructure:"packer_build_name" cty:"packer_build_name" hcl:"packer_build_name"`
	PackerBuilderType    *string                     `mapstructure:"packer_builder_type" cty:"packer_builder_type" hcl:"packer_builder_type"`
	PackerDebug          *bool                       `mapstructure:"packer_debug" cty:"packer_debug" hcl:"packer_debug"`
	PackerForce          *bool                       `mapstructure:"packer_force" cty:"packer_force" hcl:"packer_force"`
	PackerOnError        *string                     `mapstructure:"packer_on_error" cty:"packer_on_error" hcl:"packer_on_error"`
	PackerUserVars       map[string]string           `mapstructure:"packer_user_variables" cty:"packer_user_variables" hcl:"packer_user_variables"`
	PackerSensitiveVars  []string                    `mapstructure:"packer_sensitive_variables" cty:"packer_sensitive_variables" hcl:"packer_sensitive_variables"`
	Command              *string                     `cty:"command" hcl:"command"`
	Backend              *string                     `mapstructure:"backend" cty:"backend" hcl:"backend"`
	Host                 *string                     `mapstructure:"host" cty:"host" hcl:"host"`
	Password             *string                     `mapstructure:"password" cty:"password" hcl:"password"`
	ExtraArguments       []string                    `mapstructure:"extra_arguments" cty:"extra_arguments" hcl:"extra_arguments"`
	BoltEnvVars          []string                    `mapstructure:"bolt_env_vars" cty:"bolt_env_vars" hcl:"bolt_env_vars"`
	BoltParams           map[interface{}]interface{} `mapstructure:"bolt_params" cty:"bolt_params" hcl:"bolt_params"`
	BoltTask             *string                     `mapstructure:"bolt_task" cty:"bolt_task" hcl:"bolt_task"`
	BoltPlan             *string                     `mapstructure:"bolt_plan" cty:"bolt_plan" hcl:"bolt_plan"`
	BoltModulePath       *string                     `mapstructure:"bolt_module_path" cty:"bolt_module_path" hcl:"bolt_module_path"`
	InventoryFile        *string                     `mapstructure:"inventory_file" cty:"inventory_file" hcl:"inventory_file"`
	ConnectTimeout       *int                        `mapstructure:"connect_timeout" cty:"connect_timeout" hcl:"connect_timeout"`
	InventoryDirectory   *string                     `mapstructure:"inventory_directory" cty:"inventory_directory" hcl:"inventory_directory"`
	LocalPort            *int                        `mapstructure:"local_port" cty:"local_port" hcl:"local_port"`
	SkipVersionCheck     *bool                       `mapstructure:"skip_version_check" cty:"skip_version_check" hcl:"skip_version_check"`
	User                 *string                     `mapstructure:"user" cty:"user" hcl:"user"`
	RunAs                *string                     `mapstructure:"run_as" cty:"run_as" hcl:"run_as"`
	LogLevel             *string                     `mapstructure:"log_level" cty:"log_level" hcl:"log_level"`
	SSHHostKeyFile       *string                     `mapstructure:"ssh_host_key_file" cty:"ssh_host_key_file" hcl:"ssh_host_key_file"`
	SSHAuthorizedKeyFile *string                     `mapstructure:"ssh_authorized_key_file" cty:"ssh_authorized_key_file" hcl:"ssh_authorized_key_file"`
	NoWinRMSSLVerify     *bool                       `mapstructure:"no_winrm_ssl_verify" cty:"no_winrm_ssl_verify" hcl:"no_winrm_ssl_verify"`
	NoWinRMSSL           *bool                       `mapstructure:"no_winrm_ssl" cty:"no_winrm_ssl" hcl:"no_winrm_ssl"`
	InstallModules       *bool                       `mapstructure:"install_modules" cty:"install_modules" hcl:"install_modules"`
	ProjectPath          *string                     `mapstructure:"project_path" cty:"project_path" hcl:"project_path"`
}

FlatConfig is an auto-generated flat version of Config. Where the contents of a field with a `mapstructure:,squash` tag are bubbled up.

func (*FlatConfig) HCL2Spec

func (*FlatConfig) HCL2Spec() map[string]hcldec.Spec

HCL2Spec returns the hcl spec of a Config. This spec is used by HCL to read the fields of Config. The decoded values from this spec will then be applied to a FlatConfig.

type Provisioner

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

Provisioner data passed to the provision operation

func (*Provisioner) ConfigSpec

func (p *Provisioner) ConfigSpec() hcldec.ObjectSpec

func (*Provisioner) Prepare

func (p *Provisioner) Prepare(raws ...interface{}) error

Prepare the config data for provisioning

func (*Provisioner) Provision

func (p *Provisioner) Provision(ctx context.Context, ui packer.Ui, comm packer.Communicator, generatedData map[string]interface{}) error

Provision using the Puppet Bolt provisioner