Documentation
¶
Overview ¶
Package main represents the entry point of the agent.
Package main represents the entry point of the agent. Parser contains logic for commandline handling flags
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package appconfig manages the configuration of the agent.
|
Package appconfig manages the configuration of the agent. |
|
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 |
|
executer
Package executer allows execute Pending association and InProgress association
|
Package executer allows execute Pending association and InProgress association |
|
model
Package model provides model definition for association
|
Package model provides model definition for association |
|
parser
Package parser contains utilities for parsing and encoding MDS/SSM messages.
|
Package parser contains utilities for parsing and encoding MDS/SSM messages. |
|
processor
Package processor manage polling of associations, dispatching association to processor
|
Package processor manage polling of associations, dispatching association to processor |
|
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 |
|
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 |
|
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 |
|
scheduler
Package scheduler provides ability to create scheduled job
|
Package scheduler provides ability to create scheduled job |
|
service
Package service wraps SSM service
|
Package service wraps SSM service |
|
taskpool
Package taskpool wraps execution task pool and cancel task pool
|
Package taskpool wraps execution task pool and cancel task pool |
|
Package cli represents the entry point of the ssm agent cli.
|
Package cli represents the entry point of the ssm agent 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 |
|
cliutil
Package cliutil contains helper functions for cli and clicommand
|
Package cliutil contains helper functions for cli and clicommand |
|
Package main represents the entry point of the ssm agent cli.
|
Package main represents the entry point of the ssm agent cli. |
|
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. |
|
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. |
|
Package executers contains general purpose (shell) command executing objects.
|
Package executers contains general purpose (shell) command executing objects. |
|
Package fileutil contains utilities for working with the file system.
|
Package fileutil contains utilities for working with the file system. |
|
artifact
Package artifact contains utilities for working downloading files.
|
Package artifact contains utilities for working downloading files. |
|
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 modules
|
Package coremanager encapsulates the logic for configuring, starting and stopping core modules |
|
coremodules
Package coremodules contains a list of implemented core modules.
|
Package coremodules contains a list of implemented core modules. |
|
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. |
|
plugin
Package plugin contains general interfaces and types relevant to plugins.
|
Package plugin contains general interfaces and types relevant to plugins. |
|
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 |
|
Package health contains routines that periodically reports health information of the agent
|
Package health contains routines that periodically reports health information of the agent |
|
Package JobObject allows creation of job object for SSM agent process.
|
Package JobObject allows creation of job object for SSM agent process. |
|
Package jsonutil contains various utilities for dealing with json data.
|
Package jsonutil contains various utilities for dealing with json data. |
|
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 |
|
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 |
|
plugin
Package plugin contains all essential structs/interfaces for long running plugins
|
Package plugin contains all essential structs/interfaces for long running plugins |
|
plugin/cloudwatch
Package cloudwatch implements cloudwatch plugin and its configuration
|
Package cloudwatch implements cloudwatch plugin and its configuration |
|
managedInstances
|
|
|
auth
package auth provides methods to implement managed instances auth support
|
package auth provides methods to implement managed instances auth support |
|
registration
package registration provides managed instance information
|
package registration provides managed instance information |
|
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 |
|
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. |
|
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 |
|
parser
Package parser contains utilities for parsing and encoding MDS/SSM messages.
|
Package parser contains utilities for parsing and encoding MDS/SSM messages. |
|
processor
Package processor implements MDS plugin processor
|
Package processor implements MDS plugin processor |
|
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 |
|
Package parameters provides utilities to parse ssm document parameters
|
Package parameters provides utilities to parse ssm document parameters |
|
Package parameterstore contains modules to resolve ssm parameters present in the document.
|
Package parameterstore contains modules to resolve ssm parameters present in the document. |
|
Package platform provides instance information
|
Package platform provides instance information |
|
plugins
|
|
|
configurecontainers/windowscontainerutil
Package windowscontainerutil implements the the install and uninstall steps for windows for the configurecontainers plugin.
|
Package windowscontainerutil implements the the install and uninstall steps for windows for the configurecontainers plugin. |
|
configuredaemon
Package configuredaemon implements the ConfigureDaemon plugin.
|
Package configuredaemon implements the ConfigureDaemon plugin. |
|
configurepackage
Package configurepackage implements the ConfigurePackage plugin.
|
Package configurepackage implements the ConfigurePackage plugin. |
|
inventory
Package inventory contains implementation of aws:softwareInventory plugin
|
Package inventory contains implementation of aws:softwareInventory plugin |
|
inventory/datauploader
Package datauploader contains routines upload inventory data to SSM - Inventory service
|
Package datauploader contains routines upload inventory data to SSM - Inventory service |
|
inventory/gatherers
Package gatherers contains routines for different types of inventory gatherers
|
Package gatherers contains routines for different types of inventory gatherers |
|
inventory/gatherers/application
Package application contains a application gatherer.
|
Package application contains a application gatherer. |
|
inventory/gatherers/awscomponent
Package awscomponent contains a aws component gatherer.
|
Package awscomponent contains a aws component gatherer. |
|
inventory/gatherers/custom
Package custom contains a gatherer for collecting custom inventory items
|
Package custom contains a gatherer for collecting custom inventory items |
|
inventory/gatherers/network
Package network contains a network gatherer.
|
Package network contains a network gatherer. |
|
inventory/model
Package model contains contracts for inventory
|
Package model contains contracts for inventory |
|
lrpminvoker
Package lrpminvoker contains implementation of lrpm-invoker plugin.
|
Package lrpminvoker contains implementation of lrpm-invoker plugin. |
|
refreshassociation
Package refreshassociation implements the refreshassociation plugin.
|
Package refreshassociation implements the refreshassociation plugin. |
|
runscript
Package runscript implements the RunScript plugin.
|
Package runscript implements the RunScript plugin. |
|
updateec2config
Package updateec2config implements the UpdateEC2Config plugin.
|
Package updateec2config implements the UpdateEC2Config plugin. |
|
updatessmagent
Package updatessmagent implements the UpdateSsmAgent plugin.
|
Package updatessmagent implements the UpdateSsmAgent plugin. |
|
Package rebooter provides utilities used to reboot a machine.
|
Package rebooter provides utilities used to reboot a machine. |
|
Package reply provides utilities to parse reply payload
|
Package reply provides utilities to parse reply payload |
|
Package s3util contains methods for interacting with S3.
|
Package s3util contains methods for interacting with S3. |
|
generator
Usage: go run riputil-gen.go
|
Usage: go run riputil-gen.go |
|
Package sdkutil provides utilities used to call awssdk.
|
Package sdkutil provides utilities used to call awssdk. |
|
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 |
|
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. |
|
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. |
|
util
Package util contains helper function common for ssm service
|
Package util contains helper function common for ssm service |
|
Package startup implements startup plugin processor
|
Package startup implements startup plugin processor |
|
model
Package model provides model definition for startup processor
|
Package model provides model definition for startup processor |
|
serialport
Package serialport implements serial port capabilities
|
Package serialport implements serial port capabilities |
|
Package statemanager helps persist documents state to disk
|
Package statemanager helps persist documents state to disk |
|
model
Package model provides model definitions for document state
|
Package model provides model definitions for document state |
|
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. |
|
Package test contains functions used for tests.
|
Package test contains functions used for tests. |
|
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. |
|
updater
Package main represents the entry point of the ssm agent updater.
|
Package main represents the entry point of the ssm agent updater. |
|
Package updateutil contains updater specific utilities.
|
Package updateutil contains updater specific utilities. |
|
Package vault provide interface for data storage.
|
Package vault provide interface for data storage. |
|
fsvault
Package fsvault implements vault with file system storage.
|
Package fsvault implements vault with file system storage. |
|
Package version contains constants to indicate the current version of the agent.
|
Package version contains constants to indicate the current version of the agent. |
Click to show internal directories.
Click to hide internal directories.