iSharkFly-Docs
/
packer-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

make ssh docs less AWS specific

This commit is contained in:
Adrien Delorme 2020-03-13 11:04:10 +01:00
parent 1c27d9d04b
commit 60a3105a45
2 changed files with 18 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
helper/communicator/config.go
View File

@ -77,13 +77,12 @@ type SSH struct {
// A plaintext password to use to authenticate with SSH. // A plaintext password to use to authenticate with SSH.
SSHPassword string `mapstructure:"ssh_password"` SSHPassword string `mapstructure:"ssh_password"`
// If specified, this is the key that will be used for SSH with the // 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 Amazon EC2. // 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 // By default, this is blank, and Packer will generate a temporary keypair
// unless [`ssh_password`](../templates/communicator.html#ssh_password) is // unless [`ssh_password`](#ssh_password) is used.
// used. // [`ssh_private_key_file`](#ssh_private_key_file) or
// [`ssh_private_key_file`](../templates/communicator.html#ssh_private_key_file) // [`ssh_agent_auth`](#ssh_agent_auth) must be specified when
// or `ssh_agent_auth` must be specified when `ssh_keypair_name` is // [`ssh_keypair_name`](#ssh_keypair_name) is utilized.
// utilized.
SSHKeyPairName string `mapstructure:"ssh_keypair_name"` SSHKeyPairName string `mapstructure:"ssh_keypair_name"`
// The name of the temporary key pair to generate. By default, Packer // 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 // generates a name that looks like `packer_<UUID>`, where &lt;UUID&gt; is
@ -109,12 +108,10 @@ type SSH struct {
SSHTimeout time.Duration `mapstructure:"ssh_timeout"` SSHTimeout time.Duration `mapstructure:"ssh_timeout"`
// If true, the local SSH agent will be used to authenticate connections to // If true, the local SSH agent will be used to authenticate connections to
// the source instance. No temporary keypair will be created, and the // the source instance. No temporary keypair will be created, and the
// values of `ssh_password` and `ssh_private_key_file` will be ignored. To // values of [`ssh_password`](#ssh_password) and
// use this option with a key pair already configured in the source AMI, // [`ssh_private_key_file`](#ssh_private_key_file) will be ignored. The
// leave the `ssh_keypair_name` blank. To associate an existing key pair in // environment variable `SSH_AUTH_SOCK` must be set for this option to work
// AWS with the source instance, set the `ssh_keypair_name` field to the // properly.
// name of the key pair. The environment variable `SSH_AUTH_SOCK` must be
// set for this option to work properly.
SSHAgentAuth bool `mapstructure:"ssh_agent_auth"` SSHAgentAuth bool `mapstructure:"ssh_agent_auth"`
// If true, SSH agent forwarding will be disabled. Defaults to `false`. // If true, SSH agent forwarding will be disabled. Defaults to `false`.
SSHDisableAgentForwarding bool `mapstructure:"ssh_disable_agent_forwarding"` SSHDisableAgentForwarding bool `mapstructure:"ssh_disable_agent_forwarding"`

21
website/source/partials/helper/communicator/_SSH-not-required.html.md
View File

@ -10,13 +10,12 @@
- `ssh_password` (string) - A plaintext password to use to authenticate with SSH. - `ssh_password` (string) - A plaintext password to use to authenticate with SSH.
- `ssh_keypair_name` (string) - If specified, this is the key that will be used for SSH with the - `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 Amazon EC2. 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 By default, this is blank, and Packer will generate a temporary keypair
unless [`ssh_password`](../templates/communicator.html#ssh_password) is unless [`ssh_password`](#ssh_password) is used.
used. [`ssh_private_key_file`](#ssh_private_key_file) or
[`ssh_private_key_file`](../templates/communicator.html#ssh_private_key_file) [`ssh_agent_auth`](#ssh_agent_auth) must be specified when
or `ssh_agent_auth` must be specified when `ssh_keypair_name` is [`ssh_keypair_name`](#ssh_keypair_name) is utilized.
utilized.
- `temporary_key_pair_name` (string) - The name of the temporary key pair to generate. By default, Packer - `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 generates a name that looks like `packer_<UUID>`, where &lt;UUID&gt; is
@ -42,12 +41,10 @@
- `ssh_agent_auth` (bool) - If true, the local SSH agent will be used to authenticate connections to - `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 the source instance. No temporary keypair will be created, and the
values of `ssh_password` and `ssh_private_key_file` will be ignored. To values of [`ssh_password`](#ssh_password) and
use this option with a key pair already configured in the source AMI, [`ssh_private_key_file`](#ssh_private_key_file) will be ignored. The
leave the `ssh_keypair_name` blank. To associate an existing key pair in environment variable `SSH_AUTH_SOCK` must be set for this option to work
AWS with the source instance, set the `ssh_keypair_name` field to the properly.
name of the key pair. The environment variable `SSH_AUTH_SOCK` must be
set for this option to work properly.
- `ssh_disable_agent_forwarding` (bool) - If true, SSH agent forwarding will be disabled. Defaults to `false`. - `ssh_disable_agent_forwarding` (bool) - If true, SSH agent forwarding will be disabled. Defaults to `false`.