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

Clearly document all template-engine-enabled options (#8770)

This commit is contained in:
Megan Marsh 2020-02-20 02:05:27 -08:00 committed by GitHub
parent a8fcb2d91a
commit dde74232f2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
39 changed files with 243 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
builder/amazon/common/ami_config.go
View File

@ -19,9 +19,9 @@ type AMIConfig struct {
// engine](../templates/engine.html) 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, see Build template
// data for more information.
// AMI(s). By default this description is empty. This is a
// [template engine](/docs/templates/engine.html), see [Build template
// data](#build-template-data) for more information.
AMIDescription string `mapstructure:"ami_description" required:"false"`
// The type of virtualization for the AMI
// you are building. This option is required to register HVM images. Can be

2
builder/cloudstack/config.go
View File

@ -120,7 +120,7 @@ type Config struct {
// provisioners should connect to the local IP address of the instance.
UseLocalIPAddress bool `mapstructure:"use_local_ip_address" required:"false"`
// User data to launch with the instance. This is a
// template engine see User Data bellow for
// template 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.

12
builder/hyperone/config.go
View File

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

2
builder/lxc/config.go
View File

@ -28,7 +28,7 @@ type Config struct {
ContainerName string `mapstructure:"container_name" required:"false"`
// Allows you to specify a wrapper command, such
// as ssh so you can execute packer builds on a remote host. Defaults to
// Empty.
// `{{.Command}}`; i.e. no wrapper.
CommandWrapper string `mapstructure:"command_wrapper" required:"false"`
// The timeout in seconds to wait for the the
// container to start. Defaults to 20 seconds.

3
builder/lxd/config.go
View File

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

4
builder/qemu/builder.go
View File

@ -281,6 +281,10 @@ type Config struct {
// This will also work with WinRM, just change the port forward in
// `qemuargs` to map to WinRM's default port of `5985` or whatever value
// you have the service set to listen on.
//
// This is a template engine and allows access to the following variables:
// `{{ .HTTPIP }}`, `{{ .HTTPPort }}`, `{{ .HTTPDir }}`,
// `{{ .OutputDir }}`, `{{ .Name }}`, and `{{ .SSHHostPort }}`
QemuArgs [][]string `mapstructure:"qemuargs" required:"false"`
// The name of the Qemu binary to look for. This
// defaults to qemu-system-x86_64, but may need to be changed for

7
builder/virtualbox/iso/builder.go
View File

@ -57,8 +57,8 @@ type Config struct {
// The path on the guest virtual machine 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 where the Version variable is
// replaced with the VirtualBox version.
// the user. This is a configuration template where the `{{ .Version }}`
// variable is replaced with the VirtualBox version.
GuestAdditionsPath string `mapstructure:"guest_additions_path" required:"false"`
// The SHA256 checksum of the guest additions ISO that will be uploaded to
// the guest VM. By default the checksums will be downloaded from the
@ -69,7 +69,8 @@ type Config struct {
// URL if the ISO is at a local path. By default, the VirtualBox builder
// will attempt to find the guest additions ISO on the local file system.
// If it is not available locally, the builder will download the proper
// guest additions ISO from the internet.
// guest additions ISO from the internet. This is a template engine, and you
// have access to the variable `{{ .Version }}`.
GuestAdditionsURL string `mapstructure:"guest_additions_url" required:"false"`
// The interface type to use to mount guest additions when
// guest_additions_mode is set to attach. Will default to the value set in

7
builder/vmware/iso/config.go
View File

@ -108,8 +108,11 @@ type Config struct {
VMXDiskTemplatePath string `mapstructure:"vmx_disk_template_path"`
// Path to a [configuration template](/docs/templates/engine.html) that
// defines the contents of the virtual machine VMX file for VMware. This is
// for **advanced users only** as this can render the virtual machine
// defines the contents of the virtual machine VMX file for VMware. The
// engine has access to the template variables `{{ .DiskNumber }}` and
// `{{ .DiskName }}`.
//
// This is for **advanced users only** as this can render the virtual machine
// non-functional. See below for more information. For basic VMX
// modifications, try `vmx_data` first.
VMXTemplatePath string `mapstructure:"vmx_template_path" required:"false"`

2
common/bootcommand/config.go
View File

@ -76,7 +76,7 @@ import (
// `http_directory` configuration parameter. If `http_directory` isn't
// specified, these will be blank!
//
// - `Name` - The name of the VM.
// - `{{ .Name }}` - The name of the VM.
//
// Example boot command. This is actually a working boot command used to start an
// CentOS 6.4 installer:

2
website/source/docs/builders/cloudstack.html.md
View File

@ -203,7 +203,7 @@ The available variables are:
- `HTTPIP` and `HTTPPort` - The IP and port, respectively of an HTTP server
that is started serving the directory specified by the `http_directory`
configuration parameter. If `http_directory` isn't specified, these will be
blank.
blank. Example: "{{.HTTPIP}}:{{.HTTPPort}}/path/to/a/file/in/http_directory"
## Basic Example

5
website/source/docs/builders/oracle-classic.html.md
View File

@ -176,7 +176,10 @@ If this is set, a few more options become available.
- `builder_upload_image_command` (string) - The command to run to upload the
image to Object Storage Classic. This is for advanced users only, and you
should consult the default in code to decide on the changes to make. For
most users the default should suffice.
most users the default should suffice. If you choose to write your own,
this command is a template engine and can make use of the following
variables: `{{ .Username }}`, `{{ .Password }}`, `{{ .AccountID }}`,
`{{ .ImageFile }}`, and `{{ .SegmentPath }}`.
## Basic Example

5
website/source/docs/post-processors/alicloud-import.html.md
View File

@ -64,7 +64,10 @@ are two categories: required and optional parameters.
disk image after importing it to the cloud. Defaults to false.
- `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.
where the RAW or VHD file will be copied to for import. This is treated as
a [template engine](/docs/templates/engine.html), and you may access any of
the variables stored in the generated data using the
[build](/docs/templates/engine.html) template function.
- `skip_clean` (boolean) - Whether we should skip removing the RAW or VHD
file uploaded to OSS after the import process has completed. `true` means

4
website/source/docs/post-processors/amazon-import.html.md
View File

@ -138,7 +138,9 @@ Optional:
- `s3_key_name` (string) - The name of the key in `s3_bucket_name` where the
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`.
will be removed after import, unless `skip_clean` is `true`. This is
treated as a [template engine](/docs/templates/engine.html). Therefore, you
may use user variables and template functions in this field.
- `skip_clean` (boolean) - Whether we should skip removing the OVA file
uploaded to S3 after the import process has completed. "true" means that we

7
website/source/docs/post-processors/checksum.html.md
View File

@ -51,8 +51,11 @@ Optional parameters:
- `output` (string) - Specify filename to store checksums. This defaults to
`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`. The following variables
are available to use in the output template:
written as `packer_database_docker_md5.checksum`. This is treated as a
[template engine](/docs/templates/engine.html). 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:
- `BuildName`: The name of the builder that produced the artifact.
- `BuilderType`: The type of builder used to produce the artifact.

11
website/source/docs/post-processors/compress.html.md
View File

@ -27,8 +27,15 @@ you will need to specify the `output` option.
tarball. `.zip` will be a zip file. If the extension can't be detected
packer defaults to `.tar.gz` behavior but will not change the filename.
You can use `{{.BuildName}}` and `{{.BuilderType}}` in your output path. If
you are executing multiple builders in parallel you should make sure
This is treated as a
[template engine](/docs/templates/engine.html). 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:
- `{{.BuildName}}`
- `{{.BuilderType}}`
If you are executing multiple builders in parallel you should make sure
`output` is unique for each one. For example `packer_{{.BuildName}}.zip`.
- `format` (string) - Disable archive format autodetection and use provided

5
website/source/docs/post-processors/digitalocean-import.html.md
View File

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

4
website/source/docs/post-processors/googlecompute-import.html.md
View File

@ -50,7 +50,9 @@ for details.
### Optional
- `gcs_object_name` (string) - The name of the GCS object in `bucket` where
the RAW disk image will be copied for import. Defaults to
the RAW disk image will be copied for import. This is treated as a
[template engine](/docs/templates/engine.html). Therefore, you
may use user variables and template functions in this field. Defaults to
"packer-import-{{timestamp}}.tar.gz".
- `image_description` (string) - The description of the resulting image.

6
website/source/docs/post-processors/manifest.html.md
View File

@ -38,9 +38,9 @@ post-processors such as Docker and Artifice.
to `packer-manifest.json`.
- `strip_path` (boolean) Write only filename without the path to the manifest
file. This defaults to false.
- `custom_data` (map of strings) Arbitrary data to add to the manifest. This
is a [template engine](/docs/templates/engine.html); see
[Build template data](#build-template-data) for more information.
- `custom_data` (map of strings) Arbitrary data to add to the manifest.
This is a [template engine](/docs/templates/engine.html). Therefore, you
may use user variables and template functions in this field.
- `keep_input_artifact` (boolean) - Unlike most other post-processors, the
keep_input_artifact option will have no effect for the manifest
post-processor. We will always retain the input artifact for manifest,

6
website/source/docs/post-processors/shell-local.html.md
View File

@ -81,9 +81,11 @@ Optional parameters:
```
This is treated as a [template engine](/docs/templates/engine.html).
There are two available variables: `Script`, which is the path to the
There are several available variables: `Script`, which is the path to the
script to run, and `Vars`, which is the list of `environment_vars`, if
configured. If you choose to set this option, make sure that the first
configured. In addition, you may access any of the variables stored in the
generated data using the [build](/docs/templates/engine.html) 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
other than a flavor of the shell command language is not explicitly

5
website/source/docs/post-processors/ucloud-import.html.md
View File

@ -47,7 +47,10 @@ are two categories: required and optional parameters.
- `base_url` - (string) This is the base url. (Default: `https://api.ucloud.cn`).
- `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.
- `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.html).
Therefore, you may use user variables and template functions in this field.
- `skip_clean` (boolean) - Whether we should skip removing the RAW, VHD, VMDK, or qcow2 file uploaded to UFile after the import process has completed. Possible values are: `true` to leave it in the UFile bucket, `false` to remove it. (Default: `false`).

5
website/source/docs/post-processors/vagrant-cloud.html.md
View File

@ -102,6 +102,11 @@ 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.html). Therefore, you
may use user variables and template functions in this field.
The following extra variables are also avilable in this engine:
* `Provider`: The Vagrant provider the box is for
* `ArtifactId`: The ID of the input artifact.
## Use with the Vagrant Post-Processor

16
website/source/docs/post-processors/vagrant.html.md
View File

@ -78,12 +78,16 @@ more details about certain options in following sections.
`"keep_input_artifact":false`
- `output` (string) - The full path to the box file that will be created by
this post-processor. This is a [configuration
template](/docs/templates/engine.html). The variable `Provider` is replaced
by the Vagrant provider the box is for. The variable `ArtifactId` is
replaced by the ID of the input artifact. The variable `BuildName` is
replaced with the name of the build. By default, the value of this config
is `packer_{{.BuildName}}_{{.Provider}}.box`.
this post-processor. This is a
[template engine](/docs/templates/engine.html). Therefore, you may use user
variables and template functions in this field. The following extra
variables are also avilable in this engine:
* `Provider`: The Vagrant provider the box is for
* `ArtifactId`: The ID of the input artifact.
* `BuildName`: The name of the build.
By default, the value of this config is
`packer_{{.BuildName}}_{{.Provider}}.box`.
- `vagrantfile_template` (string) - Path to a template to use for the
Vagrantfile that is packaged with the box.

10
website/source/docs/provisioners/ansible.html.md.erb
View File

@ -77,11 +77,13 @@ Optional Parameters:
``` json
"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.html). Therefore, you
may use user variables and template functions in this field.
If you are running a Windows build on AWS, Azure, Google Compute, or OpenStack
and would like to access the auto-generated password that Packer uses to
connect to a Windows instance via WinRM, you can use the template variable
{{.WinRMPassword}} in this option. For example:
For example, if you are running a Windows build on AWS, Azure,
Google Compute, or OpenStack and would like to access the auto-generated
password that Packer uses to connect to a Windows instance via WinRM, you
can use the template variable {{.WinRMPassword}} in this option. Example:
``` json
"ansible_env_vars": [ "WINRM_PASSWORD={{.WinRMPassword}}" ],

3
website/source/docs/provisioners/chef-client.html.md.erb
View File

@ -50,6 +50,9 @@ 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
may use user variables and template functions in this field.
- `config_template` (string) - Path to a template that will be used for the
Chef configuration file. By default Packer only sets configuration it needs
to match the settings set in the provisioner configuration. If you need to

15
website/source/docs/provisioners/converge.html.md.erb
View File

@ -56,16 +56,21 @@ Optional parameters:
- `params` (maps of string to string) - parameters to pass into the root
module.
- `execute_command` (string) - the command used to execute Converge. This has
various [configuration template variables](/docs/templates/engine.html)
available.
- `execute_command` (string) - the command used to execute Converge. This is a
[configuration template variables](/docs/templates/engine.html).
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
has various [configuration template variables](/docs/templates/engine.html)
available.
is a [template engine](/docs/templates/engine.html). Therefore, you may use
user variables and template functions in this field. The following extra
variables are also avilable in this engine:
* `Version`: The version of Converge to use.
* `Sudo`: Boolean; intended to say whether to use sudo or not.
By default, this is `"curl -s https://get.converge.sh | {{if .Sudo}}sudo {{end}}sh {{if ne .Version \"\"}}-s -- -v {{.Version}}{{end}}"`
- `prevent_bootstrap_sudo` (boolean) - stop Converge from bootstrapping with
administrator privileges via sudo

41
website/source/docs/provisioners/powershell.html.md.erb
View File

@ -39,17 +39,20 @@ The example below is fully functional.
``` powershell
powershell -executionpolicy bypass "& { if (Test-Path variable:global:ProgressPreference){$ProgressPreference='SilentlyContinue'};. {{.Vars}}; &'{{.Path}}'; exit $LastExitCode }"
```
The value of this is treated as [configuration
template](/docs/templates/engine.html). There are two available variables:
`Path`, which is the path to the script to run, and `Vars`, which is the
location of a temp file containing the list of `environment_vars`, if
configured.
This is a [template engine](/docs/templates/engine.html). Therefore, you
may use user variables and template functions in this field. In addition,
you may use two extra variables:
* `Path`: The path to the script to run
* `Vars`: The location of a temp file containing the list of
`environment_vars`, if configured.
- `environment_vars` (array of strings) - An array of key/value pairs to
inject prior to the execute\_command. The format should be `key=value`.
Packer injects some environmental variables by default into the
environment, as well, which are covered in the section below. If you are
environment, as well, which are covered in the section below.
This is a [template engine](/docs/templates/engine.html). 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 generated password that Packer uses to connect to the instance via WinRM,
you can use the template variable `{{.WinRMPassword}}` to set this as an
@ -70,12 +73,14 @@ The example below is fully functional.
powershell -executionpolicy bypass "& { if (Test-Path variable:global:ProgressPreference){$ProgressPreference='SilentlyContinue'};. {{.Vars}}; &'{{.Path}}'; exit $LastExitCode }"
```
The value of this is treated as [configuration
template](/docs/templates/engine.html). There are two available variables:
`Path`, which is the path to the script to run, and `Vars`, which is the
location of a temp file containing the list of `environment_vars`. The
value of both `Path` and `Vars` can be manually configured by setting the
values for `remote_path` and `remote_env_var_path` respectively.
This is a [template engine](/docs/templates/engine.html). Therefore, you
may use user variables and template functions in this field. In addition,
you may use two extra variables:
* `Path`: The path to the script to run
* `Vars`: The location of a temp file containing the list of
`environment_vars`, if configured.
The value of both `Path` and `Vars` can be manually configured by setting
the values for `remote_path` and `remote_env_var_path` respectively.
If you use the SSH communicator and have changed your default shell, you
may need to modify your `execute_command` to make sure that the command is
@ -84,10 +89,14 @@ The example below is fully functional.
- `elevated_user` and `elevated_password` (string) - If specified, the
PowerShell script will be run with elevated privileges using the given
Windows user. If you are running a build on AWS, Azure, Google Compute,
Windows user.
This is a [template engine](/docs/templates/engine.html). Therefore, you
may use user variables and template functions in this field. If you are
running a build on AWS, Azure, Google Compute,
or OpenStack and would like to run using the generated password that Packer
uses to connect to the instance via WinRM, you may do so by using the template
variable {{.WinRMPassword}}. For example:
uses to connect to the instance via WinRM, you may do so by using the
template variable {{.WinRMPassword}}. For example:
``` json
"elevated_user": "Administrator",

26
website/source/docs/provisioners/puppet-masterless.html.md.erb
View File

@ -54,9 +54,24 @@ Required parameters:
Optional parameters:
- `execute_command` (string) - The command-line to execute Puppet. This also
has various [configuration template variables](/docs/templates/engine.html)
available.
- `execute_command` (string) - The command-line to execute Puppet. This is a
[template engine](/docs/templates/engine.html). 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
use in a command. This is internal and not settable by the user.
* HieraConfigPath: Path to a hiera configuration file to upload and use;
set in the template option hiera_config_path
* ManifestDir: The directory of the manifest file on the remote machine.
* ManifestFile: The manifest file on the remote machine.
* ModulePath: The module_paths, combined into one path variable.
* ModulePathJoiner: A colon `:` on posix systems and a semicolon `;` on
Windows.
* PuppetBinDir: The directory that the Puppet binary is in.
* Sudo: Returns false when PreventSudo is set, and true when it is not.
* WorkingDir: The value provided in the `working_directory` option.
See below for `execute_command`'s default value.
- `extra_arguments` (array of strings) - Additional options to pass to the
Puppet command. This allows for customization of
@ -119,7 +134,10 @@ 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.html) provisioner for the full
details.
details. This is a [template engine](/docs/templates/engine.html).
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.
<%= partial "partials/provisioners/common-config" %>

25
website/source/docs/provisioners/puppet-server.html.md.erb
View File

@ -50,9 +50,23 @@ listed below:
that contains the client private key for the node. This defaults to
nothing, in which case a client private key won't be uploaded.
- `execute_command` (string) - The command-line to execute Puppet. This also
has various [configuration template variables](/docs/templates/engine.html)
available.
- `execute_command` (string) - The command-line to execute Puppet. This is a
[template engine](/docs/templates/engine.html). 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
`client_cert_path`.
* ClientPrivateKeyPath: The value set in the template option
`client_private_key_path`.
* FacterVars: Additional facts to set when executing Puppet, joined for
use in a command. This is internal and not settable by the user.
* PuppetNode: The hostname of the Puppet node, set in `puppet_node`.
* PuppetServer: The hostname of the Puppet server, set in `puppet_server`
* PuppetBinDir: The directory that the Puppet binary is in.
* Sudo: Returns false when PreventSudo is set, and true when it is not.
* WorkingDir: The value provided in the `working_directory` option.
See below for `execute_command`'s default value.
- `extra_arguments` (array of strings) - Additional options to pass to the
Puppet command. This allows for customization of `execute_command` without
@ -104,7 +118,10 @@ 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.html) provisioner for the full
details.
details. This is a [template engine](/docs/templates/engine.html).
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.
<%= partial "partials/provisioners/common-config" %>

6
website/source/docs/provisioners/shell.html.md.erb
View File

@ -58,9 +58,9 @@ The example below is fully functional.
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}}`.
The value of this is treated as a [configuration
template](/docs/templates/engine.html). There are three available
variables:
This is a [template engine](/docs/templates/engine.html). Therefore, you may
use user variables and template functions in this field. In addition, there
are three available extra variables:
- `Path` is the path to the script to run
- `Vars` is the list of `environment_vars`, if configured.
- `EnvVarFile` is the path to the file containing env vars, if

9
website/source/docs/provisioners/windows-shell.html.md.erb
View File

@ -36,9 +36,12 @@ The example below is fully functional.
- `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.html). There are two available
variables: `Path`, which is the path to the script to run, and `Vars`,
which is the list of `environment_vars`, if configured.
[template engine](/docs/templates/engine.html). This is a
[template engine](/docs/templates/engine.html). Therefore, you may
use user variables and template functions in this field. In addition, there
are two available extra variables:
- `Path` is the path to the script to run
- `Vars` is the list of `environment_vars`, if configured.
- `remote_path` (string) - The path where the script will be uploaded to in
the machine. This defaults to "c:/Windows/Temp/script.bat". This value must

6
website/source/partials/builder/amazon/common/_AMIConfig-not-required.html.md
View File

@ -1,9 +1,9 @@
<!-- Code generated from the comments of the AMIConfig struct in builder/amazon/common/ami_config.go; DO NOT EDIT MANUALLY -->
- `ami_description` (string) - The description to set for the resulting
AMI(s). By default this description is empty. This is a template
engine, see Build template
data for more information.
AMI(s). By default this description is empty. This is a
[template engine](/docs/templates/engine.html), see [Build template
data](#build-template-data) for more information.
- `ami_virtualization_type` (string) - The type of virtualization for the AMI
you are building. This option is required to register HVM images. Can be

2
website/source/partials/builder/cloudstack/_Config-not-required.html.md
View File

@ -72,7 +72,7 @@
provisioners should connect to the local IP address of the instance.
- `user_data` (string) - User data to launch with the instance. This is a
template engine see User Data bellow for
template 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.

18
website/source/partials/builder/hyperone/_Config-not-required.html.md
View File

@ -47,11 +47,23 @@
- `chroot_mount_path` (string) - Chroot Mount Path
- `chroot_mounts` ([][]string) - Chroot Mounts
- `chroot_copy_files` ([]string) - Chroot Copy Files
- `chroot_command_wrapper` (string) - Chroot Command Wrapper
- `chroot_command_wrapper` (string) - How to run shell commands. This defaults to {{.Command}}. This may be
useful to set if you want to set environmental variables or perhaps run
it with sudo or so on. This is a configuration template where the
.Command variable is replaced with the command to be run. Defaults to
{{.Command}}.
- `mount_options` ([]string) - Mount Options
- `mount_partition` (string) - Mount Partition
- `pre_mount_commands` ([]string) - Pre Mount Commands
- `post_mount_commands` ([]string) - Post Mount Commands
- `pre_mount_commands` ([]string) - A series of commands to execute after attaching the root volume and
before mounting the chroot. This is not required unless using
from_scratch. If so, this should include any partitioning and filesystem
creation commands. The path to the device is provided by {{.Device}}.
- `post_mount_commands` ([]string) - As pre_mount_commands, but the commands are executed after mounting the
root device and before the extra mount and copy steps. The device and
mount path are provided by {{.Device}} and {{.MountPath}}.
- `ssh_keys` ([]string) - List of SSH keys by name or id to be added
to the server on launch.

2
website/source/partials/builder/lxc/_Config-not-required.html.md
View File

@ -9,7 +9,7 @@
- `command_wrapper` (string) - Allows you to specify a wrapper command, such
as ssh so you can execute packer builds on a remote host. Defaults to
Empty.
`{{.Command}}`; i.e. no wrapper.
- `init_timeout` (duration string | ex: "1h5m2s") - The timeout in seconds to wait for the the
container to start. Defaults to 20 seconds.

3
website/source/partials/builder/lxd/_Config-not-required.html.md
View File

@ -5,7 +5,8 @@
- `container_name` (string) - Container Name
- `command_wrapper` (string) - Lets you prefix all builder commands, such as
with ssh for a remote build host. Defaults to "".
with ssh for a remote build host. Defaults to "{{.Command}}"; i.e. no
wrapper.
- `profile` (string) - Profile
- `init_sleep` (string) - The number of seconds to sleep between launching

4
website/source/partials/builder/qemu/_Config-not-required.html.md
View File

@ -179,6 +179,10 @@
`qemuargs` to map to WinRM's default port of `5985` or whatever value
you have the service set to listen on.
This is a template engine and allows access to the following variables:
`{{ .HTTPIP }}`, `{{ .HTTPPort }}`, `{{ .HTTPDir }}`,
`{{ .OutputDir }}`, `{{ .Name }}`, and `{{ .SSHHostPort }}`
- `qemu_binary` (string) - The name of the Qemu binary to look for. This
defaults to qemu-system-x86_64, but may need to be changed for
some platforms. For example qemu-kvm, or qemu-system-i386 may be a

7
website/source/partials/builder/virtualbox/iso/_Config-not-required.html.md
View File

@ -14,8 +14,8 @@
- `guest_additions_path` (string) - The path on the guest virtual machine 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 where the Version variable is
replaced with the VirtualBox version.
the user. This is a configuration template where the `{{ .Version }}`
variable is replaced with the VirtualBox version.
- `guest_additions_sha256` (string) - The SHA256 checksum of the guest additions ISO that will be uploaded to
the guest VM. By default the checksums will be downloaded from the
@ -26,7 +26,8 @@
URL if the ISO is at a local path. By default, the VirtualBox builder
will attempt to find the guest additions ISO on the local file system.
If it is not available locally, the builder will download the proper
guest additions ISO from the internet.
guest additions ISO from the internet. This is a template engine, and you
have access to the variable `{{ .Version }}`.
- `guest_additions_interface` (string) - The interface type to use to mount guest additions when
guest_additions_mode is set to attach. Will default to the value set in

7
website/source/partials/builder/vmware/iso/_Config-not-required.html.md
View File

@ -74,8 +74,11 @@
- `vmx_disk_template_path` (string) - VMX Disk Template Path
- `vmx_template_path` (string) - Path to a [configuration template](/docs/templates/engine.html) that
defines the contents of the virtual machine VMX file for VMware. This is
for **advanced users only** as this can render the virtual machine
defines the contents of the virtual machine VMX file for VMware. The
engine has access to the template variables `{{ .DiskNumber }}` and
`{{ .DiskName }}`.
This is for **advanced users only** as this can render the virtual machine
non-functional. See below for more information. For basic VMX
modifications, try `vmx_data` first.

2
website/source/partials/common/bootcommand/_BootConfig.html.md
View File

@ -65,7 +65,7 @@ command, they will be replaced by the proper key:
`http_directory` configuration parameter. If `http_directory` isn't
specified, these will be blank!
- `Name` - The name of the VM.
- `{{ .Name }}` - The name of the VM.
Example boot command. This is actually a working boot command used to start an
CentOS 6.4 installer: