From 3cc90768a2509a2046aaba1b646fa6d3c814048e Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Tue, 23 Jun 2015 14:44:57 -0700 Subject: [PATCH] website: update docs to link to communicator --- .../docs/builders/amazon-chroot.html.markdown | 4 +++ .../docs/builders/amazon-ebs.html.markdown | 19 +++++--------- .../builders/amazon-instance.html.markdown | 15 +++-------- .../docs/builders/digitalocean.html.markdown | 14 +++------- .../source/docs/builders/docker.html.markdown | 4 +++ .../docs/builders/googlecompute.markdown | 15 +++++------ .../source/docs/builders/null.html.markdown | 21 ++------------- .../docs/builders/openstack.html.markdown | 14 +++------- .../docs/builders/parallels-iso.html.markdown | 19 +++----------- .../docs/builders/parallels-pvm.html.markdown | 19 +++----------- .../source/docs/builders/qemu.html.markdown | 21 +++------------ .../builders/virtualbox-iso.html.markdown | 19 +++----------- .../builders/virtualbox-ovf.html.markdown | 19 +++----------- .../docs/builders/vmware-iso.html.markdown | 26 +++---------------- .../docs/builders/vmware-vmx.html.markdown | 23 +++------------- 15 files changed, 62 insertions(+), 190 deletions(-) diff --git a/website/source/docs/builders/amazon-chroot.html.markdown b/website/source/docs/builders/amazon-chroot.html.markdown index e0553ef7a..453811c8a 100644 --- a/website/source/docs/builders/amazon-chroot.html.markdown +++ b/website/source/docs/builders/amazon-chroot.html.markdown @@ -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 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: * `access_key` (string) - The access key used to communicate with AWS. diff --git a/website/source/docs/builders/amazon-ebs.html.markdown b/website/source/docs/builders/amazon-ebs.html.markdown index b7f16eef9..596f8d230 100644 --- a/website/source/docs/builders/amazon-ebs.html.markdown +++ b/website/source/docs/builders/amazon-ebs.html.markdown @@ -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 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: * `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 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 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-12345def", where Packer will launch the EC2 instance. This field is required if you are using an non-default VPC. @@ -279,11 +272,11 @@ Here is an example using the optional AMI tags. This will add the tags ``` -> **Note:** Packer uses pre-built AMIs as the source for building images. -These source AMIs may include volumes that are not flagged to be destroyed on +These source AMIs may include volumes that are not flagged to be destroyed on termiation of the instance building the new image. Packer will attempt to clean up all residual volumes that are not designated by the user to remain after termination. If you need to preserve those source volumes, you can overwrite the -termination setting by specifying `delete_on_termination=false` in the +termination setting by specifying `delete_on_termination=false` in the `launch_device_mappings` block for the device. [1]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html diff --git a/website/source/docs/builders/amazon-instance.html.markdown b/website/source/docs/builders/amazon-instance.html.markdown index bacb5ee58..163a93584 100644 --- a/website/source/docs/builders/amazon-instance.html.markdown +++ b/website/source/docs/builders/amazon-instance.html.markdown @@ -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 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: * `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 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 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-12345def", where Packer will launch the EC2 instance. This field is required if you are using an non-default VPC. diff --git a/website/source/docs/builders/digitalocean.html.markdown b/website/source/docs/builders/digitalocean.html.markdown index 829424e3d..c9ef3b315 100644 --- a/website/source/docs/builders/digitalocean.html.markdown +++ b/website/source/docs/builders/digitalocean.html.markdown @@ -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 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: * `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 [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, for a droplet to enter a desired state (such as "active") before timing out. The default state timeout is "6m". diff --git a/website/source/docs/builders/docker.html.markdown b/website/source/docs/builders/docker.html.markdown index 78ca90a56..c760742ee 100644 --- a/website/source/docs/builders/docker.html.markdown +++ b/website/source/docs/builders/docker.html.markdown @@ -62,6 +62,10 @@ 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.html) +can be configured for this builder. + ### Required: * `commit` (boolean) - If true, the container will be committed to an diff --git a/website/source/docs/builders/googlecompute.markdown b/website/source/docs/builders/googlecompute.markdown index 097e69268..a572a0371 100644 --- a/website/source/docs/builders/googlecompute.markdown +++ b/website/source/docs/builders/googlecompute.markdown @@ -15,7 +15,7 @@ Compute Engine doesn't allow the creation of images from scratch. ## Authentication -Authenticating with Google Cloud services requires at most one JSON file, +Authenticating with Google Cloud services requires at most one JSON file, called the _account file_. The _account file_ is **not** required if you are running the `googlecompute` Packer builder from a GCE instance with a properly-configured [Compute Engine Service Account](https://cloud.google.com/compute/docs/authentication). @@ -23,7 +23,7 @@ the `googlecompute` Packer builder from a GCE instance with a properly-configure ### Running With a Compute Engine Service Account If you run the `googlecompute` Packer builder from a GCE instance, you can configure that instance to use a [Compute Engine Service Account](https://cloud.google.com/compute/docs/authentication). This will allow Packer to authenticate -to Google Cloud without having to bake in a separate credential/authentication file. +to Google Cloud without having to bake in a separate credential/authentication file. To create a GCE instance that uses a service account, provide the required scopes when launching the instance. @@ -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 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: * `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 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. Defaults to `"5m"`. diff --git a/website/source/docs/builders/null.html.markdown b/website/source/docs/builders/null.html.markdown index 1229db359..74c4465fb 100644 --- a/website/source/docs/builders/null.html.markdown +++ b/website/source/docs/builders/null.html.markdown @@ -29,23 +29,6 @@ no provisioners are defined, but it will connect to the specified host via ssh. ## Configuration Reference -Configuration options are organized into two categories: required and -optional. Within each category, the available options are alphabetized and -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. +The null builder has no configuration parameters other than the +[communicator](/docs/templates/communicator.html) settings. diff --git a/website/source/docs/builders/openstack.html.markdown b/website/source/docs/builders/openstack.html.markdown index fcd210dec..fec1a85a6 100644 --- a/website/source/docs/builders/openstack.html.markdown +++ b/website/source/docs/builders/openstack.html.markdown @@ -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 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: * `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 `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 useful for Rackspace are "public" or "private", and the default behavior is to connect via whichever is returned first from the OpenStack API. diff --git a/website/source/docs/builders/parallels-iso.html.markdown b/website/source/docs/builders/parallels-iso.html.markdown index b7e2af527..f0192b301 100644 --- a/website/source/docs/builders/parallels-iso.html.markdown +++ b/website/source/docs/builders/parallels-iso.html.markdown @@ -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 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: * `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 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 virtual machine, without the file extension. By default this is "packer-BUILDNAME", where "BUILDNAME" is the name of the build. diff --git a/website/source/docs/builders/parallels-pvm.html.markdown b/website/source/docs/builders/parallels-pvm.html.markdown index fea19fa83..4083a57fd 100644 --- a/website/source/docs/builders/parallels-pvm.html.markdown +++ b/website/source/docs/builders/parallels-pvm.html.markdown @@ -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 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: * `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 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 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 diff --git a/website/source/docs/builders/qemu.html.markdown b/website/source/docs/builders/qemu.html.markdown index 0e22ccc3b..ae5d4464f 100644 --- a/website/source/docs/builders/qemu.html.markdown +++ b/website/source/docs/builders/qemu.html.markdown @@ -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 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: * `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 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 the new virtual machine, without the file extension. By default this is "packer-BUILDNAME", where "BUILDNAME" is the name of the build. diff --git a/website/source/docs/builders/virtualbox-iso.html.markdown b/website/source/docs/builders/virtualbox-iso.html.markdown index 07204a33c..616b0a8e4 100644 --- a/website/source/docs/builders/virtualbox-iso.html.markdown +++ b/website/source/docs/builders/virtualbox-iso.html.markdown @@ -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 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: * `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 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 not setup forwarded port mapping for SSH requests and uses `ssh_port` on the host to communicate to the virtual machine diff --git a/website/source/docs/builders/virtualbox-ovf.html.markdown b/website/source/docs/builders/virtualbox-ovf.html.markdown index 9635d0e60..db5247738 100644 --- a/website/source/docs/builders/virtualbox-ovf.html.markdown +++ b/website/source/docs/builders/virtualbox-ovf.html.markdown @@ -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 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: * `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 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 not setup forwarded port mapping for SSH requests and uses `ssh_port` on the host to communicate to the virtual machine diff --git a/website/source/docs/builders/vmware-iso.html.markdown b/website/source/docs/builders/vmware-iso.html.markdown index 177bfc608..2bb3a402f 100644 --- a/website/source/docs/builders/vmware-iso.html.markdown +++ b/website/source/docs/builders/vmware-iso.html.markdown @@ -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 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: * `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 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 upload into the VM. Valid values are "darwin", "linux", and "windows". By default, this is empty, which means VMware tools won't be uploaded. diff --git a/website/source/docs/builders/vmware-vmx.html.markdown b/website/source/docs/builders/vmware-vmx.html.markdown index bbdd8925c..e28ea3f89 100644 --- a/website/source/docs/builders/vmware-vmx.html.markdown +++ b/website/source/docs/builders/vmware-vmx.html.markdown @@ -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 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: * `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 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 machine, without the file extension. By default this is "packer-BUILDNAME", where "BUILDNAME" is the name of the build.