Merge pull request #4550 from mitchellh/docup

doc updates
This commit is contained in:
Matthew Hooker 2017-02-10 20:14:05 -08:00 committed by GitHub
commit e09a6d8956
5 changed files with 62 additions and 12 deletions

View File

@ -28,6 +28,10 @@ bit.
The builder does *not* manage AMIs. Once it creates an AMI and stores it in your The builder does *not* manage AMIs. Once it creates an AMI and stores it in your
account, it is up to you to use, delete, etc. the AMI. account, it is up to you to use, delete, etc. the AMI.
-> **Note:** Temporary resources are, by default, all created with the prefix
`packer`. This can be useful if you want to restrict the security groups and
key pairs Packer is able to operate on.
## Configuration Reference ## Configuration Reference
There are many configuration options available for the builder. They are There are many configuration options available for the builder. They are
@ -66,7 +70,7 @@ builder.
- `ami_block_device_mappings` (array of block device mappings) - Add one or - `ami_block_device_mappings` (array of block device mappings) - Add one or
more [block device mappings](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) more [block device mappings](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html)
to the AMI. These will be attached when booting a new instance from your to the AMI. These will be attached when booting a new instance from your
AMI. To add a block device during the packer build see AMI. To add a block device during the Packer build see
`launch_block_device_mappings` below. Your options here may vary depending `launch_block_device_mappings` below. Your options here may vary depending
on the type of VM you use. The block device mappings allow for the following on the type of VM you use. The block device mappings allow for the following
configuration: configuration:
@ -179,8 +183,8 @@ builder.
to launch the EC2 instance with. to launch the EC2 instance with.
- `launch_block_device_mappings` (array of block device mappings) - Add one or - `launch_block_device_mappings` (array of block device mappings) - Add one or
more block devices before the packer build starts. These are not necessarily more block devices before the Packer build starts. These are not necessarily
preserved when booting from the AMI built with packer. See preserved when booting from the AMI built with Packer. See
`ami_block_device_mappings`, above, for details. `ami_block_device_mappings`, above, for details.
- `run_tags` (object of key/value strings) - Tags to apply to the instance - `run_tags` (object of key/value strings) - Tags to apply to the instance
@ -208,7 +212,7 @@ builder.
`security_group_id`. `security_group_id`.
- `shutdown_behavior` (string) - Automatically terminate instances on shutdown - `shutdown_behavior` (string) - Automatically terminate instances on shutdown
incase packer exits ungracefully. Possible values are "stop" and "terminate", in case Packer exits ungracefully. Possible values are "stop" and "terminate",
default is `stop`. default is `stop`.
- `skip_region_validation` (boolean) - Set to true if you want to skip - `skip_region_validation` (boolean) - Set to true if you want to skip
@ -301,7 +305,8 @@ builder.
`BuildRegion` variable is replaced with the value of `region`. `BuildRegion` variable is replaced with the value of `region`.
- `temporary_key_pair_name` (string) - The name of the temporary key pair - `temporary_key_pair_name` (string) - The name of the temporary key pair
to generate. By default, Packer generates a name with a UUID. to generate. By default, Packer generates a name that looks like
`packer_<UUID>`, where \<UUID\> is a 36 character unique identifier.
- `token` (string) - The access token to use. This is different from the - `token` (string) - The access token to use. This is different from the
access key and secret key. If you're not sure what this is, then you access key and secret key. If you're not sure what this is, then you

View File

@ -24,6 +24,10 @@ instance while the image is being created.
The builder does *not* manage EBS Volumes. Once it creates volumes and stores The builder does *not* manage EBS Volumes. Once it creates volumes and stores
it in your account, it is up to you to use, delete, etc. the volumes. it in your account, it is up to you to use, delete, etc. the volumes.
-> **Note:** Temporary resources are, by default, all created with the prefix
`packer`. This can be useful if you want to restrict the security groups and
key pairs Packer is able to operate on.
## Configuration Reference ## Configuration Reference
There are many configuration options available for the builder. They are There are many configuration options available for the builder. They are
@ -121,7 +125,7 @@ builder.
`security_group_id`. `security_group_id`.
- `shutdown_behavior` (string) - Automatically terminate instances on shutdown - `shutdown_behavior` (string) - Automatically terminate instances on shutdown
incase packer exits ungracefully. Possible values are `stop` and `terminate`. in case Packer exits ungracefully. Possible values are `stop` and `terminate`.
Defaults to `stop`. Defaults to `stop`.
- `skip_region_validation` (boolean) - Set to `true` if you want to skip - `skip_region_validation` (boolean) - Set to `true` if you want to skip
@ -193,7 +197,8 @@ builder.
required if you are using an non-default VPC. required if you are using an non-default VPC.
- `temporary_key_pair_name` (string) - The name of the temporary key pair - `temporary_key_pair_name` (string) - The name of the temporary key pair
to generate. By default, Packer generates a name with an UUID. to generate. By default, Packer generates a name that looks like
`packer_<UUID>`, where \<UUID\> is a 36 character unique identifier.
- `token` (string) - The access token to use. This is different from the - `token` (string) - The access token to use. This is different from the
access key and secret key. If you're not sure what this is, then you access key and secret key. If you're not sure what this is, then you

