Merge pull request #9461 from hashicorp/docs-session-manager-winrm-updates

* docs/builder/amazon: Add WinRM unsupported note to Session Manager docs

Co-authored-by: Adrien Delorme <azr@users.noreply.github.com>

Closes #9451
This commit is contained in:
Wilken Rivera 2020-06-23 07:53:04 -04:00 committed by GitHub
commit 7a08086cba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 9 deletions

View File

@ -400,11 +400,12 @@ type RunConfig struct {
// variable.
//
// 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
// the AWS Session Manager Plugin installed and within the users' system path.
// Connectivity 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
// See [Session Manager Connections](#session-manager-connections) for more information.
// - Session manager connectivity is currently only implemented for the SSH communicator, not the WinRM communicator.
// - 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"`

View File

@ -311,11 +311,12 @@
variable.
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
the AWS Session Manager Plugin installed and within the users' system path.
Connectivity 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
See [Session Manager Connections](#session-manager-connections) for more information.
- Session manager connectivity is currently only implemented for the SSH communicator, not the WinRM communicator.
- 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.
- `session_manager_port` (int) - Which port to connect the local end of the session tunnel to. If

View File

@ -2,11 +2,13 @@
Support for the AWS Systems Manager session manager lets users manage EC2 instances without the need to open inbound ports, or maintain bastion hosts. Session manager connectivity relies on the use of the [session manager plugin](#session-manager-plugin) to open a secure tunnel between the local machine and the remote instance. Once the tunnel has been created all SSH communication will be tunneled through SSM to the remote instance.
-> Note: Session manager connectivity is currently only implemented for the SSH communicator, not the WinRM Communicator.
To use the session manager as the connection interface for the SSH communicator you need to add the following configuration options to the Amazon builder options:
* `ssh_interface`: The ssh interface must be set to "session_manager". When using this option the builder will create an SSM tunnel to the configured `ssh_port` (defaults to 22) on the remote host.
* `iam_instance_profile`: A valid instance profile granting Systems Manager permissions to manage the remote instance is required in order for the aws ssm-agent to start and stop session connections.
See below for more details on IAM instance profile for Systems Manager(#iam-instance-profile-for-systems-manager).
See below for more details on [IAM instance profile for Systems Manager](#iam-instance-profile-for-systems-manager).
#### Optional
* `session_manager_port`: A local port on the host machine that should be used as the local end of the session tunnel to the remote host. If not specified Packer will find an available port to use.