Merge pull request #10345 from hashicorp/je.mdx-remote

Implement MDX Remote
This commit is contained in:
Megan Marsh 2020-12-14 15:54:39 -08:00 committed by GitHub
commit bf0a19f2cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
630 changed files with 5529 additions and 6768 deletions

View File

@ -1,8 +0,0 @@
{
"ignore": {
"marked": {
"versions": "0.8.2",
"reason": "IE breaks"
}
}
}

View File

@ -1,4 +0,0 @@
module.exports = {
presets: ['next/babel'],
plugins: ['import-glob-array'],
}

View File

@ -1,5 +1,4 @@
---
layout: index
page_title: Community vs HashiCorp Maintained Plugins
description: Packer maintains these core plugins.
---

View File

@ -1,7 +1,6 @@
---
layout: index
page_title: Download Packer Community Projects
description: |-
description: >-
Packer has a vibrant community of contributors who have built a number of
great tools on top of Packer. There are also quite a few projects
demonstrating the power of Packer templates.

View File

@ -2,7 +2,6 @@
description: |
The `alicloud-ecs` Packer builder plugin provide the capability to build
customized images based on an existing base images.
layout: docs
page_title: Alicloud Image Builder
sidebar_title: Alicloud ECS
---
@ -48,6 +47,7 @@ builder.
@include 'packer-plugin-sdk/communicator/SSH-Agent-Auth-not-required.mdx'
# Disk Devices Configuration:
@include 'builder/alicloud/ecs/AlicloudDiskDevice-not-required.mdx'
## Basic Example

View File

@ -8,7 +8,6 @@ description: >
instance storage and EBS-backed instances, storage for the root device section
in the EC2 documentation.
layout: docs
page_title: Amazon chroot - Builders
sidebar_title: chroot
---
@ -256,7 +255,6 @@ For debian based distributions you can setup a
file which will prevent packages installed by your provisioners from starting
services:
<Tabs>
<Tab heading="JSON">

View File

@ -4,7 +4,6 @@ description: |
volumes for use in EC2. For more information on the difference between
EBS-backed instances and instance-store backed instances, see the storage for
the root device section in the EC2 documentation.
layout: docs
page_title: Amazon EBS - Builders
sidebar_title: EBS
---
@ -226,7 +225,7 @@ configuration of `launch_block_device_mappings` will expand the root volume
```json
{
"builders": [
{
{
"type": "amazon-ebs",
"region": "us-east-1",
"source_ami": "ami-fce3c696",
@ -593,7 +592,6 @@ build {
</Tab>
</Tabs>
## Windows 2016 Sysprep Commands - For Amazon Windows AMIs Only
For Amazon Windows 2016 AMIs it is necessary to run Sysprep commands which can
@ -627,5 +625,4 @@ provisioner "powershell" {
</Tab>
</Tabs>
@include 'builders/aws-ssh-differentiation-table.mdx'

View File

@ -4,7 +4,6 @@ description: >
not
require running inside an EC2 instance.
layout: docs
page_title: Amazon EBS Surrogate - Builders
sidebar_title: EBS Surrogate
---

View File

@ -2,7 +2,6 @@
description: |
The amazon-ebsvolume Packer builder is like the EBS builder, but is
intended to create EBS volumes rather than a machine image.
layout: docs
page_title: Amazon EBS Volume - Builders
sidebar_title: EBS Volume
---

View File

@ -2,7 +2,6 @@
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.
layout: docs
page_title: Amazon AMI - Builders
sidebar_title: Amazon EC2
---
@ -161,7 +160,6 @@ source "amazon-ebs" "basic-example" {
</Tab>
</Tabs>
### IAM Task or Instance Role
Finally, Packer will use credentials provided by the task's or instance's IAM

View File

@ -8,7 +8,6 @@ description: >
root
device section in the EC2 documentation.
layout: docs
page_title: Amazon instance-store - Builders
sidebar_title: Instance
---

View File

@ -1,6 +1,5 @@
---
description: Packer supports building VHDs in Azure Resource manager.
layout: docs
page_title: Azure arm - Builders
sidebar_title: ARM
---

View File

@ -4,7 +4,6 @@ description: >
leveraging
a VM in Azure.
layout: docs
page_title: Azure chroot - Builders
sidebar_title: chroot
---

View File

@ -4,7 +4,6 @@ description: >
multiple builders depending on the strategy you want to use to build the
images.
layout: docs
page_title: Azure images - Builders
sidebar_title: Azure
---
@ -111,6 +110,7 @@ This method will skip all other options provided and only use the credentials th
Works with both normal user (`az login`) as well as service principal (`az login --service-principal --username APP_ID --password PASSWORD --tenant TENANT_ID`).
To enable az cli authentication, use the following:
- `"use_azure_cli_auth": true`
This mode will use the `tenant_id` and `subscription_id` from the current active az session which can be found by running: `az account show`

View File

@ -4,7 +4,6 @@ description: |
CloudStack. The builder takes either an ISO or an existing template as it's
source, runs any provisioning necessary on the instance after launching it and
then creates a new template from that instance.
layout: docs
page_title: CloudStack - Builders
sidebar_title: CloudStack
---

View File

@ -2,7 +2,6 @@
description: |
Community-maintained builders are not part of the core Packer binary, but
can run alongside Packer with minimal extra effort.
layout: docs
page_title: Community - Builders
sidebar_title: Community-Supported
---

View File

@ -3,7 +3,6 @@ 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.
layout: docs
page_title: Custom - Builders
sidebar_title: Custom
---

View File

@ -10,7 +10,6 @@ description: >
reusable image can then be used as the foundation of new servers that are
launched within DigitalOcean.
layout: docs
page_title: DigitalOcean - Builders
sidebar_title: DigitalOcean
---

View File

@ -6,7 +6,6 @@ description: >
a Docker container, runs provisioners within this container, then exports the
container for reuse or commits the image.
layout: docs
page_title: Docker - Builders
sidebar_title: Docker
---
@ -223,7 +222,7 @@ for JSON and [contextual variables](/docs/from-1.5/contextual-variables) for HCL
The generated variable available for this builder is:
- `ImageSha256` - When committing a container to an image, this will give the image SHA256. Because the image is not available at the provision step,
this variable is only available for post-processors.
this variable is only available for post-processors.
## Using the Artifact: Export

View File

@ -3,7 +3,6 @@ description: |
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
wait times.
layout: docs
page_title: File - Builders
sidebar_title: File
---

View File

@ -2,7 +2,6 @@
description: |
The googlecompute Packer builder is able to create images for use with Google
Cloud Compute Engine (GCE) based on existing images.
layout: docs
page_title: Google Compute - Builders
sidebar_title: Google Cloud
---
@ -40,7 +39,6 @@ You don't need to specify an _account file_ if you are using this method. Your u
must have at least `Compute Instance Admin (v1)` & `Service Account User` roles
to use Packer succesfully.
### Running on Google Cloud
If you run the `googlecompute` Packer builder on GCE or GKE, you can
@ -50,9 +48,10 @@ Packer to authenticate to Google Cloud without having to bake in a separate
credential/authentication file.
It is recommended that you create a custom service account for Packer and assign it
`Compute Instance Admin (v1)` & `Service Account User` roles.
`Compute Instance Admin (v1)` & `Service Account User` roles.
For `gcloud`, you can run the following commands:
```shell-session
$ gcloud iam service-accounts create packer \
--project YOUR_GCP_PROJECT \
@ -98,7 +97,7 @@ straightforwarded, it is documented here.
5. Generate a JSON Key and save it in a secure location.
5. Set the Environment Variable `GOOGLE_APPLICATION_CREDENTIALS` to point to the path of the service account key.
6. Set the Environment Variable `GOOGLE_APPLICATION_CREDENTIALS` to point to the path of the service account key.
### Precedence of Authentication Methods
@ -401,7 +400,6 @@ The GCS location must be writeable by the service account of the instance that P
@include 'packer-plugin-sdk/communicator/SSHTemporaryKeyPair-not-required.mdx'
### Gotchas
CentOS and recent Debian images have root ssh access disabled by default. Set

