shell

Documentation

Overview

This package implements a provisioner for Packer that executes shell scripts within the remote machine.

Index

• type Config
• type ExecuteCommandTemplate
• type Provisioner
  • func (p *Provisioner) Cancel()
  • func (p *Provisioner) Prepare(raws ...interface{}) error
  • func (p *Provisioner) Provision(ui packer.Ui, comm packer.Communicator) error
• type UnixReader
  • func (r *UnixReader) Read(p []byte) (n int, err error)

Types

type Config

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

	// If true, the script contains binary and line endings will not be
	// converted from Windows to Unix-style.
	Binary bool

	// An inline script to execute. Multiple strings are all executed
	// in the context of a single shell.
	Inline []string

	// The shebang value used when running inline scripts.
	InlineShebang string `mapstructure:"inline_shebang"`

	// The local path of the shell script to upload and execute.
	Script string

	// An array of multiple scripts to run.
	Scripts []string

	// An array of environment variables that will be injected before
	// your command(s) are executed.
	Vars []string `mapstructure:"environment_vars"`

	// The remote path where the local shell script will be uploaded to.
	// This should be set to a writable file that is in a pre-existing directory.
	RemotePath string `mapstructure:"remote_path"`

	// The command used to execute the script. The '{{ .Path }}' variable
	// should be used to specify where the script goes, {{ .Vars }}
	// can be used to inject the environment_vars into the environment.
	ExecuteCommand string `mapstructure:"execute_command"`

	// The timeout for retrying to start the process. Until this timeout
	// is reached, if the provisioner can't start a process, it retries.
	// This can be set high to allow for reboots.
	RawStartRetryTimeout string `mapstructure:"start_retry_timeout"`
	// contains filtered or unexported fields
}

type ExecuteCommandTemplate

type ExecuteCommandTemplate struct {
	Vars string
	Path string
}

type Provisioner

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

func (*Provisioner) Cancel

func (p *Provisioner) Cancel()

func (*Provisioner) Prepare

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

func (*Provisioner) Provision

func (p *Provisioner) Provision(ui packer.Ui, comm packer.Communicator) error

type UnixReader

type UnixReader struct {
	Reader io.Reader
	// contains filtered or unexported fields
}

UnixReader is a Reader implementation that automatically converts Windows line endings to Unix line endings.

func (*UnixReader) Read

func (r *UnixReader) Read(p []byte) (n int, err error)