ssm_agent

Table of Contents

1. Description
2. Setup - The basics of getting started with ssm_agent
   • Beginning with ssm_agent
3. Usage - Configuration options and additional functionality
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module

Description

The ssm agent module installs, configures, and manages the AWS ssm agent service across a range of operating systems and distributions.

Setup

Beginning with ssm_agent

include '::ssm_agent' is enough to get you up and running. To pass in parameters specifying which download url to use:

class { '::ssm_agent':
  ssm_agent_url => 'https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/debian_amd64/amazon-ssm-agent.deb',
}

Usage

All parameters for the ntp module are contained within the main ::ssm_agent class, so for any function of the module, set the options you want. See the common usages below for examples.

Install and enable SSM Agent

include '::ssm_agent'

Change SSM Agent download package

class { '::ssm_agent':
  ssm_agent_url => 'https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/debian_amd64/amazon-ssm-agent.deb',
}

Configuring SSM Agent to Use a Proxy

class { '::ssm_agent':
  http_proxy  => 'http://change.proxy.com:3128',
  no_proxy    => '169.254.169.254',
}

Reference

Classes

Public classes

• ssm_agent: Main class, includes all other classes.

Private classes

• ssm_agent::install: Handles the packages.
• ssm_agent::config: Handles the configuration file.
• ssm_agent::service: Handles the service.

Parameters

The following parameters are available in the ::ssm_agent class:

ssm_agent_download_url

Optional.

Data type: String.

The ssm agent download url

Default value: https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/$OS_VER/amazon-ssm-agent.{dev,rpm}.

proxy_install_manage

Optional.

Data type: Boolean.

Enables the use of agents to download the source code

Default value: false

proxy_install_manage_timeout

Optional.

Data type: String.

Connect timeout use of agents to download the source code

Default value: 3

Limitations

This module has been tested platform on:

• Red Hat Enterprise Linux (RHEL) 6, 7
• CentOS 6, 7
• Debian 6, 7
• Ubuntu 16.04

Development

Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. Please follow our guidelines when contributing changes.

For more information, see our module contribution guide.

Contributors

To see who's already involved, see the list of contributors.