View File

@ -5,7 +5,6 @@ description: |
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 the Hetzner Cloud.
layout: docs
page_title: Hetzner Cloud - Builders
sidebar_title: Hetzner Cloud
---
@ -58,9 +57,7 @@ builder.
```json
{
"image_filter": {
"with_selector": [
"name==my-image"
],
"with_selector": ["name==my-image"],
"most_recent": true
}
}

View File

@ -3,7 +3,6 @@ description: |
HyperOne Packer builder creates new images on the HyperOne platform.
The builder takes a source image, runs any provisioning necessary on
the image after launching it, then creates a reusable image.
layout: docs
page_title: HyperOne - Builders
sidebar_title: HyperOne
---

View File

@ -2,7 +2,6 @@
description: |
The Hyper-V Packer builder is able to create Hyper-V virtual machines and
export them.
layout: docs
page_title: Hyper-V - Builders
sidebar_title: Hyper-V
---

View File

@ -4,7 +4,6 @@ modeline: |
description: |
The Hyper-V Packer builder is able to create Hyper-V virtual machines and
export them.
layout: docs
page_title: Hyper-V ISO - Builders
sidebar_title: ISO
---

View File

@ -4,7 +4,6 @@ modeline: |
description: >-
The Hyper-V Packer builder is able to clone an existing Hyper-V virtual
machine and export them.
layout: docs
page_title: Hyper-V Builder (from a vmcx)
sidebar_title: VMCX
---

View File

@ -2,7 +2,6 @@
description: |
Builders are responsible for creating machines and generating images from them
for various platforms.
layout: docs
page_title: Builders
sidebar_title: Builders
---

View File

@ -2,7 +2,6 @@
description: |
The `jdcloud` Packer builder helps you to build instance images
based on an existing image
layout: docs
page_title: JDCloud Image Builder
sidebar_title: JDCloud
---
@ -37,6 +36,7 @@ are given below:
- `subnet_id` (string) - An instance is supposed to exists in an subnet, if not specified , we will create new one for you
In addition to the above configuration options, a communicator can be configured for this builder:
### Communicator Configuration
#### Optional:

View File

@ -10,7 +10,6 @@ description: >
image can then be used as the foundation of new servers that are launched
within all Linode regions.
layout: docs
page_title: Linode - Builders
sidebar_title: Linode
---

View File

@ -3,7 +3,6 @@ description: |
The `lxc` Packer builder builds containers for lxc1. The builder starts an LXC
container, runs provisioners within this container, then exports the container
as a tar.gz of the root file system.
layout: docs
page_title: LXC - Builders
sidebar_title: LXC
---

View File

@ -6,7 +6,6 @@ description: >
as
an LXD image.
layout: docs
page_title: LXD - Builders
sidebar_title: LXD
---

View File

@ -2,7 +2,6 @@
description: |
The ncloud builder allows you to create server images using the NAVER Cloud
Platform.
layout: docs
page_title: Naver Cloud Platform - Builders
sidebar_title: NAVER Cloud
---

View File

@ -4,7 +4,6 @@ description: |
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.
layout: docs
page_title: Null - Builders
sidebar_title: 'Null'
---

View File

@ -1,6 +1,5 @@
---
description: The 1&1 builder is able to create images for 1&1 cloud.
layout: docs
page_title: 1&1 - Builders
sidebar_title: 1&amp;1
---

View File

@ -10,7 +10,6 @@ description: >
image can then be used as the foundation of new servers that are launched
within OpenStack.
layout: docs
page_title: OpenStack - Builders
sidebar_title: OpenStack
---

View File

@ -2,7 +2,6 @@
description: |
The oracle-classic builder is able to create new custom images for use with
Oracle Cloud Infrastructure Classic Compute.
layout: docs
page_title: Oracle Cloud Infrastructure Classic - Builders
sidebar_title: Oracle Classic
---
@ -183,7 +182,6 @@ If this is set, a few more options become available.
variables: `{{ .Username }}`, `{{ .Password }}`, `{{ .AccountID }}`,
`{{ .ImageFile }}`, and `{{ .SegmentPath }}`.
### Communicator Configuration
The `builder_communicator` has the following options:

View File

@ -1,6 +1,5 @@
---
description: Packer is able to create custom images using Oracle Cloud Infrastructure.
layout: docs
page_title: Oracle - Builders
sidebar_title: Oracle
---

View File

@ -2,7 +2,6 @@
description: |
The oracle-oci builder is able to create new custom images for use with Oracle
Cloud Infrastructure (OCI).
layout: docs
page_title: Oracle OCI - Builders
sidebar_title: Oracle OCI
---
@ -74,17 +73,19 @@ can also be supplied to override the typical auto-generated key:
the user can supply search criteria, and Packer will use the the most recent image that meets
all search criteria. If no image meets all search criteria, Packer returns an error. The
following fields, if specified, must match exactly:
- `compartment_id` - The OCID of the compartment to find the image. If not specified, will use `compartment_ocid`
used for the instance.
- `display_name` - The full name of the image, e.g., `Oracle-Linux-7.8-2020.05.26-0`
- `operating_system` - The operating system used on the image, e.g., `Oracle Linux`
- `operating_system_version` - The version of the operating system on the image, e.g., `7.8`
- `shape` - A shape that the image supports. If not specified, will use `shape` used for the instance
- `compartment_id` - The OCID of the compartment to find the image. If not specified, will use `compartment_ocid`
used for the instance.
- `display_name` - The full name of the image, e.g., `Oracle-Linux-7.8-2020.05.26-0`
- `operating_system` - The operating system used on the image, e.g., `Oracle Linux`
- `operating_system_version` - The version of the operating system on the image, e.g., `7.8`
- `shape` - A shape that the image supports. If not specified, will use `shape` used for the instance
Additionally, the following field takes a regular expression:
- `display_name_search` - a regular expression for the display name, e.g., `^Oracle-Linux`. This
is ignored if `display_name` is also specified under `base_image_filter`. If no images match
the expression, Packer returns an error. If multiple images match, the most recent is used.
- `display_name_search` - a regular expression for the display name, e.g., `^Oracle-Linux`. This
is ignored if `display_name` is also specified under `base_image_filter`. If no images match
the expression, Packer returns an error. If multiple images match, the most recent is used.
`base_image_filter` is ignored if `base_image_ocid` is also specified.
@ -288,6 +289,7 @@ Build 'oracle-oci' finished.
```
## Assigning Tags and Network Security Groups to the Instance
Tags are useful for breaking down costs and usage. The keys `instance_tags`
and `instance_defined_tags` are assigned to the temporary instance,
whereas `tags` and `defined_tags` are assigned to the resulting image.
@ -297,19 +299,20 @@ to the instance. Depending on network (VCN and subnet) setup, this may be
required for Packer to successfully SSH into the instance. NSGs are a property
of the virtual network interface card (VNIC) attached to the instance, and
are listed in `nsg_ids` under `create_vnic_details`.
```json
{
"name": "base-image-{{isotime \"20060102030405\"}}",
"type": "oracle-oci",
"name": "base-image-{{isotime \"20060102030405\"}}",
"type": "oracle-oci",
"availability_domain": "aaaa:PHX-AD-1",
"base_image_ocid": "ocid1.image.oc1.iad.aaa",
"compartment_ocid": "ocid1.compartment.oc1..aaa",
"image_name": "my-image-{{isotime \"20060102030405\"}}",
"shape": "VM.Standard.E2.1",
"subnet_ocid": "ocid1.subnet.oc1.iad.aaa",
"use_private_ip": "true",
"instance_name": "packer-build-{{isotime \"20060102030405\"}}",
"instance_tags": { "testing": "yes" },
"base_image_ocid": "ocid1.image.oc1.iad.aaa",
"compartment_ocid": "ocid1.compartment.oc1..aaa",
"image_name": "my-image-{{isotime \"20060102030405\"}}",
"shape": "VM.Standard.E2.1",
"subnet_ocid": "ocid1.subnet.oc1.iad.aaa",
"use_private_ip": "true",
"instance_name": "packer-build-{{isotime \"20060102030405\"}}",
"instance_tags": { "testing": "yes" },
"instance_defined_tags": {
"Operations": {
"Team": "CostCenter",
@ -322,16 +325,18 @@ are listed in `nsg_ids` under `create_vnic_details`.
"nsg_ids": ["ocid1.networksecuritygroup.oc1.iad.aaa"]
},
"tags": {
"CreationDate": "{{isotime \"20060102 03:04:05 MST\"}}"
"CreationDate": "{{isotime \"20060102 03:04:05 MST\"}}"
}
}
```
## Base Image Filter Example
Note that `base_image_filter` gets passed as a string, then interpreted as a
regular expression. This means that all back-slashes must be doubled, e.g.,
use `\\w+` to mean `\w+`, and `\\\\` to create the regular expression equivalent
of `\\` (which will search for a literal back-slash).
```json
{
"name": "base-image-{{isotime \"20060102030405\"}}",
@ -344,3 +349,4 @@ of `\\` (which will search for a literal back-slash).
}
...
}
```

View File

@ -6,7 +6,6 @@ description: >
BSU-backed VMs and VM-store backed VMs, see the storage for
the root device section in the Outscale documentation.
layout: docs
page_title: Outscale BSU - Builders
sidebar_title: BSU
---

View File

@ -2,7 +2,6 @@
description: |
The osc-bsusurrogate Packer builder is like the chroot builder, but does not
require running inside an Outscale virtual machine.
layout: docs
page_title: Outscale BSU Surrogate - Builders
sidebar_title: BSU Surrogate
---

View File

@ -2,7 +2,6 @@
description: |
The osc-bsuvolume Packer builder is like the BSU builder, but is intended to
create BSU volumes rather than a machine image.
layout: docs
page_title: Outscale BSU Volume - Builders
sidebar_title: BSU Volume
---

View File

@ -8,7 +8,6 @@ description: >
instance storage and BSU-backed instances, storage for the root device section
in the Outscale documentation.
layout: docs
page_title: Outscale chroot - Builders
sidebar_title: chroot
---
@ -331,8 +330,6 @@ services:
"chmod a+x /usr/sbin/policy-rc.d"
]
},
// ...
{
"type": "shell",
"inline": ["rm -f /usr/sbin/policy-rc.d"]

View File

@ -4,7 +4,6 @@ description: >
Packer comes with
multiple builders depending on the strategy you want to use to build the OMI.
layout: docs
page_title: Outscale OMI - Builders
sidebar_title: Outscale
---
@ -85,7 +84,6 @@ This adds an additional layer of security, especially desirable on SecNumCloud c
You can set this certificates either by environment variables or by the static credentials inside the packer configuration file.
#### Environment variables
```bash
@ -100,11 +98,10 @@ export OUTSCALE_X509KEY="the/path/to/your/x509key"
"x509_cert_path": "the/path/to/your/x509cert",
"x509_key_path": "the/path/to/your/x509key",
"region": "cloudgouv-eu-west-1",
"type": "osc-bsu",
"type": "osc-bsu"
}
```
### Checking that system time is current
Outscale uses the current time as part of the [request signing

View File

@ -2,7 +2,6 @@
description: |
The Parallels Packer builder is able to create Parallels Desktop for Mac
virtual machines and export them in the PVM format.
layout: docs
page_title: Parallels - Builders
sidebar_title: Parallels
---

View File

@ -5,7 +5,6 @@ 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.
layout: docs
page_title: Parallels ISO - Builders
sidebar_title: ISO
---

View File

@ -5,7 +5,6 @@ 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).
layout: docs
page_title: Parallels PVM - Builders
sidebar_title: PVM
---

View File

@ -1,6 +1,5 @@
---
description: The ProfitBricks builder is able to create images for ProfitBricks cloud.
layout: docs
page_title: ProfitBricks - Builders
sidebar_title: ProfitBricks
---

View File

@ -4,7 +4,6 @@ description: |
Proxmox VE. The builder takes a cloud-init enabled virtual machine
template name, runs any provisioning necessary on the image after
launching it, then creates a virtual machine template.
layout: docs
page_title: Proxmox Clone - Builders
sidebar_title: Clone
---
@ -191,7 +190,7 @@ in the image's Cloud-Init settings for provisioning.
- `full_clone` (bool) - Whether to run a full or shallow clone from the base clone_vm. Defaults to `true`.
- `boot` - (string) - Override default boot order. Format example `order=virtio0;ide2;net0`.
Prior to Proxmox 6.2-15 the format was `cdn` (c:CDROM -> d:Disk -> n:Network)
Prior to Proxmox 6.2-15 the format was `cdn` (c:CDROM -> d:Disk -> n:Network)
## Example: Cloud-Init enabled Debian
@ -233,5 +232,4 @@ that there exists a Cloud-Init enabled image on the Proxmox server named
],
"description": "A template for building a base"
}
```

View File

@ -1,9 +1,7 @@
---
description: >
The Proxmox Packer builder is able to create Cloud-Init
virtual machine images on a Proxmox server.
layout: docs
The Proxmox Packer builder is able to create Cloud-Init virtual machine images
on a Proxmox server.
page_title: Proxmox - Builders
sidebar_title: Proxmox
---

View File

@ -4,7 +4,6 @@ description: |
Proxmox VE. The builder takes an ISO source, runs any provisioning
necessary on the image after launching it, then creates a virtual machine
template.
layout: docs
page_title: Proxmox ISO - Builders
sidebar_title: ISO
---
@ -230,22 +229,23 @@ builder.
}
]
```
- `device` (string) - Bus type and bus index that the ISO will be mounted on. Can be `ideX`,
`sataX` or `scsiX`.
For `ide` the bus index ranges from 0 to 3, for `sata` form 0 to 5 and for
`scsi` from 0 to 30.
Defaults to `ide3` since `ide2` is generelly the boot drive.
Defaults to `ide3` since `ide2` is generelly the boot drive.
- `iso_file` (string) - Path to the ISO file to boot from, expressed as a
proxmox datastore path, for example
`local:iso/Fedora-Server-dvd-x86_64-29-1.2.iso`.
Either `iso_file` OR `iso_url` must be specifed.
proxmox datastore path, for example
`local:iso/Fedora-Server-dvd-x86_64-29-1.2.iso`.
Either `iso_file` OR `iso_url` must be specifed.
- `iso_url` (string) - URL to an ISO file to upload to Proxmox, and then
boot from. Either `iso_file` OR `iso_url` must be specifed.
boot from. Either `iso_file` OR `iso_url` must be specifed.
- `iso_storage_pool` (string) - Proxmox storage pool onto which to upload
the ISO file.
the ISO file.
- `iso_checksum` (string) - Checksum of the ISO file.
- `unmount` (bool) - If true, remove the mounted ISO from the template after finishing. Defaults to `false`.
@ -257,7 +257,7 @@ builder.
the VMs IP from. Defaults to the first non loopback interface.
- `boot` - (string) - Override default boot order. Format example `order=virtio0;ide2;net0`.
Prior to Proxmox 6.2-15 the format was `cdn` (c:CDROM -> d:Disk -> n:Network)
Prior to Proxmox 6.2-15 the format was `cdn` (c:CDROM -> d:Disk -> n:Network)
## Boot Command

