amazon-ssm-agent

module

v0.0.0-...-7638cb1 Latest Latest Go to latest Published: Jan 18, 2017 License: Apache-2.0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ardeshir/amazon-ssm-agent

Links

Open Source Insights

README ¶

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 SSM Agent and Run Command enable you to quickly run Shell scripts on an instance using the AWS-RunShellScript SSM document.

Verify Requirements

SSM Run Command Prerequisites

Setup

Executing Commands

SSM Run Command Walkthrough Using the AWS CLI

Troubleshooting

Troubleshooting SSM Run Command

Feedback

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

Building and Running from source

Install go Getting started
Install rpm-build

sudo yum install -y rpmdevtools rpm-build

Cross Complile 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

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 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
`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.

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
Tools
src/goreportcard
agent Package main represents the entry point of the agent.	Package main represents the entry point of the agent.
appconfig Package appconfig manages the configuration of the agent.	Package appconfig manages the configuration of the agent.
association/cache
association/converter Package converter converts the plugin information from version 1.0 and 1.2 to version 2.0	Package converter converts the plugin information from version 1.0 and 1.2 to version 2.0
association/executer Package executer allows execute Pending association and InProgress association	Package executer allows execute Pending association and InProgress association
association/model Package model provides model definition for association	Package model provides model definition for association
association/parser Package parser contains utilities for parsing and encoding MDS/SSM messages.	Package parser contains utilities for parsing and encoding MDS/SSM messages.
association/processor Package processor manage polling of associations, dispatching association to processor	Package processor manage polling of associations, dispatching association to processor
association/recorder Package recorder records the association name of the last executed association to avoid duplicate execution	Package recorder records the association name of the last executed association to avoid duplicate execution
association/schedulemanager Package schedulemanager schedules association and submits the association to the task pool schedulemanager is a singleton so it can be access at the plugin level	Package schedulemanager schedules association and submits the association to the task pool schedulemanager is a singleton so it can be access at the plugin level
association/schedulemanager/signal Package signal manages signal channel required by sending/receiving request for executing scheduled association	Package signal manages signal channel required by sending/receiving request for executing scheduled association
association/scheduler Package scheduler provides ability to create scheduled job	Package scheduler provides ability to create scheduled job
association/service Package service wraps SSM service	Package service wraps SSM service
association/taskpool Package taskpool wraps execution task pool and cancel task pool	Package taskpool wraps execution task pool and cancel task pool
cli Package cli represents the entry point of the ssm agent cli.	Package cli represents the entry point of the ssm agent cli.
cli-main Package main represents the entry point of the ssm agent cli.	Package main represents the entry point of the ssm agent cli.
cli/clicommand Package clicommand contains the implementation of all commands for the ssm agent cli	Package clicommand contains the implementation of all commands for the ssm agent cli
cli/cliutil Package cliutil contains helper functions for cli and clicommand	Package cliutil contains helper functions for cli and clicommand
context Package context defines a type that carries context specific data such as the logger.	Package context defines a type that carries context specific data such as the logger.
contracts Package contracts contains all necessary interface and models necessary for communication and sharing within the agent.	Package contracts contains all necessary interface and models necessary for communication and sharing within the agent.
executers Package executers contains general purpose (shell) command executing objects.	Package executers contains general purpose (shell) command executing objects.
fileutil Package fileutil contains utilities for working with the file system.	Package fileutil contains utilities for working with the file system.
fileutil/artifact Package artifact contains utilities for working downloading files.	Package artifact contains utilities for working downloading files.
fingerprint Package fingerprint contains functions that helps identify an instance this is done to protect customers from launching two instances with the same instance identifier and thus running commands intended for one on the other	Package fingerprint contains functions that helps identify an instance this is done to protect customers from launching two instances with the same instance identifier and thus running commands intended for one on the other
framework/coremanager Package coremanager encapsulates the logic for configuring, starting and stopping core plugins	Package coremanager encapsulates the logic for configuring, starting and stopping core plugins
framework/coreplugins Package coreplugins contains a list of implemented core plugins.	Package coreplugins contains a list of implemented core plugins.
framework/engine Package engine contains the general purpose plugin runner of the plugin framework.	Package engine contains the general purpose plugin runner of the plugin framework.
framework/plugin Package plugin contains general interfaces and types relevant to plugins.	Package plugin contains general interfaces and types relevant to plugins.
framework/runpluginutil Package runpluginutil provides interfaces for running plugins that can be referenced by other plugins and a utility method for parsing documents	Package runpluginutil provides interfaces for running plugins that can be referenced by other plugins and a utility method for parsing documents
health Package health contains routines that periodically reports health information of the agent	Package health contains routines that periodically reports health information of the agent
integration-cli
jobobject Package JobObject allows creation of job object for SSM agent process.	Package JobObject allows creation of job object for SSM agent process.
jsonutil Package jsonutil contains various utilities for dealing with json data.	Package jsonutil contains various utilities for dealing with json data.
log Package log is used to initialize the logger.	Package log is used to initialize the logger.
longrunning/datastore Package datastore has utilites to read and write from long running plugins data-store	Package datastore has utilites to read and write from long running plugins data-store
longrunning/manager Package manager encapsulates everything related to long running plugin manager that starts, stops & configures long running plugins	Package manager encapsulates everything related to long running plugin manager that starts, stops & configures long running plugins
longrunning/plugin Package plugin contains all essential structs/interfaces for long running plugins	Package plugin contains all essential structs/interfaces for long running plugins
longrunning/plugin/cloudwatch Package cloudwatch implements cloudwatch plugin and its configuration	Package cloudwatch implements cloudwatch plugin and its configuration
longrunning/plugin/rundaemon
managedInstances/auth package auth provides methods to implement managed instances auth support	package auth provides methods to implement managed instances auth support
managedInstances/registration package registration provides managed instance information	package registration provides managed instance information
managedInstances/rolecreds package rolecreds contains functions that help procure the managed instance auth credentials dependencies	package rolecreds contains functions that help procure the managed instance auth credentials dependencies
managedInstances/sharedCredentials package sharedCredentials provides access to the aws shared credentials file.	package sharedCredentials provides access to the aws shared credentials file.
message/contracts Package model contains message struct for MDS/SSM messages.	Package model contains message struct for MDS/SSM messages.
message/converter Package converter converts the plugin state from version 1.0 and 1.2 to version 2.0	Package converter converts the plugin state from version 1.0 and 1.2 to version 2.0
message/parser Package parser contains utilities for parsing and encoding MDS/SSM messages.	Package parser contains utilities for parsing and encoding MDS/SSM messages.
message/processor Package processor implements MDS plugin processor	Package processor implements MDS plugin processor
message/service Package service is a wrapper for the SSM Message Delivery Service and Offline Command Service	Package service is a wrapper for the SSM Message Delivery Service and Offline Command Service
parameters Package parameters provides utilities to parse ssm document parameters	Package parameters provides utilities to parse ssm document parameters
parameterstore Package parameterstore contains modules to resolve ssm parameters present in the document.	Package parameterstore contains modules to resolve ssm parameters present in the document.
platform Package platform provides instance information	Package platform provides instance information
plugins/application
plugins/configurecontainers
plugins/configuredaemon Package configuredaemon implements the ConfigureDaemon plugin.	Package configuredaemon implements the ConfigureDaemon plugin.
plugins/configurepackage Package configurepackage implements the ConfigurePackage plugin.	Package configurepackage implements the ConfigurePackage plugin.
plugins/dockercontainer
plugins/domainjoin
plugins/inventory Package inventory contains implementation of aws:softwareInventory plugin	Package inventory contains implementation of aws:softwareInventory plugin
plugins/inventory/datauploader Package datauploader contains routines upload inventory data to SSM - Inventory service	Package datauploader contains routines upload inventory data to SSM - Inventory service
plugins/inventory/gatherers Package gatherers contains routines for different types of inventory gatherers	Package gatherers contains routines for different types of inventory gatherers
plugins/inventory/gatherers/application Package application contains a application gatherer.	Package application contains a application gatherer.
plugins/inventory/gatherers/awscomponent Package awscomponent contains a aws component gatherer.	Package awscomponent contains a aws component gatherer.
plugins/inventory/gatherers/custom Package custom contains a gatherer for collecting custom inventory items	Package custom contains a gatherer for collecting custom inventory items
plugins/inventory/gatherers/network Package network contains a network gatherer.	Package network contains a network gatherer.
plugins/inventory/gatherers/windowsUpdate
plugins/inventory/model Package model contains contracts for inventory	Package model contains contracts for inventory
plugins/lrpminvoker Package lrpminvoker contains implementation of lrpm-invoker plugin.	Package lrpminvoker contains implementation of lrpm-invoker plugin.
plugins/pluginutil
plugins/psmodule
plugins/refreshassociation Package refreshassociation implements the refreshassociation plugin.	Package refreshassociation implements the refreshassociation plugin.
plugins/runscript Package runscript implements the RunScript plugin.	Package runscript implements the RunScript plugin.
plugins/updateec2config Package updateec2config implements the UpdateEC2Config plugin.	Package updateec2config implements the UpdateEC2Config plugin.
plugins/updatessmagent Package updatessmagent implements the UpdateSsmAgent plugin.	Package updatessmagent implements the UpdateSsmAgent plugin.
rebooter Package rebooter provides utilities used to reboot a machine.	Package rebooter provides utilities used to reboot a machine.
reply Package reply provides utilities to parse reply payload	Package reply provides utilities to parse reply payload
s3util Package s3util contains utilities for working with the file system.	Package s3util contains utilities for working with the file system.
sdkutil Package sdkutil provides utilities used to call awssdk.	Package sdkutil provides utilities used to call awssdk.
sdkutil/retryer Package retryer overrides the default aws sdk retryer delay logic to better suit the mds needs	Package retryer overrides the default aws sdk retryer delay logic to better suit the mds needs
ssm
ssm/anonauth Package anonauth is an interface to the anonymous methods of the SSM service.	Package anonauth is an interface to the anonymous methods of the SSM service.
ssm/rsaauth Package rsaauth is an interface to the RSA signed methods of the SSM service.	Package rsaauth is an interface to the RSA signed methods of the SSM service.
ssm/util Package util contains helper function common for ssm service	Package util contains helper function common for ssm service
startup Package startup implements startup plugin processor	Package startup implements startup plugin processor
startup/model Package model provides model definition for startup processor	Package model provides model definition for startup processor
startup/serialport Package serialport implements serial port capabilities	Package serialport implements serial port capabilities
statemanager Package statemanager helps persist documents state to disk	Package statemanager helps persist documents state to disk
statemanager/model Package model provides model definitions for document state	Package model provides model definitions for document state
task Package task contains a default implementation of the interfaces in the task package.	Package task contains a default implementation of the interfaces in the task package.
test Package test contains functions used for tests.	Package test contains functions used for tests.
times Package times provides a set of utilities related to processing time.	Package times provides a set of utilities related to processing time.
update/processor Package processor contains the methods for update ssm agent.	Package processor contains the methods for update ssm agent.
update/updater Package main represents the entry point of the ssm agent updater.	Package main represents the entry point of the ssm agent updater.
updateutil Package updateutil contains updater specific utilities.	Package updateutil contains updater specific utilities.
vault Package vault provide interface for data storage.	Package vault provide interface for data storage.
vault/fsvault Package fsvault implements vault with file system storage.	Package fsvault implements vault with file system storage.
version Package version contains constants to indicate the current version of the agent.	Package version contains constants to indicate the current version of the agent.
version/versiongenerator