iSharkFly-Docs
/
packer-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

were rendering yay

This commit is contained in:
Jeff Escalante 2020-03-23 20:02:12 -04:00
parent 92d4553890
commit bcc848a83d
No known key found for this signature in database
GPG Key ID: 32D23C61AB5450DB
291 changed files with 487 additions and 524 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
builder/amazon/chroot/builder.go
View File

@ -48,11 +48,11 @@ type Config struct {
// in the Chroot Mounts section. Please read that section for more // in the Chroot Mounts section. Please read that section for more
// information on how to use this. // information on how to use this.
ChrootMounts [][]string `mapstructure:"chroot_mounts" required:"false"` ChrootMounts [][]string `mapstructure:"chroot_mounts" required:"false"`
// How to run shell commands. This defaults to {{.Command}}. This may be // How to run shell commands. This defaults to `{{.Command}}``. This may be
// useful to set if you want to set environmental variables or perhaps run // useful to set if you want to set environmental variables or perhaps run
// it with sudo or so on. This is a configuration template where the // it with sudo or so on. This is a configuration template where the
// .Command variable is replaced with the command to be run. Defaults to // .Command variable is replaced with the command to be run. Defaults to
// {{.Command}}. // `{{.Command}}``.
CommandWrapper string `mapstructure:"command_wrapper" required:"false"` CommandWrapper string `mapstructure:"command_wrapper" required:"false"`
// Paths to files on the running EC2 instance that will be copied into the // Paths to files on the running EC2 instance that will be copied into the
// chroot environment prior to provisioning. Defaults to /etc/resolv.conf // chroot environment prior to provisioning. Defaults to /etc/resolv.conf
@ -90,18 +90,18 @@ type Config struct {
MountPartition string `mapstructure:"mount_partition" required:"false"` MountPartition string `mapstructure:"mount_partition" required:"false"`
// The path where the volume will be mounted. This is where the chroot // The path where the volume will be mounted. This is where the chroot
// environment will be. This defaults to // environment will be. This defaults to
// /mnt/packer-amazon-chroot-volumes/{{.Device}}. This is a configuration // `/mnt/packer-amazon-chroot-volumes/{{.Device}}``. This is a configuration
// template where the .Device variable is replaced with the name of the // template where the .Device variable is replaced with the name of the
// device where the volume is attached. // device where the volume is attached.
MountPath string `mapstructure:"mount_path" required:"false"` MountPath string `mapstructure:"mount_path" required:"false"`
// As pre_mount_commands, but the commands are executed after mounting the // As pre_mount_commands, but the commands are executed after mounting the
// root device and before the extra mount and copy steps. The device and // root device and before the extra mount and copy steps. The device and
// mount path are provided by {{.Device}} and {{.MountPath}}. // mount path are provided by `{{.Device}}`` and `{{.MountPath}}``.
PostMountCommands []string `mapstructure:"post_mount_commands" required:"false"` PostMountCommands []string `mapstructure:"post_mount_commands" required:"false"`
// A series of commands to execute after attaching the root volume and // A series of commands to execute after attaching the root volume and
// before mounting the chroot. This is not required unless using // before mounting the chroot. This is not required unless using
// from_scratch. If so, this should include any partitioning and filesystem // from_scratch. If so, this should include any partitioning and filesystem
// creation commands. The path to the device is provided by {{.Device}}. // creation commands. The path to the device is provided by `{{.Device}}``.
PreMountCommands []string `mapstructure:"pre_mount_commands" required:"false"` PreMountCommands []string `mapstructure:"pre_mount_commands" required:"false"`
// The root device name. For example, xvda. // The root device name. For example, xvda.
RootDeviceName string `mapstructure:"root_device_name" required:"false"` RootDeviceName string `mapstructure:"root_device_name" required:"false"`

2
builder/amazon/instance/builder.go
View File

@ -61,7 +61,7 @@ type Config struct {
// exist and be writable. // exist and be writable.
BundleDestination string `mapstructure:"bundle_destination" required:"false"` BundleDestination string `mapstructure:"bundle_destination" required:"false"`
// The prefix for files created from bundling the root volume. By default // The prefix for files created from bundling the root volume. By default
// this is image-{{timestamp}}. The timestamp variable should be used to // this is `image-{{timestamp}}``. The timestamp variable should be used to
// make sure this is unique, otherwise it can collide with other created // make sure this is unique, otherwise it can collide with other created
// AMIs by Packer in your account. // AMIs by Packer in your account.
BundlePrefix string `mapstructure:"bundle_prefix" required:"false"` BundlePrefix string `mapstructure:"bundle_prefix" required:"false"`

2
builder/cloudstack/config.go
View File

@ -134,7 +134,7 @@ type Config struct {
// created. // created.
Zone string `mapstructure:"zone" required:"true"` Zone string `mapstructure:"zone" required:"true"`
// The name of the new template. Defaults to // The name of the new template. Defaults to
// "packer-{{timestamp}}" where timestamp will be the current time. // `packer-{{timestamp}}` where timestamp will be the current time.
TemplateName string `mapstructure:"template_name" required:"false"` TemplateName string `mapstructure:"template_name" required:"false"`
// The display text of the new template. // The display text of the new template.
// Defaults to the template_name. // Defaults to the template_name.

2
builder/digitalocean/config.go
View File

@ -55,7 +55,7 @@ type Config struct {
// created. This defaults to false, or not enabled. // created. This defaults to false, or not enabled.
IPv6 bool `mapstructure:"ipv6" required:"false"` IPv6 bool `mapstructure:"ipv6" required:"false"`
// The name of the resulting snapshot that will // The name of the resulting snapshot that will
// appear in your account. Defaults to "packer-{{timestamp}}" (see // appear in your account. Defaults to `packer-{{timestamp}}` (see
// configuration templates for more info). // configuration templates for more info).
SnapshotName string `mapstructure:"snapshot_name" required:"false"` SnapshotName string `mapstructure:"snapshot_name" required:"false"`
// The regions of the resulting // The regions of the resulting

8
builder/docker/config.go
View File

@ -63,10 +63,10 @@ type Config struct {
// used. This defaults to true if not set. // used. This defaults to true if not set.
Pull bool `mapstructure:"pull" required:"false"` Pull bool `mapstructure:"pull" required:"false"`
// An array of arguments to pass to docker run in order to run the // An array of arguments to pass to docker run in order to run the
// container. By default this is set to ["-d", "-i", "-t", // container. By default this is set to `["-d", "-i", "-t",
// "--entrypoint=/bin/sh", "--", "{{.Image}}"] if you are using a linux // "--entrypoint=/bin/sh", "--", "{{.Image}}"]` if you are using a linux
// container, and ["-d", "-i", "-t", "--entrypoint=powershell", "--", // container, and `["-d", "-i", "-t", "--entrypoint=powershell", "--",
// "{{.Image}}"] if you are running a windows container. {{.Image}} is a // "{{.Image}}"]` if you are running a windows container. `{{.Image}}` is a
// template variable that corresponds to the image template option. Passing // template variable that corresponds to the image template option. Passing
// the entrypoint option this way will make it the default entrypoint of // the entrypoint option this way will make it the default entrypoint of
// the resulting image, so running docker run -it --rm will start the // the resulting image, so running docker run -it --rm will start the

4
builder/googlecompute/config.go
View File

@ -58,7 +58,7 @@ type Config struct {
// Defaults to pd-standard. // Defaults to pd-standard.
DiskType string `mapstructure:"disk_type" required:"false"` DiskType string `mapstructure:"disk_type" required:"false"`
// The unique name of the resulting image. Defaults to // The unique name of the resulting image. Defaults to
// "packer-{{timestamp}}". // `packer-{{timestamp}}`.
ImageName string `mapstructure:"image_name" required:"false"` ImageName string `mapstructure:"image_name" required:"false"`
// The description of the resulting image. // The description of the resulting image.
ImageDescription string `mapstructure:"image_description" required:"false"` ImageDescription string `mapstructure:"image_description" required:"false"`
@ -84,7 +84,7 @@ type Config struct {
// Licenses to apply to the created image. // Licenses to apply to the created image.
ImageLicenses []string `mapstructure:"image_licenses" required:"false"` ImageLicenses []string `mapstructure:"image_licenses" required:"false"`
// A name to give the launched instance. Beware that this must be unique. // A name to give the launched instance. Beware that this must be unique.
// Defaults to "packer-{{uuid}}". // Defaults to `packer-{{uuid}}`.
InstanceName string `mapstructure:"instance_name" required:"false"` InstanceName string `mapstructure:"instance_name" required:"false"`
// Key/value pair labels to apply to the launched instance. // Key/value pair labels to apply to the launched instance.
Labels map[string]string `mapstructure:"labels" required:"false"` Labels map[string]string `mapstructure:"labels" required:"false"`

10
builder/hyperone/config.go
View File

@ -56,7 +56,7 @@ type Config struct {
// ID or name of the image to launch server from. // ID or name of the image to launch server from.
SourceImage string `mapstructure:"source_image" required:"true"` SourceImage string `mapstructure:"source_image" required:"true"`
// The name of the resulting image. Defaults to // The name of the resulting image. Defaults to
// "packer-{{timestamp}}" // `packer-{{timestamp}}`
// (see configuration templates for more info). // (see configuration templates for more info).
ImageName string `mapstructure:"image_name" required:"false"` ImageName string `mapstructure:"image_name" required:"false"`
// The description of the resulting image. // The description of the resulting image.
@ -107,11 +107,11 @@ type Config struct {
ChrootMountPath string `mapstructure:"chroot_mount_path"` ChrootMountPath string `mapstructure:"chroot_mount_path"`
ChrootMounts [][]string `mapstructure:"chroot_mounts"` ChrootMounts [][]string `mapstructure:"chroot_mounts"`
ChrootCopyFiles []string `mapstructure:"chroot_copy_files"` ChrootCopyFiles []string `mapstructure:"chroot_copy_files"`
// How to run shell commands. This defaults to {{.Command}}. This may be // How to run shell commands. This defaults to `{{.Command}}`. This may be
// useful to set if you want to set environmental variables or perhaps run // useful to set if you want to set environmental variables or perhaps run
// it with sudo or so on. This is a configuration template where the // it with sudo or so on. This is a configuration template where the
// .Command variable is replaced with the command to be run. Defaults to // .Command variable is replaced with the command to be run. Defaults to
// {{.Command}}. // `{{.Command}}`.
ChrootCommandWrapper string `mapstructure:"chroot_command_wrapper"` ChrootCommandWrapper string `mapstructure:"chroot_command_wrapper"`
MountOptions []string `mapstructure:"mount_options"` MountOptions []string `mapstructure:"mount_options"`
@ -119,11 +119,11 @@ type Config struct {
// A series of commands to execute after attaching the root volume and // A series of commands to execute after attaching the root volume and
// before mounting the chroot. This is not required unless using // before mounting the chroot. This is not required unless using
// from_scratch. If so, this should include any partitioning and filesystem // from_scratch. If so, this should include any partitioning and filesystem
// creation commands. The path to the device is provided by {{.Device}}. // creation commands. The path to the device is provided by `{{.Device}}`.
PreMountCommands []string `mapstructure:"pre_mount_commands"` PreMountCommands []string `mapstructure:"pre_mount_commands"`
// As pre_mount_commands, but the commands are executed after mounting the // As pre_mount_commands, but the commands are executed after mounting the
// root device and before the extra mount and copy steps. The device and // root device and before the extra mount and copy steps. The device and
// mount path are provided by {{.Device}} and {{.MountPath}}. // mount path are provided by `{{.Device}}` and `{{.MountPath}}`.
PostMountCommands []string `mapstructure:"post_mount_commands"` PostMountCommands []string `mapstructure:"post_mount_commands"`
// List of SSH keys by name or id to be added // List of SSH keys by name or id to be added
// to the server on launch. // to the server on launch.

2
builder/lxd/config.go
View File

@ -20,7 +20,7 @@ type Config struct {
OutputImage string `mapstructure:"output_image" required:"false"` OutputImage string `mapstructure:"output_image" required:"false"`
ContainerName string `mapstructure:"container_name"` ContainerName string `mapstructure:"container_name"`
// Lets you prefix all builder commands, such as // Lets you prefix all builder commands, such as
// with ssh for a remote build host. Defaults to "{{.Command}}"; i.e. no // with ssh for a remote build host. Defaults to `{{.Command}}`; i.e. no
// wrapper. // wrapper.
CommandWrapper string `mapstructure:"command_wrapper" required:"false"` CommandWrapper string `mapstructure:"command_wrapper" required:"false"`
// The source image to use when creating the build // The source image to use when creating the build

2
builder/parallels/common/tools_config.go
View File

@ -29,7 +29,7 @@ type ToolsConfig struct {
// is "upload". This is a configuration // is "upload". This is a configuration
// template that has a single // template that has a single
// valid variable: Flavor, which will be the value of // valid variable: Flavor, which will be the value of
// parallels_tools_flavor. By default this is "prl-tools-{{.Flavor}}.iso" // parallels_tools_flavor. By default this is `prl-tools-{{.Flavor}}.iso`
// which should upload into the login directory of the user. // which should upload into the login directory of the user.
ParallelsToolsGuestPath string `mapstructure:"parallels_tools_guest_path" required:"false"` ParallelsToolsGuestPath string `mapstructure:"parallels_tools_guest_path" required:"false"`
// The method by which Parallels Tools are // The method by which Parallels Tools are

2
builder/parallels/iso/builder.go
View File

@ -65,7 +65,7 @@ type Config struct {
HardDriveInterface string `mapstructure:"hard_drive_interface" required:"false"` HardDriveInterface string `mapstructure:"hard_drive_interface" required:"false"`
// A list of which interfaces on the // A list of which interfaces on the
// host should be searched for a IP address. The first IP address found on one // host should be searched for a IP address. The first IP address found on one
// of these will be used as {{ .HTTPIP }} in the boot_command. Defaults to // of these will be used as `{{ .HTTPIP }}` in the boot_command. Defaults to
// ["en0", "en1", "en2", "en3", "en4", "en5", "en6", "en7", "en8", "en9", // ["en0", "en1", "en2", "en3", "en4", "en5", "en6", "en7", "en8", "en9",
// "ppp0", "ppp1", "ppp2"]. // "ppp0", "ppp1", "ppp2"].
HostInterfaces []string `mapstructure:"host_interfaces" required:"false"` HostInterfaces []string `mapstructure:"host_interfaces" required:"false"`

2
builder/vagrant/builder.go
View File

@ -90,7 +90,7 @@ type Config struct {
BoxVersion string `mapstructure:"box_version" required:"false"` BoxVersion string `mapstructure:"box_version" required:"false"`
// a path to a golang template for a vagrantfile. Our default template can // a path to a golang template for a vagrantfile. Our default template can
// be found here. The template variables available to you are // be found here. The template variables available to you are
// {{ .BoxName }}, {{ .SyncedFolder }}, and {{.InsertKey}}, which // `{{ .BoxName }}`, `{{ .SyncedFolder }}`, and `{{.InsertKey}}`, which
// correspond to the Packer options box_name, synced_folder, and insert_key. // correspond to the Packer options box_name, synced_folder, and insert_key.
Template string `mapstructure:"template" required:"false"` Template string `mapstructure:"template" required:"false"`

1
website/layouts/docs.jsx
View File

@ -6,7 +6,6 @@ import Link from 'next/link'
function DocsLayoutWrapper(pageMeta) { function DocsLayoutWrapper(pageMeta) {
function DocsLayout(props) { function DocsLayout(props) {
console.log(props)
return ( return (
<DocsPage <DocsPage
{...props} {...props}

4
website/pages/community-tools/index.mdx
View File

@ -25,9 +25,9 @@ If you have built a plugin and would like to add it to this community list,
please make a pull request to the website so that we can document your please make a pull request to the website so that we can document your
contribution here! contribution here!
@include "builders/community_builders" @include "builders/community_builders.mdx"
@include "provisioners/community_provisioners" @include "provisioners/community_provisioners.mdx"
## Templates ## Templates

18
website/pages/docs/builders/alicloud-ecs.mdx
View File

@ -23,16 +23,16 @@ builder.
### Required: ### Required:
@include 'partials/builder/alicloud/ecs/RunConfig-required.mdx' @include 'builder/alicloud/ecs/RunConfig-required.mdx'
@include 'partials/builder/alicloud/ecs/AlicloudImageConfig-required.mdx' @include 'builder/alicloud/ecs/AlicloudImageConfig-required.mdx'
### Optional: ### Optional:
@include 'partials/builder/alicloud/ecs/AlicloudAccessConfig-not-required.mdx' @include 'builder/alicloud/ecs/AlicloudAccessConfig-not-required.mdx'
@include 'partials/builder/alicloud/ecs/AlicloudDiskDevice-not-required.mdx' @include 'builder/alicloud/ecs/AlicloudDiskDevice-not-required.mdx'
@include 'partials/builder/alicloud/ecs/AlicloudDiskDevices-not-required.mdx' @include 'builder/alicloud/ecs/AlicloudDiskDevices-not-required.mdx'
@include 'partials/builder/alicloud/ecs/RunConfig-not-required.mdx' @include 'builder/alicloud/ecs/RunConfig-not-required.mdx'
@include 'partials/builder/alicloud/ecs/AlicloudImageConfig-not-required.mdx' @include 'builder/alicloud/ecs/AlicloudImageConfig-not-required.mdx'
- `temporary_key_pair_name` (string) - The name of the temporary key pair to - `temporary_key_pair_name` (string) - The name of the temporary key pair to
generate. By default, Packer generates a name that looks like generate. By default, Packer generates a name that looks like
@ -72,10 +72,10 @@ Here is a basic example for Alicloud.
} }
``` ```
\~&gt; Note: Images can become deprecated after a while; run ~> Note: Images can become deprecated after a while; run
`aliyun ecs DescribeImages` to find one that exists. `aliyun ecs DescribeImages` to find one that exists.
\~&gt; Note: Since WinRM is closed by default in the system image. If you are ~> Note: Since WinRM is closed by default in the system image. If you are
planning to use Windows as the base image, you need enable it by userdata in planning to use Windows as the base image, you need enable it by userdata in
order to connect to the instance, check order to connect to the instance, check
[alicloud_windows.json](https://github.com/hashicorp/packer/tree/master/examples/alicloud/basic/alicloud_windows.json) [alicloud_windows.json](https://github.com/hashicorp/packer/tree/master/examples/alicloud/basic/alicloud_windows.json)

18
website/pages/docs/builders/amazon-chroot.mdx
View File

@ -28,7 +28,7 @@ builder is able to build an EBS-backed AMI without launching a new EC2
instance. This can dramatically speed up AMI builds for organizations who need instance. This can dramatically speed up AMI builds for organizations who need
the extra fast build. the extra fast build.
\~&gt; **This is an advanced builder** If you're just getting started with ~> **This is an advanced builder** If you're just getting started with
Packer, we recommend starting with the [amazon-ebs Packer, we recommend starting with the [amazon-ebs
builder](/docs/builders/amazon-ebs.html), which is much easier to use. builder](/docs/builders/amazon-ebs.html), which is much easier to use.
@ -64,11 +64,11 @@ necessary for this build to succeed and can be found further down the page.
#### Required: #### Required:
@include 'partials/builder/amazon/chroot/Config-required.mdx' @include 'builder/amazon/chroot/Config-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/chroot/Config-not-required.mdx' @include 'builder/amazon/chroot/Config-not-required.mdx'
## General Common Configuration Reference ## General Common Configuration Reference
@ -79,32 +79,32 @@ builders.
#### Required: #### Required:
@include 'partials/builder/amazon/common/AMIConfig-required.mdx' @include 'builder/amazon/common/AMIConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/AMIConfig-not-required.mdx' @include 'builder/amazon/common/AMIConfig-not-required.mdx'
### Block Devices Configuration ### Block Devices Configuration
Block devices can be nested in the Block devices can be nested in the
[ami_block_device_mappings](#ami_block_device_mappings) array. [ami_block_device_mappings](#ami_block_device_mappings) array.
@include 'partials/builder/amazon/common/BlockDevice.mdx' @include 'builder/amazon/common/BlockDevice.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/BlockDevice-not-required.mdx' @include 'builder/amazon/common/BlockDevice-not-required.mdx'
### Access Config Configuration ### Access Config Configuration
#### Required: #### Required:
@include 'partials/builder/amazon/common/AccessConfig-required.mdx' @include 'builder/amazon/common/AccessConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/AccessConfig-not-required.mdx' @include 'builder/amazon/common/AccessConfig-not-required.mdx'
## Basic Example ## Basic Example

30
website/pages/docs/builders/amazon-ebs.mdx
View File

@ -29,7 +29,7 @@ a bit.
The builder does _not_ manage AMIs. Once it creates an AMI and stores it in The builder does _not_ manage AMIs. Once it creates an AMI and stores it in
your account, it is up to you to use, delete, etc. the AMI. your account, it is up to you to use, delete, etc. the AMI.
-&gt; **Note:** Temporary resources are, by default, all created with the -> **Note:** Temporary resources are, by default, all created with the
prefix `packer`. This can be useful if you want to restrict the security groups prefix `packer`. This can be useful if you want to restrict the security groups
and key pairs Packer is able to operate on. and key pairs Packer is able to operate on.
@ -47,37 +47,37 @@ necessary for this build to succeed and can be found further down the page.
#### Optional: #### Optional:
@include 'partials/builder/amazon/ebs/Config-not-required.mdx' @include 'builder/amazon/ebs/Config-not-required.mdx'
### AMI Configuration ### AMI Configuration
#### Required: #### Required:
@include 'partials/builder/amazon/common/AMIConfig-required.mdx' @include 'builder/amazon/common/AMIConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/AMIConfig-not-required.mdx' @include 'builder/amazon/common/AMIConfig-not-required.mdx'
### Access Configuration ### Access Configuration
#### Required: #### Required:
@include 'partials/builder/amazon/common/AccessConfig-required.mdx' @include 'builder/amazon/common/AccessConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/AccessConfig-not-required.mdx' @include 'builder/amazon/common/AccessConfig-not-required.mdx'
### Run Configuration ### Run Configuration
#### Required: #### Required:
@include 'partials/builder/amazon/common/RunConfig-required.mdx' @include 'builder/amazon/common/RunConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/RunConfig-not-required.mdx' @include 'builder/amazon/common/RunConfig-not-required.mdx'
### Block Devices Configuration ### Block Devices Configuration
@ -85,18 +85,18 @@ Block devices can be nested in the
[ami_block_device_mappings](#ami_block_device_mappings) or the [ami_block_device_mappings](#ami_block_device_mappings) or the
[launch_block_device_mappings](#launch_block_device_mappings) array. [launch_block_device_mappings](#launch_block_device_mappings) array.
@include 'partials/builder/amazon/common/BlockDevice.mdx' @include 'builder/amazon/common/BlockDevice.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/BlockDevice-not-required.mdx' @include 'builder/amazon/common/BlockDevice-not-required.mdx'
### Communicator Configuration ### Communicator Configuration
#### Optional: #### Optional:
@include 'partials/helper/communicator/Config-not-required.mdx' @include 'helper/communicator/Config-not-required.mdx'
@include 'partials/helper/communicator/SSH-not-required.mdx' @include 'helper/communicator/SSH-not-required.mdx'
## Basic Example ## Basic Example
@ -125,7 +125,7 @@ run:
} }
``` ```
-&gt; **Note:** Packer can also read the access key and secret access key from -> **Note:** Packer can also read the access key and secret access key from
environmental variables. See the configuration reference in the section above environmental variables. See the configuration reference in the section above
for more information on what environmental variables Packer will look for. for more information on what environmental variables Packer will look for.
@ -232,7 +232,7 @@ what images exist when this template is run:
} }
``` ```
-&gt; **Note:** Packer uses pre-built AMIs as the source for building images. -> **Note:** Packer uses pre-built AMIs as the source for building images.
These source AMIs may include volumes that are not flagged to be destroyed on These source AMIs may include volumes that are not flagged to be destroyed on
termination of the instance building the new image. Packer will attempt to termination of the instance building the new image. Packer will attempt to
clean up all residual volumes that are not designated by the user to remain clean up all residual volumes that are not designated by the user to remain
@ -349,4 +349,4 @@ be easily added to the provisioner section.
} }
``` ```
@include 'partials/builders/aws-ssh-differentiation-table.mdx' @include 'builders/aws-ssh-differentiation-table.mdx'

32
website/pages/docs/builders/amazon-ebssurrogate.mdx
View File

@ -39,63 +39,63 @@ necessary for this build to succeed and can be found further down the page.
### Required: ### Required:
@include 'partials/builder/amazon/ebssurrogate/Config-required.mdx' @include 'builder/amazon/ebssurrogate/Config-required.mdx'
### Optional: ### Optional:
@include 'partials/builder/amazon/ebssurrogate/Config-not-required.mdx' @include 'builder/amazon/ebssurrogate/Config-not-required.mdx'
### AMI Configuration ### AMI Configuration
#### Required: #### Required:
@include 'partials/builder/amazon/common/AMIConfig-required.mdx' @include 'builder/amazon/common/AMIConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/AMIConfig-not-required.mdx' @include 'builder/amazon/common/AMIConfig-not-required.mdx'
### Access Configuration ### Access Configuration
#### Required: #### Required:
@include 'partials/builder/amazon/common/AccessConfig-required.mdx' @include 'builder/amazon/common/AccessConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/AccessConfig-not-required.mdx' @include 'builder/amazon/common/AccessConfig-not-required.mdx'
### Run Configuration ### Run Configuration
#### Required: #### Required:
@include 'partials/builder/amazon/common/RunConfig-required.mdx' @include 'builder/amazon/common/RunConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/RunConfig-not-required.mdx' @include 'builder/amazon/common/RunConfig-not-required.mdx'
### Block Devices Configuration ### Block Devices Configuration
Block devices can be nested in the Block devices can be nested in the
[ami_block_device_mappings](#ami_block_device_mappings) array. [ami_block_device_mappings](#ami_block_device_mappings) array.
@include 'partials/builder/amazon/common/BlockDevice.mdx' @include 'builder/amazon/common/BlockDevice.mdx'
#### Optional only for [launch_block_device_mappings](#launch_block_device_mappings) #### Optional only for [launch_block_device_mappings](#launch_block_device_mappings)
@include 'partials/builder/amazon/ebssurrogate/BlockDevice-not-required.mdx' @include 'builder/amazon/ebssurrogate/BlockDevice-not-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/BlockDevice-not-required.mdx' @include 'builder/amazon/common/BlockDevice-not-required.mdx'
### Communicator Configuration ### Communicator Configuration
#### Optional: #### Optional:
@include 'partials/helper/communicator/Config-not-required.mdx' @include 'helper/communicator/Config-not-required.mdx'
@include 'partials/helper/communicator/SSH-not-required.mdx' @include 'helper/communicator/SSH-not-required.mdx'
## Basic Example ## Basic Example
@ -126,7 +126,7 @@ Block devices can be nested in the
} }
``` ```
-&gt; **Note:** Packer can also read the access key and secret access key from -> **Note:** Packer can also read the access key and secret access key from
environmental variables. See the configuration reference in the section above environmental variables. See the configuration reference in the section above
for more information on what environmental variables Packer will look for. for more information on what environmental variables Packer will look for.
@ -168,10 +168,10 @@ variables are available:
`ubuntu/images/ebs-ssd/ubuntu-xenial-16.04-amd64-server-20180306`) used to `ubuntu/images/ebs-ssd/ubuntu-xenial-16.04-amd64-server-20180306`) used to
build the AMI. build the AMI.
-&gt; **Note:** Packer uses pre-built AMIs as the source for building images. -> **Note:** Packer uses pre-built AMIs as the source for building images.
These source AMIs may include volumes that are not flagged to be destroyed on These source AMIs may include volumes that are not flagged to be destroyed on
termination of the instance building the new image. In addition to those termination of the instance building the new image. In addition to those
volumes created by this builder, any volumes in the source AMI which are not volumes created by this builder, any volumes in the source AMI which are not
marked for deletion on termination will remain in your account. marked for deletion on termination will remain in your account.
@include 'partials/builders/aws-ssh-differentiation-table.mdx' @include 'builders/aws-ssh-differentiation-table.mdx'

28
website/pages/docs/builders/amazon-ebsvolume.mdx
View File

@ -27,7 +27,7 @@ instance while the image is being created.
The builder does _not_ manage EBS Volumes. Once it creates volumes and stores The builder does _not_ manage EBS Volumes. Once it creates volumes and stores
it in your account, it is up to you to use, delete, etc. the volumes. it in your account, it is up to you to use, delete, etc. the volumes.
-&gt; **Note:** Temporary resources are, by default, all created with the -> **Note:** Temporary resources are, by default, all created with the
prefix `packer`. This can be useful if you want to restrict the security groups prefix `packer`. This can be useful if you want to restrict the security groups
and key pairs Packer is able to operate on. and key pairs Packer is able to operate on.
@ -45,17 +45,17 @@ necessary for this build to succeed and can be found further down the page.
### Optional: ### Optional:
@include 'partials/builder/amazon/ebsvolume/Config-not-required.mdx' @include 'builder/amazon/ebsvolume/Config-not-required.mdx'
### Access Configuration ### Access Configuration
#### Required: #### Required:
@include 'partials/builder/amazon/common/AccessConfig-required.mdx' @include 'builder/amazon/common/AccessConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/AccessConfig-not-required.mdx' @include 'builder/amazon/common/AccessConfig-not-required.mdx'
### AMI Configuration ### AMI Configuration
@ -76,29 +76,29 @@ necessary for this build to succeed and can be found further down the page.
Block devices can be nested in the Block devices can be nested in the
[ebs_volumes](#ebs_volumes) array. [ebs_volumes](#ebs_volumes) array.
@include 'partials/builder/amazon/common/BlockDevice.mdx' @include 'builder/amazon/common/BlockDevice.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/BlockDevice-not-required.mdx' @include 'builder/amazon/common/BlockDevice-not-required.mdx'
@include 'partials/builder/amazon/ebsvolume/BlockDevice-not-required.mdx' @include 'builder/amazon/ebsvolume/BlockDevice-not-required.mdx'
### Run Configuration ### Run Configuration
#### Required: #### Required:
@include 'partials/builder/amazon/common/RunConfig-required.mdx' @include 'builder/amazon/common/RunConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/RunConfig-not-required.mdx' @include 'builder/amazon/common/RunConfig-not-required.mdx'
### Communicator Configuration ### Communicator Configuration
#### Optional: #### Optional:
@include 'partials/helper/communicator/Config-not-required.mdx' @include 'helper/communicator/Config-not-required.mdx'
@include 'partials/helper/communicator/SSH-not-required.mdx' @include 'helper/communicator/SSH-not-required.mdx'
## Basic Example ## Basic Example
@ -146,7 +146,7 @@ Block devices can be nested in the
} }
``` ```
-&gt; **Note:** Packer can also read the access key and secret access key from -> **Note:** Packer can also read the access key and secret access key from
environmental variables. See the configuration reference in the section above environmental variables. See the configuration reference in the section above
for more information on what environmental variables Packer will look for. for more information on what environmental variables Packer will look for.
@ -179,7 +179,7 @@ variables are available:
- `SourceAMIOwnerName` - The source AMI owner alias/name (for example `amazon`). - `SourceAMIOwnerName` - The source AMI owner alias/name (for example `amazon`).
- `SourceAMITags` - The source AMI Tags, as a `map[string]string` object. - `SourceAMITags` - The source AMI Tags, as a `map[string]string` object.
-&gt; **Note:** Packer uses pre-built AMIs as the source for building images. -> **Note:** Packer uses pre-built AMIs as the source for building images.
These source AMIs may include volumes that are not flagged to be destroyed on These source AMIs may include volumes that are not flagged to be destroyed on
termination of the instance building the new image. In addition to those termination of the instance building the new image. In addition to those
volumes created by this builder, any volumes in the source AMI which are not volumes created by this builder, any volumes in the source AMI which are not
@ -194,4 +194,4 @@ variables are available:
`ubuntu/images/ebs-ssd/ubuntu-xenial-16.04-amd64-server-20180306`) used to `ubuntu/images/ebs-ssd/ubuntu-xenial-16.04-amd64-server-20180306`) used to
build the AMI. build the AMI.
@include 'partials/builders/aws-ssh-differentiation-table.mdx' @include 'builders/aws-ssh-differentiation-table.mdx'

36
website/pages/docs/builders/amazon-instance.mdx
View File

@ -33,16 +33,16 @@ being created. This simplifies configuration quite a bit.
This builder does _not_ manage AMIs. Once it creates an AMI and stores it in This builder does _not_ manage AMIs. Once it creates an AMI and stores it in
your account, it is up to you to use, delete, etc. the AMI. your account, it is up to you to use, delete, etc. the AMI.
-&gt; **Note:** Temporary resources are, by default, all created with the -> **Note:** Temporary resources are, by default, all created with the
prefix `packer`. This can be useful if you want to restrict the security groups prefix `packer`. This can be useful if you want to restrict the security groups
and key pairs packer is able to operate on. and key pairs packer is able to operate on.
-&gt; **Note:** This builder requires that the [Amazon EC2 AMI -> **Note:** This builder requires that the [Amazon EC2 AMI
Tools](https://aws.amazon.com/developertools/368) are installed onto the Tools](https://aws.amazon.com/developertools/368) are installed onto the
machine. This can be done within a provisioner, but must be done before the machine. This can be done within a provisioner, but must be done before the
builder finishes running. builder finishes running.
\~&gt; Instance builds are not supported for Windows. Use ~> Instance builds are not supported for Windows. Use
[`amazon-ebs`](amazon-ebs.html) instead. [`amazon-ebs`](amazon-ebs.html) instead.
## Configuration Reference ## Configuration Reference
@ -59,41 +59,41 @@ necessary for this build to succeed and can be found further down the page.
### Required: ### Required:
@include 'partials/builder/amazon/instance/Config-required.mdx' @include 'builder/amazon/instance/Config-required.mdx'
### Optional: ### Optional:
@include 'partials/builder/amazon/instance/Config-not-required.mdx' @include 'builder/amazon/instance/Config-not-required.mdx'
### AMI Configuration ### AMI Configuration
#### Required: #### Required:
@include 'partials/builder/amazon/common/AMIConfig-required.mdx' @include 'builder/amazon/common/AMIConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/AMIConfig-not-required.mdx' @include 'builder/amazon/common/AMIConfig-not-required.mdx'
### Access Configuration ### Access Configuration
#### Required: #### Required:
@include 'partials/builder/amazon/common/AccessConfig-required.mdx' @include 'builder/amazon/common/AccessConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/AccessConfig-not-required.mdx' @include 'builder/amazon/common/AccessConfig-not-required.mdx'
### Run Configuration ### Run Configuration
#### Required: #### Required:
@include 'partials/builder/amazon/common/RunConfig-required.mdx' @include 'builder/amazon/common/RunConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/RunConfig-not-required.mdx' @include 'builder/amazon/common/RunConfig-not-required.mdx'
### Block Devices Configuration ### Block Devices Configuration
@ -101,18 +101,18 @@ Block devices can be nested in the
[ami_block_device_mappings](#ami_block_device_mappings) or the [ami_block_device_mappings](#ami_block_device_mappings) or the
[launch_block_device_mappings](#launch_block_device_mappings) array. [launch_block_device_mappings](#launch_block_device_mappings) array.
@include 'partials/builder/amazon/common/BlockDevice.mdx' @include 'builder/amazon/common/BlockDevice.mdx'
#### Optional: #### Optional:
@include 'partials/builder/amazon/common/BlockDevice-not-required.mdx' @include 'builder/amazon/common/BlockDevice-not-required.mdx'
### Communicator Configuration ### Communicator Configuration
#### Optional: #### Optional:
@include 'partials/helper/communicator/Config-not-required.mdx' @include 'helper/communicator/Config-not-required.mdx'
@include 'partials/helper/communicator/SSH-not-required.mdx' @include 'helper/communicator/SSH-not-required.mdx'
## Basic Example ## Basic Example
@ -138,7 +138,7 @@ Here is a basic example. It is completely valid except for the access keys:
} }
``` ```
-&gt; **Note:** Packer can also read the access key and secret access key from -> **Note:** Packer can also read the access key and secret access key from
environmental variables. See the configuration reference in the section above environmental variables. See the configuration reference in the section above
for more information on what environmental variables Packer will look for. for more information on what environmental variables Packer will look for.
@ -214,7 +214,7 @@ sudo -i -n ec2-bundle-vol \
The available template variables should be self-explanatory based on the The available template variables should be self-explanatory based on the
parameters they're used to satisfy the `ec2-bundle-vol` command. parameters they're used to satisfy the `ec2-bundle-vol` command.
\~&gt; **Warning!** Some versions of ec2-bundle-vol silently ignore all .pem ~> **Warning!** Some versions of ec2-bundle-vol silently ignore all .pem
and .gpg files during the bundling of the AMI, which can cause problems on some and .gpg files during the bundling of the AMI, which can cause problems on some
systems, such as Ubuntu. You may want to customize the bundle volume command to systems, such as Ubuntu. You may want to customize the bundle volume command to
include those files (see the `--no-filter` option of `ec2-bundle-vol`). include those files (see the `--no-filter` option of `ec2-bundle-vol`).
@ -270,4 +270,4 @@ this:
You may wish to constrain the resource to a specific bucket. You may wish to constrain the resource to a specific bucket.
@include 'partials/builders/aws-ssh-differentiation-table.mdx' @include 'builders/aws-ssh-differentiation-table.mdx'

2
website/pages/docs/builders/amazon.mdx
View File

@ -34,7 +34,7 @@ Packer supports the following builders at the moment:
not require running in AWS. This is an **advanced builder and should not be not require running in AWS. This is an **advanced builder and should not be
used by newcomers**. used by newcomers**.
-&gt; **Don't know which builder to use?** If in doubt, use the [amazon-ebs -> **Don't know which builder to use?** If in doubt, use the [amazon-ebs
builder](/docs/builders/amazon-ebs.html). It is much easier to use and Amazon builder](/docs/builders/amazon-ebs.html). It is much easier to use and Amazon
generally recommends EBS-backed images nowadays. generally recommends EBS-backed images nowadays.

10
website/pages/docs/builders/azure-arm.mdx
View File

@ -30,7 +30,7 @@ options. In addition to the options listed here, a [communicator](/docs/template
### Authentication options ### Authentication options
@include 'partials/builder/azure/common/client/\_Config.mdx' @include 'builder/azure/common/client/\_Config.mdx'
#### Managed Identity #### Managed Identity
@ -74,7 +74,7 @@ a managed image you **must** start with a managed image.
### Required: ### Required:
@include 'partials/builder/azure/arm/Config-required.mdx' @include 'builder/azure/arm/Config-required.mdx'
When creating a VHD the following additional options are required: When creating a VHD the following additional options are required:
@ -163,8 +163,8 @@ Providing `temp_resource_group_name` or `location` in combination with
### Optional: ### Optional:
@include 'partials/builder/azure/arm/Config-not-required.mdx' @include 'builder/azure/arm/Config-not-required.mdx'
@include 'partials/builder/azure/common/client/\_Config-not-required.mdx' @include 'builder/azure/common/client/\_Config-not-required.mdx'
## Basic Example ## Basic Example
@ -300,7 +300,7 @@ experience. These values can be changed by the user to more suitable values.
## Implementation ## Implementation
\~&gt; **Warning!** This is an advanced topic. You do not need to understand ~> **Warning!** This is an advanced topic. You do not need to understand
the implementation to use the Azure builder. the implementation to use the Azure builder.
The Azure builder uses ARM The Azure builder uses ARM

6
website/pages/docs/builders/azure-chroot.mdx
View File

@ -60,17 +60,17 @@ ones are specified a different authentication method may be used. See the
[shared Azure builders documentation](/docs/builders/azure.html) for more [shared Azure builders documentation](/docs/builders/azure.html) for more
information. information.
@include 'partials/builder/azure/common/client/\_Config-not-required.html.mdx' @include 'builder/azure/common/client/\_Config-not-required.mdx'
### Azure chroot builder specific options ### Azure chroot builder specific options
#### Required: #### Required:
@include 'partials/builder/azure/chroot/\_Config-required.html.mdx' @include 'builder/azure/chroot/\_Config-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/azure/chroot/\_Config-not-required.html.mdx' @include 'builder/azure/chroot/\_Config-not-required.mdx'
## Chroot Mounts ## Chroot Mounts

4
website/pages/docs/builders/azure.mdx
View File

@ -28,7 +28,7 @@ Packer supports the following builders for Azure images at the moment:
newcomers**. However, it is also the fastest way to build a VM image in newcomers**. However, it is also the fastest way to build a VM image in
Azure. Azure.
-&gt; **Don't know which builder to use?** If in doubt, use the [azure-arm -> **Don't know which builder to use?** If in doubt, use the [azure-arm
builder](/docs/builders/azure-arm.html). It is much easier to use. builder](/docs/builders/azure-arm.html). It is much easier to use.
# Authentication for Azure # Authentication for Azure
@ -41,7 +41,7 @@ following methods are available and are explained below:
- Azure Managed Identity - Azure Managed Identity
- Azure Active Directory Service Principal - Azure Active Directory Service Principal
-&gt; **Don't know which authentication method to use?** Go with interactive -> **Don't know which authentication method to use?** Go with interactive
login to try out the builders. If you need packer to run automatically, login to try out the builders. If you need packer to run automatically,
switch to using a Service Principal or Managed Identity. switch to using a Service Principal or Managed Identity.

2
website/pages/docs/builders/cloudstack.mdx
View File

@ -163,7 +163,7 @@ builder.
is featured. Defaults to `false`. is featured. Defaults to `false`.
- `template_name` (string) - The name of the new template. Defaults to - `template_name` (string) - The name of the new template. Defaults to
"packer-{{timestamp}}" where timestamp will be the current time. `packer-{{timestamp}}` where timestamp will be the current time.
- `template_public` (boolean) - Set to `true` to indicate that the template - `template_public` (boolean) - Set to `true` to indicate that the template
is available for all accounts. Defaults to `false`. is available for all accounts. Defaults to `false`.

2
website/pages/docs/builders/community-supported.mdx
View File

@ -13,4 +13,4 @@ The following builders are developed and maintained by various members of the
Packer community, not by HashiCorp. For more information on how to use community Packer community, not by HashiCorp. For more information on how to use community
builders, see our docs on [extending Packer](/docs/extending/index.html). builders, see our docs on [extending Packer](/docs/extending/index.html).
@include 'partials/builders/community_builders.mdx' @include 'builders/community_builders.mdx'

2
website/pages/docs/builders/digitalocean.mdx
View File

@ -95,7 +95,7 @@ builder.
created. This defaults to `false`, or not enabled. created. This defaults to `false`, or not enabled.
- `snapshot_name` (string) - The name of the resulting snapshot that will - `snapshot_name` (string) - The name of the resulting snapshot that will
appear in your account. Defaults to "packer-{{timestamp}}" (see appear in your account. Defaults to `packer-{{timestamp}}` (see
[configuration templates](/docs/templates/engine.html) for more info). [configuration templates](/docs/templates/engine.html) for more info).
- `snapshot_regions` (array of strings) - The regions of the resulting - `snapshot_regions` (array of strings) - The regions of the resulting

6
website/pages/docs/builders/docker.mdx
View File

@ -142,12 +142,12 @@ standard [communicators](/docs/templates/communicator.html).
You must specify (only) one of `commit`, `discard`, or `export_path`. You must specify (only) one of `commit`, `discard`, or `export_path`.
@include 'partials/builder/docker/Config-required.mdx' @include 'builder/docker/Config-required.mdx'
### Optional: ### Optional:
@include 'partials/builder/docker/AwsAccessConfig-not-required.mdx' @include 'builder/docker/AwsAccessConfig-not-required.mdx'
@include 'partials/builder/docker/Config-not-required.mdx' @include 'builder/docker/Config-not-required.mdx'
## Using the Artifact: Export ## Using the Artifact: Export

4
website/pages/docs/builders/googlecompute.mdx
View File

@ -218,11 +218,11 @@ builder.
### Required: ### Required:
@include 'partials/builder/googlecompute/Config-required.mdx' @include 'builder/googlecompute/Config-required.mdx'
### Optional: ### Optional:
@include 'partials/builder/googlecompute/Config-not-required.mdx' @include 'builder/googlecompute/Config-not-required.mdx'
## Startup Scripts ## Startup Scripts

2
website/pages/docs/builders/hetzner-cloud.mdx
View File

@ -84,7 +84,7 @@ builder.
sets the hostname of the machine to this value. sets the hostname of the machine to this value.
- `snapshot_name` (string) - The name of the resulting snapshot that will - `snapshot_name` (string) - The name of the resulting snapshot that will
appear in your account. Defaults to "packer-{{timestamp}}" (see appear in your account. Defaults to `packer-{{timestamp}}` (see
[configuration templates](/docs/templates/engine.html) for more info). [configuration templates](/docs/templates/engine.html) for more info).
- `snapshot_labels` (map of key/value strings) - Key/value pair labels to - `snapshot_labels` (map of key/value strings) - Key/value pair labels to

2
website/pages/docs/builders/hyperone.mdx
View File

@ -122,7 +122,7 @@ builder.
- `image_description` (string) - The description of the resulting image. - `image_description` (string) - The description of the resulting image.
- `image_name` (string) - The name of the resulting image. Defaults to - `image_name` (string) - The name of the resulting image. Defaults to
"packer-{{timestamp}}" `packer-{{timestamp}}`
(see [configuration templates](/docs/templates/engine.html) for more info). (see [configuration templates](/docs/templates/engine.html) for more info).
- `image_service` (string) - The service of the resulting image. - `image_service` (string) - The service of the resulting image.

24
website/pages/docs/builders/hyperv-iso.mdx
View File

@ -50,15 +50,15 @@ power off the VM.
## ISO Configuration Reference ## ISO Configuration Reference
@include 'partials/common/ISOConfig.mdx' @include 'common/ISOConfig.mdx'
### Required: ### Required:
@include 'partials/common/ISOConfig-required.mdx' @include 'common/ISOConfig-required.mdx'
### Optional: ### Optional:
@include 'partials/common/ISOConfig-not-required.mdx' @include 'common/ISOConfig-not-required.mdx'
## Configuration Reference ## Configuration Reference
@ -80,38 +80,38 @@ builder.
created, must be empty prior to running the builder. By default this is created, must be empty prior to running the builder. By default this is
"output-BUILDNAME" where "BUILDNAME" is the name of the build. "output-BUILDNAME" where "BUILDNAME" is the name of the build.
@include 'partials/builder/hyperv/iso/Config-not-required.mdx' @include 'builder/hyperv/iso/Config-not-required.mdx'
@include 'partials/builder/hyperv/common/CommonConfig-not-required.mdx' @include 'builder/hyperv/common/CommonConfig-not-required.mdx'
## Http directory configuration reference ## Http directory configuration reference
@include 'partials/common/HTTPConfig.mdx' @include 'common/HTTPConfig.mdx'
### Optional: ### Optional:
@include 'partials/common/HTTPConfig-not-required.mdx' @include 'common/HTTPConfig-not-required.mdx'
## Shutdown configuration reference ## Shutdown configuration reference
### Optional: ### Optional:
@include 'partials/common/shutdowncommand/ShutdownConfig-not-required.mdx' @include 'common/shutdowncommand/ShutdownConfig-not-required.mdx'
## Floppy configuration reference ## Floppy configuration reference
@include 'partials/common/FloppyConfig.mdx' @include 'common/FloppyConfig.mdx'
### Optional: ### Optional:
@include 'partials/common/FloppyConfig-not-required.mdx' @include 'common/FloppyConfig-not-required.mdx'
## Boot Configuration Reference ## Boot Configuration Reference
@include 'partials/common/bootcommand/BootConfig.mdx' @include 'common/bootcommand/BootConfig.mdx'
### Optional: ### Optional:
@include 'partials/common/bootcommand/BootConfig-not-required.mdx' @include 'common/bootcommand/BootConfig-not-required.mdx'
## Integration Services ## Integration Services

12
website/pages/docs/builders/hyperv-vmcx.mdx
View File

@ -72,15 +72,15 @@ builder.
## ISO Configuration Reference ## ISO Configuration Reference
@include 'partials/common/ISOConfig.mdx' @include 'common/ISOConfig.mdx'
### Required: ### Required:
@include 'partials/common/ISOConfig-required.mdx' @include 'common/ISOConfig-required.mdx'
### Optional: ### Optional:
@include 'partials/common/ISOConfig-not-required.mdx' @include 'common/ISOConfig-not-required.mdx'
### Required for virtual machine import: ### Required for virtual machine import:
@ -99,8 +99,8 @@ builder.
### Optional: ### Optional:
@include 'partials/builder/hyperv/vmcx/Config-not-required.mdx' @include 'builder/hyperv/vmcx/Config-not-required.mdx'
@include 'partials/builder/hyperv/common/CommonConfig-not-required.mdx' @include 'builder/hyperv/common/CommonConfig-not-required.mdx'
## Boot Command ## Boot Command
@ -116,7 +116,7 @@ the template.
The boot command is "typed" character for character over the virtual keyboard The boot command is "typed" character for character over the virtual keyboard
to the machine, simulating a human actually typing the keyboard. to the machine, simulating a human actually typing the keyboard.
@include 'partials/builders/boot-command.mdx' @include 'builders/boot-command.mdx'
The example shown below is a working boot command used to start an Ubuntu The example shown below is a working boot command used to start an Ubuntu
12.04 installer: 12.04 installer:

2
website/pages/docs/builders/linode.mdx
View File

@ -68,7 +68,7 @@ builder.
- `swap_size` (int) - The disk size (MiB) allocated for swap space. - `swap_size` (int) - The disk size (MiB) allocated for swap space.
- `image_label` (string) - The name of the resulting image that will appear - `image_label` (string) - The name of the resulting image that will appear
in your account. Defaults to "packer-{{timestamp}}" (see [configuration in your account. Defaults to `packer-{{timestamp}}` (see [configuration
templates](/docs/templates/engine.html) for more info). templates](/docs/templates/engine.html) for more info).
- `image_description` (string) - The description of the resulting image that - `image_description` (string) - The description of the resulting image that

2
website/pages/docs/builders/lxc.mdx
View File

@ -19,7 +19,7 @@ as a tar.gz of the root file system.
The LXC builder requires a modern linux kernel and the `lxc` or `lxc1` package. The LXC builder requires a modern linux kernel and the `lxc` or `lxc1` package.
This builder does not work with LXD. This builder does not work with LXD.
\~&gt; Note: to build Centos images on a Debian family host, you will need the ~> Note: to build Centos images on a Debian family host, you will need the
`yum` package installed. <br />Some provisioners such as `ansible-local` get `yum` package installed. <br />Some provisioners such as `ansible-local` get
confused when running in a container of a different family. E.G. it will confused when running in a container of a different family. E.G. it will
attempt to use `apt-get` to install packages, when running in a Centos attempt to use `apt-get` to install packages, when running in a Centos

12
website/pages/docs/builders/lxd.mdx
View File

@ -50,7 +50,7 @@ Below is a fully functioning example.
container. This can be a (local or remote) image (name or fingerprint). container. This can be a (local or remote) image (name or fingerprint).
E.G. `my-base-image`, `ubuntu-daily:x`, `08fababf6f27`, ... E.G. `my-base-image`, `ubuntu-daily:x`, `08fababf6f27`, ...
\~&gt; Note: The builder may appear to pause if required to download a ~> Note: The builder may appear to pause if required to download a
remote image, as they are usually 100-200MB. `/var/log/lxd/lxd.log` will remote image, as they are usually 100-200MB. `/var/log/lxd/lxd.log` will
mention starting such downloads. mention starting such downloads.
@ -70,15 +70,7 @@ Below is a fully functioning example.
- `publish_properties` (map\[string\]string) - Pass key values to the publish - `publish_properties` (map\[string\]string) - Pass key values to the publish
step to be set as properties on the output image. This is most helpful to step to be set as properties on the output image. This is most helpful to
set the description, but can be used to set anything needed. See set the description, but can be used to set anything needed. See [here](https://stgraber.org/2016/03/30/lxd-2-0-image-management-512/) for more properties.
<a
href="https://stgraber.org/2016/03/30/lxd-2-0-image-management-512/"
class="uri"
>
https://stgraber.org/2016/03/30/lxd-2-0-image-management-512/
</a>
for more properties.
- `launch_config` (map\[string\]string) - List of key/value pairs you wish to - `launch_config` (map\[string\]string) - List of key/value pairs you wish to
pass to `lxc launch` via `--config`. Defaults to empty. pass to `lxc launch` via `--config`. Defaults to empty.

26
website/pages/docs/builders/openstack.mdx
View File

@ -30,10 +30,10 @@ created. This simplifies configuration quite a bit.
The builder does _not_ manage images. Once it creates an image, it is up to you The builder does _not_ manage images. Once it creates an image, it is up to you
to use it or delete it. to use it or delete it.
\~&gt; **Note:** To use OpenStack builder with the OpenStack Newton (Oct 2016) ~> **Note:** To use OpenStack builder with the OpenStack Newton (Oct 2016)
or earlier, we recommend you use Packer v1.1.2 or earlier version. or earlier, we recommend you use Packer v1.1.2 or earlier version.
\~&gt; **OpenStack Liberty or later requires OpenSSL!** To use the OpenStack ~> **OpenStack Liberty or later requires OpenSSL!** To use the OpenStack
builder with OpenStack Liberty (Oct 2015) or later you need to have OpenSSL builder with OpenStack Liberty (Oct 2015) or later you need to have OpenSSL
installed _if you are using temporary key pairs_, i.e. don't use installed _if you are using temporary key pairs_, i.e. don't use
[`ssh_keypair_name`](openstack.html#ssh_keypair_name) nor [`ssh_keypair_name`](openstack.html#ssh_keypair_name) nor
@ -41,7 +41,7 @@ installed _if you are using temporary key pairs_, i.e. don't use
OS'es have OpenSSL installed by default except Windows. This have been resolved OS'es have OpenSSL installed by default except Windows. This have been resolved
in OpenStack Ocata(Feb 2017). in OpenStack Ocata(Feb 2017).
\~&gt; **Note:** OpenStack Block Storage volume support is available only for ~> **Note:** OpenStack Block Storage volume support is available only for
V3 Block Storage API. It's available in OpenStack since Mitaka release (Apr V3 Block Storage API. It's available in OpenStack since Mitaka release (Apr
2016). 2016).
@ -57,23 +57,23 @@ builder.
### Required: ### Required:
@include 'partials/builder/openstack/AccessConfig-required.mdx' @include 'builder/openstack/AccessConfig-required.mdx'
@include 'partials/builder/openstack/ImageConfig-required.mdx' @include 'builder/openstack/ImageConfig-required.mdx'
@include 'partials/builder/openstack/RunConfig-required.mdx' @include 'builder/openstack/RunConfig-required.mdx'
### Optional: ### Optional:
@include 'partials/builder/openstack/AccessConfig-not-required.mdx' @include 'builder/openstack/AccessConfig-not-required.mdx'
@include 'partials/builder/openstack/ImageConfig-not-required.mdx' @include 'builder/openstack/ImageConfig-not-required.mdx'
@include 'partials/builder/openstack/RunConfig-not-required.mdx' @include 'builder/openstack/RunConfig-not-required.mdx'
### Communicator Configuration ### Communicator Configuration
#### Optional: #### Optional:
@include 'partials/helper/communicator/Config-not-required.mdx' @include 'helper/communicator/Config-not-required.mdx'
@include 'partials/helper/communicator/SSH-not-required.mdx' @include 'helper/communicator/SSH-not-required.mdx'
@include 'partials/helper/communicator/SSHInterface-not-required.mdx' @include 'helper/communicator/SSHInterface-not-required.mdx'
## Basic Example: DevStack ## Basic Example: DevStack
@ -198,7 +198,7 @@ variable `OS_REGION_NAME` or `OS_REGION_ID` and
`export OS_TENANT_NAME=$OS_PROJECT_NAME` or `export OS_TENANT_NAME=$OS_PROJECT_NAME` or
`export OS_TENANT_ID=$OS_PROJECT_ID`. `export OS_TENANT_ID=$OS_PROJECT_ID`.
\~&gt; `OS_TENANT_NAME` or `OS_TENANT_ID` must be used even with Identity v3, ~> `OS_TENANT_NAME` or `OS_TENANT_ID` must be used even with Identity v3,
`OS_PROJECT_NAME` and `OS_PROJECT_ID` has no effect in Packer. `OS_PROJECT_NAME` and `OS_PROJECT_ID` has no effect in Packer.
To troubleshoot authorization issues test you environment variables with the To troubleshoot authorization issues test you environment variables with the

6
website/pages/docs/builders/osc-bsu.mdx
View File

@ -31,7 +31,7 @@ a bit.
The builder does _not_ manage OMIs. Once it creates an OMI and stores it in The builder does _not_ manage OMIs. Once it creates an OMI and stores it in
your account, it is up to you to use, delete, etc. the OMI. your account, it is up to you to use, delete, etc. the OMI.
-&gt; **Note:** Temporary resources are, by default, all created with the -> **Note:** Temporary resources are, by default, all created with the
prefix `packer`. This can be useful if you want to restrict the security groups prefix `packer`. This can be useful if you want to restrict the security groups
and key pairs Packer is able to operate on. and key pairs Packer is able to operate on.
@ -266,7 +266,7 @@ Here is a basic example. You will need to provide access keys, and may need to c
} }
``` ```
-&gt; **Note:** Packer can also read the access key and secret access key from -> **Note:** Packer can also read the access key and secret access key from
environmental variables. See the configuration reference in the section above environmental variables. See the configuration reference in the section above
for more information on what environmental variables Packer will look for. for more information on what environmental variables Packer will look for.
@ -350,7 +350,7 @@ Here is an example using the optional OMIS tags. This will add the tags `OS_Vers
} }
``` ```
-&gt; **Note:** Packer uses pre-built OMIs as the source for building images. -> **Note:** Packer uses pre-built OMIs as the source for building images.
These source OMIs may include volumes that are not flagged to be destroyed on These source OMIs may include volumes that are not flagged to be destroyed on
termination of the VM building the new image. Packer will attempt to termination of the VM building the new image. Packer will attempt to
clean up all residual volumes that are not designated by the user to remain clean up all residual volumes that are not designated by the user to remain

4
website/pages/docs/builders/osc-bsusurrogate.mdx
View File

@ -280,7 +280,7 @@ builder.
} }
``` ```
-&gt; **Note:** Packer can also read the access key and secret access key from -> **Note:** Packer can also read the access key and secret access key from
environmental variables. See the configuration reference in the section above environmental variables. See the configuration reference in the section above
for more information on what environmental variables Packer will look for. for more information on what environmental variables Packer will look for.
@ -303,7 +303,7 @@ In configuration directives marked as a template engine above, the following var
- `SourceOMIName` - The source OMIS Name (for example `ubutu-390`) used to build the OMI. - `SourceOMIName` - The source OMIS Name (for example `ubutu-390`) used to build the OMI.
- `SourceOMITags` - The source OMIS Tags, as a `map[string]string` object. - `SourceOMITags` - The source OMIS Tags, as a `map[string]string` object.
-&gt; **Note:** Packer uses pre-built OMIs as the source for building images. -> **Note:** Packer uses pre-built OMIs as the source for building images.
These source OMIs may include volumes that are not flagged to be destroyed on These source OMIs may include volumes that are not flagged to be destroyed on
termination of the virtual machine building the new image. In addition to those termination of the virtual machine building the new image. In addition to those
volumes created by this builder, any volumes inn the source OMI which are not volumes created by this builder, any volumes inn the source OMI which are not

6
website/pages/docs/builders/osc-bsuvolume.mdx
View File

@ -25,7 +25,7 @@ instance while the image is being created.
The builder does _not_ manage BSU Volumes. Once it creates volumes and stores The builder does _not_ manage BSU Volumes. Once it creates volumes and stores
it in your account, it is up to you to use, delete, etc. the volumes. it in your account, it is up to you to use, delete, etc. the volumes.
-&gt; **Note:** Temporary resources are, by default, all created with the -> **Note:** Temporary resources are, by default, all created with the
prefix `packer`. This can be useful if you want to restrict the security groups prefix `packer`. This can be useful if you want to restrict the security groups
and key pairs Packer is able to operate on. and key pairs Packer is able to operate on.
@ -248,7 +248,7 @@ builder.
} }
``` ```
-&gt; **Note:** Packer can also read the access key and secret access key from -> **Note:** Packer can also read the access key and secret access key from
environmental variables. See the configuration reference in the section above environmental variables. See the configuration reference in the section above
for more information on what environmental variables Packer will look for. for more information on what environmental variables Packer will look for.
@ -276,7 +276,7 @@ variables are available:
build the OMI. build the OMI.
- `SourceOMITags` - The source OMI Tags, as a `map[string]string` object. - `SourceOMITags` - The source OMI Tags, as a `map[string]string` object.
-&gt; **Note:** Packer uses pre-built OMIs as the source for building images. -> **Note:** Packer uses pre-built OMIs as the source for building images.
These source OMIs may include volumes that are not flagged to be destroyed on These source OMIs may include volumes that are not flagged to be destroyed on
termination of the instance building the new image. In addition to those termination of the instance building the new image. In addition to those
volumes created by this builder, any volumes in the source OMI which are not volumes created by this builder, any volumes in the source OMI which are not

2
website/pages/docs/builders/osc-chroot.mdx
View File

@ -28,7 +28,7 @@ builder is able to build an BSU-backed OMI without launching a new Outscale
VM. This can dramatically speed up OMI builds for organizations who need VM. This can dramatically speed up OMI builds for organizations who need
the extra fast build. the extra fast build.
~&gt; **This is an advanced builder** If you're just getting started with ~> **This is an advanced builder** If you're just getting started with
Packer, we recommend starting with the [osc-bsu Packer, we recommend starting with the [osc-bsu
builder](/docs/builders/osc-bsu.html), which is much easier to use. builder](/docs/builders/osc-bsu.html), which is much easier to use.

2
website/pages/docs/builders/outscale.mdx
View File

@ -31,7 +31,7 @@ Packer supports the following builders at the moment:
not require running in Outscale VM. This is an **advanced builder and should not be not require running in Outscale VM. This is an **advanced builder and should not be
used by newcomers**. used by newcomers**.
-&gt; **Don't know which builder to use?** If in doubt, use the [osc-bsu -> **Don't know which builder to use?** If in doubt, use the [osc-bsu
builder](/docs/builders/osc-bsu.html). It is much easier to use and Outscale generally recommends BSU-backed images nowadays. builder](/docs/builders/osc-bsu.html). It is much easier to use and Outscale generally recommends BSU-backed images nowadays.
# Outscale BSU Volume Builder # Outscale BSU Volume Builder

10
website/pages/docs/builders/parallels-iso.mdx
View File

@ -59,15 +59,15 @@ builder.
## ISO Configuration Reference ## ISO Configuration Reference
@include 'partials/common/ISOConfig.mdx' @include 'common/ISOConfig.mdx'
### Required: ### Required:
@include 'partials/common/ISOConfig-required.mdx' @include 'common/ISOConfig-required.mdx'
### Optional: ### Optional:
@include 'partials/common/ISOConfig-not-required.mdx' @include 'common/ISOConfig-not-required.mdx'
### Required: ### Required:
@ -172,7 +172,7 @@ builder.
is "upload". This is a [configuration is "upload". This is a [configuration
template](/docs/templates/engine.html) that has a single template](/docs/templates/engine.html) that has a single
valid variable: `Flavor`, which will be the value of valid variable: `Flavor`, which will be the value of
`parallels_tools_flavor`. By default this is "prl-tools-{{.Flavor}}.iso" `parallels_tools_flavor`. By default this is `prl-tools-{{.Flavor}}.iso`
which should upload into the login directory of the user. which should upload into the login directory of the user.
- `parallels_tools_mode` (string) - The method by which Parallels Tools are - `parallels_tools_mode` (string) - The method by which Parallels Tools are
@ -243,7 +243,7 @@ The boot command is "typed" character for character (using the Parallels
Virtualization SDK, see [Parallels Builder](/docs/builders/parallels.html)) Virtualization SDK, see [Parallels Builder](/docs/builders/parallels.html))
simulating a human actually typing the keyboard. simulating a human actually typing the keyboard.
@include 'partials/builders/boot-command.mdx' @include 'builders/boot-command.mdx'
Example boot command. This is actually a working boot command used to start an Example boot command. This is actually a working boot command used to start an
Ubuntu 12.04 installer: Ubuntu 12.04 installer:

4
website/pages/docs/builders/parallels-pvm.mdx
View File

@ -112,7 +112,7 @@ builder.
is "upload". This is a [configuration is "upload". This is a [configuration
template](/docs/templates/engine.html) that has a single template](/docs/templates/engine.html) that has a single
valid variable: `Flavor`, which will be the value of valid variable: `Flavor`, which will be the value of
`parallels_tools_flavor`. By default this is "prl-tools-{{.Flavor}}.iso" `parallels_tools_flavor`. By default this is `prl-tools-{{.Flavor}}.iso`
which should upload into the login directory of the user. which should upload into the login directory of the user.
- `parallels_tools_mode` (string) - The method by which Parallels Tools are - `parallels_tools_mode` (string) - The method by which Parallels Tools are
@ -188,7 +188,7 @@ The boot command is "typed" character for character (using the Parallels
Virtualization SDK, see [Parallels Builder](/docs/builders/parallels.html)) Virtualization SDK, see [Parallels Builder](/docs/builders/parallels.html))
simulating a human actually typing the keyboard. simulating a human actually typing the keyboard.
@include 'partials/builders/boot-command.mdx' @include 'builders/boot-command.mdx'
## prlctl Commands ## prlctl Commands

28
website/pages/docs/builders/qemu.mdx
View File

@ -81,57 +81,57 @@ necessary for this build to succeed and can be found further down the page.
### Optional: ### Optional:
@include 'partials/builder/qemu/Config-not-required.mdx' @include 'builder/qemu/Config-not-required.mdx'
## ISO Configuration ## ISO Configuration
@include 'partials/common/ISOConfig.mdx' @include 'common/ISOConfig.mdx'
### Required: ### Required:
@include 'partials/common/ISOConfig-required.mdx' @include 'common/ISOConfig-required.mdx'
### Optional: ### Optional:
@include 'partials/common/ISOConfig-not-required.mdx' @include 'common/ISOConfig-not-required.mdx'
## Http directory configuration ## Http directory configuration
@include 'partials/common/HTTPConfig.mdx' @include 'common/HTTPConfig.mdx'
### Optional: ### Optional:
@include 'partials/common/HTTPConfig-not-required.mdx' @include 'common/HTTPConfig-not-required.mdx'
## Floppy configuration ## Floppy configuration
@include 'partials/common/FloppyConfig.mdx' @include 'common/FloppyConfig.mdx'
### Optional: ### Optional:
@include 'partials/common/FloppyConfig-not-required.mdx' @include 'common/FloppyConfig-not-required.mdx'
## Shutdown configuration ## Shutdown configuration
### Optional: ### Optional:
@include 'partials/common/shutdowncommand/ShutdownConfig-not-required.mdx' @include 'common/shutdowncommand/ShutdownConfig-not-required.mdx'
## Boot Configuration ## Boot Configuration
@include 'partials/common/bootcommand/VNCConfig.mdx' @include 'common/bootcommand/VNCConfig.mdx'
@include 'partials/common/bootcommand/BootConfig.mdx' @include 'common/bootcommand/BootConfig.mdx'
### Optional: ### Optional:
@include 'partials/common/bootcommand/VNCConfig-not-required.mdx' @include 'common/bootcommand/VNCConfig-not-required.mdx'
@include 'partials/common/bootcommand/BootConfig-not-required.mdx' @include 'common/bootcommand/BootConfig-not-required.mdx'
### Communicator Configuration ### Communicator Configuration
#### Optional: #### Optional:
@include 'partials/helper/communicator/Config-not-required.mdx' @include 'helper/communicator/Config-not-required.mdx'
### Troubleshooting ### Troubleshooting

2
website/pages/docs/builders/triton.mdx
View File

@ -35,7 +35,7 @@ This reusable image can then be used to launch new machines.
The builder does _not_ manage images. Once it creates an image, it is up to you The builder does _not_ manage images. Once it creates an image, it is up to you
to use it or delete it. to use it or delete it.
\~&gt; **Private installations of Triton must have custom images enabled!** To ~> **Private installations of Triton must have custom images enabled!** To
use the Triton builder with a private/on-prem installation of Joyent's Triton use the Triton builder with a private/on-prem installation of Joyent's Triton
software, you'll need an operator to manually [enable custom software, you'll need an operator to manually [enable custom
images](https://docs.joyent.com/private-cloud/install/image-management) after images](https://docs.joyent.com/private-cloud/install/image-management) after

10
website/pages/docs/builders/ucloud-uhost.mdx
View File

@ -26,7 +26,7 @@ In addition to the options listed here, a
[communicator](../templates/communicator.html) can be configured for this [communicator](../templates/communicator.html) can be configured for this
builder. builder.
\~&gt; **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 <code>`()~!@#\$%^&\*-+=\_|{}\[]:;'<>,.?/</code>. ~> **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 `()~!@#\$%^&\*-+=\_|{}\[]:;'<>,.?/`.
### Required: ### Required:
@ -52,7 +52,7 @@ builder.
- `use_ssh_private_ip` - (boolean) - If this value is true, packer will connect to the created UHost instance via a private ip instead of allocating an EIP (elastic public ip).(Default: `false`). - `use_ssh_private_ip` - (boolean) - If this value is true, packer will connect to the created UHost instance via a private ip instead of allocating an EIP (elastic public ip).(Default: `false`).
\~&gt; **Note:** By default (`use_ssh_private_ip` is `false`), the launched uhost instance will be connecting with extranet by bounding with an EIP (elastic public ip) automatically, which bandwidth is 30 Mb by default and paid by traffic. ~> **Note:** By default (`use_ssh_private_ip` is `false`), the launched uhost instance will be connecting with extranet by bounding with an EIP (elastic public ip) automatically, which bandwidth is 30 Mb by default and paid by traffic.
- `vpc_id` - (string) The ID of VPC linked to the UHost instance. If not defined `vpc_id`, the instance will use the default VPC in the current region. - `vpc_id` - (string) The ID of VPC linked to the UHost instance. If not defined `vpc_id`, the instance will use the default VPC in the current region.
@ -70,7 +70,7 @@ builder.
Possible values are: `cloud_ssd` for cloud boot disk, `local_normal` and `local_ssd` for local boot disk. (Default: `cloud_ssd`). Possible values are: `cloud_ssd` for cloud boot disk, `local_normal` and `local_ssd` for local boot disk. (Default: `cloud_ssd`).
The `cloud_ssd` and `local_ssd` are not fully supported by all regions as boot disk type, please proceed to UCloud console for more details. The `cloud_ssd` and `local_ssd` are not fully supported by all regions as boot disk type, please proceed to UCloud console for more details.
\~&gt; **Note:** It takes around 10 mins for boot disk initialization when `boot_disk_type` is `local_normal` or `local_ssd`. ~> **Note:** It takes around 10 mins for boot disk initialization when `boot_disk_type` is `local_normal` or `local_ssd`.
- `image_copy_to_mappings` (array of copied image mappings) - The array of mappings regarding the copied images to the destination regions and projects. - `image_copy_to_mappings` (array of copied image mappings) - The array of mappings regarding the copied images to the destination regions and projects.
@ -150,8 +150,8 @@ Here is a example for build UCloud Ubuntu image:
} }
``` ```
-&gt; **Note:** Packer can also read the public key and private key from -> **Note:** Packer can also read the public key and private key from
environmental variables. See the configuration reference in the section above environmental variables. See the configuration reference in the section above
for more information on what environmental variables Packer will look for. for more information on what environmental variables Packer will look for.
\~&gt; **Note:** Source image may be deprecated after a while, you can use the tools like `UCloud CLI` to run `ucloud image list` to find one that exists. ~> **Note:** Source image may be deprecated after a while, you can use the tools like `UCloud CLI` to run `ucloud image list` to find one that exists.

4
website/pages/docs/builders/vagrant.mdx
View File

@ -83,8 +83,8 @@ the Compress post-processor will not work with this builder.
- `template` (string) - a path to a golang template for a - `template` (string) - a path to a golang template for a
vagrantfile. Our default template can be found vagrantfile. Our default template can be found
[here](https://github.com/hashicorp/packer/blob/master/builder/vagrant/step_create_vagrantfile.go#L23-L37). So far the only template variables available to you are {{ .BoxName }} and [here](https://github.com/hashicorp/packer/blob/master/builder/vagrant/step_create_vagrantfile.go#L23-L37). So far the only template variables available to you are `{{ .BoxName }}` and
{{ .SyncedFolder }}, which correspond to the Packer options `box_name` and `{{ .SyncedFolder }}`, which correspond to the Packer options `box_name` and
`synced_folder`. `synced_folder`.
You must provide a template if your default vagrant provider is Hyper-V. You must provide a template if your default vagrant provider is Hyper-V.

50
website/pages/docs/builders/virtualbox-iso.mdx
View File

@ -62,93 +62,93 @@ necessary for this build to succeed and can be found further down the page.
#### Optional: #### Optional:
@include 'partials/builder/virtualbox/iso/Config-not-required.mdx' @include 'builder/virtualbox/iso/Config-not-required.mdx'
@include 'partials/builder/virtualbox/common/VBoxVersionConfig-not-required.mdx' @include 'builder/virtualbox/common/VBoxVersionConfig-not-required.mdx'
@include 'partials/builder/virtualbox/common/VBoxBundleConfig-not-required.mdx' @include 'builder/virtualbox/common/VBoxBundleConfig-not-required.mdx'
@include 'partials/builder/virtualbox/common/GuestAdditionsConfig-not-required.mdx' @include 'builder/virtualbox/common/GuestAdditionsConfig-not-required.mdx'
### ISO Configuration ### ISO Configuration
@include 'partials/common/ISOConfig.mdx' @include 'common/ISOConfig.mdx'
#### Required: #### Required:
@include 'partials/common/ISOConfig-required.mdx' @include 'common/ISOConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/common/ISOConfig-not-required.mdx' @include 'common/ISOConfig-not-required.mdx'
### Http directory configuration ### Http directory configuration
@include 'partials/common/HTTPConfig.mdx' @include 'common/HTTPConfig.mdx'
#### Optional: #### Optional:
@include 'partials/common/HTTPConfig-not-required.mdx' @include 'common/HTTPConfig-not-required.mdx'
### Floppy configuration ### Floppy configuration
@include 'partials/common/FloppyConfig.mdx' @include 'common/FloppyConfig.mdx'
#### Optional: #### Optional:
@include 'partials/common/FloppyConfig-not-required.mdx' @include 'common/FloppyConfig-not-required.mdx'
### Export configuration ### Export configuration
#### Optional: #### Optional:
@include 'partials/builder/virtualbox/common/ExportConfig-not-required.mdx' @include 'builder/virtualbox/common/ExportConfig-not-required.mdx'
### Output configuration ### Output configuration
#### Optional: #### Optional:
@include 'partials/builder/virtualbox/common/OutputConfig-not-required.mdx' @include 'builder/virtualbox/common/OutputConfig-not-required.mdx'
### Run configuration ### Run configuration
#### Optional: #### Optional:
@include 'partials/builder/virtualbox/common/RunConfig-not-required.mdx' @include 'builder/virtualbox/common/RunConfig-not-required.mdx'
### Shutdown configuration ### Shutdown configuration
#### Optional: #### Optional:
@include 'partials/builder/virtualbox/common/ShutdownConfig-not-required.mdx' @include 'builder/virtualbox/common/ShutdownConfig-not-required.mdx'
### Hardware configuration ### Hardware configuration
#### Optional: #### Optional:
@include 'partials/builder/virtualbox/common/HWConfig-not-required.mdx' @include 'builder/virtualbox/common/HWConfig-not-required.mdx'
### VBox Manage configuration ### VBox Manage configuration
#### Optional: #### Optional:
@include 'partials/builder/virtualbox/common/VBoxManageConfig-not-required.mdx' @include 'builder/virtualbox/common/VBoxManageConfig-not-required.mdx'
### Communicator configuration ### Communicator configuration
#### Optional common fields: #### Optional common fields:
@include 'partials/helper/communicator/Config-not-required.mdx' @include 'helper/communicator/Config-not-required.mdx'
@include 'partials/builder/virtualbox/common/CommConfig-not-required.mdx' @include 'builder/virtualbox/common/CommConfig-not-required.mdx'
#### Optional SSH fields: #### Optional SSH fields:
@include 'partials/helper/communicator/SSH-not-required.mdx' @include 'helper/communicator/SSH-not-required.mdx'
#### Optional WinRM fields: #### Optional WinRM fields:
@include 'partials/helper/communicator/WinRM-not-required.mdx' @include 'helper/communicator/WinRM-not-required.mdx'
### Boot Configuration ### Boot Configuration
@include 'partials/common/bootcommand/BootConfig.mdx' @include 'common/bootcommand/BootConfig.mdx'
The boot command is sent to the VM through the `VBoxManage` utility in as few The boot command is sent to the VM through the `VBoxManage` utility in as few
invocations as possible. We send each character in groups of 25, with a default invocations as possible. We send each character in groups of 25, with a default
@ -170,11 +170,11 @@ contention. If you notice missing keys, you can tune this delay by specifying
#### Optional: #### Optional:
@include 'partials/common/bootcommand/BootConfig-not-required.mdx' @include 'common/bootcommand/BootConfig-not-required.mdx'
@include 'partials/builders/boot-command.mdx' @include 'builders/boot-command.mdx'
@include 'partials/builders/virtualbox-ssh-key-pair.mdx' @include 'builders/virtualbox-ssh-key-pair.mdx'
Example boot command. This is actually a working boot command used to start an Example boot command. This is actually a working boot command used to start an
Ubuntu 12.04 installer: Ubuntu 12.04 installer:

42
website/pages/docs/builders/virtualbox-ovf.mdx
View File

@ -69,76 +69,76 @@ necessary for this build to succeed and can be found further down the page.
### Required: ### Required:
@include 'partials/builder/virtualbox/ovf/Config-required.mdx' @include 'builder/virtualbox/ovf/Config-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/virtualbox/ovf/Config-not-required.mdx' @include 'builder/virtualbox/ovf/Config-not-required.mdx'
@include 'partials/builder/virtualbox/common/VBoxVersionConfig-not-required.mdx' @include 'builder/virtualbox/common/VBoxVersionConfig-not-required.mdx'
@include 'partials/builder/virtualbox/common/GuestAdditionsConfig-not-required.mdx' @include 'builder/virtualbox/common/GuestAdditionsConfig-not-required.mdx'
### VBoxManage configuration ### VBoxManage configuration
@include 'partials/builder/virtualbox/common/VBoxManageConfig-not-required.mdx' @include 'builder/virtualbox/common/VBoxManageConfig-not-required.mdx'
### Http directory configuration ### Http directory configuration
@include 'partials/common/HTTPConfig.mdx' @include 'common/HTTPConfig.mdx'
#### Optional: #### Optional:
@include 'partials/common/HTTPConfig-not-required.mdx' @include 'common/HTTPConfig-not-required.mdx'
### Floppy configuration ### Floppy configuration
@include 'partials/common/FloppyConfig.mdx' @include 'common/FloppyConfig.mdx'
#### Optional: #### Optional:
@include 'partials/common/FloppyConfig-not-required.mdx' @include 'common/FloppyConfig-not-required.mdx'
### Export configuration ### Export configuration
#### Optional: #### Optional:
@include 'partials/builder/virtualbox/common/ExportConfig-not-required.mdx' @include 'builder/virtualbox/common/ExportConfig-not-required.mdx'
### Output configuration ### Output configuration
#### Optional: #### Optional:
@include 'partials/builder/virtualbox/common/OutputConfig-not-required.mdx' @include 'builder/virtualbox/common/OutputConfig-not-required.mdx'
### Run configuration ### Run configuration
#### Optional: #### Optional:
@include 'partials/builder/virtualbox/common/RunConfig-not-required.mdx' @include 'builder/virtualbox/common/RunConfig-not-required.mdx'
### Shutdown configuration ### Shutdown configuration
#### Optional: #### Optional:
@include 'partials/builder/virtualbox/common/ShutdownConfig-not-required.mdx' @include 'builder/virtualbox/common/ShutdownConfig-not-required.mdx'
### Communicator configuration ### Communicator configuration
#### Optional common fields: #### Optional common fields:
@include 'partials/helper/communicator/Config-not-required.mdx' @include 'helper/communicator/Config-not-required.mdx'
@include 'partials/builder/virtualbox/common/CommConfig-not-required.mdx' @include 'builder/virtualbox/common/CommConfig-not-required.mdx'
#### Optional SSH fields: #### Optional SSH fields:
@include 'partials/helper/communicator/SSH-not-required.mdx' @include 'helper/communicator/SSH-not-required.mdx'
#### Optional WinRM fields: #### Optional WinRM fields:
@include 'partials/helper/communicator/WinRM-not-required.mdx' @include 'helper/communicator/WinRM-not-required.mdx'
### Boot Configuration ### Boot Configuration
@include 'partials/common/bootcommand/BootConfig.mdx' @include 'common/bootcommand/BootConfig.mdx'
The boot command is sent to the VM through the `VBoxManage` utility in as few The boot command is sent to the VM through the `VBoxManage` utility in as few
invocations as possible. We send each character in groups of 25, with a default invocations as possible. We send each character in groups of 25, with a default
@ -160,11 +160,11 @@ contention. If you notice missing keys, you can tune this delay by specifying
#### Optional: #### Optional:
@include 'partials/common/bootcommand/BootConfig-not-required.mdx' @include 'common/bootcommand/BootConfig-not-required.mdx'
@include 'partials/builders/boot-command.mdx' @include 'builders/boot-command.mdx'
@include 'partials/builders/virtualbox-ssh-key-pair.mdx' @include 'builders/virtualbox-ssh-key-pair.mdx'
Example boot command. This is actually a working boot command used to start an Example boot command. This is actually a working boot command used to start an
Ubuntu 12.04 installer: Ubuntu 12.04 installer:

8
website/pages/docs/builders/virtualbox-vm.mdx
View File

@ -229,7 +229,7 @@ builder.
not export the VM. Useful if the builder should be applied again on the created not export the VM. Useful if the builder should be applied again on the created
target snapshot. target snapshot.
@include 'partials/builder/virtualbox/common/CommConfig-not-required.mdx' @include 'builder/virtualbox/common/CommConfig-not-required.mdx'
- `target_snapshot` (string) - Default to `null/empty`. The name of the - `target_snapshot` (string) - Default to `null/empty`. The name of the
snapshot which shall be created after all provisioners has been run by the snapshot which shall be created after all provisioners has been run by the
@ -274,7 +274,7 @@ builder.
#### Optional: #### Optional:
@include 'partials/builder/virtualbox/common/ShutdownConfig-not-required.mdx' @include 'builder/virtualbox/common/ShutdownConfig-not-required.mdx'
## Boot Command ## Boot Command
@ -305,9 +305,9 @@ contention. If you notice missing keys, you can tune this delay by specifying
} }
``` ```
@include 'partials/builders/boot-command.mdx' @include 'builders/boot-command.mdx'
@include 'partials/builders/virtualbox-ssh-key-pair.mdx' @include 'builders/virtualbox-ssh-key-pair.mdx'
Example boot command. This is actually a working boot command used to start an Example boot command. This is actually a working boot command used to start an
Ubuntu 12.04 installer: Ubuntu 12.04 installer:

52
website/pages/docs/builders/vmware-iso.mdx
View File

@ -71,104 +71,104 @@ necessary for this build to succeed and can be found further down the page.
#### Optional: #### Optional:
@include 'partials/builder/vmware/iso/Config-not-required.mdx' @include 'builder/vmware/iso/Config-not-required.mdx'
### ISO Configuration ### ISO Configuration
@include 'partials/common/ISOConfig.mdx' @include 'common/ISOConfig.mdx'
#### Required: #### Required:
@include 'partials/common/ISOConfig-required.mdx' @include 'common/ISOConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/common/ISOConfig-not-required.mdx' @include 'common/ISOConfig-not-required.mdx'
### Http directory configuration ### Http directory configuration
@include 'partials/common/HTTPConfig.mdx' @include 'common/HTTPConfig.mdx'
#### Optional: #### Optional:
@include 'partials/common/HTTPConfig-not-required.mdx' @include 'common/HTTPConfig-not-required.mdx'
### Floppy configuration ### Floppy configuration
@include 'partials/common/FloppyConfig.mdx' @include 'common/FloppyConfig.mdx'
#### Optional: #### Optional:
@include 'partials/common/FloppyConfig-not-required.mdx' @include 'common/FloppyConfig-not-required.mdx'
### Shutdown configuration ### Shutdown configuration
#### Optional: #### Optional:
@include 'partials/common/shutdowncommand/ShutdownConfig-not-required.mdx' @include 'common/shutdowncommand/ShutdownConfig-not-required.mdx'
### Driver configuration ### Driver configuration
#### Optional: #### Optional:
@include 'partials/builder/vmware/common/DriverConfig-not-required.mdx' @include 'builder/vmware/common/DriverConfig-not-required.mdx'
### Hardware configuration ### Hardware configuration
#### Optional: #### Optional:
@include 'partials/builder/vmware/common/HWConfig-not-required.mdx' @include 'builder/vmware/common/HWConfig-not-required.mdx'
### Output configuration ### Output configuration
#### Optional: #### Optional:
@include 'partials/builder/vmware/common/OutputConfig-not-required.mdx' @include 'builder/vmware/common/OutputConfig-not-required.mdx'
### Run configuration ### Run configuration
#### Optional: #### Optional:
@include 'partials/builder/vmware/common/RunConfig-not-required.mdx' @include 'builder/vmware/common/RunConfig-not-required.mdx'
### Tools configuration ### Tools configuration
#### Optional: #### Optional:
@include 'partials/builder/vmware/common/ToolsConfig-not-required.mdx' @include 'builder/vmware/common/ToolsConfig-not-required.mdx'
### VMX configuration ### VMX configuration
#### Optional: #### Optional:
@include 'partials/builder/vmware/common/VMXConfig-not-required.mdx' @include 'builder/vmware/common/VMXConfig-not-required.mdx'
### Export configuration ### Export configuration
#### Optional: #### Optional:
@include 'partials/builder/vmware/common/ExportConfig-not-required.mdx' @include 'builder/vmware/common/ExportConfig-not-required.mdx'
### Communicator configuration ### Communicator configuration
#### Optional common fields: #### Optional common fields:
@include 'partials/helper/communicator/Config-not-required.mdx' @include 'helper/communicator/Config-not-required.mdx'
#### Optional SSH fields: #### Optional SSH fields:
@include 'partials/helper/communicator/SSH-not-required.mdx' @include 'helper/communicator/SSH-not-required.mdx'
#### Optional WinRM fields: #### Optional WinRM fields:
@include 'partials/helper/communicator/WinRM-not-required.mdx' @include 'helper/communicator/WinRM-not-required.mdx'
## Boot Configuration ## Boot Configuration
@include 'partials/common/bootcommand/BootConfig.mdx' @include 'common/bootcommand/BootConfig.mdx'
@include 'partials/common/bootcommand/VNCConfig.mdx' @include 'common/bootcommand/VNCConfig.mdx'
-&gt; **Note**: for the `HTTPIP` to be resolved correctly, your VM's network -> **Note**: for the `HTTPIP` to be resolved correctly, your VM's network
configuration has to include a `hostonly` or `nat` type network interface. configuration has to include a `hostonly` or `nat` type network interface.
If you are using this feature, it is recommended to leave the default network If you are using this feature, it is recommended to leave the default network
configuration while you are building the VM, and use the `vmx_data_post` hook configuration while you are building the VM, and use the `vmx_data_post` hook
@ -176,8 +176,8 @@ to modify the network configuration after the VM is done building.
#### Optional: #### Optional:
@include 'partials/common/bootcommand/VNCConfig-not-required.mdx' @include 'common/bootcommand/VNCConfig-not-required.mdx'
@include 'partials/common/bootcommand/BootConfig-not-required.mdx' @include 'common/bootcommand/BootConfig-not-required.mdx'
For more examples of various boot commands, see the sample projects from our For more examples of various boot commands, see the sample projects from our
[community templates page](/community-tools.html#templates). [community templates page](/community-tools.html#templates).
@ -191,7 +191,7 @@ file](https://github.com/hashicorp/packer/blob/20541a7eda085aa5cf35bfed5069592ca
But for advanced users, this template can be customized. This allows Packer to But for advanced users, this template can be customized. This allows Packer to
build virtual machines of effectively any guest operating system type. build virtual machines of effectively any guest operating system type.
~&gt; **This is an advanced feature.** Modifying the VMX template can easily ~> **This is an advanced feature.** Modifying the VMX template can easily
cause your virtual machine to not boot properly. Please only modify the template cause your virtual machine to not boot properly. Please only modify the template
if you know what you're doing. if you know what you're doing.
@ -206,7 +206,7 @@ variables isn't required, however.
- `Version` - The Hardware version VMWare will execute this vm under. Also - `Version` - The Hardware version VMWare will execute this vm under. Also
known as the `virtualhw.version`. known as the `virtualhw.version`.
@include 'partials/builders/building_on_remote_vsphere_hypervisor.mdx' @include 'builders/building_on_remote_vsphere_hypervisor.mdx'
### VNC port discovery ### VNC port discovery

44
website/pages/docs/builders/vmware-vmx.mdx
View File

@ -75,88 +75,88 @@ necessary for this build to succeed and can be found further down the page.
### Required: ### Required:
@include 'partials/builder/vmware/vmx/Config-required.mdx' @include 'builder/vmware/vmx/Config-required.mdx'
#### Optional: #### Optional:
@include 'partials/builder/vmware/vmx/Config-not-required.mdx' @include 'builder/vmware/vmx/Config-not-required.mdx'
### Http directory configuration ### Http directory configuration
@include 'partials/common/HTTPConfig.mdx' @include 'common/HTTPConfig.mdx'
#### Optional: #### Optional:
@include 'partials/common/HTTPConfig-not-required.mdx' @include 'common/HTTPConfig-not-required.mdx'
### Floppy configuration ### Floppy configuration
@include 'partials/common/FloppyConfig.mdx' @include 'common/FloppyConfig.mdx'
#### Optional: #### Optional:
@include 'partials/common/FloppyConfig-not-required.mdx' @include 'common/FloppyConfig-not-required.mdx'
### Export configuration ### Export configuration
#### Optional: #### Optional:
@include 'partials/builder/vmware/common/ExportConfig-not-required.mdx' @include 'builder/vmware/common/ExportConfig-not-required.mdx'
### Output configuration ### Output configuration
#### Optional: #### Optional:
@include 'partials/builder/vmware/common/OutputConfig-not-required.mdx' @include 'builder/vmware/common/OutputConfig-not-required.mdx'
### Run configuration ### Run configuration
#### Optional: #### Optional:
@include 'partials/builder/vmware/common/RunConfig-not-required.mdx' @include 'builder/vmware/common/RunConfig-not-required.mdx'
### Driver configuration ### Driver configuration
#### Optional: #### Optional:
@include 'partials/builder/vmware/common/DriverConfig-not-required.mdx' @include 'builder/vmware/common/DriverConfig-not-required.mdx'
### Tools configuration ### Tools configuration
#### Optional: #### Optional:
@include 'partials/builder/vmware/common/ToolsConfig-not-required.mdx' @include 'builder/vmware/common/ToolsConfig-not-required.mdx'
### VMX configuration ### VMX configuration
#### Optional: #### Optional:
@include 'partials/builder/vmware/common/VMXConfig-not-required.mdx' @include 'builder/vmware/common/VMXConfig-not-required.mdx'
### Communicator configuration ### Communicator configuration
#### Optional common fields: #### Optional common fields:
@include 'partials/helper/communicator/Config-not-required.mdx' @include 'helper/communicator/Config-not-required.mdx'
#### Optional SSH fields: #### Optional SSH fields:
@include 'partials/helper/communicator/SSH-not-required.mdx' @include 'helper/communicator/SSH-not-required.mdx'
#### Optional WinRM fields: #### Optional WinRM fields:
@include 'partials/helper/communicator/WinRM-not-required.mdx' @include 'helper/communicator/WinRM-not-required.mdx'
## Shutdown Configuration ## Shutdown Configuration
@include 'partials/common/shutdowncommand/ShutdownConfig-not-required.mdx' @include 'common/shutdowncommand/ShutdownConfig-not-required.mdx'
## Boot Configuration ## Boot Configuration
@include 'partials/common/bootcommand/BootConfig.mdx' @include 'common/bootcommand/BootConfig.mdx'
@include 'partials/common/bootcommand/VNCConfig.mdx' @include 'common/bootcommand/VNCConfig.mdx'
-&gt; **Note**: for the `HTTPIP` to be resolved correctly, your VM's network -> **Note**: for the `HTTPIP` to be resolved correctly, your VM's network
configuration has to include a `hostonly` or `nat` type network interface. configuration has to include a `hostonly` or `nat` type network interface.
If you are using this feature, it is recommended to leave the default network If you are using this feature, it is recommended to leave the default network
configuration while you are building the VM, and use the `vmx_data_post` hook configuration while you are building the VM, and use the `vmx_data_post` hook
@ -164,8 +164,8 @@ to modify the network configuration after the VM is done building.
#### Optional: #### Optional:
@include 'partials/common/bootcommand/VNCConfig-not-required.mdx' @include 'common/bootcommand/VNCConfig-not-required.mdx'
@include 'partials/common/bootcommand/BootConfig-not-required.mdx' @include 'common/bootcommand/BootConfig-not-required.mdx'
For more examples of various boot commands, see the sample projects from our For more examples of various boot commands, see the sample projects from our
[community templates page](/community-tools.html#templates). [community templates page](/community-tools.html#templates).
@ -202,4 +202,4 @@ Ubuntu 12.04 installer:
For more examples of various boot commands, see the sample projects from our For more examples of various boot commands, see the sample projects from our
[community templates page](/community-tools.html#templates). [community templates page](/community-tools.html#templates).
@include 'partials/builders/building_on_remote_vsphere_hypervisor.mdx' @include 'builders/building_on_remote_vsphere_hypervisor.mdx'

24
website/pages/docs/builders/vsphere-clone.mdx
View File

@ -40,53 +40,53 @@ references for [ISO](#iso-configuration),
configuration references, which are configuration references, which are
necessary for this build to succeed and can be found further down the page. necessary for this build to succeed and can be found further down the page.
@include 'partials/builder/vsphere/clone/Config-not-required.mdx' @include 'builder/vsphere/clone/Config-not-required.mdx'
### Clone Configuration ### Clone Configuration
@include 'partials/builder/vsphere/clone/CloneConfig-not-required.mdx' @include 'builder/vsphere/clone/CloneConfig-not-required.mdx'
### Extra Configuration Parameters ### Extra Configuration Parameters
@include 'partials/builder/vsphere/common/ConfigParamsConfig-not-required.mdx' @include 'builder/vsphere/common/ConfigParamsConfig-not-required.mdx'
### Connection Configuration ### Connection Configuration
@include 'partials/builder/vsphere/common/ConnectConfig-not-required.mdx' @include 'builder/vsphere/common/ConnectConfig-not-required.mdx'
### Hardware Configuration ### Hardware Configuration
@include 'partials/builder/vsphere/common/HardwareConfig-not-required.mdx' @include 'builder/vsphere/common/HardwareConfig-not-required.mdx'
### Location Configuration ### Location Configuration
@include 'partials/builder/vsphere/common/LocationConfig-not-required.mdx' @include 'builder/vsphere/common/LocationConfig-not-required.mdx'
### Run Configuration ### Run Configuration
@include 'partials/builder/vsphere/common/RunConfig-not-required.mdx' @include 'builder/vsphere/common/RunConfig-not-required.mdx'
### Shutdown Configuration ### Shutdown Configuration
@include 'partials/builder/vsphere/common/ShutdownConfig-not-required.mdx' @include 'builder/vsphere/common/ShutdownConfig-not-required.mdx'
### Wait Configuration ### Wait Configuration
@include 'partials/builder/vsphere/common/WaitIpConfig-not-required.mdx' @include 'builder/vsphere/common/WaitIpConfig-not-required.mdx'
### Communicator configuration ### Communicator configuration
#### Optional common fields: #### Optional common fields:
@include 'partials/helper/communicator/Config-not-required.mdx' @include 'helper/communicator/Config-not-required.mdx'
#### Optional SSH fields: #### Optional SSH fields:
@include 'partials/helper/communicator/SSH-not-required.mdx' @include 'helper/communicator/SSH-not-required.mdx'
#### Optional WinRM fields: #### Optional WinRM fields:
@include 'partials/helper/communicator/WinRM-not-required.mdx' @include 'helper/communicator/WinRM-not-required.mdx'
### Export Configuration ### Export Configuration

42
website/pages/docs/builders/vsphere-iso.mdx
View File

@ -42,43 +42,43 @@ references for [HTTP](#http-directory-configuration),
configuration references, which are configuration references, which are
necessary for this build to succeed and can be found further down the page. necessary for this build to succeed and can be found further down the page.
@include 'partials/builder/vsphere/iso/Config-not-required.mdx' @include 'builder/vsphere/iso/Config-not-required.mdx'
### Connection Configuration ### Connection Configuration
@include 'partials/builder/vsphere/common/ConnectConfig-not-required.mdx' @include 'builder/vsphere/common/ConnectConfig-not-required.mdx'
### Hardware Configuration ### Hardware Configuration
@include 'partials/builder/vsphere/common/HardwareConfig-not-required.mdx' @include 'builder/vsphere/common/HardwareConfig-not-required.mdx'
### Location Configuration ### Location Configuration
@include 'partials/builder/vsphere/common/LocationConfig-not-required.mdx' @include 'builder/vsphere/common/LocationConfig-not-required.mdx'
### Run Configuration ### Run Configuration
@include 'partials/builder/vsphere/common/RunConfig-not-required.mdx' @include 'builder/vsphere/common/RunConfig-not-required.mdx'
### Shutdown Configuration ### Shutdown Configuration
@include 'partials/builder/vsphere/common/ShutdownConfig-not-required.mdx' @include 'builder/vsphere/common/ShutdownConfig-not-required.mdx'
### Wait Configuration ### Wait Configuration
@include 'partials/builder/vsphere/common/WaitIpConfig-not-required.mdx' @include 'builder/vsphere/common/WaitIpConfig-not-required.mdx'
### ISO Configuration ### ISO Configuration
@include 'partials/common/ISOConfig.mdx' @include 'common/ISOConfig.mdx'
#### Required: #### Required:
@include 'partials/common/ISOConfig-required.mdx' @include 'common/ISOConfig-required.mdx'
#### Optional: #### Optional:
@include 'partials/common/ISOConfig-not-required.mdx' @include 'common/ISOConfig-not-required.mdx'
### CDRom Configuration ### CDRom Configuration
@ -97,24 +97,24 @@ from the datastore. Example:
], ],
``` ```
@include 'partials/builder/vsphere/iso/CDRomConfig-not-required.mdx' @include 'builder/vsphere/iso/CDRomConfig-not-required.mdx'
### Create Configuration ### Create Configuration
@include 'partials/builder/vsphere/iso/CreateConfig-not-required.mdx' @include 'builder/vsphere/iso/CreateConfig-not-required.mdx'
### Network Adapter Configuration ### Network Adapter Configuration
@include 'partials/builder/vsphere/iso/NIC-required.mdx' @include 'builder/vsphere/iso/NIC-required.mdx'
### Storage Configuration ### Storage Configuration
@include 'partials/builder/vsphere/iso/DiskConfig-required.mdx' @include 'builder/vsphere/iso/DiskConfig-required.mdx'
@include 'partials/builder/vsphere/iso/DiskConfig-not-required.mdx' @include 'builder/vsphere/iso/DiskConfig-not-required.mdx'
### Floppy Configuration ### Floppy Configuration
@include 'partials/builder/vsphere/iso/FloppyConfig-not-required.mdx' @include 'builder/vsphere/iso/FloppyConfig-not-required.mdx'
### Export Configuration ### Export Configuration
<%= partial "partials/builder/vsphere/common/ExportConfig" %> <%= partial "partials/builder/vsphere/common/ExportConfig" %>
@ -129,25 +129,25 @@ from the datastore. Example:
### Extra Configuration Parameters ### Extra Configuration Parameters
@include 'partials/builder/vsphere/common/ConfigParamsConfig-not-required.mdx' @include 'builder/vsphere/common/ConfigParamsConfig-not-required.mdx'
### Communicator configuration ### Communicator configuration
#### Optional common fields: #### Optional common fields:
@include 'partials/helper/communicator/Config-not-required.mdx' @include 'helper/communicator/Config-not-required.mdx'
#### Optional Network Adapter fields: #### Optional Network Adapter fields:
@include 'partials/builder/vsphere/iso/NIC-not-required.mdx' @include 'builder/vsphere/iso/NIC-not-required.mdx'
#### Optional SSH fields: #### Optional SSH fields:
@include 'partials/helper/communicator/SSH-not-required.mdx' @include 'helper/communicator/SSH-not-required.mdx'
#### Optional WinRM fields: #### Optional WinRM fields:
@include 'partials/helper/communicator/WinRM-not-required.mdx' @include 'helper/communicator/WinRM-not-required.mdx'
## Working with Clusters ## Working with Clusters

6
website/pages/docs/builders/yandex.mdx
View File

@ -1,6 +1,6 @@
--- ---
description: | description: |
The yandex Packer builder is able to create images for use with The yandex Packer builder is able to create images for use with
Yandex.Cloud based on existing images. Yandex.Cloud based on existing images.
layout: docs layout: docs
page_title: Yandex Compute - Builders page_title: Yandex Compute - Builders
@ -57,8 +57,8 @@ can be configured for this builder.
### Required: ### Required:
@include 'partials/builder/yandex/Config-required.mdx' @include 'builder/yandex/Config-required.mdx'
### Optional: ### Optional:
@include 'partials/builder/yandex/Config-not-required.mdx' @include 'builder/yandex/Config-not-required.mdx'

2
website/pages/docs/commands/fix.mdx
View File

@ -28,7 +28,7 @@ If fixing fails for any reason, the fix command will exit with a non-zero exit
status. Error messages appear on standard error, so if you're redirecting status. Error messages appear on standard error, so if you're redirecting
output, you'll still see error messages. output, you'll still see error messages.
-&gt; **Even when Packer fix doesn't do anything** to the template, the -> **Even when Packer fix doesn't do anything** to the template, the
template will be outputted to standard out. Things such as configuration key template will be outputted to standard out. Things such as configuration key
ordering and indentation may be changed. The output format however, is ordering and indentation may be changed. The output format however, is
pretty-printed for human readability. pretty-printed for human readability.

2
website/pages/docs/commands/index.mdx
View File

@ -58,7 +58,7 @@ The format will be covered in more detail later. But as you can see, the output
immediately becomes machine-friendly. Try some other commands with the immediately becomes machine-friendly. Try some other commands with the
`-machine-readable` flag to see! `-machine-readable` flag to see!
\~&gt; The `-machine-readable` flag is designed for automated environments and ~>; The `-machine-readable` flag is designed for automated environments and
is mutually-exclusive with the `-debug` flag, which is designed for interactive is mutually-exclusive with the `-debug` flag, which is designed for interactive
environments. environments.

2
website/pages/docs/communicators/ssh.mdx
View File

@ -58,7 +58,7 @@ the remote host.
The SSH communicator has the following options: The SSH communicator has the following options:
@include "helper/communicator/SSH-not-required" @include "helper/communicator/SSH-not-required.mdx"
### SSH Communicator Details ### SSH Communicator Details

2
website/pages/docs/communicators/winrm.mdx
View File

@ -36,7 +36,7 @@ to successfully use Packer to build from an iso.
## WinRM Communicator Options ## WinRM Communicator Options
@include "helper/communicator/WinRM-not-required" @include "helper/communicator/WinRM-not-required.mdx"
## Examples ## Examples

10
website/pages/docs/extending/custom-builders.mdx
View File

@ -19,7 +19,7 @@ plugin interface, and this page documents how to do that.
Prior to reading this page, it is assumed you have read the page on [plugin Prior to reading this page, it is assumed you have read the page on [plugin
development basics](/docs/extending/plugins.html). development basics](/docs/extending/plugins.html).
\~&gt; **Warning!** This is an advanced topic. If you're new to Packer, we ~> **Warning!** This is an advanced topic. If you're new to Packer, we
recommend getting a bit more comfortable before you dive into writing plugins. recommend getting a bit more comfortable before you dive into writing plugins.
## The Interface ## The Interface
@ -157,7 +157,7 @@ hook.Run(context.Context, packer.HookProvision, ui, comm, nil)
At this point, Packer will run the provisioners and no additional work is At this point, Packer will run the provisioners and no additional work is
necessary. necessary.
-&gt; **Note:** Hooks are still undergoing thought around their general design -> **Note:** Hooks are still undergoing thought around their general design
and will likely change in a future version. They aren't fully "baked" yet, so and will likely change in a future version. They aren't fully "baked" yet, so
they aren't documented here other than to tell you how to hook in provisioners. they aren't documented here other than to tell you how to hook in provisioners.
@ -171,7 +171,7 @@ provisioners and post-processors using the `build` function.
Part of the builder interface changes made in 1.5.0 was to make builder Prepare() methods Part of the builder interface changes made in 1.5.0 was to make builder Prepare() methods
return a list of custom variables which we call `generated data`. return a list of custom variables which we call `generated data`.
We use that list of variables to generate a custom placeholder map per builder that We use that list of variables to generate a custom placeholder map per builder that
combines custom variables with the placeholder map of default build variables created by Packer. combines custom variables with the placeholder map of default build variables created by Packer.
Here's an example snippet telling packer what will be made available by the builder: Here's an example snippet telling packer what will be made available by the builder:
``` ```
@ -184,8 +184,8 @@ func (b *Builder) Prepare(raws ...interface{}) ([]string, []string, error) {
``` ```
Returning the custom variable name(s) within the `generated_data` placeholder is necessary Returning the custom variable name(s) within the `generated_data` placeholder is necessary
for the template containing the build variable(s) to validate. for the template containing the build variable(s) to validate.
Once the placeholder is set, it's necessary to pass the variables' real values when calling Once the placeholder is set, it's necessary to pass the variables' real values when calling
the provisioner. This can be done as the example below: the provisioner. This can be done as the example below:

2
website/pages/docs/extending/custom-post-processors.mdx
View File

@ -26,7 +26,7 @@ development basics](/docs/extending/plugins.html).
Post-processor plugins implement the `packer.PostProcessor` interface and are Post-processor plugins implement the `packer.PostProcessor` interface and are
served using the `plugin.ServePostProcessor` function. served using the `plugin.ServePostProcessor` function.
\~&gt; **Warning!** This is an advanced topic. If you're new to Packer, we ~> **Warning!** This is an advanced topic. If you're new to Packer, we
recommend getting a bit more comfortable before you dive into writing plugins. recommend getting a bit more comfortable before you dive into writing plugins.
## The Interface ## The Interface

2
website/pages/docs/extending/custom-provisioners.mdx
View File

@ -27,7 +27,7 @@ development basics](/docs/extending/plugins.html).
Provisioner plugins implement the `packer.Provisioner` interface and are served Provisioner plugins implement the `packer.Provisioner` interface and are served
using the `plugin.ServeProvisioner` function. using the `plugin.ServeProvisioner` function.
\~&gt; **Warning!** This is an advanced topic. If you're new to Packer, we ~> **Warning!** This is an advanced topic. If you're new to Packer, we
recommend getting a bit more comfortable before you dive into writing plugins. recommend getting a bit more comfortable before you dive into writing plugins.
## The Interface ## The Interface

4
website/pages/docs/extending/plugins.mdx
View File

@ -93,7 +93,7 @@ assumed that you're familiar with the language. This page will not be a Go
language tutorial. Thankfully, if you are familiar with Go, the Go toolchain language tutorial. Thankfully, if you are familiar with Go, the Go toolchain
provides many conveniences to help to develop Packer plugins. provides many conveniences to help to develop Packer plugins.
\~&gt; **Warning!** This is an advanced topic. If you're new to Packer, we ~> **Warning!** This is an advanced topic. If you're new to Packer, we
recommend getting a bit more comfortable before you dive into writing plugins. recommend getting a bit more comfortable before you dive into writing plugins.
### Plugin System Architecture ### Plugin System Architecture
@ -173,7 +173,7 @@ using standard installation procedures.
The specifics of how to implement each type of interface are covered in the The specifics of how to implement each type of interface are covered in the
relevant subsections available in the navigation to the left. relevant subsections available in the navigation to the left.
\~&gt; **Lock your dependencies!** Using `go mod` is highly recommended since ~> **Lock your dependencies!** Using `go mod` is highly recommended since
the Packer codebase will continue to improve, potentially breaking APIs along the Packer codebase will continue to improve, potentially breaking APIs along
the way until there is a stable release. By locking your dependencies, your the way until there is a stable release. By locking your dependencies, your
plugins will continue to work with the version of Packer you lock to. plugins will continue to work with the version of Packer you lock to.

7
website/pages/docs/post-processors/amazon-import.mdx
View File

@ -14,11 +14,10 @@ Type: `amazon-import`
The Packer Amazon Import post-processor takes an OVA artifact from various 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. builders and imports it to an AMI available to Amazon Web Services EC2.
\~&gt; This post-processor is for advanced users. It depends on specific IAM ~> This post-processor is for advanced users. It depends on specific IAM
roles inside AWS and is best used with images that operate with the EC2 roles inside AWS and is best used with images that operate with the EC2
configuration model (eg, cloud-init for Linux systems). Please ensure you read configuration model (eg, cloud-init for Linux systems). Please ensure you read
the [prerequisites for the [prerequisites for import](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/VMImportPrerequisites.html)
import](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/VMImportPrerequisites.html)
before using this post-processor. before using this post-processor.
## How Does it Work? ## How Does it Work?
@ -241,7 +240,7 @@ second delay in between retries.
This is dramatically higher than many of our other waiters, to account for how This is dramatically higher than many of our other waiters, to account for how
long this process can take. long this process can take.
-&gt; **Note:** Packer can also read the access key and secret access key from -> **Note:** Packer can also read the access key and secret access key from
environmental variables. See the configuration reference in the section above environmental variables. See the configuration reference in the section above
for more information on what environmental variables Packer will look for. for more information on what environmental variables Packer will look for.

2
website/pages/docs/post-processors/digitalocean-import.mdx
View File

@ -79,7 +79,7 @@ Optional:
the image file will be copied to for import. This is treated as a the image file will be copied to for import. This is treated as a
[template engine](/docs/templates/engine.html). Therefore, you [template engine](/docs/templates/engine.html). Therefore, you
may use user variables and template functions in this field. may use user variables and template functions in this field.
If not specified, this will default to "packer-import-{{timestamp}}". If not specified, this will default to `packer-import-{{timestamp}}`.
- `timeout` (number) - The length of time in minutes to wait for individual - `timeout` (number) - The length of time in minutes to wait for individual
steps in the process to successfully complete. This includes both importing steps in the process to successfully complete. This includes both importing

4
website/pages/docs/post-processors/docker-push.mdx
View File

@ -55,12 +55,12 @@ This post-processor has only optional configuration:
- `login_server` (string) - The server address to login to. - `login_server` (string) - The server address to login to.
-&gt; **Note:** When using _Docker Hub_ or _Quay_ registry servers, `login` -> **Note:** When using _Docker Hub_ or _Quay_ registry servers, `login`
must to be set to `true` and `login_username`, **and** `login_password` must to must to be set to `true` and `login_username`, **and** `login_password` must to
be set to your registry credentials. When using Docker Hub, `login_server` can be set to your registry credentials. When using Docker Hub, `login_server` can
be omitted. be omitted.
-&gt; **Note:** If you login using the credentials above, the post-processor -> **Note:** If you login using the credentials above, the post-processor
will automatically log you out afterwards (just the server specified). will automatically log you out afterwards (just the server specified).
## Example ## Example

13
website/pages/docs/post-processors/googlecompute-import.mdx
View File

@ -14,9 +14,8 @@ Type: `googlecompute-import`
The Google Compute Image Import post-processor takes a compressed raw disk 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. image and imports it to a GCE image available to Google Compute Engine.
\~&gt; This post-processor is for advanced users. Please ensure you read the ~> This post-processor is for advanced users. Please ensure you read the
[GCE import [GCE import documentation](https://cloud.google.com/compute/docs/images/import-existing-image)
documentation](https://cloud.google.com/compute/docs/images/import-existing-image)
before using this post-processor. before using this post-processor.
## How Does it Work? ## How Does it Work?
@ -24,12 +23,10 @@ before using this post-processor.
The import process operates by uploading a temporary copy of the compressed raw The import process operates by uploading a temporary copy of the compressed raw
disk image to a GCS bucket, and calling an import task in GCP on the raw disk disk image to a GCS bucket, and calling an import task in GCP on the raw disk
file. Once completed, a GCE image is created containing the converted virtual file. Once completed, a GCE image is created containing the converted virtual
machine. The temporary raw disk image copy in GCS can be discarded after the machine. The temporary raw disk image copy in GCS can be discarded after the import is complete.
import is complete.
Google Cloud has very specific requirements for images being imported. Please Google Cloud has very specific requirements for images being imported. Please
see the [GCE import see the [GCE import documentation](https://cloud.google.com/compute/docs/images/import-existing-image)
documentation](https://cloud.google.com/compute/docs/images/import-existing-image)
for details. for details.
## Configuration ## Configuration
@ -53,7 +50,7 @@ for details.
the RAW disk image will be copied for import. This is treated as a the RAW disk image will be copied for import. This is treated as a
[template engine](/docs/templates/engine.html). Therefore, you [template engine](/docs/templates/engine.html). Therefore, you
may use user variables and template functions in this field. Defaults to may use user variables and template functions in this field. Defaults to
"packer-import-{{timestamp}}.tar.gz". `packer-import-{{timestamp}}.tar.gz`.
- `image_description` (string) - The description of the resulting image. - `image_description` (string) - The description of the resulting image.

2
website/pages/docs/post-processors/vagrant.mdx
View File

@ -45,7 +45,7 @@ providers.
- VirtualBox - VirtualBox
- VMware - VMware
-&gt; **Support for additional providers** is planned. If the Vagrant -> **Support for additional providers** is planned. If the Vagrant
post-processor doesn't support creating boxes for a provider you care about, post-processor doesn't support creating boxes for a provider you care about,
please help by contributing to Packer and adding support for it. please help by contributing to Packer and adding support for it.

71
website/pages/docs/provisioners/ansible-local.mdx
View File

@ -1,15 +1,6 @@
--- ---
description: > description: >
The ansible-local Packer provisioner will run ansible in ansible's "local" The ansible-local Packer provisioner will run ansible in ansible's "local" mode on the remote/guest VM using Playbook and Role files that exist on the guest VM. This means ansible must be installed on the remote/guest VM. Playbooks and Roles can be uploaded from your build machine (the one running Packer) to the vm.
mode
on the remote/guest VM using Playbook and Role files that exist on the guest
VM. This means ansible must be installed on the remote/guest VM. Playbooks and
Roles can be uploaded from your build machine (the one running Packer) to the
vm.
layout: docs layout: docs
page_title: Ansible Local - Provisioners page_title: Ansible Local - Provisioners
sidebar_current: docs-provisioners-ansible-local sidebar_current: docs-provisioners-ansible-local
@ -27,7 +18,7 @@ Packer) to the vm. Ansible is then run on the guest machine in [local
mode](https://docs.ansible.com/ansible/playbooks_delegation.html#local-playbooks) mode](https://docs.ansible.com/ansible/playbooks_delegation.html#local-playbooks)
via the `ansible-playbook` command. via the `ansible-playbook` command.
-&gt; **Note:** Ansible will _not_ be installed automatically by this -> **Note:** Ansible will _not_ be installed automatically by this
provisioner. This provisioner expects that Ansible is already installed on the provisioner. This provisioner expects that Ansible is already installed on the
guest/remote machine. It is common practice to use the [shell guest/remote machine. It is common practice to use the [shell
provisioner](/docs/provisioners/shell.html) before the Ansible provisioner to provisioner](/docs/provisioners/shell.html) before the Ansible provisioner to
@ -72,50 +63,50 @@ Optional:
be passed through a shell and arguments should be quoted accordingly. Usage be passed through a shell and arguments should be quoted accordingly. Usage
example: example:
<!-- --> ```text
"extra_arguments": [ "--extra-vars \"Region={{user `Region`}} Stage={{user `Stage`}}\"" ]
"extra_arguments": [ "--extra-vars \"Region={{user `Region`}} Stage={{user `Stage`}}\"" ] ```
- `inventory_groups` (string) - A comma-separated list of groups to which - `inventory_groups` (string) - A comma-separated list of groups to which
packer will assign the host `127.0.0.1`. A value of `my_group_1,my_group_2` packer will assign the host `127.0.0.1`. A value of `my_group_1,my_group_2`
will generate an Ansible inventory like: will generate an Ansible inventory like:
```text ```text
[my_group_1] [my_group_1]
127.0.0.1 127.0.0.1
[my_group_2] [my_group_2]
127.0.0.1 127.0.0.1
``` ```
- `inventory_file` (string) - The inventory file to be used by ansible. This - `inventory_file` (string) - The inventory file to be used by ansible. This
file must exist on your local system and will be uploaded to the remote file must exist on your local system and will be uploaded to the remote
machine. machine.
When using an inventory file, it's also required to `--limit` the hosts to the When using an inventory file, it's also required to `--limit` the hosts to the
specified host you're building. The `--limit` argument can be provided in the specified host you're building. The `--limit` argument can be provided in the
`extra_arguments` option. `extra_arguments` option.
An example inventory file may look like: An example inventory file may look like:
```text ```text
[chi-dbservers] [chi-dbservers]
db-01 ansible_connection=local db-01 ansible_connection=local
db-02 ansible_connection=local db-02 ansible_connection=local
[chi-appservers] [chi-appservers]
app-01 ansible_connection=local app-01 ansible_connection=local
app-02 ansible_connection=local app-02 ansible_connection=local
[chi:children] [chi:children]
chi-dbservers chi-dbservers
chi-appservers chi-appservers
[dbservers:children] [dbservers:children]
chi-dbservers chi-dbservers
[appservers:children] [appservers:children]
chi-appservers chi-appservers
``` ```
- `playbook_dir` (string) - a path to the complete ansible directory - `playbook_dir` (string) - a path to the complete ansible directory
structure on your local system to be copied to the remote machine as the structure on your local system to be copied to the remote machine as the
@ -160,7 +151,7 @@ chi-appservers
`staging_directory` will be removed after executing ansible. By default, `staging_directory` will be removed after executing ansible. By default,
this is set to `false`. this is set to `false`.
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'
## Default Extra Variables ## Default Extra Variables

8
website/pages/docs/provisioners/ansible.mdx
View File

@ -16,7 +16,7 @@ an Ansible inventory file configured to use SSH, runs an SSH server, executes
`ansible-playbook`, and marshals Ansible plays through the SSH server to the `ansible-playbook`, and marshals Ansible plays through the SSH server to the
machine being provisioned by Packer. machine being provisioned by Packer.
-&gt; **Note:**: Any `remote_user` defined in tasks will be ignored. Packer -> **Note:**: Any `remote_user` defined in tasks will be ignored. Packer
will always connect with the user given in the json config for this will always connect with the user given in the json config for this
provisioner. provisioner.
@ -85,7 +85,7 @@ Optional Parameters:
For example, if you are running a Windows build on AWS, Azure, For example, if you are running a Windows build on AWS, Azure,
Google Compute, or OpenStack and would like to access the auto-generated Google Compute, or OpenStack and would like to access the auto-generated
password that Packer uses to connect to a Windows instance via WinRM, you password that Packer uses to connect to a Windows instance via WinRM, you
can use the template variable {{.WinRMPassword}} in this option. Example: can use the template variable `{{.WinRMPassword}}` in this option. Example:
```json ```json
"ansible_env_vars": [ "WINRM_PASSWORD={{.WinRMPassword}}" ], "ansible_env_vars": [ "WINRM_PASSWORD={{.WinRMPassword}}" ],
@ -110,7 +110,7 @@ Optional Parameters:
If you are running a Windows build on AWS, Azure, Google Compute, or OpenStack If you are running a Windows build on AWS, Azure, Google Compute, or OpenStack
and would like to access the auto-generated password that Packer uses to and would like to access the auto-generated password that Packer uses to
connect to a Windows instance via WinRM, you can use the template variable connect to a Windows instance via WinRM, you can use the template variable
{{.WinRMPassword}} in this option. For example: `{{.WinRMPassword}}` in this option. For example:
```json ```json
"extra_arguments": [ "extra_arguments": [
@ -212,7 +212,7 @@ Optional Parameters:
this option will be changed to default to `false` for SSH and WinRM this option will be changed to default to `false` for SSH and WinRM
connections where the provisioner has access to a host IP. connections where the provisioner has access to a host IP.
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'
## Default Extra Variables ## Default Extra Variables

2
website/pages/docs/provisioners/breakpoint.mdx
View File

@ -44,7 +44,7 @@ and between every provisioner.
breakpoints or label them with information about where in the build they breakpoints or label them with information about where in the build they
occur occur
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'
## Usage ## Usage

6
website/pages/docs/provisioners/chef-client.mdx
View File

@ -94,7 +94,7 @@ configuration is actually required.
information. information.
- `node_name` (string) - The name of the node to register with the Chef - `node_name` (string) - The name of the node to register with the Chef
Server. This is optional and by default is packer-{{uuid}}. Server. This is optional and by default is `packer-{{uuid}}`.
- `policy_group` (string) - The name of a policy group that exists on the - `policy_group` (string) - The name of a policy group that exists on the
Chef server. `policy_name` must also be specified. Chef server. `policy_name` must also be specified.
@ -159,7 +159,7 @@ configuration is actually required.
- `version` (string) - The version of Chef to be installed. By default this - `version` (string) - The version of Chef to be installed. By default this
is empty which will install the latest version of Chef. is empty which will install the latest version of Chef.
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'
## Chef Configuration ## Chef Configuration
@ -304,7 +304,7 @@ contain various template variables, defined below:
## Folder Permissions ## Folder Permissions
!&gt; The `chef-client` provisioner will chmod the directory with your Chef !> The `chef-client` provisioner will chmod the directory with your Chef
keys to 777. This is to ensure that Packer can upload and make use of that keys to 777. This is to ensure that Packer can upload and make use of that
directory. However, once the machine is created, you usually don't want to keep directory. However, once the machine is created, you usually don't want to keep
these directories with those permissions. To change the permissions on the these directories with those permissions. To change the permissions on the

2
website/pages/docs/provisioners/chef-solo.mdx
View File

@ -117,7 +117,7 @@ configuration is actually required, but at least `run_list` is recommended.
- `version` (string) - The version of Chef to be installed. By default this - `version` (string) - The version of Chef to be installed. By default this
is empty which will install the latest version of Chef. is empty which will install the latest version of Chef.
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'
## Chef Configuration ## Chef Configuration

2
website/pages/docs/provisioners/community-supported.mdx
View File

@ -13,4 +13,4 @@ The following provisioners are developed and maintained by various members of th
Packer community, not by HashiCorp. For more information on how to use community Packer community, not by HashiCorp. For more information on how to use community
provisioners, see our docs on [extending Packer](/docs/extending/index.html). provisioners, see our docs on [extending Packer](/docs/extending/index.html).
@include 'partials/provisioners/community_provisioners.mdx' @include 'provisioners/community_provisioners.mdx'

2
website/pages/docs/provisioners/converge.mdx
View File

@ -78,7 +78,7 @@ Optional parameters:
- `prevent_bootstrap_sudo` (boolean) - stop Converge from bootstrapping with - `prevent_bootstrap_sudo` (boolean) - stop Converge from bootstrapping with
administrator privileges via sudo administrator privileges via sudo
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'
### Module Directories ### Module Directories

2
website/pages/docs/provisioners/file.mdx
View File

@ -72,7 +72,7 @@ The available configuration options are listed below.
the Packer run, but realize that there are situations where this may be the Packer run, but realize that there are situations where this may be
unavoidable. unavoidable.
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'
## Directory Uploads ## Directory Uploads

2
website/pages/docs/provisioners/inspec.mdx
View File

@ -104,7 +104,7 @@ Optional Parameters:
- `user` (string) - The `--user` to use. Defaults to the user running Packer. - `user` (string) - The `--user` to use. Defaults to the user running Packer.
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'
## Default Extra Variables ## Default Extra Variables

4
website/pages/docs/provisioners/powershell.mdx
View File

@ -31,7 +31,7 @@ The example below is fully functional.
## Configuration Reference ## Configuration Reference
@include 'partials/provisioners/shell-config.mdx' @include 'provisioners/shell-config.mdx'
- `elevated_execute_command` (string) - The command to use to execute the - `elevated_execute_command` (string) - The command to use to execute the
elevated script. By default this is as follows: elevated script. By default this is as follows:
@ -147,7 +147,7 @@ The example below is fully functional.
exists in order to deal with times when SSH may restart, such as a system exists in order to deal with times when SSH may restart, such as a system
reboot. Set this to a higher value if reboots take a longer amount of time. reboot. Set this to a higher value if reboots take a longer amount of time.
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'
## Default Environmental Variables ## Default Environmental Variables

6
website/pages/docs/provisioners/puppet-masterless.mdx
View File

@ -27,7 +27,7 @@ remote paths (perhaps obtained using something like the shell provisioner).
Puppet is run in masterless mode, meaning it never communicates to a Puppet Puppet is run in masterless mode, meaning it never communicates to a Puppet
master. master.
-&gt; **Note:** Puppet will _not_ be installed automatically by this -> **Note:** Puppet will _not_ be installed automatically by this
provisioner. This provisioner expects that Puppet is already installed on the provisioner. This provisioner expects that Puppet is already installed on the
machine. It is common practice to use the [shell machine. It is common practice to use the [shell
provisioner](/docs/provisioners/shell.html) before the Puppet provisioner to do provisioner](/docs/provisioners/shell.html) before the Puppet provisioner to do
@ -109,7 +109,7 @@ Optional parameters:
This is useful if your main manifest uses imports, but the directory might This is useful if your main manifest uses imports, but the directory might
not contain the `manifest_file` itself. not contain the `manifest_file` itself.
\~&gt; `manifest_dir` is passed to Puppet as `--manifestdir` option. This ~> `manifest_dir` is passed to Puppet as `--manifestdir` option. This
option was deprecated in puppet 3.6, and removed in puppet 4.0. If you have option was deprecated in puppet 3.6, and removed in puppet 4.0. If you have
multiple manifests you should use `manifest_file` instead. multiple manifests you should use `manifest_file` instead.
@ -144,7 +144,7 @@ multiple manifests you should use `manifest_file` instead.
field, including `` {{ build `Password`}} `` to use the password being used field, including `` {{ build `Password`}} `` to use the password being used
by the communicator to connect to your instance. by the communicator to connect to your instance.
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'
## Execute Command ## Execute Command

4
website/pages/docs/provisioners/puppet-server.mdx
View File

@ -14,7 +14,7 @@ Type: `puppet-server`
The `puppet-server` Packer provisioner provisions Packer machines with Puppet The `puppet-server` Packer provisioner provisions Packer machines with Puppet
by connecting to a Puppet master. by connecting to a Puppet master.
-&gt; **Note:** Puppet will _not_ be installed automatically by this -> **Note:** Puppet will _not_ be installed automatically by this
provisioner. This provisioner expects that Puppet is already installed on the provisioner. This provisioner expects that Puppet is already installed on the
machine. It is common practice to use the [shell machine. It is common practice to use the [shell
provisioner](/docs/provisioners/shell.html) before the Puppet provisioner to do provisioner](/docs/provisioners/shell.html) before the Puppet provisioner to do
@ -122,7 +122,7 @@ listed below:
field, including `` {{ build `Password`}} `` to use the password being used field, including `` {{ build `Password`}} `` to use the password being used
by the communicator to connect to your instance. by the communicator to connect to your instance.
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'
## Execute Command ## Execute Command

2
website/pages/docs/provisioners/salt-masterless.mdx
View File

@ -98,4 +98,4 @@ Optional:
- `guest_os_type` (string) - The target guest OS type, either "unix" or - `guest_os_type` (string) - The target guest OS type, either "unix" or
"windows". "windows".
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'

6
website/pages/docs/provisioners/shell-local.mdx
View File

@ -98,8 +98,8 @@ Optional parameters:
these commands are not officially supported and things like environment these commands are not officially supported and things like environment
variables may not work if you use a different shell than the default. variables may not work if you use a different shell than the default.
For backwards compatibility, you may also use {{.Command}}, but it is For backwards compatibility, you may also use `{{.Command}}`, but it is
decoded the same way as {{.Script}}. We recommend using {{.Script}} for the decoded the same way as `{{.Script}}`. We recommend using `{{.Script}}` for the
sake of clarity, as even when you set only a single `command` to run, sake of clarity, as even when you set only a single `command` to run,
Packer writes it to a temporary file and then runs it as a script. Packer writes it to a temporary file and then runs it as a script.
@ -136,7 +136,7 @@ Optional parameters:
- `valid_exit_codes` (list of ints) - Valid exit codes for the script. By - `valid_exit_codes` (list of ints) - Valid exit codes for the script. By
default this is just 0. default this is just 0.
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'
## Execute Command ## Execute Command

6
website/pages/docs/provisioners/shell.mdx
View File

@ -16,7 +16,7 @@ The shell Packer provisioner provisions machines built by Packer using shell
scripts. Shell provisioning is the easiest way to get software installed and scripts. Shell provisioning is the easiest way to get software installed and
configured on a machine. configured on a machine.
-&gt; **Building Windows images?** You probably want to use the -> **Building Windows images?** You probably want to use the
[PowerShell](/docs/provisioners/powershell.html) or [Windows [PowerShell](/docs/provisioners/powershell.html) or [Windows
Shell](/docs/provisioners/windows-shell.html) provisioners. Shell](/docs/provisioners/windows-shell.html) provisioners.
@ -33,7 +33,7 @@ The example below is fully functional.
## Configuration Reference ## Configuration Reference
@include 'partials/provisioners/shell-config.mdx' @include 'provisioners/shell-config.mdx'
- `environment_vars` (array of strings) - An array of key/value pairs to - `environment_vars` (array of strings) - An array of key/value pairs to
inject prior to the execute_command. The format should be `key=value`. inject prior to the execute_command. The format should be `key=value`.
@ -100,7 +100,7 @@ The example below is fully functional.
- `pause_after` (string) - Wait the amount of time after provisioning a shell - `pause_after` (string) - Wait the amount of time after provisioning a shell
script, this pause be taken if all previous steps were successful. script, this pause be taken if all previous steps were successful.
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'
## Execute Command Example ## Execute Command Example

2
website/pages/docs/provisioners/windows-restart.mdx
View File

@ -76,4 +76,4 @@ Optional parameters:
updates or have a lot of startup services, you will probably need to updates or have a lot of startup services, you will probably need to
increase this duration. increase this duration.
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'

4
website/pages/docs/provisioners/windows-shell.mdx
View File

@ -27,7 +27,7 @@ The example below is fully functional.
## Configuration Reference ## Configuration Reference
@include 'partials/provisioners/shell-config.mdx' @include 'provisioners/shell-config.mdx'
- `environment_vars` (array of strings) - An array of key/value pairs to - `environment_vars` (array of strings) - An array of key/value pairs to
inject prior to the execute_command. The format should be `key=value`. inject prior to the execute_command. The format should be `key=value`.
@ -53,7 +53,7 @@ The example below is fully functional.
exists in order to deal with times when SSH may restart, such as a system exists in order to deal with times when SSH may restart, such as a system
reboot. Set this to a higher value if reboots take a longer amount of time. reboot. Set this to a higher value if reboots take a longer amount of time.
@include 'partials/provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'
## Default Environmental Variables ## Default Environmental Variables

2
website/pages/docs/templates/communicator.mdx vendored
View File

@ -17,7 +17,7 @@ Communicators are configured within the
All communicators have the following options: All communicators have the following options:
@include 'partials/helper/communicator/Config-not-required.mdx' @include 'helper/communicator/Config-not-required.mdx'
## Getting Ready to Use the Communicator ## Getting Ready to Use the Communicator

48
website/pages/docs/templates/engine.mdx vendored
View File

@ -40,25 +40,23 @@ Here is a full list of the available functions for reference.
will convert upper cases to lower cases and replace illegal characters with will convert upper cases to lower cases and replace illegal characters with
a "-" character. Example: a "-" character. Example:
`"mybuild-{{isotime | clean_resource_name}}"` will become `"mybuild-{{isotime | clean_resource_name}}"` will become `mybuild-2017-10-18t02-06-30z`.
`mybuild-2017-10-18t02-06-30z`.
Note: Valid Azure image names must match the regex Note: Valid Azure image names must match the regex
`^[^_\\W][\\w-._)]{0,79}$` `^[^_\\W][\\w-._)]{0,79}$`
Note: Valid GCE image names must match the regex Note: Valid GCE image names must match the regex
`(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)` `(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)`
This engine does not guarantee that the final image name will match the This engine does not guarantee that the final image name will match the
regex; it will not truncate your name if it exceeds the maximum number of regex; it will not truncate your name if it exceeds the maximum number of
allowed characters, and it will not validate that the beginning and end of allowed characters, and it will not validate that the beginning and end of
the engine's output are valid. For example, `"image_name": {{isotime | the engine's output are valid. For example, `"image_name": {{isotime | clean_resource_name}}"` will cause your build to fail because the image
clean_resource_name}}"` will cause your build to fail because the image name will start with a number, which is why in the above example we prepend
name will start with a number, which is why in the above example we prepend the isotime with "mybuild".
the isotime with "mybuild". Exact behavior of `clean_resource_name` will depend on which builder it is
Exact behavior of `clean_resource_name` will depend on which builder it is being applied to; refer to build-specific docs below for more detail on how
being applied to; refer to build-specific docs below for more detail on how each function will behave.
each function will behave.
- `env` - Returns environment variables. See example in [using home - `env` - Returns environment variables. See example in [using home
variable](/docs/templates/user-variables.html#using-home-variable) variable](/docs/templates/user-variables.html#using-home-variable)
@ -91,19 +89,7 @@ Here is a full list of the available functions for reference.
- **SSHPublicKey** and **SSHPrivateKey**: The public and private key that Packer uses to connect to the instance. - **SSHPublicKey** and **SSHPrivateKey**: The public and private key that Packer uses to connect to the instance.
These are unique to the SSH communicator and are unset when using other communicators. These are unique to the SSH communicator and are unset when using other communicators.
**SSHPublicKey** and **SSHPrivateKey** can have escape sequences and special characters so their output should be single quoted to avoid surprises. For example: **SSHPublicKey** and **SSHPrivateKey** can have escape sequences and special characters so their output should be single quoted to avoid surprises. For example:
```json `` json { ... "provisioners": [ { "type": "shell", "inline": [ "echo '{{ build `SSHPrivateKey`}}' > /tmp/packer-session.pem" ] } ] } ``
{
...
"provisioners": [
{
"type": "shell",
"inline": [
"echo '{{ build `SSHPrivateKey`}}' > /tmp/packer-session.pem"
]
}
]
}
```
For backwards compatability, `WinRMPassword` is also available through this For backwards compatability, `WinRMPassword` is also available through this
engine, though it is no different than using the more general `Password`. engine, though it is no different than using the more general `Password`.
@ -230,7 +216,7 @@ The `{{ .Vars }}` and `{{ .Path }}` template variables will be replaced with
the list of the environment variables and the path to the script to be executed the list of the environment variables and the path to the script to be executed
respectively. respectively.
-&gt; **Note:** In addition to template variables, you can specify your own -> **Note:** In addition to template variables, you can specify your own
user variables. See the [user variable](/docs/templates/user-variables.html) user variables. See the [user variable](/docs/templates/user-variables.html)
documentation for more information on user variables. documentation for more information on user variables.
@ -316,7 +302,7 @@ this case, on the `ami_name` value):
} }
``` ```
-&gt; **Note:** See the [Amazon builder](/docs/builders/amazon.html) -> **Note:** See the [Amazon builder](/docs/builders/amazon.html)
documentation for more information on how to correctly configure the Amazon documentation for more information on how to correctly configure the Amazon
builder in this example. builder in this example.

2
website/pages/docs/templates/index.mdx vendored
View File

@ -91,7 +91,7 @@ Below is an example of a basic template that could be invoked with
`packer build`. It would create an instance in AWS, and once running copy a `packer build`. It would create an instance in AWS, and once running copy a
script to it and run that script using SSH. script to it and run that script using SSH.
-&gt; **Note:** This example requires an account with Amazon Web Services. -> **Note:** This example requires an account with Amazon Web Services.
There are a number of parameters which need to be provided for a functional There are a number of parameters which need to be provided for a functional
build to take place. See the [Amazon builder](/docs/builders/amazon.html) build to take place. See the [Amazon builder](/docs/builders/amazon.html)
documentation for more information. documentation for more information.

2
website/pages/docs/templates/post-processors.mdx vendored
View File

@ -126,7 +126,7 @@ post-processor. If you're specifying a sequence of post-processors, then all
intermediaries are discarded by default except for the input artifacts to intermediaries are discarded by default except for the input artifacts to
post-processors that explicitly state to keep the input artifact. post-processors that explicitly state to keep the input artifact.
-&gt; **Note:** The intuitive reader may be wondering what happens if multiple -> **Note:** The intuitive reader may be wondering what happens if multiple
post-processors are specified (not in a sequence). Does Packer require the post-processors are specified (not in a sequence). Does Packer require the
configuration to keep the input artifact on all the post-processors? The answer configuration to keep the input artifact on all the post-processors? The answer
is no, of course not. Packer is smart enough to figure out that at least one is no, of course not. Packer is smart enough to figure out that at least one

12
website/pages/docs/templates/user-variables.mdx vendored
View File

@ -64,11 +64,9 @@ means that the user must specify a value for this variable or template
validation will fail. validation will fail.
User variables are used by calling the `{{user}}` function in the form of User variables are used by calling the `{{user}}` function in the form of
`{{user 'variable'}}`. This function can be used in _any value_ but `type`
<code>{{user \`variable\`}}</code>. This function can be used in \*any value\* within the template: in builders, provisioners, _anywhere outside the `variables` section_.
but `type` within the template: in builders, provisioners, \*anywhere outside User variables are available globally within the rest of the template.
the `variables` section\*. User variables are available globally within the rest
of the template.
## Environment Variables ## Environment Variables
@ -88,7 +86,7 @@ An example is shown below:
This will default "my_secret" to be the value of the "MY_SECRET" environment This will default "my_secret" to be the value of the "MY_SECRET" environment
variable (or an empty string if it does not exist). variable (or an empty string if it does not exist).
-&gt; **Why can't I use environment variables elsewhere?** User variables are -> **Why can't I use environment variables elsewhere?** User variables are
the single source of configurable input to a template. We felt that having the single source of configurable input to a template. We felt that having
environment variables used _anywhere_ in a template would confuse the user environment variables used _anywhere_ in a template would confuse the user
about the possible inputs to a template. By allowing environment variables only about the possible inputs to a template. By allowing environment variables only
@ -96,7 +94,7 @@ within default values for user variables, user variables remain as the single
source of input to a template that a user can easily discover using source of input to a template that a user can easily discover using
`packer inspect`. `packer inspect`.
-&gt; **Why can't I use `~` for home variable?** `~` is an special variable -> **Why can't I use `~` for home variable?** `~` is an special variable
that is evaluated by shell during a variable expansion. As Packer doesn't run that is evaluated by shell during a variable expansion. As Packer doesn't run
inside a shell, it won't expand `~`. inside a shell, it won't expand `~`.

2
website/pages/guides/hcl/from-json-v1/index.mdx
View File

@ -11,7 +11,7 @@ description: |-
-> **Note:** Starting from version **1.5.0** Packer can read HCL2 files. -> **Note:** Starting from version **1.5.0** Packer can read HCL2 files.
@include 'partials/guides/hcl2-beta-note.mdx' @include 'guides/hcl2-beta-note.mdx'
We will soon provide a programatic way to transpose a v1 buildfile to a v1.5 We will soon provide a programatic way to transpose a v1 buildfile to a v1.5
HCL file. In the meantime we will show how to manually do it. HCL file. In the meantime we will show how to manually do it.

2
website/pages/guides/hcl/index.mdx
View File

@ -8,7 +8,7 @@ page_title: Getting started configuring Packer with HCL2 files
-> **Note:** Starting from version **1.5.0** Packer can read HCL2 files. -> **Note:** Starting from version **1.5.0** Packer can read HCL2 files.
@include 'partials/guides/hcl2-beta-note.mdx' @include 'guides/hcl2-beta-note.mdx'
It is not necessary to know all of the details of the HCL syntax in order to It is not necessary to know all of the details of the HCL syntax in order to
use Packer, and so this page summarizes the most important details to get you use Packer, and so this page summarizes the most important details to get you

2
website/pages/guides/hcl/variables/index.mdx
View File

@ -9,7 +9,7 @@ description: |-
# Input Variables and local variables # Input Variables and local variables
@include 'partials/guides/hcl2-beta-note.mdx' @include 'guides/hcl2-beta-note.mdx'
This page introduces input variables and local variables as a way to This page introduces input variables and local variables as a way to
parameterize a configuration. Once defined, input variables are settable from a parameterize a configuration. Once defined, input variables are settable from a

2
website/pages/intro/getting-started/parallel-builds.mdx
View File

@ -46,7 +46,7 @@ account now](https://www.digitalocean.com/). It is free to sign up. Because the
"droplets" (servers) are charged hourly, you _will_ be charged \$0.01 for every "droplets" (servers) are charged hourly, you _will_ be charged \$0.01 for every
image you create with Packer. If you're not okay with this, just follow along. image you create with Packer. If you're not okay with this, just follow along.
!&gt; **Warning!** You _will_ be charged \$0.01 by DigitalOcean per image !> **Warning!** You _will_ be charged \$0.01 by DigitalOcean per image
created with Packer because of the time the "droplet" is running. created with Packer because of the time the "droplet" is running.
Once you sign up for an account, grab your API token from the [DigitalOcean API Once you sign up for an account, grab your API token from the [DigitalOcean API

0
website/pages/partials/builder/alicloud/ecs/_AlicloudAccessConfig-not-required.mdx → website/pages/partials/builder/alicloud/ecs/AlicloudAccessConfig-not-required.mdx
View File

0
website/pages/partials/builder/alicloud/ecs/_AlicloudAccessConfig.mdx → website/pages/partials/builder/alicloud/ecs/AlicloudAccessConfig.mdx
View File

0
website/pages/partials/builder/alicloud/ecs/_AlicloudDiskDevice-not-required.mdx → website/pages/partials/builder/alicloud/ecs/AlicloudDiskDevice-not-required.mdx
View File

0
website/pages/partials/builder/alicloud/ecs/_AlicloudDiskDevices-not-required.mdx → website/pages/partials/builder/alicloud/ecs/AlicloudDiskDevices-not-required.mdx
View File

0
website/pages/partials/builder/alicloud/ecs/_AlicloudImageConfig-not-required.mdx → website/pages/partials/builder/alicloud/ecs/AlicloudImageConfig-not-required.mdx
View File

0
website/pages/partials/builder/alicloud/ecs/_AlicloudImageConfig-required.mdx → website/pages/partials/builder/alicloud/ecs/AlicloudImageConfig-required.mdx
View File

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