From 14fbd07186782e9f167e76bb77f9688ddb478c27 Mon Sep 17 00:00:00 2001 From: Jake Heath <76011913+jakeyheath@users.noreply.github.com> Date: Mon, 16 May 2022 11:54:23 -0700 Subject: [PATCH] chore: update readme (#395) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- README.md | 96 ++----------------------------------------------------- 1 file changed, 3 insertions(+), 93 deletions(-) diff --git a/README.md b/README.md index f2bee50d..40cb0171 100644 --- a/README.md +++ b/README.md @@ -4,101 +4,11 @@ Cztack (pronounced "stack") is CZI's collection of Terraform modules. We use the These modules are compatible with Terraform 0.12 and up. -## Design Principles - -More TODO here - -### Consistent Tagging - -We tag all applicable resources with 'owner', 'project', 'env', 'service' and 'managedBy'. - -## Modules - -### AWS Default VPC security - -This will name, tag, and optionall lock down AWS default VPCs. - -[Read More](aws-default-vpc-security/README.md) - -### AWS IAM ECS Task Role - -This creates a role for use with an ECS task, you bring your own policy and we create the role for you. - -[Read More](aws-iam-ecs-task-role/README.md) - -### AWS IAM Group assume-role - -This module with create and IAM group, add users to it and grant the grouop permission to assume a role. This is commonly used for cross-account access control. - -[Read More](aws-iam-group-assume-role/README.md) - -### AWS IAM Group console-login - -This will create a group, add users to it, and grant permission to log into the AWS console and manage one's own credentials. - -[Read More](aws-iam-group-console-login/README.md) - -### AWS IAM password policy - -This module will create a good password policy for your AWS account. - -[Read More](aws-iam-password-policy/README.md) - -### AWS IAM instance profile - -This module will create an EC2 instance profile, attaching to it a new IAM role with permissions to run standard system agents (Systems Manager Agent and Cloudwatch Logs Agent). - -[Read More](aws-iam-instance-profile/README.md) - -### AWS IAM cloudwatch logs policy - -This will create a policy that allow writing to cloudwatch logs. - -[Read More](aws-iam-policy-cwlogs/README.md) - -### AWS IAM poweruser role - -This will create a poweruser role, based off the AWS-managed "poweruser" policy, but with a few additions that we find useful. - -[Read More](aws-iam-poweruser/README.md) - -### AWS IAM Role Cloudfront poweruser - -This will create a role that gives "poweruser" level access to cloudfront. - -[Read More](aws-iam-role-cloudfront-poweruser/README.md) - -### AWS IAM Role ECS poweruser - -This will create a role that gives "poweruser" level access to ECS. - -[Read More](aws-iam-role-ecs-poweruser/README.md) - -### AWS IAM Role infraci - -This is a role we find useful for running CI jobs for terraform code. It is based on the AWS-managed policy for readonly, but includes a few additions, like the ability to read secrets. - -[Read More](aws-iam-role-infraci/README.md) - -### AWS IAM role readonly - -This creates a readonly role, based off the AWS-managed readonly policy, but with a few changes. - -[Read More](aws-iam-role-readonly/README.md) - -### AWS IAM role security-audit - -This creates a security-audit role, based off the AWS-managed policy, but with a few changes. - -[Read More](aws-iam-role-security-audit/README.md) - -### GitHub Webhooks to S3 - -Accept GitHub webhooks and store them in S3 +## Contributing -[Read More](github-webhooks-to-s3/README.md) +### Making a release -## Contributing +Release-please managages all the releases. To make a release, merge the release PR. ### Adding a new module