Update redirects and URLs to legacy JSON template docs (#10530)

This commit is contained in:
Wilken Rivera 2021-01-27 09:08:59 -05:00 committed by GitHub
parent 782cf058b5
commit f36554fa0e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
105 changed files with 177 additions and 177 deletions

View File

@ -162,7 +162,7 @@ type Config struct {
//filter, but will cause Packer to fail if the `source_ami` does not exist. //filter, but will cause Packer to fail if the `source_ami` does not exist.
SourceAmiFilter awscommon.AmiFilterOptions `mapstructure:"source_ami_filter" required:"false"` SourceAmiFilter awscommon.AmiFilterOptions `mapstructure:"source_ami_filter" required:"false"`
// Key/value pair tags to apply to the volumes that are *launched*. This is // Key/value pair tags to apply to the volumes that are *launched*. This is
// a [template engine](/docs/templates/engine), see [Build template // a [template engine](/docs/templates/legacy_json_templates/engine), see [Build template
// data](#build-template-data) for more information. // data](#build-template-data) for more information.
RootVolumeTags map[string]string `mapstructure:"root_volume_tags" required:"false"` RootVolumeTags map[string]string `mapstructure:"root_volume_tags" required:"false"`
// Same as [`root_volume_tags`](#root_volume_tags) but defined as a // Same as [`root_volume_tags`](#root_volume_tags) but defined as a

View File

@ -16,11 +16,11 @@ type AMIConfig struct {
// The name of the resulting AMI that will appear when managing AMIs in the // The name of the resulting AMI that will appear when managing AMIs in the
// AWS console or via APIs. This must be unique. To help make this unique, // AWS console or via APIs. This must be unique. To help make this unique,
// use a function like timestamp (see [template // use a function like timestamp (see [template
// engine](/docs/templates/engine) for more info). // engine](/docs/templates/legacy_json_templates/engine) for more info).
AMIName string `mapstructure:"ami_name" required:"true"` AMIName string `mapstructure:"ami_name" required:"true"`
// The description to set for the resulting // The description to set for the resulting
// AMI(s). By default this description is empty. This is a // AMI(s). By default this description is empty. This is a
// [template engine](/docs/templates/engine), see [Build template // [template engine](/docs/templates/legacy_json_templates/engine), see [Build template
// data](#build-template-data) for more information. // data](#build-template-data) for more information.
AMIDescription string `mapstructure:"ami_description" required:"false"` AMIDescription string `mapstructure:"ami_description" required:"false"`
// The type of virtualization for the AMI // The type of virtualization for the AMI
@ -47,7 +47,7 @@ type AMIConfig struct {
// validation of the ami_regions configuration option. Default false. // validation of the ami_regions configuration option. Default false.
AMISkipRegionValidation bool `mapstructure:"skip_region_validation" required:"false"` AMISkipRegionValidation bool `mapstructure:"skip_region_validation" required:"false"`
// Key/value pair tags applied to the AMI. This is a [template // Key/value pair tags applied to the AMI. This is a [template
// engine](/docs/templates/engine), see [Build template // engine](/docs/templates/legacy_json_templates/engine), see [Build template
// data](#build-template-data) for more information. // data](#build-template-data) for more information.
AMITags map[string]string `mapstructure:"tags" required:"false"` AMITags map[string]string `mapstructure:"tags" required:"false"`
// Same as [`tags`](#tags) but defined as a singular repeatable block // Same as [`tags`](#tags) but defined as a singular repeatable block
@ -137,7 +137,7 @@ type AMIConfig struct {
AMISkipBuildRegion bool `mapstructure:"skip_save_build_region"` AMISkipBuildRegion bool `mapstructure:"skip_save_build_region"`
// Key/value pair tags to apply to snapshot. They will override AMI tags if // Key/value pair tags to apply to snapshot. They will override AMI tags if
// already applied to snapshot. This is a [template // already applied to snapshot. This is a [template
// engine](/docs/templates/engine), see [Build template // engine](/docs/templates/legacy_json_templates/engine), see [Build template
// data](#build-template-data) for more information. // data](#build-template-data) for more information.
SnapshotTags map[string]string `mapstructure:"snapshot_tags" required:"false"` SnapshotTags map[string]string `mapstructure:"snapshot_tags" required:"false"`
// Same as [`snapshot_tags`](#snapshot_tags) but defined as a singular // Same as [`snapshot_tags`](#snapshot_tags) but defined as a singular

View File

@ -176,7 +176,7 @@ type RunConfig struct {
SecurityGroupFilter SecurityGroupFilterOptions `mapstructure:"security_group_filter" required:"false"` SecurityGroupFilter SecurityGroupFilterOptions `mapstructure:"security_group_filter" required:"false"`
// Key/value pair tags to apply to the instance that is that is *launched* // Key/value pair tags to apply to the instance that is that is *launched*
// to create the EBS volumes. This is a [template // to create the EBS volumes. This is a [template
// engine](/docs/templates/engine), see [Build template // engine](/docs/templates/legacy_json_templates/engine), see [Build template
// data](#build-template-data) for more information. // data](#build-template-data) for more information.
RunTags map[string]string `mapstructure:"run_tags" required:"false"` RunTags map[string]string `mapstructure:"run_tags" required:"false"`
// Same as [`run_tags`](#run_tags) but defined as a singular repeatable // Same as [`run_tags`](#run_tags) but defined as a singular repeatable

View File

@ -56,7 +56,7 @@ type Config struct {
// Tags to apply to the volumes that are *launched* to create the AMI. // Tags to apply to the volumes that are *launched* to create the AMI.
// These tags are *not* applied to the resulting AMI unless they're // These tags are *not* applied to the resulting AMI unless they're
// duplicated in `tags`. This is a [template // duplicated in `tags`. This is a [template
// engine](/docs/templates/engine), see [Build template // engine](/docs/templates/legacy_json_templates/engine), see [Build template
// data](#build-template-data) for more information. // data](#build-template-data) for more information.
VolumeRunTags map[string]string `mapstructure:"run_volume_tags"` VolumeRunTags map[string]string `mapstructure:"run_volume_tags"`
// Same as [`run_volume_tags`](#run_volume_tags) but defined as a singular // Same as [`run_volume_tags`](#run_volume_tags) but defined as a singular

View File

@ -59,7 +59,7 @@ type Config struct {
// Tags to apply to the volumes that are *launched* to create the AMI. // Tags to apply to the volumes that are *launched* to create the AMI.
// These tags are *not* applied to the resulting AMI unless they're // These tags are *not* applied to the resulting AMI unless they're
// duplicated in `tags`. This is a [template // duplicated in `tags`. This is a [template
// engine](/docs/templates/engine), see [Build template // engine](/docs/templates/legacy_json_templates/engine), see [Build template
// data](#build-template-data) for more information. // data](#build-template-data) for more information.
VolumeRunTags map[string]string `mapstructure:"run_volume_tags"` VolumeRunTags map[string]string `mapstructure:"run_volume_tags"`
// Same as [`run_volume_tags`](#run_volume_tags) but defined as a singular // Same as [`run_volume_tags`](#run_volume_tags) but defined as a singular

View File

@ -12,7 +12,7 @@ import (
type BlockDevice struct { type BlockDevice struct {
awscommon.BlockDevice `mapstructure:",squash"` awscommon.BlockDevice `mapstructure:",squash"`
// Key/value pair tags to apply to the volume. These are retained after the builder // Key/value pair tags to apply to the volume. These are retained after the builder
// completes. This is a [template engine](/docs/templates/engine), see // completes. This is a [template engine](/docs/templates/legacy_json_templates/engine), see
// [Build template data](#build-template-data) for more information. // [Build template data](#build-template-data) for more information.
Tags map[string]string `mapstructure:"tags" required:"false"` Tags map[string]string `mapstructure:"tags" required:"false"`
// Same as [`tags`](#tags) but defined as a singular repeatable block // Same as [`tags`](#tags) but defined as a singular repeatable block

View File

@ -58,7 +58,7 @@ type Config struct {
// *launched* to create EBS Volumes. These tags will *not* appear in the // *launched* to create EBS Volumes. These tags will *not* appear in the
// tags of the resulting EBS volumes unless they're duplicated under `tags` // tags of the resulting EBS volumes unless they're duplicated under `tags`
// in the `ebs_volumes` setting. This is a [template // in the `ebs_volumes` setting. This is a [template
// engine](/docs/templates/engine), see [Build template // engine](/docs/templates/legacy_json_templates/engine), see [Build template
// data](#build-template-data) for more information. // data](#build-template-data) for more information.
// //
// Note: The tags specified here will be *temporarily* applied to volumes // Note: The tags specified here will be *temporarily* applied to volumes

View File

@ -33,7 +33,7 @@ type GuestAdditionsConfig struct {
// where the VirtualBox guest additions ISO will be uploaded. By default this // where the VirtualBox guest additions ISO will be uploaded. By default this
// is `VBoxGuestAdditions.iso` which should upload into the login directory of // is `VBoxGuestAdditions.iso` which should upload into the login directory of
// the user. This is a [configuration // the user. This is a [configuration
// template](/docs/templates/engine) where the `Version` // template](/docs/templates/legacy_json_templates/engine) where the `Version`
// variable is replaced with the VirtualBox version. // variable is replaced with the VirtualBox version.
GuestAdditionsPath string `mapstructure:"guest_additions_path"` GuestAdditionsPath string `mapstructure:"guest_additions_path"`
// The SHA256 checksum of the guest // The SHA256 checksum of the guest

View File

@ -37,7 +37,7 @@ type VBoxManageConfig struct {
// followed by the CPUs. // followed by the CPUs.
// Each command itself is an array of strings, where each string is an argument to // Each command itself is an array of strings, where each string is an argument to
// `VBoxManage`. Each argument is treated as a [configuration // `VBoxManage`. Each argument is treated as a [configuration
// template](/docs/templates/engine). The only available // template](/docs/templates/legacy_json_templates/engine). The only available
// variable is `Name` which is replaced with the unique name of the VM, which is // variable is `Name` which is replaced with the unique name of the VM, which is
// required for many VBoxManage calls. // required for many VBoxManage calls.
VBoxManage [][]string `mapstructure:"vboxmanage" required:"false"` VBoxManage [][]string `mapstructure:"vboxmanage" required:"false"`

View File

@ -15,7 +15,7 @@ type ToolsConfig struct {
ToolsUploadFlavor string `mapstructure:"tools_upload_flavor" required:"false"` ToolsUploadFlavor string `mapstructure:"tools_upload_flavor" required:"false"`
// The path in the VM to upload the VMware tools. This only takes effect if // The path in the VM to upload the VMware tools. This only takes effect if
// `tools_upload_flavor` is non-empty. This is a [configuration // `tools_upload_flavor` is non-empty. This is a [configuration
// template](/docs/templates/engine) that has a single valid variable: // template](/docs/templates/legacy_json_templates/engine) that has a single valid variable:
// `Flavor`, which will be the value of `tools_upload_flavor`. By default // `Flavor`, which will be the value of `tools_upload_flavor`. By default
// the upload path is set to `{{.Flavor}}.iso`. This setting is not used // the upload path is set to `{{.Flavor}}.iso`. This setting is not used
// when `remote_type` is `esx5`. // when `remote_type` is `esx5`.

View File

@ -66,7 +66,7 @@ type Config struct {
VMName string `mapstructure:"vm_name" required:"false"` VMName string `mapstructure:"vm_name" required:"false"`
VMXDiskTemplatePath string `mapstructure:"vmx_disk_template_path"` VMXDiskTemplatePath string `mapstructure:"vmx_disk_template_path"`
// Path to a [configuration template](/docs/templates/engine) that // Path to a [configuration template](/docs/templates/legacy_json_templates/engine) that
// defines the contents of the virtual machine VMX file for VMware. The // defines the contents of the virtual machine VMX file for VMware. The
// engine has access to the template variables `{{ .DiskNumber }}` and // engine has access to the template variables `{{ .DiskNumber }}` and
// `{{ .DiskName }}`. // `{{ .DiskName }}`.

View File

@ -64,8 +64,8 @@ type Config struct {
OSSBucket string `mapstructure:"oss_bucket_name" required:"true"` OSSBucket string `mapstructure:"oss_bucket_name" required:"true"`
// The name of the object key in `oss_bucket_name` where the RAW or VHD // The name of the object key in `oss_bucket_name` where the RAW or VHD
// file will be copied to for import. This is treated as a [template // file will be copied to for import. This is treated as a [template
// engine](/docs/templates/engine), and you may access any of the variables // engine](/docs/templates/legacy_json_templates/engine), and you may access any of the variables
// stored in the generated data using the [build](/docs/templates/engine) // stored in the generated data using the [build](/docs/templates/legacy_json_templates/engine)
// template function. // template function.
OSSKey string `mapstructure:"oss_key_name"` OSSKey string `mapstructure:"oss_key_name"`
// Whether we should skip removing the RAW or VHD file uploaded to OSS // Whether we should skip removing the RAW or VHD file uploaded to OSS

View File

@ -43,7 +43,7 @@ type Config struct {
Bucket string `mapstructure:"bucket" required:"true"` Bucket string `mapstructure:"bucket" required:"true"`
//The name of the GCS object in `bucket` where //The name of the GCS object in `bucket` where
//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). Therefore, you //[template engine](/docs/templates/legacy_json_templates/engine). 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`.
GCSObjectName string `mapstructure:"gcs_object_name"` GCSObjectName string `mapstructure:"gcs_object_name"`

View File

@ -32,7 +32,7 @@ type Config struct {
// Don't write the `build_time` field from the output. // Don't write the `build_time` field from the output.
StripTime bool `mapstructure:"strip_time"` StripTime bool `mapstructure:"strip_time"`
// Arbitrary data to add to the manifest. This is a [template // Arbitrary data to add to the manifest. This is a [template
// engine](https://packer.io/docs/templates/engine.html). Therefore, you // engine](https://packer.io/docs/templates/legacy_json_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.
CustomData map[string]string `mapstructure:"custom_data"` CustomData map[string]string `mapstructure:"custom_data"`
ctx interpolate.Context ctx interpolate.Context

View File

@ -49,7 +49,7 @@ type Config struct {
UFileBucket string `mapstructure:"ufile_bucket_name" required:"true"` UFileBucket string `mapstructure:"ufile_bucket_name" required:"true"`
// The name of the object key in // The name of the object key in
// `ufile_bucket_name` where the RAW, VHD, VMDK, or qcow2 file will be copied // `ufile_bucket_name` where the RAW, VHD, VMDK, or qcow2 file will be copied
// to import. This is a [template engine](/docs/templates/engine). // to import. This is a [template engine](/docs/templates/legacy_json_templates/engine).
// Therefore, you may use user variables and template functions in this field. // Therefore, you may use user variables and template functions in this field.
UFileKey string `mapstructure:"ufile_key_name" required:"false"` UFileKey string `mapstructure:"ufile_key_name" required:"false"`
// Whether we should skip removing the RAW, VHD, VMDK, or qcow2 file uploaded to // Whether we should skip removing the RAW, VHD, VMDK, or qcow2 file uploaded to

View File

@ -46,7 +46,7 @@ type Config struct {
// List of paths to Yandex Object Storage where exported image will be uploaded. // List of paths to Yandex Object Storage where exported image will be uploaded.
// Please be aware that use of space char inside path not supported. // Please be aware that use of space char inside path not supported.
// Also this param support [build](/docs/templates/engine) template function. // Also this param support [build](/docs/templates/legacy_json_templates/engine) template function.
// Check available template data for [Yandex](/docs/builders/yandex#build-template-data) builder. // Check available template data for [Yandex](/docs/builders/yandex#build-template-data) builder.
// Paths to Yandex Object Storage where exported image will be uploaded. // Paths to Yandex Object Storage where exported image will be uploaded.
Paths []string `mapstructure:"paths" required:"true"` Paths []string `mapstructure:"paths" required:"true"`

View File

@ -34,7 +34,7 @@ type Config struct {
// in storage service and first paths (URL) is used to, so no need to set this param. // in storage service and first paths (URL) is used to, so no need to set this param.
Bucket string `mapstructure:"bucket" required:"false"` Bucket string `mapstructure:"bucket" required:"false"`
// The name of the object key in `bucket` where the qcow2 file will be copied to import. // The name of the object key in `bucket` where the qcow2 file will be copied to import.
// This is a [template engine](/docs/templates/engine). // This is a [template engine](/docs/templates/legacy_json_templates/engine).
// Therefore, you may use user variables and template functions in this field. // Therefore, you may use user variables and template functions in this field.
ObjectName string `mapstructure:"object_name" required:"false"` ObjectName string `mapstructure:"object_name" required:"false"`
// Whether skip removing the qcow2 file uploaded to Storage // Whether skip removing the qcow2 file uploaded to Storage

View File

@ -76,7 +76,7 @@ type Config struct {
// "ansible_env_vars": [ "ANSIBLE_HOST_KEY_CHECKING=False", "ANSIBLE_SSH_ARGS='-o ForwardAgent=yes -o ControlMaster=auto -o ControlPersist=60s'", "ANSIBLE_NOCOLOR=True" ] // "ansible_env_vars": [ "ANSIBLE_HOST_KEY_CHECKING=False", "ANSIBLE_SSH_ARGS='-o ForwardAgent=yes -o ControlMaster=auto -o ControlPersist=60s'", "ANSIBLE_NOCOLOR=True" ]
// ``` // ```
// //
// This is a [template engine](/docs/templates/engine). Therefore, you // This is a [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you
// may use user variables and template functions in this field. // may use user variables and template functions in this field.
// //
// For example, if you are running a Windows build on AWS, Azure, // For example, if you are running a Windows build on AWS, Azure,

View File

@ -17,7 +17,7 @@ customized images based on an existing base images.
The following configuration options are available for building Alicloud images. The following configuration options are available for building Alicloud images.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. builder.
### Required: ### Required:

View File

@ -514,7 +514,7 @@ variables are available:
## Build Shared Information Variables ## Build Shared Information Variables
This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/legacy_json_templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2.
The generated variables available for this builder are: The generated variables available for this builder are:

View File

@ -323,7 +323,7 @@ variables are available:
## Build Shared Information Variables ## Build Shared Information Variables
This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/legacy_json_templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2.
The generated variables available for this builder are: The generated variables available for this builder are:

View File

@ -227,7 +227,7 @@ variables are available:
## Build Shared Information Variables ## Build Shared Information Variables
This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/legacy_json_templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2.
The generated variables available for this builder are: The generated variables available for this builder are:

View File

@ -258,7 +258,7 @@ variables are available:
## Build Shared Information Variables ## Build Shared Information Variables
This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/legacy_json_templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2.
The generated variables available for this builder are: The generated variables available for this builder are:
@ -281,7 +281,7 @@ marked for deletion on termination will remain in your account.
## Build Shared Information Variables ## Build Shared Information Variables
This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/legacy_json_templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2.
The generated variables available for this builder are: The generated variables available for this builder are:

View File

@ -220,7 +220,7 @@ variables are available:
## Build Shared Information Variables ## Build Shared Information Variables
This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/legacy_json_templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2.
The generated variables available for this builder are: The generated variables available for this builder are:
@ -299,7 +299,7 @@ upload the AMI.
These are configured with `bundle_vol_command` and `bundle_upload_command`. These are configured with `bundle_vol_command` and `bundle_upload_command`.
Both of these configurations are [configuration Both of these configurations are [configuration
templates](/docs/templates/engine) and have support for their own set of templates](/docs/templates/legacy_json_templates/engine) and have support for their own set of
template variables. template variables.
### Bundle Volume Command ### Bundle Volume Command

View File

@ -25,7 +25,7 @@ CLI](https://azure.microsoft.com/en-us/documentation/articles/xplat-cli-install/
There are many configuration options available for the builder. We'll start There are many configuration options available for the builder. We'll start
with authentication parameters, then go over the Azure ARM builder specific with authentication parameters, then go over the Azure ARM builder specific
options. In addition to the options listed here, a [communicator](/docs/templates/communicator) can be configured for this builder. options. In addition to the options listed here, a [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this builder.
### Authentication options ### Authentication options

View File

@ -27,7 +27,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized. each category, the available configuration keys are alphabetized.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. builder.
### Required: ### Required:
@ -174,14 +174,14 @@ builder.
`packer_<UUID>`, where &lt;UUID&gt; is a 36 character unique identifier. `packer_<UUID>`, where &lt;UUID&gt; is a 36 character unique identifier.
- `user_data` (string) - User data to launch with the instance. This is a - `user_data` (string) - User data to launch with the instance. This is a
[template engine](/docs/templates/engine) see _User Data_ bellow for [template engine](/docs/templates/legacy_json_templates/engine) see _User Data_ bellow for
more details. Packer will not automatically wait for a user script to more details. Packer will not automatically wait for a user script to
finish before shutting down the instance this must be handled in a finish before shutting down the instance this must be handled in a
provisioner. provisioner.
- `user_data_file` (string) - Path to a file that will be used for the user - `user_data_file` (string) - Path to a file that will be used for the user
data when launching the instance. This file will be parsed as a [template data when launching the instance. This file will be parsed as a [template
engine](/docs/templates/engine) see _User Data_ bellow for more engine](/docs/templates/legacy_json_templates/engine) see _User Data_ bellow for more
details. details.
- `use_local_ip_address` (boolean) - Set to `true` to indicate that the - `use_local_ip_address` (boolean) - Set to `true` to indicate that the

View File

@ -36,7 +36,7 @@ each category, the available configuration keys are alphabetized.
### Communicator Config ### Communicator Config
In addition to the builder options, a In addition to the builder options, a
[communicator](/docs/templates/communicator) can be configured for this builder. [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this builder.
@include 'packer-plugin-sdk/communicator/Config-not-required.mdx' @include 'packer-plugin-sdk/communicator/Config-not-required.mdx'
@ -84,7 +84,7 @@ In addition to the builder options, a
- `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) for more info). [configuration templates](/docs/templates/legacy_json_templates/engine) for more info).
- `snapshot_regions` (array of strings) - The regions of the resulting - `snapshot_regions` (array of strings) - The regions of the resulting
snapshot that will appear in your account. snapshot that will appear in your account.

View File

@ -200,7 +200,7 @@ optional. Within each category, the available options are alphabetized and
described. described.
The Docker builder uses a special Docker communicator _and will not use_ the The Docker builder uses a special Docker communicator _and will not use_ the
standard [communicators](/docs/templates/communicator). standard [communicators](/docs/templates/legacy_json_templates/communicators).
### Required: ### Required:
@ -216,7 +216,7 @@ You must specify (only) one of `commit`, `discard`, or `export_path`.
## Build Shared Information Variables ## Build Shared Information Variables
This build shares generated data with provisioners and post-processors via [template engines](/docs/templates/engine) This build shares generated data with provisioners and post-processors via [template engines](/docs/templates/legacy_json_templates/engine)
for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2.
The generated variable available for this builder is: The generated variable available for this builder is:
@ -238,7 +238,7 @@ If you set `commit`, see the next section.
The example below shows a full configuration that would import and push the The example below shows a full configuration that would import and push the
created image. This is accomplished using a sequence definition (a collection created image. This is accomplished using a sequence definition (a collection
of post-processors that are treated as as single pipeline, see of post-processors that are treated as as single pipeline, see
[Post-Processors](/docs/templates/post-processors) for more information): [Post-Processors](/docs/templates/legacy_json_templates/post-processors) for more information):
<Tabs> <Tabs>
<Tab heading="JSON"> <Tab heading="JSON">
@ -299,7 +299,7 @@ If you committed your container to an image, you probably want to tag, save,
push, etc. Packer can do this automatically for you. An example is shown below push, etc. Packer can do this automatically for you. An example is shown below
which tags and pushes an image. This is accomplished using a sequence which tags and pushes an image. This is accomplished using a sequence
definition (a collection of post-processors that are treated as as single definition (a collection of post-processors that are treated as as single
pipeline, see [Post-Processors](/docs/templates/post-processors) for more pipeline, see [Post-Processors](/docs/templates/legacy_json_templates/post-processors) for more
information): information):
<Tabs> <Tabs>

View File

@ -54,7 +54,7 @@ Configuration options are organized below into two categories: required and
optional. Within each category, the available options are alphabetized and optional. Within each category, the available options are alphabetized and
described. described.
Any [communicator](/docs/templates/communicator) defined is ignored. Any [communicator](/docs/templates/legacy_json_templates/communicators) defined is ignored.
### Required: ### Required:

View File

@ -342,7 +342,7 @@ optional. Within each category, the available options are alphabetized and
described. described.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. builder.
### Communicator Configuration ### Communicator Configuration

View File

@ -29,7 +29,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized. each category, the available configuration keys are alphabetized.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. builder.
### Required Builder Configuration options: ### Required Builder Configuration options:
@ -83,7 +83,7 @@ builder.
- `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 as image description. Defaults to `packer-{{timestamp}}` (see appear in your account as image description. Defaults to `packer-{{timestamp}}` (see
[configuration templates](/docs/templates/engine) for more info). If you want to reference the image as a sample in your terraform configuration please use the image id or the `snapshot_labels`. [configuration templates](/docs/templates/legacy_json_templates/engine) for more info). If you want to reference the image as a sample in your terraform configuration please use the image id or the `snapshot_labels`.
- `snapshot_labels` (map of key/value strings) - Key/value pair labels to - `snapshot_labels` (map of key/value strings) - Key/value pair labels to
apply to the created image. apply to the created image.

View File

@ -86,7 +86,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized. each category, the available configuration keys are alphabetized.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. builder.
### Required: ### Required:
@ -122,7 +122,7 @@ builder.
- `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) for more info). (see [configuration templates](/docs/templates/legacy_json_templates/engine) for more info).
- `image_service` (string) - The service of the resulting image. - `image_service` (string) - The service of the resulting image.

View File

@ -65,7 +65,7 @@ are organized below into two categories: required and optional. Within each
category, the available options are alphabetized and described. category, the available options are alphabetized and described.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. builder.
### Optional: ### Optional:

View File

@ -66,7 +66,7 @@ are organized below into two categories: required and optional. Within each
category, the available options are alphabetized and described. category, the available options are alphabetized and described.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. builder.
## ISO Configuration Reference ## ISO Configuration Reference

View File

@ -35,7 +35,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized. each category, the available configuration keys are alphabetized.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. In addition to the options defined there, a private key file builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key: can also be supplied to override the typical auto-generated key:
@ -77,7 +77,7 @@ can also be supplied to override the typical auto-generated key:
- `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) for more info). templates](/docs/templates/legacy_json_templates/engine) for more info).
- `image_description` (string) - The description of the resulting image that - `image_description` (string) - The description of the resulting image that
will appear in your account. Defaults to "". will appear in your account. Defaults to "".

View File

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

View File

@ -18,7 +18,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized. each category, the available configuration keys are alphabetized.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. In addition to the options defined there, a private key file builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key: can also be supplied to override the typical auto-generated key:

View File

@ -51,7 +51,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized. each category, the available configuration keys are alphabetized.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. builder.
### Required: ### Required:

View File

@ -40,7 +40,7 @@ in which case you don't need the above user authorization.
There are many configuration options available for the `oracle-oci` builder. In There are many configuration options available for the `oracle-oci` builder. In
addition to the options listed here, a addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. builder.
In addition to the options defined there, a private key file In addition to the options defined there, a private key file

View File

@ -41,14 +41,14 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized. each category, the available configuration keys are alphabetized.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. builder.
### Required: ### Required:
- `access_key` (string) - The access key used to communicate with OUTSCALE. [Learn how to set this](/docs/builders/outscale#authentication) - `access_key` (string) - The access key used to communicate with OUTSCALE. [Learn how to set this](/docs/builders/outscale#authentication)
- `omi_name` (string) - The name of the resulting OMIS that will appear when managing OMIs in the Outscale console or via APIs. This must be unique. To help make this unique, use a function like `timestamp` (see [template engine](/docs/templates/engine) for more info). - `omi_name` (string) - The name of the resulting OMIS that will appear when managing OMIs in the Outscale console or via APIs. This must be unique. To help make this unique, use a function like `timestamp` (see [template engine](/docs/templates/legacy_json_templates/engine) for more info).
- `vm_type` (string) - The Outscale VM type to use while building the OMI, such as `t2.small`. - `vm_type` (string) - The Outscale VM type to use while building the OMI, such as `t2.small`.
@ -81,7 +81,7 @@ builder.
- `volume_type` (string) - The volume type. `gp2` for General Purpose (SSD) volumes, `io1` for Provisioned IOPS (SSD) volumes, and `standard` for Magnetic volumes - `volume_type` (string) - The volume type. `gp2` for General Purpose (SSD) volumes, `io1` for Provisioned IOPS (SSD) volumes, and `standard` for Magnetic volumes
- `omi_description` (string) - The description to set for the resulting OMI(s). By default this description is empty. This is a [template engine](/docs/templates/engine), see [Build template - `omi_description` (string) - The description to set for the resulting OMI(s). By default this description is empty. This is a [template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `omi_account_ids` (array of strings) - A list of account IDs that have access to launch the resulting OMI(s). By default no additional users other than the user creating the OMIS has permissions to launch it. - `omi_account_ids` (array of strings) - A list of account IDs that have access to launch the resulting OMI(s). By default no additional users other than the user creating the OMIS has permissions to launch it.
@ -131,13 +131,13 @@ builder.
- `run_tags` (object of key/value strings) - Tags to apply to the VM - `run_tags` (object of key/value strings) - Tags to apply to the VM
that is _launched_ to create the OMI. These tags are _not_ applied to the that is _launched_ to create the OMI. These tags are _not_ applied to the
resulting OMIS unless they're duplicated in `tags`. This is a [template resulting OMIS unless they're duplicated in `tags`. This is a [template
engine](/docs/templates/engine), see [Build template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `run_volume_tags` (object of key/value strings) - Tags to apply to the - `run_volume_tags` (object of key/value strings) - Tags to apply to the
volumes that are _launched_ to create the OMI. These tags are _not_ applied volumes that are _launched_ to create the OMI. These tags are _not_ applied
to the resulting OMIS unless they're duplicated in `tags`. This is a to the resulting OMIS unless they're duplicated in `tags`. This is a
[template engine](/docs/templates/engine), see [Build template [template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `security_group_id` (string) - The ID (_not_ the name) of the security - `security_group_id` (string) - The ID (_not_ the name) of the security
@ -169,7 +169,7 @@ builder.
- `snapshot_tags` (object of key/value strings) - Tags to apply to snapshot. - `snapshot_tags` (object of key/value strings) - Tags to apply to snapshot.
They will override OMIS tags if already applied to snapshot. This is a They will override OMIS tags if already applied to snapshot. This is a
[template engine](/docs/templates/engine), see [Build template [template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `source_omi_filter` (object) - Filters used to populate the `source_omi` field. - `source_omi_filter` (object) - Filters used to populate the `source_omi` field.
@ -208,7 +208,7 @@ builder.
- `subnet_id` (string) - If using Net, the ID of the subnet, such as `subnet-12345def`, where Packer will launch the VM. This field is required if you are using an non-default Net. - `subnet_id` (string) - If using Net, the ID of the subnet, such as `subnet-12345def`, where Packer will launch the VM. This field is required if you are using an non-default Net.
- `tags` (object of key/value strings) - Tags applied to the OMIS and relevant snapshots. This is a [template engine](/docs/templates/engine), see [Build template data](#build-template-data) for more information. - `tags` (object of key/value strings) - Tags applied to the OMIS and relevant snapshots. This is a [template engine](/docs/templates/legacy_json_templates/engine), see [Build template data](#build-template-data) for more information.
- `temporary_key_pair_name` (string) - The name of the temporary key pair to generate. By default, Packer generates a name that looks like `packer_<UUID>`, where &lt;UUID&gt; is a 36 character unique identifier. - `temporary_key_pair_name` (string) - The name of the temporary key pair to generate. By default, Packer generates a name that looks like `packer_<UUID>`, where &lt;UUID&gt; is a 36 character unique identifier.

View File

@ -29,14 +29,14 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized. each category, the available configuration keys are alphabetized.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. builder.
### Required: ### Required:
- `access_key` (string) - The access key used to communicate with OUTSCALE. [Learn how to set this](/docs/builders/outscale#authentication) - `access_key` (string) - The access key used to communicate with OUTSCALE. [Learn how to set this](/docs/builders/outscale#authentication)
- `omi_name` (string) - The name of the resulting OMIS that will appear when managing OMIs in the Outscale console or via APIs. This must be unique. To help make this unique, use a function like `timestamp` (see [template engine](/docs/templates/engine) for more info). - `omi_name` (string) - The name of the resulting OMIS that will appear when managing OMIs in the Outscale console or via APIs. This must be unique. To help make this unique, use a function like `timestamp` (see [template engine](/docs/templates/legacy_json_templates/engine) for more info).
- `vm_type` (string) - The Outscale VM type to use while building the OMI, such as `t2.small`. - `vm_type` (string) - The Outscale VM type to use while building the OMI, such as `t2.small`.
@ -77,7 +77,7 @@ builder.
- `volume_type` (string) - The volume type. `gp2` for General Purpose (SSD) volumes, `io1` for Provisioned IOPS (SSD) volumes, and `standard` for Magnetic volumes - `volume_type` (string) - The volume type. `gp2` for General Purpose (SSD) volumes, `io1` for Provisioned IOPS (SSD) volumes, and `standard` for Magnetic volumes
- `omi_description` (string) - The description to set for the resulting OMI(s). By default this description is empty. This is a [template engine](/docs/templates/engine), see [Build template - `omi_description` (string) - The description to set for the resulting OMI(s). By default this description is empty. This is a [template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `omi_account_ids` (array of strings) - A list of account IDs that have access to launch the resulting OMI(s). By default no additional users other than the user creating the OMIS has permissions to launch it. - `omi_account_ids` (array of strings) - A list of account IDs that have access to launch the resulting OMI(s). By default no additional users other than the user creating the OMIS has permissions to launch it.
@ -139,13 +139,13 @@ builder.
- `run_tags` (object of key/value strings) - Tags to apply to the VM - `run_tags` (object of key/value strings) - Tags to apply to the VM
that is _launched_ to create the OMI. These tags are _not_ applied to the that is _launched_ to create the OMI. These tags are _not_ applied to the
resulting OMIS unless they're duplicated in `tags`. This is a [template resulting OMIS unless they're duplicated in `tags`. This is a [template
engine](/docs/templates/engine), see [Build template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `run_volume_tags` (object of key/value strings) - Tags to apply to the - `run_volume_tags` (object of key/value strings) - Tags to apply to the
volumes that are _launched_ to create the OMI. These tags are _not_ applied volumes that are _launched_ to create the OMI. These tags are _not_ applied
to the resulting OMIS unless they're duplicated in `tags`. This is a to the resulting OMIS unless they're duplicated in `tags`. This is a
[template engine](/docs/templates/engine), see [Build template [template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `security_group_id` (string) - The ID (_not_ the name) of the security - `security_group_id` (string) - The ID (_not_ the name) of the security
@ -177,7 +177,7 @@ builder.
- `snapshot_tags` (object of key/value strings) - Tags to apply to snapshot. - `snapshot_tags` (object of key/value strings) - Tags to apply to snapshot.
They will override OMIS tags if already applied to snapshot. This is a They will override OMIS tags if already applied to snapshot. This is a
[template engine](/docs/templates/engine), see [Build template [template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `source_omi_filter` (object) - Filters used to populate the `source_omi` field. - `source_omi_filter` (object) - Filters used to populate the `source_omi` field.
@ -214,7 +214,7 @@ builder.
- `subnet_id` (string) - If using Net, the ID of the subnet, such as `subnet-12345def`, where Packer will launch the VM. This field is required if you are using an non-default Net. - `subnet_id` (string) - If using Net, the ID of the subnet, such as `subnet-12345def`, where Packer will launch the VM. This field is required if you are using an non-default Net.
- `tags` (object of key/value strings) - Tags applied to the OMIS and relevant snapshots. This is a [template engine](/docs/templates/engine), see [Build template data](#build-template-data) for more information. - `tags` (object of key/value strings) - Tags applied to the OMIS and relevant snapshots. This is a [template engine](/docs/templates/legacy_json_templates/engine), see [Build template data](#build-template-data) for more information.
- `temporary_key_pair_name` (string) - The name of the temporary key pair to generate. By default, Packer generates a name that looks like `packer_<UUID>`, where &lt;UUID&gt; is a 36 character unique identifier. - `temporary_key_pair_name` (string) - The name of the temporary key pair to generate. By default, Packer generates a name that looks like `packer_<UUID>`, where &lt;UUID&gt; is a 36 character unique identifier.

View File

@ -35,7 +35,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized. each category, the available configuration keys are alphabetized.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. builder.
### Required: ### Required:
@ -74,7 +74,7 @@ builder.
- `tags` (map) - Tags to apply to the volume. These are retained after - `tags` (map) - Tags to apply to the volume. These are retained after
the builder completes. This is a [template the builder completes. This is a [template
engine](/docs/templates/engine), see [Build template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `associate_public_ip_address` (boolean) - If using a non-default Net, public IP addresses are not provided by default. If this is toggled, your new VM will get a Public IP. - `associate_public_ip_address` (boolean) - If using a non-default Net, public IP addresses are not provided by default. If this is toggled, your new VM will get a Public IP.
@ -104,7 +104,7 @@ builder.
- `run_tags` (object of key/value strings) - Tags to apply to the instance - `run_tags` (object of key/value strings) - Tags to apply to the instance
that is _launched_ to create the OMI. These tags are _not_ applied to the that is _launched_ to create the OMI. These tags are _not_ applied to the
resulting OMI unless they're duplicated in `tags`. This is a [template resulting OMI unless they're duplicated in `tags`. This is a [template
engine](/docs/templates/engine), see [Build template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `security_group_id` (string) - The ID (_not_ the name) of the security - `security_group_id` (string) - The ID (_not_ the name) of the security

View File

@ -62,7 +62,7 @@ each category, the available configuration keys are alphabetized.
- `access_key` (string) - The access key used to communicate with OUTSCALE. [Learn how to set this](/docs/builders/outscale#authentication) - `access_key` (string) - The access key used to communicate with OUTSCALE. [Learn how to set this](/docs/builders/outscale#authentication)
- `omi_name` (string) - The name of the resulting OMIS that will appear when managing OMIs in the Outscale console or via APIs. This must be unique. To help make this unique, use a function like `timestamp` (see [template engine](/docs/templates/engine) for more info). - `omi_name` (string) - The name of the resulting OMIS that will appear when managing OMIs in the Outscale console or via APIs. This must be unique. To help make this unique, use a function like `timestamp` (see [template engine](/docs/templates/legacy_json_templates/engine) for more info).
- `secret_key` (string) - The secret key used to communicate with Outscale. [Learn how to set this](/docs/builders/outscale#authentication) - `secret_key` (string) - The secret key used to communicate with Outscale. [Learn how to set this](/docs/builders/outscale#authentication)
@ -71,7 +71,7 @@ each category, the available configuration keys are alphabetized.
### Optional: ### Optional:
- `omi_description` (string) - The description to set for the resulting OMI(s). - `omi_description` (string) - The description to set for the resulting OMI(s).
By default this description is empty. This is a [template engine](/docs/templates/engine), By default this description is empty. This is a [template engine](/docs/templates/legacy_json_templates/engine),
see [Build template data](#build-template-data) for more information. see [Build template data](#build-template-data) for more information.
- `omi_account_ids` (array of strings) - A list of account IDs that have access to launch the resulting OMI(s). By default no additional users other than the user creating the OMIS has permissions to launch it. - `omi_account_ids` (array of strings) - A list of account IDs that have access to launch the resulting OMI(s). By default no additional users other than the user creating the OMIS has permissions to launch it.
@ -193,7 +193,7 @@ each category, the available configuration keys are alphabetized.
- `root_volume_tags` (object of key/value strings) - Tags to apply to the - `root_volume_tags` (object of key/value strings) - Tags to apply to the
volumes that are _launched_. This is a [template volumes that are _launched_. This is a [template
engine](/docs/templates/engine), see [Build template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `skip_region_validation` (boolean) - Set to true if you want to skip - `skip_region_validation` (boolean) - Set to true if you want to skip
@ -201,7 +201,7 @@ each category, the available configuration keys are alphabetized.
- `snapshot_tags` (object of key/value strings) - Tags to apply to snapshot. - `snapshot_tags` (object of key/value strings) - Tags to apply to snapshot.
They will override OMI tags if already applied to snapshot. This is a They will override OMI tags if already applied to snapshot. This is a
[template engine](/docs/templates/engine), see [Build template [template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `snapshot_groups` (array of strings) - A list of groups that have access to - `snapshot_groups` (array of strings) - A list of groups that have access to
@ -245,7 +245,7 @@ each category, the available configuration keys are alphabetized.
filter, but will cause Packer to fail if the `source_omi` does not exist. filter, but will cause Packer to fail if the `source_omi` does not exist.
- `tags` (object of key/value strings) - Tags applied to the OMI. This is a - `tags` (object of key/value strings) - Tags applied to the OMI. This is a
[template engine](/docs/templates/engine), see [Build template [template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
## Basic Example ## Basic Example

View File

@ -53,7 +53,7 @@ are organized below into two categories: required and optional. Within each
category, the available options are alphabetized and described. category, the available options are alphabetized and described.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. In addition to the options defined there, a private key file builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key: can also be supplied to override the typical auto-generated key:
@ -172,7 +172,7 @@ can also be supplied to override the typical auto-generated key:
- `parallels_tools_guest_path` (string) - The path in the virtual machine to - `parallels_tools_guest_path` (string) - The path in the virtual machine to
upload Parallels Tools. This only takes effect if `parallels_tools_mode` upload Parallels Tools. This only takes effect if `parallels_tools_mode`
is "upload". This is a [configuration is "upload". This is a [configuration
template](/docs/templates/engine) that has a single template](/docs/templates/legacy_json_templates/engine) 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.
@ -191,7 +191,7 @@ can also be supplied to override the typical auto-generated key:
itself as an array of strings, where each string represents a single itself as an array of strings, where each string represents a single
argument on the command-line to `prlctl` (but excluding `prlctl` itself). argument on the command-line to `prlctl` (but excluding `prlctl` itself).
Each arg is treated as a [configuration Each arg is treated as a [configuration
template](/docs/templates/engine), where the `Name` template](/docs/templates/legacy_json_templates/engine), where the `Name`
variable is replaced with the VM name. More details on how to use `prlctl` variable is replaced with the VM name. More details on how to use `prlctl`
are below. are below.
@ -293,6 +293,6 @@ executed in the order defined. So in the above example, 3d acceleration will be
first, followed by the command which enables the adaptive hypervisor. first, followed by the command which enables the adaptive hypervisor.
Each command itself is an array of strings, where each string is an argument to Each command itself is an array of strings, where each string is an argument to
`prlctl`. Each argument is treated as a [template engine](/docs/templates/engine). The only available `prlctl`. Each argument is treated as a [template engine](/docs/templates/legacy_json_templates/engine). The only available
variable is `Name` which is replaced with the unique name of the VM, which is variable is `Name` which is replaced with the unique name of the VM, which is
required for many `prlctl` calls. required for many `prlctl` calls.

View File

@ -50,7 +50,7 @@ are organized below into two categories: required and optional. Within each
category, the available options are alphabetized and described. category, the available options are alphabetized and described.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. In addition to the options defined there, a private key file builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key: can also be supplied to override the typical auto-generated key:
@ -112,7 +112,7 @@ can also be supplied to override the typical auto-generated key:
- `parallels_tools_guest_path` (string) - The path in the VM to upload - `parallels_tools_guest_path` (string) - The path in the VM to upload
Parallels Tools. This only takes effect if `parallels_tools_mode` Parallels Tools. This only takes effect if `parallels_tools_mode`
is "upload". This is a [configuration is "upload". This is a [configuration
template](/docs/templates/engine) that has a single template](/docs/templates/legacy_json_templates/engine) 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.
@ -131,7 +131,7 @@ can also be supplied to override the typical auto-generated key:
itself as an array of strings, where each string represents a single itself as an array of strings, where each string represents a single
argument on the command-line to `prlctl` (but excluding `prlctl` itself). argument on the command-line to `prlctl` (but excluding `prlctl` itself).
Each arg is treated as a [configuration Each arg is treated as a [configuration
template](/docs/templates/engine), where the `Name` template](/docs/templates/legacy_json_templates/engine), where the `Name`
variable is replaced with the VM name. More details on how to use `prlctl` variable is replaced with the VM name. More details on how to use `prlctl`
are below. are below.
@ -219,6 +219,6 @@ followed by the CPUs.
Each command itself is an array of strings, where each string is an argument to Each command itself is an array of strings, where each string is an argument to
`prlctl`. Each argument is treated as a [configuration `prlctl`. Each argument is treated as a [configuration
template](/docs/templates/engine). The only available template](/docs/templates/legacy_json_templates/engine). The only available
variable is `Name` which is replaced with the unique name of the VM, which is variable is `Name` which is replaced with the unique name of the VM, which is
required for many `prlctl` calls. required for many `prlctl` calls.

View File

@ -18,7 +18,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized. each category, the available configuration keys are alphabetized.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. In addition to the options defined there, a private key file builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key: can also be supplied to override the typical auto-generated key:

View File

@ -28,7 +28,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized. each category, the available configuration keys are alphabetized.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. builder.
If no communicator is defined, an SSH key is generated for use, and is used If no communicator is defined, an SSH key is generated for use, and is used

View File

@ -28,7 +28,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized. each category, the available configuration keys are alphabetized.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. builder.
### Required: ### Required:

View File

@ -34,7 +34,7 @@ segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized. each category, the available configuration keys are alphabetized.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. In addition to the options defined there, a private key file builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key: can also be supplied to override the typical auto-generated key:

View File

@ -17,7 +17,7 @@ customized images based on an existing base images.
The following configuration options are available for building Tencentcloud images. The following configuration options are available for building Tencentcloud images.
In addition to the options listed here, In addition to the options listed here,
a [communicator](/docs/templates/communicator) can be configured for this builder. a [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this builder.
### Required: ### Required:

View File

@ -47,7 +47,7 @@ There are many configuration options available for the builder. They are
segmented below into two categories: required and optional parameters. segmented below into two categories: required and optional parameters.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. In addition to the options defined there, a private key file builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key: can also be supplied to override the typical auto-generated key:

View File

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

View File

@ -100,7 +100,7 @@ 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.
In addition to the options listed here, a In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
builder. builder.
### Required: ### Required:

View File

@ -64,7 +64,7 @@ Configuration options are organized below into two categories: required and
optional. Within each category, the available options are alphabetized and optional. Within each category, the available options are alphabetized and
described. described.
In addition to the options listed here, a [communicator](/docs/templates/communicator) In addition to the options listed here, a [communicator](/docs/templates/legacy_json_templates/communicators)
can be configured for this builder. In addition to the options defined there, a private key file can be configured for this builder. In addition to the options defined there, a private key file
can also be supplied to override the typical auto-generated key: can also be supplied to override the typical auto-generated key:
@ -136,7 +136,7 @@ In configuration directives the following variables are available:
## Build Shared Information Variables ## Build Shared Information Variables
This builder generates data that are shared with provisioner and post-processor via build function of This builder generates data that are shared with provisioner and post-processor via build function of
[template engine](/docs/templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) [template engine](/docs/templates/legacy_json_templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables)
for HCL2. for HCL2.
The generated variables available for this builder see above The generated variables available for this builder see above

View File

@ -45,7 +45,7 @@ artifacts that are created will be outputted at the end of the build.
- `ask` presents a prompt and waits for you to decide to clean up, abort, or retry - `ask` presents a prompt and waits for you to decide to clean up, abort, or retry
the failed step. the failed step.
- `run-cleanup-provisioner` aborts and exits without any cleanup besides - `run-cleanup-provisioner` aborts and exits without any cleanup besides
the [error-cleanup-provisioner](/docs/templates/provisioners#on-error-provisioner) if one is defined. the [error-cleanup-provisioner](/docs/templates/legacy_json_templates/provisioners#on-error-provisioner) if one is defined.
`@include 'commands/only.mdx'` `@include 'commands/only.mdx'`

View File

@ -12,7 +12,7 @@ Communicators are the mechanism Packer uses to upload files, execute scripts,
etc. with the machine being created. etc. with the machine being created.
Communicators are configured within the Communicators are configured within the
[builder](/docs/templates/builders) section. Packer currently supports [builder](/docs/templates/legacy_json_templates/builders) section. Packer currently supports
three kinds of communicators: three kinds of communicators:
- `none` - No communicator will be used. If this is set, most provisioners - `none` - No communicator will be used. If this is set, most provisioners

View File

@ -10,7 +10,7 @@ sidebar_title: SSH
Communicators are the mechanism Packer uses to upload files, execute scripts, Communicators are the mechanism Packer uses to upload files, execute scripts,
etc. on the machine being created, and are configured within the etc. on the machine being created, and are configured within the
[builder](/docs/templates/builders) section. [builder](/docs/templates/legacy_json_templates/builders) section.
The SSH communicator does this by using the SSH protocol. It is the default The SSH communicator does this by using the SSH protocol. It is the default
communicator for a majority of builders. communicator for a majority of builders.

View File

@ -204,7 +204,7 @@ provide to procisioners (see below for more details on generatedData.)
Packer makes it possible to provide custom template engine variables to be Packer makes it possible to provide custom template engine variables to be
shared with provisioners and post-processors using the `build` function. shared with provisioners and post-processors using the `build` function.
Json template `build` docs are [here](/docs/templates/engine#build) Json template `build` docs are [here](/docs/templates/legacy_json_templates/engine#build)
and HCL template build docs are [here](/docs/templates/hcl_templates/contextual-variables#build-variables). and HCL template build docs are [here](/docs/templates/hcl_templates/contextual-variables#build-variables).
As of Packer v1.5.0, builder Prepare() methods return a list of custom variables As of Packer v1.5.0, builder Prepare() methods return a list of custom variables

View File

@ -137,7 +137,7 @@ Optional:
OVA file will be copied to for import. If not specified, this will default OVA file will be copied to for import. If not specified, this will default
to "packer-import-{{timestamp}}.ova". This key (i.e., the uploaded OVA) to "packer-import-{{timestamp}}.ova". This key (i.e., the uploaded OVA)
will be removed after import, unless `skip_clean` is `true`. This is will be removed after import, unless `skip_clean` is `true`. This is
treated as a [template engine](/docs/templates/engine). Therefore, you treated as a [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you
may use user variables and template functions in this field. may use user variables and template functions in this field.
- `skip_clean` (boolean) - Whether we should skip removing the OVA file - `skip_clean` (boolean) - Whether we should skip removing the OVA file

View File

@ -70,7 +70,7 @@ Optional parameters:
`packer_{{.BuildName}}_{{.BuilderType}}_{{.ChecksumType}}.checksum`. For `packer_{{.BuildName}}_{{.BuilderType}}_{{.ChecksumType}}.checksum`. For
example, if you had a builder named `database`, you might see the file example, if you had a builder named `database`, you might see the file
written as `packer_database_docker_md5.checksum`. This is treated as a written as `packer_database_docker_md5.checksum`. This is treated as a
[template engine](/docs/templates/engine). Therefore, you [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you
may use user variables and template functions in this field. may use user variables and template functions in this field.
The following special variables are also available to use in the output The following special variables are also available to use in the output
template: template:

View File

@ -27,7 +27,7 @@ you will need to specify the `output` option.
packer defaults to `.tar.gz` behavior but will not change the filename. packer defaults to `.tar.gz` behavior but will not change the filename.
This is treated as a This is treated as a
[template engine](/docs/templates/engine). Therefore, you [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you
may use user variables and template functions in this field. may use user variables and template functions in this field.
The following special variables are also available to use in the output The following special variables are also available to use in the output
template: template:

View File

@ -78,7 +78,7 @@ Optional:
- `space_object_name` (string) - The name of the key used in the Space where - `space_object_name` (string) - The name of the key used in the Space where
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). Therefore, you [template engine](/docs/templates/legacy_json_templates/engine). 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}}`.

View File

@ -26,7 +26,7 @@ As such, the authentication credentials that built the image must have write
permissions to the GCS `paths`. permissions to the GCS `paths`.
~> **Note**: By default the GCE image being exported will be deleted once the image has been exported. ~> **Note**: By default the GCE image being exported will be deleted once the image has been exported.
To prevent Packer from deleting the image set the `keep_input_artifact` configuration option to `true`. See [Post-Processor Input Artifacts](/docs/templates/post-processors#input-artifacts) for more details. To prevent Packer from deleting the image set the `keep_input_artifact` configuration option to `true`. See [Post-Processor Input Artifacts](/docs/templates/legacy_json_templates/post-processors#input-artifacts) for more details.
## Configuration ## Configuration

View File

@ -29,7 +29,7 @@ see the [GCE import documentation](https://cloud.google.com/compute/docs/images/
for details. for details.
~> **Note**: To prevent Packer from deleting the compressed RAW disk image set the `keep_input_artifact` configuration option to `true`. ~> **Note**: To prevent Packer from deleting the compressed RAW disk image set the `keep_input_artifact` configuration option to `true`.
See [Post-Processor Input Artifacts](/docs/templates/post-processors#input-artifacts) for more details. See [Post-Processor Input Artifacts](/docs/templates/legacy_json_templates/post-processors#input-artifacts) for more details.
## Configuration ## Configuration

View File

@ -116,11 +116,11 @@ Optional parameters:
["cmd", "/V", "/C", "{{.Vars}}", "call", "{{.Script}}"] ["cmd", "/V", "/C", "{{.Vars}}", "call", "{{.Script}}"]
``` ```
This is treated as a [template engine](/docs/templates/engine). This is treated as a [template engine](/docs/templates/legacy_json_templates/engine).
There are several available variables: `Script`, which is the path to the There are several available variables: `Script`, which is the path to the
script to run, and `Vars`, which is the list of `environment_vars`, if script to run, and `Vars`, which is the list of `environment_vars`, if
configured. In addition, you may access any of the variables stored in the configured. In addition, you may access any of the variables stored in the
generated data using the [build](/docs/templates/engine) template generated data using the [build](/docs/templates/legacy_json_templates/engine) template
function. If you choose to set this option, make sure that the first function. If you choose to set this option, make sure that the first
element in the array is the shell program you want to use (for example, element in the array is the shell program you want to use (for example,
"sh" or "/usr/local/bin/zsh" or even "powershell.exe" although anything "sh" or "/usr/local/bin/zsh" or even "powershell.exe" although anything
@ -277,7 +277,7 @@ In addition to being able to specify custom environmental variables using the
commonly useful environmental variables: commonly useful environmental variables:
- `PACKER_BUILD_NAME` is set to the [name of the - `PACKER_BUILD_NAME` is set to the [name of the
build](/docs/templates/builders#named-builds) that Packer is running. build](/docs/templates/legacy_json_templates/builders#named-builds) that Packer is running.
This is most useful when Packer is making multiple builds and you want to This is most useful when Packer is making multiple builds and you want to
distinguish them slightly from a common provisioning script. distinguish them slightly from a common provisioning script.

View File

@ -107,7 +107,7 @@ on Vagrant Cloud, as well as authentication and version information.
- `box_download_url` (string) - Optional URL for a self-hosted box. If this - `box_download_url` (string) - Optional URL for a self-hosted box. If this
is set the box will not be uploaded to the Vagrant Cloud. is set the box will not be uploaded to the Vagrant Cloud.
This is a [template engine](/docs/templates/engine). Therefore, you This is a [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you
may use user variables and template functions in this field. may use user variables and template functions in this field.
The following extra variables are also avilable in this engine: The following extra variables are also avilable in this engine:

View File

@ -22,7 +22,7 @@ Packer to automatically create arbitrarily complex Vagrant boxes, and is in
fact how the official boxes distributed by Vagrant are created. fact how the official boxes distributed by Vagrant are created.
If you've never used a post-processor before, please read the documentation on If you've never used a post-processor before, please read the documentation on
[using post-processors](/docs/templates/post-processors) in templates. [using post-processors](/docs/templates/legacy_json_templates/post-processors) in templates.
This knowledge will be expected for the remainder of this document. This knowledge will be expected for the remainder of this document.
Because Vagrant boxes are Because Vagrant boxes are
@ -82,7 +82,7 @@ more details about certain options in following sections.
- `output` (string) - The full path to the box file that will be created by - `output` (string) - The full path to the box file that will be created by
this post-processor. This is a this post-processor. This is a
[template engine](/docs/templates/engine). Therefore, you may use user [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you may use user
variables and template functions in this field. The following extra variables and template functions in this field. The following extra
variables are also avilable in this engine: variables are also avilable in this engine:
@ -101,7 +101,7 @@ more details about certain options in following sections.
`lxc`, `scaleway`, `hyperv`, `parallels`, `aws`, or `google`. `lxc`, `scaleway`, `hyperv`, `parallels`, `aws`, or `google`.
- `vagrantfile_template` (string) - Path to a template to use for the - `vagrantfile_template` (string) - Path to a template to use for the
Vagrantfile that is packaged with the box. This option supports the usage of the [template engine](/docs/templates/engine) Vagrantfile that is packaged with the box. This option supports the usage of the [template engine](/docs/templates/legacy_json_templates/engine)
for JSON and the [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. for JSON and the [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2.
- `vagrantfile_template_generated` (boolean) - By default, Packer will - `vagrantfile_template_generated` (boolean) - By default, Packer will
@ -238,7 +238,7 @@ artifact (the raw virtual machine, for example), then you must configure Packer
to keep it. to keep it.
Please see the [documentation on input Please see the [documentation on input
artifacts](/docs/templates/post-processors#input-artifacts) for more information. artifacts](/docs/templates/legacy_json_templates/post-processors#input-artifacts) for more information.
### Docker ### Docker

View File

@ -87,7 +87,7 @@ Once the [vSphere](/docs/post-processors/vsphere) takes an artifact from
the VMware builder and uploads it to a vSphere endpoint, you will likely want the VMware builder and uploads it to a vSphere endpoint, you will likely want
to mark that VM as template. Packer can do this for you automatically using a to mark that VM as template. Packer can do this for you automatically using a
sequence definition (a collection of post-processors that are treated as as sequence definition (a collection of post-processors that are treated as as
single pipeline, see [Post-Processors](/docs/templates/post-processors) single pipeline, see [Post-Processors](/docs/templates/legacy_json_templates/post-processors)
for more information): for more information):
```json ```json

View File

@ -55,7 +55,7 @@ configuration is actually required.
`accept-silent` and `accept-no-persist`. For details see [Accepting the `accept-silent` and `accept-no-persist`. For details see [Accepting the
Chef License](https://docs.chef.io/chef_license_accept.html). Chef License](https://docs.chef.io/chef_license_accept.html).
This is a [template engine](/docs/templates/engine.html). Therefore, you This is a [template engine](/docs/templates/legacy_json_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.
- `config_template` (string) - Path to a template that will be used for the - `config_template` (string) - Path to a template that will be used for the
@ -75,7 +75,7 @@ configuration is actually required.
will be available. will be available.
- `execute_command` (string) - The command used to execute Chef. This has - `execute_command` (string) - The command used to execute Chef. This has
various [configuration template variables](/docs/templates/engine) various [configuration template variables](/docs/templates/legacy_json_templates/engine)
available. See below for more information. available. See below for more information.
- `guest_os_type` (string) - The target guest OS type, either "unix" or - `guest_os_type` (string) - The target guest OS type, either "unix" or
@ -83,7 +83,7 @@ configuration is actually required.
Windows friendly paths and commands. By default, this is "unix". Windows friendly paths and commands. By default, this is "unix".
- `install_command` (string) - The command used to install Chef. This has - `install_command` (string) - The command used to install Chef. This has
various [configuration template variables](/docs/templates/engine) various [configuration template variables](/docs/templates/legacy_json_templates/engine)
available. See below for more information. available. See below for more information.
- `json` (object) - An arbitrary mapping of JSON that will be available as - `json` (object) - An arbitrary mapping of JSON that will be available as
@ -91,7 +91,7 @@ configuration is actually required.
- `knife_command` (string) - The command used to run Knife during node - `knife_command` (string) - The command used to run Knife during node
clean-up. This has various [configuration template clean-up. This has various [configuration template
variables](/docs/templates/engine) available. See below for more variables](/docs/templates/legacy_json_templates/engine) available. See below for more
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
@ -206,7 +206,7 @@ trusted_certs_dir :{{.TrustedCertsDir}}
{{end}} {{end}}
``` ```
This template is a [configuration template](/docs/templates/engine) and This template is a [configuration template](/docs/templates/legacy_json_templates/engine) and
has a set of variables available to use: has a set of variables available to use:
- `ChefEnvironment` - The Chef environment name. - `ChefEnvironment` - The Chef environment name.
@ -321,7 +321,7 @@ mode.
**Packer variables** **Packer variables**
Set the necessary Packer variables using environment variables or provide a Set the necessary Packer variables using environment variables or provide a
[var file](/docs/templates/user-variables). [var file](/docs/templates/legacy_json_templates/user-variables).
```json ```json
"variables": { "variables": {
@ -386,7 +386,7 @@ mode, while passing a `run_list` using a variable.
**Packer variables** **Packer variables**
Set the necessary Packer variables using environment variables or provide a Set the necessary Packer variables using environment variables or provide a
[var file](/docs/templates/user-variables). [var file](/docs/templates/legacy_json_templates/user-variables).
```json ```json
"variables": { "variables": {

View File

@ -72,7 +72,7 @@ configuration is actually required, but at least `run_list` is recommended.
directory specified by the `staging_directory`. By default, this is empty. directory specified by the `staging_directory`. By default, this is empty.
- `execute_command` (string) - The command used to execute Chef. This has - `execute_command` (string) - The command used to execute Chef. This has
various [configuration template variables](/docs/templates/engine) various [configuration template variables](/docs/templates/legacy_json_templates/engine)
available. See below for more information. available. See below for more information.
- `guest_os_type` (string) - The target guest OS type, either "unix" or - `guest_os_type` (string) - The target guest OS type, either "unix" or
@ -80,7 +80,7 @@ configuration is actually required, but at least `run_list` is recommended.
Windows friendly paths and commands. By default, this is "unix". Windows friendly paths and commands. By default, this is "unix".
- `install_command` (string) - The command used to install Chef. This has - `install_command` (string) - The command used to install Chef. This has
various [configuration template variables](/docs/templates/engine) various [configuration template variables](/docs/templates/legacy_json_templates/engine)
available. See below for more information. available. See below for more information.
- `json` (object) - An arbitrary mapping of JSON that will be available as - `json` (object) - An arbitrary mapping of JSON that will be available as
@ -133,7 +133,7 @@ The default value for the configuration template is:
cookbook_path [{{.CookbookPaths}}] cookbook_path [{{.CookbookPaths}}]
``` ```
This template is a [configuration template](/docs/templates/engine) and This template is a [configuration template](/docs/templates/legacy_json_templates/engine) and
has a set of variables available to use: has a set of variables available to use:
- `ChefEnvironment` - The current enabled environment. Only non-empty if the - `ChefEnvironment` - The current enabled environment. Only non-empty if the

View File

@ -60,14 +60,14 @@ Optional parameters:
module. module.
- `execute_command` (string) - the command used to execute Converge. This is a - `execute_command` (string) - the command used to execute Converge. This is a
[configuration template variables](/docs/templates/engine). [configuration template variables](/docs/templates/legacy_json_templates/engine).
See below for detailed usage instructions. See below for detailed usage instructions.
- `prevent_sudo` (boolean) - stop Converge from running with administrator - `prevent_sudo` (boolean) - stop Converge from running with administrator
privileges via sudo privileges via sudo
- `bootstrap_command` (string) - the command used to bootstrap Converge. This - `bootstrap_command` (string) - the command used to bootstrap Converge. This
is a [template engine](/docs/templates/engine). Therefore, you may use is a [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you may use
user variables and template functions in this field. The following extra user variables and template functions in this field. The following extra
variables are also avilable in this engine: variables are also avilable in this engine:

View File

@ -17,6 +17,6 @@ use cases for provisioners include:
- creating users - creating users
- downloading application code - downloading application code
See [Template Provisioners](/docs/templates/provisioners) to learn more See [Template Provisioners](/docs/templates/legacy_json_templates/provisioners) to learn more
about working with provisioners. For information on an individual provisioner, about working with provisioners. For information on an individual provisioner,
choose it from the sidebar. choose it from the sidebar.

View File

@ -61,7 +61,7 @@ provisioner "powershell" {
powershell -executionpolicy bypass "& { if (Test-Path variable:global:ProgressPreference){$ProgressPreference='SilentlyContinue'};. {{.Vars}}; &'{{.Path}}'; exit $LastExitCode }" powershell -executionpolicy bypass "& { if (Test-Path variable:global:ProgressPreference){$ProgressPreference='SilentlyContinue'};. {{.Vars}}; &'{{.Path}}'; exit $LastExitCode }"
``` ```
This is a [template engine](/docs/templates/engine). Therefore, you This is a [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you
may use user variables and template functions in this field. In addition, may use user variables and template functions in this field. In addition,
you may use two extra variables: you may use two extra variables:
@ -74,7 +74,7 @@ provisioner "powershell" {
Packer injects some environmental variables by default into the Packer injects some environmental variables by default into the
environment, as well, which are covered in the section below. environment, as well, which are covered in the section below.
This is a [template engine](/docs/templates/engine). Therefore, you This is a [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you
may use user variables and template functions in this field. If you are may use user variables and template functions in this field. If you are
running on AWS, Azure, Google Compute, or OpenStack and would like to access running on AWS, Azure, Google Compute, or OpenStack and would like to access
the autogenerated password that Packer uses to connect to the instance via the autogenerated password that Packer uses to connect to the instance via
@ -113,7 +113,7 @@ provisioner "powershell" {
powershell -executionpolicy bypass "& { if (Test-Path variable:global:ProgressPreference){$ProgressPreference='SilentlyContinue'};. {{.Vars}}; &'{{.Path}}'; exit $LastExitCode }" powershell -executionpolicy bypass "& { if (Test-Path variable:global:ProgressPreference){$ProgressPreference='SilentlyContinue'};. {{.Vars}}; &'{{.Path}}'; exit $LastExitCode }"
``` ```
This is a [template engine](/docs/templates/engine). Therefore, you This is a [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you
may use user variables and template functions in this field. In addition, may use user variables and template functions in this field. In addition,
you may use two extra variables: you may use two extra variables:
@ -132,7 +132,7 @@ provisioner "powershell" {
PowerShell script will be run with elevated privileges using the given PowerShell script will be run with elevated privileges using the given
Windows user. Windows user.
This is a [template engine](/docs/templates/engine). Therefore, you This is a [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you
may use user variables and template functions in this field. If you are may use user variables and template functions in this field. If you are
running on AWS, Azure, Google Compute, or OpenStack and would like to access running on AWS, Azure, Google Compute, or OpenStack and would like to access
the autogenerated password that Packer uses to connect to the instance via the autogenerated password that Packer uses to connect to the instance via
@ -241,7 +241,7 @@ In addition to being able to specify custom environmental variables using the
commonly useful environmental variables: commonly useful environmental variables:
- `PACKER_BUILD_NAME` is set to the [name of the - `PACKER_BUILD_NAME` is set to the [name of the
build](/docs/templates/builders#named-builds) that Packer is running. build](/docs/templates/legacy_json_templates/builders#named-builds) that Packer is running.
This is most useful when Packer is making multiple builds and you want to This is most useful when Packer is making multiple builds and you want to
distinguish them slightly from a common provisioning script. distinguish them slightly from a common provisioning script.

View File

@ -62,7 +62,7 @@ Required parameters:
Optional parameters: Optional parameters:
- `execute_command` (string) - The command-line to execute Puppet. This is a - `execute_command` (string) - The command-line to execute Puppet. This is a
[template engine](/docs/templates/engine). Therefore, you [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you
may use user variables and template functions in this field. In addition, may use user variables and template functions in this field. In addition,
you may use the following extra variables: you may use the following extra variables:
- FacterVars: Additional facts to set when executing Puppet, joined for - FacterVars: Additional facts to set when executing Puppet, joined for
@ -142,7 +142,7 @@ multiple manifests you should use `manifest_file` instead.
- `elevated_user` and `elevated_password` (string) - If specified, Puppet - `elevated_user` and `elevated_password` (string) - If specified, Puppet
will be run with elevated privileges using the given Windows user. See the will be run with elevated privileges using the given Windows user. See the
[powershell](/docs/provisioners/powershell) provisioner for the full [powershell](/docs/provisioners/powershell) provisioner for the full
details. This is a [template engine](/docs/templates/engine). details. This is a [template engine](/docs/templates/legacy_json_templates/engine).
Therefore, you may use user variables and template functions in this Therefore, you may use user variables and template functions in this
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.

View File

@ -52,7 +52,7 @@ listed below:
nothing, in which case a client private key won't be uploaded. nothing, in which case a client private key won't be uploaded.
- `execute_command` (string) - The command-line to execute Puppet. This is a - `execute_command` (string) - The command-line to execute Puppet. This is a
[template engine](/docs/templates/engine). Therefore, you [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you
may use user variables and template functions in this field. In addition, may use user variables and template functions in this field. In addition,
you may use the following extra variables: you may use the following extra variables:
- ClientCertPath: The value set in the template option - ClientCertPath: The value set in the template option
@ -120,7 +120,7 @@ listed below:
* `elevated_user` and `elevated_password` (string) - If specified, Puppet * `elevated_user` and `elevated_password` (string) - If specified, Puppet
will be run with elevated privileges using the given Windows user. See the will be run with elevated privileges using the given Windows user. See the
[powershell](/docs/provisioners/powershell) provisioner for the full [powershell](/docs/provisioners/powershell) provisioner for the full
details. This is a [template engine](/docs/templates/engine). details. This is a [template engine](/docs/templates/legacy_json_templates/engine).
Therefore, you may use user variables and template functions in this Therefore, you may use user variables and template functions in this
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.

View File

@ -120,7 +120,7 @@ Optional parameters:
- `execute_command` (array of strings) - The command used to execute the - `execute_command` (array of strings) - The command used to execute the
script. By default this is `["/bin/sh", "-c", "{{.Vars}}", "{{.Script}}"]` script. By default this is `["/bin/sh", "-c", "{{.Vars}}", "{{.Script}}"]`
on unix and `["cmd", "/c", "{{.Vars}}", "{{.Script}}"]` on windows. This is on unix and `["cmd", "/c", "{{.Vars}}", "{{.Script}}"]` on windows. This is
treated as a [template engine](/docs/templates/engine). There are two treated as a [template engine](/docs/templates/legacy_json_templates/engine). There are two
available variables: `Script`, which is the path to the script to run, and available variables: `Script`, which is the path to the script to run, and
`Vars`, which is the list of `environment_vars`, if configured. `Vars`, which is the list of `environment_vars`, if configured.

View File

@ -72,7 +72,7 @@ provisioner "shell" {
default this is `chmod +x {{ .Path }}; {{ .Vars }} {{ .Path }}`, unless the default this is `chmod +x {{ .Path }}; {{ .Vars }} {{ .Path }}`, unless the
user has set `"use_env_var_file": true` -- in that case, the default user has set `"use_env_var_file": true` -- in that case, the default
`execute_command` is `chmod +x {{.Path}}; . {{.EnvVarFile}} && {{.Path}}`. `execute_command` is `chmod +x {{.Path}}; . {{.EnvVarFile}} && {{.Path}}`.
This is a [template engine](/docs/templates/engine). Therefore, you may This is a [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you may
use user variables and template functions in this field. In addition, there use user variables and template functions in this field. In addition, there
are three available extra variables: are three available extra variables:
@ -167,7 +167,7 @@ In addition to being able to specify custom environmental variables using the
commonly useful environmental variables: commonly useful environmental variables:
- `PACKER_BUILD_NAME` is set to the [name of the - `PACKER_BUILD_NAME` is set to the [name of the
build](/docs/templates/builders#named-builds) that Packer is running. build](/docs/templates/legacy_json_templates/builders#named-builds) that Packer is running.
This is most useful when Packer is making multiple builds and you want to This is most useful when Packer is making multiple builds and you want to
distinguish them slightly from a common provisioning script. distinguish them slightly from a common provisioning script.

View File

@ -50,8 +50,8 @@ provisioner "windows-shell" {
- `execute_command` (string) - The command to use to execute the script. By - `execute_command` (string) - The command to use to execute the script. By
default this is `{{ .Vars }}"{{ .Path }}"`. The value of this is treated as default this is `{{ .Vars }}"{{ .Path }}"`. The value of this is treated as
[template engine](/docs/templates/engine). This is a [template engine](/docs/templates/legacy_json_templates/engine). This is a
[template engine](/docs/templates/engine). Therefore, you may [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you may
use user variables and template functions in this field. In addition, there use user variables and template functions in this field. In addition, there
are two available extra variables: are two available extra variables:
@ -76,7 +76,7 @@ In addition to being able to specify custom environmental variables using the
commonly useful environmental variables: commonly useful environmental variables:
- `PACKER_BUILD_NAME` is set to the [name of the - `PACKER_BUILD_NAME` is set to the [name of the
build](/docs/templates/builders#named-builds) that Packer is running. build](/docs/templates/legacy_json_templates/builders#named-builds) that Packer is running.
This is most useful when Packer is making multiple builds and you want to This is most useful when Packer is making multiple builds and you want to
distinguish them slightly from a common provisioning script. distinguish them slightly from a common provisioning script.

View File

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

View File

@ -14,7 +14,7 @@ Communicators are the mechanism Packer uses to upload files, execute scripts,
etc. with the machine being created. etc. with the machine being created.
Communicators are configured within the Communicators are configured within the
[builder](/docs/templates/builders) section. [builder](/docs/templates/legacy_json_templates/builders) section.
All communicators have the following options: All communicators have the following options:

View File

@ -60,7 +60,7 @@ Here is a full list of the available functions for reference.
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#using-home-variable) variable](/docs/templates/legacy_json_templates/user-variables#using-home-variable)
- `build` - This engine will allow you to access, from provisioners and post-processors, special variables that - `build` - This engine will allow you to access, from provisioners and post-processors, special variables that
provide connection information and basic instance state information. provide connection information and basic instance state information.
Usage example: Usage example:
@ -122,7 +122,7 @@ Here is a full list of the available functions for reference.
- `isotime [FORMAT]` - UTC time, which can be - `isotime [FORMAT]` - UTC time, which can be
[formatted](https://golang.org/pkg/time/#example_Time_Format). See more [formatted](https://golang.org/pkg/time/#example_Time_Format). See more
examples below in [the `isotime` format examples below in [the `isotime` format
reference](/docs/templates/engine#isotime-function-format-reference). reference](/docs/templates/legacy_json_templates/engine#isotime-function-format-reference).
`strftime FORMAT` - UTC time, formated using the ISO C standard format `strftime FORMAT` - UTC time, formated using the ISO C standard format
`FORMAT`. See `FORMAT`. See
[jehiah/go-strftime](https://github.com/jehiah/go-strftime) for a list [jehiah/go-strftime](https://github.com/jehiah/go-strftime) for a list
@ -231,7 +231,7 @@ the list of the environment variables and the path to the script to be executed
respectively. respectively.
-> **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) user variables. See the [user variable](/docs/templates/legacy_json_templates/user-variables)
documentation for more information on user variables. documentation for more information on user variables.
# isotime Function Format Reference # isotime Function Format Reference

View File

@ -32,7 +32,7 @@ Along with each key, it is noted whether it is required or not.
builders that will be used to create machine images for this template, and builders that will be used to create machine images for this template, and
configures each of those builders. For more information on how to define configures each of those builders. For more information on how to define
and configure a builder, read the sub-section on [configuring builders in and configure a builder, read the sub-section on [configuring builders in
templates](/docs/templates/builders). templates](/docs/templates/legacy_json_templates/builders).
- `description` (optional) is a string providing a description of what the - `description` (optional) is a string providing a description of what the
template does. This output is used only in the [inspect template does. This output is used only in the [inspect
@ -49,20 +49,20 @@ Along with each key, it is noted whether it is required or not.
not specified, then no post-processing will be done. For more information not specified, then no post-processing will be done. For more information
on what post-processors do and how they're defined, read the sub-section on on what post-processors do and how they're defined, read the sub-section on
[configuring post-processors in [configuring post-processors in
templates](/docs/templates/post-processors). templates](/docs/templates/legacy_json_templates/post-processors).
- `provisioners` (optional) is an array of one or more objects that defines - `provisioners` (optional) is an array of one or more objects that defines
the provisioners that will be used to install and configure software for the provisioners that will be used to install and configure software for
the machines created by each of the builders. If it is not specified, then the machines created by each of the builders. If it is not specified, then
no provisioners will be run. For more information on how to define and no provisioners will be run. For more information on how to define and
configure a provisioner, read the sub-section on [configuring provisioners configure a provisioner, read the sub-section on [configuring provisioners
in templates](/docs/templates/provisioners). in templates](/docs/templates/legacy_json_templates/provisioners).
- `variables` (optional) is an object of one or more key/value strings that - `variables` (optional) is an object of one or more key/value strings that
defines user variables contained in the template. If it is not specified, defines user variables contained in the template. If it is not specified,
then no variables are defined. For more information on how to define and then no variables are defined. For more information on how to define and
use user variables, read the sub-section on [user variables in use user variables, read the sub-section on [user variables in
templates](/docs/templates/user-variables). templates](/docs/templates/legacy_json_templates/user-variables).
## Comments ## Comments

View File

@ -151,7 +151,7 @@ This example is shown below:
As you can see, the `override` key is used. The value of this key is another As you can see, the `override` key is used. The value of this key is another
JSON object where the key is the name of a [builder JSON object where the key is the name of a [builder
definition](/docs/templates/builders). The value of this is in turn definition](/docs/templates/legacy_json_templates/builders). The value of this is in turn
another JSON object. This JSON object simply contains the provisioner another JSON object. This JSON object simply contains the provisioner
configuration as normal. This configuration is merged into the default configuration as normal. This configuration is merged into the default
provisioner configuration. provisioner configuration.

View File

@ -20,7 +20,7 @@ environment-specific data, and other types of information out of your
templates. This maximizes the portability of the template. templates. This maximizes the portability of the template.
Using user variables expects you to know how [configuration Using user variables expects you to know how [configuration
templates](/docs/templates/engine) work. If you don't know how templates](/docs/templates/legacy_json_templates/engine) work. If you don't know how
configuration templates work yet, please read that page first. configuration templates work yet, please read that page first.
## Usage ## Usage

View File

@ -122,7 +122,7 @@
filter, but will cause Packer to fail if the `source_ami` does not exist. filter, but will cause Packer to fail if the `source_ami` does not exist.
- `root_volume_tags` (map[string]string) - Key/value pair tags to apply to the volumes that are *launched*. This is - `root_volume_tags` (map[string]string) - Key/value pair tags to apply to the volumes that are *launched*. This is
a [template engine](/docs/templates/engine), see [Build template a [template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `root_volume_tag` ([]{key string, value string}) - Same as [`root_volume_tags`](#root_volume_tags) but defined as a - `root_volume_tag` ([]{key string, value string}) - Same as [`root_volume_tags`](#root_volume_tags) but defined as a

View File

@ -2,7 +2,7 @@
- `ami_description` (string) - The description to set for the resulting - `ami_description` (string) - The description to set for the resulting
AMI(s). By default this description is empty. This is a AMI(s). By default this description is empty. This is a
[template engine](/docs/templates/engine), see [Build template [template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `ami_virtualization_type` (string) - The type of virtualization for the AMI - `ami_virtualization_type` (string) - The type of virtualization for the AMI
@ -29,7 +29,7 @@
validation of the ami_regions configuration option. Default false. validation of the ami_regions configuration option. Default false.
- `tags` (map[string]string) - Key/value pair tags applied to the AMI. This is a [template - `tags` (map[string]string) - Key/value pair tags applied to the AMI. This is a [template
engine](/docs/templates/engine), see [Build template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `tag` ([]{key string, value string}) - Same as [`tags`](#tags) but defined as a singular repeatable block - `tag` ([]{key string, value string}) - Same as [`tags`](#tags) but defined as a singular repeatable block
@ -119,7 +119,7 @@
- `snapshot_tags` (map[string]string) - Key/value pair tags to apply to snapshot. They will override AMI tags if - `snapshot_tags` (map[string]string) - Key/value pair tags to apply to snapshot. They will override AMI tags if
already applied to snapshot. This is a [template already applied to snapshot. This is a [template
engine](/docs/templates/engine), see [Build template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `snapshot_tag` ([]{key string, value string}) - Same as [`snapshot_tags`](#snapshot_tags) but defined as a singular - `snapshot_tag` ([]{key string, value string}) - Same as [`snapshot_tags`](#snapshot_tags) but defined as a singular

View File

@ -3,4 +3,4 @@
- `ami_name` (string) - The name of the resulting AMI that will appear when managing AMIs in the - `ami_name` (string) - The name of the resulting AMI that will appear when managing AMIs in the
AWS console or via APIs. This must be unique. To help make this unique, AWS console or via APIs. This must be unique. To help make this unique,
use a function like timestamp (see [template use a function like timestamp (see [template
engine](/docs/templates/engine) for more info). engine](/docs/templates/legacy_json_templates/engine) for more info).

View File

@ -125,7 +125,7 @@
- `run_tags` (map[string]string) - Key/value pair tags to apply to the instance that is that is *launched* - `run_tags` (map[string]string) - Key/value pair tags to apply to the instance that is that is *launched*
to create the EBS volumes. This is a [template to create the EBS volumes. This is a [template
engine](/docs/templates/engine), see [Build template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `run_tag` ([]{key string, value string}) - Same as [`run_tags`](#run_tags) but defined as a singular repeatable - `run_tag` ([]{key string, value string}) - Same as [`run_tags`](#run_tags) but defined as a singular repeatable

View File

@ -22,7 +22,7 @@
- `run_volume_tags` (map[string]string) - Tags to apply to the volumes that are *launched* to create the AMI. - `run_volume_tags` (map[string]string) - Tags to apply to the volumes that are *launched* to create the AMI.
These tags are *not* applied to the resulting AMI unless they're These tags are *not* applied to the resulting AMI unless they're
duplicated in `tags`. This is a [template duplicated in `tags`. This is a [template
engine](/docs/templates/engine), see [Build template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `run_volume_tag` ([]{name string, value string}) - Same as [`run_volume_tags`](#run_volume_tags) but defined as a singular - `run_volume_tag` ([]{name string, value string}) - Same as [`run_volume_tags`](#run_volume_tags) but defined as a singular

View File

@ -19,7 +19,7 @@
- `run_volume_tags` (map[string]string) - Tags to apply to the volumes that are *launched* to create the AMI. - `run_volume_tags` (map[string]string) - Tags to apply to the volumes that are *launched* to create the AMI.
These tags are *not* applied to the resulting AMI unless they're These tags are *not* applied to the resulting AMI unless they're
duplicated in `tags`. This is a [template duplicated in `tags`. This is a [template
engine](/docs/templates/engine), see [Build template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
- `run_volume_tag` ([]{name string, value string}) - Same as [`run_volume_tags`](#run_volume_tags) but defined as a singular - `run_volume_tag` ([]{name string, value string}) - Same as [`run_volume_tags`](#run_volume_tags) but defined as a singular

View File

@ -1,7 +1,7 @@
<!-- Code generated from the comments of the BlockDevice struct in builder/amazon/ebsvolume/block_device.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the BlockDevice struct in builder/amazon/ebsvolume/block_device.go; DO NOT EDIT MANUALLY -->
- `tags` (map[string]string) - Key/value pair tags to apply to the volume. These are retained after the builder - `tags` (map[string]string) - Key/value pair tags to apply to the volume. These are retained after the builder
completes. This is a [template engine](/docs/templates/engine), see completes. This is a [template engine](/docs/templates/legacy_json_templates/engine), see
[Build template data](#build-template-data) for more information. [Build template data](#build-template-data) for more information.
- `tag` ([]{key string, value string}) - Same as [`tags`](#tags) but defined as a singular repeatable block - `tag` ([]{key string, value string}) - Same as [`tags`](#tags) but defined as a singular repeatable block

View File

@ -27,7 +27,7 @@
*launched* to create EBS Volumes. These tags will *not* appear in the *launched* to create EBS Volumes. These tags will *not* appear in the
tags of the resulting EBS volumes unless they're duplicated under `tags` tags of the resulting EBS volumes unless they're duplicated under `tags`
in the `ebs_volumes` setting. This is a [template in the `ebs_volumes` setting. This is a [template
engine](/docs/templates/engine), see [Build template engine](/docs/templates/legacy_json_templates/engine), see [Build template
data](#build-template-data) for more information. data](#build-template-data) for more information.
Note: The tags specified here will be *temporarily* applied to volumes Note: The tags specified here will be *temporarily* applied to volumes

View File

@ -17,7 +17,7 @@
where the VirtualBox guest additions ISO will be uploaded. By default this where the VirtualBox guest additions ISO will be uploaded. By default this
is `VBoxGuestAdditions.iso` which should upload into the login directory of is `VBoxGuestAdditions.iso` which should upload into the login directory of
the user. This is a [configuration the user. This is a [configuration
template](/docs/templates/engine) where the `Version` template](/docs/templates/legacy_json_templates/engine) where the `Version`
variable is replaced with the VirtualBox version. variable is replaced with the VirtualBox version.
- `guest_additions_sha256` (string) - The SHA256 checksum of the guest - `guest_additions_sha256` (string) - The SHA256 checksum of the guest

View File

@ -25,7 +25,7 @@
followed by the CPUs. followed by the CPUs.
Each command itself is an array of strings, where each string is an argument to Each command itself is an array of strings, where each string is an argument to
`VBoxManage`. Each argument is treated as a [configuration `VBoxManage`. Each argument is treated as a [configuration
template](/docs/templates/engine). The only available template](/docs/templates/legacy_json_templates/engine). The only available
variable is `Name` which is replaced with the unique name of the VM, which is variable is `Name` which is replaced with the unique name of the VM, which is
required for many VBoxManage calls. required for many VBoxManage calls.

View File

@ -6,7 +6,7 @@
- `tools_upload_path` (string) - The path in the VM to upload the VMware tools. This only takes effect if - `tools_upload_path` (string) - The path in the VM to upload the VMware tools. This only takes effect if
`tools_upload_flavor` is non-empty. This is a [configuration `tools_upload_flavor` is non-empty. This is a [configuration
template](/docs/templates/engine) that has a single valid variable: template](/docs/templates/legacy_json_templates/engine) that has a single valid variable:
`Flavor`, which will be the value of `tools_upload_flavor`. By default `Flavor`, which will be the value of `tools_upload_flavor`. By default
the upload path is set to `{{.Flavor}}.iso`. This setting is not used the upload path is set to `{{.Flavor}}.iso`. This setting is not used
when `remote_type` is `esx5`. when `remote_type` is `esx5`.

View File

@ -30,7 +30,7 @@
- `vmx_disk_template_path` (string) - VMX Disk Template Path - `vmx_disk_template_path` (string) - VMX Disk Template Path
- `vmx_template_path` (string) - Path to a [configuration template](/docs/templates/engine) that - `vmx_template_path` (string) - Path to a [configuration template](/docs/templates/legacy_json_templates/engine) that
defines the contents of the virtual machine VMX file for VMware. The defines the contents of the virtual machine VMX file for VMware. The
engine has access to the template variables `{{ .DiskNumber }}` and engine has access to the template variables `{{ .DiskNumber }}` and
`{{ .DiskName }}`. `{{ .DiskName }}`.

View File

@ -55,7 +55,7 @@ To hold the `c` key down, you would use `<cOn>`. Likewise, `<cOff>` to release.
### Templates inside boot command ### Templates inside boot command
In addition to the special keys, each command to type is treated as a In addition to the special keys, each command to type is treated as a
[template engine](/docs/templates/engine). The [template engine](/docs/templates/legacy_json_templates/engine). The
available variables are: available variables are:
- `HTTPIP` and `HTTPPort` - The IP and port, respectively of an HTTP server - `HTTPIP` and `HTTPPort` - The IP and port, respectively of an HTTP server

View File

@ -2,8 +2,8 @@
- `oss_key_name` (string) - The name of the object key in `oss_bucket_name` where the RAW or VHD - `oss_key_name` (string) - The name of the object key in `oss_bucket_name` where the RAW or VHD
file will be copied to for import. This is treated as a [template file will be copied to for import. This is treated as a [template
engine](/docs/templates/engine), and you may access any of the variables engine](/docs/templates/legacy_json_templates/engine), and you may access any of the variables
stored in the generated data using the [build](/docs/templates/engine) stored in the generated data using the [build](/docs/templates/legacy_json_templates/engine)
template function. template function.
- `skip_clean` (bool) - Whether we should skip removing the RAW or VHD file uploaded to OSS - `skip_clean` (bool) - Whether we should skip removing the RAW or VHD file uploaded to OSS

View File

@ -4,7 +4,7 @@
- `gcs_object_name` (string) - The name of the GCS object in `bucket` where - `gcs_object_name` (string) - The name of the GCS object in `bucket` where
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). Therefore, you [template engine](/docs/templates/legacy_json_templates/engine). 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`.

View File

@ -9,5 +9,5 @@
- `strip_time` (bool) - Don't write the `build_time` field from the output. - `strip_time` (bool) - Don't write the `build_time` field from the output.
- `custom_data` (map[string]string) - Arbitrary data to add to the manifest. This is a [template - `custom_data` (map[string]string) - Arbitrary data to add to the manifest. This is a [template
engine](https://packer.io/docs/templates/engine.html). Therefore, you engine](https://packer.io/docs/templates/legacy_json_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.

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