upstream/packer
1
0
Fork 0
mirror of https://github.com/hashicorp/packer.git synced 2026-05-28 04:35:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

docs: update ssh

Browse source 
Adds documentation for `ssh_keypair_name`, `ssh_agent_auth`, `temporary_key_pair_name`, and `ssh_private_key_file`.

The note is updated noting that not all builders support these options.

Ref:  #10722

Signed-off-by: Ryan Johnson <ryan@tenthirtyam.org>
This commit is contained in:
Ryan Johnson 2024-06-12 23:01:43 -04:00 committed by Wilken Rivera
parent f7cf9ede19
commit 51cbe0ba81
1 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
website/content/docs/communicators/ssh.mdx
View file

@ -58,15 +58,23 @@ The SSH communicator has the following options:
@include "packer-plugin-sdk/communicator/SSH-not-required.mdx"
~> Note: SSH communicator options: `ssh_keypair_name`, `ssh_agent_auth`,
`temporary_key_pair_name` and `ssh_private_key_file` are also supported by
the communicator. But they may not be supported for every builder. Please check
the builder specific documentation for additional SSH supported options.
@include "packer-plugin-sdk/communicator/SSH-Key-Pair-Name-not-required.mdx"
@include "packer-plugin-sdk/communicator/SSH-Agent-Auth-not-required.mdx"
@include "packer-plugin-sdk/communicator/SSH-Temporary-Key-Pair-not-required.mdx"
@include "packer-plugin-sdk/communicator/SSH-Private-Key-File-not-required.mdx"
~> Note: The options `ssh_keypair_name`, `ssh_agent_auth`,
`temporary_key_pair_name`, and `ssh_private_key_file` are supported by the
communicator; however, they may not be supported for every builder. Please refer
to the builder documentation for supported options.
### SSH Communicator Details
Packer will only use one authentication method, either `publickey` or if
`ssh_password` is used packer will offer `password` and `keyboard-interactive`
`ssh_password` is used Packer will offer `password` and `keyboard-interactive`
both sending the password. In other words Packer will not work with _sshd_
configured with more than one configured authentication method using
`AuthenticationMethods`.