diff --git a/website/pages/docs/builders/amazon/ebs.mdx b/website/pages/docs/builders/amazon/ebs.mdx index 57ac2126a..adcb24669 100644 --- a/website/pages/docs/builders/amazon/ebs.mdx +++ b/website/pages/docs/builders/amazon/ebs.mdx @@ -101,7 +101,13 @@ Block devices can be nested in the @include 'helper/communicator/SSH-not-required.mdx' -@include 'helper/communicator/SSH-Key-Pair-not-required.mdx' +@include 'helper/communicator/SSH-Temporary-Key-Pair-not-required.mdx' + +@include 'helper/communicator/SSH-Key-Pair-Name-not-required.mdx' + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' + +@include 'helper/communicator/SSH-Agent-Auth-not-required.mdx' ## Basic Example diff --git a/website/pages/docs/builders/amazon/ebssurrogate.mdx b/website/pages/docs/builders/amazon/ebssurrogate.mdx index 1fe903e4d..bb02f5636 100644 --- a/website/pages/docs/builders/amazon/ebssurrogate.mdx +++ b/website/pages/docs/builders/amazon/ebssurrogate.mdx @@ -100,7 +100,13 @@ Block devices can be nested in the @include 'helper/communicator/SSH-not-required.mdx' -@include 'helper/communicator/SSH-Key-Pair-not-required.mdx' +@include 'helper/communicator/SSH-Temporary-Key-Pair-not-required.mdx' + +@include 'helper/communicator/SSH-Key-Pair-Name-not-required.mdx' + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' + +@include 'helper/communicator/SSH-Agent-Auth-not-required.mdx' ## Basic Example diff --git a/website/pages/docs/builders/amazon/ebsvolume.mdx b/website/pages/docs/builders/amazon/ebsvolume.mdx index 3708a5c9c..e4e49720a 100644 --- a/website/pages/docs/builders/amazon/ebsvolume.mdx +++ b/website/pages/docs/builders/amazon/ebsvolume.mdx @@ -104,7 +104,13 @@ Block devices can be nested in the @include 'helper/communicator/SSH-not-required.mdx' -@include 'helper/communicator/SSH-Key-Pair-not-required.mdx' +@include 'helper/communicator/SSH-Temporary-Key-Pair-not-required.mdx' + +@include 'helper/communicator/SSH-Key-Pair-Name-not-required.mdx' + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' + +@include 'helper/communicator/SSH-Agent-Auth-not-required.mdx' ## Basic Example diff --git a/website/pages/docs/builders/amazon/instance.mdx b/website/pages/docs/builders/amazon/instance.mdx index 5aa4ba7ad..f8e1083a2 100644 --- a/website/pages/docs/builders/amazon/instance.mdx +++ b/website/pages/docs/builders/amazon/instance.mdx @@ -117,7 +117,13 @@ Block devices can be nested in the @include 'helper/communicator/SSH-not-required.mdx' -@include 'helper/communicator/SSH-Key-Pair-not-required.mdx' +@include 'helper/communicator/SSH-Temporary-Key-Pair-not-required.mdx' + +@include 'helper/communicator/SSH-Key-Pair-Name-not-required.mdx' + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' + +@include 'helper/communicator/SSH-Agent-Auth-not-required.mdx' ## Basic Example diff --git a/website/pages/docs/builders/openstack.mdx b/website/pages/docs/builders/openstack.mdx index 5a6f57ab2..336b5135d 100644 --- a/website/pages/docs/builders/openstack.mdx +++ b/website/pages/docs/builders/openstack.mdx @@ -79,7 +79,13 @@ builder. @include 'helper/communicator/SSH-not-required.mdx' -@include 'helper/communicator/SSH-Key-Pair-not-required.mdx' +@include 'helper/communicator/SSH-Temporary-Key-Pair-not-required.mdx' + +@include 'helper/communicator/SSH-Key-Pair-Name-not-required.mdx' + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' + +@include 'helper/communicator/SSH-Agent-Auth-not-required.mdx' @include 'helper/communicator/SSHInterface-not-required.mdx' diff --git a/website/pages/docs/builders/virtualbox/iso.mdx b/website/pages/docs/builders/virtualbox/iso.mdx index a2bbf9e44..05d14c717 100644 --- a/website/pages/docs/builders/virtualbox/iso.mdx +++ b/website/pages/docs/builders/virtualbox/iso.mdx @@ -172,7 +172,13 @@ necessary for this build to succeed and can be found further down the page. @include 'helper/communicator/SSH-not-required.mdx' -@include 'helper/communicator/SSH-Key-Pair-not-required.mdx' +@include 'helper/communicator/SSH-Temporary-Key-Pair-not-required.mdx' + +@include 'helper/communicator/SSH-Key-Pair-Name-not-required.mdx' + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' + +@include 'helper/communicator/SSH-Agent-Auth-not-required.mdx' #### Optional WinRM fields: diff --git a/website/pages/docs/builders/virtualbox/ovf.mdx b/website/pages/docs/builders/virtualbox/ovf.mdx index 57b874c91..6f253faf4 100644 --- a/website/pages/docs/builders/virtualbox/ovf.mdx +++ b/website/pages/docs/builders/virtualbox/ovf.mdx @@ -159,7 +159,13 @@ necessary for this build to succeed and can be found further down the page. @include 'helper/communicator/SSH-not-required.mdx' -@include 'helper/communicator/SSH-Key-Pair-not-required.mdx' +@include 'helper/communicator/SSH-Temporary-Key-Pair-not-required.mdx' + +@include 'helper/communicator/SSH-Key-Pair-Name-not-required.mdx' + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' + +@include 'helper/communicator/SSH-Agent-Auth-not-required.mdx' #### Optional WinRM fields: diff --git a/website/pages/docs/builders/virtualbox/vm.mdx b/website/pages/docs/builders/virtualbox/vm.mdx index 464f04dd7..12ac15401 100644 --- a/website/pages/docs/builders/virtualbox/vm.mdx +++ b/website/pages/docs/builders/virtualbox/vm.mdx @@ -182,8 +182,6 @@ builder. @include 'helper/communicator/SSH-not-required.mdx' -@include 'helper/communicator/SSH-Key-Pair-not-required.mdx' - #### Optional WinRM fields: @include 'helper/communicator/WinRM-not-required.mdx' diff --git a/website/pages/partials/helper/communicator/SSH-Agent-Auth-not-required.mdx b/website/pages/partials/helper/communicator/SSH-Agent-Auth-not-required.mdx new file mode 100644 index 000000000..3039120dd --- /dev/null +++ b/website/pages/partials/helper/communicator/SSH-Agent-Auth-not-required.mdx @@ -0,0 +1,7 @@ + +- `ssh_agent_auth` (bool) - If true, the local SSH agent will be used to authenticate connections to + the source instance. No temporary keypair will be created, and the + values of [`ssh_password`](#ssh_password) and + [`ssh_private_key_file`](#ssh_private_key_file) will be ignored. The + environment variable `SSH_AUTH_SOCK` must be set for this option to work + properly. diff --git a/website/pages/partials/helper/communicator/SSH-Key-Pair-Name-not-required.mdx b/website/pages/partials/helper/communicator/SSH-Key-Pair-Name-not-required.mdx new file mode 100644 index 000000000..2bb1ecc51 --- /dev/null +++ b/website/pages/partials/helper/communicator/SSH-Key-Pair-Name-not-required.mdx @@ -0,0 +1,9 @@ + +- `ssh_keypair_name` (string) - If specified, this is the key that will be used for SSH with the + machine. The key must match a key pair name loaded up into the remote. + By default, this is blank, and Packer will generate a temporary keypair + unless [`ssh_password`](#ssh_password) is used. + [`ssh_private_key_file`](#ssh_private_key_file) or + [`ssh_agent_auth`](#ssh_agent_auth) must be specified when + [`ssh_keypair_name`](#ssh_keypair_name) is utilized. + diff --git a/website/pages/partials/helper/communicator/SSH-Key-Pair-not-required.mdx b/website/pages/partials/helper/communicator/SSH-Key-Pair-not-required.mdx deleted file mode 100644 index a2be645da..000000000 --- a/website/pages/partials/helper/communicator/SSH-Key-Pair-not-required.mdx +++ /dev/null @@ -1,23 +0,0 @@ - -- `temporary_key_pair_name` (string) - The name of the temporary key pair to generate. By default, Packer - generates a name that looks like `packer_`, where <UUID> is - a 36 character unique identifier. - -- `ssh_keypair_name` (string) - If specified, this is the key that will be used for SSH with the - machine. The key must match a key pair name loaded up into the remote. - By default, this is blank, and Packer will generate a temporary keypair - unless [`ssh_password`](#ssh_password) is used. - [`ssh_private_key_file`](#ssh_private_key_file) or - [`ssh_agent_auth`](#ssh_agent_auth) must be specified when - [`ssh_keypair_name`](#ssh_keypair_name) is utilized. - -- `ssh_private_key_file` (string) - Path to a PEM encoded private key file to use to authenticate with SSH. - The `~` can be used in path and will be expanded to the home directory - of current user. - -- `ssh_agent_auth` (bool) - If true, the local SSH agent will be used to authenticate connections to - the source instance. No temporary keypair will be created, and the - values of [`ssh_password`](#ssh_password) and - [`ssh_private_key_file`](#ssh_private_key_file) will be ignored. The - environment variable `SSH_AUTH_SOCK` must be set for this option to work - properly. diff --git a/website/pages/partials/helper/communicator/SSH-Private-Key-File-not-required.mdx b/website/pages/partials/helper/communicator/SSH-Private-Key-File-not-required.mdx new file mode 100644 index 000000000..92d185f36 --- /dev/null +++ b/website/pages/partials/helper/communicator/SSH-Private-Key-File-not-required.mdx @@ -0,0 +1,4 @@ + +- `ssh_private_key_file` (string) - Path to a PEM encoded private key file to use to authenticate with SSH. + The `~` can be used in path and will be expanded to the home directory + of current user. diff --git a/website/pages/partials/helper/communicator/SSH-Temporary-Key-Pair-not-required.mdx b/website/pages/partials/helper/communicator/SSH-Temporary-Key-Pair-not-required.mdx new file mode 100644 index 000000000..133f946de --- /dev/null +++ b/website/pages/partials/helper/communicator/SSH-Temporary-Key-Pair-not-required.mdx @@ -0,0 +1,4 @@ + +- `temporary_key_pair_name` (string) - The name of the temporary key pair to generate. By default, Packer + generates a name that looks like `packer_`, where <UUID> is + a 36 character unique identifier.