From f36554fa0ee1b8f44576c9a22f06f04a10a03608 Mon Sep 17 00:00:00 2001 From: Wilken Rivera Date: Wed, 27 Jan 2021 09:08:59 -0500 Subject: [PATCH] Update redirects and URLs to legacy JSON template docs (#10530) --- builder/amazon/chroot/builder.go | 2 +- builder/amazon/common/ami_config.go | 8 ++++---- builder/amazon/common/run_config.go | 2 +- builder/amazon/ebs/builder.go | 2 +- builder/amazon/ebssurrogate/builder.go | 2 +- builder/amazon/ebsvolume/block_device.go | 2 +- builder/amazon/ebsvolume/builder.go | 2 +- .../virtualbox/common/guest_additions_config.go | 2 +- builder/virtualbox/common/vboxmanage_config.go | 2 +- builder/vmware/common/tools_config.go | 2 +- builder/vmware/iso/config.go | 2 +- post-processor/alicloud-import/post-processor.go | 4 ++-- .../googlecompute-import/post-processor.go | 2 +- post-processor/manifest/post-processor.go | 2 +- post-processor/ucloud-import/post-processor.go | 2 +- post-processor/yandex-export/post-processor.go | 2 +- post-processor/yandex-import/post-processor.go | 2 +- provisioner/ansible/provisioner.go | 2 +- website/content/docs/builders/alicloud-ecs.mdx | 2 +- website/content/docs/builders/amazon/chroot.mdx | 2 +- website/content/docs/builders/amazon/ebs.mdx | 2 +- .../content/docs/builders/amazon/ebssurrogate.mdx | 2 +- website/content/docs/builders/amazon/ebsvolume.mdx | 4 ++-- website/content/docs/builders/amazon/instance.mdx | 4 ++-- website/content/docs/builders/azure/arm.mdx | 2 +- website/content/docs/builders/cloudstack.mdx | 6 +++--- website/content/docs/builders/digitalocean.mdx | 4 ++-- website/content/docs/builders/docker.mdx | 8 ++++---- website/content/docs/builders/file.mdx | 2 +- website/content/docs/builders/googlecompute.mdx | 2 +- website/content/docs/builders/hetzner-cloud.mdx | 4 ++-- website/content/docs/builders/hyperone.mdx | 4 ++-- website/content/docs/builders/hyperv/iso.mdx | 2 +- website/content/docs/builders/hyperv/vmcx.mdx | 2 +- website/content/docs/builders/linode.mdx | 4 ++-- website/content/docs/builders/null.mdx | 2 +- website/content/docs/builders/oneandone.mdx | 2 +- website/content/docs/builders/openstack.mdx | 2 +- website/content/docs/builders/oracle/oci.mdx | 2 +- website/content/docs/builders/outscale/bsu.mdx | 14 +++++++------- .../docs/builders/outscale/bsusurrogate.mdx | 14 +++++++------- .../content/docs/builders/outscale/bsuvolume.mdx | 6 +++--- website/content/docs/builders/outscale/chroot.mdx | 10 +++++----- website/content/docs/builders/parallels/iso.mdx | 8 ++++---- website/content/docs/builders/parallels/pvm.mdx | 8 ++++---- website/content/docs/builders/profitbricks.mdx | 2 +- website/content/docs/builders/proxmox/clone.mdx | 2 +- website/content/docs/builders/proxmox/iso.mdx | 2 +- website/content/docs/builders/scaleway.mdx | 2 +- website/content/docs/builders/tencentcloud-cvm.mdx | 2 +- website/content/docs/builders/triton.mdx | 2 +- website/content/docs/builders/ucloud-uhost.mdx | 2 +- website/content/docs/builders/virtualbox/vm.mdx | 2 +- website/content/docs/builders/yandex.mdx | 4 ++-- website/content/docs/commands/build.mdx | 2 +- website/content/docs/communicators/index.mdx | 2 +- website/content/docs/communicators/ssh.mdx | 2 +- website/content/docs/extending/custom-builders.mdx | 2 +- .../content/docs/post-processors/amazon-import.mdx | 2 +- website/content/docs/post-processors/checksum.mdx | 2 +- website/content/docs/post-processors/compress.mdx | 2 +- .../docs/post-processors/digitalocean-import.mdx | 2 +- .../docs/post-processors/googlecompute-export.mdx | 2 +- .../docs/post-processors/googlecompute-import.mdx | 2 +- .../content/docs/post-processors/shell-local.mdx | 6 +++--- .../content/docs/post-processors/vagrant-cloud.mdx | 2 +- website/content/docs/post-processors/vagrant.mdx | 8 ++++---- .../docs/post-processors/vsphere-template.mdx | 2 +- website/content/docs/provisioners/chef-client.mdx | 14 +++++++------- website/content/docs/provisioners/chef-solo.mdx | 6 +++--- website/content/docs/provisioners/converge.mdx | 4 ++-- website/content/docs/provisioners/index.mdx | 2 +- website/content/docs/provisioners/powershell.mdx | 10 +++++----- .../docs/provisioners/puppet-masterless.mdx | 4 ++-- .../content/docs/provisioners/puppet-server.mdx | 4 ++-- website/content/docs/provisioners/shell-local.mdx | 2 +- website/content/docs/provisioners/shell.mdx | 4 ++-- .../content/docs/provisioners/windows-shell.mdx | 6 +++--- .../templates/legacy_json_templates/builders.mdx | 4 ++-- .../legacy_json_templates/communicator.mdx | 2 +- .../templates/legacy_json_templates/engine.mdx | 6 +++--- .../docs/templates/legacy_json_templates/index.mdx | 8 ++++---- .../legacy_json_templates/provisioners.mdx | 2 +- .../legacy_json_templates/user-variables.mdx | 2 +- .../builder/amazon/chroot/Config-not-required.mdx | 2 +- .../amazon/common/AMIConfig-not-required.mdx | 6 +++--- .../builder/amazon/common/AMIConfig-required.mdx | 2 +- .../amazon/common/RunConfig-not-required.mdx | 2 +- .../builder/amazon/ebs/Config-not-required.mdx | 2 +- .../amazon/ebssurrogate/Config-not-required.mdx | 2 +- .../amazon/ebsvolume/BlockDevice-not-required.mdx | 2 +- .../amazon/ebsvolume/Config-not-required.mdx | 2 +- .../common/GuestAdditionsConfig-not-required.mdx | 2 +- .../common/VBoxManageConfig-not-required.mdx | 2 +- .../vmware/common/ToolsConfig-not-required.mdx | 2 +- .../builder/vmware/iso/Config-not-required.mdx | 2 +- website/content/partials/builders/boot-command.mdx | 2 +- .../alicloud-import/Config-not-required.mdx | 4 ++-- .../googlecompute-import/Config-not-required.mdx | 2 +- .../manifest/Config-not-required.mdx | 2 +- .../ucloud-import/Config-not-required.mdx | 2 +- .../yandex-export/Config-required.mdx | 2 +- .../yandex-import/Config-not-required.mdx | 2 +- .../provisioner/ansible/Config-not-required.mdx | 2 +- website/redirects.next.js | 2 +- 105 files changed, 177 insertions(+), 177 deletions(-) diff --git a/builder/amazon/chroot/builder.go b/builder/amazon/chroot/builder.go index 5b9951c8a..afae29446 100644 --- a/builder/amazon/chroot/builder.go +++ b/builder/amazon/chroot/builder.go @@ -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 diff --git a/builder/amazon/common/ami_config.go b/builder/amazon/common/ami_config.go index 3fb103a4f..d9596eb22 100644 --- a/builder/amazon/common/ami_config.go +++ b/builder/amazon/common/ami_config.go @@ -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 diff --git a/builder/amazon/common/run_config.go b/builder/amazon/common/run_config.go index d9019e4ce..256703973 100644 --- a/builder/amazon/common/run_config.go +++ b/builder/amazon/common/run_config.go @@ -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 diff --git a/builder/amazon/ebs/builder.go b/builder/amazon/ebs/builder.go index c29e87540..fb3b9cbf6 100644 --- a/builder/amazon/ebs/builder.go +++ b/builder/amazon/ebs/builder.go @@ -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 diff --git a/builder/amazon/ebssurrogate/builder.go b/builder/amazon/ebssurrogate/builder.go index 0283fc43a..7b4a50ed2 100644 --- a/builder/amazon/ebssurrogate/builder.go +++ b/builder/amazon/ebssurrogate/builder.go @@ -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 diff --git a/builder/amazon/ebsvolume/block_device.go b/builder/amazon/ebsvolume/block_device.go index f82803d94..49d1067c8 100644 --- a/builder/amazon/ebsvolume/block_device.go +++ b/builder/amazon/ebsvolume/block_device.go @@ -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 diff --git a/builder/amazon/ebsvolume/builder.go b/builder/amazon/ebsvolume/builder.go index f87228ad5..d22c589b3 100644 --- a/builder/amazon/ebsvolume/builder.go +++ b/builder/amazon/ebsvolume/builder.go @@ -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 diff --git a/builder/virtualbox/common/guest_additions_config.go b/builder/virtualbox/common/guest_additions_config.go index 5e8d430ba..4a7e58538 100644 --- a/builder/virtualbox/common/guest_additions_config.go +++ b/builder/virtualbox/common/guest_additions_config.go @@ -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 diff --git a/builder/virtualbox/common/vboxmanage_config.go b/builder/virtualbox/common/vboxmanage_config.go index 33556d129..577998ea0 100644 --- a/builder/virtualbox/common/vboxmanage_config.go +++ b/builder/virtualbox/common/vboxmanage_config.go @@ -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"` diff --git a/builder/vmware/common/tools_config.go b/builder/vmware/common/tools_config.go index e96766eb5..7774cce15 100644 --- a/builder/vmware/common/tools_config.go +++ b/builder/vmware/common/tools_config.go @@ -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`. diff --git a/builder/vmware/iso/config.go b/builder/vmware/iso/config.go index a2cecf4c5..e1bf1cd39 100644 --- a/builder/vmware/iso/config.go +++ b/builder/vmware/iso/config.go @@ -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 }}`. diff --git a/post-processor/alicloud-import/post-processor.go b/post-processor/alicloud-import/post-processor.go index f1e351657..83f5aaf2b 100644 --- a/post-processor/alicloud-import/post-processor.go +++ b/post-processor/alicloud-import/post-processor.go @@ -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 diff --git a/post-processor/googlecompute-import/post-processor.go b/post-processor/googlecompute-import/post-processor.go index 6e9227316..3d92476c6 100644 --- a/post-processor/googlecompute-import/post-processor.go +++ b/post-processor/googlecompute-import/post-processor.go @@ -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"` diff --git a/post-processor/manifest/post-processor.go b/post-processor/manifest/post-processor.go index 8edbf9fcd..59e0664bd 100644 --- a/post-processor/manifest/post-processor.go +++ b/post-processor/manifest/post-processor.go @@ -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 diff --git a/post-processor/ucloud-import/post-processor.go b/post-processor/ucloud-import/post-processor.go index b96b5a5f6..5d8f0f73f 100644 --- a/post-processor/ucloud-import/post-processor.go +++ b/post-processor/ucloud-import/post-processor.go @@ -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 diff --git a/post-processor/yandex-export/post-processor.go b/post-processor/yandex-export/post-processor.go index f333c1ca8..c3dee4de4 100644 --- a/post-processor/yandex-export/post-processor.go +++ b/post-processor/yandex-export/post-processor.go @@ -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"` diff --git a/post-processor/yandex-import/post-processor.go b/post-processor/yandex-import/post-processor.go index b949ba64f..7095739c6 100644 --- a/post-processor/yandex-import/post-processor.go +++ b/post-processor/yandex-import/post-processor.go @@ -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 diff --git a/provisioner/ansible/provisioner.go b/provisioner/ansible/provisioner.go index 58fac8e35..55932abb3 100644 --- a/provisioner/ansible/provisioner.go +++ b/provisioner/ansible/provisioner.go @@ -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, diff --git a/website/content/docs/builders/alicloud-ecs.mdx b/website/content/docs/builders/alicloud-ecs.mdx index db64d266f..120458a6f 100644 --- a/website/content/docs/builders/alicloud-ecs.mdx +++ b/website/content/docs/builders/alicloud-ecs.mdx @@ -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: diff --git a/website/content/docs/builders/amazon/chroot.mdx b/website/content/docs/builders/amazon/chroot.mdx index 373e9727c..322549d34 100644 --- a/website/content/docs/builders/amazon/chroot.mdx +++ b/website/content/docs/builders/amazon/chroot.mdx @@ -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: diff --git a/website/content/docs/builders/amazon/ebs.mdx b/website/content/docs/builders/amazon/ebs.mdx index e54647154..655b9bfc7 100644 --- a/website/content/docs/builders/amazon/ebs.mdx +++ b/website/content/docs/builders/amazon/ebs.mdx @@ -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: diff --git a/website/content/docs/builders/amazon/ebssurrogate.mdx b/website/content/docs/builders/amazon/ebssurrogate.mdx index b17aca88d..59b6289a4 100644 --- a/website/content/docs/builders/amazon/ebssurrogate.mdx +++ b/website/content/docs/builders/amazon/ebssurrogate.mdx @@ -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: diff --git a/website/content/docs/builders/amazon/ebsvolume.mdx b/website/content/docs/builders/amazon/ebsvolume.mdx index 6eba6a866..9df1ce1b1 100644 --- a/website/content/docs/builders/amazon/ebsvolume.mdx +++ b/website/content/docs/builders/amazon/ebsvolume.mdx @@ -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: diff --git a/website/content/docs/builders/amazon/instance.mdx b/website/content/docs/builders/amazon/instance.mdx index 876c0cf75..99ba3237c 100644 --- a/website/content/docs/builders/amazon/instance.mdx +++ b/website/content/docs/builders/amazon/instance.mdx @@ -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 diff --git a/website/content/docs/builders/azure/arm.mdx b/website/content/docs/builders/azure/arm.mdx index fe2964227..877d1d7db 100644 --- a/website/content/docs/builders/azure/arm.mdx +++ b/website/content/docs/builders/azure/arm.mdx @@ -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 diff --git a/website/content/docs/builders/cloudstack.mdx b/website/content/docs/builders/cloudstack.mdx index 0aee5b58e..f092f9e44 100644 --- a/website/content/docs/builders/cloudstack.mdx +++ b/website/content/docs/builders/cloudstack.mdx @@ -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_`, 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 diff --git a/website/content/docs/builders/digitalocean.mdx b/website/content/docs/builders/digitalocean.mdx index 5df946c87..173c3b9ad 100644 --- a/website/content/docs/builders/digitalocean.mdx +++ b/website/content/docs/builders/digitalocean.mdx @@ -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. diff --git a/website/content/docs/builders/docker.mdx b/website/content/docs/builders/docker.mdx index b29b93c2a..35ec5cb1d 100644 --- a/website/content/docs/builders/docker.mdx +++ b/website/content/docs/builders/docker.mdx @@ -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): @@ -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): diff --git a/website/content/docs/builders/file.mdx b/website/content/docs/builders/file.mdx index 069c0fc1c..d5a815a5b 100644 --- a/website/content/docs/builders/file.mdx +++ b/website/content/docs/builders/file.mdx @@ -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: diff --git a/website/content/docs/builders/googlecompute.mdx b/website/content/docs/builders/googlecompute.mdx index 2140175d6..87b8d02fb 100644 --- a/website/content/docs/builders/googlecompute.mdx +++ b/website/content/docs/builders/googlecompute.mdx @@ -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 diff --git a/website/content/docs/builders/hetzner-cloud.mdx b/website/content/docs/builders/hetzner-cloud.mdx index 5600e08da..ab4a62d3a 100644 --- a/website/content/docs/builders/hetzner-cloud.mdx +++ b/website/content/docs/builders/hetzner-cloud.mdx @@ -29,7 +29,7 @@ segmented below into two categories: required and optional parameters. Within each category, the available configuration keys are alphabetized. In addition to the options listed here, a -[communicator](/docs/templates/communicator) can be configured for this +[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this builder. ### Required Builder Configuration options: @@ -83,7 +83,7 @@ builder. - `snapshot_name` (string) - The name of the resulting snapshot that will 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 apply to the created image. diff --git a/website/content/docs/builders/hyperone.mdx b/website/content/docs/builders/hyperone.mdx index b9d09ef96..ac118c662 100644 --- a/website/content/docs/builders/hyperone.mdx +++ b/website/content/docs/builders/hyperone.mdx @@ -86,7 +86,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: @@ -122,7 +122,7 @@ builder. - `image_name` (string) - The name of the resulting image. Defaults to `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. diff --git a/website/content/docs/builders/hyperv/iso.mdx b/website/content/docs/builders/hyperv/iso.mdx index 8384df0db..e342cc259 100644 --- a/website/content/docs/builders/hyperv/iso.mdx +++ b/website/content/docs/builders/hyperv/iso.mdx @@ -65,7 +65,7 @@ are organized below into two categories: required and optional. Within each category, the available options are alphabetized and described. In addition to the options listed here, a -[communicator](/docs/templates/communicator) can be configured for this +[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this builder. ### Optional: diff --git a/website/content/docs/builders/hyperv/vmcx.mdx b/website/content/docs/builders/hyperv/vmcx.mdx index 54ce4b114..8e57bc19a 100644 --- a/website/content/docs/builders/hyperv/vmcx.mdx +++ b/website/content/docs/builders/hyperv/vmcx.mdx @@ -66,7 +66,7 @@ are organized below into two categories: required and optional. Within each category, the available options are alphabetized and described. In addition to the options listed here, a -[communicator](/docs/templates/communicator) can be configured for this +[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this builder. ## ISO Configuration Reference diff --git a/website/content/docs/builders/linode.mdx b/website/content/docs/builders/linode.mdx index dcd16a1bf..34f094a91 100644 --- a/website/content/docs/builders/linode.mdx +++ b/website/content/docs/builders/linode.mdx @@ -35,7 +35,7 @@ segmented below into two categories: required and optional parameters. Within each category, the available configuration keys are alphabetized. In addition to the options listed here, a -[communicator](/docs/templates/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 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 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 will appear in your account. Defaults to "". diff --git a/website/content/docs/builders/null.mdx b/website/content/docs/builders/null.mdx index 52acdb774..bb42fca42 100644 --- a/website/content/docs/builders/null.mdx +++ b/website/content/docs/builders/null.mdx @@ -55,4 +55,4 @@ build { ## Configuration Reference The null builder has no configuration parameters other than the -[communicator](/docs/templates/communicator) settings. +[communicator](/docs/templates/legacy_json_templates/communicators) settings. diff --git a/website/content/docs/builders/oneandone.mdx b/website/content/docs/builders/oneandone.mdx index 40b969444..20018ae08 100644 --- a/website/content/docs/builders/oneandone.mdx +++ b/website/content/docs/builders/oneandone.mdx @@ -18,7 +18,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. In addition to the options defined there, a private key file can also be supplied to override the typical auto-generated key: diff --git a/website/content/docs/builders/openstack.mdx b/website/content/docs/builders/openstack.mdx index 624cf89a1..848a97e40 100644 --- a/website/content/docs/builders/openstack.mdx +++ b/website/content/docs/builders/openstack.mdx @@ -51,7 +51,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: diff --git a/website/content/docs/builders/oracle/oci.mdx b/website/content/docs/builders/oracle/oci.mdx index ef124cf6e..a7c235fb0 100644 --- a/website/content/docs/builders/oracle/oci.mdx +++ b/website/content/docs/builders/oracle/oci.mdx @@ -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 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 diff --git a/website/content/docs/builders/outscale/bsu.mdx b/website/content/docs/builders/outscale/bsu.mdx index 17c2cd90d..c41f45e74 100644 --- a/website/content/docs/builders/outscale/bsu.mdx +++ b/website/content/docs/builders/outscale/bsu.mdx @@ -41,14 +41,14 @@ 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: - `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`. @@ -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 -- `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. - `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 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 - engine](/docs/templates/engine), see [Build template + engine](/docs/templates/legacy_json_templates/engine), see [Build template data](#build-template-data) for more information. - `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 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. - `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. 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. - `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. -- `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_`, where <UUID> is a 36 character unique identifier. diff --git a/website/content/docs/builders/outscale/bsusurrogate.mdx b/website/content/docs/builders/outscale/bsusurrogate.mdx index 838fb43c3..2c7a2c93c 100644 --- a/website/content/docs/builders/outscale/bsusurrogate.mdx +++ b/website/content/docs/builders/outscale/bsusurrogate.mdx @@ -29,14 +29,14 @@ 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: - `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`. @@ -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 -- `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. - `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 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 - engine](/docs/templates/engine), see [Build template + engine](/docs/templates/legacy_json_templates/engine), see [Build template data](#build-template-data) for more information. - `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 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. - `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. 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. - `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. -- `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_`, where <UUID> is a 36 character unique identifier. diff --git a/website/content/docs/builders/outscale/bsuvolume.mdx b/website/content/docs/builders/outscale/bsuvolume.mdx index 32ea11280..af327a78b 100644 --- a/website/content/docs/builders/outscale/bsuvolume.mdx +++ b/website/content/docs/builders/outscale/bsuvolume.mdx @@ -35,7 +35,7 @@ segmented below into two categories: required and optional parameters. Within each category, the available configuration keys are alphabetized. In addition to the options listed here, a -[communicator](/docs/templates/communicator) can be configured for this +[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this builder. ### Required: @@ -74,7 +74,7 @@ builder. - `tags` (map) - Tags to apply to the volume. These are retained after 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. - `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 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 - engine](/docs/templates/engine), see [Build template + engine](/docs/templates/legacy_json_templates/engine), see [Build template data](#build-template-data) for more information. - `security_group_id` (string) - The ID (_not_ the name) of the security diff --git a/website/content/docs/builders/outscale/chroot.mdx b/website/content/docs/builders/outscale/chroot.mdx index 2f0f07899..b77f74500 100644 --- a/website/content/docs/builders/outscale/chroot.mdx +++ b/website/content/docs/builders/outscale/chroot.mdx @@ -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) -- `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) @@ -71,7 +71,7 @@ each category, the available configuration keys are alphabetized. ### Optional: - `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. - `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 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. - `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. 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. - `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. - `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. ## Basic Example diff --git a/website/content/docs/builders/parallels/iso.mdx b/website/content/docs/builders/parallels/iso.mdx index 79d0eae09..a14594fd8 100644 --- a/website/content/docs/builders/parallels/iso.mdx +++ b/website/content/docs/builders/parallels/iso.mdx @@ -53,7 +53,7 @@ are organized below into two categories: required and optional. Within each category, the available options are alphabetized and described. In addition to the options listed here, a -[communicator](/docs/templates/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 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 upload Parallels Tools. This only takes effect if `parallels_tools_mode` 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 `parallels_tools_flavor`. By default this is `prl-tools-{{.Flavor}}.iso` 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 argument on the command-line to `prlctl` (but excluding `prlctl` itself). 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` 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. 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 required for many `prlctl` calls. diff --git a/website/content/docs/builders/parallels/pvm.mdx b/website/content/docs/builders/parallels/pvm.mdx index 3cc967fff..1c7b885bc 100644 --- a/website/content/docs/builders/parallels/pvm.mdx +++ b/website/content/docs/builders/parallels/pvm.mdx @@ -50,7 +50,7 @@ are organized below into two categories: required and optional. Within each category, the available options are alphabetized and described. In addition to the options listed here, a -[communicator](/docs/templates/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 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. This only takes effect if `parallels_tools_mode` 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 `parallels_tools_flavor`. By default this is `prl-tools-{{.Flavor}}.iso` 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 argument on the command-line to `prlctl` (but excluding `prlctl` itself). 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` 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 `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 required for many `prlctl` calls. diff --git a/website/content/docs/builders/profitbricks.mdx b/website/content/docs/builders/profitbricks.mdx index d6dfea2ac..3d4a4aa1b 100644 --- a/website/content/docs/builders/profitbricks.mdx +++ b/website/content/docs/builders/profitbricks.mdx @@ -18,7 +18,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. In addition to the options defined there, a private key file can also be supplied to override the typical auto-generated key: diff --git a/website/content/docs/builders/proxmox/clone.mdx b/website/content/docs/builders/proxmox/clone.mdx index c7f80510c..a8a09b1f9 100644 --- a/website/content/docs/builders/proxmox/clone.mdx +++ b/website/content/docs/builders/proxmox/clone.mdx @@ -28,7 +28,7 @@ segmented below into two categories: required and optional parameters. Within each category, the available configuration keys are alphabetized. In addition to the options listed here, a -[communicator](/docs/templates/communicator) can be configured for this +[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this builder. If no communicator is defined, an SSH key is generated for use, and is used diff --git a/website/content/docs/builders/proxmox/iso.mdx b/website/content/docs/builders/proxmox/iso.mdx index 954b37699..e8905ba1c 100644 --- a/website/content/docs/builders/proxmox/iso.mdx +++ b/website/content/docs/builders/proxmox/iso.mdx @@ -28,7 +28,7 @@ segmented below into two categories: required and optional parameters. Within each category, the available configuration keys are alphabetized. In addition to the options listed here, a -[communicator](/docs/templates/communicator) can be configured for this +[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this builder. ### Required: diff --git a/website/content/docs/builders/scaleway.mdx b/website/content/docs/builders/scaleway.mdx index 502915d48..3ba85af33 100644 --- a/website/content/docs/builders/scaleway.mdx +++ b/website/content/docs/builders/scaleway.mdx @@ -34,7 +34,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. In addition to the options defined there, a private key file can also be supplied to override the typical auto-generated key: diff --git a/website/content/docs/builders/tencentcloud-cvm.mdx b/website/content/docs/builders/tencentcloud-cvm.mdx index 20ff0e208..a74606fc3 100644 --- a/website/content/docs/builders/tencentcloud-cvm.mdx +++ b/website/content/docs/builders/tencentcloud-cvm.mdx @@ -17,7 +17,7 @@ customized images based on an existing base images. The following configuration options are available for building Tencentcloud images. In addition to the options listed here, -a [communicator](/docs/templates/communicator) can be configured for this builder. +a [communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this builder. ### Required: diff --git a/website/content/docs/builders/triton.mdx b/website/content/docs/builders/triton.mdx index f0d51f4aa..4070dca45 100644 --- a/website/content/docs/builders/triton.mdx +++ b/website/content/docs/builders/triton.mdx @@ -47,7 +47,7 @@ There are many configuration options available for the builder. They are segmented below into two categories: required and optional parameters. In addition to the options listed here, a -[communicator](/docs/templates/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 can also be supplied to override the typical auto-generated key: diff --git a/website/content/docs/builders/ucloud-uhost.mdx b/website/content/docs/builders/ucloud-uhost.mdx index ec67c9646..f635cc4e7 100644 --- a/website/content/docs/builders/ucloud-uhost.mdx +++ b/website/content/docs/builders/ucloud-uhost.mdx @@ -22,7 +22,7 @@ The following configuration options are available for building UCloud images. Th segmented below into two categories: required and optional parameters. In addition to the options listed here, a -[communicator](/docs/templates/communicator) can be configured for this +[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this builder. ~> **Note:** The builder doesn't support Windows images for now and only supports CentOS and Ubuntu images via SSH authentication with `ssh_username` (Required) and `ssh_password` (Optional). The `ssh_username` must be `root` for CentOS images and `ubuntu` for Ubuntu images. The `ssh_password` may contain 8-30 characters, and must consist of at least 2 items out of the capital letters, lower case letters, numbers and special characters. The special characters include `()~!@#\$%^&\*-+=\_|{}\[]:;'<>,.?/`. diff --git a/website/content/docs/builders/virtualbox/vm.mdx b/website/content/docs/builders/virtualbox/vm.mdx index 1e918cc13..facde01c6 100644 --- a/website/content/docs/builders/virtualbox/vm.mdx +++ b/website/content/docs/builders/virtualbox/vm.mdx @@ -100,7 +100,7 @@ references for [ISO](#iso-configuration), configuration references, which are necessary for this build to succeed and can be found further down the page. In addition to the options listed here, a -[communicator](/docs/templates/communicator) can be configured for this +[communicator](/docs/templates/legacy_json_templates/communicators) can be configured for this builder. ### Required: diff --git a/website/content/docs/builders/yandex.mdx b/website/content/docs/builders/yandex.mdx index f63e2df41..f7db66c63 100644 --- a/website/content/docs/builders/yandex.mdx +++ b/website/content/docs/builders/yandex.mdx @@ -64,7 +64,7 @@ Configuration options are organized below into two categories: required and optional. Within each category, the available options are alphabetized and described. -In addition to the options listed here, a [communicator](/docs/templates/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 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 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. The generated variables available for this builder see above diff --git a/website/content/docs/commands/build.mdx b/website/content/docs/commands/build.mdx index 9f4be12c3..aa6fe8499 100644 --- a/website/content/docs/commands/build.mdx +++ b/website/content/docs/commands/build.mdx @@ -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 the failed step. - `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'` diff --git a/website/content/docs/communicators/index.mdx b/website/content/docs/communicators/index.mdx index bf4175adf..9ab93f343 100644 --- a/website/content/docs/communicators/index.mdx +++ b/website/content/docs/communicators/index.mdx @@ -12,7 +12,7 @@ Communicators are the mechanism Packer uses to upload files, execute scripts, etc. with the machine being created. 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: - `none` - No communicator will be used. If this is set, most provisioners diff --git a/website/content/docs/communicators/ssh.mdx b/website/content/docs/communicators/ssh.mdx index e27a3ef76..f3bd518ca 100644 --- a/website/content/docs/communicators/ssh.mdx +++ b/website/content/docs/communicators/ssh.mdx @@ -10,7 +10,7 @@ sidebar_title: SSH Communicators are the mechanism Packer uses to upload files, execute scripts, 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 communicator for a majority of builders. diff --git a/website/content/docs/extending/custom-builders.mdx b/website/content/docs/extending/custom-builders.mdx index 546ab9b93..38791d278 100644 --- a/website/content/docs/extending/custom-builders.mdx +++ b/website/content/docs/extending/custom-builders.mdx @@ -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 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). As of Packer v1.5.0, builder Prepare() methods return a list of custom variables diff --git a/website/content/docs/post-processors/amazon-import.mdx b/website/content/docs/post-processors/amazon-import.mdx index d89659a67..4faa38784 100644 --- a/website/content/docs/post-processors/amazon-import.mdx +++ b/website/content/docs/post-processors/amazon-import.mdx @@ -137,7 +137,7 @@ Optional: 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) 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. - `skip_clean` (boolean) - Whether we should skip removing the OVA file diff --git a/website/content/docs/post-processors/checksum.mdx b/website/content/docs/post-processors/checksum.mdx index 643f5f7c1..fcfbd21a9 100644 --- a/website/content/docs/post-processors/checksum.mdx +++ b/website/content/docs/post-processors/checksum.mdx @@ -70,7 +70,7 @@ Optional parameters: `packer_{{.BuildName}}_{{.BuilderType}}_{{.ChecksumType}}.checksum`. For 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 - [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. The following special variables are also available to use in the output template: diff --git a/website/content/docs/post-processors/compress.mdx b/website/content/docs/post-processors/compress.mdx index 91647fa30..ad1a0812e 100644 --- a/website/content/docs/post-processors/compress.mdx +++ b/website/content/docs/post-processors/compress.mdx @@ -27,7 +27,7 @@ you will need to specify the `output` option. packer defaults to `.tar.gz` behavior but will not change the filename. 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. The following special variables are also available to use in the output template: diff --git a/website/content/docs/post-processors/digitalocean-import.mdx b/website/content/docs/post-processors/digitalocean-import.mdx index c92858e0f..3e0aa8147 100644 --- a/website/content/docs/post-processors/digitalocean-import.mdx +++ b/website/content/docs/post-processors/digitalocean-import.mdx @@ -78,7 +78,7 @@ Optional: - `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 - [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. If not specified, this will default to `packer-import-{{timestamp}}`. diff --git a/website/content/docs/post-processors/googlecompute-export.mdx b/website/content/docs/post-processors/googlecompute-export.mdx index 408767671..8e4db6563 100644 --- a/website/content/docs/post-processors/googlecompute-export.mdx +++ b/website/content/docs/post-processors/googlecompute-export.mdx @@ -26,7 +26,7 @@ As such, the authentication credentials that built the image must have write permissions to the GCS `paths`. ~> **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 diff --git a/website/content/docs/post-processors/googlecompute-import.mdx b/website/content/docs/post-processors/googlecompute-import.mdx index fea6c6963..53e2de6b2 100644 --- a/website/content/docs/post-processors/googlecompute-import.mdx +++ b/website/content/docs/post-processors/googlecompute-import.mdx @@ -29,7 +29,7 @@ see the [GCE import documentation](https://cloud.google.com/compute/docs/images/ for details. ~> **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 diff --git a/website/content/docs/post-processors/shell-local.mdx b/website/content/docs/post-processors/shell-local.mdx index 356f17f59..c59378aa7 100644 --- a/website/content/docs/post-processors/shell-local.mdx +++ b/website/content/docs/post-processors/shell-local.mdx @@ -116,11 +116,11 @@ Optional parameters: ["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 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 - 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 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 @@ -277,7 +277,7 @@ In addition to being able to specify custom environmental variables using the commonly useful environmental variables: - `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 distinguish them slightly from a common provisioning script. diff --git a/website/content/docs/post-processors/vagrant-cloud.mdx b/website/content/docs/post-processors/vagrant-cloud.mdx index 1e84da205..2baf4de17 100644 --- a/website/content/docs/post-processors/vagrant-cloud.mdx +++ b/website/content/docs/post-processors/vagrant-cloud.mdx @@ -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 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. The following extra variables are also avilable in this engine: diff --git a/website/content/docs/post-processors/vagrant.mdx b/website/content/docs/post-processors/vagrant.mdx index bc2256545..5dba60d59 100644 --- a/website/content/docs/post-processors/vagrant.mdx +++ b/website/content/docs/post-processors/vagrant.mdx @@ -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. 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. 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 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 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`. - `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. - `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. 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 diff --git a/website/content/docs/post-processors/vsphere-template.mdx b/website/content/docs/post-processors/vsphere-template.mdx index 5170c2ff7..4dbc13af6 100644 --- a/website/content/docs/post-processors/vsphere-template.mdx +++ b/website/content/docs/post-processors/vsphere-template.mdx @@ -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 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 -single pipeline, see [Post-Processors](/docs/templates/post-processors) +single pipeline, see [Post-Processors](/docs/templates/legacy_json_templates/post-processors) for more information): ```json diff --git a/website/content/docs/provisioners/chef-client.mdx b/website/content/docs/provisioners/chef-client.mdx index 2067f8a65..8e5eec706 100644 --- a/website/content/docs/provisioners/chef-client.mdx +++ b/website/content/docs/provisioners/chef-client.mdx @@ -55,7 +55,7 @@ configuration is actually required. `accept-silent` and `accept-no-persist`. For details see [Accepting the 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. - `config_template` (string) - Path to a template that will be used for the @@ -75,7 +75,7 @@ configuration is actually required. will be available. - `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. - `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". - `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. - `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 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. - `node_name` (string) - The name of the node to register with the Chef @@ -206,7 +206,7 @@ trusted_certs_dir :{{.TrustedCertsDir}} {{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: - `ChefEnvironment` - The Chef environment name. @@ -321,7 +321,7 @@ mode. **Packer variables** 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 "variables": { @@ -386,7 +386,7 @@ mode, while passing a `run_list` using a variable. **Packer variables** 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 "variables": { diff --git a/website/content/docs/provisioners/chef-solo.mdx b/website/content/docs/provisioners/chef-solo.mdx index efcea89a5..975f67bd2 100644 --- a/website/content/docs/provisioners/chef-solo.mdx +++ b/website/content/docs/provisioners/chef-solo.mdx @@ -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. - `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. - `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". - `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. - `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}}] ``` -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: - `ChefEnvironment` - The current enabled environment. Only non-empty if the diff --git a/website/content/docs/provisioners/converge.mdx b/website/content/docs/provisioners/converge.mdx index 58b04005f..90cbbc104 100644 --- a/website/content/docs/provisioners/converge.mdx +++ b/website/content/docs/provisioners/converge.mdx @@ -60,14 +60,14 @@ Optional parameters: module. - `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. - `prevent_sudo` (boolean) - stop Converge from running with administrator privileges via sudo - `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 variables are also avilable in this engine: diff --git a/website/content/docs/provisioners/index.mdx b/website/content/docs/provisioners/index.mdx index 6213d10d5..f054f2adc 100644 --- a/website/content/docs/provisioners/index.mdx +++ b/website/content/docs/provisioners/index.mdx @@ -17,6 +17,6 @@ use cases for provisioners include: - creating users - 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, choose it from the sidebar. diff --git a/website/content/docs/provisioners/powershell.mdx b/website/content/docs/provisioners/powershell.mdx index cb2c038e7..465f234c0 100644 --- a/website/content/docs/provisioners/powershell.mdx +++ b/website/content/docs/provisioners/powershell.mdx @@ -61,7 +61,7 @@ provisioner "powershell" { 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, you may use two extra variables: @@ -74,7 +74,7 @@ provisioner "powershell" { Packer injects some environmental variables by default into the 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 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 @@ -113,7 +113,7 @@ provisioner "powershell" { 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, you may use two extra variables: @@ -132,7 +132,7 @@ provisioner "powershell" { PowerShell script will be run with elevated privileges using the given 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 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 @@ -241,7 +241,7 @@ In addition to being able to specify custom environmental variables using the commonly useful environmental variables: - `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 distinguish them slightly from a common provisioning script. diff --git a/website/content/docs/provisioners/puppet-masterless.mdx b/website/content/docs/provisioners/puppet-masterless.mdx index e32244da8..c19c55776 100644 --- a/website/content/docs/provisioners/puppet-masterless.mdx +++ b/website/content/docs/provisioners/puppet-masterless.mdx @@ -62,7 +62,7 @@ Required parameters: Optional parameters: - `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, you may use the following extra variables: - 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 will be run with elevated privileges using the given Windows user. See the [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 field, including `` {{ build `Password`}} `` to use the password being used by the communicator to connect to your instance. diff --git a/website/content/docs/provisioners/puppet-server.mdx b/website/content/docs/provisioners/puppet-server.mdx index d02cfe46a..5571c0fb0 100644 --- a/website/content/docs/provisioners/puppet-server.mdx +++ b/website/content/docs/provisioners/puppet-server.mdx @@ -52,7 +52,7 @@ listed below: nothing, in which case a client private key won't be uploaded. - `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, you may use the following extra variables: - ClientCertPath: The value set in the template option @@ -120,7 +120,7 @@ listed below: * `elevated_user` and `elevated_password` (string) - If specified, Puppet will be run with elevated privileges using the given Windows user. See the [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 field, including `` {{ build `Password`}} `` to use the password being used by the communicator to connect to your instance. diff --git a/website/content/docs/provisioners/shell-local.mdx b/website/content/docs/provisioners/shell-local.mdx index 01ef21379..4c75dedc8 100644 --- a/website/content/docs/provisioners/shell-local.mdx +++ b/website/content/docs/provisioners/shell-local.mdx @@ -120,7 +120,7 @@ Optional parameters: - `execute_command` (array of strings) - The command used to execute the script. By default this is `["/bin/sh", "-c", "{{.Vars}}", "{{.Script}}"]` 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 `Vars`, which is the list of `environment_vars`, if configured. diff --git a/website/content/docs/provisioners/shell.mdx b/website/content/docs/provisioners/shell.mdx index f080a109b..789d22ce9 100644 --- a/website/content/docs/provisioners/shell.mdx +++ b/website/content/docs/provisioners/shell.mdx @@ -72,7 +72,7 @@ provisioner "shell" { default this is `chmod +x {{ .Path }}; {{ .Vars }} {{ .Path }}`, unless the user has set `"use_env_var_file": true` -- in that case, the default `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 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: - `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 distinguish them slightly from a common provisioning script. diff --git a/website/content/docs/provisioners/windows-shell.mdx b/website/content/docs/provisioners/windows-shell.mdx index 85781f427..46d0b75ec 100644 --- a/website/content/docs/provisioners/windows-shell.mdx +++ b/website/content/docs/provisioners/windows-shell.mdx @@ -50,8 +50,8 @@ provisioner "windows-shell" { - `execute_command` (string) - The command to use to execute the script. By default this is `{{ .Vars }}"{{ .Path }}"`. The value of this is treated as - [template engine](/docs/templates/engine). This is a - [template engine](/docs/templates/engine). Therefore, you may + [template engine](/docs/templates/legacy_json_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. In addition, there 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: - `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 distinguish them slightly from a common provisioning script. diff --git a/website/content/docs/templates/legacy_json_templates/builders.mdx b/website/content/docs/templates/legacy_json_templates/builders.mdx index 667cd7159..d2ecc5655 100644 --- a/website/content/docs/templates/legacy_json_templates/builders.mdx +++ b/website/content/docs/templates/legacy_json_templates/builders.mdx @@ -70,10 +70,10 @@ of them since the names must be unique. ## Communicators 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 instance or local virtual machine). All the examples for the various builders show some communicator (usually SSH), but the communicators are highly customizable so we recommend reading the -[communicator documentation](/docs/templates/communicator). +[communicator documentation](/docs/templates/legacy_json_templates/communicators). diff --git a/website/content/docs/templates/legacy_json_templates/communicator.mdx b/website/content/docs/templates/legacy_json_templates/communicator.mdx index 6db94c839..8ed47cbf7 100644 --- a/website/content/docs/templates/legacy_json_templates/communicator.mdx +++ b/website/content/docs/templates/legacy_json_templates/communicator.mdx @@ -14,7 +14,7 @@ Communicators are the mechanism Packer uses to upload files, execute scripts, etc. with the machine being created. Communicators are configured within the -[builder](/docs/templates/builders) section. +[builder](/docs/templates/legacy_json_templates/builders) section. All communicators have the following options: diff --git a/website/content/docs/templates/legacy_json_templates/engine.mdx b/website/content/docs/templates/legacy_json_templates/engine.mdx index 1482ab400..0868f84a6 100644 --- a/website/content/docs/templates/legacy_json_templates/engine.mdx +++ b/website/content/docs/templates/legacy_json_templates/engine.mdx @@ -60,7 +60,7 @@ Here is a full list of the available functions for reference. each function will behave. - `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 provide connection information and basic instance state information. Usage example: @@ -122,7 +122,7 @@ Here is a full list of the available functions for reference. - `isotime [FORMAT]` - UTC time, which can be [formatted](https://golang.org/pkg/time/#example_Time_Format). See more 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 `FORMAT`. See [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. -> **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. # isotime Function Format Reference diff --git a/website/content/docs/templates/legacy_json_templates/index.mdx b/website/content/docs/templates/legacy_json_templates/index.mdx index 6cdaab80b..a7020ee58 100644 --- a/website/content/docs/templates/legacy_json_templates/index.mdx +++ b/website/content/docs/templates/legacy_json_templates/index.mdx @@ -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 configures each of those builders. For more information on how to define 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 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 on what post-processors do and how they're defined, read the sub-section on [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 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 no provisioners will be run. For more information on how to define and 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 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 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 diff --git a/website/content/docs/templates/legacy_json_templates/provisioners.mdx b/website/content/docs/templates/legacy_json_templates/provisioners.mdx index 485919602..74ad88ec8 100644 --- a/website/content/docs/templates/legacy_json_templates/provisioners.mdx +++ b/website/content/docs/templates/legacy_json_templates/provisioners.mdx @@ -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 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 configuration as normal. This configuration is merged into the default provisioner configuration. diff --git a/website/content/docs/templates/legacy_json_templates/user-variables.mdx b/website/content/docs/templates/legacy_json_templates/user-variables.mdx index c9f19ef7a..c02ad9a97 100644 --- a/website/content/docs/templates/legacy_json_templates/user-variables.mdx +++ b/website/content/docs/templates/legacy_json_templates/user-variables.mdx @@ -20,7 +20,7 @@ environment-specific data, and other types of information out of your templates. This maximizes the portability of the template. 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. ## Usage diff --git a/website/content/partials/builder/amazon/chroot/Config-not-required.mdx b/website/content/partials/builder/amazon/chroot/Config-not-required.mdx index d70756fe1..9952dafda 100644 --- a/website/content/partials/builder/amazon/chroot/Config-not-required.mdx +++ b/website/content/partials/builder/amazon/chroot/Config-not-required.mdx @@ -122,7 +122,7 @@ 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 - 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. - `root_volume_tag` ([]{key string, value string}) - Same as [`root_volume_tags`](#root_volume_tags) but defined as a diff --git a/website/content/partials/builder/amazon/common/AMIConfig-not-required.mdx b/website/content/partials/builder/amazon/common/AMIConfig-not-required.mdx index b8498cd54..72d84bf6c 100644 --- a/website/content/partials/builder/amazon/common/AMIConfig-not-required.mdx +++ b/website/content/partials/builder/amazon/common/AMIConfig-not-required.mdx @@ -2,7 +2,7 @@ - `ami_description` (string) - 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. - `ami_virtualization_type` (string) - The type of virtualization for the AMI @@ -29,7 +29,7 @@ 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 - engine](/docs/templates/engine), see [Build template + engine](/docs/templates/legacy_json_templates/engine), see [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 @@ -119,7 +119,7 @@ - `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 - engine](/docs/templates/engine), see [Build template + engine](/docs/templates/legacy_json_templates/engine), see [Build template data](#build-template-data) for more information. - `snapshot_tag` ([]{key string, value string}) - Same as [`snapshot_tags`](#snapshot_tags) but defined as a singular diff --git a/website/content/partials/builder/amazon/common/AMIConfig-required.mdx b/website/content/partials/builder/amazon/common/AMIConfig-required.mdx index 3701463b5..b6c179c18 100644 --- a/website/content/partials/builder/amazon/common/AMIConfig-required.mdx +++ b/website/content/partials/builder/amazon/common/AMIConfig-required.mdx @@ -3,4 +3,4 @@ - `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, use a function like timestamp (see [template - engine](/docs/templates/engine) for more info). + engine](/docs/templates/legacy_json_templates/engine) for more info). diff --git a/website/content/partials/builder/amazon/common/RunConfig-not-required.mdx b/website/content/partials/builder/amazon/common/RunConfig-not-required.mdx index aa43bdca5..e7ad36873 100644 --- a/website/content/partials/builder/amazon/common/RunConfig-not-required.mdx +++ b/website/content/partials/builder/amazon/common/RunConfig-not-required.mdx @@ -125,7 +125,7 @@ - `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 - engine](/docs/templates/engine), see [Build template + engine](/docs/templates/legacy_json_templates/engine), see [Build template 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 diff --git a/website/content/partials/builder/amazon/ebs/Config-not-required.mdx b/website/content/partials/builder/amazon/ebs/Config-not-required.mdx index 79265e903..9da194803 100644 --- a/website/content/partials/builder/amazon/ebs/Config-not-required.mdx +++ b/website/content/partials/builder/amazon/ebs/Config-not-required.mdx @@ -22,7 +22,7 @@ - `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 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. - `run_volume_tag` ([]{name string, value string}) - Same as [`run_volume_tags`](#run_volume_tags) but defined as a singular diff --git a/website/content/partials/builder/amazon/ebssurrogate/Config-not-required.mdx b/website/content/partials/builder/amazon/ebssurrogate/Config-not-required.mdx index c90aadfa4..098ebabf7 100644 --- a/website/content/partials/builder/amazon/ebssurrogate/Config-not-required.mdx +++ b/website/content/partials/builder/amazon/ebssurrogate/Config-not-required.mdx @@ -19,7 +19,7 @@ - `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 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. - `run_volume_tag` ([]{name string, value string}) - Same as [`run_volume_tags`](#run_volume_tags) but defined as a singular diff --git a/website/content/partials/builder/amazon/ebsvolume/BlockDevice-not-required.mdx b/website/content/partials/builder/amazon/ebsvolume/BlockDevice-not-required.mdx index d3ba79efc..9bccc2818 100644 --- a/website/content/partials/builder/amazon/ebsvolume/BlockDevice-not-required.mdx +++ b/website/content/partials/builder/amazon/ebsvolume/BlockDevice-not-required.mdx @@ -1,7 +1,7 @@ - `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. - `tag` ([]{key string, value string}) - Same as [`tags`](#tags) but defined as a singular repeatable block diff --git a/website/content/partials/builder/amazon/ebsvolume/Config-not-required.mdx b/website/content/partials/builder/amazon/ebsvolume/Config-not-required.mdx index b1da376a5..79c6bccef 100644 --- a/website/content/partials/builder/amazon/ebsvolume/Config-not-required.mdx +++ b/website/content/partials/builder/amazon/ebsvolume/Config-not-required.mdx @@ -27,7 +27,7 @@ *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 diff --git a/website/content/partials/builder/virtualbox/common/GuestAdditionsConfig-not-required.mdx b/website/content/partials/builder/virtualbox/common/GuestAdditionsConfig-not-required.mdx index 214353b06..a6e10b733 100644 --- a/website/content/partials/builder/virtualbox/common/GuestAdditionsConfig-not-required.mdx +++ b/website/content/partials/builder/virtualbox/common/GuestAdditionsConfig-not-required.mdx @@ -17,7 +17,7 @@ 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. - `guest_additions_sha256` (string) - The SHA256 checksum of the guest diff --git a/website/content/partials/builder/virtualbox/common/VBoxManageConfig-not-required.mdx b/website/content/partials/builder/virtualbox/common/VBoxManageConfig-not-required.mdx index 6ebea3a8d..03fed8bb9 100644 --- a/website/content/partials/builder/virtualbox/common/VBoxManageConfig-not-required.mdx +++ b/website/content/partials/builder/virtualbox/common/VBoxManageConfig-not-required.mdx @@ -25,7 +25,7 @@ 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. diff --git a/website/content/partials/builder/vmware/common/ToolsConfig-not-required.mdx b/website/content/partials/builder/vmware/common/ToolsConfig-not-required.mdx index 6e3d1b06a..2beb38415 100644 --- a/website/content/partials/builder/vmware/common/ToolsConfig-not-required.mdx +++ b/website/content/partials/builder/vmware/common/ToolsConfig-not-required.mdx @@ -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_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`. diff --git a/website/content/partials/builder/vmware/iso/Config-not-required.mdx b/website/content/partials/builder/vmware/iso/Config-not-required.mdx index f647cee9a..a7980b1b8 100644 --- a/website/content/partials/builder/vmware/iso/Config-not-required.mdx +++ b/website/content/partials/builder/vmware/iso/Config-not-required.mdx @@ -30,7 +30,7 @@ - `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 engine has access to the template variables `{{ .DiskNumber }}` and `{{ .DiskName }}`. diff --git a/website/content/partials/builders/boot-command.mdx b/website/content/partials/builders/boot-command.mdx index a7ca68d1c..1cd77193e 100644 --- a/website/content/partials/builders/boot-command.mdx +++ b/website/content/partials/builders/boot-command.mdx @@ -55,7 +55,7 @@ To hold the `c` key down, you would use ``. Likewise, `` to release. ### Templates inside boot command 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: - `HTTPIP` and `HTTPPort` - The IP and port, respectively of an HTTP server diff --git a/website/content/partials/post-processor/alicloud-import/Config-not-required.mdx b/website/content/partials/post-processor/alicloud-import/Config-not-required.mdx index 35508c41a..db93a68c7 100644 --- a/website/content/partials/post-processor/alicloud-import/Config-not-required.mdx +++ b/website/content/partials/post-processor/alicloud-import/Config-not-required.mdx @@ -2,8 +2,8 @@ - `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 - 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. - `skip_clean` (bool) - Whether we should skip removing the RAW or VHD file uploaded to OSS diff --git a/website/content/partials/post-processor/googlecompute-import/Config-not-required.mdx b/website/content/partials/post-processor/googlecompute-import/Config-not-required.mdx index bacbd84e5..446643a69 100644 --- a/website/content/partials/post-processor/googlecompute-import/Config-not-required.mdx +++ b/website/content/partials/post-processor/googlecompute-import/Config-not-required.mdx @@ -4,7 +4,7 @@ - `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 - [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`. diff --git a/website/content/partials/post-processor/manifest/Config-not-required.mdx b/website/content/partials/post-processor/manifest/Config-not-required.mdx index b02e4ef85..e3a345844 100644 --- a/website/content/partials/post-processor/manifest/Config-not-required.mdx +++ b/website/content/partials/post-processor/manifest/Config-not-required.mdx @@ -9,5 +9,5 @@ - `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 - 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. diff --git a/website/content/partials/post-processor/ucloud-import/Config-not-required.mdx b/website/content/partials/post-processor/ucloud-import/Config-not-required.mdx index e19c56ae6..3fa292617 100644 --- a/website/content/partials/post-processor/ucloud-import/Config-not-required.mdx +++ b/website/content/partials/post-processor/ucloud-import/Config-not-required.mdx @@ -2,7 +2,7 @@ - `ufile_key_name` (string) - 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. - `skip_clean` (bool) - Whether we should skip removing the RAW, VHD, VMDK, or qcow2 file uploaded to diff --git a/website/content/partials/post-processor/yandex-export/Config-required.mdx b/website/content/partials/post-processor/yandex-export/Config-required.mdx index a051f192c..1d3aa9f9f 100644 --- a/website/content/partials/post-processor/yandex-export/Config-required.mdx +++ b/website/content/partials/post-processor/yandex-export/Config-required.mdx @@ -2,6 +2,6 @@ - `paths` ([]string) - 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. diff --git a/website/content/partials/post-processor/yandex-import/Config-not-required.mdx b/website/content/partials/post-processor/yandex-import/Config-not-required.mdx index 636cb9f04..877c4ddac 100644 --- a/website/content/partials/post-processor/yandex-import/Config-not-required.mdx +++ b/website/content/partials/post-processor/yandex-import/Config-not-required.mdx @@ -7,7 +7,7 @@ in storage service and first paths (URL) is used to, so no need to set this param. - `object_name` (string) - 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. - `skip_clean` (bool) - Whether skip removing the qcow2 file uploaded to Storage diff --git a/website/content/partials/provisioner/ansible/Config-not-required.mdx b/website/content/partials/provisioner/ansible/Config-not-required.mdx index 99d0df0f5..994efc5d7 100644 --- a/website/content/partials/provisioner/ansible/Config-not-required.mdx +++ b/website/content/partials/provisioner/ansible/Config-not-required.mdx @@ -34,7 +34,7 @@ "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, diff --git a/website/redirects.next.js b/website/redirects.next.js index 6c6fd8381..29642cf06 100644 --- a/website/redirects.next.js +++ b/website/redirects.next.js @@ -71,7 +71,7 @@ module.exports = [ }, { source: '/docs/templates/configuration-templates', - destination: '/docs/templates/engine', + destination: '/docs/templates/legacy_json_templates/engine', permanent: true, }, {