create partials for each ssh key pair related config

This commit is contained in:
Moss 2020-07-02 14:50:45 +02:00
parent 8ea64c5b35
commit d060cc9ef2
13 changed files with 73 additions and 32 deletions

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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'

View File

@ -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:

View File

@ -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:

View File

@ -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'

View File

@ -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.

View File

@ -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.

View File

@ -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_<UUID>`, where &lt;UUID&gt; 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.

View File

@ -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.

View File

@ -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_<UUID>`, where &lt;UUID&gt; is
a 36 character unique identifier.