-
-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(readme): migrate to yaml format (#8)
* refactor(readme): migrate to yaml format
- Loading branch information
1 parent
788e98b
commit 2047a8f
Showing
7 changed files
with
289 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,3 +6,5 @@ | |
| .terraform/ | ||
| .idea | ||
| terraform-aws-cloudtrail.iml | ||
| .build-harness | ||
| build-harness | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,10 @@ | ||
| SHELL := /bin/bash | ||
|
|
||
| # List of targets the `readme` target should call before generating the readme | ||
| export README_DEPS ?= docs/targets.md docs/terraform.md | ||
|
|
||
| -include $(shell curl -sSL -o .build-harness "https://git.io/build-harness"; echo .build-harness) | ||
|
|
||
| ## Lint terraform code | ||
| lint: | ||
| $(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate | ||
| $(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,9 @@ | ||
| # terraform-aws-cloudtrail [](https://travis-ci.org/cloudposse/terraform-aws-cloudtrail) | ||
| <!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. --> | ||
|
|
||
| [](https://cloudposse.com) | ||
|
|
||
| # terraform-aws-cloudtrail [](https://travis-ci.org/cloudposse/terraform-aws-cloudtrail) [](https://travis-ci.org/cloudposse/terraform-aws-cloudtrail/releases) [](https://slack.cloudposse.com) | ||
|
|
||
|
|
||
| Terraform module to provision an AWS [CloudTrail](https://aws.amazon.com/cloudtrail/). | ||
|
|
||
|
|
@@ -8,10 +13,21 @@ The bucket could be from the same AWS account or from a different account. | |
|
|
||
| This is useful if an organization uses a number of separate AWS accounts to isolate the Audit environment from other environments (production, staging, development). | ||
|
|
||
| In this case, you create CloudTrail in the production environment (production AWS account), | ||
| In this case, you create CloudTrail in the production environment (production AWS account), | ||
| while the S3 bucket to store the CloudTrail logs is created in the Audit AWS account, restricting access to the logs only to the users/groups from the Audit account. | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps. | ||
|
|
||
|
|
||
| It's 100% Open Source and licensed under the [APACHE2](LICENSE). | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| ```hcl | ||
|
|
@@ -57,43 +73,87 @@ module "cloudtrail_s3_bucket" { | |
| For a complete example, see [examples/complete](examples/complete). | ||
|
|
||
|
|
||
| ## Variables | ||
|
|
||
| | Name | Default | Description | Required | | ||
| |:---------------------------------|:--------------------:|:---------------------------------------------------------------------------------------------------|:--------:| | ||
| | `namespace` | `` | Namespace (e.g. `cp` or `cloudposse`) | Yes | | ||
| | `stage` | `` | Stage (e.g. `prod`, `dev`, `staging`) | Yes | | ||
| | `name` | `` | Name (e.g. `cluster` or `app`) | Yes | | ||
| | `attributes` | `[]` | Additional attributes (e.g. `logs`) | No | | ||
| | `tags` | `{}` | Additional tags (e.g. `map("BusinessUnit","XYZ")` | No | | ||
| | `delimiter` | `-` | Delimiter to be used between `namespace`, `stage`, `name` and `attributes` | No | | ||
| | `enable_log_file_validation` | `true` | Specifies whether log file integrity validation is enabled. Creates signed digest for validated contents of logs | No | | ||
| | `include_global_service_events` | `false` | Specifies whether the trail is publishing events from global services such as IAM to the log files | No | | ||
| | `is_multi_region_trail` | `false` | Specifies whether the trail is created in the current region or in all regions | No | | ||
| | `enable_logging` | `true` | Enable logging for the trail. Logs will be stored in the S3 bucket | No | | ||
| | `s3_bucket_name` | `` | S3 bucket name for CloudTrail logs | Yes (if `enable_logging` = `true`) | | ||
| | `cloud_watch_logs_role_arn` | `` | Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group | No | | ||
| | `cloud_watch_logs_group_arn` | `` | Specifies a log group name using an Amazon Resource Name (ARN), that represents the log group to which CloudTrail logs will be delivered | No | | ||
| | `event_selector` | `` | Specifies an event selector for enabling data event logging. See: https://www.terraform.io/docs/providers/aws/r/cloudtrail.html for details on this map variable | No | | ||
| | `kms_key_id` | `` | Specifies the KMS key ARN to use to encrypt the logs delivered by CloudTrail | No | | ||
|
|
||
|
|
||
|
|
||
| ## Makefile Targets | ||
| ``` | ||
| Available targets: | ||
| help This help screen | ||
| help/all Display help for all targets | ||
| lint Lint terraform code | ||
| ``` | ||
|
|
||
| ## Inputs | ||
|
|
||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|:----:|:-----:|:-----:| | ||
| | attributes | Additional attributes (e.g. `logs`) | list | `<list>` | no | | ||
| | cloud_watch_logs_group_arn | Specifies a log group name using an Amazon Resource Name (ARN), that represents the log group to which CloudTrail logs will be delivered | string | `` | no | | ||
| | cloud_watch_logs_role_arn | Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group | string | `` | no | | ||
| | delimiter | Delimiter to be used between `namespace`, `stage`, `name` and `attributes` | string | `-` | no | | ||
| | enable_log_file_validation | Specifies whether log file integrity validation is enabled. Creates signed digest for validated contents of logs | string | `true` | no | | ||
| | enable_logging | Enable logging for the trail | string | `true` | no | | ||
| | event_selector | Specifies an event selector for enabling data event logging. See: https://www.terraform.io/docs/providers/aws/r/cloudtrail.html for details on this map variable | map | `<map>` | no | | ||
| | include_global_service_events | Specifies whether the trail is publishing events from global services such as IAM to the log files | string | `false` | no | | ||
| | is_multi_region_trail | Specifies whether the trail is created in the current region or in all regions | string | `false` | no | | ||
| | kms_key_id | Specifies the KMS key ARN to use to encrypt the logs delivered by CloudTrail | string | `` | no | | ||
| | name | Name (e.g. `app` or `cluster`) | string | - | yes | | ||
| | namespace | Namespace (e.g. `cp` or `cloudposse`) | string | - | yes | | ||
| | s3_bucket_name | S3 bucket name for CloudTrail logs | string | - | yes | | ||
| | stage | Stage (e.g. `prod`, `dev`, `staging`) | string | - | yes | | ||
| | tags | Additional tags (e.g. map('BusinessUnit`,`XYZ`) | map | `<map>` | no | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |:--------------------------|:---------------------------------------------| | ||
| | `cloudtrail_id` | The name of the trail | | ||
| | `cloudtrail_home_region` | The region in which the trail was created | | ||
| | `cloudtrail_arn` | The Amazon Resource Name of the trail | | ||
| | Name | Description | | ||
| |------|-------------| | ||
| | cloudtrail_arn | The Amazon Resource Name of the trail | | ||
| | cloudtrail_home_region | The region in which the trail was created | | ||
| | cloudtrail_id | The name of the trail | | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Related Projects | ||
|
|
||
| Check out these related projects. | ||
|
|
||
| - [terraform-aws-cloudtrail-cloudwatch-alarms](https://github.com/cloudposse/terraform-aws-cloudtrail-cloudwatch-alarms) - Terraform module for creating alarms for tracking important changes and occurances from cloudtrail. | ||
| - [terraform-aws-cloudtrail-s3-bucket](https://github.com/cloudposse/terraform-aws-cloudtrail-s3-bucket) - S3 bucket with built in IAM policy to allow CloudTrail logs | ||
| - [terraform-aws-s3-log-storage](https://github.com/cloudposse/terraform-aws-s3-log-storage) - This module creates an S3 bucket suitable for receiving logs from other AWS services such as S3, CloudFront, and CloudTrail | ||
|
|
||
|
|
||
|
|
||
| ## Help | ||
|
|
||
| **Got a question?** | ||
|
|
||
| File a GitHub [issue](https://github.com/cloudposse/terraform-aws-cloudtrail/issues), send us an [email](mailto:[email protected]) or reach out to us on [Gitter](https://gitter.im/cloudposse/). | ||
| File a GitHub [issue](https://github.com/cloudposse/terraform-aws-cloudtrail/issues), send us an [email][email] or join our [Slack Community][slack]. | ||
|
|
||
| ## Commerical Support | ||
|
|
||
| Work directly with our team of DevOps experts via email, slack, and video conferencing. | ||
|
|
||
| We provide *commercial support* for all of our [Open Source][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a fulltime engineer. | ||
|
|
||
| [](mailto:[email protected]) | ||
|
|
||
| - **Questions.** We'll use a Shared Slack channel between your team and ours. | ||
| - **Troubleshooting.** We'll help you triage why things aren't working. | ||
| - **Code Reviews.** We'll review your Pull Requests and provide constructive feedback. | ||
| - **Bug Fixes.** We'll rapidly work to fix any bugs in our projects. | ||
| - **Build New Terraform Modules.** We'll develop original modules to provision infrastructure. | ||
| - **Cloud Architecture.** We'll assist with your cloud strategy and design. | ||
| - **Implementation.** We'll provide hands on support to implement our reference architectures. | ||
|
|
||
|
|
||
| ## Community Forum | ||
|
|
||
| Get access to our [Open Source Community Forum][slack] on Slack. It's **FREE** to join for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build *sweet* infrastructure. | ||
|
|
||
| ## Contributing | ||
|
|
||
|
|
@@ -103,22 +163,28 @@ Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-cloud | |
|
|
||
| ### Developing | ||
|
|
||
| If you are interested in being a contributor and want to get involved in developing `terraform-aws-cloudtrail`, we would love to hear from you! Shoot us an [email](mailto:[email protected]). | ||
| If you are interested in being a contributor and want to get involved in developing this project or [help out](https://github.com/orgs/cloudposse/projects/3) with our other projects, we would love to hear from you! Shoot us an [email](mailto:[email protected]). | ||
|
|
||
| In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. | ||
|
|
||
| 1. **Fork** the repo on GitHub | ||
| 2. **Clone** the project to your own machine | ||
| 3. **Commit** changes to your own branch | ||
| 4. **Push** your work back up to your fork | ||
| 5. Submit a **Pull request** so that we can review your changes | ||
| 5. Submit a **Pull Request** so that we can review your changes | ||
|
|
||
| **NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request! | ||
|
|
||
|
|
||
| ## Copyright | ||
|
|
||
| Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com) | ||
|
|
||
| **NOTE:** Be sure to merge the latest from "upstream" before making a pull request! | ||
|
|
||
|
|
||
| ## License | ||
| ## License | ||
|
|
||
| [APACHE 2.0](LICENSE) © 2018 [Cloud Posse, LLC](https://cloudposse.com) | ||
| [](https://opensource.org/licenses/Apache-2.0) | ||
|
|
||
| See [LICENSE](LICENSE) for full details. | ||
|
|
||
|
|
@@ -130,7 +196,7 @@ See [LICENSE](LICENSE) for full details. | |
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| https://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
|
|
@@ -140,31 +206,45 @@ See [LICENSE](LICENSE) for full details. | |
| under the License. | ||
|
|
||
|
|
||
| ## About | ||
| ## Trademarks | ||
|
|
||
| All other trademarks referenced herein are the property of their respective owners. | ||
|
|
||
| `terraform-aws-cloudtrail` is maintained and funded by [Cloud Posse, LLC][website]. | ||
| ## About | ||
|
|
||
|  | ||
| This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at <hello@cloudposse.com> | ||
|
|
||
| [](https://cloudposse.com) | ||
|
|
||
| Like it? Please let us know at <hello@cloudposse.com> | ||
| We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We love [Open Source Software](https://github.com/cloudposse/)! | ||
|
|
||
| We love [Open Source Software](https://github.com/cloudposse/)! | ||
| We offer paid support on all of our projects. | ||
|
|
||
| See [our other projects][community] | ||
| or [hire us][hire] to help build your next cloud platform. | ||
| Check out [our other projects][github], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation. | ||
|
|
||
| [docs]: https://docs.cloudposse.com/ | ||
| [website]: https://cloudposse.com/ | ||
| [community]: https://github.com/cloudposse/ | ||
| [github]: https://github.com/cloudposse/ | ||
| [jobs]: https://cloudposse.com/jobs/ | ||
| [hire]: https://cloudposse.com/contact/ | ||
| [slack]: https://slack.cloudposse.com/ | ||
| [linkedin]: https://www.linkedin.com/company/cloudposse | ||
| [twitter]: https://twitter.com/cloudposse/ | ||
| [email]: mailto:[email protected] | ||
|
|
||
|
|
||
| ### Contributors | ||
|
|
||
| | [![Erik Osterman][erik_img]][erik_web]<br/>[Erik Osterman][erik_web] | [![Andriy Knysh][andriy_img]][andriy_web]<br/>[Andriy Knysh][andriy_web] | | ||
| |-------------------------------------------------------|------------------------------------------------------------------| | ||
| | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Sergey Vasilyev][s2504s_avatar]][s2504s_homepage]<br/>[Sergey Vasilyev][s2504s_homepage] | [![Valeriy][drama17_avatar]][drama17_homepage]<br/>[Valeriy][drama17_homepage] | [![Jamie Nelson][Jamie-BitFlight_avatar]][Jamie-BitFlight_homepage]<br/>[Jamie Nelson][Jamie-BitFlight_homepage] | | ||
| |---|---|---|---| | ||
|
|
||
| [aknysh_homepage]: https://github.com/aknysh | ||
| [aknysh_avatar]: https://github.com/aknysh.png?size=150 | ||
| [s2504s_homepage]: https://github.com/s2504s | ||
| [s2504s_avatar]: https://github.com/s2504s.png?size=150 | ||
| [drama17_homepage]: https://github.com/drama17 | ||
| [drama17_avatar]: https://github.com/drama17.png?size=150 | ||
| [Jamie-BitFlight_homepage]: https://github.com/Jamie-BitFlight | ||
| [Jamie-BitFlight_avatar]: https://github.com/Jamie-BitFlight.png?size=150 | ||
|
|
||
|
|
||
| [erik_img]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144 | ||
| [erik_web]: https://github.com/osterman/ | ||
| [andriy_img]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144 | ||
| [andriy_web]: https://github.com/aknysh/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| --- | ||
| # | ||
| # This is the canonical configuration for the `README.md` | ||
| # Run `make readme` to rebuild the `README.md` | ||
| # | ||
|
|
||
| # Name of this project | ||
| name: terraform-aws-cloudtrail | ||
|
|
||
| # Logo for this project | ||
| #logo: docs/logo.png | ||
|
|
||
| # License of this project | ||
| license: "APACHE2" | ||
|
|
||
| # Canonical GitHub repo | ||
| github_repo: cloudposse/terraform-aws-cloudtrail | ||
|
|
||
| # Badges to display | ||
| badges: | ||
| - name: "Build Status" | ||
| image: "https://travis-ci.org/cloudposse/terraform-aws-cloudtrail.svg?branch=master" | ||
| url: "https://travis-ci.org/cloudposse/terraform-aws-cloudtrail" | ||
| - name: "Latest Release" | ||
| image: "https://img.shields.io/github/release/cloudposse/terraform-aws-cloudtrail.svg" | ||
| url: "https://travis-ci.org/cloudposse/terraform-aws-cloudtrail/releases" | ||
| - name: "Slack Community" | ||
| image: "https://slack.cloudposse.com/badge.svg" | ||
| url: "https://slack.cloudposse.com" | ||
|
|
||
| related: | ||
| - name: "terraform-aws-cloudtrail-cloudwatch-alarms" | ||
| description: "Terraform module for creating alarms for tracking important changes and occurances from cloudtrail." | ||
| url: "https://github.com/cloudposse/terraform-aws-cloudtrail-cloudwatch-alarms" | ||
| - name: "terraform-aws-cloudtrail-s3-bucket" | ||
| description: "S3 bucket with built in IAM policy to allow CloudTrail logs" | ||
| url: "https://github.com/cloudposse/terraform-aws-cloudtrail-s3-bucket" | ||
| - name: "terraform-aws-s3-log-storage" | ||
| description: "This module creates an S3 bucket suitable for receiving logs from other AWS services such as S3, CloudFront, and CloudTrail" | ||
| url: "https://github.com/cloudposse/terraform-aws-s3-log-storage" | ||
|
|
||
| # Short description of this project | ||
| description: |- | ||
| Terraform module to provision an AWS [CloudTrail](https://aws.amazon.com/cloudtrail/). | ||
| The module accepts an encrypted S3 bucket with versioning to store CloudTrail logs. | ||
| The bucket could be from the same AWS account or from a different account. | ||
| This is useful if an organization uses a number of separate AWS accounts to isolate the Audit environment from other environments (production, staging, development). | ||
| In this case, you create CloudTrail in the production environment (production AWS account), | ||
| while the S3 bucket to store the CloudTrail logs is created in the Audit AWS account, restricting access to the logs only to the users/groups from the Audit account. | ||
| # How to use this project | ||
| usage: |- | ||
| ```hcl | ||
| module "cloudtrail" { | ||
| source = "git::https://github.com/cloudposse/terraform-aws-cloudtrail.git?ref=master" | ||
| namespace = "cp" | ||
| stage = "dev" | ||
| name = "cluster" | ||
| enable_log_file_validation = "true" | ||
| include_global_service_events = "true" | ||
| is_multi_region_trail = "false" | ||
| enable_logging = "true" | ||
| s3_bucket_name = "my-cloudtrail-logs-bucket" | ||
| } | ||
| ``` | ||
| __NOTE:__ To create an S3 bucket for CloudTrail logs, use [terraform-aws-cloudtrail-s3-bucket](https://github.com/cloudposse/terraform-aws-cloudtrail-s3-bucket) module. | ||
| It creates an S3 bucket and an IAM policy to allow CloudTrail logs. | ||
| ```hcl | ||
| module "cloudtrail" { | ||
| source = "git::https://github.com/cloudposse/terraform-aws-cloudtrail.git?ref=master" | ||
| namespace = "cp" | ||
| stage = "dev" | ||
| name = "cluster" | ||
| enable_log_file_validation = "true" | ||
| include_global_service_events = "true" | ||
| is_multi_region_trail = "false" | ||
| enable_logging = "true" | ||
| s3_bucket_name = "${module.cloudtrail_s3_bucket.bucket_id}" | ||
| } | ||
| module "cloudtrail_s3_bucket" { | ||
| source = "git::https://github.com/cloudposse/terraform-aws-cloudtrail-s3-bucket.git?ref=master" | ||
| namespace = "cp" | ||
| stage = "dev" | ||
| name = "cluster" | ||
| region = "us-east-1" | ||
| } | ||
| ``` | ||
| For a complete example, see [examples/complete](examples/complete). | ||
| include: | ||
| - "docs/targets.md" | ||
| - "docs/terraform.md" | ||
|
|
||
| # Contributors to this project | ||
| contributors: | ||
| - name: "Andriy Knysh" | ||
| github: "aknysh" | ||
| - name: "Sergey Vasilyev" | ||
| github: "s2504s" | ||
| - name: "Valeriy" | ||
| github: "drama17" | ||
| - name: "Jamie Nelson" | ||
| github: "Jamie-BitFlight" |
Oops, something went wrong.