Commit d8e8f98b authored by Chris Bednarski's avatar Chris Bednarski

Change to 4 spaces

parent 555a8ba7
...@@ -13,5 +13,5 @@ format: ...@@ -13,5 +13,5 @@ format:
bundle exec htmlbeautifier -t 2 source/*.erb bundle exec htmlbeautifier -t 2 source/*.erb
bundle exec htmlbeautifier -t 2 source/layouts/*.erb bundle exec htmlbeautifier -t 2 source/layouts/*.erb
@pandoc -v > /dev/null || echo "pandoc must be installed in order to format markdown content" @pandoc -v > /dev/null || echo "pandoc must be installed in order to format markdown content"
pandoc -v > /dev/null && find . -iname "*.html.markdown" | xargs -I{} bash -c "pandoc -r markdown -w markdown --tab-stop=2 --atx-headers -s --columns=80 {} > {}.new"\; || true pandoc -v > /dev/null && find . -iname "*.html.markdown" | xargs -I{} bash -c "pandoc -r markdown -w markdown --tab-stop=4 --atx-headers -s --columns=80 {} > {}.new"\; || true
pandoc -v > /dev/null && find . -iname "*.html.markdown" | xargs -I{} bash -c "mv {}.new {}"\; || true pandoc -v > /dev/null && find . -iname "*.html.markdown" | xargs -I{} bash -c "mv {}.new {}"\; || true
...@@ -29,7 +29,8 @@ list as contributors come and go. ...@@ -29,7 +29,8 @@ list as contributors come and go.
<div class="people"> <div class="people">
<div class="person"> <div class="person">
<img class="pull-left" src="http://www.gravatar.com/avatar/54079122b67de9677c1f93933ce8b63a.png?s=125"> <img class="pull-left" src="http://www.gravatar.com/avatar/54079122b67de9677c1f93933ce8b63a.png?s=125">
<div class="bio"> <div class="bio">
<h3>Mitchell Hashimoto (<a href="https://github.com/mitchellh">@mitchellh</a>)</h3> <h3>Mitchell Hashimoto (<a href="https://github.com/mitchellh">@mitchellh</a>)</h3>
...@@ -41,9 +42,11 @@ list as contributors come and go. ...@@ -41,9 +42,11 @@ list as contributors come and go.
described as "automation obsessed." described as "automation obsessed."
</p> </p>
</div> </div>
</div>
<div class="person"> </div>
<div class="person">
<img class="pull-left" src="http://www.gravatar.com/avatar/2acc31dd6370a54b18f6755cd0710ce6.png?s=125"> <img class="pull-left" src="http://www.gravatar.com/avatar/2acc31dd6370a54b18f6755cd0710ce6.png?s=125">
<div class="bio"> <div class="bio">
<h3>Jack Pearkes (<a href="https://github.com/pearkes">@pearkes</a>)</h3> <h3>Jack Pearkes (<a href="https://github.com/pearkes">@pearkes</a>)</h3>
...@@ -52,9 +55,11 @@ list as contributors come and go. ...@@ -52,9 +55,11 @@ list as contributors come and go.
for Packer. Outside of Packer, Jack is an avid open source for Packer. Outside of Packer, Jack is an avid open source
contributor and software consultant.</p> contributor and software consultant.</p>
</div> </div>
</div>
<div class="person"> </div>
<div class="person">
<img class="pull-left" src="http://www.gravatar.com/avatar/2f7fc9cb7558e3ea48f5a86fa90a78da.png?s=125"> <img class="pull-left" src="http://www.gravatar.com/avatar/2f7fc9cb7558e3ea48f5a86fa90a78da.png?s=125">
<div class="bio"> <div class="bio">
<h3>Mark Peek (<a href="https://github.com/markpeek">@markpeek</a>)</h3> <h3>Mark Peek (<a href="https://github.com/markpeek">@markpeek</a>)</h3>
...@@ -65,9 +70,11 @@ list as contributors come and go. ...@@ -65,9 +70,11 @@ list as contributors come and go.
<a href="https://github.com/ironport">IronPort Python libraries</a>. <a href="https://github.com/ironport">IronPort Python libraries</a>.
Mark is also a <a href="https://FreeBSD.org">FreeBSD committer</a>.</p> Mark is also a <a href="https://FreeBSD.org">FreeBSD committer</a>.</p>
</div> </div>
</div>
<div class="person"> </div>
<div class="person">
<img class="pull-left" src="http://www.gravatar.com/avatar/1fca64df3d7db1e2f258a8956d2b0aff.png?s=125"> <img class="pull-left" src="http://www.gravatar.com/avatar/1fca64df3d7db1e2f258a8956d2b0aff.png?s=125">
<div class="bio"> <div class="bio">
<h3>Ross Smith II (<a href="https://github.com/rasa" target="_blank">@rasa</a>)</h3> <h3>Ross Smith II (<a href="https://github.com/rasa" target="_blank">@rasa</a>)</h3>
...@@ -78,9 +85,11 @@ VMware builder on Windows, and provides other valuable assistance. Ross is an ...@@ -78,9 +85,11 @@ VMware builder on Windows, and provides other valuable assistance. Ross is an
open source enthusiast, published author, and freelance consultant. open source enthusiast, published author, and freelance consultant.
</p> </p>
</div> </div>
</div>
<div class="person"> </div>
<div class="person">
<img class="pull-left" src="http://www.gravatar.com/avatar/c9f6bf7b5b865012be5eded656ebed7d.png?s=125"> <img class="pull-left" src="http://www.gravatar.com/avatar/c9f6bf7b5b865012be5eded656ebed7d.png?s=125">
<div class="bio"> <div class="bio">
<h3>Rickard von Essen<br/>(<a href="https://github.com/rickard-von-essen" target="_blank">@rickard-von-essen</a>)</h3> <h3>Rickard von Essen<br/>(<a href="https://github.com/rickard-von-essen" target="_blank">@rickard-von-essen</a>)</h3>
...@@ -90,8 +99,11 @@ Rickard von Essen maintains our Parallels Desktop builder. Rickard is an ...@@ -90,8 +99,11 @@ Rickard von Essen maintains our Parallels Desktop builder. Rickard is an
polyglot programmer and consults on Continuous Delivery. polyglot programmer and consults on Continuous Delivery.
</p> </p>
</div> </div>
</div>
<div class="clearfix"></div> </div>
<div class="clearfix">
</div>
</div> </div>
...@@ -17,34 +17,34 @@ Luckily, there are relatively few. This page documents all the terminology ...@@ -17,34 +17,34 @@ Luckily, there are relatively few. This page documents all the terminology
required to understand and use Packer. The terminology is in alphabetical order required to understand and use Packer. The terminology is in alphabetical order
for easy referencing. for easy referencing.
- `Artifacts` are the results of a single build, and are usually a set of IDs or - `Artifacts` are the results of a single build, and are usually a set of IDs
files to represent a machine image. Every builder produces a single artifact. or files to represent a machine image. Every builder produces a
As an example, in the case of the Amazon EC2 builder, the artifact is a set of single artifact. As an example, in the case of the Amazon EC2 builder, the
AMI IDs (one per region). For the VMware builder, the artifact is a directory artifact is a set of AMI IDs (one per region). For the VMware builder, the
of files comprising the created virtual machine. artifact is a directory of files comprising the created virtual machine.
- `Builds` are a single task that eventually produces an image for a - `Builds` are a single task that eventually produces an image for a
single platform. Multiple builds run in parallel. Example usage in a sentence: single platform. Multiple builds run in parallel. Example usage in a
"The Packer build produced an AMI to run our web application." Or: "Packer is sentence: "The Packer build produced an AMI to run our web application." Or:
running the builds now for VMware, AWS, and VirtualBox." "Packer is running the builds now for VMware, AWS, and VirtualBox."
- `Builders` are components of Packer that are able to create a machine image - `Builders` are components of Packer that are able to create a machine image
for a single platform. Builders read in some configuration and use that to run for a single platform. Builders read in some configuration and use that to
and generate a machine image. A builder is invoked as part of a build in order run and generate a machine image. A builder is invoked as part of a build in
to create the actual resulting images. Example builders include VirtualBox, order to create the actual resulting images. Example builders include
VMware, and Amazon EC2. Builders can be created and added to Packer in the VirtualBox, VMware, and Amazon EC2. Builders can be created and added to
form of plugins. Packer in the form of plugins.
- `Commands` are sub-commands for the `packer` program that perform some job. An - `Commands` are sub-commands for the `packer` program that perform some job.
example command is "build", which is invoked as `packer build`. Packer ships An example command is "build", which is invoked as `packer build`. Packer
with a set of commands out of the box in order to define its ships with a set of commands out of the box in order to define its
command-line interface. Commands can also be created and added to Packer in command-line interface. Commands can also be created and added to Packer in
the form of plugins. the form of plugins.
- `Post-processors` are components of Packer that take the result of a builder - `Post-processors` are components of Packer that take the result of a builder
or another post-processor and process that to create a new artifact. Examples or another post-processor and process that to create a new artifact.
of post-processors are compress to compress artifacts, upload to upload Examples of post-processors are compress to compress artifacts, upload to
artifacts, etc. upload artifacts, etc.
- `Provisioners` are components of Packer that install and configure software - `Provisioners` are components of Packer that install and configure software
within a running machine prior to that machine being turned into a within a running machine prior to that machine being turned into a
...@@ -52,6 +52,6 @@ for easy referencing. ...@@ -52,6 +52,6 @@ for easy referencing.
useful software. Example provisioners include shell scripts, Chef, useful software. Example provisioners include shell scripts, Chef,
Puppet, etc. Puppet, etc.
- `Templates` are JSON files which define one or more builds by configuring the - `Templates` are JSON files which define one or more builds by configuring
various components of Packer. Packer is able to read a template and use that the various components of Packer. Packer is able to read a template and use
information to create multiple machine images in parallel. that information to create multiple machine images in parallel.
...@@ -82,24 +82,25 @@ builder. ...@@ -82,24 +82,25 @@ builder.
instance metadata for IAM role keys. instance metadata for IAM role keys.
- `source_ami` (string) - The source AMI whose root volume will be copied and - `source_ami` (string) - The source AMI whose root volume will be copied and
provisioned on the currently running instance. This must be an EBS-backed AMI provisioned on the currently running instance. This must be an EBS-backed
with a root volume snapshot that you have access to. AMI with a root volume snapshot that you have access to.
### Optional: ### Optional:
- `ami_description` (string) - The description to set for the resulting AMI(s). - `ami_description` (string) - The description to set for the
By default this description is empty. resulting AMI(s). By default this description is empty.
- `ami_groups` (array of strings) - A list of groups that have access to launch - `ami_groups` (array of strings) - A list of groups that have access to
the resulting AMI(s). By default no groups have permission to launch the AMI. launch the resulting AMI(s). By default no groups have permission to launch
`all` will make the AMI publicly accessible. the AMI. `all` will make the AMI publicly accessible.
- `ami_product_codes` (array of strings) - A list of product codes to associate - `ami_product_codes` (array of strings) - A list of product codes to
with the AMI. By default no product codes are associated with the AMI. associate with the AMI. By default no product codes are associated with
the AMI.
- `ami_regions` (array of strings) - A list of regions to copy the AMI to. Tags - `ami_regions` (array of strings) - A list of regions to copy the AMI to.
and attributes are copied along with the AMI. AMI copying takes time depending Tags and attributes are copied along with the AMI. AMI copying takes time
on the size of the AMI, but will generally take many minutes. depending on the size of the AMI, but will generally take many minutes.
- `ami_users` (array of strings) - A list of account IDs that have access to - `ami_users` (array of strings) - A list of account IDs that have access to
launch the resulting AMI(s). By default no additional users other than the launch the resulting AMI(s). By default no additional users other than the
...@@ -116,21 +117,22 @@ builder. ...@@ -116,21 +117,22 @@ builder.
use this. use this.
- `command_wrapper` (string) - How to run shell commands. This defaults - `command_wrapper` (string) - How to run shell commands. This defaults
to "{{.Command}}". This may be useful to set if you want to set environmental to "{{.Command}}". This may be useful to set if you want to set
variables or perhaps run it with `sudo` or so on. This is a configuration environmental variables or perhaps run it with `sudo` or so on. This is a
template where the `.Command` variable is replaced with the command to be run. configuration template where the `.Command` variable is replaced with the
command to be run.
- `copy_files` (array of strings) - Paths to files on the running EC2 instance - `copy_files` (array of strings) - Paths to files on the running EC2 instance
that will be copied into the chroot environment prior to provisioning. This is that will be copied into the chroot environment prior to provisioning. This
useful, for example, to copy `/etc/resolv.conf` so that DNS lookups work. is useful, for example, to copy `/etc/resolv.conf` so that DNS lookups work.
- `device_path` (string) - The path to the device where the root volume of the - `device_path` (string) - The path to the device where the root volume of the
source AMI will be attached. This defaults to "" (empty string), which forces source AMI will be attached. This defaults to "" (empty string), which
Packer to find an open device automatically. forces Packer to find an open device automatically.
- `enhanced_networking` (boolean) - Enable enhanced networking (SriovNetSupport) - `enhanced_networking` (boolean) - Enable enhanced
on HVM-compatible AMIs. If true, add `ec2:ModifyInstanceAttribute` to your AWS networking (SriovNetSupport) on HVM-compatible AMIs. If true, add
IAM policy. `ec2:ModifyInstanceAttribute` to your AWS IAM policy.
- `force_deregister` (boolean) - Force Packer to first deregister an existing - `force_deregister` (boolean) - Force Packer to first deregister an existing
AMI if one with the same name already exists. Default `false`. AMI if one with the same name already exists. Default `false`.
...@@ -138,15 +140,15 @@ builder. ...@@ -138,15 +140,15 @@ builder.
- `mount_path` (string) - The path where the volume will be mounted. This is - `mount_path` (string) - The path where the volume will be mounted. This is
where the chroot environment will be. This defaults to where the chroot environment will be. This defaults to
`packer-amazon-chroot-volumes/{{.Device}}`. This is a configuration template `packer-amazon-chroot-volumes/{{.Device}}`. This is a configuration template
where the `.Device` variable is replaced with the name of the device where the where the `.Device` variable is replaced with the name of the device where
volume is attached. the volume is attached.
- `mount_options` (array of strings) - Options to supply the `mount` command - `mount_options` (array of strings) - Options to supply the `mount` command
when mounting devices. Each option will be prefixed with `-o` and supplied to when mounting devices. Each option will be prefixed with `-o` and supplied
the `mount` command ran by Packer. Because this command is ran in a shell, to the `mount` command ran by Packer. Because this command is ran in a
user discrestion is advised. See [this manual page for the mount shell, user discrestion is advised. See [this manual page for the mount
command](http://linuxcommand.org/man_pages/mount8.html) for valid file system command](http://linuxcommand.org/man_pages/mount8.html) for valid file
specific options system specific options
- `root_volume_size` (integer) - The size of the root volume for the chroot - `root_volume_size` (integer) - The size of the root volume for the chroot
environment, and the resulting AMI environment, and the resulting AMI
......
...@@ -66,49 +66,50 @@ builder. ...@@ -66,49 +66,50 @@ builder.
- `source_ami` (string) - The initial AMI used as a base for the newly - `source_ami` (string) - The initial AMI used as a base for the newly
created machine. created machine.
- `ssh_username` (string) - The username to use in order to communicate over SSH - `ssh_username` (string) - The username to use in order to communicate over
to the running machine. SSH to the running machine.
### Optional: ### Optional:
- `ami_block_device_mappings` (array of block device mappings) - Add the block - `ami_block_device_mappings` (array of block device mappings) - Add the block
device mappings to the AMI. The block device mappings allow for keys: device mappings to the AMI. The block device mappings allow for keys:
- `device_name` (string) - The device name exposed to the instance (for - `device_name` (string) - The device name exposed to the instance (for
example, "/dev/sdh" or "xvdh") example, "/dev/sdh" or "xvdh")
- `virtual_name` (string) - The virtual device name. See the documentation on - `virtual_name` (string) - The virtual device name. See the documentation on
[Block Device [Block Device
Mapping](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html) Mapping](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html)
for more information for more information
- `snapshot_id` (string) - The ID of the snapshot - `snapshot_id` (string) - The ID of the snapshot
- `volume_type` (string) - The volume type. gp2 for General Purpose (SSD) - `volume_type` (string) - The volume type. gp2 for General Purpose (SSD)
volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic
volumes volumes
- `volume_size` (integer) - The size of the volume, in GiB. Required if not - `volume_size` (integer) - The size of the volume, in GiB. Required if not
specifying a `snapshot_id` specifying a `snapshot_id`
- `delete_on_termination` (boolean) - Indicates whether the EBS volume is - `delete_on_termination` (boolean) - Indicates whether the EBS volume is
deleted on instance termination deleted on instance termination
- `encrypted` (boolean) - Indicates whether to encrypt the volume or not - `encrypted` (boolean) - Indicates whether to encrypt the volume or not
- `no_device` (boolean) - Suppresses the specified device included in the - `no_device` (boolean) - Suppresses the specified device included in the
block device mapping of the AMI block device mapping of the AMI
- `iops` (integer) - The number of I/O operations per second (IOPS) that the - `iops` (integer) - The number of I/O operations per second (IOPS) that the
volume supports. See the documentation on volume supports. See the documentation on
[IOPs](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html) [IOPs](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html)
for more information for more information
- `ami_description` (string) - The description to set for the resulting AMI(s). - `ami_description` (string) - The description to set for the
By default this description is empty. resulting AMI(s). By default this description is empty.
- `ami_groups` (array of strings) - A list of groups that have access to launch - `ami_groups` (array of strings) - A list of groups that have access to
the resulting AMI(s). By default no groups have permission to launch the AMI. launch the resulting AMI(s). By default no groups have permission to launch
`all` will make the AMI publicly accessible. AWS currently doesn't accept any the AMI. `all` will make the AMI publicly accessible. AWS currently doesn't
value other than "all". accept any value other than "all".
- `ami_product_codes` (array of strings) - A list of product codes to associate - `ami_product_codes` (array of strings) - A list of product codes to
with the AMI. By default no product codes are associated with the AMI. associate with the AMI. By default no product codes are associated with
the AMI.
- `ami_regions` (array of strings) - A list of regions to copy the AMI to. Tags - `ami_regions` (array of strings) - A list of regions to copy the AMI to.
and attributes are copied along with the AMI. AMI copying takes time depending Tags and attributes are copied along with the AMI. AMI copying takes time
on the size of the AMI, but will generally take many minutes. depending on the size of the AMI, but will generally take many minutes.
- `ami_users` (array of strings) - A list of account IDs that have access to - `ami_users` (array of strings) - A list of account IDs that have access to
launch the resulting AMI(s). By default no additional users other than the launch the resulting AMI(s). By default no additional users other than the
...@@ -121,9 +122,9 @@ builder. ...@@ -121,9 +122,9 @@ builder.
- `availability_zone` (string) - Destination availability zone to launch - `availability_zone` (string) - Destination availability zone to launch
instance in. Leave this empty to allow Amazon to auto-assign. instance in. Leave this empty to allow Amazon to auto-assign.
- `enhanced_networking` (boolean) - Enable enhanced networking (SriovNetSupport) - `enhanced_networking` (boolean) - Enable enhanced
on HVM-compatible AMIs. If true, add `ec2:ModifyInstanceAttribute` to your AWS networking (SriovNetSupport) on HVM-compatible AMIs. If true, add
IAM policy. `ec2:ModifyInstanceAttribute` to your AWS IAM policy.
- `force_deregister` (boolean) - Force Packer to first deregister an existing - `force_deregister` (boolean) - Force Packer to first deregister an existing
AMI if one with the same name already exists. Default `false`. AMI if one with the same name already exists. Default `false`.
...@@ -136,38 +137,39 @@ builder. ...@@ -136,38 +137,39 @@ builder.
block device mappings to the launch instance. The block device mappings are block device mappings to the launch instance. The block device mappings are
the same as `ami_block_device_mappings` above. the same as `ami_block_device_mappings` above.
- `run_tags` (object of key/value strings) - Tags to apply to the instance that - `run_tags` (object of key/value strings) - Tags to apply to the instance
is *launched* to create the AMI. These tags are *not* applied to the resulting that is *launched* to create the AMI. These tags are *not* applied to the
AMI unless they're duplicated in `tags`. resulting AMI unless they're duplicated in `tags`.
- `security_group_id` (string) - The ID (*not* the name) of the security group - `security_group_id` (string) - The ID (*not* the name) of the security group
to assign to the instance. By default this is not set and Packer will to assign to the instance. By default this is not set and Packer will
automatically create a new temporary security group to allow SSH access. Note automatically create a new temporary security group to allow SSH access.
that if this is specified, you must be sure the security group allows access Note that if this is specified, you must be sure the security group allows
to the `ssh_port` given below. access to the `ssh_port` given below.
- `security_group_ids` (array of strings) - A list of security groups as - `security_group_ids` (array of strings) - A list of security groups as
described above. Note that if this is specified, you must omit the described above. Note that if this is specified, you must omit the
`security_group_id`. `security_group_id`.
- `spot_price` (string) - The maximum hourly price to pay for a spot instance to - `spot_price` (string) - The maximum hourly price to pay for a spot instance
create the AMI. Spot instances are a type of instance that EC2 starts when the to create the AMI. Spot instances are a type of instance that EC2 starts
current spot price is less than the maximum price you specify. Spot price will when the current spot price is less than the maximum price you specify. Spot
be updated based on available spot instance capacity and current spot price will be updated based on available spot instance capacity and current
instance requests. It may save you some costs. You can set this to "auto" for spot instance requests. It may save you some costs. You can set this to
Packer to automatically discover the best spot price. "auto" for Packer to automatically discover the best spot price.
- `spot_price_auto_product` (string) - Required if `spot_price` is set - `spot_price_auto_product` (string) - Required if `spot_price` is set
to "auto". This tells Packer what sort of AMI you're launching to find the to "auto". This tells Packer what sort of AMI you're launching to find the
best spot price. This must be one of: `Linux/UNIX`, `SUSE Linux`, `Windows`, best spot price. This must be one of: `Linux/UNIX`, `SUSE Linux`, `Windows`,
`Linux/UNIX (Amazon VPC)`, `SUSE Linux (Amazon VPC)`, `Windows (Amazon VPC)` `Linux/UNIX (Amazon VPC)`, `SUSE Linux (Amazon VPC)`, `Windows (Amazon VPC)`
- `ssh_keypair_name` (string) - If specified, this is the key that will be used - `ssh_keypair_name` (string) - If specified, this is the key that will be
for SSH with the machine. By default, this is blank, and Packer will generate used for SSH with the machine. By default, this is blank, and Packer will
a temporary keypair. `ssh_private_key_file` must be specified with this. generate a temporary keypair. `ssh_private_key_file` must be specified
with this.
- `ssh_private_ip` (boolean) - If true, then SSH will always use the private IP - `ssh_private_ip` (boolean) - If true, then SSH will always use the private
if available. IP if available.
- `subnet_id` (string) - If using VPC, the ID of the subnet, such as - `subnet_id` (string) - If using VPC, the ID of the subnet, such as
"subnet-12345def", where Packer will launch the EC2 instance. This field is "subnet-12345def", where Packer will launch the EC2 instance. This field is
...@@ -179,20 +181,20 @@ builder. ...@@ -179,20 +181,20 @@ builder.
- `temporary_key_pair_name` (string) - The name of the temporary keypair - `temporary_key_pair_name` (string) - The name of the temporary keypair
to generate. By default, Packer generates a name with a UUID. to generate. By default, Packer generates a name with a UUID.
- `token` (string) - The access token to use. This is different from the access - `token` (string) - The access token to use. This is different from the
key and secret key. If you're not sure what this is, then you probably don't access key and secret key. If you're not sure what this is, then you
need it. This will also be read from the `AWS_SECURITY_TOKEN` probably don't need it. This will also be read from the `AWS_SECURITY_TOKEN`
environmental variable. environmental variable.
- `user_data` (string) - User data to apply when launching the instance. Note - `user_data` (string) - User data to apply when launching the instance. Note
that you need to be careful about escaping characters due to the templates that you need to be careful about escaping characters due to the templates
being JSON. It is often more convenient to use `user_data_file`, instead. being JSON. It is often more convenient to use `user_data_file`, instead.
- `user_data_file` (string) - Path to a file that will be used for the user data - `user_data_file` (string) - Path to a file that will be used for the user
when launching the instance. data when launching the instance.
- `vpc_id` (string) - If launching into a VPC subnet, Packer needs the VPC ID in - `vpc_id` (string) - If launching into a VPC subnet, Packer needs the VPC ID
order to create a temporary security group within the VPC. in order to create a temporary security group within the VPC.
- `windows_password_timeout` (string) - The timeout for waiting for a Windows - `windows_password_timeout` (string) - The timeout for waiting for a Windows
password for Windows instances. Defaults to 20 minutes. Example value: "10m" password for Windows instances. Defaults to 20 minutes. Example value: "10m"
......
...@@ -78,57 +78,59 @@ builder. ...@@ -78,57 +78,59 @@ builder.
- `source_ami` (string) - The initial AMI used as a base for the newly - `source_ami` (string) - The initial AMI used as a base for the newly
created machine. created machine.
- `ssh_username` (string) - The username to use in order to communicate over SSH - `ssh_username` (string) - The username to use in order to communicate over
to the running machine. SSH to the running machine.
- `x509_cert_path` (string) - The local path to a valid X509 certificate for - `x509_cert_path` (string) - The local path to a valid X509 certificate for
your AWS account. This is used for bundling the AMI. This X509 certificate your AWS account. This is used for bundling the AMI. This X509 certificate
must be registered with your account from the security credentials page in the must be registered with your account from the security credentials page in
AWS console. the AWS console.
- `x509_key_path` (string) - The local path to the private key for the X509 - `x509_key_path` (string) - The local path to the private key for the X509
certificate specified by `x509_cert_path`. This is used for bundling the AMI. certificate specified by `x509_cert_path`. This is used for bundling
the AMI.
### Optional: ### Optional:
- `ami_block_device_mappings` (array of block device mappings) - Add the block - `ami_block_device_mappings` (array of block device mappings) - Add the block
device mappings to the AMI. The block device mappings allow for keys: device mappings to the AMI. The block device mappings allow for keys:
- `device_name` (string) - The device name exposed to the instance (for - `device_name` (string) - The device name exposed to the instance (for
example, "/dev/sdh" or "xvdh") example, "/dev/sdh" or "xvdh")
- `virtual_name` (string) - The virtual device name. See the documentation on - `virtual_name` (string) - The virtual device name. See the documentation on
[Block Device [Block Device
Mapping](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html) Mapping](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html)
for more information for more information
- `snapshot_id` (string) - The ID of the snapshot - `snapshot_id` (string) - The ID of the snapshot
- `volume_type` (string) - The volume type. gp2 for General Purpose (SSD) - `volume_type` (string) - The volume type. gp2 for General Purpose (SSD)
volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic
volumes volumes
- `volume_size` (integer) - The size of the volume, in GiB. Required if not - `volume_size` (integer) - The size of the volume, in GiB. Required if not
specifying a `snapshot_id` specifying a `snapshot_id`
- `delete_on_termination` (boolean) - Indicates whether the EBS volume is - `delete_on_termination` (boolean) - Indicates whether the EBS volume is
deleted on instance termination deleted on instance termination
- `encrypted` (boolean) - Indicates whether to encrypt the volume or not - `encrypted` (boolean) - Indicates whether to encrypt the volume or not
- `no_device` (boolean) - Suppresses the specified device included in the - `no_device` (boolean) - Suppresses the specified device included in the
block device mapping of the AMI block device mapping of the AMI
- `iops` (integer) - The number of I/O operations per second (IOPS) that the - `iops` (integer) - The number of I/O operations per second (IOPS) that the
volume supports. See the documentation on volume supports. See the documentation on
[IOPs](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html) [IOPs](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html)
for more information for more information
- `ami_description` (string) - The description to set for the resulting AMI(s). - `ami_description` (string) - The description to set for the
By default this description is empty. resulting AMI(s). By default this description is empty.
- `ami_groups` (array of strings) - A list of groups that have access to launch - `ami_groups` (array of strings) - A list of groups that have access to
the resulting AMI(s). By default no groups have permission to launch the AMI. launch the resulting AMI(s). By default no groups have permission to launch
`all` will make the AMI publicly accessible. AWS currently doesn't accept any the AMI. `all` will make the AMI publicly accessible. AWS currently doesn't
value other than "all". accept any value other than "all".
- `ami_product_codes` (array of strings) - A list of product codes to associate - `ami_product_codes` (array of strings) - A list of product codes to
with the AMI. By default no product codes are associated with the AMI. associate with the AMI. By default no product codes are associated with
the AMI.
- `ami_regions` (array of strings) - A list of regions to copy the AMI to. Tags - `ami_regions` (array of strings) - A list of regions to copy the AMI to.
and attributes are copied along with the AMI. AMI copying takes time depending Tags and attributes are copied along with the AMI. AMI copying takes time
on the size of the AMI, but will generally take many minutes. depending on the size of the AMI, but will generally take many minutes.
- `ami_users` (array of strings) - A list of account IDs that have access to - `ami_users` (array of strings) - A list of account IDs that have access to
launch the resulting AMI(s). By default no additional users other than the launch the resulting AMI(s). By default no additional users other than the
...@@ -151,8 +153,8 @@ builder. ...@@ -151,8 +153,8 @@ builder.
- `bundle_prefix` (string) - The prefix for files created from bundling the - `bundle_prefix` (string) - The prefix for files created from bundling the
root volume. By default this is "image-{{timestamp}}". The `timestamp` root volume. By default this is "image-{{timestamp}}". The `timestamp`
variable should be used to make sure this is unique, otherwise it can collide variable should be used to make sure this is unique, otherwise it can
with other created AMIs by Packer in your account. collide with other created AMIs by Packer in your account.
- `bundle_upload_command` (string) - The command to use to upload the - `bundle_upload_command` (string) - The command to use to upload the
bundled volume. See the "custom bundle commands" section below for bundled volume. See the "custom bundle commands" section below for
...@@ -161,9 +163,9 @@ builder. ...@@ -161,9 +163,9 @@ builder.
- `bundle_vol_command` (string) - The command to use to bundle the volume. See - `bundle_vol_command` (string) - The command to use to bundle the volume. See
the "custom bundle commands" section below for more information. the "custom bundle commands" section below for more information.
- `enhanced_networking` (boolean) - Enable enhanced networking (SriovNetSupport) - `enhanced_networking` (boolean) - Enable enhanced
on HVM-compatible AMIs. If true, add `ec2:ModifyInstanceAttribute` to your AWS networking (SriovNetSupport) on HVM-compatible AMIs. If true, add
IAM policy. `ec2:ModifyInstanceAttribute` to your AWS IAM policy.
- `force_deregister` (boolean) - Force Packer to first deregister an existing - `force_deregister` (boolean) - Force Packer to first deregister an existing
AMI if one with the same name already exists. Default `false`. AMI if one with the same name already exists. Default `false`.
...@@ -176,38 +178,39 @@ builder. ...@@ -176,38 +178,39 @@ builder.
block device mappings to the launch instance. The block device mappings are block device mappings to the launch instance. The block device mappings are
the same as `ami_block_device_mappings` above. the same as `ami_block_device_mappings` above.
- `run_tags` (object of key/value strings) - Tags to apply to the instance that - `run_tags` (object of key/value strings) - Tags to apply to the instance
is *launched* to create the AMI. These tags are *not* applied to the resulting that is *launched* to create the AMI. These tags are *not* applied to the
AMI unless they're duplicated in `tags`. resulting AMI unless they're duplicated in `tags`.
- `security_group_id` (string) - The ID (*not* the name) of the security group - `security_group_id` (string) - The ID (*not* the name) of the security group
to assign to the instance. By default this is not set and Packer will to assign to the instance. By default this is not set and Packer will
automatically create a new temporary security group to allow SSH access. Note automatically create a new temporary security group to allow SSH access.
that if this is specified, you must be sure the security group allows access Note that if this is specified, you must be sure the security group allows
to the `ssh_port` given below. access to the `ssh_port` given below.
- `security_group_ids` (array of strings) - A list of security groups as - `security_group_ids` (array of strings) - A list of security groups as
described above. Note that if this is specified, you must omit the described above. Note that if this is specified, you must omit the
`security_group_id`. `security_group_id`.
- `spot_price` (string) - The maximum hourly price to launch a spot instance to - `spot_price` (string) - The maximum hourly price to launch a spot instance
create the AMI. It is a type of instances that EC2 starts when the maximum to create the AMI. It is a type of instances that EC2 starts when the
price that you specify exceeds the current spot price. Spot price will be maximum price that you specify exceeds the current spot price. Spot price
updated based on available spot instance capacity and current spot will be updated based on available spot instance capacity and current spot
Instance requests. It may save you some costs. You can set this to "auto" for Instance requests. It may save you some costs. You can set this to "auto"
Packer to automatically discover the best spot price. for Packer to automatically discover the best spot price.
- `spot_price_auto_product` (string) - Required if `spot_price` is set - `spot_price_auto_product` (string) - Required if `spot_price` is set
to "auto". This tells Packer what sort of AMI you're launching to find the to "auto". This tells Packer what sort of AMI you're launching to find the
best spot price. This must be one of: `Linux/UNIX`, `SUSE Linux`, `Windows`, best spot price. This must be one of: `Linux/UNIX`, `SUSE Linux`, `Windows`,
`Linux/UNIX (Amazon VPC)`, `SUSE Linux (Amazon VPC)`, `Windows (Amazon VPC)` `Linux/UNIX (Amazon VPC)`, `SUSE Linux (Amazon VPC)`, `Windows (Amazon VPC)`
- `ssh_keypair_name` (string) - If specified, this is the key that will be used - `ssh_keypair_name` (string) - If specified, this is the key that will be
for SSH with the machine. By default, this is blank, and Packer will generate used for SSH with the machine. By default, this is blank, and Packer will
a temporary keypair. `ssh_private_key_file` must be specified with this. generate a temporary keypair. `ssh_private_key_file` must be specified
with this.
- `ssh_private_ip` (boolean) - If true, then SSH will always use the private IP - `ssh_private_ip` (boolean) - If true, then SSH will always use the private
if available. IP if available.
- `subnet_id` (string) - If using VPC, the ID of the subnet, such as - `subnet_id` (string) - If using VPC, the ID of the subnet, such as
"subnet-12345def", where Packer will launch the EC2 instance. This field is "subnet-12345def", where Packer will launch the EC2 instance. This field is
...@@ -222,11 +225,11 @@ builder. ...@@ -222,11 +225,11 @@ builder.
that you need to be careful about escaping characters due to the templates that you need to be careful about escaping characters due to the templates
being JSON. It is often more convenient to use `user_data_file`, instead. being JSON. It is often more convenient to use `user_data_file`, instead.
- `user_data_file` (string) - Path to a file that will be used for the user data - `user_data_file` (string) - Path to a file that will be used for the user
when launching the instance. data when launching the instance.
- `vpc_id` (string) - If launching into a VPC subnet, Packer needs the VPC ID in - `vpc_id` (string) - If launching into a VPC subnet, Packer needs the VPC ID
order to create a temporary security group within the VPC. in order to create a temporary security group within the VPC.
- `x509_upload_path` (string) - The path on the remote machine where the X509 - `x509_upload_path` (string) - The path on the remote machine where the X509
certificate will be uploaded. This path must already exist and be writable. certificate will be uploaded. This path must already exist and be writable.
......
...@@ -13,12 +13,13 @@ multiple builders depending on the strategy you want to use to build the AMI. ...@@ -13,12 +13,13 @@ multiple builders depending on the strategy you want to use to build the AMI.
Packer supports the following builders at the moment: Packer supports the following builders at the moment:
- [amazon-ebs](/docs/builders/amazon-ebs.html) - Create EBS-backed AMIs by - [amazon-ebs](/docs/builders/amazon-ebs.html) - Create EBS-backed AMIs by
launching a source AMI and re-packaging it into a new AMI after provisioning. launching a source AMI and re-packaging it into a new AMI
If in doubt, use this builder, which is the easiest to get started with. after provisioning. If in doubt, use this builder, which is the easiest to
get started with.
- [amazon-instance](/docs/builders/amazon-instance.html) - Create instance-store - [amazon-instance](/docs/builders/amazon-instance.html) - Create
AMIs by launching and provisioning a source instance, then rebundling it and instance-store AMIs by launching and provisioning a source instance, then
uploading it to S3. rebundling it and uploading it to S3.
- [amazon-chroot](/docs/builders/amazon-chroot.html) - Create EBS-backed AMIs - [amazon-chroot](/docs/builders/amazon-chroot.html) - Create EBS-backed AMIs
from an existing EC2 instance by mounting the root device and using a from an existing EC2 instance by mounting the root device and using a
......
...@@ -34,34 +34,36 @@ builder. ...@@ -34,34 +34,36 @@ builder.
### Required: ### Required:
- `api_token` (string) - The client TOKEN to use to access your account. It can - `api_token` (string) - The client TOKEN to use to access your account. It
also be specified via environment variable `DIGITALOCEAN_API_TOKEN`, if set. can also be specified via environment variable `DIGITALOCEAN_API_TOKEN`,
if set.
- `image` (string) - The name (or slug) of the base image to use. This is the - `image` (string) - The name (or slug) of the base image to use. This is the
image that will be used to launch a new droplet and provision it. See image that will be used to launch a new droplet and provision it. See
https://developers.digitalocean.com/documentation/v2/\#list-all-images for https://developers.digitalocean.com/documentation/v2/\#list-all-images for
details on how to get a list of the the accepted image names/slugs. details on how to get a list of the the accepted image names/slugs.
- `region` (string) - The name (or slug) of the region to launch the droplet in. - `region` (string) - The name (or slug) of the region to launch the
Consequently, this is the region where the snapshot will be available. See droplet in. Consequently, this is the region where the snapshot will
be available. See
https://developers.digitalocean.com/documentation/v2/\#list-all-regions for https://developers.digitalocean.com/documentation/v2/\#list-all-regions for
the accepted region names/slugs. the accepted region names/slugs.
- `size` (string) - The name (or slug) of the droplet size to use. See - `size` (string) - The name (or slug) of the droplet size to use. See
https://developers.digitalocean.com/documentation/v2/\#list-all-sizes for the https://developers.digitalocean.com/documentation/v2/\#list-all-sizes for
accepted size names/slugs. the accepted size names/slugs.
### Optional: ### Optional:
- `droplet_name` (string) - The name assigned to the droplet. DigitalOcean sets - `droplet_name` (string) - The name assigned to the droplet. DigitalOcean
the hostname of the machine to this value. sets the hostname of the machine to this value.
- `private_networking` (boolean) - Set to `true` to enable private networking - `private_networking` (boolean) - Set to `true` to enable private networking
for the droplet being created. This defaults to `false`, or not enabled. for the droplet being created. This defaults to `false`, or not enabled.
- `snapshot_name` (string) - The name of the resulting snapshot that will appear - `snapshot_name` (string) - The name of the resulting snapshot that will
in your account. This must be unique. To help make this unique, use a function appear in your account. This must be unique. To help make this unique, use a
like `timestamp` (see [configuration function like `timestamp` (see [configuration
templates](/docs/templates/configuration-templates.html) for more info) templates](/docs/templates/configuration-templates.html) for more info)
- `state_timeout` (string) - The time to wait, as a duration string, for a - `state_timeout` (string) - The time to wait, as a duration string, for a
......
...@@ -93,8 +93,8 @@ builder. ...@@ -93,8 +93,8 @@ builder.
- `login_server` (string) - The server address to login to. - `login_server` (string) - The server address to login to.
- `pull` (boolean) - If true, the configured image will be pulled using - `pull` (boolean) - If true, the configured image will be pulled using
`docker pull` prior to use. Otherwise, it is assumed the image already exists `docker pull` prior to use. Otherwise, it is assumed the image already
and can be used. This defaults to true if not set. exists and can be used. This defaults to true if not set.
- `run_command` (array of strings) - An array of arguments to pass to - `run_command` (array of strings) - An array of arguments to pass to
`docker run` in order to run the container. By default this is set to `docker run` in order to run the container. By default this is set to
...@@ -226,11 +226,11 @@ Dockerfiles have some additional features that Packer doesn't support which are ...@@ -226,11 +226,11 @@ Dockerfiles have some additional features that Packer doesn't support which are
able to be worked around. Many of these features will be automated by Packer in able to be worked around. Many of these features will be automated by Packer in
the future: the future:
- Dockerfiles will snapshot the container at each step, allowing you to go back - Dockerfiles will snapshot the container at each step, allowing you to go
to any step in the history of building. Packer doesn't do this yet, but back to any step in the history of building. Packer doesn't do this yet, but
inter-step snapshotting is on the way. inter-step snapshotting is on the way.
- Dockerfiles can contain information such as exposed ports, shared volumes, and - Dockerfiles can contain information such as exposed ports, shared volumes,
other metadata. Packer builds a raw Docker container image that has none of and other metadata. Packer builds a raw Docker container image that has none
this metadata. You can pass in much of this metadata at runtime with of this metadata. You can pass in much of this metadata at runtime with
`docker run`. `docker run`.
...@@ -43,10 +43,10 @@ builder. ...@@ -43,10 +43,10 @@ builder.
- `image_name` (string) - The name of the resulting image. - `image_name` (string) - The name of the resulting image.
- `source_image` (string) - The ID or full URL to the base image to use. This is - `source_image` (string) - The ID or full URL to the base image to use. This
the image that will be used to launch a new server and provision it. Unless is the image that will be used to launch a new server and provision it.
you specify completely custom SSH settings, the source image must have Unless you specify completely custom SSH settings, the source image must
`cloud-init` installed so that the keypair gets assigned properly. have `cloud-init` installed so that the keypair gets assigned properly.
- `username` (string) - The username used to connect to the OpenStack service. - `username` (string) - The username used to connect to the OpenStack service.
If not specified, Packer will use the environment variable `OS_USERNAME`, If not specified, Packer will use the environment variable `OS_USERNAME`,
...@@ -61,19 +61,19 @@ builder. ...@@ -61,19 +61,19 @@ builder.
- `api_key` (string) - The API key used to access OpenStack. Some OpenStack - `api_key` (string) - The API key used to access OpenStack. Some OpenStack
installations require this. installations require this.
- `availability_zone` (string) - The availability zone to launch the server in. - `availability_zone` (string) - The availability zone to launch the
If this isn't specified, the default enforced by your OpenStack cluster will server in. If this isn't specified, the default enforced by your OpenStack
be used. This may be required for some OpenStack clusters. cluster will be used. This may be required for some OpenStack clusters.
- `floating_ip` (string) - A specific floating IP to assign to this instance. - `floating_ip` (string) - A specific floating IP to assign to this instance.
`use_floating_ip` must also be set to true for this to have an affect. `use_floating_ip` must also be set to true for this to have an affect.
- `floating_ip_pool` (string) - The name of the floating IP pool to use to - `floating_ip_pool` (string) - The name of the floating IP pool to use to
allocate a floating IP. `use_floating_ip` must also be set to true for this to allocate a floating IP. `use_floating_ip` must also be set to true for this
have an affect. to have an affect.
- `insecure` (boolean) - Whether or not the connection to OpenStack can be done - `insecure` (boolean) - Whether or not the connection to OpenStack can be
over an insecure connection. By default this is false. done over an insecure connection. By default this is false.
- `networks` (array of strings) - A list of networks by UUID to attach to - `networks` (array of strings) - A list of networks by UUID to attach to
this instance. this instance.
...@@ -85,13 +85,13 @@ builder. ...@@ -85,13 +85,13 @@ builder.
- `security_groups` (array of strings) - A list of security groups by name to - `security_groups` (array of strings) - A list of security groups by name to
add to this instance. add to this instance.
- `region` (string) - The name of the region, such as "DFW", in which to launch - `region` (string) - The name of the region, such as "DFW", in which to
the server to create the AMI. If not specified, Packer will use the launch the server to create the AMI. If not specified, Packer will use the
environment variable `OS_REGION_NAME`, if set. environment variable `OS_REGION_NAME`, if set.
- `ssh_interface` (string) - The type of interface to connect via SSH. Values - `ssh_interface` (string) - The type of interface to connect via SSH. Values
useful for Rackspace are "public" or "private", and the default behavior is to useful for Rackspace are "public" or "private", and the default behavior is
connect via whichever is returned first from the OpenStack API. to connect via whichever is returned first from the OpenStack API.
- `use_floating_ip` (boolean) - Whether or not to use a floating IP for - `use_floating_ip` (boolean) - Whether or not to use a floating IP for
the instance. Defaults to false. the instance. Defaults to false.
......
...@@ -56,10 +56,10 @@ builder. ...@@ -56,10 +56,10 @@ builder.
### Required: ### Required:
- `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO files - `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO
are so large, this is required and Packer will verify it prior to booting a files are so large, this is required and Packer will verify it prior to
virtual machine with the ISO attached. The type of the checksum is specified booting a virtual machine with the ISO attached. The type of the checksum is
with `iso_checksum_type`, documented below. specified with `iso_checksum_type`, documented below.
- `iso_checksum_type` (string) - The type of the checksum specified in - `iso_checksum_type` (string) - The type of the checksum specified in
`iso_checksum`. Valid values are "none", "md5", "sha1", "sha256", or `iso_checksum`. Valid values are "none", "md5", "sha1", "sha256", or
...@@ -67,34 +67,35 @@ builder. ...@@ -67,34 +67,35 @@ builder.
recommended since ISO files are generally large and corruption does happen recommended since ISO files are generally large and corruption does happen
from time to time. from time to time.
- `iso_url` (string) - A URL to the ISO containing the installation image. This - `iso_url` (string) - A URL to the ISO containing the installation image.
URL can be either an HTTP URL or a file URL (or path to a file). If this is an This URL can be either an HTTP URL or a file URL (or path to a file). If
HTTP URL, Packer will download it and cache it between runs. this is an HTTP URL, Packer will download it and cache it between runs.
- `ssh_username` (string) - The username to use to SSH into the machine once the - `ssh_username` (string) - The username to use to SSH into the machine once
OS is installed. the OS is installed.
- `parallels_tools_flavor` (string) - The flavor of the Parallels Tools ISO to - `parallels_tools_flavor` (string) - The flavor of the Parallels Tools ISO to
install into the VM. Valid values are "win", "lin", "mac", "os2" and "other". install into the VM. Valid values are "win", "lin", "mac", "os2"
This can be omitted only if `parallels_tools_mode` is "disable". and "other". This can be omitted only if `parallels_tools_mode`
is "disable".
### Optional: ### Optional:
- `boot_command` (array of strings) - This is an array of commands to type when - `boot_command` (array of strings) - This is an array of commands to type
the virtual machine is first booted. The goal of these commands should be to when the virtual machine is first booted. The goal of these commands should
type just enough to initialize the operating system installer. Special keys be to type just enough to initialize the operating system installer. Special
can be typed as well, and are covered in the section below on the keys can be typed as well, and are covered in the section below on the
boot command. If this is not specified, it is assumed the installer will boot command. If this is not specified, it is assumed the installer will
start itself. start itself.
- `boot_wait` (string) - The time to wait after booting the initial virtual - `boot_wait` (string) - The time to wait after booting the initial virtual
machine before typing the `boot_command`. The value of this should be machine before typing the `boot_command`. The value of this should be
a duration. Examples are "5s" and "1m30s" which will cause Packer to wait five a duration. Examples are "5s" and "1m30s" which will cause Packer to wait
seconds and one minute 30 seconds, respectively. If this isn't specified, the five seconds and one minute 30 seconds, respectively. If this isn't
default is 10 seconds. specified, the default is 10 seconds.
- `disk_size` (integer) - The size, in megabytes, of the hard disk to create for - `disk_size` (integer) - The size, in megabytes, of the hard disk to create
the VM. By default, this is 40000 (about 40 GB). for the VM. By default, this is 40000 (about 40 GB).
- `floppy_files` (array of strings) - A list of files to place onto a floppy - `floppy_files` (array of strings) - A list of files to place onto a floppy
disk that is attached when the VM is booted. This is most useful for disk that is attached when the VM is booted. This is most useful for
...@@ -102,46 +103,46 @@ builder. ...@@ -102,46 +103,46 @@ builder.
removable media. By default, no floppy will be attached. All files listed in removable media. By default, no floppy will be attached. All files listed in
this setting get placed into the root directory of the floppy and the floppy this setting get placed into the root directory of the floppy and the floppy
is attached as the first floppy device. Currently, no support exists for is attached as the first floppy device. Currently, no support exists for
creating sub-directories on the floppy. Wildcard characters (\*, ?, and \[\]) creating sub-directories on the floppy. Wildcard characters (\*, ?,
are allowed. Directory names are also allowed, which will add all the files and \[\]) are allowed. Directory names are also allowed, which will add all
found in the directory to the floppy. the files found in the directory to the floppy.
- `guest_os_type` (string) - The guest OS type being installed. By default this - `guest_os_type` (string) - The guest OS type being installed. By default
is "other", but you can get *dramatic* performance improvements by setting this is "other", but you can get *dramatic* performance improvements by
this to the proper value. To view all available values for this run setting this to the proper value. To view all available values for this run
`prlctl create x --distribution list`. Setting the correct value hints to `prlctl create x --distribution list`. Setting the correct value hints to
Parallels Desktop how to optimize the virtual hardware to work best with that Parallels Desktop how to optimize the virtual hardware to work best with
operating system. that operating system.
- `hard_drive_interface` (string) - The type of controller that the hard drives - `hard_drive_interface` (string) - The type of controller that the hard
are attached to, defaults to "sata". Valid options are "sata", "ide", drives are attached to, defaults to "sata". Valid options are "sata", "ide",
and "scsi". and "scsi".
- `host_interfaces` (array of strings) - A list of which interfaces on the host - `host_interfaces` (array of strings) - A list of which interfaces on the
should be searched for a IP address. The first IP address found on one of host should be searched for a IP address. The first IP address found on one
these will be used as `{{ .HTTPIP }}` in the `boot_command`. Defaults to of these will be used as `{{ .HTTPIP }}` in the `boot_command`. Defaults to
\["en0", "en1", "en2", "en3", "en4", "en5", "en6", "en7", "en8", "en9", \["en0", "en1", "en2", "en3", "en4", "en5", "en6", "en7", "en8", "en9",
"ppp0", "ppp1", "ppp2"\]. "ppp0", "ppp1", "ppp2"\].
- `http_directory` (string) - Path to a directory to serve using an HTTP server. - `http_directory` (string) - Path to a directory to serve using an
The files in this directory will be available over HTTP that will be HTTP server. The files in this directory will be available over HTTP that
requestable from the virtual machine. This is useful for hosting kickstart will be requestable from the virtual machine. This is useful for hosting
files and so on. By default this is "", which means no HTTP server will kickstart files and so on. By default this is "", which means no HTTP server
be started. The address and port of the HTTP server will be available as will be started. The address and port of the HTTP server will be available
variables in `boot_command`. This is covered in more detail below. as variables in `boot_command`. This is covered in more detail below.
- `http_port_min` and `http_port_max` (integer) - These are the minimum and - `http_port_min` and `http_port_max` (integer) - These are the minimum and
maximum port to use for the HTTP server started to serve the `http_directory`. maximum port to use for the HTTP server started to serve the
Because Packer often runs in parallel, Packer will choose a randomly available `http_directory`. Because Packer often runs in parallel, Packer will choose
port in this range to run the HTTP server. If you want to force the HTTP a randomly available port in this range to run the HTTP server. If you want
server to be on one port, make this minimum and maximum port the same. By to force the HTTP server to be on one port, make this minimum and maximum
default the values are 8000 and 9000, respectively. port the same. By default the values are 8000 and 9000, respectively.
- `iso_urls` (array of strings) - Multiple URLs for the ISO to download. Packer - `iso_urls` (array of strings) - Multiple URLs for the ISO to download.
will try these in order. If anything goes wrong attempting to download or Packer will try these in order. If anything goes wrong attempting to
while downloading a single URL, it will move on to the next. All URLs must download or while downloading a single URL, it will move on to the next. All
point to the same file (same checksum). By default this is empty and `iso_url` URLs must point to the same file (same checksum). By default this is empty
is used. Only one of `iso_url` or `iso_urls` can be specified. and `iso_url` is used. Only one of `iso_url` or `iso_urls` can be specified.
- `output_directory` (string) - This is the path to the directory where the - `output_directory` (string) - This is the path to the directory where the
resulting virtual machine will be created. This may be relative or absolute. resulting virtual machine will be created. This may be relative or absolute.
...@@ -154,48 +155,50 @@ builder. ...@@ -154,48 +155,50 @@ builder.
upload Parallels Tools. This only takes effect if `parallels_tools_mode` upload Parallels Tools. This only takes effect if `parallels_tools_mode`
is "upload". This is a [configuration is "upload". This is a [configuration
template](/docs/templates/configuration-templates.html) that has a single template](/docs/templates/configuration-templates.html) that has a single
valid variable: `Flavor`, which will be the value of `parallels_tools_flavor`. valid variable: `Flavor`, which will be the value of
By default this is "prl-tools-{{.Flavor}}.iso" which should upload into the `parallels_tools_flavor`. By default this is "prl-tools-{{.Flavor}}.iso"
login directory of the user. which should upload into the login directory of the user.
- `parallels_tools_mode` (string) - The method by which Parallels Tools are made - `parallels_tools_mode` (string) - The method by which Parallels Tools are
available to the guest for installation. Valid options are "upload", "attach", made available to the guest for installation. Valid options are "upload",
or "disable". If the mode is "attach" the Parallels Tools ISO will be attached "attach", or "disable". If the mode is "attach" the Parallels Tools ISO will
as a CD device to the virtual machine. If the mode is "upload" the Parallels be attached as a CD device to the virtual machine. If the mode is "upload"
Tools ISO will be uploaded to the path specified by the Parallels Tools ISO will be uploaded to the path specified by
`parallels_tools_guest_path`. The default value is "upload". `parallels_tools_guest_path`. The default value is "upload".
- `prlctl` (array of array of strings) - Custom `prlctl` commands to execute in - `prlctl` (array of array of strings) - Custom `prlctl` commands to execute
order to further customize the virtual machine being created. The value of in order to further customize the virtual machine being created. The value
this is an array of commands to execute. The commands are executed in the of this is an array of commands to execute. The commands are executed in the
order defined in the template. For each command, the command is defined itself order defined in the template. For each command, the command is defined
as an array of strings, where each string represents a single argument on the itself as an array of strings, where each string represents a single
command-line to `prlctl` (but excluding `prlctl` itself). Each arg is treated argument on the command-line to `prlctl` (but excluding `prlctl` itself).
as a [configuration template](/docs/templates/configuration-templates.html), Each arg is treated as a [configuration
where the `Name` variable is replaced with the VM name. More details on how to template](/docs/templates/configuration-templates.html), where the `Name`
use `prlctl` are below. variable is replaced with the VM name. More details on how to use `prlctl`
are below.
- `prlctl_post` (array of array of strings) - Identical to `prlctl`, except that
it is run after the virtual machine is shutdown, and before the virtual - `prlctl_post` (array of array of strings) - Identical to `prlctl`, except
that it is run after the virtual machine is shutdown, and before the virtual
machine is exported. machine is exported.
- `prlctl_version_file` (string) - The path within the virtual machine to upload - `prlctl_version_file` (string) - The path within the virtual machine to
a file that contains the `prlctl` version that was used to create the machine. upload a file that contains the `prlctl` version that was used to create
This information can be useful for provisioning. By default this is the machine. This information can be useful for provisioning. By default
".prlctl\_version", which will generally upload it into the home directory. this is ".prlctl\_version", which will generally upload it into the
home directory.
- `shutdown_command` (string) - The command to use to gracefully shut down the - `shutdown_command` (string) - The command to use to gracefully shut down the
machine once all the provisioning is done. By default this is an empty string, machine once all the provisioning is done. By default this is an empty
which tells Packer to just forcefully shut down the machine. string, which tells Packer to just forcefully shut down the machine.
- `shutdown_timeout` (string) - The amount of time to wait after executing the - `shutdown_timeout` (string) - The amount of time to wait after executing the
`shutdown_command` for the virtual machine to actually shut down. If it `shutdown_command` for the virtual machine to actually shut down. If it
doesn't shut down in this time, it is an error. By default, the timeout is doesn't shut down in this time, it is an error. By default, the timeout is
"5m", or five minutes. "5m", or five minutes.
- `vm_name` (string) - This is the name of the PVM directory for the new virtual - `vm_name` (string) - This is the name of the PVM directory for the new
machine, without the file extension. By default this is "packer-BUILDNAME", virtual machine, without the file extension. By default this is
where "BUILDNAME" is the name of the build. "packer-BUILDNAME", where "BUILDNAME" is the name of the build.
## Boot Command ## Boot Command
...@@ -236,16 +239,16 @@ proper key: ...@@ -236,16 +239,16 @@ proper key:
- `<pageUp>` `<pageDown>` - Simulates pressing the page up and page down keys. - `<pageUp>` `<pageDown>` - Simulates pressing the page up and page down keys.
- `<wait>` `<wait5>` `<wait10>` - Adds a 1, 5 or 10 second pause before sending - `<wait>` `<wait5>` `<wait10>` - Adds a 1, 5 or 10 second pause before
any additional keys. This is useful if you have to generally wait for the UI sending any additional keys. This is useful if you have to generally wait
to update before typing more. for the UI to update before typing more.
In addition to the special keys, each command to type is treated as a In addition to the special keys, each command to type is treated as a
[configuration template](/docs/templates/configuration-templates.html). The [configuration template](/docs/templates/configuration-templates.html). The
available variables are: available variables are:
- `HTTPIP` and `HTTPPort` - The IP and port, respectively of an HTTP server that - `HTTPIP` and `HTTPPort` - The IP and port, respectively of an HTTP server
is started serving the directory specified by the `http_directory` that is started serving the directory specified by the `http_directory`
configuration parameter. If `http_directory` isn't specified, these will be configuration parameter. If `http_directory` isn't specified, these will be
blank! blank!
......
...@@ -56,37 +56,38 @@ builder. ...@@ -56,37 +56,38 @@ builder.
- `source_path` (string) - The path to a PVM directory that acts as the source - `source_path` (string) - The path to a PVM directory that acts as the source
of this build. of this build.
- `ssh_username` (string) - The username to use to SSH into the machine once the - `ssh_username` (string) - The username to use to SSH into the machine once
OS is installed. the OS is installed.
- `parallels_tools_flavor` (string) - The flavor of the Parallels Tools ISO to - `parallels_tools_flavor` (string) - The flavor of the Parallels Tools ISO to
install into the VM. Valid values are "win", "lin", "mac", "os2" and "other". install into the VM. Valid values are "win", "lin", "mac", "os2"
This can be omitted only if `parallels_tools_mode` is "disable". and "other". This can be omitted only if `parallels_tools_mode`
is "disable".
### Optional: ### Optional:
- `boot_command` (array of strings) - This is an array of commands to type when - `boot_command` (array of strings) - This is an array of commands to type
the virtual machine is first booted. The goal of these commands should be to when the virtual machine is first booted. The goal of these commands should
type just enough to initialize the operating system installer. Special keys be to type just enough to initialize the operating system installer. Special
can be typed as well, and are covered in the section below on the keys can be typed as well, and are covered in the section below on the
boot command. If this is not specified, it is assumed the installer will boot command. If this is not specified, it is assumed the installer will
start itself. start itself.
- `boot_wait` (string) - The time to wait after booting the initial virtual - `boot_wait` (string) - The time to wait after booting the initial virtual
machine before typing the `boot_command`. The value of this should be machine before typing the `boot_command`. The value of this should be
a duration. Examples are "5s" and "1m30s" which will cause Packer to wait five a duration. Examples are "5s" and "1m30s" which will cause Packer to wait
seconds and one minute 30 seconds, respectively. If this isn't specified, the five seconds and one minute 30 seconds, respectively. If this isn't
default is 10 seconds. specified, the default is 10 seconds.
- `floppy_files` (array of strings) - A list of files to put onto a floppy disk - `floppy_files` (array of strings) - A list of files to put onto a floppy
that is attached when the VM is booted for the first time. This is most useful disk that is attached when the VM is booted for the first time. This is most
for unattended Windows installs, which look for an `Autounattend.xml` file on useful for unattended Windows installs, which look for an `Autounattend.xml`
removable media. By default no floppy will be attached. The files listed in file on removable media. By default no floppy will be attached. The files
this configuration will all be put into the root directory of the floppy disk; listed in this configuration will all be put into the root directory of the
sub-directories are not supported. floppy disk; sub-directories are not supported.
- `reassign_mac` (boolean) - If this is "false" the MAC address of the first NIC - `reassign_mac` (boolean) - If this is "false" the MAC address of the first
will reused when imported else a new MAC address will be generated NIC will reused when imported else a new MAC address will be generated
by Parallels. Defaults to "false". by Parallels. Defaults to "false".
- `output_directory` (string) - This is the path to the directory where the - `output_directory` (string) - This is the path to the directory where the
...@@ -97,42 +98,44 @@ builder. ...@@ -97,42 +98,44 @@ builder.
name of the build. name of the build.
- `parallels_tools_guest_path` (string) - The path in the VM to upload - `parallels_tools_guest_path` (string) - The path in the VM to upload
Parallels Tools. This only takes effect if `parallels_tools_mode` is "upload". Parallels Tools. This only takes effect if `parallels_tools_mode`
This is a [configuration is "upload". This is a [configuration
template](/docs/templates/configuration-templates.html) that has a single template](/docs/templates/configuration-templates.html) that has a single
valid variable: `Flavor`, which will be the value of `parallels_tools_flavor`. valid variable: `Flavor`, which will be the value of
By default this is "prl-tools-{{.Flavor}}.iso" which should upload into the `parallels_tools_flavor`. By default this is "prl-tools-{{.Flavor}}.iso"
login directory of the user. which should upload into the login directory of the user.
- `parallels_tools_mode` (string) - The method by which Parallels Tools are made - `parallels_tools_mode` (string) - The method by which Parallels Tools are
available to the guest for installation. Valid options are "upload", "attach", made available to the guest for installation. Valid options are "upload",
or "disable". If the mode is "attach" the Parallels Tools ISO will be attached "attach", or "disable". If the mode is "attach" the Parallels Tools ISO will
as a CD device to the virtual machine. If the mode is "upload" the Parallels be attached as a CD device to the virtual machine. If the mode is "upload"
Tools ISO will be uploaded to the path specified by the Parallels Tools ISO will be uploaded to the path specified by
`parallels_tools_guest_path`. The default value is "upload". `parallels_tools_guest_path`. The default value is "upload".
- `prlctl` (array of array of strings) - Custom `prlctl` commands to execute in - `prlctl` (array of array of strings) - Custom `prlctl` commands to execute
order to further customize the virtual machine being created. The value of in order to further customize the virtual machine being created. The value
this is an array of commands to execute. The commands are executed in the of this is an array of commands to execute. The commands are executed in the
order defined in the template. For each command, the command is defined itself order defined in the template. For each command, the command is defined
as an array of strings, where each string represents a single argument on the itself as an array of strings, where each string represents a single
command-line to `prlctl` (but excluding `prlctl` itself). Each arg is treated argument on the command-line to `prlctl` (but excluding `prlctl` itself).
as a [configuration template](/docs/templates/configuration-templates.html), Each arg is treated as a [configuration
where the `Name` variable is replaced with the VM name. More details on how to template](/docs/templates/configuration-templates.html), where the `Name`
use `prlctl` are below. variable is replaced with the VM name. More details on how to use `prlctl`
are below.
- `prlctl_post` (array of array of strings) - Identical to `prlctl`, except that
it is run after the virtual machine is shutdown, and before the virtual - `prlctl_post` (array of array of strings) - Identical to `prlctl`, except
that it is run after the virtual machine is shutdown, and before the virtual
machine is exported. machine is exported.
- `prlctl_version_file` (string) - The path within the virtual machine to upload - `prlctl_version_file` (string) - The path within the virtual machine to
a file that contains the `prlctl` version that was used to create the machine. upload a file that contains the `prlctl` version that was used to create
This information can be useful for provisioning. By default this is the machine. This information can be useful for provisioning. By default
".prlctl\_version", which will generally upload it into the home directory. this is ".prlctl\_version", which will generally upload it into the
home directory.
- `shutdown_command` (string) - The command to use to gracefully shut down the - `shutdown_command` (string) - The command to use to gracefully shut down the
machine once all the provisioning is done. By default this is an empty string, machine once all the provisioning is done. By default this is an empty
which tells Packer to just forcefully shut down the machine. string, which tells Packer to just forcefully shut down the machine.
- `shutdown_timeout` (string) - The amount of time to wait after executing the - `shutdown_timeout` (string) - The amount of time to wait after executing the
`shutdown_command` for the virtual machine to actually shut down. If it `shutdown_command` for the virtual machine to actually shut down. If it
...@@ -190,9 +193,9 @@ proper key: ...@@ -190,9 +193,9 @@ proper key:
- `<pageUp>` `<pageDown>` - Simulates pressing the page up and page down keys. - `<pageUp>` `<pageDown>` - Simulates pressing the page up and page down keys.
- `<wait>` `<wait5>` `<wait10>` - Adds a 1, 5 or 10 second pause before sending - `<wait>` `<wait5>` `<wait10>` - Adds a 1, 5 or 10 second pause before
any additional keys. This is useful if you have to generally wait for the UI sending any additional keys. This is useful if you have to generally wait
to update before typing more. for the UI to update before typing more.
In addition to the special keys, each command to type is treated as a In addition to the special keys, each command to type is treated as a
[configuration template](/docs/templates/configuration-templates.html). The [configuration template](/docs/templates/configuration-templates.html). The
......
...@@ -16,16 +16,16 @@ Packer actually comes with multiple builders able to create Parallels machines, ...@@ -16,16 +16,16 @@ Packer actually comes with multiple builders able to create Parallels machines,
depending on the strategy you want to use to build the image. Packer supports depending on the strategy you want to use to build the image. Packer supports
the following Parallels builders: the following Parallels builders:
- [parallels-iso](/docs/builders/parallels-iso.html) - Starts from an ISO file, - [parallels-iso](/docs/builders/parallels-iso.html) - Starts from an ISO
creates a brand new Parallels VM, installs an OS, provisions software within file, creates a brand new Parallels VM, installs an OS, provisions software
the OS, then exports that machine to create an image. This is best for people within the OS, then exports that machine to create an image. This is best
who want to start from scratch. for people who want to start from scratch.
- [parallels-pvm](/docs/builders/parallels-pvm.html) - This builder imports an - [parallels-pvm](/docs/builders/parallels-pvm.html) - This builder imports an
existing PVM file, runs provisioners on top of that VM, and exports that existing PVM file, runs provisioners on top of that VM, and exports that
machine to create an image. This is best if you have an existing Parallels VM machine to create an image. This is best if you have an existing Parallels
export you want to use as the source. As an additional benefit, you can feed VM export you want to use as the source. As an additional benefit, you can
the artifact of this builder back into itself to iterate on a machine. feed the artifact of this builder back into itself to iterate on a machine.
## Requirements ## Requirements
......
...@@ -81,61 +81,61 @@ builder. ...@@ -81,61 +81,61 @@ builder.
### Required: ### Required:
- `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO files - `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO
are so large, this is required and Packer will verify it prior to booting a files are so large, this is required and Packer will verify it prior to
virtual machine with the ISO attached. The type of the checksum is specified booting a virtual machine with the ISO attached. The type of the checksum is
with `iso_checksum_type`, documented below. specified with `iso_checksum_type`, documented below.
- `iso_checksum_type` (string) - The type of the checksum specified in - `iso_checksum_type` (string) - The type of the checksum specified in
`iso_checksum`. Valid values are "md5", "sha1", "sha256", or `iso_checksum`. Valid values are "md5", "sha1", "sha256", or
"sha512" currently. "sha512" currently.
- `iso_url` (string) - A URL to the ISO containing the installation image. This - `iso_url` (string) - A URL to the ISO containing the installation image.
URL can be either an HTTP URL or a file URL (or path to a file). If this is an This URL can be either an HTTP URL or a file URL (or path to a file). If
HTTP URL, Packer will download it and cache it between runs. this is an HTTP URL, Packer will download it and cache it between runs.
- `ssh_username` (string) - The username to use to SSH into the machine once the - `ssh_username` (string) - The username to use to SSH into the machine once
OS is installed. the OS is installed.
### Optional: ### Optional:
- `accelerator` (string) - The accelerator type to use when running the VM. This - `accelerator` (string) - The accelerator type to use when running the VM.
may have a value of either "none", "kvm", "tcg", or "xen" and you must have This may have a value of either "none", "kvm", "tcg", or "xen" and you must
that support in on the machine on which you run the builder. By default "kvm" have that support in on the machine on which you run the builder. By default
is used. "kvm" is used.
- `boot_command` (array of strings) - This is an array of commands to type when - `boot_command` (array of strings) - This is an array of commands to type
the virtual machine is first booted. The goal of these commands should be to when the virtual machine is first booted. The goal of these commands should
type just enough to initialize the operating system installer. Special keys be to type just enough to initialize the operating system installer. Special
can be typed as well, and are covered in the section below on the keys can be typed as well, and are covered in the section below on the
boot command. If this is not specified, it is assumed the installer will boot command. If this is not specified, it is assumed the installer will
start itself. start itself.
- `boot_wait` (string) - The time to wait after booting the initial virtual - `boot_wait` (string) - The time to wait after booting the initial virtual
machine before typing the `boot_command`. The value of this should be machine before typing the `boot_command`. The value of this should be
a duration. Examples are "5s" and "1m30s" which will cause Packer to wait five a duration. Examples are "5s" and "1m30s" which will cause Packer to wait
seconds and one minute 30 seconds, respectively. If this isn't specified, the five seconds and one minute 30 seconds, respectively. If this isn't
default is 10 seconds. specified, the default is 10 seconds.
- `disk_cache` (string) - The cache mode to use for disk. Allowed values include - `disk_cache` (string) - The cache mode to use for disk. Allowed values
any of "writethrough", "writeback", "none", "unsafe" or "directsync". By include any of "writethrough", "writeback", "none", "unsafe"
default, this is set to "writeback". or "directsync". By default, this is set to "writeback".
- `disk_discard` (string) - The discard mode to use for disk. Allowed values - `disk_discard` (string) - The discard mode to use for disk. Allowed values
include any of "unmap" or "ignore". By default, this is set to "ignore". include any of "unmap" or "ignore". By default, this is set to "ignore".
- `disk_image` (boolean) - Packer defaults to building from an ISO file, this - `disk_image` (boolean) - Packer defaults to building from an ISO file, this
parameter controls whether the ISO URL supplied is actually a bootable parameter controls whether the ISO URL supplied is actually a bootable
QEMU image. When this value is set to true, the machine will clone the source, QEMU image. When this value is set to true, the machine will clone the
resize it according to `disk_size` and boot the image. source, resize it according to `disk_size` and boot the image.
- `disk_interface` (string) - The interface to use for the disk. Allowed values - `disk_interface` (string) - The interface to use for the disk. Allowed
include any of "ide," "scsi" or "virtio." Note also that any boot commands or values include any of "ide," "scsi" or "virtio." Note also that any boot
kickstart type scripts must have proper adjustments for resulting commands or kickstart type scripts must have proper adjustments for
device names. The Qemu builder uses "virtio" by default. resulting device names. The Qemu builder uses "virtio" by default.
- `disk_size` (integer) - The size, in megabytes, of the hard disk to create for - `disk_size` (integer) - The size, in megabytes, of the hard disk to create
the VM. By default, this is 40000 (about 40 GB). for the VM. By default, this is 40000 (about 40 GB).
- `floppy_files` (array of strings) - A list of files to place onto a floppy - `floppy_files` (array of strings) - A list of files to place onto a floppy
disk that is attached when the VM is booted. This is most useful for disk that is attached when the VM is booted. This is most useful for
...@@ -143,40 +143,40 @@ builder. ...@@ -143,40 +143,40 @@ builder.
removable media. By default, no floppy will be attached. All files listed in removable media. By default, no floppy will be attached. All files listed in
this setting get placed into the root directory of the floppy and the floppy this setting get placed into the root directory of the floppy and the floppy
is attached as the first floppy device. Currently, no support exists for is attached as the first floppy device. Currently, no support exists for
creating sub-directories on the floppy. Wildcard characters (\*, ?, and \[\]) creating sub-directories on the floppy. Wildcard characters (\*, ?,
are allowed. Directory names are also allowed, which will add all the files and \[\]) are allowed. Directory names are also allowed, which will add all
found in the directory to the floppy. the files found in the directory to the floppy.
- `format` (string) - Either "qcow2" or "raw", this specifies the output format - `format` (string) - Either "qcow2" or "raw", this specifies the output
of the virtual machine image. This defaults to "qcow2". format of the virtual machine image. This defaults to "qcow2".
- `headless` (boolean) - Packer defaults to building QEMU virtual machines by - `headless` (boolean) - Packer defaults to building QEMU virtual machines by
launching a GUI that shows the console of the machine being built. When this launching a GUI that shows the console of the machine being built. When this
value is set to true, the machine will start without a console. value is set to true, the machine will start without a console.
- `http_directory` (string) - Path to a directory to serve using an HTTP server. - `http_directory` (string) - Path to a directory to serve using an
The files in this directory will be available over HTTP that will be HTTP server. The files in this directory will be available over HTTP that
requestable from the virtual machine. This is useful for hosting kickstart will be requestable from the virtual machine. This is useful for hosting
files and so on. By default this is "", which means no HTTP server will kickstart files and so on. By default this is "", which means no HTTP server
be started. The address and port of the HTTP server will be available as will be started. The address and port of the HTTP server will be available
variables in `boot_command`. This is covered in more detail below. as variables in `boot_command`. This is covered in more detail below.
- `http_port_min` and `http_port_max` (integer) - These are the minimum and - `http_port_min` and `http_port_max` (integer) - These are the minimum and
maximum port to use for the HTTP server started to serve the `http_directory`. maximum port to use for the HTTP server started to serve the
Because Packer often runs in parallel, Packer will choose a randomly available `http_directory`. Because Packer often runs in parallel, Packer will choose
port in this range to run the HTTP server. If you want to force the HTTP a randomly available port in this range to run the HTTP server. If you want
server to be on one port, make this minimum and maximum port the same. By to force the HTTP server to be on one port, make this minimum and maximum
default the values are 8000 and 9000, respectively. port the same. By default the values are 8000 and 9000, respectively.
- `iso_urls` (array of strings) - Multiple URLs for the ISO to download. Packer - `iso_urls` (array of strings) - Multiple URLs for the ISO to download.
will try these in order. If anything goes wrong attempting to download or Packer will try these in order. If anything goes wrong attempting to
while downloading a single URL, it will move on to the next. All URLs must download or while downloading a single URL, it will move on to the next. All
point to the same file (same checksum). By default this is empty and `iso_url` URLs must point to the same file (same checksum). By default this is empty
is used. Only one of `iso_url` or `iso_urls` can be specified. and `iso_url` is used. Only one of `iso_url` or `iso_urls` can be specified.
- `machine_type` (string) - The type of machine emulation to use. Run your qemu - `machine_type` (string) - The type of machine emulation to use. Run your
binary with the flags `-machine help` to list available types for your system. qemu binary with the flags `-machine help` to list available types for
This defaults to "pc". your system. This defaults to "pc".
- `net_device` (string) - The driver to use for the network interface. Allowed - `net_device` (string) - The driver to use for the network interface. Allowed
values "ne2k\_pci," "i82551," "i82557b," "i82559er," "rtl8139," "e1000," values "ne2k\_pci," "i82551," "i82557b," "i82559er," "rtl8139," "e1000,"
...@@ -191,14 +191,14 @@ builder. ...@@ -191,14 +191,14 @@ builder.
- `qemu_binary` (string) - The name of the Qemu binary to look for. This - `qemu_binary` (string) - The name of the Qemu binary to look for. This
defaults to "qemu-system-x86\_64", but may need to be changed for defaults to "qemu-system-x86\_64", but may need to be changed for
some platforms. For example "qemu-kvm", or "qemu-system-i386" may be a better some platforms. For example "qemu-kvm", or "qemu-system-i386" may be a
choice for some systems. better choice for some systems.
- `qemuargs` (array of array of strings) - Allows complete control over the qemu - `qemuargs` (array of array of strings) - Allows complete control over the
command line (though not, at this time, qemu-img). Each array of strings makes qemu command line (though not, at this time, qemu-img). Each array of
up a command line switch that overrides matching default switch/value pairs. strings makes up a command line switch that overrides matching default
Any value specified as an empty string is ignored. All values after the switch switch/value pairs. Any value specified as an empty string is ignored. All
are concatenated with no separator. values after the switch are concatenated with no separator.
\~&gt; **Warning:** The qemu command line allows extreme flexibility, so beware \~&gt; **Warning:** The qemu command line allows extreme flexibility, so beware
of conflicting arguments causing failures of your run. For instance, using of conflicting arguments causing failures of your run. For instance, using
...@@ -207,7 +207,7 @@ shutdown -P now) to the virtual machine, thus preventing proper shutdown. To see ...@@ -207,7 +207,7 @@ shutdown -P now) to the virtual machine, thus preventing proper shutdown. To see
the defaults, look in the packer.log file and search for the qemu-system-x86 the defaults, look in the packer.log file and search for the qemu-system-x86
command. The arguments are all printed for review. command. The arguments are all printed for review.
The following shows a sample usage: The following shows a sample usage:
``` {.javascript} ``` {.javascript}
// ... // ...
...@@ -225,14 +225,15 @@ command. The arguments are all printed for review. ...@@ -225,14 +225,15 @@ command. The arguments are all printed for review.
// ... // ...
``` ```
would produce the following (not including other defaults supplied by the builder and not otherwise conflicting with the qemuargs): would produce the following (not including other defaults supplied by the
builder and not otherwise conflicting with the qemuargs):
<pre class="prettyprint"> <pre class="prettyprint">
qemu-system-x86 -m 1024m --no-acpi -netdev user,id=mynet0,hostfwd=hostip:hostport-guestip:guestport -device virtio-net,netdev=mynet0" qemu-system-x86 -m 1024m --no-acpi -netdev user,id=mynet0,hostfwd=hostip:hostport-guestip:guestport -device virtio-net,netdev=mynet0"
</pre> </pre>
- `shutdown_command` (string) - The command to use to gracefully shut down the - `shutdown_command` (string) - The command to use to gracefully shut down the
machine once all the provisioning is done. By default this is an empty string, machine once all the provisioning is done. By default this is an empty
which tells Packer to just forcefully shut down the machine. string, which tells Packer to just forcefully shut down the machine.
- `shutdown_timeout` (string) - The amount of time to wait after executing the - `shutdown_timeout` (string) - The amount of time to wait after executing the
`shutdown_command` for the virtual machine to actually shut down. If it `shutdown_command` for the virtual machine to actually shut down. If it
...@@ -240,19 +241,19 @@ command. The arguments are all printed for review. ...@@ -240,19 +241,19 @@ command. The arguments are all printed for review.
"5m", or five minutes. "5m", or five minutes.
- `ssh_host_port_min` and `ssh_host_port_max` (integer) - The minimum and - `ssh_host_port_min` and `ssh_host_port_max` (integer) - The minimum and
maximum port to use for the SSH port on the host machine which is forwarded to maximum port to use for the SSH port on the host machine which is forwarded
the SSH port on the guest machine. Because Packer often runs in parallel, to the SSH port on the guest machine. Because Packer often runs in parallel,
Packer will choose a randomly available port in this range to use as the Packer will choose a randomly available port in this range to use as the
host port. host port.
- `vm_name` (string) - This is the name of the image (QCOW2 or IMG) file for the - `vm_name` (string) - This is the name of the image (QCOW2 or IMG) file for
new virtual machine, without the file extension. By default this is the new virtual machine, without the file extension. By default this is
"packer-BUILDNAME", where "BUILDNAME" is the name of the build. "packer-BUILDNAME", where "BUILDNAME" is the name of the build.
- `vnc_port_min` and `vnc_port_max` (integer) - The minimum and maximum port to - `vnc_port_min` and `vnc_port_max` (integer) - The minimum and maximum port
use for the VNC port on the host machine which is forwarded to the VNC port on to use for the VNC port on the host machine which is forwarded to the VNC
the guest machine. Because Packer often runs in parallel, Packer will choose a port on the guest machine. Because Packer often runs in parallel, Packer
randomly available port in this range to use as the host port. will choose a randomly available port in this range to use as the host port.
## Boot Command ## Boot Command
...@@ -292,16 +293,16 @@ by the proper key: ...@@ -292,16 +293,16 @@ by the proper key:
- `<pageUp>` `<pageDown>` - Simulates pressing the page up and page down keys. - `<pageUp>` `<pageDown>` - Simulates pressing the page up and page down keys.
- `<wait>` `<wait5>` `<wait10>` - Adds a 1, 5 or 10 second pause before sending - `<wait>` `<wait5>` `<wait10>` - Adds a 1, 5 or 10 second pause before
any additional keys. This is useful if you have to generally wait for the UI sending any additional keys. This is useful if you have to generally wait
to update before typing more. for the UI to update before typing more.
In addition to the special keys, each command to type is treated as a In addition to the special keys, each command to type is treated as a
[configuration template](/docs/templates/configuration-templates.html). The [configuration template](/docs/templates/configuration-templates.html). The
available variables are: available variables are:
- `HTTPIP` and `HTTPPort` - The IP and port, respectively of an HTTP server that - `HTTPIP` and `HTTPPort` - The IP and port, respectively of an HTTP server
is started serving the directory specified by the `http_directory` that is started serving the directory specified by the `http_directory`
configuration parameter. If `http_directory` isn't specified, these will be configuration parameter. If `http_directory` isn't specified, these will be
blank! blank!
......
...@@ -54,10 +54,10 @@ builder. ...@@ -54,10 +54,10 @@ builder.
### Required: ### Required:
- `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO files - `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO
are so large, this is required and Packer will verify it prior to booting a files are so large, this is required and Packer will verify it prior to
virtual machine with the ISO attached. The type of the checksum is specified booting a virtual machine with the ISO attached. The type of the checksum is
with `iso_checksum_type`, documented below. specified with `iso_checksum_type`, documented below.
- `iso_checksum_type` (string) - The type of the checksum specified in - `iso_checksum_type` (string) - The type of the checksum specified in
`iso_checksum`. Valid values are "none", "md5", "sha1", "sha256", or `iso_checksum`. Valid values are "none", "md5", "sha1", "sha256", or
...@@ -65,30 +65,30 @@ builder. ...@@ -65,30 +65,30 @@ builder.
recommended since ISO files are generally large and corruption does happen recommended since ISO files are generally large and corruption does happen
from time to time. from time to time.
- `iso_url` (string) - A URL to the ISO containing the installation image. This - `iso_url` (string) - A URL to the ISO containing the installation image.
URL can be either an HTTP URL or a file URL (or path to a file). If this is an This URL can be either an HTTP URL or a file URL (or path to a file). If
HTTP URL, Packer will download it and cache it between runs. this is an HTTP URL, Packer will download it and cache it between runs.
- `ssh_username` (string) - The username to use to SSH into the machine once the - `ssh_username` (string) - The username to use to SSH into the machine once
OS is installed. the OS is installed.
### Optional: ### Optional:
- `boot_command` (array of strings) - This is an array of commands to type when - `boot_command` (array of strings) - This is an array of commands to type
the virtual machine is first booted. The goal of these commands should be to when the virtual machine is first booted. The goal of these commands should
type just enough to initialize the operating system installer. Special keys be to type just enough to initialize the operating system installer. Special
can be typed as well, and are covered in the section below on the keys can be typed as well, and are covered in the section below on the
boot command. If this is not specified, it is assumed the installer will boot command. If this is not specified, it is assumed the installer will
start itself. start itself.
- `boot_wait` (string) - The time to wait after booting the initial virtual - `boot_wait` (string) - The time to wait after booting the initial virtual
machine before typing the `boot_command`. The value of this should be machine before typing the `boot_command`. The value of this should be
a duration. Examples are "5s" and "1m30s" which will cause Packer to wait five a duration. Examples are "5s" and "1m30s" which will cause Packer to wait
seconds and one minute 30 seconds, respectively. If this isn't specified, the five seconds and one minute 30 seconds, respectively. If this isn't
default is 10 seconds. specified, the default is 10 seconds.
- `disk_size` (integer) - The size, in megabytes, of the hard disk to create for - `disk_size` (integer) - The size, in megabytes, of the hard disk to create
the VM. By default, this is 40000 (about 40 GB). for the VM. By default, this is 40000 (about 40 GB).
- `export_opts` (array of strings) - Additional options to pass to the - `export_opts` (array of strings) - Additional options to pass to the
`VBoxManage export`. This can be useful for passing product information to `VBoxManage export`. This can be useful for passing product information to
...@@ -100,77 +100,78 @@ builder. ...@@ -100,77 +100,78 @@ builder.
removable media. By default, no floppy will be attached. All files listed in removable media. By default, no floppy will be attached. All files listed in
this setting get placed into the root directory of the floppy and the floppy this setting get placed into the root directory of the floppy and the floppy
is attached as the first floppy device. Currently, no support exists for is attached as the first floppy device. Currently, no support exists for
creating sub-directories on the floppy. Wildcard characters (\*, ?, and \[\]) creating sub-directories on the floppy. Wildcard characters (\*, ?,
are allowed. Directory names are also allowed, which will add all the files and \[\]) are allowed. Directory names are also allowed, which will add all
found in the directory to the floppy. the files found in the directory to the floppy.
- `format` (string) - Either "ovf" or "ova", this specifies the output format of - `format` (string) - Either "ovf" or "ova", this specifies the output format
the exported virtual machine. This defaults to "ovf". of the exported virtual machine. This defaults to "ovf".
- `guest_additions_mode` (string) - The method by which guest additions are made - `guest_additions_mode` (string) - The method by which guest additions are
available to the guest for installation. Valid options are "upload", "attach", made available to the guest for installation. Valid options are "upload",
or "disable". If the mode is "attach" the guest additions ISO will be attached "attach", or "disable". If the mode is "attach" the guest additions ISO will
as a CD device to the virtual machine. If the mode is "upload" the guest be attached as a CD device to the virtual machine. If the mode is "upload"
additions ISO will be uploaded to the path specified by the guest additions ISO will be uploaded to the path specified by
`guest_additions_path`. The default value is "upload". If "disable" is used, `guest_additions_path`. The default value is "upload". If "disable" is used,
guest additions won't be downloaded, either. guest additions won't be downloaded, either.
- `guest_additions_path` (string) - The path on the guest virtual machine where - `guest_additions_path` (string) - The path on the guest virtual machine
the VirtualBox guest additions ISO will be uploaded. By default this is where the VirtualBox guest additions ISO will be uploaded. By default this
"VBoxGuestAdditions.iso" which should upload into the login directory of is "VBoxGuestAdditions.iso" which should upload into the login directory of
the user. This is a [configuration the user. This is a [configuration
template](/docs/templates/configuration-templates.html) where the `Version` template](/docs/templates/configuration-templates.html) where the `Version`
variable is replaced with the VirtualBox version. variable is replaced with the VirtualBox version.
- `guest_additions_sha256` (string) - The SHA256 checksum of the guest additions - `guest_additions_sha256` (string) - The SHA256 checksum of the guest
ISO that will be uploaded to the guest VM. By default the checksums will be additions ISO that will be uploaded to the guest VM. By default the
downloaded from the VirtualBox website, so this only needs to be set if you checksums will be downloaded from the VirtualBox website, so this only needs
want to be explicit about the checksum. to be set if you want to be explicit about the checksum.
- `guest_additions_url` (string) - The URL to the guest additions ISO to upload. - `guest_additions_url` (string) - The URL to the guest additions ISO
This can also be a file URL if the ISO is at a local path. By default, the to upload. This can also be a file URL if the ISO is at a local path. By
VirtualBox builder will attempt to find the guest additions ISO on the local default, the VirtualBox builder will attempt to find the guest additions ISO
file system. If it is not available locally, the builder will download the on the local file system. If it is not available locally, the builder will
proper guest additions ISO from the internet. download the proper guest additions ISO from the internet.
- `guest_os_type` (string) - The guest OS type being installed. By default this - `guest_os_type` (string) - The guest OS type being installed. By default
is "other", but you can get *dramatic* performance improvements by setting this is "other", but you can get *dramatic* performance improvements by
this to the proper value. To view all available values for this run setting this to the proper value. To view all available values for this run
`VBoxManage list ostypes`. Setting the correct value hints to VirtualBox how `VBoxManage list ostypes`. Setting the correct value hints to VirtualBox how
to optimize the virtual hardware to work best with that operating system. to optimize the virtual hardware to work best with that operating system.
- `hard_drive_interface` (string) - The type of controller that the primary hard - `hard_drive_interface` (string) - The type of controller that the primary
drive is attached to, defaults to "ide". When set to "sata", the drive is hard drive is attached to, defaults to "ide". When set to "sata", the drive
attached to an AHCI SATA controller. When set to "scsi", the drive is attached is attached to an AHCI SATA controller. When set to "scsi", the drive is
to an LsiLogic SCSI controller. attached to an LsiLogic SCSI controller.
- `headless` (boolean) - Packer defaults to building VirtualBox virtual machines - `headless` (boolean) - Packer defaults to building VirtualBox virtual
by launching a GUI that shows the console of the machine being built. When machines by launching a GUI that shows the console of the machine
this value is set to true, the machine will start without a console. being built. When this value is set to true, the machine will start without
a console.
- `http_directory` (string) - Path to a directory to serve using an HTTP server. - `http_directory` (string) - Path to a directory to serve using an
The files in this directory will be available over HTTP that will be HTTP server. The files in this directory will be available over HTTP that
requestable from the virtual machine. This is useful for hosting kickstart will be requestable from the virtual machine. This is useful for hosting
files and so on. By default this is "", which means no HTTP server will kickstart files and so on. By default this is "", which means no HTTP server
be started. The address and port of the HTTP server will be available as will be started. The address and port of the HTTP server will be available
variables in `boot_command`. This is covered in more detail below. as variables in `boot_command`. This is covered in more detail below.
- `http_port_min` and `http_port_max` (integer) - These are the minimum and - `http_port_min` and `http_port_max` (integer) - These are the minimum and
maximum port to use for the HTTP server started to serve the `http_directory`. maximum port to use for the HTTP server started to serve the
Because Packer often runs in parallel, Packer will choose a randomly available `http_directory`. Because Packer often runs in parallel, Packer will choose
port in this range to run the HTTP server. If you want to force the HTTP a randomly available port in this range to run the HTTP server. If you want
server to be on one port, make this minimum and maximum port the same. By to force the HTTP server to be on one port, make this minimum and maximum
default the values are 8000 and 9000, respectively. port the same. By default the values are 8000 and 9000, respectively.
- `iso_interface` (string) - The type of controller that the ISO is attached to, - `iso_interface` (string) - The type of controller that the ISO is attached
defaults to "ide". When set to "sata", the drive is attached to an AHCI to, defaults to "ide". When set to "sata", the drive is attached to an AHCI
SATA controller. SATA controller.
- `iso_urls` (array of strings) - Multiple URLs for the ISO to download. Packer - `iso_urls` (array of strings) - Multiple URLs for the ISO to download.
will try these in order. If anything goes wrong attempting to download or Packer will try these in order. If anything goes wrong attempting to
while downloading a single URL, it will move on to the next. All URLs must download or while downloading a single URL, it will move on to the next. All
point to the same file (same checksum). By default this is empty and `iso_url` URLs must point to the same file (same checksum). By default this is empty
is used. Only one of `iso_url` or `iso_urls` can be specified. and `iso_url` is used. Only one of `iso_url` or `iso_urls` can be specified.
- `output_directory` (string) - This is the path to the directory where the - `output_directory` (string) - This is the path to the directory where the
resulting virtual machine will be created. This may be relative or absolute. resulting virtual machine will be created. This may be relative or absolute.
...@@ -180,11 +181,12 @@ builder. ...@@ -180,11 +181,12 @@ builder.
name of the build. name of the build.
- `shutdown_command` (string) - The command to use to gracefully shut down the - `shutdown_command` (string) - The command to use to gracefully shut down the
machine once all the provisioning is done. By default this is an empty string, machine once all the provisioning is done. By default this is an empty
which tells Packer to just forcefully shut down the machine unless a shutdown string, which tells Packer to just forcefully shut down the machine unless a
command takes place inside script so this may safely be omitted. If one or shutdown command takes place inside script so this may safely be omitted. If
more scripts require a reboot it is suggested to leave this blank since one or more scripts require a reboot it is suggested to leave this blank
reboots may fail and specify the final shutdown command in your last script. since reboots may fail and specify the final shutdown command in your
last script.
- `shutdown_timeout` (string) - The amount of time to wait after executing the - `shutdown_timeout` (string) - The amount of time to wait after executing the
`shutdown_command` for the virtual machine to actually shut down. If it `shutdown_command` for the virtual machine to actually shut down. If it
...@@ -192,25 +194,25 @@ builder. ...@@ -192,25 +194,25 @@ builder.
"5m", or five minutes. "5m", or five minutes.
- `ssh_host_port_min` and `ssh_host_port_max` (integer) - The minimum and - `ssh_host_port_min` and `ssh_host_port_max` (integer) - The minimum and
maximum port to use for the SSH port on the host machine which is forwarded to maximum port to use for the SSH port on the host machine which is forwarded
the SSH port on the guest machine. Because Packer often runs in parallel, to the SSH port on the guest machine. Because Packer often runs in parallel,
Packer will choose a randomly available port in this range to use as the Packer will choose a randomly available port in this range to use as the
host port. host port.
- `ssh_skip_nat_mapping` (boolean) - Defaults to false. When enabled, Packer - `ssh_skip_nat_mapping` (boolean) - Defaults to false. When enabled, Packer
does not setup forwarded port mapping for SSH requests and uses `ssh_port` on does not setup forwarded port mapping for SSH requests and uses `ssh_port`
the host to communicate to the virtual machine on the host to communicate to the virtual machine
- `vboxmanage` (array of array of strings) - Custom `VBoxManage` commands to - `vboxmanage` (array of array of strings) - Custom `VBoxManage` commands to
execute in order to further customize the virtual machine being created. The execute in order to further customize the virtual machine being created. The
value of this is an array of commands to execute. The commands are executed in value of this is an array of commands to execute. The commands are executed
the order defined in the template. For each command, the command is defined in the order defined in the template. For each command, the command is
itself as an array of strings, where each string represents a single argument defined itself as an array of strings, where each string represents a single
on the command-line to `VBoxManage` (but excluding `VBoxManage` itself). Each argument on the command-line to `VBoxManage` (but excluding
arg is treated as a [configuration `VBoxManage` itself). Each arg is treated as a [configuration
template](/docs/templates/configuration-templates.html), where the `Name` template](/docs/templates/configuration-templates.html), where the `Name`
variable is replaced with the VM name. More details on how to use `VBoxManage` variable is replaced with the VM name. More details on how to use
are below. `VBoxManage` are below.
- `vboxmanage_post` (array of array of strings) - Identical to `vboxmanage`, - `vboxmanage_post` (array of array of strings) - Identical to `vboxmanage`,
except that it is run after the virtual machine is shutdown, and before the except that it is run after the virtual machine is shutdown, and before the
...@@ -218,8 +220,8 @@ builder. ...@@ -218,8 +220,8 @@ builder.
- `virtualbox_version_file` (string) - The path within the virtual machine to - `virtualbox_version_file` (string) - The path within the virtual machine to
upload a file that contains the VirtualBox version that was used to create upload a file that contains the VirtualBox version that was used to create
the machine. This information can be useful for provisioning. By default this the machine. This information can be useful for provisioning. By default
is ".vbox\_version", which will generally be upload it into the this is ".vbox\_version", which will generally be upload it into the
home directory. home directory.
- `vm_name` (string) - This is the name of the OVF file for the new virtual - `vm_name` (string) - This is the name of the OVF file for the new virtual
...@@ -264,16 +266,16 @@ by the proper key: ...@@ -264,16 +266,16 @@ by the proper key:
- `<pageUp>` `<pageDown>` - Simulates pressing the page up and page down keys. - `<pageUp>` `<pageDown>` - Simulates pressing the page up and page down keys.
- `<wait>` `<wait5>` `<wait10>` - Adds a 1, 5 or 10 second pause before sending - `<wait>` `<wait5>` `<wait10>` - Adds a 1, 5 or 10 second pause before
any additional keys. This is useful if you have to generally wait for the UI sending any additional keys. This is useful if you have to generally wait
to update before typing more. for the UI to update before typing more.
In addition to the special keys, each command to type is treated as a In addition to the special keys, each command to type is treated as a
[configuration template](/docs/templates/configuration-templates.html). The [configuration template](/docs/templates/configuration-templates.html). The
available variables are: available variables are:
- `HTTPIP` and `HTTPPort` - The IP and port, respectively of an HTTP server that - `HTTPIP` and `HTTPPort` - The IP and port, respectively of an HTTP server
is started serving the directory specified by the `http_directory` that is started serving the directory specified by the `http_directory`
configuration parameter. If `http_directory` isn't specified, these will be configuration parameter. If `http_directory` isn't specified, these will be
blank! blank!
......
...@@ -19,11 +19,13 @@ image). ...@@ -19,11 +19,13 @@ image).
When exporting from VirtualBox make sure to choose OVF Version 2, since Version When exporting from VirtualBox make sure to choose OVF Version 2, since Version
1 is not compatible and will generate errors like this: 1 is not compatible and will generate errors like this:
==> virtualbox-ovf: Progress state: VBOX_E_FILE_ERROR ==&gt; virtualbox-ovf: Progress state: VBOX\_E\_FILE\_ERROR ==&gt;
==> virtualbox-ovf: VBoxManage: error: Appliance read failed virtualbox-ovf: VBoxManage: error: Appliance read failed ==&gt; virtualbox-ovf:
==> virtualbox-ovf: VBoxManage: error: Error reading "source.ova": element "Section" has no "type" attribute, line 21 VBoxManage: error: Error reading "source.ova": element "Section" has no "type"
==> virtualbox-ovf: VBoxManage: error: Details: code VBOX_E_FILE_ERROR (0x80bb0004), component Appliance, interface IAppliance attribute, line 21 ==&gt; virtualbox-ovf: VBoxManage: error: Details: code
==> virtualbox-ovf: VBoxManage: error: Context: "int handleImportAppliance(HandlerArg*)" at line 304 of file VBoxManageAppliance.cpp VBOX\_E\_FILE\_ERROR (0x80bb0004), component Appliance, interface IAppliance
==&gt; virtualbox-ovf: VBoxManage: error: Context: "int
handleImportAppliance(HandlerArg\*)" at line 304 of file VBoxManageAppliance.cpp
The builder builds a virtual machine by importing an existing OVF or OVA file. The builder builds a virtual machine by importing an existing OVF or OVA file.
It then boots this image, runs provisioners on this new VM, and exports that VM It then boots this image, runs provisioners on this new VM, and exports that VM
...@@ -64,23 +66,23 @@ builder. ...@@ -64,23 +66,23 @@ builder.
- `source_path` (string) - The path to an OVF or OVA file that acts as the - `source_path` (string) - The path to an OVF or OVA file that acts as the
source of this build. source of this build.
- `ssh_username` (string) - The username to use to SSH into the machine once the - `ssh_username` (string) - The username to use to SSH into the machine once
OS is installed. the OS is installed.
### Optional: ### Optional:
- `boot_command` (array of strings) - This is an array of commands to type when - `boot_command` (array of strings) - This is an array of commands to type
the virtual machine is first booted. The goal of these commands should be to when the virtual machine is first booted. The goal of these commands should
type just enough to initialize the operating system installer. Special keys be to type just enough to initialize the operating system installer. Special
can be typed as well, and are covered in the section below on the keys can be typed as well, and are covered in the section below on the
boot command. If this is not specified, it is assumed the installer will boot command. If this is not specified, it is assumed the installer will
start itself. start itself.
- `boot_wait` (string) - The time to wait after booting the initial virtual - `boot_wait` (string) - The time to wait after booting the initial virtual
machine before typing the `boot_command`. The value of this should be machine before typing the `boot_command`. The value of this should be
a duration. Examples are "5s" and "1m30s" which will cause Packer to wait five a duration. Examples are "5s" and "1m30s" which will cause Packer to wait
seconds and one minute 30 seconds, respectively. If this isn't specified, the five seconds and one minute 30 seconds, respectively. If this isn't
default is 10 seconds. specified, the default is 10 seconds.
- `export_opts` (array of strings) - Additional options to pass to the - `export_opts` (array of strings) - Additional options to pass to the
`VBoxManage export`. This can be useful for passing product information to `VBoxManage export`. This can be useful for passing product information to
...@@ -92,55 +94,56 @@ builder. ...@@ -92,55 +94,56 @@ builder.
removable media. By default, no floppy will be attached. All files listed in removable media. By default, no floppy will be attached. All files listed in
this setting get placed into the root directory of the floppy and the floppy this setting get placed into the root directory of the floppy and the floppy
is attached as the first floppy device. Currently, no support exists for is attached as the first floppy device. Currently, no support exists for
creating sub-directories on the floppy. Wildcard characters (\*, ?, and \[\]) creating sub-directories on the floppy. Wildcard characters (\*, ?,
are allowed. Directory names are also allowed, which will add all the files and \[\]) are allowed. Directory names are also allowed, which will add all
found in the directory to the floppy. the files found in the directory to the floppy.
- `format` (string) - Either "ovf" or "ova", this specifies the output format of - `format` (string) - Either "ovf" or "ova", this specifies the output format
the exported virtual machine. This defaults to "ovf". of the exported virtual machine. This defaults to "ovf".
- `guest_additions_mode` (string) - The method by which guest additions are made - `guest_additions_mode` (string) - The method by which guest additions are
available to the guest for installation. Valid options are "upload", "attach", made available to the guest for installation. Valid options are "upload",
or "disable". If the mode is "attach" the guest additions ISO will be attached "attach", or "disable". If the mode is "attach" the guest additions ISO will
as a CD device to the virtual machine. If the mode is "upload" the guest be attached as a CD device to the virtual machine. If the mode is "upload"
additions ISO will be uploaded to the path specified by the guest additions ISO will be uploaded to the path specified by
`guest_additions_path`. The default value is "upload". If "disable" is used, `guest_additions_path`. The default value is "upload". If "disable" is used,
guest additions won't be downloaded, either. guest additions won't be downloaded, either.
- `guest_additions_path` (string) - The path on the guest virtual machine where - `guest_additions_path` (string) - The path on the guest virtual machine
the VirtualBox guest additions ISO will be uploaded. By default this is where the VirtualBox guest additions ISO will be uploaded. By default this
"VBoxGuestAdditions.iso" which should upload into the login directory of is "VBoxGuestAdditions.iso" which should upload into the login directory of
the user. This is a [configuration the user. This is a [configuration
template](/docs/templates/configuration-templates.html) where the `Version` template](/docs/templates/configuration-templates.html) where the `Version`
variable is replaced with the VirtualBox version. variable is replaced with the VirtualBox version.
- `guest_additions_sha256` (string) - The SHA256 checksum of the guest additions - `guest_additions_sha256` (string) - The SHA256 checksum of the guest
ISO that will be uploaded to the guest VM. By default the checksums will be additions ISO that will be uploaded to the guest VM. By default the
downloaded from the VirtualBox website, so this only needs to be set if you checksums will be downloaded from the VirtualBox website, so this only needs
want to be explicit about the checksum. to be set if you want to be explicit about the checksum.
- `guest_additions_url` (string) - The URL to the guest additions ISO to upload. - `guest_additions_url` (string) - The URL to the guest additions ISO
This can also be a file URL if the ISO is at a local path. By default the to upload. This can also be a file URL if the ISO is at a local path. By
VirtualBox builder will go and download the proper guest additions ISO from default the VirtualBox builder will go and download the proper guest
the internet. additions ISO from the internet.
- `headless` (boolean) - Packer defaults to building VirtualBox virtual machines - `headless` (boolean) - Packer defaults to building VirtualBox virtual
by launching a GUI that shows the console of the machine being built. When machines by launching a GUI that shows the console of the machine
this value is set to true, the machine will start without a console. being built. When this value is set to true, the machine will start without
a console.
- `http_directory` (string) - Path to a directory to serve using an HTTP server. - `http_directory` (string) - Path to a directory to serve using an
The files in this directory will be available over HTTP that will be HTTP server. The files in this directory will be available over HTTP that
requestable from the virtual machine. This is useful for hosting kickstart will be requestable from the virtual machine. This is useful for hosting
files and so on. By default this is "", which means no HTTP server will kickstart files and so on. By default this is "", which means no HTTP server
be started. The address and port of the HTTP server will be available as will be started. The address and port of the HTTP server will be available
variables in `boot_command`. This is covered in more detail below. as variables in `boot_command`. This is covered in more detail below.
- `http_port_min` and `http_port_max` (integer) - These are the minimum and - `http_port_min` and `http_port_max` (integer) - These are the minimum and
maximum port to use for the HTTP server started to serve the `http_directory`. maximum port to use for the HTTP server started to serve the
Because Packer often runs in parallel, Packer will choose a randomly available `http_directory`. Because Packer often runs in parallel, Packer will choose
port in this range to run the HTTP server. If you want to force the HTTP a randomly available port in this range to run the HTTP server. If you want
server to be on one port, make this minimum and maximum port the same. By to force the HTTP server to be on one port, make this minimum and maximum
default the values are 8000 and 9000, respectively. port the same. By default the values are 8000 and 9000, respectively.
- `import_flags` (array of strings) - Additional flags to pass to - `import_flags` (array of strings) - Additional flags to pass to
`VBoxManage import`. This can be used to add additional command-line flags `VBoxManage import`. This can be used to add additional command-line flags
...@@ -158,11 +161,12 @@ builder. ...@@ -158,11 +161,12 @@ builder.
name of the build. name of the build.
- `shutdown_command` (string) - The command to use to gracefully shut down the - `shutdown_command` (string) - The command to use to gracefully shut down the
machine once all the provisioning is done. By default this is an empty string, machine once all the provisioning is done. By default this is an empty
which tells Packer to just forcefully shut down the machine unless a shutdown string, which tells Packer to just forcefully shut down the machine unless a
command takes place inside script so this may safely be omitted. If one or shutdown command takes place inside script so this may safely be omitted. If
more scripts require a reboot it is suggested to leave this blank since one or more scripts require a reboot it is suggested to leave this blank
reboots may fail and specify the final shutdown command in your last script. since reboots may fail and specify the final shutdown command in your
last script.
- `shutdown_timeout` (string) - The amount of time to wait after executing the - `shutdown_timeout` (string) - The amount of time to wait after executing the
`shutdown_command` for the virtual machine to actually shut down. If it `shutdown_command` for the virtual machine to actually shut down. If it
...@@ -170,25 +174,25 @@ builder. ...@@ -170,25 +174,25 @@ builder.
"5m", or five minutes. "5m", or five minutes.
- `ssh_host_port_min` and `ssh_host_port_max` (integer) - The minimum and - `ssh_host_port_min` and `ssh_host_port_max` (integer) - The minimum and
maximum port to use for the SSH port on the host machine which is forwarded to maximum port to use for the SSH port on the host machine which is forwarded
the SSH port on the guest machine. Because Packer often runs in parallel, to the SSH port on the guest machine. Because Packer often runs in parallel,
Packer will choose a randomly available port in this range to use as the Packer will choose a randomly available port in this range to use as the
host port. host port.
- `ssh_skip_nat_mapping` (boolean) - Defaults to false. When enabled, Packer - `ssh_skip_nat_mapping` (boolean) - Defaults to false. When enabled, Packer
does not setup forwarded port mapping for SSH requests and uses `ssh_port` on does not setup forwarded port mapping for SSH requests and uses `ssh_port`
the host to communicate to the virtual machine on the host to communicate to the virtual machine
- `vboxmanage` (array of array of strings) - Custom `VBoxManage` commands to - `vboxmanage` (array of array of strings) - Custom `VBoxManage` commands to
execute in order to further customize the virtual machine being created. The execute in order to further customize the virtual machine being created. The
value of this is an array of commands to execute. The commands are executed in value of this is an array of commands to execute. The commands are executed
the order defined in the template. For each command, the command is defined in the order defined in the template. For each command, the command is
itself as an array of strings, where each string represents a single argument defined itself as an array of strings, where each string represents a single
on the command-line to `VBoxManage` (but excluding `VBoxManage` itself). Each argument on the command-line to `VBoxManage` (but excluding
arg is treated as a [configuration `VBoxManage` itself). Each arg is treated as a [configuration
template](/docs/templates/configuration-templates.html), where the `Name` template](/docs/templates/configuration-templates.html), where the `Name`
variable is replaced with the VM name. More details on how to use `VBoxManage` variable is replaced with the VM name. More details on how to use
are below. `VBoxManage` are below.
- `vboxmanage_post` (array of array of strings) - Identical to `vboxmanage`, - `vboxmanage_post` (array of array of strings) - Identical to `vboxmanage`,
except that it is run after the virtual machine is shutdown, and before the except that it is run after the virtual machine is shutdown, and before the
...@@ -196,8 +200,8 @@ builder. ...@@ -196,8 +200,8 @@ builder.
- `virtualbox_version_file` (string) - The path within the virtual machine to - `virtualbox_version_file` (string) - The path within the virtual machine to
upload a file that contains the VirtualBox version that was used to create upload a file that contains the VirtualBox version that was used to create
the machine. This information can be useful for provisioning. By default this the machine. This information can be useful for provisioning. By default
is ".vbox\_version", which will generally be upload it into the this is ".vbox\_version", which will generally be upload it into the
home directory. home directory.
- `vm_name` (string) - This is the name of the virtual machine when it is - `vm_name` (string) - This is the name of the virtual machine when it is
......
...@@ -18,11 +18,12 @@ the following VirtualBox builders: ...@@ -18,11 +18,12 @@ the following VirtualBox builders:
- [virtualbox-iso](/docs/builders/virtualbox-iso.html) - Starts from an ISO - [virtualbox-iso](/docs/builders/virtualbox-iso.html) - Starts from an ISO
file, creates a brand new VirtualBox VM, installs an OS, provisions software file, creates a brand new VirtualBox VM, installs an OS, provisions software
within the OS, then exports that machine to create an image. This is best for within the OS, then exports that machine to create an image. This is best
people who want to start from scratch. for people who want to start from scratch.
- [virtualbox-ovf](/docs/builders/virtualbox-ovf.html) - This builder imports an - [virtualbox-ovf](/docs/builders/virtualbox-ovf.html) - This builder imports
existing OVF/OVA file, runs provisioners on top of that VM, and exports that an existing OVF/OVA file, runs provisioners on top of that VM, and exports
machine to create an image. This is best if you have an existing VirtualBox VM that machine to create an image. This is best if you have an existing
export you want to use as the source. As an additional benefit, you can feed VirtualBox VM export you want to use as the source. As an additional
the artifact of this builder back into itself to iterate on a machine. benefit, you can feed the artifact of this builder back into itself to
iterate on a machine.
...@@ -57,10 +57,10 @@ builder. ...@@ -57,10 +57,10 @@ builder.
### Required: ### Required:
- `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO files - `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO
are so large, this is required and Packer will verify it prior to booting a files are so large, this is required and Packer will verify it prior to
virtual machine with the ISO attached. The type of the checksum is specified booting a virtual machine with the ISO attached. The type of the checksum is
with `iso_checksum_type`, documented below. specified with `iso_checksum_type`, documented below.
- `iso_checksum_type` (string) - The type of the checksum specified in - `iso_checksum_type` (string) - The type of the checksum specified in
`iso_checksum`. Valid values are "none", "md5", "sha1", "sha256", or `iso_checksum`. Valid values are "none", "md5", "sha1", "sha256", or
...@@ -68,38 +68,38 @@ builder. ...@@ -68,38 +68,38 @@ builder.
recommended since ISO files are generally large and corruption does happen recommended since ISO files are generally large and corruption does happen
from time to time. from time to time.
- `iso_url` (string) - A URL to the ISO containing the installation image. This - `iso_url` (string) - A URL to the ISO containing the installation image.
URL can be either an HTTP URL or a file URL (or path to a file). If this is an This URL can be either an HTTP URL or a file URL (or path to a file). If
HTTP URL, Packer will download it and cache it between runs. this is an HTTP URL, Packer will download it and cache it between runs.
- `ssh_username` (string) - The username to use to SSH into the machine once the - `ssh_username` (string) - The username to use to SSH into the machine once
OS is installed. the OS is installed.
### Optional: ### Optional:
- `disk_additional_size` (array of integers) - The size(s) of any additional - `disk_additional_size` (array of integers) - The size(s) of any additional
hard disks for the VM in megabytes. If this is not specified then the VM will hard disks for the VM in megabytes. If this is not specified then the VM
only contain a primary hard disk. The builder uses expandable, not fixed-size will only contain a primary hard disk. The builder uses expandable, not
virtual hard disks, so the actual file representing the disk will not use the fixed-size virtual hard disks, so the actual file representing the disk will
full size unless it is full. not use the full size unless it is full.
- `boot_command` (array of strings) - This is an array of commands to type when - `boot_command` (array of strings) - This is an array of commands to type
the virtual machine is first booted. The goal of these commands should be to when the virtual machine is first booted. The goal of these commands should
type just enough to initialize the operating system installer. Special keys be to type just enough to initialize the operating system installer. Special
can be typed as well, and are covered in the section below on the keys can be typed as well, and are covered in the section below on the
boot command. If this is not specified, it is assumed the installer will boot command. If this is not specified, it is assumed the installer will
start itself. start itself.
- `boot_wait` (string) - The time to wait after booting the initial virtual - `boot_wait` (string) - The time to wait after booting the initial virtual
machine before typing the `boot_command`. The value of this should be machine before typing the `boot_command`. The value of this should be
a duration. Examples are "5s" and "1m30s" which will cause Packer to wait five a duration. Examples are "5s" and "1m30s" which will cause Packer to wait
seconds and one minute 30 seconds, respectively. If this isn't specified, the five seconds and one minute 30 seconds, respectively. If this isn't
default is 10 seconds. specified, the default is 10 seconds.
- `disk_size` (integer) - The size of the hard disk for the VM in megabytes. The - `disk_size` (integer) - The size of the hard disk for the VM in megabytes.
builder uses expandable, not fixed-size virtual hard disks, so the actual file The builder uses expandable, not fixed-size virtual hard disks, so the
representing the disk will not use the full size unless it is full. By default actual file representing the disk will not use the full size unless it
this is set to 40,000 (about 40 GB). is full. By default this is set to 40,000 (about 40 GB).
- `disk_type_id` (string) - The type of VMware virtual disk to create. The - `disk_type_id` (string) - The type of VMware virtual disk to create. The
default is "1", which corresponds to a growable virtual disk split in default is "1", which corresponds to a growable virtual disk split in
...@@ -114,44 +114,45 @@ builder. ...@@ -114,44 +114,45 @@ builder.
removable media. By default, no floppy will be attached. All files listed in removable media. By default, no floppy will be attached. All files listed in
this setting get placed into the root directory of the floppy and the floppy this setting get placed into the root directory of the floppy and the floppy
is attached as the first floppy device. Currently, no support exists for is attached as the first floppy device. Currently, no support exists for
creating sub-directories on the floppy. Wildcard characters (\*, ?, and \[\]) creating sub-directories on the floppy. Wildcard characters (\*, ?,
are allowed. Directory names are also allowed, which will add all the files and \[\]) are allowed. Directory names are also allowed, which will add all
found in the directory to the floppy. the files found in the directory to the floppy.
- `fusion_app_path` (string) - Path to "VMware Fusion.app". By default this is - `fusion_app_path` (string) - Path to "VMware Fusion.app". By default this is
"/Applications/VMware Fusion.app" but this setting allows you to "/Applications/VMware Fusion.app" but this setting allows you to
customize this. customize this.
- `guest_os_type` (string) - The guest OS type being installed. This will be set - `guest_os_type` (string) - The guest OS type being installed. This will be
in the VMware VMX. By default this is "other". By specifying a more specific set in the VMware VMX. By default this is "other". By specifying a more
OS type, VMware may perform some optimizations or virtual hardware changes to specific OS type, VMware may perform some optimizations or virtual hardware
better support the operating system running in the virtual machine. changes to better support the operating system running in the
virtual machine.
- `headless` (boolean) - Packer defaults to building VMware virtual machines by
launching a GUI that shows the console of the machine being built. When this - `headless` (boolean) - Packer defaults to building VMware virtual machines
value is set to true, the machine will start without a console. For VMware by launching a GUI that shows the console of the machine being built. When
machines, Packer will output VNC connection information in case you need to this value is set to true, the machine will start without a console. For
connect to the console to debug the build process. VMware machines, Packer will output VNC connection information in case you
need to connect to the console to debug the build process.
- `http_directory` (string) - Path to a directory to serve using an HTTP server.
The files in this directory will be available over HTTP that will be - `http_directory` (string) - Path to a directory to serve using an
requestable from the virtual machine. This is useful for hosting kickstart HTTP server. The files in this directory will be available over HTTP that
files and so on. By default this is "", which means no HTTP server will will be requestable from the virtual machine. This is useful for hosting
be started. The address and port of the HTTP server will be available as kickstart files and so on. By default this is "", which means no HTTP server
variables in `boot_command`. This is covered in more detail below. will be started. The address and port of the HTTP server will be available
as variables in `boot_command`. This is covered in more detail below.
- `http_port_min` and `http_port_max` (integer) - These are the minimum and - `http_port_min` and `http_port_max` (integer) - These are the minimum and
maximum port to use for the HTTP server started to serve the `http_directory`. maximum port to use for the HTTP server started to serve the
Because Packer often runs in parallel, Packer will choose a randomly available `http_directory`. Because Packer often runs in parallel, Packer will choose
port in this range to run the HTTP server. If you want to force the HTTP a randomly available port in this range to run the HTTP server. If you want
server to be on one port, make this minimum and maximum port the same. By to force the HTTP server to be on one port, make this minimum and maximum
default the values are 8000 and 9000, respectively. port the same. By default the values are 8000 and 9000, respectively.
- `iso_urls` (array of strings) - Multiple URLs for the ISO to download. Packer - `iso_urls` (array of strings) - Multiple URLs for the ISO to download.
will try these in order. If anything goes wrong attempting to download or Packer will try these in order. If anything goes wrong attempting to
while downloading a single URL, it will move on to the next. All URLs must download or while downloading a single URL, it will move on to the next. All
point to the same file (same checksum). By default this is empty and `iso_url` URLs must point to the same file (same checksum). By default this is empty
is used. Only one of `iso_url` or `iso_urls` can be specified. and `iso_url` is used. Only one of `iso_url` or `iso_urls` can be specified.
- `output_directory` (string) - This is the path to the directory where the - `output_directory` (string) - This is the path to the directory where the
resulting virtual machine will be created. This may be relative or absolute. resulting virtual machine will be created. This may be relative or absolute.
...@@ -160,38 +161,39 @@ builder. ...@@ -160,38 +161,39 @@ builder.
the builder. By default this is "output-BUILDNAME" where "BUILDNAME" is the the builder. By default this is "output-BUILDNAME" where "BUILDNAME" is the
name of the build. name of the build.
- `remote_cache_datastore` (string) - The path to the datastore where supporting - `remote_cache_datastore` (string) - The path to the datastore where
files will be stored during the build on the remote machine. By default this supporting files will be stored during the build on the remote machine. By
is the same as the `remote_datastore` option. This only has an effect if default this is the same as the `remote_datastore` option. This only has an
`remote_type` is enabled. effect if `remote_type` is enabled.
- `remote_cache_directory` (string) - The path where the ISO and/or floppy files - `remote_cache_directory` (string) - The path where the ISO and/or floppy
will be stored during the build on the remote machine. The path is relative to files will be stored during the build on the remote machine. The path is
the `remote_cache_datastore` on the remote machine. By default this relative to the `remote_cache_datastore` on the remote machine. By default
is "packer\_cache". This only has an effect if `remote_type` is enabled. this is "packer\_cache". This only has an effect if `remote_type`
is enabled.
- `remote_datastore` (string) - The path to the datastore where the resulting VM - `remote_datastore` (string) - The path to the datastore where the resulting
will be stored when it is built on the remote machine. By default this VM will be stored when it is built on the remote machine. By default this
is "datastore1". This only has an effect if `remote_type` is enabled. is "datastore1". This only has an effect if `remote_type` is enabled.
- `remote_host` (string) - The host of the remote machine used for access. This - `remote_host` (string) - The host of the remote machine used for access.
is only required if `remote_type` is enabled. This is only required if `remote_type` is enabled.
- `remote_password` (string) - The SSH password for the user used to access the - `remote_password` (string) - The SSH password for the user used to access
remote machine. By default this is empty. This only has an effect if the remote machine. By default this is empty. This only has an effect if
`remote_type` is enabled. `remote_type` is enabled.
- `remote_type` (string) - The type of remote machine that will be used to build - `remote_type` (string) - The type of remote machine that will be used to
this VM rather than a local desktop product. The only value accepted for this build this VM rather than a local desktop product. The only value accepted
currently is "esx5". If this is not set, a desktop product will be used. By for this currently is "esx5". If this is not set, a desktop product will
default, this is not set. be used. By default, this is not set.
- `remote_username` (string) - The username for the SSH user that will access - `remote_username` (string) - The username for the SSH user that will access
the remote machine. This is required if `remote_type` is enabled. the remote machine. This is required if `remote_type` is enabled.
- `shutdown_command` (string) - The command to use to gracefully shut down the - `shutdown_command` (string) - The command to use to gracefully shut down the
machine once all the provisioning is done. By default this is an empty string, machine once all the provisioning is done. By default this is an empty
which tells Packer to just forcefully shut down the machine. string, which tells Packer to just forcefully shut down the machine.
- `shutdown_timeout` (string) - The amount of time to wait after executing the - `shutdown_timeout` (string) - The amount of time to wait after executing the
`shutdown_command` for the virtual machine to actually shut down. If it `shutdown_command` for the virtual machine to actually shut down. If it
...@@ -204,21 +206,22 @@ builder. ...@@ -204,21 +206,22 @@ builder.
slightly larger. If you find this to be the case, you can disable compaction slightly larger. If you find this to be the case, you can disable compaction
using this configuration value. using this configuration value.
- `tools_upload_flavor` (string) - The flavor of the VMware Tools ISO to upload - `tools_upload_flavor` (string) - The flavor of the VMware Tools ISO to
into the VM. Valid values are "darwin", "linux", and "windows". By default, upload into the VM. Valid values are "darwin", "linux", and "windows". By
this is empty, which means VMware tools won't be uploaded. default, this is empty, which means VMware tools won't be uploaded.
- `tools_upload_path` (string) - The path in the VM to upload the VMware tools. - `tools_upload_path` (string) - The path in the VM to upload the
This only takes effect if `tools_upload_flavor` is non-empty. This is a VMware tools. This only takes effect if `tools_upload_flavor` is non-empty.
[configuration template](/docs/templates/configuration-templates.html) that This is a [configuration
has a single valid variable: `Flavor`, which will be the value of template](/docs/templates/configuration-templates.html) that has a single
`tools_upload_flavor`. By default the upload path is set to `{{.Flavor}}.iso`. valid variable: `Flavor`, which will be the value of `tools_upload_flavor`.
This setting is not used when `remote_type` is "esx5". By default the upload path is set to `{{.Flavor}}.iso`. This setting is not
used when `remote_type` is "esx5".
- `version` (string) - The [vmx hardware - `version` (string) - The [vmx hardware
version](http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003746) version](http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003746)
for the new virtual machine. Only the default value has been tested, any other for the new virtual machine. Only the default value has been tested, any
value is experimental. Default value is '9'. other value is experimental. Default value is '9'.
- `vm_name` (string) - This is the name of the VMX file for the new virtual - `vm_name` (string) - This is the name of the VMX file for the new virtual
machine, without the file extension. By default this is "packer-BUILDNAME", machine, without the file extension. By default this is "packer-BUILDNAME",
...@@ -227,9 +230,9 @@ builder. ...@@ -227,9 +230,9 @@ builder.
- `vmdk_name` (string) - The filename of the virtual disk that'll be created, - `vmdk_name` (string) - The filename of the virtual disk that'll be created,
without the extension. This defaults to "packer". without the extension. This defaults to "packer".
- `vmx_data` (object of key/value strings) - Arbitrary key/values to enter into - `vmx_data` (object of key/value strings) - Arbitrary key/values to enter
the virtual machine VMX file. This is for advanced users who want to set into the virtual machine VMX file. This is for advanced users who want to
properties such as memory, CPU, etc. set properties such as memory, CPU, etc.
- `vmx_data_post` (object of key/value strings) - Identical to `vmx_data`, - `vmx_data_post` (object of key/value strings) - Identical to `vmx_data`,
except that it is run after the virtual machine is shutdown, and before the except that it is run after the virtual machine is shutdown, and before the
...@@ -238,14 +241,15 @@ builder. ...@@ -238,14 +241,15 @@ builder.
- `vmx_template_path` (string) - Path to a [configuration - `vmx_template_path` (string) - Path to a [configuration
template](/docs/templates/configuration-templates.html) that defines the template](/docs/templates/configuration-templates.html) that defines the
contents of the virtual machine VMX file for VMware. This is for **advanced contents of the virtual machine VMX file for VMware. This is for **advanced
users only** as this can render the virtual machine non-functional. See below users only** as this can render the virtual machine non-functional. See
for more information. For basic VMX modifications, try `vmx_data` first. below for more information. For basic VMX modifications, try
`vmx_data` first.
- `vnc_port_min` and `vnc_port_max` (integer) - The minimum and maximum port to - `vnc_port_min` and `vnc_port_max` (integer) - The minimum and maximum port
use for VNC access to the virtual machine. The builder uses VNC to type the to use for VNC access to the virtual machine. The builder uses VNC to type
initial `boot_command`. Because Packer generally runs in parallel, Packer uses the initial `boot_command`. Because Packer generally runs in parallel,
a randomly chosen port in this range that appears available. By default this Packer uses a randomly chosen port in this range that appears available. By
is 5900 to 6000. The minimum and maximum ports are inclusive. default this is 5900 to 6000. The minimum and maximum ports are inclusive.
## Boot Command ## Boot Command
...@@ -285,16 +289,16 @@ by the proper key: ...@@ -285,16 +289,16 @@ by the proper key:
- `<pageUp>` `<pageDown>` - Simulates pressing the page up and page down keys. - `<pageUp>` `<pageDown>` - Simulates pressing the page up and page down keys.
- `<wait>` `<wait5>` `<wait10>` - Adds a 1, 5 or 10 second pause before sending - `<wait>` `<wait5>` `<wait10>` - Adds a 1, 5 or 10 second pause before
any additional keys. This is useful if you have to generally wait for the UI sending any additional keys. This is useful if you have to generally wait
to update before typing more. for the UI to update before typing more.
In addition to the special keys, each command to type is treated as a In addition to the special keys, each command to type is treated as a
[configuration template](/docs/templates/configuration-templates.html). The [configuration template](/docs/templates/configuration-templates.html). The
available variables are: available variables are:
- `HTTPIP` and `HTTPPort` - The IP and port, respectively of an HTTP server that - `HTTPIP` and `HTTPPort` - The IP and port, respectively of an HTTP server
is started serving the directory specified by the `http_directory` that is started serving the directory specified by the `http_directory`
configuration parameter. If `http_directory` isn't specified, these will be configuration parameter. If `http_directory` isn't specified, these will be
blank! blank!
...@@ -336,8 +340,8 @@ variables isn't required, however. ...@@ -336,8 +340,8 @@ variables isn't required, however.
- `GuestOS` - The VMware-valid guest OS type. - `GuestOS` - The VMware-valid guest OS type.
- `DiskName` - The filename (without the suffix) of the main virtual disk. - `DiskName` - The filename (without the suffix) of the main virtual disk.
- `ISOPath` - The path to the ISO to use for the OS installation. - `ISOPath` - The path to the ISO to use for the OS installation.
- `Version` - The Hardware version VMWare will execute this vm under. Also known - `Version` - The Hardware version VMWare will execute this vm under. Also
as the `virtualhw.version`. known as the `virtualhw.version`.
## Building on a Remote vSphere Hypervisor ## Building on a Remote vSphere Hypervisor
...@@ -374,15 +378,15 @@ the required `remote_*` configurations: ...@@ -374,15 +378,15 @@ the required `remote_*` configurations:
Additionally, there are some optional configurations that you'll likely have to Additionally, there are some optional configurations that you'll likely have to
modify as well: modify as well:
- `remote_datastore` - The path to the datastore where the VM will be stored on - `remote_datastore` - The path to the datastore where the VM will be stored
the ESXi machine. on the ESXi machine.
- `remote_cache_datastore` - The path to the datastore where supporting files - `remote_cache_datastore` - The path to the datastore where supporting files
will be stored during the build on the remote machine. will be stored during the build on the remote machine.
- `remote_cache_directory` - The path where the ISO and/or floppy files will be - `remote_cache_directory` - The path where the ISO and/or floppy files will
stored during the build on the remote machine. The path is relative to the be stored during the build on the remote machine. The path is relative to
`remote_cache_datastore` on the remote machine. the `remote_cache_datastore` on the remote machine.
- `remote_username` - The SSH username used to access the remote machine. - `remote_username` - The SSH username used to access the remote machine.
......
...@@ -55,23 +55,23 @@ builder. ...@@ -55,23 +55,23 @@ builder.
- `source_path` (string) - Path to the source VMX file to clone. - `source_path` (string) - Path to the source VMX file to clone.
- `ssh_username` (string) - The username to use to SSH into the machine once the - `ssh_username` (string) - The username to use to SSH into the machine once
OS is installed. the OS is installed.
### Optional: ### Optional:
- `boot_command` (array of strings) - This is an array of commands to type when - `boot_command` (array of strings) - This is an array of commands to type
the virtual machine is first booted. The goal of these commands should be to when the virtual machine is first booted. The goal of these commands should
type just enough to initialize the operating system installer. Special keys be to type just enough to initialize the operating system installer. Special
can be typed as well, and are covered in the section below on the keys can be typed as well, and are covered in the section below on the
boot command. If this is not specified, it is assumed the installer will boot command. If this is not specified, it is assumed the installer will
start itself. start itself.
- `boot_wait` (string) - The time to wait after booting the initial virtual - `boot_wait` (string) - The time to wait after booting the initial virtual
machine before typing the `boot_command`. The value of this should be machine before typing the `boot_command`. The value of this should be
a duration. Examples are "5s" and "1m30s" which will cause Packer to wait five a duration. Examples are "5s" and "1m30s" which will cause Packer to wait
seconds and one minute 30 seconds, respectively. If this isn't specified, the five seconds and one minute 30 seconds, respectively. If this isn't
default is 10 seconds. specified, the default is 10 seconds.
- `floppy_files` (array of strings) - A list of files to place onto a floppy - `floppy_files` (array of strings) - A list of files to place onto a floppy
disk that is attached when the VM is booted. This is most useful for disk that is attached when the VM is booted. This is most useful for
...@@ -79,33 +79,33 @@ builder. ...@@ -79,33 +79,33 @@ builder.
removable media. By default, no floppy will be attached. All files listed in removable media. By default, no floppy will be attached. All files listed in
this setting get placed into the root directory of the floppy and the floppy this setting get placed into the root directory of the floppy and the floppy
is attached as the first floppy device. Currently, no support exists for is attached as the first floppy device. Currently, no support exists for
creating sub-directories on the floppy. Wildcard characters (\*, ?, and \[\]) creating sub-directories on the floppy. Wildcard characters (\*, ?,
are allowed. Directory names are also allowed, which will add all the files and \[\]) are allowed. Directory names are also allowed, which will add all
found in the directory to the floppy. the files found in the directory to the floppy.
- `fusion_app_path` (string) - Path to "VMware Fusion.app". By default this is - `fusion_app_path` (string) - Path to "VMware Fusion.app". By default this is
"/Applications/VMware Fusion.app" but this setting allows you to "/Applications/VMware Fusion.app" but this setting allows you to
customize this. customize this.
- `headless` (boolean) - Packer defaults to building VMware virtual machines by - `headless` (boolean) - Packer defaults to building VMware virtual machines
launching a GUI that shows the console of the machine being built. When this by launching a GUI that shows the console of the machine being built. When
value is set to true, the machine will start without a console. For VMware this value is set to true, the machine will start without a console. For
machines, Packer will output VNC connection information in case you need to VMware machines, Packer will output VNC connection information in case you
connect to the console to debug the build process. need to connect to the console to debug the build process.
- `http_directory` (string) - Path to a directory to serve using an HTTP server. - `http_directory` (string) - Path to a directory to serve using an
The files in this directory will be available over HTTP that will be HTTP server. The files in this directory will be available over HTTP that
requestable from the virtual machine. This is useful for hosting kickstart will be requestable from the virtual machine. This is useful for hosting
files and so on. By default this is "", which means no HTTP server will kickstart files and so on. By default this is "", which means no HTTP server
be started. The address and port of the HTTP server will be available as will be started. The address and port of the HTTP server will be available
variables in `boot_command`. This is covered in more detail below. as variables in `boot_command`. This is covered in more detail below.
- `http_port_min` and `http_port_max` (integer) - These are the minimum and - `http_port_min` and `http_port_max` (integer) - These are the minimum and
maximum port to use for the HTTP server started to serve the `http_directory`. maximum port to use for the HTTP server started to serve the
Because Packer often runs in parallel, Packer will choose a randomly available `http_directory`. Because Packer often runs in parallel, Packer will choose
port in this range to run the HTTP server. If you want to force the HTTP a randomly available port in this range to run the HTTP server. If you want
server to be on one port, make this minimum and maximum port the same. By to force the HTTP server to be on one port, make this minimum and maximum
default the values are 8000 and 9000, respectively. port the same. By default the values are 8000 and 9000, respectively.
- `output_directory` (string) - This is the path to the directory where the - `output_directory` (string) - This is the path to the directory where the
resulting virtual machine will be created. This may be relative or absolute. resulting virtual machine will be created. This may be relative or absolute.
...@@ -115,11 +115,12 @@ builder. ...@@ -115,11 +115,12 @@ builder.
name of the build. name of the build.
- `shutdown_command` (string) - The command to use to gracefully shut down the - `shutdown_command` (string) - The command to use to gracefully shut down the
machine once all the provisioning is done. By default this is an empty string, machine once all the provisioning is done. By default this is an empty
which tells Packer to just forcefully shut down the machine unless a shutdown string, which tells Packer to just forcefully shut down the machine unless a
command takes place inside script so this may safely be omitted. If one or shutdown command takes place inside script so this may safely be omitted. If
more scripts require a reboot it is suggested to leave this blank since one or more scripts require a reboot it is suggested to leave this blank
reboots may fail and specify the final shutdown command in your last script. since reboots may fail and specify the final shutdown command in your
last script.
- `shutdown_timeout` (string) - The amount of time to wait after executing the - `shutdown_timeout` (string) - The amount of time to wait after executing the
`shutdown_command` for the virtual machine to actually shut down. If it `shutdown_command` for the virtual machine to actually shut down. If it
...@@ -136,16 +137,16 @@ builder. ...@@ -136,16 +137,16 @@ builder.
machine, without the file extension. By default this is "packer-BUILDNAME", machine, without the file extension. By default this is "packer-BUILDNAME",
where "BUILDNAME" is the name of the build. where "BUILDNAME" is the name of the build.
- `vmx_data` (object of key/value strings) - Arbitrary key/values to enter into - `vmx_data` (object of key/value strings) - Arbitrary key/values to enter
the virtual machine VMX file. This is for advanced users who want to set into the virtual machine VMX file. This is for advanced users who want to
properties such as memory, CPU, etc. set properties such as memory, CPU, etc.
- `vmx_data_post` (object of key/value strings) - Identical to `vmx_data`, - `vmx_data_post` (object of key/value strings) - Identical to `vmx_data`,
except that it is run after the virtual machine is shutdown, and before the except that it is run after the virtual machine is shutdown, and before the
virtual machine is exported. virtual machine is exported.
- `vnc_port_min` and `vnc_port_max` (integer) - The minimum and maximum port to - `vnc_port_min` and `vnc_port_max` (integer) - The minimum and maximum port
use for VNC access to the virtual machine. The builder uses VNC to type the to use for VNC access to the virtual machine. The builder uses VNC to type
initial `boot_command`. Because Packer generally runs in parallel, Packer uses the initial `boot_command`. Because Packer generally runs in parallel,
a randomly chosen port in this range that appears available. By default this Packer uses a randomly chosen port in this range that appears available. By
is 5900 to 6000. The minimum and maximum ports are inclusive. default this is 5900 to 6000. The minimum and maximum ports are inclusive.
...@@ -16,9 +16,9 @@ depending on the strategy you want to use to build the image. Packer supports ...@@ -16,9 +16,9 @@ depending on the strategy you want to use to build the image. Packer supports
the following VMware builders: the following VMware builders:
- [vmware-iso](/docs/builders/vmware-iso.html) - Starts from an ISO file, - [vmware-iso](/docs/builders/vmware-iso.html) - Starts from an ISO file,
creates a brand new VMware VM, installs an OS, provisions software within the creates a brand new VMware VM, installs an OS, provisions software within
OS, then exports that machine to create an image. This is best for people who the OS, then exports that machine to create an image. This is best for
want to start from scratch. people who want to start from scratch.
- [vmware-vmx](/docs/builders/vmware-vmx.html) - This builder imports an - [vmware-vmx](/docs/builders/vmware-vmx.html) - This builder imports an
existing VMware machine (from a VMX file), runs provisioners on top of that existing VMware machine (from a VMX file), runs provisioners on top of that
......
...@@ -20,21 +20,23 @@ artifacts that are created will be outputted at the end of the build. ...@@ -20,21 +20,23 @@ artifacts that are created will be outputted at the end of the build.
- `-color=false` - Disables colorized output. Enabled by default. - `-color=false` - Disables colorized output. Enabled by default.
- `-debug` - Disables parallelization and enables debug mode. Debug mode flags - `-debug` - Disables parallelization and enables debug mode. Debug mode flags
the builders that they should output debugging information. The exact behavior the builders that they should output debugging information. The exact
of debug mode is left to the builder. In general, builders usually will stop behavior of debug mode is left to the builder. In general, builders usually
between each step, waiting for keyboard input before continuing. This will will stop between each step, waiting for keyboard input before continuing.
allow the user to inspect state and so on. This will allow the user to inspect state and so on.
- `-except=foo,bar,baz` - Builds all the builds except those with the given - `-except=foo,bar,baz` - Builds all the builds except those with the given
comma-separated names. Build names by default are the names of their builders, comma-separated names. Build names by default are the names of their
unless a specific `name` attribute is specified within the configuration. builders, unless a specific `name` attribute is specified within
the configuration.
- `-force` - Forces a builder to run when artifacts from a previous build - `-force` - Forces a builder to run when artifacts from a previous build
prevent a build from running. The exact behavior of a forced build is left to prevent a build from running. The exact behavior of a forced build is left
the builder. In general, a builder supporting the forced build will remove the to the builder. In general, a builder supporting the forced build will
artifacts from the previous build. This will allow the user to repeat a build remove the artifacts from the previous build. This will allow the user to
without having to manually clean these artifacts beforehand. repeat a build without having to manually clean these artifacts beforehand.
- `-only=foo,bar,baz` - Only build the builds with the given - `-only=foo,bar,baz` - Only build the builds with the given
comma-separated names. Build names by default are the names of their builders, comma-separated names. Build names by default are the names of their
unless a specific `name` attribute is specified within the configuration. builders, unless a specific `name` attribute is specified within
the configuration.
...@@ -19,7 +19,7 @@ The fix command will output the changed template to standard out, so you should ...@@ -19,7 +19,7 @@ The fix command will output the changed template to standard out, so you should
redirect standard using standard OS-specific techniques if you want to save it redirect standard using standard OS-specific techniques if you want to save it
to a file. For example, on Linux systems, you may want to do this: to a file. For example, on Linux systems, you may want to do this:
$ packer fix old.json > new.json \$ packer fix old.json &gt; new.json
If fixing fails for any reason, the fix command will exit with a non-zero exit If fixing fails for any reason, the fix command will exit with a non-zero exit
status. Error messages appear on standard error, so if you're redirecting status. Error messages appear on standard error, so if you're redirecting
......
...@@ -55,18 +55,20 @@ Each component is explained below: ...@@ -55,18 +55,20 @@ Each component is explained below:
- **timestamp** is a Unix timestamp in UTC of when the message was printed. - **timestamp** is a Unix timestamp in UTC of when the message was printed.
- **target** is the target of the following output. This is empty if the message - **target** is the target of the following output. This is empty if the
is related to Packer globally. Otherwise, this is generally a build name so message is related to Packer globally. Otherwise, this is generally a build
you can relate output to a specific build while parallel builds are running. name so you can relate output to a specific build while parallel builds
are running.
- **type** is the type of machine-readable message being outputted. There are a - **type** is the type of machine-readable message being outputted. There are
set of standard types which are covered later, but each component of Packer a set of standard types which are covered later, but each component of
(builders, provisioners, etc.) may output their own custom types as well, Packer (builders, provisioners, etc.) may output their own custom types as
allowing the machine-readable output to be infinitely flexible. well, allowing the machine-readable output to be infinitely flexible.
- **data** is zero or more comma-seperated values associated with the - **data** is zero or more comma-seperated values associated with the
prior type. The exact amount and meaning of this data is type-dependent, so prior type. The exact amount and meaning of this data is type-dependent, so
you must read the documentation associated with the type to understand fully. you must read the documentation associated with the type to
understand fully.
Within the format, if data contains a comma, it is replaced with Within the format, if data contains a comma, it is replaced with
`%!(PACKER_COMMA)`. This was preferred over an escape character such as `\'` `%!(PACKER_COMMA)`. This was preferred over an escape character such as `\'`
......
...@@ -29,5 +29,5 @@ Errors validating build 'vmware'. 1 error(s) occurred: ...@@ -29,5 +29,5 @@ Errors validating build 'vmware'. 1 error(s) occurred:
## Options ## Options
- `-syntax-only` - Only the syntax of the template is checked. The configuration - `-syntax-only` - Only the syntax of the template is checked. The
is not validated. configuration is not validated.
...@@ -55,8 +55,8 @@ dependencies. ...@@ -55,8 +55,8 @@ dependencies.
- `github.com/mitchellh/packer` - Contains all the interfaces that you have to - `github.com/mitchellh/packer` - Contains all the interfaces that you have to
implement for any given plugin. implement for any given plugin.
- `github.com/mitchellh/packer/plugin` - Contains the code to serve the plugin. - `github.com/mitchellh/packer/plugin` - Contains the code to serve
This handles all the inter-process communication stuff. the plugin. This handles all the inter-process communication stuff.
There are two steps involved in creating a plugin: There are two steps involved in creating a plugin:
......
...@@ -64,8 +64,8 @@ The valid types for plugins are: ...@@ -64,8 +64,8 @@ The valid types for plugins are:
- `command` - A CLI sub-command for `packer`. - `command` - A CLI sub-command for `packer`.
- `post-processor` - A post-processor responsible for taking an artifact from a - `post-processor` - A post-processor responsible for taking an artifact from
builder and turning it into something else. a builder and turning it into something else.
- `provisioner` - A provisioner to install software on images created by - `provisioner` - A provisioner to install software on images created by
a builder. a builder.
...@@ -81,9 +81,9 @@ value is explained below: ...@@ -81,9 +81,9 @@ value is explained below:
- `Artifact` - The newly created artifact if no errors occurred. - `Artifact` - The newly created artifact if no errors occurred.
- `bool` - If true, the input artifact will forcefully be kept. By default, - `bool` - If true, the input artifact will forcefully be kept. By default,
Packer typically deletes all input artifacts, since the user doesn't generally Packer typically deletes all input artifacts, since the user doesn't
want intermediary artifacts. However, some post-processors depend on the generally want intermediary artifacts. However, some post-processors depend
previous artifact existing. If this is `true`, it forces packer to keep the on the previous artifact existing. If this is `true`, it forces packer to
artifact around. keep the artifact around.
- `error` - Non-nil if there was an error in any way. If this is the case, the - `error` - Non-nil if there was an error in any way. If this is the case, the
other two return values are ignored. other two return values are ignored.
...@@ -12,8 +12,10 @@ These are the machine-readable types that exist as part of the output of ...@@ -12,8 +12,10 @@ These are the machine-readable types that exist as part of the output of
`packer build`. `packer build`.
<dl> <dl>
<dt>artifact (>= 2)</dt> <dt>
<dd> artifact (&gt;= 2)
</dt>
<dd>
<p> <p>
Information about an artifact of the targeted item. This is a Information about an artifact of the targeted item. This is a
fairly complex (but uniform!) machine-readable type that contains fairly complex (but uniform!) machine-readable type that contains
...@@ -37,10 +39,12 @@ These are the machine-readable types that exist as part of the output of ...@@ -37,10 +39,12 @@ These are the machine-readable types that exist as part of the output of
data points related to the subtype. The exact count and meaning data points related to the subtype. The exact count and meaning
of this subtypes comes from the subtype documentation. of this subtypes comes from the subtype documentation.
</p> </p>
</dd>
<dt>artifact-count (1)</dt> </dd>
<dd> <dt>
artifact-count (1)
</dt>
<dd>
<p> <p>
The number of artifacts associated with the given target. This The number of artifacts associated with the given target. This
will always be outputted _before_ any other artifact information, will always be outputted _before_ any other artifact information,
...@@ -51,10 +55,12 @@ These are the machine-readable types that exist as part of the output of ...@@ -51,10 +55,12 @@ These are the machine-readable types that exist as part of the output of
<strong>Data 1: count</strong> - The number of artifacts as <strong>Data 1: count</strong> - The number of artifacts as
a base 10 integer. a base 10 integer.
</p> </p>
</dd>
<dt>artifact subtype: builder-id (1)</dt> </dd>
<dd> <dt>
artifact subtype: builder-id (1)
</dt>
<dd>
<p> <p>
The unique ID of the builder that created this artifact. The unique ID of the builder that created this artifact.
</p> </p>
...@@ -62,19 +68,23 @@ These are the machine-readable types that exist as part of the output of ...@@ -62,19 +68,23 @@ These are the machine-readable types that exist as part of the output of
<p> <p>
<strong>Data 1: id</strong> - The unique ID of the builder. <strong>Data 1: id</strong> - The unique ID of the builder.
</p> </p>
</dd>
<dt>artifact subtype: end (0)</dt> </dd>
<dd> <dt>
artifact subtype: end (0)
</dt>
<dd>
<p> <p>
The last machine-readable output line outputted for an artifact. The last machine-readable output line outputted for an artifact.
This is a sentinel value so you know that no more data related to This is a sentinel value so you know that no more data related to
the targetted artifact will be outputted. the targetted artifact will be outputted.
</p> </p>
</dd>
<dt>artifact subtype: file (2)</dt> </dd>
<dd> <dt>
artifact subtype: file (2)
</dt>
<dd>
<p> <p>
A single file associated with the artifact. There are 0 to A single file associated with the artifact. There are 0 to
"files-count" of these entries to describe every file that is "files-count" of these entries to describe every file that is
...@@ -89,10 +99,12 @@ These are the machine-readable types that exist as part of the output of ...@@ -89,10 +99,12 @@ These are the machine-readable types that exist as part of the output of
<p> <p>
<strong>Data 2: filename</strong> - The filename. <strong>Data 2: filename</strong> - The filename.
</p> </p>
</dd>
<dt>artifact subtype: files-count (1)</dt> </dd>
<dd> <dt>
artifact subtype: files-count (1)
</dt>
<dd>
<p> <p>
The number of files associated with this artifact. Not all The number of files associated with this artifact. Not all
artifacts have files associated with it. artifacts have files associated with it.
...@@ -101,10 +113,12 @@ These are the machine-readable types that exist as part of the output of ...@@ -101,10 +113,12 @@ These are the machine-readable types that exist as part of the output of
<p> <p>
<strong>Data 1: count</strong> - The number of files. <strong>Data 1: count</strong> - The number of files.
</p> </p>
</dd>
<dt>artifact subtype: id (1)</dt> </dd>
<dd> <dt>
artifact subtype: id (1)
</dt>
<dd>
<p> <p>
The ID (if any) of the artifact that was built. Not all artifacts The ID (if any) of the artifact that was built. Not all artifacts
have associated IDs. For example, AMIs built have IDs associated have associated IDs. For example, AMIs built have IDs associated
...@@ -115,18 +129,22 @@ These are the machine-readable types that exist as part of the output of ...@@ -115,18 +129,22 @@ These are the machine-readable types that exist as part of the output of
<p> <p>
<strong>Data 1: id</strong> - The ID of the artifact. <strong>Data 1: id</strong> - The ID of the artifact.
</p> </p>
</dd>
<dt>artifact subtype: nil (0)</dt> </dd>
<dd> <dt>
artifact subtype: nil (0)
</dt>
<dd>
<p> <p>
If present, this means that the artifact was nil, or that the targeted If present, this means that the artifact was nil, or that the targeted
build completed successfully but no artifact was created. build completed successfully but no artifact was created.
</p> </p>
</dd>
<dt>artifact subtype: string (1)</dt> </dd>
<dd> <dt>
artifact subtype: string (1)
</dt>
<dd>
<p> <p>
The human-readable string description of the artifact provided by The human-readable string description of the artifact provided by
the artifact itself. the artifact itself.
...@@ -135,10 +153,12 @@ These are the machine-readable types that exist as part of the output of ...@@ -135,10 +153,12 @@ These are the machine-readable types that exist as part of the output of
<p> <p>
<strong>Data 1: string</strong> - The string output for the artifact. <strong>Data 1: string</strong> - The string output for the artifact.
</p> </p>
</dd>
<dt>error-count (1)</dt> </dd>
<dd> <dt>
error-count (1)
</dt>
<dd>
<p> <p>
The number of errors that occurred during the build. This will The number of errors that occurred during the build. This will
always be outputted before any errors so you know how many are coming. always be outputted before any errors so you know how many are coming.
...@@ -148,10 +168,12 @@ These are the machine-readable types that exist as part of the output of ...@@ -148,10 +168,12 @@ These are the machine-readable types that exist as part of the output of
<strong>Data 1: count</strong> - The number of build errors as <strong>Data 1: count</strong> - The number of build errors as
a base 10 integer. a base 10 integer.
</p> </p>
</dd>
<dt>error (1)</dt> </dd>
<dd> <dt>
error (1)
</dt>
<dd>
<p> <p>
A build error that occurred. The target of this output will be A build error that occurred. The target of this output will be
the build that had the error. the build that had the error.
...@@ -160,6 +182,6 @@ These are the machine-readable types that exist as part of the output of ...@@ -160,6 +182,6 @@ These are the machine-readable types that exist as part of the output of
<p> <p>
<strong>Data 1: error</strong> - The error message as a string. <strong>Data 1: error</strong> - The error message as a string.
</p> </p>
</dd>
</dd>
</dl> </dl>
...@@ -12,8 +12,10 @@ These are the machine-readable types that exist as part of the output of ...@@ -12,8 +12,10 @@ These are the machine-readable types that exist as part of the output of
`packer inspect`. `packer inspect`.
<dl> <dl>
<dt>template-variable (3)</dt> <dt>
<dd> template-variable (3)
</dt>
<dd>
<p> <p>
A <a href="/docs/templates/user-variables.html">user variable</a> A <a href="/docs/templates/user-variables.html">user variable</a>
defined within the template. defined within the template.
...@@ -32,10 +34,12 @@ These are the machine-readable types that exist as part of the output of ...@@ -32,10 +34,12 @@ These are the machine-readable types that exist as part of the output of
<strong>Data 3: required</strong> - If non-zero, then this variable <strong>Data 3: required</strong> - If non-zero, then this variable
is required. is required.
</p> </p>
</dd>
<dt>template-builder (2)</dt> </dd>
<dd> <dt>
template-builder (2)
</dt>
<dd>
<p> <p>
A builder defined within the template A builder defined within the template
</p> </p>
...@@ -48,10 +52,12 @@ These are the machine-readable types that exist as part of the output of ...@@ -48,10 +52,12 @@ These are the machine-readable types that exist as part of the output of
generally be the same as the name unless you explicitly override generally be the same as the name unless you explicitly override
the name. the name.
</p> </p>
</dd>
<dt>template-provisioner (1)</dt> </dd>
<dd> <dt>
template-provisioner (1)
</dt>
<dd>
<p> <p>
A provisioner defined within the template. Multiple of these may A provisioner defined within the template. Multiple of these may
exist. If so, they are outputted in the order they would run. exist. If so, they are outputted in the order they would run.
...@@ -60,6 +66,6 @@ These are the machine-readable types that exist as part of the output of ...@@ -60,6 +66,6 @@ These are the machine-readable types that exist as part of the output of
<p> <p>
<strong>Data 1: name</strong> - The name/type of the provisioner. <strong>Data 1: name</strong> - The name/type of the provisioner.
</p> </p>
</dd>
</dd>
</dl> </dl>
...@@ -12,8 +12,10 @@ These are the machine-readable types that exist as part of the output of ...@@ -12,8 +12,10 @@ These are the machine-readable types that exist as part of the output of
`packer version`. `packer version`.
<dl> <dl>
<dt>version (1)</dt> <dt>
<dd> version (1)
</dt>
<dd>
<p>The version number of Packer running.</p> <p>The version number of Packer running.</p>
<p> <p>
...@@ -21,19 +23,23 @@ These are the machine-readable types that exist as part of the output of ...@@ -21,19 +23,23 @@ These are the machine-readable types that exist as part of the output of
only including the major, minor, and patch versions. Example: only including the major, minor, and patch versions. Example:
"0.2.4". "0.2.4".
</p> </p>
</dd>
<dt>version-commit (1)</dt> </dd>
<dd> <dt>
version-commit (1)
</dt>
<dd>
<p>The SHA1 of the Git commit that built this version of Packer.</p> <p>The SHA1 of the Git commit that built this version of Packer.</p>
<p> <p>
<strong>Data 1: commit SHA1</strong> - The SHA1 of the commit. <strong>Data 1: commit SHA1</strong> - The SHA1 of the commit.
</p> </p>
</dd>
<dt>version-prerelease (1)</dt> </dd>
<dd> <dt>
version-prerelease (1)
</dt>
<dd>
<p> <p>
The prerelease tag (if any) for the running version of Packer. This The prerelease tag (if any) for the running version of Packer. This
can be "beta", "dev", "alpha", etc. If this is empty, you can assume can be "beta", "dev", "alpha", etc. If this is empty, you can assume
...@@ -44,6 +50,6 @@ These are the machine-readable types that exist as part of the output of ...@@ -44,6 +50,6 @@ These are the machine-readable types that exist as part of the output of
<strong>Data 1: prerelease name</strong> - The name of the <strong>Data 1: prerelease name</strong> - The name of the
prerelease tag. prerelease tag.
</p> </p>
</dd>
</dd>
</dl> </dl>
...@@ -12,8 +12,10 @@ These are the machine-readable types that can appear in almost any ...@@ -12,8 +12,10 @@ These are the machine-readable types that can appear in almost any
machine-readable output and are provided by Packer core itself. machine-readable output and are provided by Packer core itself.
<dl> <dl>
<dt>ui (2)</dt> <dt>
<dd> ui (2)
</dt>
<dd>
<p> <p>
Specifies the output and type of output that would've normally Specifies the output and type of output that would've normally
gone to the console if Packer were running in human-readable gone to the console if Packer were running in human-readable
...@@ -28,6 +30,6 @@ machine-readable output and are provided by Packer core itself. ...@@ -28,6 +30,6 @@ machine-readable output and are provided by Packer core itself.
<strong>Data 2: output</strong> - The UI message that would have <strong>Data 2: output</strong> - The UI message that would have
been outputted. been outputted.
</p> </p>
</dd>
</dd>
</dl> </dl>
...@@ -24,12 +24,14 @@ Within each section, the format of the documentation is the following: ...@@ -24,12 +24,14 @@ Within each section, the format of the documentation is the following:
<br> <br>
<dl> <dl>
<dt>type-name (data-count)</dt> <dt>
<dd> type-name (data-count)
</dt>
<dd>
<p>Description of the type.</p> <p>Description of the type.</p>
<p> <p>
<strong>Data 1: name</strong> - Description. <strong>Data 1: name</strong> - Description.
</p> </p>
</dd>
</dd>
</dl> </dl>
...@@ -32,13 +32,13 @@ The format of the configuration file is basic JSON. ...@@ -32,13 +32,13 @@ The format of the configuration file is basic JSON.
Below is the list of all available configuration parameters for the core Below is the list of all available configuration parameters for the core
configuration file. None of these are required, since all have sane defaults. configuration file. None of these are required, since all have sane defaults.
- `plugin_min_port` and `plugin_max_port` (integer) - These are the minimum and - `plugin_min_port` and `plugin_max_port` (integer) - These are the minimum
maximum ports that Packer uses for communication with plugins, since plugin and maximum ports that Packer uses for communication with plugins, since
communication happens over TCP connections on your local host. By default plugin communication happens over TCP connections on your local host. By
these are 10,000 and 25,000, respectively. Be sure to set a fairly wide range default these are 10,000 and 25,000, respectively. Be sure to set a fairly
here, since Packer can easily use over 25 ports on a single run. wide range here, since Packer can easily use over 25 ports on a single run.
- `builders`, `commands`, `post-processors`, and `provisioners` are objects that - `builders`, `commands`, `post-processors`, and `provisioners` are objects
are used to install plugins. The details of how exactly these are set is that are used to install plugins. The details of how exactly these are set
covered in more detail in the [installing plugins documentation is covered in more detail in the [installing plugins documentation
page](/docs/extend/plugins.html). page](/docs/extend/plugins.html).
...@@ -25,12 +25,12 @@ each can be found below: ...@@ -25,12 +25,12 @@ each can be found below:
- `PACKER_NO_COLOR` - Setting this to any value will disable color in - `PACKER_NO_COLOR` - Setting this to any value will disable color in
the terminal. the terminal.
- `PACKER_PLUGIN_MAX_PORT` - The maximum port that Packer uses for communication - `PACKER_PLUGIN_MAX_PORT` - The maximum port that Packer uses for
with plugins, since plugin communication happens over TCP connections on your communication with plugins, since plugin communication happens over TCP
local host. The default is 25,000. See the [core configuration connections on your local host. The default is 25,000. See the [core
page](/docs/other/core-configuration.html). configuration page](/docs/other/core-configuration.html).
- `PACKER_PLUGIN_MIN_PORT` - The minimum port that Packer uses for communication - `PACKER_PLUGIN_MIN_PORT` - The minimum port that Packer uses for
with plugins, since plugin communication happens over TCP connections on your communication with plugins, since plugin communication happens over TCP
local host. The default is 10,000. See the [core configuration connections on your local host. The default is 10,000. See the [core
page](/docs/other/core-configuration.html). configuration page](/docs/other/core-configuration.html).
...@@ -28,9 +28,9 @@ Here is an example workflow: ...@@ -28,9 +28,9 @@ Here is an example workflow:
1. Packer builds an AMI with the [Amazon AMI 1. Packer builds an AMI with the [Amazon AMI
builder](/docs/builders/amazon.html) builder](/docs/builders/amazon.html)
2. The `atlas` post-processor takes the resulting AMI and uploads it to Atlas. 2. The `atlas` post-processor takes the resulting AMI and uploads it to Atlas.
The `atlas` post-processor is configured with the name of the AMI, for example The `atlas` post-processor is configured with the name of the AMI, for
`hashicorp/foobar`, to create the artifact in Atlas or update the version if example `hashicorp/foobar`, to create the artifact in Atlas or update the
the artifact already exists version if the artifact already exists
3. The new version is ready and available to be used in deployments with a tool 3. The new version is ready and available to be used in deployments with a tool
like [Terraform](https://terraform.io) like [Terraform](https://terraform.io)
...@@ -40,15 +40,16 @@ The configuration allows you to specify and access the artifact in Atlas. ...@@ -40,15 +40,16 @@ The configuration allows you to specify and access the artifact in Atlas.
### Required: ### Required:
- `token` (string) - Your access token for the Atlas API. This can be generated - `token` (string) - Your access token for the Atlas API. This can be
on your [tokens page](https://atlas.hashicorp.com/settings/tokens). generated on your [tokens
Alternatively you can export your Atlas token as an environmental variable and page](https://atlas.hashicorp.com/settings/tokens). Alternatively you can
remove it from the configuration. export your Atlas token as an environmental variable and remove it from
the configuration.
- `artifact` (string) - The shorthand tag for your artifact that maps to Atlas, - `artifact` (string) - The shorthand tag for your artifact that maps to
i.e `hashicorp/foobar` for `atlas.hashicorp.com/hashicorp/foobar`. You must Atlas, i.e `hashicorp/foobar` for `atlas.hashicorp.com/hashicorp/foobar`.
have access to the organization, hashicorp in this example, in order to add an You must have access to the organization, hashicorp in this example, in
artifact to the organization in Atlas. order to add an artifact to the organization in Atlas.
- `artifact_type` (string) - For uploading AMIs to Atlas, `artifact_type` will - `artifact_type` (string) - For uploading AMIs to Atlas, `artifact_type` will
always be `amazon.ami`. This field must be defined because Atlas can host always be `amazon.ami`. This field must be defined because Atlas can host
......
...@@ -22,21 +22,21 @@ filename. ...@@ -22,21 +22,21 @@ filename.
- `output` (string) - The path to save the compressed archive. The archive - `output` (string) - The path to save the compressed archive. The archive
format is inferred from the filename. E.g. `.tar.gz` will be a format is inferred from the filename. E.g. `.tar.gz` will be a
gzipped tarball. `.zip` will be a zip file. If the extension can't be detected gzipped tarball. `.zip` will be a zip file. If the extension can't be
packer defaults to `.tar.gz` behavior but will not change the filename. detected packer defaults to `.tar.gz` behavior but will not change
the filename.
If you are executing multiple builders in parallel you should make sure If you are executing multiple builders in parallel you should make sure `output`
`output` is unique for each one. For example is unique for each one. For example `packer_{{.BuildName}}_{{.Provider}}.zip`.
`packer_{{.BuildName}}_{{.Provider}}.zip`.
### Optional: ### Optional:
If you want more control over how the archive is created you can specify the If you want more control over how the archive is created you can specify the
following settings: following settings:
- `compression_level` (integer) - Specify the compression level, for algorithms - `compression_level` (integer) - Specify the compression level, for
that support it, from 1 through 9 inclusive. Typically higher compression algorithms that support it, from 1 through 9 inclusive. Typically higher
levels take longer but produce smaller files. Defaults to `6` compression levels take longer but produce smaller files. Defaults to `6`
- `keep_input_artifact` (boolean) - Keep source files; defaults to `false` - `keep_input_artifact` (boolean) - Keep source files; defaults to `false`
......
...@@ -18,8 +18,8 @@ pushes it to a Docker registry. ...@@ -18,8 +18,8 @@ pushes it to a Docker registry.
This post-processor has only optional configuration: This post-processor has only optional configuration:
- `login` (boolean) - Defaults to false. If true, the post-processor will login - `login` (boolean) - Defaults to false. If true, the post-processor will
prior to pushing. login prior to pushing.
- `login_email` (string) - The email to use to authenticate to login. - `login_email` (string) - The email to use to authenticate to login.
......
...@@ -63,19 +63,19 @@ on Vagrant Cloud, as well as authentication and version information. ...@@ -63,19 +63,19 @@ on Vagrant Cloud, as well as authentication and version information.
- `version` (string) - The version number, typically incrementing a - `version` (string) - The version number, typically incrementing a
previous version. The version string is validated based on [Semantic previous version. The version string is validated based on [Semantic
Versioning](http://semver.org/). The string must match a pattern that could be Versioning](http://semver.org/). The string must match a pattern that could
semver, and doesn't validate that the version comes after your be semver, and doesn't validate that the version comes after your
previous versions. previous versions.
### Optional: ### Optional:
- `no_release` (string) - If set to true, does not release the version on - `no_release` (string) - If set to true, does not release the version on
Vagrant Cloud, making it active. You can manually release the version via the Vagrant Cloud, making it active. You can manually release the version via
API or Web UI. Defaults to false. the API or Web UI. Defaults to false.
- `vagrant_cloud_url` (string) - Override the base URL for Vagrant Cloud. This - `vagrant_cloud_url` (string) - Override the base URL for Vagrant Cloud. This
is useful if you're using Vagrant Private Cloud in your own network. Defaults is useful if you're using Vagrant Private Cloud in your own network.
to `https://vagrantcloud.com/api/v1` Defaults to `https://vagrantcloud.com/api/v1`
- `version_description` (string) - Optionally markdown text used as a - `version_description` (string) - Optionally markdown text used as a
full-length and in-depth description of the version, typically for denoting full-length and in-depth description of the version, typically for denoting
......
...@@ -51,10 +51,10 @@ However, if you want to configure things a bit more, the post-processor does ...@@ -51,10 +51,10 @@ However, if you want to configure things a bit more, the post-processor does
expose some configuration options. The available options are listed below, with expose some configuration options. The available options are listed below, with
more details about certain options in following sections. more details about certain options in following sections.
- `compression_level` (integer) - An integer representing the compression level - `compression_level` (integer) - An integer representing the compression
to use when creating the Vagrant box. Valid values range from 0 to 9, with 0 level to use when creating the Vagrant box. Valid values range from 0 to 9,
being no compression and 9 being the best compression. By default, compression with 0 being no compression and 9 being the best compression. By default,
is enabled at level 6. compression is enabled at level 6.
- `include` (array of strings) - Paths to files to include in the Vagrant box. - `include` (array of strings) - Paths to files to include in the Vagrant box.
These files will each be copied into the top level directory of the Vagrant These files will each be copied into the top level directory of the Vagrant
......
...@@ -32,10 +32,11 @@ Required: ...@@ -32,10 +32,11 @@ Required:
- `host` (string) - The vSphere host that will be contacted to perform the - `host` (string) - The vSphere host that will be contacted to perform the
VM upload. VM upload.
- `password` (string) - Password to use to authenticate to the vSphere endpoint. - `password` (string) - Password to use to authenticate to the
vSphere endpoint.
- `resource_pool` (string) - The resource pool to upload the VM to. This is *not - `resource_pool` (string) - The resource pool to upload the VM to. This is
required*. *not required*.
- `username` (string) - The username to use to authenticate to the - `username` (string) - The username to use to authenticate to the
vSphere endpoint. vSphere endpoint.
......
...@@ -44,49 +44,36 @@ Optional: ...@@ -44,49 +44,36 @@ Optional:
- `command` (string) - The command to invoke ansible. Defaults - `command` (string) - The command to invoke ansible. Defaults
to "ansible-playbook". to "ansible-playbook".
- `extra_arguments` (array of strings) - An array of extra arguments to pass to - `extra_arguments` (array of strings) - An array of extra arguments to pass
the ansible command. By default, this is empty. to the ansible command. By default, this is empty.
- `inventory_groups` (string) - A comma-separated list of groups to which packer - `inventory_groups` (string) - A comma-separated list of groups to which
will assign the host `127.0.0.1`. A value of `my_group_1,my_group_2` will packer will assign the host `127.0.0.1`. A value of `my_group_1,my_group_2`
generate an Ansible inventory like: will generate an Ansible inventory like:
``` {.text} `{.text} [my_group_1] 127.0.0.1 [my_group_2] 127.0.0.1`
[my_group_1]
127.0.0.1
[my_group_2]
127.0.0.1
```
- `inventory_file` (string) - The inventory file to be used by ansible. This - `inventory_file` (string) - The inventory file to be used by ansible. This
file must exist on your local system and will be uploaded to the file must exist on your local system and will be uploaded to the
remote machine. remote machine.
When using an inventory file, it's also required to `--limit` the hosts to the When using an inventory file, it's also required to `--limit` the hosts to the
specified host you're buiding. The `--limit` argument can be provided in the specified host you're buiding. The `--limit` argument can be provided in the
`extra_arguments` option. `extra_arguments` option.
An example inventory file may look like: An example inventory file may look like:
``` {.text} \`\`\` {.text} \[chi-dbservers\] db-01 ansible\_connection=local db-02
[chi-dbservers] ansible\_connection=local
db-01 ansible_connection=local
db-02 ansible_connection=local
[chi-appservers] \[chi-appservers\] app-01 ansible\_connection=local app-02
app-01 ansible_connection=local ansible\_connection=local
app-02 ansible_connection=local
[chi:children] \[chi:children\] chi-dbservers chi-appservers
chi-dbservers
chi-appservers
[dbservers:children] \[dbservers:children\] chi-dbservers
chi-dbservers
[appservers:children] \[appservers:children\] chi-appservers \`\`\`
chi-appservers
```
- `playbook_dir` (string) - a path to the complete ansible directory structure - `playbook_dir` (string) - a path to the complete ansible directory structure
on your local system to be copied to the remote machine as the on your local system to be copied to the remote machine as the
...@@ -97,12 +84,12 @@ Optional: ...@@ -97,12 +84,12 @@ Optional:
`staging_directory`/playbooks. By default, this is empty. `staging_directory`/playbooks. By default, this is empty.
- `group_vars` (string) - a path to the directory containing ansible group - `group_vars` (string) - a path to the directory containing ansible group
variables on your local system to be copied to the remote machine. By default, variables on your local system to be copied to the remote machine. By
this is empty. default, this is empty.
- `host_vars` (string) - a path to the directory containing ansible host - `host_vars` (string) - a path to the directory containing ansible host
variables on your local system to be copied to the remote machine. By default, variables on your local system to be copied to the remote machine. By
this is empty. default, this is empty.
- `role_paths` (array of strings) - An array of paths to role directories on - `role_paths` (array of strings) - An array of paths to role directories on
your local system. These will be uploaded to the remote machine under your local system. These will be uploaded to the remote machine under
......
...@@ -43,37 +43,37 @@ configuration is actually required. ...@@ -43,37 +43,37 @@ configuration is actually required.
- `chef_environment` (string) - The name of the chef\_environment sent to the - `chef_environment` (string) - The name of the chef\_environment sent to the
Chef server. By default this is empty and will not use an environment. Chef server. By default this is empty and will not use an environment.
- `config_template` (string) - Path to a template that will be used for the Chef - `config_template` (string) - Path to a template that will be used for the
configuration file. By default Packer only sets configuration it needs to Chef configuration file. By default Packer only sets configuration it needs
match the settings set in the provisioner configuration. If you need to set to match the settings set in the provisioner configuration. If you need to
configurations that the Packer provisioner doesn't support, then you should set configurations that the Packer provisioner doesn't support, then you
use a custom configuration template. See the dedicated "Chef Configuration" should use a custom configuration template. See the dedicated "Chef
section below for more details. Configuration" section below for more details.
- `execute_command` (string) - The command used to execute Chef. This has - `execute_command` (string) - The command used to execute Chef. This has
various [configuration template various [configuration template
variables](/docs/templates/configuration-templates.html) available. See below variables](/docs/templates/configuration-templates.html) available. See
for more information. below for more information.
- `install_command` (string) - The command used to install Chef. This has - `install_command` (string) - The command used to install Chef. This has
various [configuration template various [configuration template
variables](/docs/templates/configuration-templates.html) available. See below variables](/docs/templates/configuration-templates.html) available. See
for more information. below for more information.
- `json` (object) - An arbitrary mapping of JSON that will be available as node - `json` (object) - An arbitrary mapping of JSON that will be available as
attributes while running Chef. node attributes while running Chef.
- `node_name` (string) - The name of the node to register with the Chef Server. - `node_name` (string) - The name of the node to register with the
This is optional and by default is packer-{{uuid}}. Chef Server. This is optional and by default is packer-{{uuid}}.
- `prevent_sudo` (boolean) - By default, the configured commands that are - `prevent_sudo` (boolean) - By default, the configured commands that are
executed to install and run Chef are executed with `sudo`. If this is true, executed to install and run Chef are executed with `sudo`. If this is true,
then the sudo will be omitted. then the sudo will be omitted.
- `run_list` (array of strings) - The [run - `run_list` (array of strings) - The [run
list](http://docs.opscode.com/essentials_node_object_run_lists.html) for Chef. list](http://docs.opscode.com/essentials_node_object_run_lists.html)
By default this is empty, and will use the run list sent down by the for Chef. By default this is empty, and will use the run list sent down by
Chef Server. the Chef Server.
- `server_url` (string) - The URL to the Chef server. This is required. - `server_url` (string) - The URL to the Chef server. This is required.
...@@ -96,14 +96,15 @@ configuration is actually required. ...@@ -96,14 +96,15 @@ configuration is actually required.
- `client_key` (string) - Path to client key. If not set, this defaults to a - `client_key` (string) - Path to client key. If not set, this defaults to a
file named client.pem in `staging_directory`. file named client.pem in `staging_directory`.
- `validation_client_name` (string) - Name of the validation client. If not set, - `validation_client_name` (string) - Name of the validation client. If not
this won't be set in the configuration and the default that Chef uses will set, this won't be set in the configuration and the default that Chef uses
be used. will be used.
- `validation_key_path` (string) - Path to the validation key for communicating - `validation_key_path` (string) - Path to the validation key for
with the Chef Server. This will be uploaded to the remote machine. If this is communicating with the Chef Server. This will be uploaded to the
NOT set, then it is your responsibility via other means (shell remote machine. If this is NOT set, then it is your responsibility via other
provisioner, etc.) to get a validation key to where Chef expects it. means (shell provisioner, etc.) to get a validation key to where Chef
expects it.
## Chef Configuration ## Chef Configuration
......
...@@ -39,17 +39,17 @@ configuration is actually required, but at least `run_list` is recommended. ...@@ -39,17 +39,17 @@ configuration is actually required, but at least `run_list` is recommended.
- `chef_environment` (string) - The name of the `chef_environment` sent to the - `chef_environment` (string) - The name of the `chef_environment` sent to the
Chef server. By default this is empty and will not use an environment Chef server. By default this is empty and will not use an environment
- `config_template` (string) - Path to a template that will be used for the Chef - `config_template` (string) - Path to a template that will be used for the
configuration file. By default Packer only sets configuration it needs to Chef configuration file. By default Packer only sets configuration it needs
match the settings set in the provisioner configuration. If you need to set to match the settings set in the provisioner configuration. If you need to
configurations that the Packer provisioner doesn't support, then you should set configurations that the Packer provisioner doesn't support, then you
use a custom configuration template. See the dedicated "Chef Configuration" should use a custom configuration template. See the dedicated "Chef
section below for more details. Configuration" section below for more details.
- `cookbook_paths` (array of strings) - This is an array of paths to "cookbooks" - `cookbook_paths` (array of strings) - This is an array of paths to
directories on your local filesystem. These will be uploaded to the remote "cookbooks" directories on your local filesystem. These will be uploaded to
machine in the directory specified by the `staging_directory`. By default, the remote machine in the directory specified by the `staging_directory`. By
this is empty. default, this is empty.
- `data_bags_path` (string) - The path to the "data\_bags" directory on your - `data_bags_path` (string) - The path to the "data\_bags" directory on your
local filesystem. These will be uploaded to the remote machine in the local filesystem. These will be uploaded to the remote machine in the
...@@ -65,16 +65,16 @@ configuration is actually required, but at least `run_list` is recommended. ...@@ -65,16 +65,16 @@ configuration is actually required, but at least `run_list` is recommended.
- `execute_command` (string) - The command used to execute Chef. This has - `execute_command` (string) - The command used to execute Chef. This has
various [configuration template various [configuration template
variables](/docs/templates/configuration-templates.html) available. See below variables](/docs/templates/configuration-templates.html) available. See
for more information. below for more information.
- `install_command` (string) - The command used to install Chef. This has - `install_command` (string) - The command used to install Chef. This has
various [configuration template various [configuration template
variables](/docs/templates/configuration-templates.html) available. See below variables](/docs/templates/configuration-templates.html) available. See
for more information. below for more information.
- `json` (object) - An arbitrary mapping of JSON that will be available as node - `json` (object) - An arbitrary mapping of JSON that will be available as
attributes while running Chef. node attributes while running Chef.
- `prevent_sudo` (boolean) - By default, the configured commands that are - `prevent_sudo` (boolean) - By default, the configured commands that are
executed to install and run Chef are executed with `sudo`. If this is true, executed to install and run Chef are executed with `sudo`. If this is true,
...@@ -90,17 +90,18 @@ configuration is actually required, but at least `run_list` is recommended. ...@@ -90,17 +90,18 @@ configuration is actually required, but at least `run_list` is recommended.
directory specified by the `staging_directory`. By default, this is empty. directory specified by the `staging_directory`. By default, this is empty.
- `run_list` (array of strings) - The [run - `run_list` (array of strings) - The [run
list](https://docs.chef.io/run_lists.html) for Chef. By default this is empty. list](https://docs.chef.io/run_lists.html) for Chef. By default this
is empty.
- `skip_install` (boolean) - If true, Chef will not automatically be installed - `skip_install` (boolean) - If true, Chef will not automatically be installed
on the machine using the Chef omnibus installers. on the machine using the Chef omnibus installers.
- `staging_directory` (string) - This is the directory where all the - `staging_directory` (string) - This is the directory where all the
configuration of Chef by Packer will be placed. By default this configuration of Chef by Packer will be placed. By default this
is "/tmp/packer-chef-solo". This directory doesn't need to exist but must have is "/tmp/packer-chef-solo". This directory doesn't need to exist but must
proper permissions so that the SSH user that Packer uses is able to create have proper permissions so that the SSH user that Packer uses is able to
directories and write into this folder. If the permissions are not correct, create directories and write into this folder. If the permissions are not
use a shell provisioner prior to this to configure it properly. correct, use a shell provisioner prior to this to configure it properly.
## Chef Configuration ## Chef Configuration
...@@ -121,8 +122,8 @@ variables available to use: ...@@ -121,8 +122,8 @@ variables available to use:
- `ChefEnvironment` - The current enabled environment. Only non-empty if the - `ChefEnvironment` - The current enabled environment. Only non-empty if the
environment path is set. environment path is set.
- `CookbookPaths` is the set of cookbook paths ready to embedded directly into a - `CookbookPaths` is the set of cookbook paths ready to embedded directly into
Ruby array to configure Chef. a Ruby array to configure Chef.
- `DataBagsPath` is the path to the data bags folder. - `DataBagsPath` is the path to the data bags folder.
- `EncryptedDataBagSecretPath` - The path to the encrypted data bag secret - `EncryptedDataBagSecretPath` - The path to the encrypted data bag secret
- `EnvironmentsPath` - The path to the environments folder. - `EnvironmentsPath` - The path to the environments folder.
......
...@@ -39,12 +39,12 @@ The available configuration options are listed below. All elements are required. ...@@ -39,12 +39,12 @@ The available configuration options are listed below. All elements are required.
uploading directories. uploading directories.
- `destination` (string) - The path where the file will be uploaded to in - `destination` (string) - The path where the file will be uploaded to in
the machine. This value must be a writable location and any parent directories the machine. This value must be a writable location and any parent
must already exist. directories must already exist.
- `direction` (string) - The direction of the file transfer. This defaults to - `direction` (string) - The direction of the file transfer. This defaults to
"upload." If it is set to "download" then the file "source" in the machine wll "upload." If it is set to "download" then the file "source" in the machine
be downloaded locally to "destination" wll be downloaded locally to "destination"
## Directory Uploads ## Directory Uploads
......
...@@ -35,18 +35,18 @@ Exactly *one* of the following is required: ...@@ -35,18 +35,18 @@ Exactly *one* of the following is required:
- `inline` (array of strings) - This is an array of commands to execute. The - `inline` (array of strings) - This is an array of commands to execute. The
commands are concatenated by newlines and turned into a single file, so they commands are concatenated by newlines and turned into a single file, so they
are all executed within the same context. This allows you to change are all executed within the same context. This allows you to change
directories in one command and use something in the directory in the next and directories in one command and use something in the directory in the next
so on. Inline scripts are the easiest way to pull off simple tasks within and so on. Inline scripts are the easiest way to pull off simple tasks
the machine. within the machine.
- `script` (string) - The path to a script to upload and execute in the machine. - `script` (string) - The path to a script to upload and execute in
This path can be absolute or relative. If it is relative, it is relative to the machine. This path can be absolute or relative. If it is relative, it is
the working directory when Packer is executed. relative to the working directory when Packer is executed.
- `scripts` (array of strings) - An array of scripts to execute. The scripts - `scripts` (array of strings) - An array of scripts to execute. The scripts
will be uploaded and executed in the order specified. Each script is executed will be uploaded and executed in the order specified. Each script is
in isolation, so state such as variables from one script won't carry on to executed in isolation, so state such as variables from one script won't
the next. carry on to the next.
Optional parameters: Optional parameters:
...@@ -54,10 +54,10 @@ Optional parameters: ...@@ -54,10 +54,10 @@ Optional parameters:
and Packer should therefore not convert Windows line endings to Unix line and Packer should therefore not convert Windows line endings to Unix line
endings (if there are any). By default this is false. endings (if there are any). By default this is false.
- `environment_vars` (array of strings) - An array of key/value pairs to inject - `environment_vars` (array of strings) - An array of key/value pairs to
prior to the execute\_command. The format should be `key=value`. Packer inject prior to the execute\_command. The format should be `key=value`.
injects some environmental variables by default into the environment, as well, Packer injects some environmental variables by default into the environment,
which are covered in the section below. as well, which are covered in the section below.
- `execute_command` (string) - The command to use to execute the script. By - `execute_command` (string) - The command to use to execute the script. By
default this is `powershell "& { {{.Vars}}{{.Path}}; exit $LastExitCode}"`. default this is `powershell "& { {{.Vars}}{{.Path}}; exit $LastExitCode}"`.
...@@ -71,13 +71,14 @@ Optional parameters: ...@@ -71,13 +71,14 @@ Optional parameters:
Windows user. Windows user.
- `remote_path` (string) - The path where the script will be uploaded to in - `remote_path` (string) - The path where the script will be uploaded to in
the machine. This defaults to "/tmp/script.sh". This value must be a writable the machine. This defaults to "/tmp/script.sh". This value must be a
location and any parent directories must already exist. writable location and any parent directories must already exist.
- `start_retry_timeout` (string) - The amount of time to attempt to *start* the - `start_retry_timeout` (string) - The amount of time to attempt to *start*
remote process. By default this is "5m" or 5 minutes. This setting exists in the remote process. By default this is "5m" or 5 minutes. This setting
order to deal with times when SSH may restart, such as a system reboot. Set exists in order to deal with times when SSH may restart, such as a
this to a higher value if reboots take a longer amount of time. system reboot. Set this to a higher value if reboots take a longer amount
of time.
- `valid_exit_codes` (list of ints) - Valid exit codes for the script. By - `valid_exit_codes` (list of ints) - Valid exit codes for the script. By
default this is just 0. default this is just 0.
...@@ -56,8 +56,8 @@ Optional parameters: ...@@ -56,8 +56,8 @@ Optional parameters:
- `execute_command` (string) - The command used to execute Puppet. This has - `execute_command` (string) - The command used to execute Puppet. This has
various [configuration template various [configuration template
variables](/docs/templates/configuration-templates.html) available. See below variables](/docs/templates/configuration-templates.html) available. See
for more information. below for more information.
- `facter` (object of key/value strings) - Additional - `facter` (object of key/value strings) - Additional
[facts](http://puppetlabs.com/puppet/related-projects/facter) to make [facts](http://puppetlabs.com/puppet/related-projects/facter) to make
...@@ -69,14 +69,13 @@ Optional parameters: ...@@ -69,14 +69,13 @@ Optional parameters:
- `manifest_dir` (string) - The path to a local directory with manifests to be - `manifest_dir` (string) - The path to a local directory with manifests to be
uploaded to the remote machine. This is useful if your main manifest file uploaded to the remote machine. This is useful if your main manifest file
uses imports. This directory doesn't necessarily contain the `manifest_file`. uses imports. This directory doesn't necessarily contain the
It is a separate directory that will be set as the "manifestdir" setting `manifest_file`. It is a separate directory that will be set as the
on Puppet. "manifestdir" setting on Puppet.
\~&gt; `manifest_dir` is passed to `puppet apply` as the \~&gt; `manifest_dir` is passed to `puppet apply` as the `--manifestdir` option.
`--manifestdir` option. This option was deprecated in puppet 3.6, and removed This option was deprecated in puppet 3.6, and removed in puppet 4.0. If you have
in puppet 4.0. If you have multiple manifests you should use multiple manifests you should use `manifest_file` instead.
`manifest_file` instead.
- `module_paths` (array of strings) - This is an array of paths to module - `module_paths` (array of strings) - This is an array of paths to module
directories on your local filesystem. These will be uploaded to the directories on your local filesystem. These will be uploaded to the
...@@ -89,15 +88,15 @@ Optional parameters: ...@@ -89,15 +88,15 @@ Optional parameters:
- `staging_directory` (string) - This is the directory where all the - `staging_directory` (string) - This is the directory where all the
configuration of Puppet by Packer will be placed. By default this configuration of Puppet by Packer will be placed. By default this
is "/tmp/packer-puppet-masterless". This directory doesn't need to exist but is "/tmp/packer-puppet-masterless". This directory doesn't need to exist but
must have proper permissions so that the SSH user that Packer uses is able to must have proper permissions so that the SSH user that Packer uses is able
create directories and write into this folder. If the permissions are not to create directories and write into this folder. If the permissions are not
correct, use a shell provisioner prior to this to configure it properly. correct, use a shell provisioner prior to this to configure it properly.
- `working_directory` (string) - This is the directory from which the puppet - `working_directory` (string) - This is the directory from which the puppet
command will be run. When using hiera with a relative path, this option allows command will be run. When using hiera with a relative path, this option
to ensure that the paths are working properly. If not specified, defaults to allows to ensure that the paths are working properly. If not specified,
the value of specified `staging_directory` (or its default value if not defaults to the value of specified `staging_directory` (or its default value
specified either). if not specified either).
## Execute Command ## Execute Command
......
...@@ -55,8 +55,8 @@ listed below: ...@@ -55,8 +55,8 @@ listed below:
- `ignore_exit_codes` (boolean) - If true, Packer will never consider the - `ignore_exit_codes` (boolean) - If true, Packer will never consider the
provisioner a failure. provisioner a failure.
- `options` (string) - Additional command line options to pass to `puppet agent` - `options` (string) - Additional command line options to pass to
when Puppet is ran. `puppet agent` when Puppet is ran.
- `prevent_sudo` (boolean) - By default, the configured commands that are - `prevent_sudo` (boolean) - By default, the configured commands that are
executed to run Puppet are executed with `sudo`. If this is true, then the executed to run Puppet are executed with `sudo`. If this is true, then the
...@@ -65,12 +65,12 @@ listed below: ...@@ -65,12 +65,12 @@ listed below:
- `puppet_node` (string) - The name of the node. If this isn't set, the fully - `puppet_node` (string) - The name of the node. If this isn't set, the fully
qualified domain name will be used. qualified domain name will be used.
- `puppet_server` (string) - Hostname of the Puppet server. By default "puppet" - `puppet_server` (string) - Hostname of the Puppet server. By default
will be used. "puppet" will be used.
- `staging_directory` (string) - This is the directory where all the - `staging_directory` (string) - This is the directory where all the
configuration of Puppet by Packer will be placed. By default this configuration of Puppet by Packer will be placed. By default this
is "/tmp/packer-puppet-server". This directory doesn't need to exist but must is "/tmp/packer-puppet-server". This directory doesn't need to exist but
have proper permissions so that the SSH user that Packer uses is able to must have proper permissions so that the SSH user that Packer uses is able
create directories and write into this folder. If the permissions are not to create directories and write into this folder. If the permissions are not
correct, use a shell provisioner prior to this to configure it properly. correct, use a shell provisioner prior to this to configure it properly.
...@@ -54,5 +54,5 @@ Optional: ...@@ -54,5 +54,5 @@ Optional:
bootstrap](https://github.com/saltstack/salt-bootstrap) to install salt. Set bootstrap](https://github.com/saltstack/salt-bootstrap) to install salt. Set
this to true to skip this step. this to true to skip this step.
- `temp_config_dir` (string) - Where your local state tree will be copied before - `temp_config_dir` (string) - Where your local state tree will be copied
moving to the `/srv/salt` directory. Default is `/tmp/salt`. before moving to the `/srv/salt` directory. Default is `/tmp/salt`.
...@@ -40,18 +40,18 @@ Exactly *one* of the following is required: ...@@ -40,18 +40,18 @@ Exactly *one* of the following is required:
- `inline` (array of strings) - This is an array of commands to execute. The - `inline` (array of strings) - This is an array of commands to execute. The
commands are concatenated by newlines and turned into a single file, so they commands are concatenated by newlines and turned into a single file, so they
are all executed within the same context. This allows you to change are all executed within the same context. This allows you to change
directories in one command and use something in the directory in the next and directories in one command and use something in the directory in the next
so on. Inline scripts are the easiest way to pull off simple tasks within and so on. Inline scripts are the easiest way to pull off simple tasks
the machine. within the machine.
- `script` (string) - The path to a script to upload and execute in the machine. - `script` (string) - The path to a script to upload and execute in
This path can be absolute or relative. If it is relative, it is relative to the machine. This path can be absolute or relative. If it is relative, it is
the working directory when Packer is executed. relative to the working directory when Packer is executed.
- `scripts` (array of strings) - An array of scripts to execute. The scripts - `scripts` (array of strings) - An array of scripts to execute. The scripts
will be uploaded and executed in the order specified. Each script is executed will be uploaded and executed in the order specified. Each script is
in isolation, so state such as variables from one script won't carry on to executed in isolation, so state such as variables from one script won't
the next. carry on to the next.
Optional parameters: Optional parameters:
...@@ -59,14 +59,14 @@ Optional parameters: ...@@ -59,14 +59,14 @@ Optional parameters:
and Packer should therefore not convert Windows line endings to Unix line and Packer should therefore not convert Windows line endings to Unix line
endings (if there are any). By default this is false. endings (if there are any). By default this is false.
- `environment_vars` (array of strings) - An array of key/value pairs to inject - `environment_vars` (array of strings) - An array of key/value pairs to
prior to the execute\_command. The format should be `key=value`. Packer inject prior to the execute\_command. The format should be `key=value`.
injects some environmental variables by default into the environment, as well, Packer injects some environmental variables by default into the environment,
which are covered in the section below. as well, which are covered in the section below.
- `execute_command` (string) - The command to use to execute the script. By - `execute_command` (string) - The command to use to execute the script. By
default this is `chmod +x {{ .Path }}; {{ .Vars }} {{ .Path }}`. The value of default this is `chmod +x {{ .Path }}; {{ .Vars }} {{ .Path }}`. The value
this is treated as [configuration of this is treated as [configuration
template](/docs/templates/configuration-templates.html). There are two template](/docs/templates/configuration-templates.html). There are two
available variables: `Path`, which is the path to the script to run, and available variables: `Path`, which is the path to the script to run, and
`Vars`, which is the list of `environment_vars`, if configured. `Vars`, which is the list of `environment_vars`, if configured.
...@@ -79,13 +79,14 @@ Optional parameters: ...@@ -79,13 +79,14 @@ Optional parameters:
`-e` flag, otherwise individual steps failing won't fail the provisioner. `-e` flag, otherwise individual steps failing won't fail the provisioner.
- `remote_path` (string) - The path where the script will be uploaded to in - `remote_path` (string) - The path where the script will be uploaded to in
the machine. This defaults to "/tmp/script.sh". This value must be a writable the machine. This defaults to "/tmp/script.sh". This value must be a
location and any parent directories must already exist. writable location and any parent directories must already exist.
- `start_retry_timeout` (string) - The amount of time to attempt to *start* the - `start_retry_timeout` (string) - The amount of time to attempt to *start*
remote process. By default this is "5m" or 5 minutes. This setting exists in the remote process. By default this is "5m" or 5 minutes. This setting
order to deal with times when SSH may restart, such as a system reboot. Set exists in order to deal with times when SSH may restart, such as a
this to a higher value if reboots take a longer amount of time. system reboot. Set this to a higher value if reboots take a longer amount
of time.
## Execute Command Example ## Execute Command Example
...@@ -133,8 +134,8 @@ commonly useful environmental variables: ...@@ -133,8 +134,8 @@ commonly useful environmental variables:
distinguish them slightly from a common provisioning script. distinguish them slightly from a common provisioning script.
- `PACKER_BUILDER_TYPE` is the type of the builder that was used to create the - `PACKER_BUILDER_TYPE` is the type of the builder that was used to create the
machine that the script is running on. This is useful if you want to run only machine that the script is running on. This is useful if you want to run
certain parts of the script on systems built with certain builders. only certain parts of the script on systems built with certain builders.
## Handling Reboots ## Handling Reboots
...@@ -181,24 +182,19 @@ provisioner](/docs/provisioners/file.html) (more secure) or using `ssh-keyscan` ...@@ -181,24 +182,19 @@ provisioner](/docs/provisioners/file.html) (more secure) or using `ssh-keyscan`
to populate the file (less secure). An example of the latter accessing github to populate the file (less secure). An example of the latter accessing github
would be: would be:
{ { "type": "shell", "inline": \[ "sudo apt-get install -y git", "ssh-keyscan
"type": "shell", github.com &gt;&gt; \~/.ssh/known\_hosts", "git clone
"inline": [ git@github.com:exampleorg/myprivaterepo.git" \] }
"sudo apt-get install -y git",
"ssh-keyscan github.com >> ~/.ssh/known_hosts",
"git clone git@github.com:exampleorg/myprivaterepo.git"
]
}
## Troubleshooting ## Troubleshooting
*My shell script doesn't work correctly on Ubuntu* *My shell script doesn't work correctly on Ubuntu*
- On Ubuntu, the `/bin/sh` shell is - On Ubuntu, the `/bin/sh` shell is
[dash](http://en.wikipedia.org/wiki/Debian_Almquist_shell). If your script has [dash](http://en.wikipedia.org/wiki/Debian_Almquist_shell). If your script
[bash](http://en.wikipedia.org/wiki/Bash_(Unix_shell))-specific commands in has [bash](http://en.wikipedia.org/wiki/Bash_(Unix_shell))-specific commands
it, then put `#!/bin/bash` at the top of your script. Differences between dash in it, then put `#!/bin/bash` at the top of your script. Differences between
and bash can be found on the dash and bash can be found on the
[DashAsBinSh](https://wiki.ubuntu.com/DashAsBinSh) Ubuntu wiki page. [DashAsBinSh](https://wiki.ubuntu.com/DashAsBinSh) Ubuntu wiki page.
*My shell works when I login but fails with the shell provisioner* *My shell works when I login but fails with the shell provisioner*
......
...@@ -113,6 +113,7 @@ Numeric ...@@ -113,6 +113,7 @@ Numeric
</th> </th>
<td align="center"> <td align="center">
- -
</td> </td>
<td align="center"> <td align="center">
01 01
...@@ -148,18 +149,23 @@ January (Jan) ...@@ -148,18 +149,23 @@ January (Jan)
</td> </td>
<td align="center"> <td align="center">
- -
</td> </td>
<td align="center"> <td align="center">
- -
</td> </td>
<td align="center"> <td align="center">
- -
</td> </td>
<td align="center"> <td align="center">
- -
</td> </td>
<td align="center"> <td align="center">
- -
</td> </td>
<td align="center"> <td align="center">
MST MST
......
...@@ -37,29 +37,30 @@ Along with each key, it is noted whether it is required or not. ...@@ -37,29 +37,30 @@ Along with each key, it is noted whether it is required or not.
template does. This output is used only in the [inspect template does. This output is used only in the [inspect
command](/docs/command-line/inspect.html). command](/docs/command-line/inspect.html).
- `min_packer_version` (optional) is a string that has a minimum Packer version - `min_packer_version` (optional) is a string that has a minimum Packer
that is required to parse the template. This can be used to ensure that proper version that is required to parse the template. This can be used to ensure
versions of Packer are used with the template. A max version can't be that proper versions of Packer are used with the template. A max version
specified because Packer retains backwards compatibility with `packer fix`. can't be specified because Packer retains backwards compatibility with
`packer fix`.
- `post-processors` (optional) is an array of one or more objects that defines - `post-processors` (optional) is an array of one or more objects that defines
the various post-processing steps to take with the built images. If not the various post-processing steps to take with the built images. If not
specified, then no post-processing will be done. For more information on what specified, then no post-processing will be done. For more information on
post-processors do and how they're defined, read the sub-section on what post-processors do and how they're defined, read the sub-section on
[configuring post-processors in [configuring post-processors in
templates](/docs/templates/post-processors.html). templates](/docs/templates/post-processors.html).
- `provisioners` (optional) is an array of one or more objects that defines the - `provisioners` (optional) is an array of one or more objects that defines
provisioners that will be used to install and configure software for the the provisioners that will be used to install and configure software for the
machines created by each of the builders. If it is not specified, then no machines created by each of the builders. If it is not specified, then no
provisioners will be run. For more information on how to define and configure provisioners will be run. For more information on how to define and
a provisioner, read the sub-section on [configuring provisioners in configure a provisioner, read the sub-section on [configuring provisioners
templates](/docs/templates/provisioners.html). in templates](/docs/templates/provisioners.html).
- `variables` (optional) is an array of one or more key/value strings that - `variables` (optional) is an array of one or more key/value strings that
defines user variables contained in the template. If it is not specified, then defines user variables contained in the template. If it is not specified,
no variables are defined. For more information on how to define and use user then no variables are defined. For more information on how to define and use
variables, read the sub-section on [user variables in user variables, read the sub-section on [user variables in
templates](/docs/templates/user-variables.html). templates](/docs/templates/user-variables.html).
## Comments ## Comments
......
...@@ -42,12 +42,12 @@ each category, the available configuration keys are alphabetized. ...@@ -42,12 +42,12 @@ each category, the available configuration keys are alphabetized.
### Optional ### Optional
- `address` (string) - The address of the build service to use. By default this - `address` (string) - The address of the build service to use. By default
is `https://atlas.hashicorp.com`. this is `https://atlas.hashicorp.com`.
- `base_dir` (string) - The base directory of the files to upload. This will be - `base_dir` (string) - The base directory of the files to upload. This will
the current working directory when the build service executes your template. be the current working directory when the build service executes
This path is relative to the template. your template. This path is relative to the template.
- `include` (array of strings) - Glob patterns to include relative to the - `include` (array of strings) - Glob patterns to include relative to the
`base_dir`. If this is specified, only files that match the include pattern `base_dir`. If this is specified, only files that match the include pattern
......
...@@ -34,20 +34,22 @@ on supported configuration parameters and usage, please see the appropriate ...@@ -34,20 +34,22 @@ on supported configuration parameters and usage, please see the appropriate
[documentation page within the documentation section](/docs). [documentation page within the documentation section](/docs).
- ***Amazon EC2 (AMI)***. Both EBS-backed and instance-store AMIs within - ***Amazon EC2 (AMI)***. Both EBS-backed and instance-store AMIs within
[EC2](http://aws.amazon.com/ec2/), optionally distributed to multiple regions. [EC2](http://aws.amazon.com/ec2/), optionally distributed to
multiple regions.
- ***DigitalOcean***. Snapshots for [DigitalOcean](http://www.digitalocean.com/) - ***DigitalOcean***. Snapshots for
that can be used to start a pre-configured DigitalOcean instance of any size. [DigitalOcean](http://www.digitalocean.com/) that can be used to start a
pre-configured DigitalOcean instance of any size.
- ***Docker***. Snapshots for [Docker](http://www.docker.io/) that can be used - ***Docker***. Snapshots for [Docker](http://www.docker.io/) that can be used
to start a pre-configured Docker instance. to start a pre-configured Docker instance.
- ***Google Compute Engine***. Snapshots for [Google Compute - ***Google Compute Engine***. Snapshots for [Google Compute
Engine](https://cloud.google.com/products/compute-engine) that can be used to Engine](https://cloud.google.com/products/compute-engine) that can be used
start a pre-configured Google Compute Engine instance. to start a pre-configured Google Compute Engine instance.
- ***OpenStack***. Images for [OpenStack](http://www.openstack.org/) that can be - ***OpenStack***. Images for [OpenStack](http://www.openstack.org/) that can
used to start pre-configured OpenStack servers. be used to start pre-configured OpenStack servers.
- ***Parallels (PVM)***. Exported virtual machines for - ***Parallels (PVM)***. Exported virtual machines for
[Parallels](http://www.parallels.com/downloads/desktop/), including virtual [Parallels](http://www.parallels.com/downloads/desktop/), including virtual
...@@ -55,13 +57,13 @@ on supported configuration parameters and usage, please see the appropriate ...@@ -55,13 +57,13 @@ on supported configuration parameters and usage, please see the appropriate
and can be started on any platform Parallels runs on. and can be started on any platform Parallels runs on.
- ***QEMU***. Images for [KVM](http://www.linux-kvm.org/) or - ***QEMU***. Images for [KVM](http://www.linux-kvm.org/) or
[Xen](http://www.xenproject.org/) that can be used to start pre-configured KVM [Xen](http://www.xenproject.org/) that can be used to start pre-configured
or Xen instances. KVM or Xen instances.
- ***VirtualBox (OVF)***. Exported virtual machines for - ***VirtualBox (OVF)***. Exported virtual machines for
[VirtualBox](https://www.virtualbox.org/), including virtual machine metadata [VirtualBox](https://www.virtualbox.org/), including virtual machine
such as RAM, CPUs, etc. These virtual machines are portable and can be started metadata such as RAM, CPUs, etc. These virtual machines are portable and can
on any platform VirtualBox runs on. be started on any platform VirtualBox runs on.
- ***VMware (VMX)***. Exported virtual machines for - ***VMware (VMX)***. Exported virtual machines for
[VMware](http://www.vmware.com/) that can be run within any desktop products [VMware](http://www.vmware.com/) that can be run within any desktop products
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment