Skip to content

Commit 3168b16

Browse files
committed
pushed README.md
1 parent 9ff12f7 commit 3168b16

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
Terraform AWS S3
88
</h1>
99

10-
<p align="center" style="font-size: 1.2rem;">
10+
<p align="center" style="font-size: 1.2rem;">
1111
Terraform module to create default S3 bucket with logging and encryption type specific features.
1212
</p>
1313

1414
<p align="center">
1515

1616
<a href="https://www.terraform.io">
17-
<img src="https://img.shields.io/badge/Terraform-v0.12-green" alt="Terraform">
17+
<img src="https://img.shields.io/badge/Terraform-v0.13-green" alt="Terraform">
1818
</a>
1919
<a href="LICENSE.md">
2020
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Licence">
@@ -38,7 +38,7 @@
3838
<hr>
3939

4040

41-
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.
41+
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.
4242

4343
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.
4444

@@ -49,7 +49,7 @@ We have [*fifty plus terraform modules*][terraform_modules]. A few of them are c
4949

5050
## Prerequisites
5151

52-
This module has a few dependencies:
52+
This module has a few dependencies:
5353

5454
- [Terraform 0.13](https://learn.hashicorp.com/terraform/getting-started/install.html)
5555
- [Go](https://golang.org/doc/install)
@@ -72,7 +72,8 @@ Here are some examples of how you can use this module in your inventory structur
7272
### Basic Bucket
7373
```hcl
7474
module "s3_bucket" {
75-
source = "https://github.com/clouddrove/terraform-aws-s3?ref=tags/0.12.7"
75+
source = "clouddrove/s3/aws"
76+
version = "0.13.0"
7677
name = "secure-bucket"
7778
application = "clouddrove"
7879
environment = "test"
@@ -85,7 +86,8 @@ module "s3_bucket" {
8586
### Encryption Bucket
8687
```hcl
8788
module "s3_bucket" {
88-
source = "https://github.com/clouddrove/terraform-aws-s3?ref=tags/0.12.7"
89+
source = "clouddrove/s3/aws"
90+
version = "0.13.0"
8991
name = "encryption-bucket"
9092
application = "clouddrove"
9193
environment = "test"
@@ -99,7 +101,8 @@ module "s3_bucket" {
99101
### Logging-Encryption Bucket
100102
```hcl
101103
module "s3_bucket" {
102-
source = "https://github.com/clouddrove/terraform-aws-s3?ref=tags/0.12.7"
104+
source = "clouddrove/s3/aws"
105+
version = "0.13.0"
103106
name = "logging-encryption-bucket"
104107
application = "clouddrove"
105108
environment = "test"
@@ -115,7 +118,8 @@ module "s3_bucket" {
115118
### Logging Bucket
116119
```hcl
117120
module "s3_bucket" {
118-
source = "https://github.com/clouddrove/terraform-aws-s3?ref=tags/0.12.7"
121+
source = "clouddrove/s3/aws"
122+
version = "0.13.0"
119123
name = "logging-bucket"
120124
application = "clouddrove"
121125
environment = "test"
@@ -130,7 +134,8 @@ module "s3_bucket" {
130134
### Website Host Bucket
131135
```hcl
132136
module "s3_bucket" {
133-
source = "https://github.com/clouddrove/terraform-aws-s3?ref=tags/0.12.7"
137+
source = "clouddrove/s3/aws"
138+
version = "0.13.0"
134139
name = "website-bucket"
135140
application = "clouddrove"
136141
environment = "test"
@@ -219,7 +224,7 @@ data "aws_iam_policy_document" "default" {
219224

220225

221226
## Testing
222-
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.
227+
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.
223228

224229
You need to run the following command in the testing folder:
225230
```hcl
@@ -228,7 +233,7 @@ You need to run the following command in the testing folder:
228233

229234

230235

231-
## Feedback
236+
## Feedback
232237
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-s3/issues), or feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com).
233238

234239
If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-s3)!

0 commit comments

Comments
 (0)