View File

@ -3,7 +3,6 @@ modeline: |
vim: set ft=pandoc:
description: |
The Qemu Packer builder is able to create KVM virtual machine images.
layout: docs
page_title: QEMU - Builders
sidebar_title: QEMU
---
@ -217,4 +216,4 @@ the input file's format and file extension, and Packer will
perform a simple copy operation instead. You will also want to set
`"skip_compaction": true,` and `"disk_compression": false` to skip a final
image conversion at the end of the build. See
https://bugs.launchpad.net/qemu/+bug/1776920 for more details.
https://bugs.launchpad.net/qemu/+bug/1776920 for more details.

View File

@ -10,7 +10,6 @@ description: >
new
servers that are launched within Scaleway.
layout: docs
page_title: Scaleway - Builders
sidebar_title: Scaleway
---

View File

@ -2,7 +2,6 @@
description: |
The `tencentcloud-cvm` Packer builder plugin provide the capability to build
customized images based on an existing base images.
layout: docs
page_title: Tencentcloud Image Builder
sidebar_title: Tencent Cloud
---

View File

@ -9,7 +9,6 @@ description: >
Triton
Cloud API to create images.
layout: docs
page_title: Triton - Builders
sidebar_title: Triton
---

View File

@ -2,7 +2,6 @@
description: |
The `ucloud-uhost` Packer builder plugin provides the capability to build
customized images based on an existing base image for use in UHost Instance.
layout: docs
page_title: UCloud Image Builder
sidebar_title: UCloud
---

View File

@ -2,7 +2,6 @@
description: |
The Vagrant Packer builder is able to launch Vagrant boxes and
re-package them into .box files
layout: docs
page_title: Vagrant - Builders
sidebar_title: Vagrant
---

View File

@ -4,7 +4,6 @@ description: >
and
export them in the OVA or OVF format.
layout: docs
page_title: VirtualBox - Builders
sidebar_title: VirtualBox
---

View File

@ -4,7 +4,6 @@ modeline: |
description: |
The VirtualBox Packer builder is able to create VirtualBox virtual machines
and export them in the OVF format, starting from an ISO image.
layout: docs
page_title: VirtualBox ISO - Builders
sidebar_title: ISO
---
@ -202,7 +201,6 @@ delay of 100ms between groups. The delay alleviates issues with latency and CPU
contention. If you notice missing keys, you can tune this delay by specifying
"boot_keygroup_interval" in your Packer template, for example:
<Tabs>
<Tab heading="JSON">

View File

@ -5,7 +5,6 @@ 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).
layout: docs
page_title: VirtualBox OVF/OVA - Builders
sidebar_title: OVF
---
@ -248,4 +247,3 @@ directory of the SSH user.
@include 'builder/virtualbox/common/VBoxManageConfig.mdx'
@include 'builder/virtualbox/common/VBoxManageConfig-not-required.mdx'

