From 60a3105a4569bb05e2a7381e020790f46d71ab5e Mon Sep 17 00:00:00 2001 From: Adrien Delorme Date: Fri, 13 Mar 2020 11:04:10 +0100 Subject: [PATCH] make ssh docs less AWS specific --- helper/communicator/config.go | 21 ++++++++----------- .../communicator/_SSH-not-required.html.md | 21 ++++++++----------- 2 files changed, 18 insertions(+), 24 deletions(-) diff --git a/helper/communicator/config.go b/helper/communicator/config.go index fe992a1b0..9094d39a6 100644 --- a/helper/communicator/config.go +++ b/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_`, where <UUID> 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"` diff --git a/website/source/partials/helper/communicator/_SSH-not-required.html.md b/website/source/partials/helper/communicator/_SSH-not-required.html.md index 629654786..71616c0f3 100644 --- a/website/source/partials/helper/communicator/_SSH-not-required.html.md +++ b/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_`, where <UUID> 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`.