Skip to content

Commit 6704f6f

Browse files
committed
update README.md
1 parent b5cd067 commit 6704f6f

File tree

1 file changed

+17
-21
lines changed

1 file changed

+17
-21
lines changed

README.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
Terraform Aws Acm
88
</h1>
99

10-
<p align="center" style="font-size: 1.2rem;">
10+
<p align="center" style="font-size: 1.2rem;">
1111
This terraform module is used for requesting or importing SSL/TLS certificate with validation.
1212
</p>
1313

@@ -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)
@@ -73,11 +73,10 @@ Here are some examples of how you can use this module in your inventory structur
7373
```hcl
7474
module "acm" {
7575
source = "clouddrove/acm/aws"
76-
version = "0.13.0"
76+
version = "0.14.0"
7777
name = "certificate"
78-
application = "clouddrove"
7978
environment = "test"
80-
label_order = ["environment", "name", "application"]
79+
label_order = ["name","environment"]
8180
domain_name = "clouddrove.com"
8281
validation_method = "DNS"
8382
enable_dns_validation = false
@@ -89,11 +88,10 @@ module "acm" {
8988
```hcl
9089
module "acm" {
9190
source = "clouddrove/acm/aws"
92-
version = "0.13.0"
91+
version = "0.14.0"
9392
name = "certificate"
94-
application = "clouddrove"
9593
environment = "test"
96-
label_order = ["environment", "name", "application"]
94+
label_order = ["name","environment"]
9795
domain_name = "clouddrove.com"
9896
validation_method = "EMAIL"
9997
validate_certificate = false
@@ -105,11 +103,10 @@ module "acm" {
105103
```hcl
106104
module "acm" {
107105
source = "clouddrove/acm/aws"
108-
version = "0.13.0"
106+
version = "0.14.0"
109107
name = "certificate"
110-
application = "clouddrove"
111108
environment = "test"
112-
label_order = ["environment", "name", "application"]
109+
label_order = ["name","environment"]
113110
private_key = "./../../../clouddrove-private-key.pem"
114111
certificate_body = "./../../../clouddrove-cert.pem"
115112
certificate_chain = "./../../../clouddrove-chain.crt"
@@ -126,24 +123,23 @@ module "acm" {
126123

127124
| Name | Description | Type | Default | Required |
128125
|------|-------------|------|---------|:--------:|
129-
| application | Application (e.g. `cd` or `clouddrove`). | `string` | `""` | no |
130-
| attributes | Additional attributes (e.g. `1`). | `list` | `[]` | no |
126+
| attributes | Additional attributes (e.g. `1`). | `list(any)` | `[]` | no |
131127
| certificate\_body | Path of certificate body. | `string` | `"~"` | no |
132128
| certificate\_chain | Path of certificate chain. | `string` | `""` | no |
133-
| delimiter | Delimiter to be used between `organization`, `environment`, `name` and `attributes`. | `string` | `"-"` | no |
134129
| domain\_name | A domain name for which the certificate should be issued. | `string` | `""` | no |
135130
| enable\_acm\_certificate | Set to false to prevent the creation of a acm certificate. | `bool` | `true` | no |
136131
| enable\_aws\_certificate | Set to false to prevent the creation of a acm certificate. | `bool` | `false` | no |
137132
| enable\_dns\_validation | Set to prevent validation of DNS. | `bool` | `false` | no |
138133
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
139134
| import\_certificate | Set to true or false to decide the creation and import of a acm certificate. | `bool` | `false` | no |
140-
| label\_order | Label order, e.g. `name`,`application`. | `list` | `[]` | no |
141-
| managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. | `string` | `"anmol@clouddrove.com"` | no |
135+
| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | `[]` | no |
136+
| managedby | ManagedBy, eg 'CloudDrove' | `string` | `"hello@clouddrove.com"` | no |
142137
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
143138
| private\_key | Path of private key. | `string` | `""` | no |
144-
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map` | `{}` | no |
139+
| repository | Terraform current module repo | `string` | `"https://registry.terraform.io/modules/clouddrove/acm/aws"` | no |
140+
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(any)` | `{}` | no |
145141
| ttl | Time to live. | `number` | `600` | no |
146-
| validate\_certificate | Set to false to prevent the validation of a acm certificate. | `string` | `false` | no |
142+
| validate\_certificate | Set to false to prevent the validation of a acm certificate. | `bool` | `false` | no |
147143
| validation\_method | Which method to use for validation, DNS or EMAIL. | `string` | `""` | no |
148144

149145
## Outputs
@@ -158,7 +154,7 @@ module "acm" {
158154

159155

160156
## Testing
161-
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.
157+
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.
162158

163159
You need to run the following command in the testing folder:
164160
```hcl
@@ -167,7 +163,7 @@ You need to run the following command in the testing folder:
167163

168164

169165

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

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

0 commit comments

Comments
 (0)