Skip to content

Commit 3ea6a24

Browse files
committed
Auto-generate docs for release v0.21.3 [ci skip]
1 parent 29edbe9 commit 3ea6a24

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+356
-250
lines changed

Diff for: README.adoc

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
**Note**: This public repo contains the documentation for the private GitHub repo <https://github.com/gruntwork-io/module-security>.
2+
We publish the documentation publicly so it turns up in online searches, but to see the source code, you must be a Gruntwork customer.
3+
If you're already a Gruntwork customer, the original source for this file is at: <https://github.com/gruntwork-io/module-security/blob/master/README.adoc>.
4+
If you're not a customer, contact us at <info@gruntwork.io> or <http://www.gruntwork.io> for info on how to get access!

Diff for: README.md

-124
This file was deleted.

Diff for: _docs/auto-update.png

11.6 KB
Loading

Diff for: _docs/aws-cloudtrail-architecture.png

78.9 KB
Loading

Diff for: _docs/aws-cloudtrail.png

4.51 KB
Loading

Diff for: _docs/aws-config-architecture.png

85.4 KB
Loading

Diff for: _docs/aws-config-rules-architecture.png

56.4 KB
Loading

Diff for: _docs/aws-config-rules.png

9.39 KB
Loading

Diff for: _docs/aws-config.png

7.71 KB
Loading

Diff for: _docs/aws-organizations-architecture.png

80.3 KB
Loading

Diff for: _docs/aws-organizations-icon.png

9.39 KB
Loading

Diff for: _docs/ssh-grunt-architecture.png

68.4 KB
Loading

Diff for: _docs/terminal-icon.png

493 KB
Loading

Diff for: examples/aws-config/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ If you're not a customer, contact us at <[email protected]> or <http://www.grunt
55

66
# AWS Config Example
77

8-
This is an example of how to use the [config module](/modules/config) to enable AWS Config on your AWS account.
8+
This is an example of how to use the [aws-config module](/modules/aws-config) to enable AWS Config on your AWS account.
99

1010
This example enables Config in a single region by creating an S3 bucket, an SNS topic, an IAM role with the necessary permissions, and the Config resources to put it all together.
1111

Diff for: examples/aws-organizations-config-rules/README.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
**Note**: This public repo contains the documentation for the private GitHub repo <https://github.com/gruntwork-io/module-security>.
2+
We publish the documentation publicly so it turns up in online searches, but to see the source code, you must be a Gruntwork customer.
3+
If you're already a Gruntwork customer, the original source for this file is at: <https://github.com/gruntwork-io/module-security/blob/master/examples/aws-organizations-config-rules/README.md>.
4+
If you're not a customer, contact us at <[email protected]> or <http://www.gruntwork.io> for info on how to get access!
5+
6+
# AWS Organization Config Rules Example
7+
8+
This is an example of how to use the [aws-organizations-config-rules module](/modules/aws-organizations-config-rules) to
9+
enable a set of best practices AWS Config Managed rules on your AWS Organization.
10+
11+
**NOTE:** You will have to apply the changes on your Organization root account.
12+
13+
## Quick start
14+
15+
To try these templates out you must have Terraform installed:
16+
17+
1. Open `variables.tf` and fill in any variables that don't have a default.
18+
1. Run `terraform init` to instruct Terraform to perform initialization steps.
19+
1. Run `terraform plan` to confirm that Terraform will create what looks like a reasonable set of resources.
20+
1. Run `terraform apply` to enable Config rules.
21+
1. Now log into the AWS Web Console, go to the Config console, and within a few minutes resources should start to appear.

Diff for: examples/aws-organizations-config-rules/main.tf

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# **Note**: This public repo contains the documentation for the private GitHub repo <https://github.com/gruntwork-io/module-security>.
2+
# We publish the documentation publicly so it turns up in online searches, but to see the source code, you must be a Gruntwork customer.
3+
# If you're already a Gruntwork customer, the original source for this file is at: <https://github.com/gruntwork-io/module-security/blob/master/examples/aws-organizations-config-rules/main.tf>.
4+
# If you're not a customer, contact us at <[email protected]> or <http://www.gruntwork.io> for info on how to get access!

