-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
24fa204
commit 361e5de
Showing
1 changed file
with
20 additions
and
18 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 |
|---|---|---|
|
|
@@ -9,14 +9,14 @@ | |
|
|
||
| </h1> | ||
|
|
||
| <p align="center" style="font-size: 1.2rem;"> | ||
| <p align="center" style="font-size: 1.2rem;"> | ||
| Terraform module to create Lambda resource on AWS for sending notification when anything done from console in AWS. | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
|
|
||
| <a href="https://www.terraform.io"> | ||
| <img src="https://img.shields.io/badge/Terraform-v0.12-green" alt="Terraform"> | ||
| <img src="https://img.shields.io/badge/Terraform-v0.13-green" alt="Terraform"> | ||
| </a> | ||
| <a href="LICENSE.md"> | ||
| <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Licence"> | ||
|
|
@@ -40,7 +40,7 @@ | |
| <hr> | ||
|
|
||
|
|
||
| We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure. | ||
| We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure. | ||
|
|
||
| This module is basically combination of [Terraform open source](https://www.terraform.io/) and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself. | ||
|
|
||
|
|
@@ -51,9 +51,9 @@ We have [*fifty plus terraform modules*][terraform_modules]. A few of them are c | |
|
|
||
| ## Prerequisites | ||
|
|
||
| This module has a few dependencies: | ||
| This module has a few dependencies: | ||
|
|
||
| - [Terraform 0.12](https://learn.hashicorp.com/terraform/getting-started/install.html) | ||
| - [Terraform 0.13](https://learn.hashicorp.com/terraform/getting-started/install.html) | ||
| - [Go](https://golang.org/doc/install) | ||
| - [github.com/stretchr/testify/assert](https://github.com/stretchr/testify) | ||
| - [github.com/gruntwork-io/terratest/modules/terraform](https://github.com/gruntwork-io/terratest) | ||
|
|
@@ -74,7 +74,8 @@ This module has a few dependencies: | |
| Here is an example of how you can use this module in your inventory structure: | ||
| ```hcl | ||
| module "cloudtrail-slack-notification" { | ||
| source = "git::https://github.com/clouddrove/terraform-aws-cloudtrail-slack-notification.git?ref=tags/0.12.2" | ||
| source = "clouddrove/cloudtrail-slack-notification/aws" | ||
| version = "0.13.0" | ||
| name = "cloudtrail-slack-notification" | ||
| application = "clouddrove" | ||
| environment = "test" | ||
|
|
@@ -99,27 +100,28 @@ module "cloudtrail-slack-notification" { | |
| ## Inputs | ||
|
|
||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|:----:|:-----:|:-----:| | ||
| | application | Lambda Application \(e.g. `cd` or `clouddrove`\). | string | `""` | no | | ||
| | bucket\_arn | S3 Bucket ARN. | string | `""` | no | | ||
| | bucket\_name | S3 Bucket Name. | string | `""` | no | | ||
| | enabled | Whether to create lambda function. | bool | `"false"` | no | | ||
| | environment | Lambda Environment \(e.g. `prod`, `dev`, `staging`\). | string | `""` | no | | ||
| | label\_order | Label order, e.g. `name`,`application`. | list | `<list>` | no | | ||
| | name | Lambda Name \(e.g. `app` or `cluster`\). | string | `""` | no | | ||
| | variables | A map that defines environment variables for the Lambda function. | map | `<map>` | no | | ||
| |------|-------------|------|---------|:--------:| | ||
| | application | Lambda Application (e.g. `cd` or `clouddrove`). | `string` | `""` | no | | ||
| | bucket\_arn | S3 Bucket ARN. | `string` | `""` | no | | ||
| | bucket\_name | S3 Bucket Name. | `string` | `""` | no | | ||
| | enabled | Whether to create lambda function. | `bool` | `false` | no | | ||
| | environment | Lambda Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no | | ||
| | label\_order | Label order, e.g. `name`,`application`. | `list` | `[]` | no | | ||
| | managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. | `string` | `"[email protected]"` | no | | ||
| | name | Lambda Name (e.g. `app` or `cluster`). | `string` | `""` | no | | ||
| | variables | A map that defines environment variables for the Lambda function. | `map` | `{}` | no | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |------|-------------| | ||
| | cloudtrail-slack-arn | The Amazon Resource Name \(ARN\) identifying your cloudtrail logs Lambda Function. | | ||
| | cloudtrail-slack-arn | The Amazon Resource Name (ARN) identifying your cloudtrail logs Lambda Function. | | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Testing | ||
| In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system. | ||
| In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system. | ||
|
|
||
| You need to run the following command in the testing folder: | ||
| ```hcl | ||
|
|
@@ -128,7 +130,7 @@ You need to run the following command in the testing folder: | |
|
|
||
|
|
||
|
|
||
| ## Feedback | ||
| ## Feedback | ||
| If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-cloudtrail-slack-notification/issues), or feel free to drop us an email at [[email protected]](mailto:[email protected]). | ||
|
|
||
| If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-cloudtrail-slack-notification)! | ||
|
|
||