From 81c40b8d08b929a246a00cb736351d38b5a7dcec Mon Sep 17 00:00:00 2001 From: Wilken Rivera Date: Wed, 6 May 2020 15:17:38 -0400 Subject: [PATCH] Add section to docs about the session-manager-plugin tunnel --- builder/amazon/common/run_config.go | 4 ++++ .../partials/builder/amazon/common/RunConfig-not-required.mdx | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/builder/amazon/common/run_config.go b/builder/amazon/common/run_config.go index 705510949..d4dfca172 100644 --- a/builder/amazon/common/run_config.go +++ b/builder/amazon/common/run_config.go @@ -402,6 +402,10 @@ type RunConfig struct { // When using `session_manager` the machine running Packer must have // the AWS Session Manager Plugin installed and within the users' or system path. // https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html + // Remote connections via the `session_manager` interface establishes a secure tunnel + // between the local host and the remote host on an available local port to the specified `ssh_port`. + // Upon termination the secure tunnel will be terminated automatically, if however there is a failure in + // terminating the tunnel it will automatically terminate itself after 20 minutes of inactivity. SSHInterface string `mapstructure:"ssh_interface"` } diff --git a/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx b/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx index 383d98c06..495a7bb95 100644 --- a/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx +++ b/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx @@ -313,4 +313,8 @@ When using `session_manager` the machine running Packer must have the AWS Session Manager Plugin installed and within the users' or system path. https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html + Remote connections via the `session_manager` interface establishes a secure tunnel + between the local host and the remote host on an available local port to the specified `ssh_port`. + Upon termination the secure tunnel will be terminated automatically, if however there is a failure in + terminating the tunnel it will automatically terminate itself after 20 minutes of inactivity. \ No newline at end of file