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.
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. The first time a Session Manager session is started on an instance, the agent will create a user called "ssm-user" with sudo or administrator privilege. Session Manager sessions will be launched in context of this user.
SSM Run Command Walkthrough Using the AWS CLI
Session Manager Walkthrough Using the AWS Console and CLI
Troubleshooting SSM Run Command Troubleshooting SSM Session Manager
Thank you for helping us to improve Systems Manager, Run Command and Session Manager. Please send your questions or comments to Systems Manager Forums
Install docker: Install CentOS
Build image
docker build -t ssm-agent-build-image .
docker run -it --rm --name ssm-agent-build-container -v `pwd`:/amazon-ssm-agent ssm-agent-build-image make build-release
Install go Getting started
Install rpm-build and rpmdevtools
Cross Compile SSM Agent
Run make build
to build the SSM Agent for Linux, Debian, Windows environment.
Run make build-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/linux_arm
bin/linux_arm64
bin/windows_386
bin/windows_amd64
Please follow the user guide to copy and install the SSM Agent
To lint the entire module call the lint-all
target. This executes golangci-lint on all packages in the module.
You can configure golangci-lint with different linters using the .golangci.yml
file.
For golangci-lint installation instructions see https://golangci-lint.run/usage/install/ For more information on the golangci-lint configuration file see https://golangci-lint.run/usage/configuration/ For more information on the linters used see https://golangci-lint.run/usage/linters/
To use vendor dependencies, the suggested GOPATH format is :
The following targets are available. Each may be run with make
.
Make Target | Description |
---|---|
build |
(Default) build builds the agent for Linux, Debian, Darwin and Windows amd64 and 386 environment |
build-release |
build-release checks code style and coverage, builds the agent and also packages it into a RPM, DEB and ZIP package |
release |
release checks code style and coverage, runs tests, packages all dependencies to the bin folder. |
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 |
analyze-install |
analyze-install install static analysis dependencies for local use |
analyze |
analyze runs static analysis script to find possible vulnerabilities |
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 using go 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 |
build-arm |
build-arm builds the agent for execution in the arm environment |
build-arm64 |
build-arm64 builds the agent for execution in the arm64 environment |
lint-all |
lint-all runs golangci-lint on all packages. golangci-lint is configured by .golangci.yml |
package-rpm |
package-rpm builds the agent and packages it into a RPM package for Linux amd64 based distributions |
package-deb |
package-deb builds the agent and packages it into a DEB package Debian amd64 based distributions |
package-win |
package-win builds the agent and packages it into a ZIP package Windows amd64 based distributions |
package-rpm-386 |
package-rpm-386 builds the agent and packages it into a RPM package for Linux 386 based distributions |
package-deb-386 |
package-deb-386 builds the agent and packages it into a DEB package Debian 386 based distributions |
package-win-386 |
package-win-386 builds the agent and packages it into a ZIP package Windows 386 based distributions |
package-rpm-arm64 |
package-rpm-arm64 builds the agent and packages it into a RPM package Linux arm64 based distributions |
package-deb-arm |
package-deb-arm builds the agent and packages it into a DEB package Debian arm based distributions |
package-deb-arm64 |
package-deb-arm64 builds the agent and packages it into a DEB package Debian arm64 based distributions |
package-linux |
package-linux create update packages for Linux and Debian based distributions |
package-windows |
package-windows create update packages for Windows based distributions |
package-darwin |
package-darwin create update packages for Darwin based distributions |
get-tools |
get-tools gets gocode and oracle using go get |
clean |
clean removes build artifacts |
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.
To set up your own custom configuration for the agent:
After the SSM Agent source code has been released to github, it can take up to 2 weeks for the install packages to propagate to all AWS regions.
The following commands can be used to pull the VERSION
file and check the latest agent available in a region.
curl https://s3.{region}.amazonaws.com/amazon-ssm-{region}/latest/VERSION
{region}
with region code like us-east-1
.curl https://s3.{region}.amazonaws.com.cn/amazon-ssm-{region}/latest/VERSION
{region}
with region code cn-north-1
, cn-northwest-1
.curl https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/VERSION
The Amazon SSM Agent is licensed under the Apache 2.0 License.