Agent to enable remote management of your Amazon EC2 instance configuration.
Permalink
Failed to load latest commit information.
Tools/src Merge branch 'master' into session Sep 15, 2018
agent Remove unnecessary error message and fix typo Oct 9, 2018
internal/tests Add integration test for failed document Oct 5, 2018
packaging Implement logging process for session manager Aug 10, 2018
src add back src folder Apr 13, 2016
vendor/src Change file permissions for log files to be rwx for admin only Sep 18, 2018
.gitignore Updated the darwin patch set to work with the newer version of SSM Jul 26, 2018
.travis.yml Updating GoLang version in travis file and updating the development b… Oct 30, 2017
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Apr 5, 2018
CONTRIBUTING.md Updating GoLang version in travis file and updating the development b… Oct 30, 2017
Config Get winpty binaries from dependent package Sep 15, 2018
LICENSE Update LICENSE May 19, 2017
NOTICE.md Add attribution for open source libraries Sep 15, 2018
README.md Remove unnecessary error message and fix typo Oct 9, 2018
RELEASENOTES.md Update release notes Oct 5, 2018
VERSION Bumping up the default version of SSM Agent to 2.3.0.0 Sep 15, 2018
amazon-ssm-agent.json.template Setup new orchestration directory for Session Manager Sep 15, 2018
amazon-ssm-agent.spec Exclude Arch ix86 from Amazon Linux spec file Sep 26, 2018
makefile Implement logging process for session manager Aug 10, 2018
seelog_unix.xml adding support for managing instance Jun 8, 2016
seelog_windows.xml.template adding support for managing instance Jun 8, 2016

README.md

ReportCard Build Status

Amazon SSM Agent

The Amazon EC2 Simple Systems Manager (SSM) Agent is software developed for the Simple Systems Manager Service. The SSM Agent is the primary component of a feature called Run Command.

Overview

The SSM Agent runs on EC2 instances and enables you to quickly and easily execute remote commands or scripts against one or more instances. The agent uses SSM documents. When you execute a command, the agent on the instance processes the document and configures the instance as specified. Currently, the agent and Run Command enable you to quickly run Shell scripts on an instance using the AWS-RunShellScript SSM document. SSM Agent also enables the Session Manager capability that lets you manage your Amazon EC2 instance through an interactive one-click browser-based shell or through the AWS CLI. When the agent starts, it will create a user called "ssm-user" with sudo or administrator privilege. Session Manager sessions will be launched in context of this user.

Verify Requirements

SSM Run Command Prerequisites SSM Session Manager Prerequisites and supported Operating Systems

Setup

Executing Commands

SSM Run Command Walkthrough Using the AWS CLI

Starting Sessions

Session Manager Walkthrough Using the AWS Console and CLI

Troubleshooting

Troubleshooting SSM Run Command Troubleshooting SSM Session Manager

Feedback

Thank you for helping us to improve Systems Manager, Run Command and Session Manager. Please send your questions or comments to: ec2-ssm-feedback@amazon.com

Building and Running from source

sudo yum install -y rpmdevtools rpm-build
  • Cross Compile SSM Agent

  • Run make build to build the SSM Agent for Linux, Debian, Windows environment.

  • Run make release to build the agent and also packages it into a RPM, DEB and ZIP package.

The following folders are generated when the build completes:

bin/debian_386
bin/debian_amd64
bin/linux_386
bin/linux_amd64
bin/windows_386
bin/windows_amd64
  • To enable the Agent for Session Manager scenario on Windows instances
    • Clone the repo from https://github.com/masatma/winpty.git
    • Follow instructions on https://github.com/rprichard/winpty to build winpty 64-bit binaries
    • Copy the winpty.dll and winpty-agent.exe to the bin/SessionManagerShell folder For the Windows Operating System, Session Manager is only supported on Windows Server 2008 R2 through Windows Server 2016 64-bit versions.

Please follow the user guide to copy and install the SSM Agent

Code Layout

  • Source code is under agent/
  • Vendor package source code is under vendor/src
  • rpm and dpkg artifacts are under packaging
  • build scripts are under Tools/src

GOPATH

To use vendor dependencies, the suggested GOPATH format is :<packagesource>/vendor:<packagesource>

Make Targets

The following targets are available. Each may be run with make <target>.

Make Target Description
build (Default) build builds the agent for Linux, Debian and Windows amd64 and 386 environment
release release checks code style and coverage, builds the agent and also packages it into a RPM, DEB and ZIP package
package package packages build result into a RPM, DEB and ZIP package
pre-build pre-build goes through Tools/src folder to make sure all the script files are executable
checkstyle checkstyle runs the checkstyle script
quick-integtest quick-integtest runs all tests tagged with integration using go test
quick-test quick-test runs all the tests including integration and unit tests usinggo test`
coverage coverage runs all tests and calculate code coverage
build-linux build-linux builds the agent for execution in the Linux amd64 environment
build-windows build-windows builds the agent for execution in the Windows amd64 environment
build-darwin build-darwin builds the agent for execution in the Darwin amd64 environment
build-linux-386 build-linux-386 builds the agent for execution in the Linux 386 environment
build-windows-386 build-windows-386 builds the agent for execution in the Windows 386 environment
build-darwin-386 build-darwin-386 builds the agent for execution in the Darwin 386 environment
create-rpm create-rpm builds the agent and packages it into a RPM package for Linux amd64 based distributions
create-deb create-deb builds the agent and packages it into a DEB package Debian amd64 based distributions
create-win create-win builds the agent and packages it into a ZIP package Windows amd64 based distributions
create-rpm-386 create-rpm-386 builds the agent and packages it into a RPM package for Linux 386 based distributions
create-deb-386 create-deb-386 builds the agent and packages it into a DEB package Debian 386 based distributions
create-win-386 create-win-386 builds the agent and packages it into a ZIP package Windows 386 based distributions
create-linux-package create-linux-package create update packages for Linux and Debian based distributions
create-windows-package create-windows-package create update packages for Windows based distributions
get-tools get-tools gets gocode and oracle using go get
clean clean removes build artifacts.

Contributing

Contributions and feedback are welcome! Proposals and Pull Requests will be considered and responded to. Please see the CONTRIBUTING.md file for more information.

Amazon Web Services does not currently provide support for modified copies of this software.

License

The Amazon SSM Agent is licensed under the Apache 2.0 License.