View File

@ -28,6 +28,10 @@ created. This simplifies configuration quite a bit.
The builder does *not* manage AMIs. Once it creates an AMI and stores it in The builder does *not* manage AMIs. Once it creates an AMI and stores it in
your account, it is up to you to use, delete, etc. the AMI. your account, it is up to you to use, delete, etc. the AMI.
-> **Note:** Temporary resources are, by default, all created with the prefix
`packer`. This can be useful if you want to restrict the security groups and
key pairs packer is able to operate on.
-> **Note:** This builder requires that the [Amazon EC2 AMI -> **Note:** This builder requires that the [Amazon EC2 AMI
Tools](https://aws.amazon.com/developertools/368) are installed onto the Tools](https://aws.amazon.com/developertools/368) are installed onto the
machine. This can be done within a provisioner, but must be done before the machine. This can be done within a provisioner, but must be done before the
@ -88,7 +92,7 @@ builder.
- `ami_block_device_mappings` (array of block device mappings) - Add one or - `ami_block_device_mappings` (array of block device mappings) - Add one or
more [block device mappings](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) more [block device mappings](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html)
to the AMI. These will be attached when booting a new instance from your to the AMI. These will be attached when booting a new instance from your
AMI. To add a block device during the packer build see AMI. To add a block device during the Packer build see
`launch_block_device_mappings` below. Your options here may vary depending `launch_block_device_mappings` below. Your options here may vary depending
on the type of VM you use. The block device mappings allow for the following on the type of VM you use. The block device mappings allow for the following
configuration: configuration:
@ -195,8 +199,8 @@ builder.
to launch the EC2 instance with. to launch the EC2 instance with.
- `launch_block_device_mappings` (array of block device mappings) - Add one or - `launch_block_device_mappings` (array of block device mappings) - Add one or
more block devices before the packer build starts. These are not necessarily more block devices before the Packer build starts. These are not necessarily
preserved when booting from the AMI built with packer. See preserved when booting from the AMI built with Packer. See
`ami_block_device_mappings`, above, for details. `ami_block_device_mappings`, above, for details.
- `run_tags` (object of key/value strings) - Tags to apply to the instance - `run_tags` (object of key/value strings) - Tags to apply to the instance
@ -302,7 +306,8 @@ builder.
`BuildRegion` variable is replaced with the value of `region`. `BuildRegion` variable is replaced with the value of `region`.
- `temporary_key_pair_name` (string) - The name of the temporary key pair - `temporary_key_pair_name` (string) - The name of the temporary key pair
to generate. By default, Packer generates a name with an UUID. to generate. By default, Packer generates a name that looks like
`packer_<UUID>`, where \<UUID\> is a 36 character unique identifier.
- `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

View File

@ -0,0 +1,34 @@
---
description: |
Packer community project index.
layout: docs
page_title: Packer Community
...
# Community Projects
Packer has a vibrant community of contributers who have built a number of great
tools on top of Packer. There are also quite a few projects demonstrating the
power of Packer templates. This is an incomplete list.
## Templates
* **https://github.com/boxcutter -** Community-driven templates and tools for
creating cloud, virtual machines, containers and metal operating system
environments.
* **https://github.com/tylert/packer-build -** These Packer templates and
associated files may be used to build fresh Debian and Ubuntu virtual machine
images for Vagrant, VirtualBox and QEMU.
* **https://github.com/chef/bento -** Packer templates for building minimal Vagrant baseboxes.
* **https://github.com/joefitzgerald/packer-windows -** Windows Packer Templates.
* **https://github.com/taliesins/packer-baseboxes -** Templates for packer to build base boxes.
* **https://github.com/cbednarski/packer-ubuntu -** Ubuntu LTS Virtual Machines for Vagrant
## Wrappers
* **[packer-config](https://github.com/ianchesal/packer-config) -** A Ruby model that lets you build Packer configurations in Ruby.
* **[racker](https://github.com/aspring/racker) -** Racker is an opinionated Ruby DSL for generating Packer templates.
## Other
* **[suitcase](https://github.com/tmclaugh/suitcase) -** Packer based build system for CentOS OS images.

View File

@ -101,6 +101,7 @@
<li><a href="/docs/other/core-configuration.html">Core Configuration</a></li> <li><a href="/docs/other/core-configuration.html">Core Configuration</a></li>
<li><a href="/docs/other/debugging.html">Debugging</a></li> <li><a href="/docs/other/debugging.html">Debugging</a></li>
<li><a href="/docs/other/environmental-variables.html">Environmental Variables</a></li> <li><a href="/docs/other/environmental-variables.html">Environmental Variables</a></li>
<li><a href="/docs/other/community.html">Community Projects</a></li>
</ul> </ul>
<ul> <ul>
<li> <li>