View File

@ -6,7 +6,6 @@ description: >
snapshots
and export them in the OVF format, starting from an ISO image.
layout: docs
page_title: VirtualBox Snapshot - Builders
sidebar_title: VM
---

View File

@ -2,7 +2,6 @@
description: |
The VMware Packer builder is able to create VMware virtual machines for use
with any VMware product.
layout: docs
page_title: VMware - Builders
sidebar_title: VMware
---

View File

@ -7,7 +7,6 @@ description: |
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.
layout: docs
page_title: VMware ISO - Builders
sidebar_title: VMWare ISO
---
@ -131,6 +130,7 @@ necessary for this build to succeed and can be found further down the page.
@include 'packer-plugin-sdk/multistep/commonsteps/FloppyConfig-not-required.mdx'
### CD configuration
@include 'packer-plugin-sdk/multistep/commonsteps/CDConfig-not-required.mdx'
### Shutdown configuration

View File

@ -6,7 +6,6 @@ description: |
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.
layout: docs
page_title: VMware VMX - Builders
sidebar_title: VMWare VMX
---

View File

@ -4,7 +4,6 @@ modeline: |
description: >
This VMware Packer builder uses the vSphere API to clone an existing vSphere
template and create a new virtual machine remotely.
layout: docs
page_title: VSphere Clone - Builders
sidebar_title: VSphere Clone
---
@ -18,8 +17,8 @@ This builder clones VMs from existing templates.
- VMware Player is not required.
- It uses the official vCenter API, and does not require ESXi host [modification](https://www.packer.io/docs/builders/vmware-iso.html#building-on-a-remote-vsphere-hypervisor)
- This builder is supported for vSphere version 6.5 and greater. Builds on lower
versions may work, but some configuration options may throw errors because they
do not exist in the older versions of the vSphere API.
versions may work, but some configuration options may throw errors because they
do not exist in the older versions of the vSphere API.
## Examples

View File

@ -4,7 +4,6 @@ modeline: |
description: |
This VMware Packer builder starts from an ISO and creates a vm using the
vSphere API to build on a remote VMWare machine.
layout: docs
page_title: VSphere ISO - Builders
sidebar_title: VSphere ISO
---
@ -19,8 +18,8 @@ starts from an ISO file and creates new VMs from scratch.
- VMware Player is not required.
- It uses the official vCenter API, and does not require ESXi host [modification](/docs/builders/vmware-iso#building-on-a-remote-vsphere-hypervisor)
- This builder is supported for vSphere version 6.5 and greater. Builds on lower
versions may work, but some configuration options may throw errors because they
do not exist in the older versions of the vSphere API.
versions may work, but some configuration options may throw errors because they
do not exist in the older versions of the vSphere API.
## Examples

View File

@ -2,7 +2,6 @@
description: |
The yandex Packer builder is able to create images for use with
Yandex.Cloud based on existing images.
layout: docs
page_title: Yandex Compute - Builders
sidebar_title: Yandex.Cloud
---
@ -130,7 +129,6 @@ In configuration directives the following variables are available:
- `SourceImageFamily` - The source image family (for example `ubuntu-1604-lts`).
- `SourceImageFolderID` - The folder ID where source image located (for example `standard-images`).
## Build Shared Information Variables
This builder generates data that are shared with provisioner and post-processor via build function of

View File

@ -4,7 +4,6 @@ description: |
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.
layout: docs
page_title: packer build - Commands
sidebar_title: <tt>build</tt>
---

View File

@ -2,7 +2,6 @@
description: |
The `packer console` command allows you to experiment with Packer variable
interpolations.
layout: docs
page_title: packer console - Commands
sidebar_title: <tt>console</tt>
---

View File

@ -4,7 +4,6 @@ description: |
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.
layout: docs
page_title: packer fix - Commands
sidebar_title: <tt>fix</tt>
---

View File

@ -2,7 +2,6 @@
description: |
The `packer fmt` Packer command is used to format HCL2
configuration files to a canonical format and style.
layout: docs
page_title: packer fmt - Commands
sidebar_title: <tt>fmt</tt>
---
@ -38,9 +37,9 @@ my-template.json
## Options
- `-check` - Checks if the input is formatted. Exit status will be 0 if all
input is properly formatted and non-zero otherwise.
input is properly formatted and non-zero otherwise.
- `-diff` - Display diffs of any formatting change
- `-write=false` - Don't write formatting changes to source files
(always disabled if using -check)
(always disabled if using -check)

View File

@ -3,7 +3,6 @@ description: |
The `packer hcl2_upgrade` Packer command is used to transpile a JSON
configuration template to it's formatted HCL2 counterpart. The command will
return a zero exit status on success, and a non-zero exit status on failure.
layout: docs
page_title: packer hcl2_upgrade - Commands
sidebar_title: <tt>hcl2_upgrade</tt>
---
@ -56,14 +55,15 @@ locals {
`hcl2_upgrade` will do its best to transform your go _template calls_ to HCL2,
here is the list of calls that should get transformed:
- ```{{ user `my_var` }}``` becomes ```${var.my_var}```.
- ```{{ env `my_var` }}``` becomes ```${var.my_var}```. Packer HCL2 supports
environment variables through input variables. See
[docs](http://packer.io/docs/from-1.5/variables#environment-variables)
for more info.
- ```{{ timestamp }}``` becomes ```${local.timestamp}```, the local variable
will be created for all generated files.
- ```{{ build `ID` }}``` becomes ```${build.ID}```.
- `` {{ user `my_var` }} `` becomes `${var.my_var}`.
- `` {{ env `my_var` }} `` becomes `${var.my_var}`. Packer HCL2 supports
environment variables through input variables. See
[docs](http://packer.io/docs/from-1.5/variables#environment-variables)
for more info.
- `{{ timestamp }}` becomes `${local.timestamp}`, the local variable
will be created for all generated files.
- `` {{ build `ID` }} `` becomes `${build.ID}`.
The rest of the calls should remain go template calls for now, this will be
improved over time.

View File

@ -5,7 +5,6 @@ description: |
`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 the actual command you wish to execute.
layout: docs
page_title: Commands
sidebar_title: Commands (CLI)
---

View File

@ -10,7 +10,6 @@ description: >
like what variables a template accepts, the builders it defines, the
provisioners it defines and the order they'll run, and more.
layout: docs
page_title: packer inspect - Commands
sidebar_title: <tt>inspect</tt>
---

View File

@ -4,7 +4,6 @@ description: |
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.
layout: docs
page_title: packer validate - Commands
sidebar_title: <tt>validate</tt>
---

View File

@ -2,7 +2,6 @@
description: |
Communicators are the mechanism Packer uses to upload files, execute
scripts, etc. with the machine being created.
layout: docs
page_title: Communicators
sidebar_title: Communicators
---

View File

@ -2,7 +2,6 @@
description: |
The SSH communicator uses SSH to upload files, execute scripts, etc. on
the machine being created.
layout: docs
page_title: Communicators - SSH
sidebar_title: SSH
---
@ -61,10 +60,9 @@ The SSH communicator has the following options:
@include "packer-plugin-sdk/communicator/SSH-not-required.mdx"
~> Note: SSH communicator options: `ssh_keypair_name`, `ssh_agent_auth`,
`temporary_key_pair_name` and `ssh_private_key_file` are also supported by
the communicator. But they may not be supported for every builder. Please check
the builder specific documentation for additional SSH supported options.
`temporary_key_pair_name` and `ssh_private_key_file` are also supported by
the communicator. But they may not be supported for every builder. Please check
the builder specific documentation for additional SSH supported options.
### SSH Communicator Details

View File

@ -2,7 +2,6 @@
description: |
Communicators are the mechanism Packer uses to upload files, execute scripts,
etc. with the machine being created.
layout: docs
page_title: Communicators - Templates
sidebar_title: WINRM
---

View File

@ -8,7 +8,6 @@ description: >
you generally don't have to worry about it until you want to tweak a
configuration.
layout: docs
page_title: Core Configuration - Other
sidebar_title: Core Configuration
---

View File

@ -3,7 +3,6 @@ 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.
layout: docs
page_title: Debugging - Other
sidebar_title: Debugging
---

View File

@ -1,6 +1,5 @@
---
description: Packer uses a variety of environmental variables.
layout: docs
page_title: Environment Variables - Other
sidebar_title: Environment Variables
---

View File

@ -2,7 +2,6 @@
description: |
It is possible to write custom builders using the Packer plugin interface, and
this page documents how to do that.
layout: docs
page_title: Custom Builders - Extending
sidebar_title: Custom Builders
---

View File

@ -4,7 +4,6 @@ description: >
artifact
into another, for example by compressing files, or uploading them.
layout: docs
page_title: Custom Post-Processors - Extending
sidebar_title: Custom Post-Processors
---

View File

@ -8,7 +8,6 @@ description: >
example of a provisioner is the shell provisioner, which runs shell scripts
within the machines.
layout: docs
page_title: Custom Provisioners - Extending
sidebar_title: Custom Provisioners
---

View File

@ -3,7 +3,6 @@ description: |
Packer is designed to be extensible. Because the surface area for workloads is
infinite, Packer supports plugins for builders, provisioners, and
post-processors.
layout: docs
page_title: Extending
sidebar_title: Extending Packer
---

View File

@ -3,7 +3,6 @@ description: |
Packer Plugins allow new functionality to be added to Packer without modifying
the core source code. Packer plugins are able to add new builders,
provisioners, hooks, and more.
layout: docs
page_title: Plugins - Extending
sidebar_title: Plugins
---

View File

@ -1,7 +1,6 @@
---
description: >
description: |
The source block defines what builders are started.
layout: docs
page_title: build - Blocks
sidebar_title: <tt>build</tt>
---

View File

@ -1,7 +1,6 @@
---
description: >
description: |
The post-processor block defines how a post-processor is configured.
layout: docs
page_title: post-processor - build - Blocks
sidebar_title: <tt>post-processor</tt>
---
@ -90,6 +89,6 @@ about and see some examples of how to use them.
### Related
* The [`post-processors` block](/docs/from-1.5/blocks/build/post-processor)
- The [`post-processors` block](/docs/from-1.5/blocks/build/post-processor)
allows to define one or more chain of `post-processor`s that will take the
output from the build and provision steps.

View File

@ -2,7 +2,6 @@
description: >
The post-processors block allows to define lists of post-processors to apply
to an artifact.
layout: docs
page_title: post-processors - build - Blocks
sidebar_title: <tt>post-processors</tt>
---
@ -31,7 +30,7 @@ build {
keep_input_artifact = true # keep the artifact
}
}
}
```

View File

@ -1,7 +1,6 @@
---
description: >
description: |
The provisioner block defines how a provisioner is configured.
layout: docs
page_title: provisioner - build - Blocks
sidebar_title: <tt>provisioner</tt>
---

View File

@ -2,7 +2,6 @@
description: >
A source block nested in a build block allows you to use an already defined
source and to set specific fields.
layout: docs
page_title: source - build - Blocks
sidebar_title: <tt>source</tt>
---

View File

@ -1,9 +1,7 @@
---
layout: docs
page_title: Blocks - Configuration Language
sidebar_title: Blocks
description: |-
The HCL language has a number of blocks that can be used to configure builds.
description: The HCL language has a number of blocks that can be used to configure builds.
---
# Built-in Blocks

View File

@ -2,7 +2,6 @@
description: >
The locals block also called the local-variable block defines locals within
your Packer configuration.
layout: docs
page_title: locals - Blocks
sidebar_title: <tt>locals</tt>
---

View File

@ -1,5 +1,4 @@
---
layout: docs
page_title: packer - Blocks
sidebar_title: <tt>packer</tt>
description: |-
@ -14,7 +13,7 @@ description: |-
-> **Note:** The Packer block is only available in Packer v1.6.5 and later.
The `packer` configuration block type is used to configure some
behaviors of Packer itself, such as the minimum required Packer version needed to
behaviors of Packer itself, such as the minimum required Packer version needed to
apply your configuration.
## Packer Block Syntax
@ -48,7 +47,6 @@ Use Packer version constraints in a collaborative environment to
ensure that everyone is using a specific Packer version, or using at least
a minimum Packer version that has behavior expected by the configuration.
## Version Constraints
Anywhere that Packer lets you specify a range of acceptable versions for

View File

@ -1,7 +1,6 @@
---
description: >
description: |
The top-level source block defines reusable builder configuration blocks
layout: docs
page_title: source - Blocks
sidebar_title: <tt>source</tt>
---

View File

@ -2,7 +2,6 @@
description: >
The variable block, also called the input-variable block, defines variables
within your Packer configuration.
layout: docs
page_title: variable - Blocks
sidebar_title: <tt>variable</tt>
---

View File

@ -1,9 +1,10 @@
---
layout: docs
page_title: Contextual Variables - HCL Configuration Language
sidebar_title: Contextual Variables
description: |-
Special variables provide connection information and basic instance state information.
description: >-
Special variables provide connection information and basic instance state
information.
This page covers all existing special variables.
---
@ -86,7 +87,6 @@ For builder-specific builder variables, please also refer to the builder docs:
The HCL2 Special Build Variables is in beta; please report any issues or requests on the Packer
issue tracker on GitHub.
# Packer Version
This variable is set to the Packer version currently running.

View File

@ -1,5 +1,4 @@
---
layout: docs
page_title: Expressions - Configuration Language
sidebar_title: Expressions
description: |-

View File

@ -1,5 +1,4 @@
---
layout: docs
page_title: chunklist - Functions - Configuration Language
sidebar_title: chunklist
description: |-

View File

@ -1,5 +1,4 @@
---
layout: docs
page_title: coalesce - Functions - Configuration Language
sidebar_title: coalesce
description: |-

View File

@ -1,5 +1,4 @@
---
layout: docs
page_title: coalescelist - Functions - Configuration Language
sidebar_title: coalescelist
description: |-

Some files were not shown because too many files have changed in this diff Show More