Skip to content

Commit

Permalink
examples: include README and more comments on the org-config
Browse files Browse the repository at this point in the history
  • Loading branch information
dschofie committed Jun 5, 2024
1 parent 5788dbc commit 8758861
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
8 changes: 8 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Examples
The examples directory contains example Cloudformation, terraform and CDK code that can be referenced in an organization.yml

## organization-config-everywhere.yml
`organization-config-everywhere.yml` stands up an example Org structure where:
- Applies delegated admin to the Audit account.
- Provisions an organization-wide config aggregator in the Audit account.
- AWS Config is enabled in every region of every telophase managed Account.
8 changes: 6 additions & 2 deletions examples/organization-config-everywhere.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
Organization:

# All OUs/accounts will inherit these stacks.
# All OUs/accounts will inherit these stacks and apply to every account.
Stacks:
# This stack creates an S3 bucket and dynamo DB table in every account.
- Type: "Cloudformation"
Path: "cloudformation/s3/bucket.yml"
Name: "s3-remote-state-terraform"
CloudformationCapabilities:
- "CAPABILITY_NAMED_IAM"

# This stack enables AWS config in every region in every account.
- Type: "Cloudformation"
- Type: "Terraform"
Path: "tf/awsconfig"
Name: "AWS-Config-Every-Region"
Expand All @@ -17,10 +19,12 @@ Organization:
Accounts:
- Email: [email protected]
AccountName: Audit
# This account will have config and config-multiaccountsetup delegated.
DelegatedAdministratorServices:
- "config.amazonaws.com"
- "config-multiaccountsetup.amazonaws.com"
Stacks:
# This stack creates the aggregator for the organization in the delegated admin account.
- Type: "Terraform"
Path: "tf/configaggregator"
Name: "aggregator"
Expand Down

0 comments on commit 8758861

Please sign in to comment.