Skip to content

Commit

Permalink
Add catalog of SCPs (#5)
Browse files Browse the repository at this point in the history
* Add catalog of SCPs

* Update README.md

Co-authored-by: Erik Osterman <erik@cloudposse.com>

* Add catalog of SCPs

Co-authored-by: Erik Osterman <erik@cloudposse.com>
  • Loading branch information
aknysh and osterman committed Nov 17, 2020
1 parent f80f396 commit 19045da
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 7 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
-->

Terraform module to provision Service Control Policies (SCP) for AWS Organizations and Organizational Units.
Terraform module to provision Service Control Policies (SCP) for AWS Organizations, Organizational Units, and AWS accounts.


---
Expand Down Expand Up @@ -64,7 +64,9 @@ We literally have [*hundreds of terraform modules*][terraform_modules] that are

Service Control Policies are configured in YAML configuration files.

See [policies](examples/complete/policies) for Service Control Policies configuration examples.
We maintain a comprehensive [catalog](catalog) of SCP configurations and welcome contributions via pull request!

The [example](examples/complete) in this module uses the catalog to provision the SCPs on AWS.

## Usage

Expand All @@ -84,7 +86,7 @@ For automated tests of the complete example using [bats](https://github.com/bats
source = "git::https://github.com/cloudposse/terraform-yaml-config.git?ref=master"
list_config_local_base_path = path.module
list_config_paths = ["policies/*.yaml"]
list_config_paths = ["catalog/*.yaml"]
context = module.this.context
}
Expand Down
8 changes: 5 additions & 3 deletions README.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,15 @@ references:

# Short description of this project
description: |-
Terraform module to provision Service Control Policies (SCP) for AWS Organizations and Organizational Units.
Terraform module to provision Service Control Policies (SCP) for AWS Organizations, Organizational Units, and AWS accounts.
# Introduction to the project
introduction: |-
Service Control Policies are configured in YAML configuration files.
See [policies](examples/complete/policies) for Service Control Policies configuration examples.
We maintain a comprehensive [catalog](catalog) of SCP configurations and welcome contributions via pull request!
The [example](examples/complete) in this module uses the catalog to provision the SCPs on AWS.
# How to use this module. Should be an easy example to copy and paste.
usage: |-
Expand All @@ -107,7 +109,7 @@ usage: |-
source = "git::https://github.com/cloudposse/terraform-yaml-config.git?ref=master"
list_config_local_base_path = path.module
list_config_paths = ["policies/*.yaml"]
list_config_paths = ["catalog/*.yaml"]
context = module.this.context
}
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 2 additions & 0 deletions examples/complete/fixtures.us-east-2.tfvars
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ stage = "test"
name = "scp"

service_control_policy_description = "Test Service Control Policy"

service_control_policy_paths = ["../../catalog/*.yaml"]
2 changes: 1 addition & 1 deletion examples/complete/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ module "yaml_config" {
source = "git::https://github.com/cloudposse/terraform-yaml-config.git?ref=tags/0.1.0"

list_config_local_base_path = path.module
list_config_paths = ["policies/*.yaml"]
list_config_paths = var.service_control_policy_paths

context = module.this.context
}
Expand Down
5 changes: 5 additions & 0 deletions examples/complete/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,8 @@ variable "service_control_policy_description" {
default = null
description = "Description of the combined Service Control Policy"
}

variable "service_control_policy_paths" {
type = list(string)
description = "List of paths to Service Control Policy configurations"
}

0 comments on commit 19045da

Please sign in to comment.