Skip to content

Commit 03eb6df

Browse files
Merge pull request #56 from ModusCreateOrg/more-docs
Add gauntlt to readme. Also fixes #38
2 parents 9892942 + 7266598 commit 03eb6df

File tree

3 files changed

+28
-33
lines changed

3 files changed

+28
-33
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ You will need to create an application in the Google developer console, create a
5656

5757
### Packer
5858

59-
Run `packer/bin/pack.sh` to initiate a Packer run. This will provision a machine on EC2, configure it using Ansible, and scan it using OpenSCAP. The results from the scan will end up in `packer/build`.
59+
Run `packer/bin/pack.sh` to initiate a Packer run. This will provision a machine on EC2, configure it using Ansible, and scan it using [OpenSCAP](https://www.open-scap.org/) and [Gauntlt](http://gauntlt.org/). The results from the scan will end up in `packer/build`.
6060

6161
Optionally, you can use Vagrant to test ansible playbooks locally and Jenkins to orchestrate creation of AMIs in conjunction with GitHub branches and pull requests.
6262

@@ -136,6 +136,8 @@ The scripts here assume that Jenkins is running on EC2 and uses instance data fr
136136

137137
This script relies on Jenkins having a secret file containing the Google application credentials in JSON with the id `terraform-demo.json`. You will need to add that to your Jenkins server's credentials.
138138

139+
After a sucessful build, Jenkins will archive the artifacts from the OpenSCAP and Gauntlt scans (if a Packer run has completed) and JMeter (if a JMeter run has completed).
140+
139141
# Modus Create
140142

141143
[Modus Create](https://moduscreate.com) is a digital product consultancy. We use a distributed team of the best talent in the world to offer a full suite of digital product design-build services; ranging from consumer facing apps, to digital migration, to agile development training, and business transformation.
Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,44 @@
11
Role Name
22
=========
33

4-
A brief description of the role goes here.
4+
Set up the AWS CloudWatch agent and capture some basic log files.
55

66
Requirements
77
------------
88

9-
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
9+
A working AWS account. The config file included is suitable for CentOS 7 and an instance running on EC2.
1010

1111
Role Variables
1212
--------------
1313

14-
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
14+
N/A
1515

1616
Dependencies
1717
------------
1818

19-
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
19+
This role stands alone and has no dependencies.
2020

2121
Example Playbook
2222
----------------
2323

24-
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
24+
Here is an example playbook:
2525

2626
- hosts: servers
27+
become: yes
2728
roles:
28-
- { role: username.rolename, x: 42 }
29+
- cloudwatch-agent
2930

3031
License
3132
-------
3233

33-
BSD
34+
MIT
3435

3536
Author Information
3637
------------------
3738

38-
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
39+
Copyright © 2019 Modus Create, Inc.
40+
41+
* Madalin Borodi (@MadalinBorodi)
42+
* Richard Bullington-McGuire (@obscurerichard) <richard@moduscreate.com>
43+
44+

ansible/roles/cloudwatch-agent/meta/main.yml

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
galaxy_info:
2-
author: your name
3-
description: your description
4-
company: your company (optional)
2+
author: Richard Bullington-McGuire (@obscurerichard) <richard@moduscreate.com>
3+
description: CloudWatch agent role
4+
company: Modus Create, Inc.
55

66
# If the issue tracker for your role is not on github, uncomment the
77
# next line and provide a value
@@ -14,30 +14,17 @@ galaxy_info:
1414
# - GPL-3.0-only
1515
# - Apache-2.0
1616
# - CC-BY-4.0
17-
license: license (GPL-2.0-or-later, MIT, etc)
17+
license: MIT
1818

1919
min_ansible_version: 2.4
2020

21-
# If this a Container Enabled role, provide the minimum Ansible Container version.
22-
# min_ansible_container_version:
23-
24-
#
25-
# Provide a list of supported platforms, and for each platform a list of versions.
26-
# If you don't wish to enumerate all versions for a particular platform, use 'all'.
27-
# To view available platforms and versions (or releases), visit:
28-
# https://galaxy.ansible.com/api/v1/platforms/
29-
#
30-
# platforms:
31-
# - name: Fedora
32-
# versions:
33-
# - all
34-
# - 25
35-
# - name: SomePlatform
36-
# versions:
37-
# - all
38-
# - 1.0
39-
# - 7
40-
# - 99.99
21+
platforms:
22+
- name: CentOs
23+
versions:
24+
- 7
25+
- name: RHEL
26+
versions:
27+
- 7
4128

4229
galaxy_tags: []
4330
# List tags for your role here, one per line. A tag is a keyword that describes

0 commit comments

Comments
 (0)