document builder id of artifact for each builder's output on website (#10580)

* document builder id of artifact for each builder's output on website

* document postprocessor artifact ids on website

* Fix links to new communicator page

Co-authored-by: Wilken Rivera <dev@wilkenrivera.com>
This commit is contained in:
Megan Marsh 2021-02-05 16:49:28 -08:00 committed by GitHub
parent 2324f433f7
commit 13320650f0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
73 changed files with 114 additions and 34 deletions

View File

@ -9,6 +9,7 @@ sidebar_title: Alicloud ECS
# Alicloud Image Builder
Type: `alicloud-ecs`
Artifact BuilderId: `alibaba.alicloud`
The `alicloud-ecs` Packer builder plugin provide the capability to build
customized images based on an existing base images.
@ -17,7 +18,7 @@ customized images based on an existing base images.
The following configuration options are available for building Alicloud images.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
### Required:

View File

@ -15,6 +15,7 @@ sidebar_title: chroot
# AMI Builder (chroot)
Type: `amazon-chroot`
Artifact BuilderId: `mitchellh.amazon.chroot`
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

View File

@ -11,6 +11,7 @@ sidebar_title: EBS
# AMI Builder (EBS backed)
Type: `amazon-ebs`
Artifact BuilderId: `mitchellh.amazonebs`
The `amazon-ebs` Packer builder is able to create Amazon AMIs backed by EBS
volumes for use in [EC2](https://aws.amazon.com/ec2/). For more information on

View File

@ -11,6 +11,7 @@ sidebar_title: EBS Surrogate
# EBS Surrogate Builder
Type: `amazon-ebssurrogate`
Artifact BuilderId: `mitchellh.amazon.ebssurrogate`
The `amazon-ebssurrogate` Packer builder is able to create Amazon AMIs by
running a source instance with an attached volume, provisioning the attached

View File

@ -9,6 +9,7 @@ sidebar_title: EBS Volume
# EBS Volume Builder
Type: `amazon-ebsvolume`
Artifact BuilderId: `mitchellh.amazon.ebsvolume`
The `amazon-ebsvolume` Packer builder is able to create Amazon Elastic Block
Store volumes which are prepopulated with filesystems or data.

View File

@ -15,6 +15,7 @@ sidebar_title: Instance
# AMI Builder (instance-store)
Type: `amazon-instance`
Artifact BuilderId: `mitchellh.amazon.instance`
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

View File

@ -7,6 +7,7 @@ sidebar_title: ARM
# Azure Resource Manager Builder
Type: `azure-arm`
Artifact BuilderId: `Azure.ResourceManagement.VMImage`
Packer supports building Virtual Hard Disks (VHDs) and Managed Images in [Azure Resource
Manager](https://azure.microsoft.com/en-us/documentation/articles/resource-group-overview/).
@ -25,7 +26,7 @@ CLI](https://azure.microsoft.com/en-us/documentation/articles/xplat-cli-install/
There are many configuration options available for the builder. We'll start
with authentication parameters, then go over the Azure ARM builder specific
options. In addition to the options listed here, a [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this builder.
options. In addition to the options listed here, a [communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this builder.
### Authentication options

View File

@ -11,6 +11,7 @@ sidebar_title: chroot
# Azure Builder (chroot)
Type: `azure-chroot`
Artifact BuilderId: `azure.chroot`
The `azure-chroot` builder is able to build Azure managed disk (MD) images. For
more information on managed disks, see [Azure Managed Disks Overview](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/managed-disks-overview).

View File

@ -11,6 +11,7 @@ sidebar_title: CloudStack
# CloudStack Builder
Type: `cloudstack`
Artifact BuilderId: `packer.cloudstack`
The `cloudstack` Packer builder is able to create new templates for use with
[CloudStack](https://cloudstack.apache.org/). The builder takes either an ISO
@ -27,7 +28,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
### Required:

View File

@ -17,6 +17,7 @@ sidebar_title: DigitalOcean
# DigitalOcean Builder
Type: `digitalocean`
Artifact BuilderId: `pearkes.digitalocean`
The `digitalocean` Packer builder is able to create new images for use with
[DigitalOcean](https://www.digitalocean.com). The builder takes a source image,
@ -36,7 +37,7 @@ each category, the available configuration keys are alphabetized.
### Communicator Config
In addition to the builder options, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this builder.
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this builder.
@include 'packer-plugin-sdk/communicator/Config-not-required.mdx'

View File

@ -13,6 +13,7 @@ sidebar_title: Docker
# Docker Builder
Type: `docker`
Artifact BuilderId: `packer.docker`
The `docker` Packer builder builds [Docker](https://www.docker.io) images using
Docker. The builder starts a Docker container, runs provisioners within this
@ -200,7 +201,7 @@ optional. Within each category, the available options are alphabetized and
described.
The Docker builder uses a special Docker communicator _and will not use_ the
standard [communicators](/docs/templates/legacy_json_templates/communicators).
standard [communicators](/docs/templates/legacy_json_templates/communicator).
### Required:

View File

@ -10,6 +10,7 @@ sidebar_title: File
# File Builder
Type: `file`
Artifact BuilderId: `packer.file`
The `file` Packer builder is not really a builder, it just creates an artifact
from a file. It can be used to debug post-processors without incurring high
@ -54,7 +55,7 @@ Configuration options are organized below into two categories: required and
optional. Within each category, the available options are alphabetized and
described.
Any [communicator](/docs/templates/legacy_json_templates/communicators) defined is ignored.
Any [communicator](/docs/templates/legacy_json_templates/communicator) defined is ignored.
### Required:

View File

@ -9,6 +9,7 @@ sidebar_title: Google Cloud
# Google Compute Builder
Type: `googlecompute`
Artifact BuilderId: `packer.googlecompute`
The `googlecompute` Packer builder is able to create
[images](https://developers.google.com/compute/docs/images) for use with
@ -342,7 +343,7 @@ optional. Within each category, the available options are alphabetized and
described.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
### Communicator Configuration

View File

@ -12,6 +12,7 @@ sidebar_title: Hetzner Cloud
# Hetzner Cloud Builder
Type: `hcloud`
Artifact BuilderId: `hcloud.builder`
The `hcloud` Packer builder is able to create new images for use with [Hetzner
Cloud](https://www.hetzner.cloud). The builder takes a source image, runs any
@ -29,7 +30,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
### Required Builder Configuration options:

View File

@ -10,6 +10,7 @@ sidebar_title: HyperOne
# HyperOne Builder
Type: `hyperone`
Artifact BuilderId: `hyperone.builder`
The `hyperone` Packer builder is able to create new images on the [HyperOne
platform](http://www.hyperone.com/). The builder takes a source image, runs
@ -86,7 +87,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
### Required:

View File

@ -11,6 +11,7 @@ sidebar_title: ISO
# Hyper-V Builder (from an ISO)
Type: `hyperv-iso`
Artifact BuilderId: `MSOpenTech.hyperv`
The Hyper-V Packer builder is able to create
[Hyper-V](https://www.microsoft.com/en-us/server-cloud/solutions/virtualization.aspx)
@ -65,7 +66,7 @@ are organized below into two categories: required and optional. Within each
category, the available options are alphabetized and described.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
### Optional:

View File

@ -11,6 +11,7 @@ sidebar_title: VMCX
# Hyper-V Builder (from a vmcx)
Type: `hyperv-vmcx`
Artifact BuilderId: `MSOpenTech.hyperv`
The Hyper-V Packer builder is able to use exported virtual machines or clone
existing
@ -66,7 +67,7 @@ are organized below into two categories: required and optional. Within each
category, the available options are alphabetized and described.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
## ISO Configuration Reference

View File

@ -9,6 +9,7 @@ sidebar_title: JDCloud
# JDCloud Image Builder
Type: `jdcloud`
Artifact BuilderId: `hashicorp.jdcloud`
The `jdcloud` Packer builder helps you to build instance images
based on an existing image

View File

@ -17,6 +17,7 @@ sidebar_title: Linode
# Linode Builder
Type: `linode`
Artifact BuilderId: `packer.linode`
The `linode` Packer builder is able to create [Linode
Images](https://www.linode.com/docs/platform/disk-images/linode-images/) for
@ -35,7 +36,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key:

View File

@ -10,6 +10,7 @@ sidebar_title: LXC
# LXC Builder
Type: `lxc`
Artifact BuilderId: `ustream.lxc`
The `lxc` Packer builder builds containers for lxc1. The builder starts an LXC
container, runs provisioners within this container, then exports the container

View File

@ -13,6 +13,7 @@ sidebar_title: LXD
# LXD Builder
Type: `lxd`
Artifact BuilderId: `lxd`
The `lxd` Packer builder builds containers for LXD. The builder starts an LXD
container, runs provisioners within this container, then saves the container as

View File

@ -8,6 +8,9 @@ sidebar_title: NAVER Cloud
# NAVER CLOUD PLATFORM Builder
Type: `ncloud`
Artifact BuilderId: `ncloud.server.image`
The `ncloud` builder allows you to create server images using the [NAVER Cloud
Platform](https://www.ncloud.com/).

View File

@ -55,4 +55,4 @@ build {
## Configuration Reference
The null builder has no configuration parameters other than the
[communicator](/docs/templates/legacy_json_templates/communicators) settings.
[communicator](/docs/templates/legacy_json_templates/communicator) settings.

View File

@ -7,6 +7,7 @@ sidebar_title: 1&amp;1
# 1&1 Builder
Type: `oneandone`
Artifact BuilderId: `packer.oneandone`
The 1&1 Builder is able to create virtual machines for
[1&1](https://www.1and1.com/).
@ -18,7 +19,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key:

View File

@ -17,6 +17,7 @@ sidebar_title: OpenStack
# OpenStack Builder
Type: `openstack`
Artifact BuilderId: `mitchellh.openstack`
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
@ -51,7 +52,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
### Required:
@ -140,7 +141,7 @@ Here is a basic example. This is a working example to build a Ubuntu 12.04 LTS
(Precise Pangolin) on Rackspace OpenStack cloud offering.
<Tabs>
<Tab heading="JSON">
<Tab heading="JSON">
```json
{

View File

@ -9,6 +9,7 @@ sidebar_title: Oracle Classic
# Oracle Cloud Infrastructure Classic Compute Builder
Type: `oracle-classic`
Artifact BuilderId: `packer.oracle.classic`
The `oracle-classic` Packer builder is able to create custom images for use
with [Oracle Cloud Infrastructure Classic

View File

@ -9,6 +9,7 @@ sidebar_title: Oracle OCI
# Oracle Cloud Infrastructure (OCI) Builder
Type: `oracle-oci`
Artifact BuilderId: `packer.oracle.oci`
The `oracle-oci` Packer builder is able to create new custom images for use
with [Oracle Cloud Infrastructure](https://cloud.oracle.com) (OCI). The builder
@ -40,7 +41,7 @@ in which case you don't need the above user authorization.
There are many configuration options available for the `oracle-oci` builder. In
addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
In addition to the options defined there, a private key file

View File

@ -13,6 +13,7 @@ sidebar_title: BSU
# OMI Builder (BSU backed)
Type: `osc-bsu`
Artifact BuilderId: `oapi.outscale.bsu`
The `osc-bsu` Packer builder is able to create Outscale OMIs backed by BSU
volumes for use in [Flexible Compute Unit](https://wiki.outscale.net/pages/viewpage.action?pageId=43060893). For more information on
@ -41,7 +42,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
### Required:

View File

@ -9,6 +9,7 @@ sidebar_title: BSU Surrogate
# BSU Surrogate Builder
Type: `osc-bsusurrogate`
Artifact BuilderId: `oapi.outscale.bsusurrogate`
The `osc-bsusurrogate` Packer builder is able to create Outscale OMIs by
running a source virtual machine with an attached volume, provisioning the attached
@ -29,7 +30,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
### Required:

View File

@ -9,6 +9,7 @@ sidebar_title: BSU Volume
# BSU Volume Builder
Type: `osc-bsuvolume`
Artifact BuilderId: `oapi.outscale.bsuvolume`
The `osc-bsuvolume` Packer builder is able to create Ouscale Block Stogate Unit
volumes which are prepopulated with filesystems or data.
@ -35,7 +36,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
### Required:

View File

@ -15,6 +15,7 @@ sidebar_title: chroot
# OMI Builder (chroot)
Type: `osc-chroot`
Artifact BuilderId: `oapi.outscale.chroot`
The `osc-chroot` Packer builder is able to create Outscale Machine Images (OMIs) backed by an
BSU volume as the root device. For more information on the difference between

View File

@ -12,6 +12,7 @@ sidebar_title: ISO
# Parallels Builder (from an ISO)
Type: `parallels-iso`
Artifact BuilderId: `packer.parallels`
The Parallels Packer builder is able to create [Parallels Desktop for
Mac](https://www.parallels.com/products/desktop/) virtual machines and export
@ -53,7 +54,7 @@ are organized below into two categories: required and optional. Within each
category, the available options are alphabetized and described.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key:

View File

@ -12,6 +12,7 @@ sidebar_title: PVM
# Parallels Builder (from a PVM)
Type: `parallels-pvm`
Artifact BuilderId: `packer.parallels`
This Parallels builder is able to create [Parallels Desktop for
Mac](https://www.parallels.com/products/desktop/) virtual machines and export
@ -50,7 +51,7 @@ are organized below into two categories: required and optional. Within each
category, the available options are alphabetized and described.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key:

View File

@ -7,6 +7,7 @@ sidebar_title: ProfitBricks
# ProfitBricks Builder
Type: `profitbricks`
Artifact BuilderId: `packer.profitbricks`
The ProfitBricks Builder is able to create virtual machines for
[ProfitBricks](https://www.profitbricks.com).
@ -18,7 +19,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key:

View File

@ -11,6 +11,7 @@ sidebar_title: Clone
# Proxmox Builder (from an image)
Type: `proxmox-clone`
Artifact BuilderId: `proxmox.clone`
The `proxmox-clone` Packer builder is able to create new images for use with
[Proxmox](https://www.proxmox.com/en/proxmox-ve). The builder takes a virtual
@ -28,7 +29,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
If no communicator is defined, an SSH key is generated for use, and is used

View File

@ -11,6 +11,7 @@ sidebar_title: ISO
# Proxmox Builder (from an ISO)
Type: `proxmox-iso`
Artifact BuilderId: `proxmox.iso`
The `proxmox-iso` Packer builder is able to create new images for use with
[Proxmox](https://www.proxmox.com/en/proxmox-ve). The builder takes an ISO
@ -28,7 +29,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
### Required:

View File

@ -10,6 +10,7 @@ sidebar_title: QEMU
# QEMU Builder
Type: `qemu`
Artifact BuilderId: `transcend.qemu`
The Qemu Packer builder is able to create [KVM](http://www.linux-kvm.org) virtual
machine images.

View File

@ -17,6 +17,7 @@ sidebar_title: Scaleway
# Scaleway Builder
Type: `scaleway`
Artifact BuilderId: `hashicorp.scaleway`
The `scaleway` Packer builder is able to create new images for use with
[Scaleway](https://www.scaleway.com). The builder takes a source image, runs
@ -34,7 +35,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key:

View File

@ -9,6 +9,7 @@ sidebar_title: Tencent Cloud
# Tencentcloud Image Builder
Type: `tencentcloud-cvm`
Artifact BuilderId: `tencent.cloud`
The `tencentcloud-cvm` Packer builder plugin provide the capability to build
customized images based on an existing base images.
@ -17,7 +18,7 @@ customized images based on an existing base images.
The following configuration options are available for building Tencentcloud images.
In addition to the options listed here,
a [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this builder.
a [communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this builder.
### Required:

View File

@ -16,6 +16,7 @@ sidebar_title: Triton
# Triton Builder
Type: `triton`
Artifact BuilderId: `joyent.triton`
The `triton` Packer builder is able to create new images for use with Triton.
These images can be used with both the [Joyent public
@ -47,7 +48,7 @@ There are many configuration options available for the builder. They are
segmented below into two categories: required and optional parameters.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key:

View File

@ -9,6 +9,7 @@ sidebar_title: UCloud
# UCloud Image Builder
Type: `ucloud-uhost`
Artifact BuilderId: `ucloud.uhost`
The `ucloud-uhost` Packer builder plugin provides the capability to build
customized images based on an existing base image for use in UHost Instance.
@ -22,7 +23,7 @@ The following configuration options are available for building UCloud images. Th
segmented below into two categories: required and optional parameters.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
~> **Note:** The builder doesn't support Windows images for now and only supports CentOS and Ubuntu images via SSH authentication with `ssh_username` (Required) and `ssh_password` (Optional). The `ssh_username` must be `root` for CentOS images and `ubuntu` for Ubuntu images. The `ssh_password` may contain 8-30 characters, and must consist of at least 2 items out of the capital letters, lower case letters, numbers and special characters. The special characters include `()~!@#\$%^&\*-+=\_|{}\[]:;'<>,.?/`.

View File

@ -8,6 +8,9 @@ sidebar_title: Vagrant
# Vagrant Builder
Type: `vagrant`
Artifact BuilderId: `vagrant`
The Vagrant builder is intended for building new boxes from already-existing
boxes. Your source should be a URL or path to a .box file or a Vagrant Cloud
box name such as `hashicorp/precise64`.

View File

@ -11,6 +11,7 @@ sidebar_title: ISO
# VirtualBox Builder (from an ISO)
Type: `virtualbox-iso`
Artifact BuilderId: `mitchellh.virtualbox`
The VirtualBox Packer builder is able to create
[VirtualBox](https://www.virtualbox.org/) virtual machines and export them in

View File

@ -12,6 +12,7 @@ sidebar_title: OVF
# VirtualBox Builder (from an OVF/OVA)
Type: `virtualbox-ovf`
Artifact BuilderId: `mitchellh.virtualbox`
This VirtualBox Packer builder is able to create
[VirtualBox](https://www.virtualbox.org/) virtual machines and export them in

View File

@ -13,6 +13,7 @@ sidebar_title: VM
# VirtualBox Builder (from an existing VM)
Type: `virtualbox-vm`
Artifact BuilderId: `mitchellh.virtualbox`
The VirtualBox Packer builder is able to create
[VirtualBox](https://www.virtualbox.org/) virtual machines snapshots and
@ -100,7 +101,7 @@ references for [ISO](#iso-configuration),
configuration references, which are
necessary for this build to succeed and can be found further down the page.
In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.
### Required:

View File

@ -14,6 +14,8 @@ sidebar_title: VMWare ISO
# VMware Builder (from ISO)
Type: `vmware-iso`
Artifact BuilderId: `mitchellh.vmware`
If remote_type is esx: Artifact BuilderId: `mitchellh.vmware-esx`
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

View File

@ -13,6 +13,8 @@ sidebar_title: VMWare VMX
# VMware Builder (from VMX)
Type: `vmware-vmx`
Artifact BuilderId: `mitchellh.vmware`
If remote_type is esx: Artifact BuilderId: `mitchellh.vmware-esx`
This VMware Packer builder is able to create VMware virtual machines from an
existing VMware virtual machine (a VMX file). It currently supports building

View File

@ -11,6 +11,7 @@ sidebar_title: VSphere Clone
# VMWare Vsphere Clone Builder
Type: `vsphere-clone`
Artifact BuilderId: `jetbrains.vsphere`
This builder clones VMs from existing templates.

View File

@ -11,6 +11,7 @@ sidebar_title: VSphere ISO
# Packer Builder for VMware vSphere
Type: `vsphere-iso`
Artifact BuilderId: `jetbrains.vsphere`
This builder uses the vSphere API, and creates virtual machines remotely. It
starts from an ISO file and creates new VMs from scratch.

View File

@ -9,6 +9,7 @@ sidebar_title: Yandex.Cloud
# Yandex Compute Builder
Type: `yandex`
Artifact BuilderId: `packer.yandex`
The `yandex` Packer builder is able to create
[images](https://cloud.yandex.com/docs/compute/concepts/images) for use with
@ -64,7 +65,7 @@ Configuration options are organized below into two categories: required and
optional. Within each category, the available options are alphabetized and
described.
In addition to the options listed here, a [communicator](/docs/templates/legacy_json_templates/communicators)
In addition to the options listed here, a [communicator](/docs/templates/legacy_json_templates/communicator)
can be configured for this builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key:

View File

@ -173,7 +173,11 @@ builder, followed by the platform it is building for. For example, the builder
ID of the VMware builder is "hashicorp.vmware".
Post-processors use the builder ID value in order to make some assumptions
about the artifact results, so it is important it never changes.
about the artifact results and to determine whether they are even able to run
against a given artifact, so it is important that this ID never changes once
the builder is published.
The builder ID for each builder is documented on its website docs page.
## Provisioning

View File

@ -9,6 +9,7 @@ sidebar_title: Alicloud Import
# Alicloud Import Post-Processor
Type: `alicloud-import`
Artifact BuilderId: `packer.post-processor.alicloud-import`
The Packer Alicloud Import post-processor takes a RAW or VHD artifact from
various builders and imports it to an Alicloud ECS Image.

View File

@ -9,6 +9,7 @@ sidebar_title: Amazon Import
# Amazon Import Post-Processor
Type: `amazon-import`
Artifact BuilderId: `packer.post-processor.amazon-import`
The Packer Amazon Import post-processor takes an OVA artifact from various
builders and imports it to an AMI available to Amazon Web Services EC2.

View File

@ -19,6 +19,7 @@ sidebar_title: Artifice
# Artifice Post-Processor
Type: `artifice`
Artifact BuilderId: `packer.post-processor.artifice`
The artifice post-processor overrides the artifact list from an upstream
builder or post-processor. All downstream post-processors will see the new

View File

@ -13,6 +13,7 @@ sidebar_title: Checksum
# Checksum Post-Processor
Type: `checksum`
Artifact BuilderId: `packer.post-processor.checksum`
The checksum post-processor computes specified checksum for the artifact list
from an upstream builder or post-processor. All downstream post-processors will

View File

@ -9,6 +9,7 @@ sidebar_title: Compress
# Compress Post-Processor
Type: `compress`
Artifact BuilderId: `packer.post-processor.compress`
The Packer compress post-processor takes an artifact with files (such as from
VMware or VirtualBox) and compresses the artifact into a single archive.

View File

@ -9,6 +9,7 @@ sidebar_title: DigitalOcean Import
# DigitalOcean Import Post-Processor
Type: `digitalocean-import`
Artifact BuilderId: `packer.post-processor.digitalocean-import`
The Packer DigitalOcean Import post-processor is used to import images created by other Packer builders to DigitalOcean.

View File

@ -11,6 +11,7 @@ sidebar_title: Docker Import
# Docker Import Post-Processor
Type: `docker-import`
Artifact BuilderId: `packer.post-processor.docker-import`
The Packer Docker import post-processor takes an artifact from the [docker
builder](/docs/builders/docker) and imports it with Docker locally. This

View File

@ -9,6 +9,7 @@ sidebar_title: Docker Push
# Docker Push Post-Processor
Type: `docker-push`
Artifact BuilderId: `packer.post-processor.docker-import`
The Packer Docker push post-processor takes an artifact from the
[docker-import](/docs/post-processors/docker-import) post-processor and

View File

@ -15,6 +15,7 @@ sidebar_title: Docker Save
# Docker Save Post-Processor
Type: `docker-save`
Artifact BuilderId: `packer.post-processor.docker-save`
The Packer Docker Save post-processor takes an artifact from the [docker
builder](/docs/builders/docker) that was committed and saves it to a file.

View File

@ -11,6 +11,7 @@ sidebar_title: Docker Tag
# Docker Tag Post-Processor
Type: `docker-tag`
Artifact BuilderId: `packer.post-processor.docker-tag`
The Packer Docker Tag post-processor takes an artifact from the [docker
builder](/docs/builders/docker) that was committed and tags it into a

View File

@ -9,6 +9,7 @@ sidebar_title: Exoscale Import
# Exoscale Import Post-Processor
Type: `exoscale-import`
Artifact BuilderId: `packer.post-processor.exoscale-import`
The Packer Exoscale Import post-processor takes an image artifact from
the QEMU, Artifice, or File builders and imports it to Exoscale.

View File

@ -11,6 +11,7 @@ sidebar_title: Google Compute Export
# Google Compute Image Exporter Post-Processor
Type: `googlecompute-export`
Artifact BuilderId: `packer.post-processor.googlecompute-export`
The Google Compute Image Exporter post-processor exports the resultant image
from a googlecompute build as a gzipped tarball to Google Cloud Storage (GCS).

View File

@ -9,6 +9,7 @@ sidebar_title: Google Compute Import
# Google Compute Image Import Post-Processor
Type: `googlecompute-import`
Artifact BuilderId: `packer.post-processor.googlecompute-import`
The Google Compute Image Import post-processor takes a compressed raw disk
image and imports it to a GCE image available to Google Compute Engine.

View File

@ -9,6 +9,7 @@ sidebar_title: Manifest
# Manifest Post-Processor
Type: `manifest`
Artifact BuilderId: `packer.post-processor.manifest`
The manifest post-processor writes a JSON file with a list of all of the
artifacts packer produces during a run. If your packer template includes

View File

@ -10,6 +10,7 @@ sidebar_title: UCloud Import
# UCloud Import Post-Processor
Type: `ucloud-import`
Artifact BuilderId: `packer.post-processor.ucloud-import`
The Packer UCloud Import post-processor takes the RAW, VHD, VMDK, or qcow2 artifact from various builders and imports it to UCloud customized image list for UHost Instance.

View File

@ -9,6 +9,7 @@ sidebar_title: Vagrant Cloud
# Vagrant Cloud Post-Processor
Type: `vagrant-cloud`
Artifact BuilderId: `pearkes.post-processor.vagrant-cloud`
[Vagrant Cloud](https://app.vagrantup.com/boxes/search) hosts and serves boxes
to Vagrant, allowing you to version and distribute boxes to an organization in a

View File

@ -15,6 +15,7 @@ sidebar_title: Vagrant
# Vagrant Post-Processor
Type: `vagrant`
Artifact BuilderId: `mitchellh.post-processor.vagrant`
The Packer Vagrant post-processor takes a build and converts the artifact into
a valid [Vagrant](https://www.vagrantup.com) box, if it can. This lets you use

View File

@ -11,6 +11,7 @@ sidebar_title: vSphere Template
# vSphere Template Post-Processor
Type: `vsphere-template`
Artifact BuilderId: `packer.post-processor.vsphere`
The Packer vSphere Template post-processor takes an artifact from the
VMware-iso builder, built on ESXi (i.e. remote) or an artifact from the

View File

@ -9,6 +9,7 @@ sidebar_title: vSphere
# vSphere Post-Processor
Type: `vsphere`
Artifact BuilderId: `packer.post-processor.vsphere`
The Packer vSphere post-processor takes an artifact and uploads it to a vSphere endpoint.
The artifact must have a vmx/ova/ovf image.

View File

@ -13,6 +13,7 @@ sidebar_title: Yandex.Cloud Compute Export
# Yandex.Cloud Compute Image Exporter Post-Processor
Type: `yandex-export`
Artifact BuilderId: `packer.post-processor.yandex-export`
The Yandex.Cloud Compute Image Exporter post-processor exports the resultant image
from a yandex build as a qcow2 file to Yandex Object Storage.

View File

@ -10,6 +10,7 @@ sidebar_title: Yandex.Cloud Compute Import
# Yandex.Cloud Compute Image Import Post-Processor
Type: `yandex-import`
Artifact BuilderId: `packer.post-processor.yandex-import`
The Yandex.Cloud Compute Image Import post-processor create new Compute Image
from a qcow2 file. As Compute service support image creation from Storage service object

View File

@ -70,10 +70,10 @@ of them since the names must be unique.
## Communicators
Every build is associated with a single
[communicator](/docs/templates/legacy_json_templates/communicators). Communicators are used to
[communicator](/docs/templates/legacy_json_templates/communicator). Communicators are used to
establish a connection for provisioning a remote machine (such as an AWS
instance or local virtual machine).
All the examples for the various builders show some communicator (usually SSH),
but the communicators are highly customizable so we recommend reading the
[communicator documentation](/docs/templates/legacy_json_templates/communicators).
[communicator documentation](/docs/templates/legacy_json_templates/communicator).