website: update docs to link to communicator
This commit is contained in:
parent
4244a6ce8d
commit
3cc90768a2
|
@ -51,6 +51,10 @@ There are many configuration options available for the builder. They are
|
||||||
segmented below into two categories: required and optional parameters. Within
|
segmented below into two categories: required and optional parameters. Within
|
||||||
each category, the available configuration keys are alphabetized.
|
each category, the available configuration keys are alphabetized.
|
||||||
|
|
||||||
|
In addition to the options listed here, a
|
||||||
|
[communicator](/docs/templates/communicator.html)
|
||||||
|
can be configured for this builder.
|
||||||
|
|
||||||
### Required:
|
### Required:
|
||||||
|
|
||||||
* `access_key` (string) - The access key used to communicate with AWS.
|
* `access_key` (string) - The access key used to communicate with AWS.
|
||||||
|
|
|
@ -31,6 +31,10 @@ There are many configuration options available for the builder. They are
|
||||||
segmented below into two categories: required and optional parameters. Within
|
segmented below into two categories: required and optional parameters. Within
|
||||||
each category, the available configuration keys are alphabetized.
|
each category, the available configuration keys are alphabetized.
|
||||||
|
|
||||||
|
In addition to the options listed here, a
|
||||||
|
[communicator](/docs/templates/communicator.html)
|
||||||
|
can be configured for this builder.
|
||||||
|
|
||||||
### Required:
|
### Required:
|
||||||
|
|
||||||
* `access_key` (string) - The access key used to communicate with AWS.
|
* `access_key` (string) - The access key used to communicate with AWS.
|
||||||
|
@ -154,20 +158,9 @@ AMI if one with the same name already exists. Default `false`.
|
||||||
generate a temporary keypair. `ssh_private_key_file` must be specified
|
generate a temporary keypair. `ssh_private_key_file` must be specified
|
||||||
with this.
|
with this.
|
||||||
|
|
||||||
* `ssh_port` (integer) - The port that SSH will be available on. This defaults
|
|
||||||
to port 22.
|
|
||||||
|
|
||||||
* `ssh_private_key_file` (string) - Use this ssh private key file instead of
|
|
||||||
a generated ssh key pair for connecting to the instance. This key file must
|
|
||||||
already exist on the `source_ami`
|
|
||||||
|
|
||||||
* `ssh_private_ip` (bool) - If true, then SSH will always use the private
|
* `ssh_private_ip` (bool) - If true, then SSH will always use the private
|
||||||
IP if available.
|
IP if available.
|
||||||
|
|
||||||
* `ssh_timeout` (string) - The time to wait for SSH to become available
|
|
||||||
before timing out. The format of this value is a duration such as "5s"
|
|
||||||
or "5m". The default SSH timeout is "5m", or five minutes.
|
|
||||||
|
|
||||||
* `subnet_id` (string) - If using VPC, the ID of the subnet, such as
|
* `subnet_id` (string) - If using VPC, the ID of the subnet, such as
|
||||||
"subnet-12345def", where Packer will launch the EC2 instance. This field is
|
"subnet-12345def", where Packer will launch the EC2 instance. This field is
|
||||||
required if you are using an non-default VPC.
|
required if you are using an non-default VPC.
|
||||||
|
|
|
@ -36,6 +36,10 @@ There are many configuration options available for the builder. They are
|
||||||
segmented below into two categories: required and optional parameters. Within
|
segmented below into two categories: required and optional parameters. Within
|
||||||
each category, the available configuration keys are alphabetized.
|
each category, the available configuration keys are alphabetized.
|
||||||
|
|
||||||
|
In addition to the options listed here, a
|
||||||
|
[communicator](/docs/templates/communicator.html)
|
||||||
|
can be configured for this builder.
|
||||||
|
|
||||||
### Required:
|
### Required:
|
||||||
|
|
||||||
* `access_key` (string) - The access key used to communicate with AWS.
|
* `access_key` (string) - The access key used to communicate with AWS.
|
||||||
|
@ -193,20 +197,9 @@ AMI if one with the same name already exists. Default `false`.
|
||||||
generate a temporary keypair. `ssh_private_key_file` must be specified
|
generate a temporary keypair. `ssh_private_key_file` must be specified
|
||||||
with this.
|
with this.
|
||||||
|
|
||||||
* `ssh_port` (integer) - The port that SSH will be available on. This defaults
|
|
||||||
to port 22.
|
|
||||||
|
|
||||||
* `ssh_private_key_file` (string) - Use this ssh private key file instead of
|
|
||||||
a generated ssh key pair for connecting to the instance. This key file must
|
|
||||||
already exist on the `source_ami`
|
|
||||||
|
|
||||||
* `ssh_private_ip` (bool) - If true, then SSH will always use the private
|
* `ssh_private_ip` (bool) - If true, then SSH will always use the private
|
||||||
IP if available.
|
IP if available.
|
||||||
|
|
||||||
* `ssh_timeout` (string) - The time to wait for SSH to become available
|
|
||||||
before timing out. The format of this value is a duration such as "5s"
|
|
||||||
or "5m". The default SSH timeout is "5m", or five minutes.
|
|
||||||
|
|
||||||
* `subnet_id` (string) - If using VPC, the ID of the subnet, such as
|
* `subnet_id` (string) - If using VPC, the ID of the subnet, such as
|
||||||
"subnet-12345def", where Packer will launch the EC2 instance. This field is
|
"subnet-12345def", where Packer will launch the EC2 instance. This field is
|
||||||
required if you are using an non-default VPC.
|
required if you are using an non-default VPC.
|
||||||
|
|
|
@ -24,6 +24,10 @@ There are many configuration options available for the builder. They are
|
||||||
segmented below into two categories: required and optional parameters. Within
|
segmented below into two categories: required and optional parameters. Within
|
||||||
each category, the available configuration keys are alphabetized.
|
each category, the available configuration keys are alphabetized.
|
||||||
|
|
||||||
|
In addition to the options listed here, a
|
||||||
|
[communicator](/docs/templates/communicator.html)
|
||||||
|
can be configured for this builder.
|
||||||
|
|
||||||
### Required:
|
### Required:
|
||||||
|
|
||||||
* `api_token` (string) - The client TOKEN to use to access your account.
|
* `api_token` (string) - The client TOKEN to use to access your account.
|
||||||
|
@ -53,16 +57,6 @@ each category, the available configuration keys are alphabetized.
|
||||||
To help make this unique, use a function like `timestamp` (see
|
To help make this unique, use a function like `timestamp` (see
|
||||||
[configuration templates](/docs/templates/configuration-templates.html) for more info)
|
[configuration templates](/docs/templates/configuration-templates.html) for more info)
|
||||||
|
|
||||||
* `ssh_port` (integer) - The port that SSH will be available on. Defaults to port
|
|
||||||
22.
|
|
||||||
|
|
||||||
* `ssh_timeout` (string) - The time to wait for SSH to become available
|
|
||||||
before timing out. The format of this value is a duration such as "5s"
|
|
||||||
or "5m". The default SSH timeout is "1m".
|
|
||||||
|
|
||||||
* `ssh_username` (string) - The username to use in order to communicate
|
|
||||||
over SSH to the running droplet. Default is "root".
|
|
||||||
|
|
||||||
* `state_timeout` (string) - The time to wait, as a duration string,
|
* `state_timeout` (string) - The time to wait, as a duration string,
|
||||||
for a droplet to enter a desired state (such as "active") before
|
for a droplet to enter a desired state (such as "active") before
|
||||||
timing out. The default state timeout is "6m".
|
timing out. The default state timeout is "6m".
|
||||||
|
|
|
@ -62,6 +62,10 @@ Configuration options are organized below into two categories: required and
|
||||||
optional. Within each category, the available options are alphabetized and
|
optional. Within each category, the available options are alphabetized and
|
||||||
described.
|
described.
|
||||||
|
|
||||||
|
In addition to the options listed here, a
|
||||||
|
[communicator](/docs/templates/communicator.html)
|
||||||
|
can be configured for this builder.
|
||||||
|
|
||||||
### Required:
|
### Required:
|
||||||
|
|
||||||
* `commit` (boolean) - If true, the container will be committed to an
|
* `commit` (boolean) - If true, the container will be committed to an
|
||||||
|
|
|
@ -85,6 +85,10 @@ existing GCE image. The account file is obtained in the previous section.
|
||||||
Configuration options are organized below into two categories: required and optional. Within
|
Configuration options are organized below into two categories: required and optional. Within
|
||||||
each category, the available options are alphabetized and described.
|
each category, the available options are alphabetized and described.
|
||||||
|
|
||||||
|
In addition to the options listed here, a
|
||||||
|
[communicator](/docs/templates/communicator.html)
|
||||||
|
can be configured for this builder.
|
||||||
|
|
||||||
### Required:
|
### Required:
|
||||||
|
|
||||||
* `project_id` (string) - The project ID that will be used to launch instances
|
* `project_id` (string) - The project ID that will be used to launch instances
|
||||||
|
@ -120,13 +124,6 @@ each category, the available options are alphabetized and described.
|
||||||
* `network` (string) - The Google Compute network to use for the launched
|
* `network` (string) - The Google Compute network to use for the launched
|
||||||
instance. Defaults to `"default"`.
|
instance. Defaults to `"default"`.
|
||||||
|
|
||||||
* `ssh_port` (integer) - The SSH port. Defaults to `22`.
|
|
||||||
|
|
||||||
* `ssh_timeout` (string) - The time to wait for SSH to become available.
|
|
||||||
Defaults to `"1m"`.
|
|
||||||
|
|
||||||
* `ssh_username` (string) - The SSH username. Defaults to `"root"`.
|
|
||||||
|
|
||||||
* `state_timeout` (string) - The time to wait for instance state changes.
|
* `state_timeout` (string) - The time to wait for instance state changes.
|
||||||
Defaults to `"5m"`.
|
Defaults to `"5m"`.
|
||||||
|
|
||||||
|
|
|
@ -29,23 +29,6 @@ no provisioners are defined, but it will connect to the specified host via ssh.
|
||||||
|
|
||||||
## Configuration Reference
|
## Configuration Reference
|
||||||
|
|
||||||
Configuration options are organized into two categories: required and
|
The null builder has no configuration parameters other than the
|
||||||
optional. Within each category, the available options are alphabetized and
|
[communicator](/docs/templates/communicator.html) settings.
|
||||||
described.
|
|
||||||
|
|
||||||
### Required:
|
|
||||||
|
|
||||||
* `host` (string) - The hostname or IP address to connect to.
|
|
||||||
|
|
||||||
* `ssh_password` (string) - The password to be used for the ssh connection.
|
|
||||||
Cannot be combined with ssh_private_key_file.
|
|
||||||
|
|
||||||
* `ssh_private_key_file` (string) - The filename of the ssh private key to be
|
|
||||||
used for the ssh connection. E.g. /home/user/.ssh/identity_rsa.
|
|
||||||
|
|
||||||
* `ssh_username` (string) - The username to be used for the ssh connection.
|
|
||||||
|
|
||||||
### Optional:
|
|
||||||
|
|
||||||
* `port` (integer) - ssh port to connect to, defaults to 22.
|
|
||||||
|
|
||||||
|
|
|
@ -27,6 +27,10 @@ There are many configuration options available for the builder. They are
|
||||||
segmented below into two categories: required and optional parameters. Within
|
segmented below into two categories: required and optional parameters. Within
|
||||||
each category, the available configuration keys are alphabetized.
|
each category, the available configuration keys are alphabetized.
|
||||||
|
|
||||||
|
In addition to the options listed here, a
|
||||||
|
[communicator](/docs/templates/communicator.html)
|
||||||
|
can be configured for this builder.
|
||||||
|
|
||||||
### Required:
|
### Required:
|
||||||
|
|
||||||
* `flavor` (string) - The ID, name, or full URL for the desired flavor for the
|
* `flavor` (string) - The ID, name, or full URL for the desired flavor for the
|
||||||
|
@ -82,16 +86,6 @@ each category, the available configuration keys are alphabetized.
|
||||||
If not specified, Packer will use the environment variable
|
If not specified, Packer will use the environment variable
|
||||||
`OS_REGION_NAME`, if set.
|
`OS_REGION_NAME`, if set.
|
||||||
|
|
||||||
* `ssh_port` (integer) - The port that SSH will be available on. Defaults to port
|
|
||||||
22.
|
|
||||||
|
|
||||||
* `ssh_timeout` (string) - The time to wait for SSH to become available
|
|
||||||
before timing out. The format of this value is a duration such as "5s"
|
|
||||||
or "1m". The default SSH timeout is "5m".
|
|
||||||
|
|
||||||
* `ssh_username` (string) - The username to use in order to communicate
|
|
||||||
over SSH to the running server. The default is "root".
|
|
||||||
|
|
||||||
* `ssh_interface` (string) - The type of interface to connect via SSH. Values
|
* `ssh_interface` (string) - The type of interface to connect via SSH. Values
|
||||||
useful for Rackspace are "public" or "private", and the default behavior is
|
useful for Rackspace are "public" or "private", and the default behavior is
|
||||||
to connect via whichever is returned first from the OpenStack API.
|
to connect via whichever is returned first from the OpenStack API.
|
||||||
|
|
|
@ -50,6 +50,10 @@ There are many configuration options available for the Parallels builder.
|
||||||
They are organized below into two categories: required and optional. Within
|
They are organized below into two categories: required and optional. Within
|
||||||
each category, the available options are alphabetized and described.
|
each category, the available options are alphabetized and described.
|
||||||
|
|
||||||
|
In addition to the options listed here, a
|
||||||
|
[communicator](/docs/templates/communicator.html)
|
||||||
|
can be configured for this builder.
|
||||||
|
|
||||||
### Required:
|
### Required:
|
||||||
|
|
||||||
* `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO
|
* `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO
|
||||||
|
@ -190,21 +194,6 @@ each category, the available options are alphabetized and described.
|
||||||
If it doesn't shut down in this time, it is an error. By default, the timeout
|
If it doesn't shut down in this time, it is an error. By default, the timeout
|
||||||
is "5m", or five minutes.
|
is "5m", or five minutes.
|
||||||
|
|
||||||
* `ssh_key_path` (string) - Path to a private key to use for authenticating
|
|
||||||
with SSH. By default this is not set (key-based auth won't be used).
|
|
||||||
The associated public key is expected to already be configured on the
|
|
||||||
VM being prepared by some other process (kickstart, etc.).
|
|
||||||
|
|
||||||
* `ssh_password` (string) - The password for `ssh_username` to use to
|
|
||||||
authenticate with SSH. By default this is the empty string.
|
|
||||||
|
|
||||||
* `ssh_port` (integer) - The port that SSH will be listening on in the guest
|
|
||||||
virtual machine. By default this is 22.
|
|
||||||
|
|
||||||
* `ssh_wait_timeout` (string) - The duration to wait for SSH to become
|
|
||||||
available. By default this is "20m", or 20 minutes. Note that this should
|
|
||||||
be quite long since the timer begins as soon as the virtual machine is booted.
|
|
||||||
|
|
||||||
* `vm_name` (string) - This is the name of the PVM directory for the new
|
* `vm_name` (string) - This is the name of the PVM directory for the new
|
||||||
virtual machine, without the file extension. By default this is
|
virtual machine, without the file extension. By default this is
|
||||||
"packer-BUILDNAME", where "BUILDNAME" is the name of the build.
|
"packer-BUILDNAME", where "BUILDNAME" is the name of the build.
|
||||||
|
|
|
@ -46,6 +46,10 @@ There are many configuration options available for the Parallels builder.
|
||||||
They are organized below into two categories: required and optional. Within
|
They are organized below into two categories: required and optional. Within
|
||||||
each category, the available options are alphabetized and described.
|
each category, the available options are alphabetized and described.
|
||||||
|
|
||||||
|
In addition to the options listed here, a
|
||||||
|
[communicator](/docs/templates/communicator.html)
|
||||||
|
can be configured for this builder.
|
||||||
|
|
||||||
### Required:
|
### Required:
|
||||||
|
|
||||||
* `source_path` (string) - The path to a PVM directory that acts as
|
* `source_path` (string) - The path to a PVM directory that acts as
|
||||||
|
@ -133,21 +137,6 @@ each category, the available options are alphabetized and described.
|
||||||
If it doesn't shut down in this time, it is an error. By default, the timeout
|
If it doesn't shut down in this time, it is an error. By default, the timeout
|
||||||
is "5m", or five minutes.
|
is "5m", or five minutes.
|
||||||
|
|
||||||
* `ssh_key_path` (string) - Path to a private key to use for authenticating
|
|
||||||
with SSH. By default this is not set (key-based auth won't be used).
|
|
||||||
The associated public key is expected to already be configured on the
|
|
||||||
VM being prepared by some other process (kickstart, etc.).
|
|
||||||
|
|
||||||
* `ssh_password` (string) - The password for `ssh_username` to use to
|
|
||||||
authenticate with SSH. By default this is the empty string.
|
|
||||||
|
|
||||||
* `ssh_port` (integer) - The port that SSH will be listening on in the guest
|
|
||||||
virtual machine. By default this is 22.
|
|
||||||
|
|
||||||
* `ssh_wait_timeout` (string) - The duration to wait for SSH to become
|
|
||||||
available. By default this is "20m", or 20 minutes. Note that this should
|
|
||||||
be quite long since the timer begins as soon as the virtual machine is booted.
|
|
||||||
|
|
||||||
* `vm_name` (string) - This is the name of the virtual machine when it is
|
* `vm_name` (string) - This is the name of the virtual machine when it is
|
||||||
imported as well as the name of the PVM directory when the virtual machine is
|
imported as well as the name of the PVM directory when the virtual machine is
|
||||||
exported. By default this is "packer-BUILDNAME", where "BUILDNAME" is
|
exported. By default this is "packer-BUILDNAME", where "BUILDNAME" is
|
||||||
|
|
|
@ -73,6 +73,10 @@ There are many configuration options available for the Qemu builder.
|
||||||
They are organized below into two categories: required and optional. Within
|
They are organized below into two categories: required and optional. Within
|
||||||
each category, the available options are alphabetized and described.
|
each category, the available options are alphabetized and described.
|
||||||
|
|
||||||
|
In addition to the options listed here, a
|
||||||
|
[communicator](/docs/templates/communicator.html)
|
||||||
|
can be configured for this builder.
|
||||||
|
|
||||||
### Required:
|
### Required:
|
||||||
|
|
||||||
* `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO
|
* `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO
|
||||||
|
@ -241,23 +245,6 @@ qemu-system-x86 command. The arguments are all printed for review.
|
||||||
Packer will choose a randomly available port in this range to use as the
|
Packer will choose a randomly available port in this range to use as the
|
||||||
host port.
|
host port.
|
||||||
|
|
||||||
* `ssh_key_path` (string) - Path to a private key to use for authenticating
|
|
||||||
with SSH. By default this is not set (key-based auth won't be used).
|
|
||||||
The associated public key is expected to already be configured on the
|
|
||||||
VM being prepared by some other process (kickstart, etc.).
|
|
||||||
|
|
||||||
* `ssh_password` (string) - The password for `ssh_username` to use to
|
|
||||||
authenticate with SSH. By default this is the empty string.
|
|
||||||
|
|
||||||
* `ssh_port` (integer) - The port that SSH will be listening on in the guest
|
|
||||||
virtual machine. By default this is 22. The Qemu builder will map, via
|
|
||||||
port forward, a port on the host machine to the port listed here so
|
|
||||||
machines outside the installing VM can access the VM.
|
|
||||||
|
|
||||||
* `ssh_wait_timeout` (string) - The duration to wait for SSH to become
|
|
||||||
available. By default this is "20m", or 20 minutes. Note that this should
|
|
||||||
be quite long since the timer begins as soon as the virtual machine is booted.
|
|
||||||
|
|
||||||
* `vm_name` (string) - This is the name of the image (QCOW2 or IMG) file for
|
* `vm_name` (string) - This is the name of the image (QCOW2 or IMG) file for
|
||||||
the new virtual machine, without the file extension. By default this is
|
the new virtual machine, without the file extension. By default this is
|
||||||
"packer-BUILDNAME", where "BUILDNAME" is the name of the build.
|
"packer-BUILDNAME", where "BUILDNAME" is the name of the build.
|
||||||
|
|
|
@ -48,6 +48,10 @@ There are many configuration options available for the VirtualBox builder.
|
||||||
They are organized below into two categories: required and optional. Within
|
They are organized below into two categories: required and optional. Within
|
||||||
each category, the available options are alphabetized and described.
|
each category, the available options are alphabetized and described.
|
||||||
|
|
||||||
|
In addition to the options listed here, a
|
||||||
|
[communicator](/docs/templates/communicator.html)
|
||||||
|
can be configured for this builder.
|
||||||
|
|
||||||
### Required:
|
### Required:
|
||||||
|
|
||||||
* `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO
|
* `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO
|
||||||
|
@ -196,21 +200,6 @@ each category, the available options are alphabetized and described.
|
||||||
Packer will choose a randomly available port in this range to use as the
|
Packer will choose a randomly available port in this range to use as the
|
||||||
host port.
|
host port.
|
||||||
|
|
||||||
* `ssh_key_path` (string) - Path to a private key to use for authenticating
|
|
||||||
with SSH. By default this is not set (key-based auth won't be used).
|
|
||||||
The associated public key is expected to already be configured on the
|
|
||||||
VM being prepared by some other process (kickstart, etc.).
|
|
||||||
|
|
||||||
* `ssh_password` (string) - The password for `ssh_username` to use to
|
|
||||||
authenticate with SSH. By default this is the empty string.
|
|
||||||
|
|
||||||
* `ssh_port` (integer) - The port that SSH will be listening on in the guest
|
|
||||||
virtual machine. By default this is 22.
|
|
||||||
|
|
||||||
* `ssh_wait_timeout` (string) - The duration to wait for SSH to become
|
|
||||||
available. By default this is "20m", or 20 minutes. Note that this should
|
|
||||||
be quite long since the timer begins as soon as the virtual machine is booted.
|
|
||||||
|
|
||||||
* `ssh_skip_nat_mapping` (bool) - Defaults to false. When enabled, Packer does
|
* `ssh_skip_nat_mapping` (bool) - Defaults to false. When enabled, Packer does
|
||||||
not setup forwarded port mapping for SSH requests and uses `ssh_port` on the
|
not setup forwarded port mapping for SSH requests and uses `ssh_port` on the
|
||||||
host to communicate to the virtual machine
|
host to communicate to the virtual machine
|
||||||
|
|
|
@ -54,6 +54,10 @@ There are many configuration options available for the VirtualBox builder.
|
||||||
They are organized below into two categories: required and optional. Within
|
They are organized below into two categories: required and optional. Within
|
||||||
each category, the available options are alphabetized and described.
|
each category, the available options are alphabetized and described.
|
||||||
|
|
||||||
|
In addition to the options listed here, a
|
||||||
|
[communicator](/docs/templates/communicator.html)
|
||||||
|
can be configured for this builder.
|
||||||
|
|
||||||
### Required:
|
### Required:
|
||||||
|
|
||||||
* `source_path` (string) - The path to an OVF or OVA file that acts as
|
* `source_path` (string) - The path to an OVF or OVA file that acts as
|
||||||
|
@ -171,21 +175,6 @@ each category, the available options are alphabetized and described.
|
||||||
Packer will choose a randomly available port in this range to use as the
|
Packer will choose a randomly available port in this range to use as the
|
||||||
host port.
|
host port.
|
||||||
|
|
||||||
* `ssh_key_path` (string) - Path to a private key to use for authenticating
|
|
||||||
with SSH. By default this is not set (key-based auth won't be used).
|
|
||||||
The associated public key is expected to already be configured on the
|
|
||||||
VM being prepared by some other process (kickstart, etc.).
|
|
||||||
|
|
||||||
* `ssh_password` (string) - The password for `ssh_username` to use to
|
|
||||||
authenticate with SSH. By default this is the empty string.
|
|
||||||
|
|
||||||
* `ssh_port` (integer) - The port that SSH will be listening on in the guest
|
|
||||||
virtual machine. By default this is 22.
|
|
||||||
|
|
||||||
* `ssh_wait_timeout` (string) - The duration to wait for SSH to become
|
|
||||||
available. By default this is "20m", or 20 minutes. Note that this should
|
|
||||||
be quite long since the timer begins as soon as the virtual machine is booted.
|
|
||||||
|
|
||||||
* `ssh_skip_nat_mapping` (bool) - Defaults to false. When enabled, Packer does
|
* `ssh_skip_nat_mapping` (bool) - Defaults to false. When enabled, Packer does
|
||||||
not setup forwarded port mapping for SSH requests and uses `ssh_port` on the
|
not setup forwarded port mapping for SSH requests and uses `ssh_port` on the
|
||||||
host to communicate to the virtual machine
|
host to communicate to the virtual machine
|
||||||
|
|
|
@ -49,6 +49,10 @@ There are many configuration options available for the VMware builder.
|
||||||
They are organized below into two categories: required and optional. Within
|
They are organized below into two categories: required and optional. Within
|
||||||
each category, the available options are alphabetized and described.
|
each category, the available options are alphabetized and described.
|
||||||
|
|
||||||
|
In addition to the options listed here, a
|
||||||
|
[communicator](/docs/templates/communicator.html)
|
||||||
|
can be configured for this builder.
|
||||||
|
|
||||||
### Required:
|
### Required:
|
||||||
|
|
||||||
* `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO
|
* `iso_checksum` (string) - The checksum for the OS ISO file. Because ISO
|
||||||
|
@ -201,28 +205,6 @@ each category, the available options are alphabetized and described.
|
||||||
slightly larger. If you find this to be the case, you can disable compaction
|
slightly larger. If you find this to be the case, you can disable compaction
|
||||||
using this configuration value.
|
using this configuration value.
|
||||||
|
|
||||||
* `ssh_host` (string) - Hostname or IP address of the host. By default, DHCP
|
|
||||||
is used to connect to the host and this field is not used.
|
|
||||||
|
|
||||||
* `ssh_key_path` (string) - Path to a private key to use for authenticating
|
|
||||||
with SSH. By default this is not set (key-based auth won't be used).
|
|
||||||
The associated public key is expected to already be configured on the
|
|
||||||
VM being prepared by some other process (kickstart, etc.).
|
|
||||||
|
|
||||||
* `ssh_password` (string) - The password for `ssh_username` to use to
|
|
||||||
authenticate with SSH. By default this is the empty string.
|
|
||||||
|
|
||||||
* `ssh_port` (integer) - The port that SSH will listen on within the virtual
|
|
||||||
machine. By default this is 22.
|
|
||||||
|
|
||||||
* `ssh_skip_request_pty` (boolean) - If true, a pty will not be requested as
|
|
||||||
part of the SSH connection. By default, this is "false", so a pty
|
|
||||||
_will_ be requested.
|
|
||||||
|
|
||||||
* `ssh_wait_timeout` (string) - The duration to wait for SSH to become
|
|
||||||
available. By default this is "20m", or 20 minutes. Note that this should
|
|
||||||
be quite long since the timer begins as soon as the virtual machine is booted.
|
|
||||||
|
|
||||||
* `tools_upload_flavor` (string) - The flavor of the VMware Tools ISO to
|
* `tools_upload_flavor` (string) - The flavor of the VMware Tools ISO to
|
||||||
upload into the VM. Valid values are "darwin", "linux", and "windows".
|
upload into the VM. Valid values are "darwin", "linux", and "windows".
|
||||||
By default, this is empty, which means VMware tools won't be uploaded.
|
By default, this is empty, which means VMware tools won't be uploaded.
|
||||||
|
|
|
@ -44,6 +44,10 @@ There are many configuration options available for the VMware builder.
|
||||||
They are organized below into two categories: required and optional. Within
|
They are organized below into two categories: required and optional. Within
|
||||||
each category, the available options are alphabetized and described.
|
each category, the available options are alphabetized and described.
|
||||||
|
|
||||||
|
In addition to the options listed here, a
|
||||||
|
[communicator](/docs/templates/communicator.html)
|
||||||
|
can be configured for this builder.
|
||||||
|
|
||||||
### Required:
|
### Required:
|
||||||
|
|
||||||
* `source_path` (string) - Path to the source VMX file to clone.
|
* `source_path` (string) - Path to the source VMX file to clone.
|
||||||
|
@ -126,25 +130,6 @@ each category, the available options are alphabetized and described.
|
||||||
slightly larger. If you find this to be the case, you can disable compaction
|
slightly larger. If you find this to be the case, you can disable compaction
|
||||||
using this configuration value.
|
using this configuration value.
|
||||||
|
|
||||||
* `ssh_key_path` (string) - Path to a private key to use for authenticating
|
|
||||||
with SSH. By default this is not set (key-based auth won't be used).
|
|
||||||
The associated public key is expected to already be configured on the
|
|
||||||
VM being prepared by some other process (kickstart, etc.).
|
|
||||||
|
|
||||||
* `ssh_password` (string) - The password for `ssh_username` to use to
|
|
||||||
authenticate with SSH. By default this is the empty string.
|
|
||||||
|
|
||||||
* `ssh_port` (integer) - The port that SSH will listen on within the virtual
|
|
||||||
machine. By default this is 22.
|
|
||||||
|
|
||||||
* `ssh_skip_request_pty` (boolean) - If true, a pty will not be requested as
|
|
||||||
part of the SSH connection. By default, this is "false", so a pty
|
|
||||||
_will_ be requested.
|
|
||||||
|
|
||||||
* `ssh_wait_timeout` (string) - The duration to wait for SSH to become
|
|
||||||
available. By default this is "20m", or 20 minutes. Note that this should
|
|
||||||
be quite long since the timer begins as soon as the virtual machine is booted.
|
|
||||||
|
|
||||||
* `vm_name` (string) - This is the name of the VMX file for the new virtual
|
* `vm_name` (string) - This is the name of the VMX file for the new virtual
|
||||||
machine, without the file extension. By default this is "packer-BUILDNAME",
|
machine, without the file extension. By default this is "packer-BUILDNAME",
|
||||||
where "BUILDNAME" is the name of the build.
|
where "BUILDNAME" is the name of the build.
|
||||||
|
|
Loading…
Reference in New Issue