mirror of
https://github.com/hashicorp/packer.git
synced 2026-10-22 06:02:23 -04:00
Update redirects and URLs to legacy JSON template docs (#10530)
This commit is contained in:
@@ -162,7 +162,7 @@ type Config struct {
|
||||
//filter, but will cause Packer to fail if the `source_ami` does not exist.
|
||||
SourceAmiFilter awscommon.AmiFilterOptions `mapstructure:"source_ami_filter" required:"false"`
|
||||
// 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.
|
||||
RootVolumeTags map[string]string `mapstructure:"root_volume_tags" required:"false"`
|
||||
// Same as [`root_volume_tags`](#root_volume_tags) but defined as a
|
||||
|
||||
@@ -16,11 +16,11 @@ type AMIConfig struct {
|
||||
// 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,
|
||||
// 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"`
|
||||
// The description to set for the resulting
|
||||
// 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.
|
||||
AMIDescription string `mapstructure:"ami_description" required:"false"`
|
||||
// The type of virtualization for the AMI
|
||||
@@ -47,7 +47,7 @@ type AMIConfig struct {
|
||||
// validation of the ami_regions configuration option. Default false.
|
||||
AMISkipRegionValidation bool `mapstructure:"skip_region_validation" required:"false"`
|
||||
// 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.
|
||||
AMITags map[string]string `mapstructure:"tags" required:"false"`
|
||||
// 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"`
|
||||
// Key/value pair tags to apply to snapshot. They will override AMI tags if
|
||||
// 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.
|
||||
SnapshotTags map[string]string `mapstructure:"snapshot_tags" required:"false"`
|
||||
// Same as [`snapshot_tags`](#snapshot_tags) but defined as a singular
|
||||
|
||||
@@ -176,7 +176,7 @@ type RunConfig struct {
|
||||
SecurityGroupFilter SecurityGroupFilterOptions `mapstructure:"security_group_filter" required:"false"`
|
||||
// Key/value pair tags to apply to the instance that is that is *launched*
|
||||
// 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.
|
||||
RunTags map[string]string `mapstructure:"run_tags" required:"false"`
|
||||
// Same as [`run_tags`](#run_tags) but defined as a singular repeatable
|
||||
|
||||
@@ -56,7 +56,7 @@ type Config struct {
|
||||
// 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
|
||||
// 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.
|
||||
VolumeRunTags map[string]string `mapstructure:"run_volume_tags"`
|
||||
// Same as [`run_volume_tags`](#run_volume_tags) but defined as a singular
|
||||
|
||||
@@ -59,7 +59,7 @@ type Config struct {
|
||||
// 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
|
||||
// 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.
|
||||
VolumeRunTags map[string]string `mapstructure:"run_volume_tags"`
|
||||
// Same as [`run_volume_tags`](#run_volume_tags) but defined as a singular
|
||||
|
||||
@@ -12,7 +12,7 @@ import (
|
||||
type BlockDevice struct {
|
||||
awscommon.BlockDevice `mapstructure:",squash"`
|
||||
// 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.
|
||||
Tags map[string]string `mapstructure:"tags" required:"false"`
|
||||
// Same as [`tags`](#tags) but defined as a singular repeatable block
|
||||
|
||||
@@ -58,7 +58,7 @@ type Config struct {
|
||||
// *launched* to create EBS Volumes. These tags will *not* appear in the
|
||||
// tags of the resulting EBS volumes unless they're duplicated under `tags`
|
||||
// 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.
|
||||
//
|
||||
// Note: The tags specified here will be *temporarily* applied to volumes
|
||||
|
||||
@@ -33,7 +33,7 @@ type GuestAdditionsConfig struct {
|
||||
// where the VirtualBox guest additions ISO will be uploaded. By default this
|
||||
// is `VBoxGuestAdditions.iso` which should upload into the login directory of
|
||||
// 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.
|
||||
GuestAdditionsPath string `mapstructure:"guest_additions_path"`
|
||||
// The SHA256 checksum of the guest
|
||||
|
||||
@@ -37,7 +37,7 @@ type VBoxManageConfig struct {
|
||||
// followed by the CPUs.
|
||||
// Each command itself is an array of strings, where each string is an argument to
|
||||
// `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
|
||||
// required for many VBoxManage calls.
|
||||
VBoxManage [][]string `mapstructure:"vboxmanage" required:"false"`
|
||||
|
||||
@@ -15,7 +15,7 @@ type ToolsConfig struct {
|
||||
ToolsUploadFlavor string `mapstructure:"tools_upload_flavor" required:"false"`
|
||||
// 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
|
||||
// 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
|
||||
// the upload path is set to `{{.Flavor}}.iso`. This setting is not used
|
||||
// when `remote_type` is `esx5`.
|
||||
|
||||
@@ -66,7 +66,7 @@ type Config struct {
|
||||
VMName string `mapstructure:"vm_name" required:"false"`
|
||||
|
||||
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
|
||||
// engine has access to the template variables `{{ .DiskNumber }}` and
|
||||
// `{{ .DiskName }}`.
|
||||
|
||||
@@ -64,8 +64,8 @@ type Config struct {
|
||||
OSSBucket string `mapstructure:"oss_bucket_name" required:"true"`
|
||||
// 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
|
||||
// engine](/docs/templates/engine), and you may access any of the variables
|
||||
// stored in the generated data using the [build](/docs/templates/engine)
|
||||
// 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/legacy_json_templates/engine)
|
||||
// template function.
|
||||
OSSKey string `mapstructure:"oss_key_name"`
|
||||
// Whether we should skip removing the RAW or VHD file uploaded to OSS
|
||||
|
||||
@@ -43,7 +43,7 @@ type Config struct {
|
||||
Bucket string `mapstructure:"bucket" required:"true"`
|
||||
//The name of the GCS object in `bucket` where
|
||||
//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
|
||||
//`packer-import-{{timestamp}}.tar.gz`.
|
||||
GCSObjectName string `mapstructure:"gcs_object_name"`
|
||||
|
||||
@@ -32,7 +32,7 @@ type Config struct {
|
||||
// Don't write the `build_time` field from the output.
|
||||
StripTime bool `mapstructure:"strip_time"`
|
||||
// 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.
|
||||
CustomData map[string]string `mapstructure:"custom_data"`
|
||||
ctx interpolate.Context
|
||||
|
||||
@@ -49,7 +49,7 @@ type Config struct {
|
||||
UFileBucket string `mapstructure:"ufile_bucket_name" required:"true"`
|
||||
// The name of the object key in
|
||||
// `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.
|
||||
UFileKey string `mapstructure:"ufile_key_name" required:"false"`
|
||||
// Whether we should skip removing the RAW, VHD, VMDK, or qcow2 file uploaded to
|
||||
|
||||
@@ -46,7 +46,7 @@ type Config struct {
|
||||
|
||||
// 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.
|
||||
// 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.
|
||||
// Paths to Yandex Object Storage where exported image will be uploaded.
|
||||
Paths []string `mapstructure:"paths" required:"true"`
|
||||
|
||||
@@ -34,7 +34,7 @@ type Config struct {
|
||||
// in storage service and first paths (URL) is used to, so no need to set this param.
|
||||
Bucket string `mapstructure:"bucket" required:"false"`
|
||||
// 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.
|
||||
ObjectName string `mapstructure:"object_name" required:"false"`
|
||||
// Whether skip removing the qcow2 file uploaded to Storage
|
||||
|
||||
@@ -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" ]
|
||||
// ```
|
||||
//
|
||||
// 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.
|
||||
//
|
||||
// For example, if you are running a Windows build on AWS, Azure,
|
||||
|
||||
@@ -17,7 +17,7 @@ customized images based on an existing base images.
|
||||
|
||||
The following configuration options are available for building Alicloud images.
|
||||
In addition to the options listed here, a
|
||||
[communicator](/docs/templates/communicator) can be configured for this
|
||||
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
|
||||
builder.
|
||||
|
||||
### Required:
|
||||
|
||||
@@ -514,7 +514,7 @@ variables are available:
|
||||
|
||||
## 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:
|
||||
|
||||
|
||||
@@ -323,7 +323,7 @@ variables are available:
|
||||
|
||||
## 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:
|
||||
|
||||
|
||||
@@ -227,7 +227,7 @@ variables are available:
|
||||
|
||||
## 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:
|
||||
|
||||
|
||||
@@ -258,7 +258,7 @@ variables are available:
|
||||
|
||||
## 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:
|
||||
|
||||
@@ -281,7 +281,7 @@ marked for deletion on termination will remain in your account.
|
||||
|
||||
## 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:
|
||||
|
||||
|
||||
@@ -220,7 +220,7 @@ variables are available:
|
||||
|
||||
## 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:
|
||||
|
||||
@@ -299,7 +299,7 @@ upload the AMI.
|
||||
|
||||
These are configured with `bundle_vol_command` and `bundle_upload_command`.
|
||||
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.
|
||||
|
||||
### Bundle Volume Command
|
||||
|
||||
@@ -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
|
||||
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
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ segmented below into two categories: required and optional parameters. Within
|
||||
each category, the available configuration keys are alphabetized.
|
||||
|
||||
In addition to the options listed here, a
|
||||
[communicator](/docs/templates/communicator) can be configured for this
|
||||
[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this
|
||||
builder.
|
||||
|
||||
### Required:
|
||||
@@ -174,14 +174,14 @@ builder.
|
||||
`packer_<UUID>`, where <UUID> is a 36 character unique identifier.
|
||||
|
||||
- `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
|
||||
finish before shutting down the instance this must be handled in a
|
||||
provisioner.
|
||||
|
||||
- `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
|
||||
engine](/docs/templates/engine) see _User Data_ bellow for more
|
||||
engine](/docs/templates/legacy_json_templates/engine) see _User Data_ bellow for more
|
||||
details.
|
||||
|
||||
- `use_local_ip_address` (boolean) - Set to `true` to indicate that the
|
||||
|
||||
@@ -36,7 +36,7 @@ each category, the available configuration keys are alphabetized.
|
||||
### Communicator Config
|
||||
|
||||
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'
|
||||
|
||||
@@ -84,7 +84,7 @@ In addition to the builder options, a
|
||||
|
||||
- `snapshot_name` (string) - The name of the resulting snapshot that will
|
||||
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 that will appear in your account.
|
||||
|
||||
@@ -200,7 +200,7 @@ optional. Within each category, the available options are alphabetized and
|
||||
described.
|
||||
|
||||
The Docker builder uses a special Docker communicator _and will not use_ the
|
||||
standard [communicators](/docs/templates/communicator).
|
||||
standard [communicators](/docs/templates/legacy_json_templates/communicators).
|
||||
|
||||
### Required:
|
||||
|
||||
@@ -216,7 +216,7 @@ You must specify (only) one of `commit`, `discard`, or `export_path`.
|
||||
|
||||
## 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.
|
||||
|
||||
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
|
||||
created image. This is accomplished using a sequence definition (a collection
|
||||
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>
|
||||
<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
|
||||
which tags and pushes an image. This is accomplished using a sequence
|
||||
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):
|
||||
|
||||
<Tabs>
|
||||
|
||||
@@ -54,7 +54,7 @@ Configuration options are organized below into two categories: required and
|
||||
optional. Within each category, the available options are alphabetized and
|
||||
described.
|
||||
|
||||
Any [communicator](/docs/templates/communicator) defined is ignored.
|
||||
Any [communicator](/docs/templates/legacy_json_templates/communicators) defined is ignored.
|
||||
|
||||
### Required:
|
||||
|
||||
|
||||
@@ -342,7 +342,7 @@ optional. Within each category, the available options are alphabetized and
|
||||
described.
|
||||
|
||||
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.
|
||||
|
||||
### Communicator Configuration
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user