Diff for: examples/aws-organizations-config-rules/outputs.tf

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# **Note**: This public repo contains the documentation for the private GitHub repo <https://github.com/gruntwork-io/module-security>.
2+
# We publish the documentation publicly so it turns up in online searches, but to see the source code, you must be a Gruntwork customer.
3+
# If you're already a Gruntwork customer, the original source for this file is at: <https://github.com/gruntwork-io/module-security/blob/master/examples/aws-organizations-config-rules/outputs.tf>.
4+
# If you're not a customer, contact us at <[email protected]> or <http://www.gruntwork.io> for info on how to get access!

Diff for: examples/aws-organizations-config-rules/variables.tf

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# **Note**: This public repo contains the documentation for the private GitHub repo <https://github.com/gruntwork-io/module-security>.
2+
# We publish the documentation publicly so it turns up in online searches, but to see the source code, you must be a Gruntwork customer.
3+
# If you're already a Gruntwork customer, the original source for this file is at: <https://github.com/gruntwork-io/module-security/blob/master/examples/aws-organizations-config-rules/variables.tf>.
4+
# If you're not a customer, contact us at <[email protected]> or <http://www.gruntwork.io> for info on how to get access!

Diff for: examples/aws-organizations/README.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
**Note**: This public repo contains the documentation for the private GitHub repo <https://github.com/gruntwork-io/module-security>.
2+
We publish the documentation publicly so it turns up in online searches, but to see the source code, you must be a Gruntwork customer.
3+
If you're already a Gruntwork customer, the original source for this file is at: <https://github.com/gruntwork-io/module-security/blob/master/examples/aws-organizations/README.md>.
4+
If you're not a customer, contact us at <[email protected]> or <http://www.gruntwork.io> for info on how to get access!
5+
6+
# AWS Organizations Example
7+
8+
This is an example of how to use the [aws-organizations module](/modules/aws-organizations) to create an Organization and
9+
child accounts.
10+
11+
This example uses an existing organization and adds two child accounts to it.
12+
13+
**NOTE:** Destroying the example or removing entries from `child_accounts` will only remove an AWS account from an organization.
14+
Terraform **will not close the account**. The member account must be prepared to be a standalone account beforehand.
15+
See the [AWS Organizations documentation](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html)
16+
for more information.
17+
18+
## Quick start
19+
20+
To try these templates out you must have Terraform installed:
21+
22+
1. Open `variables.tf` and fill in any variables that don't have a default.
23+
1. Run `terraform init` to instruct Terraform to perform initialization steps.
24+
1. Run `terraform plan` to confirm that Terraform will create what looks like a reasonable set of resources.
25+
1. Run `terraform apply`.
26+
1. Now log into the AWS Web Console, go to the Organizations console, and locate your new child accounts.

Diff for: examples/aws-organizations/main.tf

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# **Note**: This public repo contains the documentation for the private GitHub repo <https://github.com/gruntwork-io/module-security>.
2+
# We publish the documentation publicly so it turns up in online searches, but to see the source code, you must be a Gruntwork customer.
3+
# If you're already a Gruntwork customer, the original source for this file is at: <https://github.com/gruntwork-io/module-security/blob/master/examples/aws-organizations/main.tf>.
4+
# If you're not a customer, contact us at <[email protected]> or <http://www.gruntwork.io> for info on how to get access!

Diff for: examples/aws-organizations/outputs.tf

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# **Note**: This public repo contains the documentation for the private GitHub repo <https://github.com/gruntwork-io/module-security>.
2+
# We publish the documentation publicly so it turns up in online searches, but to see the source code, you must be a Gruntwork customer.
3+
# If you're already a Gruntwork customer, the original source for this file is at: <https://github.com/gruntwork-io/module-security/blob/master/examples/aws-organizations/outputs.tf>.
4+
# If you're not a customer, contact us at <[email protected]> or <http://www.gruntwork.io> for info on how to get access!

