Merge pull request #8887 from hashicorp/untangle_ssh_docs_from_aws

Untangle ssh docs from aws

helper/communicator/config.go

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

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

@@ -10,13 +10,12 @@
 -   `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
-    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
-    unless [`ssh_password`](../templates/communicator.html#ssh_password) is
-    used.
-    [`ssh_private_key_file`](../templates/communicator.html#ssh_private_key_file)
-    or `ssh_agent_auth` must be specified when `ssh_keypair_name` is
-    utilized.
+    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.
     
 -   `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
@@ -42,12 +41,10 @@
     
 -   `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` and `ssh_private_key_file` will be ignored. To
-    use this option with a key pair already configured in the source AMI,
-    leave the `ssh_keypair_name` blank. To associate an existing key pair in
-    AWS with the source instance, set the `ssh_keypair_name` field to the
-    name of the key pair. The environment variable `SSH_AUTH_SOCK` must be
-    set for this option to work properly.
+    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.
     
 -   `ssh_disable_agent_forwarding` (bool) - If true, SSH agent forwarding will be disabled. Defaults to `false`.