diff --git a/website/source/community/index.html.markdown b/website/source/community/index.html.markdown index 4fedf4349..89c37ef03 100644 --- a/website/source/community/index.html.markdown +++ b/website/source/community/index.html.markdown @@ -1,6 +1,8 @@ --- layout: "community" page_title: "Community" +description: |- + Packer is a new project with a growing community. Despite this, there are dedicated users willing to help through various mediums. --- # Community diff --git a/website/source/docs/basics/terminology.html.markdown b/website/source/docs/basics/terminology.html.markdown index 18f53cde8..4fce2cc79 100644 --- a/website/source/docs/basics/terminology.html.markdown +++ b/website/source/docs/basics/terminology.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Packer Terminology" +description: |- + There are a handful of terms used throughout the Packer documentation where the meaning may not be immediately obvious if you haven't used Packer before. Luckily, there are relatively few. This page documents all the terminology required to understand and use Packer. The terminology is in alphabetical order for easy referencing. --- # Packer Terminology diff --git a/website/source/docs/builders/amazon-chroot.html.markdown b/website/source/docs/builders/amazon-chroot.html.markdown index 5a545a91a..41235496e 100644 --- a/website/source/docs/builders/amazon-chroot.html.markdown +++ b/website/source/docs/builders/amazon-chroot.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Amazon AMI Builder (chroot)" +description: |- + The `amazon-chroot` Packer builder is able to create Amazon AMIs backed by an EBS volume as the root device. For more information on the difference between instance storage and EBS-backed instances, storage for the root device section in the EC2 documentation. --- # AMI Builder (chroot) Type: `amazon-chroot` -The `amazon-chroot` builder is able to create Amazon AMIs backed by +The `amazon-chroot` Packer builder is able to create Amazon AMIs backed by an EBS volume as the root device. For more information on the difference between instance storage and EBS-backed instances, see the ["storage for the root device" section in the EC2 documentation](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). diff --git a/website/source/docs/builders/amazon-ebs.html.markdown b/website/source/docs/builders/amazon-ebs.html.markdown index 4bfd78c5b..95f7ffcf9 100644 --- a/website/source/docs/builders/amazon-ebs.html.markdown +++ b/website/source/docs/builders/amazon-ebs.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Amazon AMI Builder (EBS backed)" +description: |- + The `amazon-ebs` Packer builder is able to create Amazon AMIs backed by EBS volumes for use in EC2. For more information on the difference betwen EBS-backed instances and instance-store backed instances, see the storage for the root device section in the EC2 documentation. --- # AMI Builder (EBS backed) Type: `amazon-ebs` -The `amazon-ebs` builder is able to create Amazon AMIs backed by EBS +The `amazon-ebs` Packer builder is able to create Amazon AMIs backed by EBS volumes for use in [EC2](http://aws.amazon.com/ec2/). For more information on the difference betwen EBS-backed instances and instance-store backed instances, see the diff --git a/website/source/docs/builders/amazon-instance.html.markdown b/website/source/docs/builders/amazon-instance.html.markdown index 3fc5de7fc..43080accb 100644 --- a/website/source/docs/builders/amazon-instance.html.markdown +++ b/website/source/docs/builders/amazon-instance.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Amazon AMI Builder (instance-store)" +description: |- + The `amazon-instance` Packer builder is able to create Amazon AMIs backed by instance storage as the root device. For more information on the difference between instance storage and EBS-backed instances, see the storage for the root device section in the EC2 documentation. --- # AMI Builder (instance-store) Type: `amazon-instance` -The `amazon-instance` builder is able to create Amazon AMIs backed by +The `amazon-instance` Packer builder is able to create Amazon AMIs backed by instance storage as the root device. For more information on the difference between instance storage and EBS-backed instances, see the ["storage for the root device" section in the EC2 documentation](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). diff --git a/website/source/docs/builders/amazon.html.markdown b/website/source/docs/builders/amazon.html.markdown index cec855f3f..49d6e202e 100644 --- a/website/source/docs/builders/amazon.html.markdown +++ b/website/source/docs/builders/amazon.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Amazon AMI Builder" +description: |- + Packer is able to create Amazon AMIs. To achieve this, Packer comes with multiple builders depending on the strategy you want to use to build the AMI. --- # Amazon AMI Builder diff --git a/website/source/docs/builders/custom.html.markdown b/website/source/docs/builders/custom.html.markdown index 2b087a48a..a737c1bd1 100644 --- a/website/source/docs/builders/custom.html.markdown +++ b/website/source/docs/builders/custom.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Custom Builder" +description: |- + Packer is extensible, allowing you to write new builders without having to modify the core source code of Packer itself. Documentation for creating new builders is covered in the custom builders page of the Packer plugin section. --- # Custom Builder diff --git a/website/source/docs/builders/digitalocean.html.markdown b/website/source/docs/builders/digitalocean.html.markdown index ee714dcbb..d750cde1f 100644 --- a/website/source/docs/builders/digitalocean.html.markdown +++ b/website/source/docs/builders/digitalocean.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "DigitalOcean Builder" +description: |- + The `digitalocean` Packer builder is able to create new images for use with DigitalOcean. The builder takes a source image, runs any provisioning necessary on the image after launching it, then snapshots it into a reusable image. This reusable image can then be used as the foundation of new servers that are launched within DigitalOcean. --- # DigitalOcean Builder Type: `digitalocean` -The `digitalocean` builder is able to create new images for use with +The `digitalocean` Packer builder is able to create new images for use with [DigitalOcean](http://www.digitalocean.com). The builder takes a source image, runs any provisioning necessary on the image after launching it, then snapshots it into a reusable image. This reusable image can then be diff --git a/website/source/docs/builders/docker.html.markdown b/website/source/docs/builders/docker.html.markdown index d4b0b0151..61b4b4d79 100644 --- a/website/source/docs/builders/docker.html.markdown +++ b/website/source/docs/builders/docker.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Docker Builder" +description: |- + The `docker` Packer builder builds Docker images using Docker. The builder starts a Docker container, runs provisioners within this container, then exports the container for reuse or commits the image. --- # Docker Builder Type: `docker` -The Docker builder builds [Docker](http://www.docker.io) images using +The `docker` Packer builder builds [Docker](http://www.docker.io) images using Docker. The builder starts a Docker container, runs provisioners within this container, then exports the container for reuse or commits the image. diff --git a/website/source/docs/builders/googlecompute.markdown b/website/source/docs/builders/googlecompute.markdown index fb63350a0..7e4355eec 100644 --- a/website/source/docs/builders/googlecompute.markdown +++ b/website/source/docs/builders/googlecompute.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Google Compute Builder" +description: |- + The `googlecompute` Packer builder is able to create images for use with Google Compute Engine (GCE) based on existing images. Google Compute Engine doesn't allow the creation of images from scratch. --- # Google Compute Builder Type: `googlecompute` -The `googlecompute` builder is able to create +The `googlecompute` Packer builder is able to create [images](https://developers.google.com/compute/docs/images) for use with [Google Compute Engine](https://cloud.google.com/products/compute-engine) (GCE) based on existing images. Google Compute Engine doesn't allow the creation diff --git a/website/source/docs/builders/null.html.markdown b/website/source/docs/builders/null.html.markdown index af655922f..1229db359 100644 --- a/website/source/docs/builders/null.html.markdown +++ b/website/source/docs/builders/null.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Null Builder" +description: |- + The `null` Packer builder is not really a builder, it just sets up an SSH connection and runs the provisioners. It can be used to debug provisioners without incurring high wait times. It does not create any kind of image or artifact. --- # Null Builder Type: `null` -The null builder is not really a builder, it just sets up an SSH connection +The `null` Packer builder is not really a builder, it just sets up an SSH connection and runs the provisioners. It can be used to debug provisioners without incurring high wait times. It does not create any kind of image or artifact. diff --git a/website/source/docs/builders/openstack.html.markdown b/website/source/docs/builders/openstack.html.markdown index b94a81414..0e864e4bd 100644 --- a/website/source/docs/builders/openstack.html.markdown +++ b/website/source/docs/builders/openstack.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "OpenStack Builder" +description: |- + The `openstack` Packer builder is able to create new images for use with OpenStack. The builder takes a source image, runs any provisioning necessary on the image after launching it, then creates a new reusable image. This reusable image can then be used as the foundation of new servers that are launched within OpenStack. The builder will create temporary keypairs that provide temporary access to the server while the image is being created. This simplifies configuration quite a bit. --- # OpenStack Builder Type: `openstack` -The `openstack` builder is able to create new images for use with +The `openstack` Packer builder is able to create new images for use with [OpenStack](http://www.openstack.org). The builder takes a source image, runs any provisioning necessary on the image after launching it, then creates a new reusable image. This reusable image can then be diff --git a/website/source/docs/builders/parallels-iso.html.markdown b/website/source/docs/builders/parallels-iso.html.markdown index 2a63ca1a1..3d8bbaddc 100644 --- a/website/source/docs/builders/parallels-iso.html.markdown +++ b/website/source/docs/builders/parallels-iso.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Parallels Builder (from an ISO)" +description: |- + The Parallels Packer builder is able to create Parallels Desktop for Mac virtual machines and export them in the PVM format, starting from an ISO image. --- # Parallels Builder (from an ISO) Type: `parallels-iso` -The Parallels builder is able to create +The Parallels Packer builder is able to create [Parallels Desktop for Mac](http://www.parallels.com/products/desktop/) virtual machines and export them in the PVM format, starting from an ISO image. diff --git a/website/source/docs/builders/parallels-pvm.html.markdown b/website/source/docs/builders/parallels-pvm.html.markdown index 161611f84..5bd1c92cf 100644 --- a/website/source/docs/builders/parallels-pvm.html.markdown +++ b/website/source/docs/builders/parallels-pvm.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Parallels Builder (from a PVM)" +description: |- + This Parallels builder is able to create Parallels Desktop for Mac virtual machines and export them in the PVM format, starting from an existing PVM (exported virtual machine image). --- # Parallels Builder (from a PVM) diff --git a/website/source/docs/builders/parallels.html.markdown b/website/source/docs/builders/parallels.html.markdown index 98a1f9994..db5f62139 100644 --- a/website/source/docs/builders/parallels.html.markdown +++ b/website/source/docs/builders/parallels.html.markdown @@ -1,11 +1,13 @@ --- layout: "docs" page_title: "Parallels Builder" +description: |- + The Parallels Packer builder is able to create Parallels Desktop for Mac virtual machines and export them in the PVM format. --- # Parallels Builder -The Parallels builder is able to create [Parallels Desktop for Mac](http://www.parallels.com/products/desktop/) virtual machines and export them in the PVM format. +The Parallels Packer builder is able to create [Parallels Desktop for Mac](http://www.parallels.com/products/desktop/) virtual machines and export them in the PVM format. Packer actually comes with multiple builders able to create Parallels machines, depending on the strategy you want to use to build the image. diff --git a/website/source/docs/builders/qemu.html.markdown b/website/source/docs/builders/qemu.html.markdown index 1c5ae283a..8cab844cc 100644 --- a/website/source/docs/builders/qemu.html.markdown +++ b/website/source/docs/builders/qemu.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "QEMU Builder" +description: |- + The Qemu Packer builder is able to create KVM and Xen virtual machine images. Support for Xen is experimental at this time. --- # QEMU Builder Type: `qemu` -The Qemu builder is able to create [KVM](http://www.linux-kvm.org) +The Qemu Packer builder is able to create [KVM](http://www.linux-kvm.org) and [Xen](http://www.xenproject.org) virtual machine images. Support for Xen is experimental at this time. diff --git a/website/source/docs/builders/virtualbox-iso.html.markdown b/website/source/docs/builders/virtualbox-iso.html.markdown index 3bee4b803..f8a45d352 100644 --- a/website/source/docs/builders/virtualbox-iso.html.markdown +++ b/website/source/docs/builders/virtualbox-iso.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "VirtualBox Builder (from an ISO)" +description: |- + The VirtualBox Packer builder is able to create VirtualBox virtual machines and export them in the OVF format, starting from an ISO image. --- # VirtualBox Builder (from an ISO) Type: `virtualbox-iso` -The VirtualBox builder is able to create [VirtualBox](https://www.virtualbox.org/) +The VirtualBox Packer builder is able to create [VirtualBox](https://www.virtualbox.org/) virtual machines and export them in the OVF format, starting from an ISO image. diff --git a/website/source/docs/builders/virtualbox-ovf.html.markdown b/website/source/docs/builders/virtualbox-ovf.html.markdown index 66598eda1..2dc9edca7 100644 --- a/website/source/docs/builders/virtualbox-ovf.html.markdown +++ b/website/source/docs/builders/virtualbox-ovf.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "VirtualBox Builder (from an OVF/OVA)" +description: |- + This VirtualBox Packer builder is able to create VirtualBox virtual machines and export them in the OVF format, starting from an existing OVF/OVA (exported virtual machine image). --- # VirtualBox Builder (from an OVF/OVA) Type: `virtualbox-ovf` -This VirtualBox builder is able to create [VirtualBox](https://www.virtualbox.org/) +This VirtualBox Packer builder is able to create [VirtualBox](https://www.virtualbox.org/) virtual machines and export them in the OVF format, starting from an existing OVF/OVA (exported virtual machine image). diff --git a/website/source/docs/builders/virtualbox.html.markdown b/website/source/docs/builders/virtualbox.html.markdown index 4a81c67f3..26e94b5b8 100644 --- a/website/source/docs/builders/virtualbox.html.markdown +++ b/website/source/docs/builders/virtualbox.html.markdown @@ -1,11 +1,13 @@ --- layout: "docs" page_title: "VirtualBox Builder" +description: |- + The VirtualBox Packer builder is able to create VirtualBox virtual machines and export them in the OVA or OVF format. --- # VirtualBox Builder -The VirtualBox builder is able to create [VirtualBox](http://www.virtualbox.org) +The VirtualBox Packer builder is able to create [VirtualBox](http://www.virtualbox.org) virtual machines and export them in the OVA or OVF format. Packer actually comes with multiple builders able to create VirtualBox diff --git a/website/source/docs/builders/vmware-iso.html.markdown b/website/source/docs/builders/vmware-iso.html.markdown index 1f2e83b70..6029ff052 100644 --- a/website/source/docs/builders/vmware-iso.html.markdown +++ b/website/source/docs/builders/vmware-iso.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "VMware Builder from ISO" +description: |- + This VMware Packer builder is able to create VMware virtual machines from an ISO file as a source. It currently supports building virtual machines on hosts running VMware Fusion for OS X, VMware Workstation for Linux and Windows, and VMware Player on Linux. It can also build machines directly on VMware vSphere Hypervisor using SSH as opposed to the vSphere API. --- # VMware Builder (from ISO) Type: `vmware-iso` -This VMware builder is able to create VMware virtual machines from an +This VMware Packer builder is able to create VMware virtual machines from an ISO file as a source. It currently supports building virtual machines on hosts running [VMware Fusion](http://www.vmware.com/products/fusion/overview.html) for OS X, diff --git a/website/source/docs/builders/vmware-vmx.html.markdown b/website/source/docs/builders/vmware-vmx.html.markdown index 06821fbc9..5cf752459 100644 --- a/website/source/docs/builders/vmware-vmx.html.markdown +++ b/website/source/docs/builders/vmware-vmx.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "VMware Builder from VMX" +description: |- + This VMware Packer builder is able to create VMware virtual machines from an existing VMware virtual machine (a VMX file). It currently supports building virtual machines on hosts running VMware Fusion Professional for OS X, VMware Workstation for Linux and Windows, and VMware Player on Linux. --- # VMware Builder (from VMX) Type: `vmware-vmx` -This VMware builder is able to create VMware virtual machines from an +This VMware Packer builder is able to create VMware virtual machines from an existing VMware virtual machine (a VMX file). It currently supports building virtual machines on hosts running [VMware Fusion Professional](http://www.vmware.com/products/fusion-professional/) for OS X, diff --git a/website/source/docs/builders/vmware.html.markdown b/website/source/docs/builders/vmware.html.markdown index c25172efc..84d94a369 100644 --- a/website/source/docs/builders/vmware.html.markdown +++ b/website/source/docs/builders/vmware.html.markdown @@ -1,11 +1,13 @@ --- layout: "docs" page_title: "VMware Builder" +description: |- + The VMware Packer builder is able to create VMware virtual machines for use with any VMware product. --- # VMware Builder -The VMware builder is able to create VMware virtual machines for use +The VMware Packer builder is able to create VMware virtual machines for use with any VMware product. Packer actually comes with multiple builders able to create VMware diff --git a/website/source/docs/command-line/build.html.markdown b/website/source/docs/command-line/build.html.markdown index d1b9bf2e8..bada564a1 100644 --- a/website/source/docs/command-line/build.html.markdown +++ b/website/source/docs/command-line/build.html.markdown @@ -1,11 +1,13 @@ --- layout: "docs" page_title: "Build - Command-Line" +description: |- + The `packer build` Packer command takes a template and runs all the builds within it in order to generate a set of artifacts. The various builds specified within a template are executed in parallel, unless otherwise specified. And the artifacts that are created will be outputted at the end of the build. --- # Command-Line: Build -The `packer build` command takes a template and runs all the builds within +The `packer build` Packer command takes a template and runs all the builds within it in order to generate a set of artifacts. The various builds specified within a template are executed in parallel, unless otherwise specified. And the artifacts that are created will be outputted at the end of the build. diff --git a/website/source/docs/command-line/fix.html.markdown b/website/source/docs/command-line/fix.html.markdown index 4657a1807..958ebd0f8 100644 --- a/website/source/docs/command-line/fix.html.markdown +++ b/website/source/docs/command-line/fix.html.markdown @@ -1,11 +1,13 @@ --- layout: "docs" page_title: "Fix - Command-Line" +description: |- + The `packer fix` Packer command takes a template and finds backwards incompatible parts of it and brings it up to date so it can be used with the latest version of Packer. After you update to a new Packer release, you should run the fix command to make sure your templates work with the new release. --- # Command-Line: Fix -The `packer fix` command takes a template and finds backwards incompatible +The `packer fix` Packer command takes a template and finds backwards incompatible parts of it and brings it up to date so it can be used with the latest version of Packer. After you update to a new Packer release, you should run the fix command to make sure your templates work with the new release. diff --git a/website/source/docs/command-line/inspect.html.markdown b/website/source/docs/command-line/inspect.html.markdown index 676fae023..09f979208 100644 --- a/website/source/docs/command-line/inspect.html.markdown +++ b/website/source/docs/command-line/inspect.html.markdown @@ -1,11 +1,13 @@ --- layout: "docs" page_title: "Inspect - Command-Line" +description: |- + The `packer inspect` Packer command takes a template and outputs the various components a template defines. This can help you quickly learn about a template without having to dive into the JSON itself. The command will tell you things like what variables a template accepts, the builders it defines, the provisioners it defines and the order they'll run, and more. --- # Command-Line: Inspect -The `packer inspect` command takes a template and outputs the various components +The `packer inspect` Packer command takes a template and outputs the various components a template defines. This can help you quickly learn about a template without having to dive into the JSON itself. The command will tell you things like what variables a template accepts, diff --git a/website/source/docs/command-line/introduction.html.markdown b/website/source/docs/command-line/introduction.html.markdown index f28755e7e..0a97e0056 100644 --- a/website/source/docs/command-line/introduction.html.markdown +++ b/website/source/docs/command-line/introduction.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Packer Command-Line" +description: |- + Packer is controlled using a command-line interface. All interaction with Packer is done via the `packer` tool. Like many other command-line tools, the `packer` tool takes a subcommand to execute, and that subcommand may have additional options as well. Subcommands are executed with `packer SUBCOMMAND`, where "SUBCOMMAND" is obviously the actual command you wish to execute. --- # Packer Command-Line diff --git a/website/source/docs/command-line/machine-readable.html.markdown b/website/source/docs/command-line/machine-readable.html.markdown index c33bf1cc2..5fed33310 100644 --- a/website/source/docs/command-line/machine-readable.html.markdown +++ b/website/source/docs/command-line/machine-readable.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Machine-Readable Output - Command-Line" +description: |- + By default, the output of Packer is very human-readable. It uses nice formatting, spacing, and colors in order to make Packer a pleasure to use. However, Packer was built with automation in mind. To that end, Packer supports a fully machine-readable output setting, allowing you to use Packer in automated environments. --- # Machine-Readable Output diff --git a/website/source/docs/command-line/validate.html.markdown b/website/source/docs/command-line/validate.html.markdown index 40479ae2e..530f00295 100644 --- a/website/source/docs/command-line/validate.html.markdown +++ b/website/source/docs/command-line/validate.html.markdown @@ -1,11 +1,13 @@ --- layout: "docs" page_title: "Validate - Command-Line" +description: |- + The `packer validate` Packer command is used to validate the syntax and configuration of a template. The command will return a zero exit status on success, and a non-zero exit status on failure. Additionally, if a template doesn't validate, any error messages will be outputted. --- # Command-Line: Validate -The `packer validate` command is used to validate the syntax and configuration +The `packer validate` Packer command is used to validate the syntax and configuration of a [template](/docs/templates/introduction.html). The command will return a zero exit status on success, and a non-zero exit status on failure. Additionally, if a template doesn't validate, any error messages will be outputted. diff --git a/website/source/docs/extend/builder.html.markdown b/website/source/docs/extend/builder.html.markdown index 93ed9b5b2..a841d5c3d 100644 --- a/website/source/docs/extend/builder.html.markdown +++ b/website/source/docs/extend/builder.html.markdown @@ -1,11 +1,13 @@ --- layout: "docs" page_title: "Custom Builder - Extend Packer" +description: |- + Packer Builders are the components of Packer responsible for creating a machine, bringing it to a point where it can be provisioned, and then turning that provisioned machine into some sort of machine image. Several builders are officially distributed with Packer itself, such as the AMI builder, the VMware builder, etc. However, it is possible to write custom builders using the Packer plugin interface, and this page documents how to do that. --- # Custom Builder Development -Builders are the components of Packer responsible for creating a machine, +Packer Builders are the components of Packer responsible for creating a machine, bringing it to a point where it can be provisioned, and then turning that provisioned machine into some sort of machine image. Several builders are officially distributed with Packer itself, such as the AMI builder, the diff --git a/website/source/docs/extend/command.html.markdown b/website/source/docs/extend/command.html.markdown index 8f6e5414d..d36a9087d 100644 --- a/website/source/docs/extend/command.html.markdown +++ b/website/source/docs/extend/command.html.markdown @@ -1,11 +1,13 @@ --- layout: "docs" page_title: "Custom Command Development" +description: |- + Packer Commands are the components of Packer that add functionality to the `packer` application. Packer comes with a set of commands out of the box, such as `build`. Commands are invoked as `packer `. Custom commands allow you to add new commands to Packer to perhaps perform new functionality. --- # Custom Command Development -Commands are the components of Packer that add functionality to the +Packer Commands are the components of Packer that add functionality to the `packer` application. Packer comes with a set of commands out of the box, such as `build`. Commands are invoked as `packer `. Custom commands allow you to add new commands to Packer to perhaps diff --git a/website/source/docs/extend/developing-plugins.html.markdown b/website/source/docs/extend/developing-plugins.html.markdown index 6f73030a9..d67470930 100644 --- a/website/source/docs/extend/developing-plugins.html.markdown +++ b/website/source/docs/extend/developing-plugins.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Developing Plugins" +description: |- + This page will document how you can develop your own Packer plugins. Prior to reading this, it is assumed that you're comfortable with Packer and also know the basics of how Plugins work, from a user standpoint. --- # Developing Plugins diff --git a/website/source/docs/extend/plugins.html.markdown b/website/source/docs/extend/plugins.html.markdown index dbef6c5d9..12db22150 100644 --- a/website/source/docs/extend/plugins.html.markdown +++ b/website/source/docs/extend/plugins.html.markdown @@ -1,11 +1,13 @@ --- layout: "docs" page_title: "Packer Plugins - Extend Packer" +description: |- + Packer Plugins allow new functionality to be added to Packer without modifying the core source code. Packer plugins are able to add new commands, builders, provisioners, hooks, and more. In fact, much of Packer itself is implemented by writing plugins that are simply distributed with Packer. For example, all the commands, builders, provisioners, and more that ship with Packer are implemented as Plugins that are simply hardcoded to load with Packer. --- # Packer Plugins -Plugins allow new functionality to be added to Packer without +Packer Plugins allow new functionality to be added to Packer without modifying the core source code. Packer plugins are able to add new commands, builders, provisioners, hooks, and more. In fact, much of Packer itself is implemented by writing plugins that are simply distributed with diff --git a/website/source/docs/extend/post-processor.html.markdown b/website/source/docs/extend/post-processor.html.markdown index 1d14b7485..204cc593b 100644 --- a/website/source/docs/extend/post-processor.html.markdown +++ b/website/source/docs/extend/post-processor.html.markdown @@ -1,11 +1,13 @@ --- layout: "docs" page_title: "Custom Post-Processor Development" +description: |- + Packer Post-processors are the components of Packer that transform one artifact into another, for example by compressing files, or uploading them. --- # Custom Post-Processor Development -Post-processors are the components of Packer that transform one artifact +Packer Post-processors are the components of Packer that transform one artifact into another, for example by compressing files, or uploading them. In the compression example, the transformation would be taking an artifact diff --git a/website/source/docs/extend/provisioner.html.markdown b/website/source/docs/extend/provisioner.html.markdown index 9d63e562a..cb73cccd2 100644 --- a/website/source/docs/extend/provisioner.html.markdown +++ b/website/source/docs/extend/provisioner.html.markdown @@ -1,11 +1,13 @@ --- layout: "docs" page_title: "Custom Provisioner Development" +description: |- + Packer Provisioners are the components of Packer that install and configure software into a running machine prior to turning that machine into an image. An example of a provisioner is the shell provisioner, which runs shell scripts within the machines. --- # Custom Provisioner Development -Provisioners are the components of Packer that install and configure +Packer Provisioners are the components of Packer that install and configure software into a running machine prior to turning that machine into an image. An example of a provisioner is the [shell provisioner](/docs/provisioners/shell.html), which runs shell scripts within the machines. diff --git a/website/source/docs/index.html.markdown b/website/source/docs/index.html.markdown index 738030663..5894d17db 100644 --- a/website/source/docs/index.html.markdown +++ b/website/source/docs/index.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Packer Documentation" +description: |- + Welcome to the Packer documentation! This documentation is more of a reference guide for all available features and options in Packer. If you're just getting started with Packer, please start with the introduction and getting started guide instead. --- # Packer Documentation diff --git a/website/source/docs/installation.html.markdown b/website/source/docs/installation.html.markdown index fd09d3197..c0aee9528 100644 --- a/website/source/docs/installation.html.markdown +++ b/website/source/docs/installation.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Install Packer" +description: |- + Packer must first be installed on the machine you want to run it on. To make installation easy, Packer is distributed as a binary package for all supported platforms and architectures. This page will not cover how to compile Packer from source, as that is covered in the README and is only recommended for advanced users. --- # Install Packer diff --git a/website/source/docs/machine-readable/command-build.html.markdown b/website/source/docs/machine-readable/command-build.html.markdown index aac2713f9..836a61ef2 100644 --- a/website/source/docs/machine-readable/command-build.html.markdown +++ b/website/source/docs/machine-readable/command-build.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs_machine_readable" page_title: "Command: build - Machine-Readable Reference" +description: |- + These are the machine-readable types that exist as part of the output of `packer build`. --- # Build Command Types diff --git a/website/source/docs/machine-readable/command-inspect.html.markdown b/website/source/docs/machine-readable/command-inspect.html.markdown index 3d24c884d..3f8bbb852 100644 --- a/website/source/docs/machine-readable/command-inspect.html.markdown +++ b/website/source/docs/machine-readable/command-inspect.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs_machine_readable" page_title: "Command: inspect - Machine-Readable Reference" +description: |- + These are the machine-readable types that exist as part of the output of `packer inspect`. --- # Inspect Command Types diff --git a/website/source/docs/machine-readable/command-version.html.markdown b/website/source/docs/machine-readable/command-version.html.markdown index a84a49762..a7029b627 100644 --- a/website/source/docs/machine-readable/command-version.html.markdown +++ b/website/source/docs/machine-readable/command-version.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs_machine_readable" page_title: "Command: version - Machine-Readable Reference" +description: |- + These are the machine-readable types that exist as part of the output of `packer version`. --- # Version Command Types diff --git a/website/source/docs/machine-readable/general.html.markdown b/website/source/docs/machine-readable/general.html.markdown index 8f604e56e..05eb2699a 100644 --- a/website/source/docs/machine-readable/general.html.markdown +++ b/website/source/docs/machine-readable/general.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs_machine_readable" page_title: "General Types - Machine-Readable Reference" +description: |- + These are the machine-readable types that can appear in almost any machine-readable output and are provided by Packer core itself. --- # General Types diff --git a/website/source/docs/machine-readable/index.html.markdown b/website/source/docs/machine-readable/index.html.markdown index f0ac3e112..d26106b15 100644 --- a/website/source/docs/machine-readable/index.html.markdown +++ b/website/source/docs/machine-readable/index.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs_machine_readable" page_title: "Machine-Readable Reference" +description: |- + This is the reference for the various message categories for Packer machine-readable output. Please read that page if you're unfamiliar with the general format and usage for the machine-readable output. --- # Machine-Readable Reference diff --git a/website/source/docs/other/core-configuration.html.markdown b/website/source/docs/other/core-configuration.html.markdown index ea7d7f6d6..3727af061 100644 --- a/website/source/docs/other/core-configuration.html.markdown +++ b/website/source/docs/other/core-configuration.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Core Configuration" +description: |- + There are a few configuration settings that affect Packer globally by configuring the core of Packer. These settings all have reasonable defaults, so you generally don't have to worry about it until you want to tweak a configuration. If you're just getting started with Packer, don't worry about core configuration for now. --- # Core Configuration diff --git a/website/source/docs/other/debugging.html.markdown b/website/source/docs/other/debugging.html.markdown index ab82cf3b6..714a87264 100644 --- a/website/source/docs/other/debugging.html.markdown +++ b/website/source/docs/other/debugging.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Debugging Packer" +description: |- + Packer strives to be stable and bug-free, but issues inevitably arise where certain things may not work entirely correctly, or may not appear to work correctly. In these cases, it is sometimes helpful to see more details about what Packer is actually doing. --- # Debugging Packer diff --git a/website/source/docs/other/environmental-variables.html.markdown b/website/source/docs/other/environmental-variables.html.markdown index 8b2b8956e..318e25e25 100644 --- a/website/source/docs/other/environmental-variables.html.markdown +++ b/website/source/docs/other/environmental-variables.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Environmental Variables for Packer" +description: |- + Packer uses a variety of environmental variables. --- # Environmental Variables for Packer diff --git a/website/source/docs/post-processors/compress.html.markdown b/website/source/docs/post-processors/compress.html.markdown index 56df31700..ea3b9c7ac 100644 --- a/website/source/docs/post-processors/compress.html.markdown +++ b/website/source/docs/post-processors/compress.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "compress Post-Processor" +description: |- + The Packer compress post-processor takes an artifact with files (such as from VMware or VirtualBox) and gzip compresses the artifact into a single archive. --- # Compress Post-Processor Type: `compress` -The compress post-processor takes an artifact with files (such as from +The Packer compress post-processor takes an artifact with files (such as from VMware or VirtualBox) and gzip compresses the artifact into a single archive. diff --git a/website/source/docs/post-processors/docker-import.html.markdown b/website/source/docs/post-processors/docker-import.html.markdown index 23f29e243..c2d7bba80 100644 --- a/website/source/docs/post-processors/docker-import.html.markdown +++ b/website/source/docs/post-processors/docker-import.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "docker-import Post-Processor" +description: |- + The Packer Docker import post-processor takes an artifact from the docker builder and imports it with Docker locally. This allows you to apply a repository and tag to the image and lets you use the other Docker post-processors such as docker-push to push the image to a registry. --- # Docker Import Post-Processor Type: `docker-import` -The Docker import post-processor takes an artifact from the +The Packer Docker import post-processor takes an artifact from the [docker builder](/docs/builders/docker.html) and imports it with Docker locally. This allows you to apply a repository and tag to the image and lets you use the other Docker post-processors such as diff --git a/website/source/docs/post-processors/docker-push.html.markdown b/website/source/docs/post-processors/docker-push.html.markdown index 92d233f58..2f7ae3e92 100644 --- a/website/source/docs/post-processors/docker-push.html.markdown +++ b/website/source/docs/post-processors/docker-push.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Docker Push Post-Processor" +description: |- + The Packer Docker push post-processor takes an artifact from the docker-import post-processor and pushes it to a Docker registry. --- # Docker Push Post-Processor Type: `docker-push` -The Docker push post-processor takes an artifact from the +The Packer Docker push post-processor takes an artifact from the [docker-import](/docs/post-processors/docker-import.html) post-processor and pushes it to a Docker registry. diff --git a/website/source/docs/post-processors/docker-save.html.markdown b/website/source/docs/post-processors/docker-save.html.markdown index 3c4f87634..ca03dfcf6 100644 --- a/website/source/docs/post-processors/docker-save.html.markdown +++ b/website/source/docs/post-processors/docker-save.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "docker-save Post-Processor" +description: |- + The Packer Docker Save post-processor takes an artifact from the docker builder that was committed and saves it to a file. This is similar to exporting the Docker image directly from the builder, except that it preserves the hierarchy of images and metadata. --- # Docker Save Post-Processor Type: `docker-save` -The Docker Save post-processor takes an artifact from the +The Packer Docker Save post-processor takes an artifact from the [docker builder](/docs/builders/docker.html) that was committed and saves it to a file. This is similar to exporting the Docker image directly from the builder, except that it preserves the hierarchy of diff --git a/website/source/docs/post-processors/docker-tag.html.markdown b/website/source/docs/post-processors/docker-tag.html.markdown index a66d95717..7b8b92722 100644 --- a/website/source/docs/post-processors/docker-tag.html.markdown +++ b/website/source/docs/post-processors/docker-tag.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "docker-tag Post-Processor" +description: |- + The Packer Docker Tag post-processor takes an artifact from the docker builder that was committed and tags it into a repository. This allows you to use the other Docker post-processors such as docker-push to push the image to a registry. --- # Docker Tag Post-Processor Type: `docker-tag` -The Docker Tag post-processor takes an artifact from the +The Packer Docker Tag post-processor takes an artifact from the [docker builder](/docs/builders/docker.html) that was committed and tags it into a repository. This allows you to use the other Docker post-processors such as diff --git a/website/source/docs/post-processors/vagrant-cloud.html.markdown b/website/source/docs/post-processors/vagrant-cloud.html.markdown index 83b7c8e0a..8a668f5d0 100644 --- a/website/source/docs/post-processors/vagrant-cloud.html.markdown +++ b/website/source/docs/post-processors/vagrant-cloud.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Vagrant Cloud Post-Processor" +description: |- + The Packer Vagrant Cloud post-processor receives a Vagrant box from the `vagrant` post-processor and pushes it to Vagrant Cloud. Vagrant Cloud hosts and serves boxes to Vagrant, allowing you to version and distribute boxes to an organization in a simple way. --- # Vagrant Cloud Post-Processor Type: `vagrant-cloud` -The Vagrant Cloud post-processor receives a Vagrant box from the `vagrant` +The Packer Vagrant Cloud post-processor receives a Vagrant box from the `vagrant` post-processor and pushes it to Vagrant Cloud. [Vagrant Cloud](https://vagrantcloud.com) hosts and serves boxes to Vagrant, allowing you to version and distribute boxes to an organization in a simple way. diff --git a/website/source/docs/post-processors/vagrant.html.markdown b/website/source/docs/post-processors/vagrant.html.markdown index 5a26d0352..ab4ca2f86 100644 --- a/website/source/docs/post-processors/vagrant.html.markdown +++ b/website/source/docs/post-processors/vagrant.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Vagrant Post-Processor" +description: |- + The Packer Vagrant post-processor takes a build and converts the artifact into a valid Vagrant box, if it can. This lets you use Packer to automatically create arbitrarily complex Vagrant boxes, and is in fact how the official boxes distributed by Vagrant are created. --- # Vagrant Post-Processor Type: `vagrant` -The Vagrant post-processor takes a build and converts the artifact +The Packer Vagrant post-processor takes a build and converts the artifact into a valid [Vagrant](http://www.vagrantup.com) box, if it can. This lets you use Packer to automatically create arbitrarily complex Vagrant boxes, and is in fact how the official boxes distributed by diff --git a/website/source/docs/post-processors/vsphere.html.markdown b/website/source/docs/post-processors/vsphere.html.markdown index 408d8b327..3ce8ec5f9 100644 --- a/website/source/docs/post-processors/vsphere.html.markdown +++ b/website/source/docs/post-processors/vsphere.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "vSphere Post-Processor" +description: |- + The Packer vSphere post-processor takes an artifact from the VMware builder and uploads it to a vSphere endpoint. --- # vSphere Post-Processor Type: `vsphere` -The vSphere post-processor takes an artifact from the VMware builder +The Packer vSphere post-processor takes an artifact from the VMware builder and uploads it to a vSphere endpoint. ## Configuration diff --git a/website/source/docs/provisioners/ansible-local.html.markdown b/website/source/docs/provisioners/ansible-local.html.markdown index 70a45755b..63b98ade4 100644 --- a/website/source/docs/provisioners/ansible-local.html.markdown +++ b/website/source/docs/provisioners/ansible-local.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Ansible (Local) Provisioner" +description: |- + The `ansible-local` Packer provisioner configures Ansible to run on the machine by Packer from local Playbook and Role files. Playbooks and Roles can be uploaded from your local machine to the remote machine. Ansible is run in local mode via the `ansible-playbook` command. --- # Ansible Local Provisioner Type: `ansible-local` -The `ansible-local` provisioner configures Ansible to run on the machine by +The `ansible-local` Packer provisioner configures Ansible to run on the machine by Packer from local Playbook and Role files. Playbooks and Roles can be uploaded from your local machine to the remote machine. Ansible is run in [local mode](http://docs.ansible.com/playbooks_delegation.html#local-playbooks) via the `ansible-playbook` command. diff --git a/website/source/docs/provisioners/chef-client.html.markdown b/website/source/docs/provisioners/chef-client.html.markdown index c54223997..a3403e48e 100644 --- a/website/source/docs/provisioners/chef-client.html.markdown +++ b/website/source/docs/provisioners/chef-client.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Chef-Client Provisioner" +description: |- + The Chef Client Packer provisioner installs and configures software on machines built by Packer using chef-client. Packer configures a Chef client to talk to a remote Chef Server to provision the machine. --- # Chef Client Provisioner Type: `chef-client` -The Chef Client provisioner installs and configures software on machines built +The Chef Client Packer provisioner installs and configures software on machines built by Packer using [chef-client](http://docs.opscode.com/chef_client.html). Packer configures a Chef client to talk to a remote Chef Server to provision the machine. diff --git a/website/source/docs/provisioners/chef-solo.html.markdown b/website/source/docs/provisioners/chef-solo.html.markdown index a69a7d810..b60096307 100644 --- a/website/source/docs/provisioners/chef-solo.html.markdown +++ b/website/source/docs/provisioners/chef-solo.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Chef-Solo Provisioner" +description: |- + The Chef solo Packer provisioner installs and configures software on machines built by Packer using chef-solo. Cookbooks can be uploaded from your local machine to the remote machine or remote paths can be used. --- # Chef Solo Provisioner Type: `chef-solo` -The Chef solo provisioner installs and configures software on machines built +The Chef solo Packer provisioner installs and configures software on machines built by Packer using [chef-solo](http://docs.opscode.com/chef_solo.html). Cookbooks can be uploaded from your local machine to the remote machine or remote paths can be used. diff --git a/website/source/docs/provisioners/custom.html.markdown b/website/source/docs/provisioners/custom.html.markdown index c2dd3a527..08df184fd 100644 --- a/website/source/docs/provisioners/custom.html.markdown +++ b/website/source/docs/provisioners/custom.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Custom Provisioner" +description: |- + Packer is extensible, allowing you to write new provisioners without having to modify the core source code of Packer itself. Documentation for creating new provisioners is covered in the custom provisioners page of the Packer plugin section. --- # Custom Provisioner diff --git a/website/source/docs/provisioners/file.html.markdown b/website/source/docs/provisioners/file.html.markdown index fda01efc2..a8d0daf56 100644 --- a/website/source/docs/provisioners/file.html.markdown +++ b/website/source/docs/provisioners/file.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "File Provisioner" +description: |- + The file Packer provisioner uploads files to machines built by Packer. The recommended usage of the file provisioner is to use it to upload files, and then use shell provisioner to move them to the proper place, set permissions, etc. --- # File Provisioner Type: `file` -The file provisioner uploads files to machines built by Packer. The +The file Packer provisioner uploads files to machines built by Packer. The recommended usage of the file provisioner is to use it to upload files, and then use [shell provisioner](/docs/provisioners/shell.html) to move them to the proper place, set permissions, etc. diff --git a/website/source/docs/provisioners/puppet-masterless.html.markdown b/website/source/docs/provisioners/puppet-masterless.html.markdown index 5864428a0..b3574cac6 100644 --- a/website/source/docs/provisioners/puppet-masterless.html.markdown +++ b/website/source/docs/provisioners/puppet-masterless.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Puppet (Masterless) Provisioner" +description: |- + The masterless Puppet Packer provisioner configures Puppet to run on the machines by Packer from local modules and manifest files. Modules and manifests can be uploaded from your local machine to the remote machine or can simply use remote paths (perhaps obtained using something like the shell provisioner). Puppet is run in masterless mode, meaning it never communicates to a Puppet master. --- # Puppet (Masterless) Provisioner Type: `puppet-masterless` -The masterless Puppet provisioner configures Puppet to run on the machines +The masterless Puppet Packer provisioner configures Puppet to run on the machines by Packer from local modules and manifest files. Modules and manifests can be uploaded from your local machine to the remote machine or can simply use remote paths (perhaps obtained using something like the shell provisioner). diff --git a/website/source/docs/provisioners/puppet-server.html.markdown b/website/source/docs/provisioners/puppet-server.html.markdown index c1847db23..f60e88f50 100644 --- a/website/source/docs/provisioners/puppet-server.html.markdown +++ b/website/source/docs/provisioners/puppet-server.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Puppet Server Provisioner" +description: |- + The `puppet-server` Packer provisioner provisions Packer machines with Puppet by connecting to a Puppet master. --- # Puppet Server Provisioner Type: `puppet-server` -The `puppet-server` provisioner provisions Packer machines with Puppet +The `puppet-server` Packer provisioner provisions Packer machines with Puppet by connecting to a Puppet master. -> **Note:** Puppet will _not_ be installed automatically diff --git a/website/source/docs/provisioners/salt-masterless.html.markdown b/website/source/docs/provisioners/salt-masterless.html.markdown index c398c26ff..a298bb28d 100644 --- a/website/source/docs/provisioners/salt-masterless.html.markdown +++ b/website/source/docs/provisioners/salt-masterless.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Salt (Masterless) Provisioner" +description: |- + The `salt-masterless` Packer provisioner provisions machines built by Packer using Salt states, without connecting to a Salt master. --- # Salt Masterless Provisioner Type: `salt-masterless` -The `salt-masterless` provisioner provisions machines built by Packer using +The `salt-masterless` Packer provisioner provisions machines built by Packer using [Salt](http://saltstack.com/) states, without connecting to a Salt master. ## Basic Example diff --git a/website/source/docs/provisioners/shell.html.markdown b/website/source/docs/provisioners/shell.html.markdown index b5dae4b5d..ffed1e442 100644 --- a/website/source/docs/provisioners/shell.html.markdown +++ b/website/source/docs/provisioners/shell.html.markdown @@ -1,13 +1,15 @@ --- layout: "docs" page_title: "Shell Provisioner" +description: |- + The shell Packer provisioner provisions machines built by Packer using shell scripts. Shell provisioning is the easiest way to get software installed and configured on a machine. --- # Shell Provisioner Type: `shell` -The shell provisioner provisions machines built by Packer using shell scripts. +The shell Packer provisioner provisions machines built by Packer using shell scripts. Shell provisioning is the easiest way to get software installed and configured on a machine. diff --git a/website/source/docs/templates/builders.html.markdown b/website/source/docs/templates/builders.html.markdown index de99a9eca..0226d30d5 100644 --- a/website/source/docs/templates/builders.html.markdown +++ b/website/source/docs/templates/builders.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Templates: Builders" +description: |- + Within the template, the builders section contains an array of all the builders that Packer should use to generate a machine images for the template. --- # Templates: Builders diff --git a/website/source/docs/templates/configuration-templates.html.markdown b/website/source/docs/templates/configuration-templates.html.markdown index cd086af29..bf6b31e36 100644 --- a/website/source/docs/templates/configuration-templates.html.markdown +++ b/website/source/docs/templates/configuration-templates.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Configuration Templates" +description: |- + All strings within templates are processed by a common Packer templating engine, where variables and functions can be used to modify the value of a configuration parameter at runtime. --- # Configuration Templates diff --git a/website/source/docs/templates/introduction.html.markdown b/website/source/docs/templates/introduction.html.markdown index 26b618c7d..a8be4f592 100644 --- a/website/source/docs/templates/introduction.html.markdown +++ b/website/source/docs/templates/introduction.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Templates" +description: |- + Templates are JSON files that configure the various components of Packer in order to create one or more machine images. Templates are portable, static, and readable and writable by both humans and computers. This has the added benefit of being able to not only create and modify templates by hand, but also write scripts to dynamically create or modify templates. --- # Templates diff --git a/website/source/docs/templates/post-processors.html.markdown b/website/source/docs/templates/post-processors.html.markdown index 8a8adec89..7a7ba4664 100644 --- a/website/source/docs/templates/post-processors.html.markdown +++ b/website/source/docs/templates/post-processors.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Templates: Post-Processors" +description: |- + The post-processor section within a template configures any post-processing that will be done to images built by the builders. Examples of post-processing would be compressing files, uploading artifacts, etc. --- # Templates: Post-Processors diff --git a/website/source/docs/templates/provisioners.html.markdown b/website/source/docs/templates/provisioners.html.markdown index 7da902c54..00578bb86 100644 --- a/website/source/docs/templates/provisioners.html.markdown +++ b/website/source/docs/templates/provisioners.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Templates: Provisioners" +description: |- + Within the template, the provisioners section contains an array of all the provisioners that Packer should use to install and configure software within running machines prior to turning them into machine images. --- # Templates: Provisioners diff --git a/website/source/docs/templates/user-variables.html.markdown b/website/source/docs/templates/user-variables.html.markdown index e17d831d7..ae6ef3cd3 100644 --- a/website/source/docs/templates/user-variables.html.markdown +++ b/website/source/docs/templates/user-variables.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "User Variables in Templates" +description: |- + User variables allow your templates to be further configured with variables from the command-line, environmental variables, or files. This lets you parameterize your templates so that you can keep secret tokens, environment-specific data, and other types of information out of your templates. This maximizes the portablility and shareability of the template. --- # User Variables diff --git a/website/source/docs/templates/veewee-to-packer.html.markdown b/website/source/docs/templates/veewee-to-packer.html.markdown index 2899372ac..81a06de71 100644 --- a/website/source/docs/templates/veewee-to-packer.html.markdown +++ b/website/source/docs/templates/veewee-to-packer.html.markdown @@ -1,6 +1,8 @@ --- layout: "docs" page_title: "Convert Veewee Definitions to Packer Templates" +description: |- + If you are or were a user of Veewee, then there is an official tool called veewee-to-packer that will convert your Veewee definition into an equivalent Packer template. Even if you're not a Veewee user, Veewee has a large library of templates that can be readily used with Packer by simply converting them. --- # Veewee-to-Packer diff --git a/website/source/index.html.erb b/website/source/index.html.erb index 9138f24ad..6c6ddc5dd 100644 --- a/website/source/index.html.erb +++ b/website/source/index.html.erb @@ -1,3 +1,8 @@ +--- +description: |- + Packer is a free and open source tool for creating golden images for multiple platforms from a single source configuration. +--- +
diff --git a/website/source/intro/getting-started/build-image.html.markdown b/website/source/intro/getting-started/build-image.html.markdown index 70c13db6e..024447c78 100644 --- a/website/source/intro/getting-started/build-image.html.markdown +++ b/website/source/intro/getting-started/build-image.html.markdown @@ -4,6 +4,8 @@ page_title: "Build an Image" prev_url: "/intro/getting-started/setup.html" next_url: "/intro/getting-started/provision.html" next_title: "Provision" +description: |- + With Packer installed, let's just dive right into it and build our first image. Our first image will be an Amazon EC2 AMI with Redis pre-installed. This is just an example. Packer can create images for many platforms with anything pre-installed. --- # Build an Image diff --git a/website/source/intro/getting-started/next.html.markdown b/website/source/intro/getting-started/next.html.markdown index eee743fc9..11f5ea4f7 100644 --- a/website/source/intro/getting-started/next.html.markdown +++ b/website/source/intro/getting-started/next.html.markdown @@ -1,6 +1,8 @@ --- layout: "intro" page_title: "Next Steps" +description: |- + That concludes the getting started guide for Packer. You should now be comfortable with basic Packer usage, should understand templates, defining builds, provisioners, etc. At this point you're ready to begin playing with and using Packer in real scenarios. --- # Next Steps diff --git a/website/source/intro/getting-started/parallel-builds.html.markdown b/website/source/intro/getting-started/parallel-builds.html.markdown index 4145aa178..72ab4737c 100644 --- a/website/source/intro/getting-started/parallel-builds.html.markdown +++ b/website/source/intro/getting-started/parallel-builds.html.markdown @@ -4,6 +4,8 @@ page_title: "Parallel Builds" prev_url: "/intro/getting-started/provision.html" next_url: "/intro/getting-started/vagrant.html" next_title: "Vagrant Boxes" +description: |- + So far we've shown how Packer can automatically build an image and provision it. This on its own is already quite powerful. But Packer can do better than that. Packer can create multiple images for multiple platforms in parallel, all configured from a single template. --- # Parallel Builds diff --git a/website/source/intro/getting-started/provision.html.markdown b/website/source/intro/getting-started/provision.html.markdown index 29698775d..bedb63b69 100644 --- a/website/source/intro/getting-started/provision.html.markdown +++ b/website/source/intro/getting-started/provision.html.markdown @@ -4,6 +4,8 @@ page_title: "Provision" prev_url: "/intro/getting-started/build-image.html" next_url: "/intro/getting-started/parallel-builds.html" next_title: "Parallel Builds" +description: |- + In the previous page of this guide, you created your first image with Packer. The image you just built, however, was basically just a repackaging of a previously existing base AMI. The real utility of Packer comes from being able to install and configure software into the images as well. This stage is also known as the _provision_ step. Packer fully supports automated provisioning in order to install software onto the machines prior to turning them into images. --- # Provision diff --git a/website/source/intro/getting-started/setup.html.markdown b/website/source/intro/getting-started/setup.html.markdown index 1c98a74a0..60eed6df8 100644 --- a/website/source/intro/getting-started/setup.html.markdown +++ b/website/source/intro/getting-started/setup.html.markdown @@ -4,6 +4,8 @@ page_title: "Install Packer" prev_url: "/intro/platforms.html" next_url: "/intro/getting-started/build-image.html" next_title: "Build an Image" +description: |- + Packer must first be installed on the machine you want to run it on. To make installation easy, Packer is distributed as a binary package for all supported platforms and architectures. This page will not cover how to compile Packer from source, as that is covered in the README and is only recommended for advanced users. --- # Install Packer diff --git a/website/source/intro/getting-started/vagrant.html.markdown b/website/source/intro/getting-started/vagrant.html.markdown index c34d35ef9..7353c6f0b 100644 --- a/website/source/intro/getting-started/vagrant.html.markdown +++ b/website/source/intro/getting-started/vagrant.html.markdown @@ -4,6 +4,8 @@ page_title: "Vagrant Boxes" prev_url: "/intro/getting-started/parallel-builds.html" next_url: "/intro/getting-started/next.html" next_title: "Next Steps" +description: |- + Packer also has the ability to take the results of a builder (such as an AMI or plain VMware image) and turn it into a Vagrant box. --- # Vagrant Boxes diff --git a/website/source/intro/index.html.markdown b/website/source/intro/index.html.markdown index 381982f81..147cc51ee 100644 --- a/website/source/intro/index.html.markdown +++ b/website/source/intro/index.html.markdown @@ -4,6 +4,8 @@ page_title: "Introduction" prev_url: "#" next_url: "/intro/why.html" next_title: "Why Use Packer?" +description: |- + Welcome to the world of Packer! This introduction guide will show you what Packer is, explain why it exists, the benefits it has to offer, and how you can get started with it. If you're already familiar with Packer, the documentation provides more of a reference for all available features. --- # Introduction to Packer diff --git a/website/source/intro/platforms.html.markdown b/website/source/intro/platforms.html.markdown index 830093926..75fcf6721 100644 --- a/website/source/intro/platforms.html.markdown +++ b/website/source/intro/platforms.html.markdown @@ -4,6 +4,8 @@ page_title: "Supported Platforms" prev_url: "/intro/use-cases.html" next_url: "/intro/getting-started/setup.html" next_title: "Getting Started: Install Packer" +description: |- + Packer can create machine images for any platform. Packer ships with support for a set of platforms, but can be extended through plugins to support any platform. This page documents the list of supported image types that Packer supports creating. --- # Supported Platforms diff --git a/website/source/intro/use-cases.html.markdown b/website/source/intro/use-cases.html.markdown index 18e95c999..0b73ea32c 100644 --- a/website/source/intro/use-cases.html.markdown +++ b/website/source/intro/use-cases.html.markdown @@ -4,6 +4,8 @@ page_title: "Use Cases" prev_url: "/intro/why.html" next_url: "/intro/platforms.html" next_title: "Supported Platforms" +description: |- + By now you should know what Packer does and what the benefits of image creation are. In this section, we'll enumerate _some_ of the use cases for Packer. Note that this is not an exhaustive list by any means. There are definitely use cases for Packer not listed here. This list is just meant to give you an idea of how Packer may improve your processes. --- # Use Cases diff --git a/website/source/intro/why.html.markdown b/website/source/intro/why.html.markdown index cf999fb47..98de7855f 100644 --- a/website/source/intro/why.html.markdown +++ b/website/source/intro/why.html.markdown @@ -4,6 +4,8 @@ page_title: "Why Use Packer?" prev_url: "/intro/index.html" next_url: "/intro/use-cases.html" next_title: "Packer Use Cases" +description: |- + Pre-baked machine images have a lot of advantages, but most have been unable to benefit from them because images have been too tedious to create and manage. There were either no existing tools to automate the creation of machine images or they had too high of a learning curve. The result is that, prior to Packer, creating machine images threatened the agility of operations teams, and therefore aren't used, despite the massive benefits. --- # Why Use Packer? diff --git a/website/source/layouts/layout.erb b/website/source/layouts/layout.erb index 6125e165a..898de87c1 100644 --- a/website/source/layouts/layout.erb +++ b/website/source/layouts/layout.erb @@ -1,8 +1,8 @@ - <%= current_page.data.page_title ? "#{current_page.data.page_title} - " : "" %>Packer - + <%= [current_page.data.page_title, "Packer by HashiCorp"].compact.join(" - ") %> + <%= stylesheet_link_tag "application" %>