Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
clouddrove-ci committed Jul 1, 2021
1 parent 848d88a commit 54faa4f
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Terraform AWS Cloudfront CDN
</h1>

<p align="center" style="font-size: 1.2rem;">
<p align="center" style="font-size: 1.2rem;">
Terraform module provisions CloudFront CDN resource on AWS.
</p>

Expand Down Expand Up @@ -35,7 +35,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.

Expand All @@ -46,7 +46,7 @@ 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.13](https://learn.hashicorp.com/terraform/getting-started/install.html)
- [Go](https://golang.org/doc/install)
Expand All @@ -70,9 +70,8 @@ Here are some examples of how you can use this module in your inventory structur
```hcl
module "cdn" {
source = "clouddrove/cloudfront-cdn/aws"
version = "0.14.0"
version = "0.15.0"
name = "basic-cdn"
repository = "https://registry.terraform.io/modules/clouddrove/cloudfront/aws/0.14.0"
environment = "test"
label_order = ["name", "environment"]
enabled_bucket = true
Expand All @@ -89,9 +88,8 @@ Here are some examples of how you can use this module in your inventory structur
```hcl
module "cdn" {
source = "clouddrove/cloudfront-cdn/aws"
version = "0.14.0"
version = "0.15.0"
name = "secure-cdn"
repository = "https://registry.terraform.io/modules/clouddrove/cloudfront/aws/0.14.0"
environment = "test"
label_order = ["name", "environment"]
aliases = ["clouddrove.com"]
Expand All @@ -109,9 +107,8 @@ Here are some examples of how you can use this module in your inventory structur
```hcl
module "cdn" {
source = "clouddrove/cloudfront-cdn/aws"
version = "0.14.0"
version = "0.15.0"
name = "domain-cdn"
repository = "https://registry.terraform.io/modules/clouddrove/cloudfront/aws/0.14.0"
environment = "test"
label_order = ["name", "environment"]
custom_domain = true
Expand Down Expand Up @@ -176,7 +173,7 @@ Here are some examples of how you can use this module in your inventory structur
| price\_class | Price class for this distribution: `PriceClass_All`, `PriceClass_200`, `PriceClass_100`. | `string` | `"PriceClass_100"` | no |
| public\_key | It encoded public key that you want to add to CloudFront to use with features like field-level encryption. | `string` | `""` | no |
| public\_key\_enable | Public key enable or disable. | `bool` | `false` | no |
| repository | Terraform current module repo | `string` | `""` | no |
| repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-aws-cloudfront-cdn"` | no |
| response\_page\_path | The path of the custom error page (for example, /custom\_404.html). | `string` | `null` | no |
| smooth\_streaming | Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. | `bool` | `false` | no |
| ssl\_support\_method | Specifies how you want CloudFront to serve HTTPS requests. One of `vip` or `sni-only`. | `string` | `"sni-only"` | no |
Expand Down Expand Up @@ -205,7 +202,7 @@ Here are some examples of how you can use this module in your inventory structur


## 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
Expand All @@ -214,7 +211,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-cloudfront-cdn/issues), or feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com).

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

0 comments on commit 54faa4f

Please sign in to comment.