Diff for: examples/aws-organizations/variables.tf

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# **Note**: This public repo contains the documentation for the private GitHub repo <https://github.com/gruntwork-io/module-security>.
2+
# We publish the documentation publicly so it turns up in online searches, but to see the source code, you must be a Gruntwork customer.
3+
# If you're already a Gruntwork customer, the original source for this file is at: <https://github.com/gruntwork-io/module-security/blob/master/examples/aws-organizations/variables.tf>.
4+
# If you're not a customer, contact us at <[email protected]> or <http://www.gruntwork.io> for info on how to get access!

Diff for: modules/auto-update/README.adoc

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
**Note**: This public repo contains the documentation for the private GitHub repo <https://github.com/gruntwork-io/module-security>.
2+
We publish the documentation publicly so it turns up in online searches, but to see the source code, you must be a Gruntwork customer.
3+
If you're already a Gruntwork customer, the original source for this file is at: <https://github.com/gruntwork-io/module-security/blob/master/modules/auto-update/README.adoc>.
4+
If you're not a customer, contact us at <info@gruntwork.io> or <http://www.gruntwork.io> for info on how to get access!

Diff for: modules/auto-update/README.md renamed to modules/auto-update/core-concepts.md

+5-16
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,13 @@
11
**Note**: This public repo contains the documentation for the private GitHub repo <https://github.com/gruntwork-io/module-security>.
22
We publish the documentation publicly so it turns up in online searches, but to see the source code, you must be a Gruntwork customer.
3-
If you're already a Gruntwork customer, the original source for this file is at: <https://github.com/gruntwork-io/module-security/blob/master/modules/auto-update/README.md>.
3+
If you're already a Gruntwork customer, the original source for this file is at: <https://github.com/gruntwork-io/module-security/blob/master/modules/auto-update/core-concepts.md>.
44
If you're not a customer, contact us at <[email protected]> or <http://www.gruntwork.io> for info on how to get access!
55

6-
# Auto Update Module
6+
# Auto Update Core Concepts
77

8-
This module can configure a Linux server to automatically install security updates. This module currently supports:
8+
## Installation
99

10-
* Ubuntu 14.04/16.04 (using [unattended-upgrades](https://help.ubuntu.com/lts/serverguide/automatic-updates.html))
11-
* Amazon Linux, Amazon Linux 2, and CentOS (using [yum-cron](http://man7.org/linux/man-pages/man8/yum-cron.8.html)).
12-
13-
## How do you use this module?
14-
15-
#### Example
16-
17-
See the [auto-update example](/examples/auto-update) for an example of how to use this module.
18-
19-
#### Installation
20-
21-
To use this module, you just need to:
10+
To use this module, you need to:
2211

2312
1. Install [bash-commons](https://github.com/gruntwork-io/bash-commons) on your servers.
2413
1. Install and run the `configure-auto-update` script on your servers.
@@ -34,7 +23,7 @@ gruntwork-install --module-name bash-commons --tag <BASH_COMMONS_VERSION> --repo
3423
gruntwork-install --module-name auto-update --tag <MODULE_SECURITY_VERSION> --repo https://github.com/gruntwork-io/module-security
3524
```
3625

37-
#### Ubuntu support
26+
## Ubuntu support
3827

3928
On Ubuntu, we use [unattended-upgrades](https://help.ubuntu.com/lts/serverguide/automatic-updates.html) to
4029
automatically install updates. A cron job runs `unattended-upgrades` once per day. Our default configuration is as

Diff for: modules/aws-config/README.adoc

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
**Note**: This public repo contains the documentation for the private GitHub repo <https://github.com/gruntwork-io/module-security>.
2+
We publish the documentation publicly so it turns up in online searches, but to see the source code, you must be a Gruntwork customer.
3+
If you're already a Gruntwork customer, the original source for this file is at: <https://github.com/gruntwork-io/module-security/blob/master/modules/aws-config/README.adoc>.
4+
If you're not a customer, contact us at <info@gruntwork.io> or <http://www.gruntwork.io> for info on how to get access!

0 commit comments

Comments
 (0)