Skip to content

Commit 796e160

Browse files
committed
Add the README for this role.
1 parent 3de319f commit 796e160

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
Restless-ET.aws-scripts-mon
2+
=========
3+
4+
An Ansible role for installing and configuring the Amazon CloudWatch Monitoring Scripts for Amazon Elastic Compute Cloud (Amazon EC2).
5+
6+
Followed instructions from [Monitoring Memory and Disk Metrics for Amazon EC2 Linux Instances](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/mon-scripts.html).
7+
8+
Requirements
9+
------------
10+
11+
Nothing worth mentioning ...
12+
13+
Role Variables
14+
--------------
15+
16+
- `aws_scripts_mon_version` - The version of monitoring scripts to install. Defaults to: `1.2.1`
17+
- `aws_scripts_mon_base_directory` - The base directory where the scripts will be installed. Defaults to: `/opt`
18+
- `aws_scripts_mon_cron_user` - The user for which the scripts will run as. Defaults to: `{{ ansible_user }}`
19+
- `aws_scripts_mon_options` - The monitoring script options (`--from-cron` is always assumed). Defaults to: `"--disk-space-util --disk-path=/"`.
20+
- `aws_scripts_mon_access_key` - Your AWS Access Key. You need to define this or the role will fail to execute.
21+
- `aws_scripts_mon_secret_key` - Your AWS Secret Key. You need to define this or the role will fail to execute.
22+
23+
24+
Dependencies
25+
------------
26+
27+
No dependecies. :-)
28+
29+
Example Playbook
30+
----------------
31+
32+
Add `Restless-ET.aws-scripts-mon` to your roles in your playbook. E.g.:
33+
34+
- hosts: aws_ec2_instances
35+
roles:
36+
- { role: Restless-ET.aws-scripts-mon,
37+
aws_scripts_mon_access_key: YourAccessKeyID,
38+
aws_scripts_mon_secret_key: YourSecretAccessKey
39+
}
40+
41+
License
42+
-------
43+
44+
MIT
45+
46+
Author Information
47+
------------------
48+
49+
Artur Melo

0 commit comments

Comments
 (0)