Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@clouddrove-ci
clouddrove-ci committed Dec 28, 2021
1 parent 608ed7c commit 03d3c80
Showing 1 changed file with 34 additions and 33 deletions.
67 changes: 34 additions & 33 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@


<h1 align="center">
Terraform Azure Resource Group
Terraform AZURE RESOURCE-GROUP
</h1>

<p align="center" style="font-size: 1.2rem;">
Terraform module to create Resource Group on Azure.
<p align="center" style="font-size: 1.2rem;">
Terraform module to create RESOURCE-GROUP resource on AZURE.
</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-v1.0.0-green" alt="Terraform">
</a>
<a href="LICENSE.md">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Licence">
<img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence">
</a>


Expand All @@ -27,18 +27,18 @@
<a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-azure-resource-group'>
<img title="Share on Facebook" src="https://user-images.githubusercontent.com/50652676/62817743-4f64cb80-bb59-11e9-90c7-b057252ded50.png" />
</a>
<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+Azure+Resource+Group&url=https://github.com/clouddrove/terraform-azure-resource-group'>
<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+AZURE+RESOURCE-GROUP&url=https://github.com/clouddrove/terraform-azure-resource-group'>
<img title="Share on LinkedIn" src="https://user-images.githubusercontent.com/50652676/62817742-4e339e80-bb59-11e9-87b9-a1f68cae1049.png" />
</a>
<a href='https://twitter.com/intent/tweet/?text=Terraform+Azure+Resource+Group&url=https://github.com/clouddrove/terraform-azure-resource-group'>
<a href='https://twitter.com/intent/tweet/?text=Terraform+AZURE+RESOURCE-GROUP&url=https://github.com/clouddrove/terraform-azure-resource-group'>
<img title="Share on Twitter" src="https://user-images.githubusercontent.com/50652676/62817740-4c69db00-bb59-11e9-8a79-3580fbbf6d5c.png" />
</a>

</p>
<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 @@ -49,9 +49,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 1.x.x](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)
Expand All @@ -71,15 +71,13 @@ This module has a few dependencies:
### Simple Example
Here is an example of how you can use this module in your inventory structure:
```hcl
module "resource_group" {
source = "git::https://github.com/clouddrove/terraform-azure-resource-group.git?ref=tags/0.12.0"
name = "resource-group"
application = "clouddrove"
environment = "test"
label_order = ["environment", "application", "name"]
enabled = true
location = "North Europe"
source = "terraform/resource-group/azure"
version = "1.0.0"
environment = "test"
label_order = ["name","environment"]
name = "example"
location = "North Europe"
}
```

Expand All @@ -91,19 +89,22 @@ Here is an example of how you can use this module in your inventory structure:
## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:|
| application | Application \(e.g. `cd` or `clouddrove`\). | string | `""` | no |
| create | Used when creating the Resource Group. | string | `"90m"` | no |
| delete | Used when deleting the Resource Group. | string | `"90m"` | no |
| enabled | Flag to control the module creation. | bool | `"false"` | no |
| environment | Environment \(e.g. `prod`, `dev`, `staging`\). | string | `""` | no |
| label\_order | Label order, e.g. `name`,`application`. | list | `<list>` | no |
| location | Location where resource should be created. | string | `""` | no |
| managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. | string | `"anmol@clouddrove.com"` | no |
| name | Name \(e.g. `app` or `cluster`\). | string | `""` | no |
| read | Used when retrieving the Resource Group. | string | `"5m"` | no |
| tags | Additional tags \(e.g. map\(`BusinessUnit`,`XYZ`\). | map | `<map>` | no |
| update | Used when updating the Resource Group. | string | `"90m"` | no |
|------|-------------|------|---------|:--------:|
| attributes | Additional attributes (e.g. `1`). | `list(any)` | `[]` | no |
| business\_unit | Top-level division of your company that owns the subscription or workload that the resource belongs to. In smaller organizations, this tag might represent a single corporate or shared top-level organizational element. | `string` | `"Corp"` | no |
| create | Used when creating the Resource Group. | `string` | `"90m"` | no |
| delete | Used when deleting the Resource Group. | `string` | `"90m"` | no |
| delimiter | Delimiter to be used between `organization`, `environment`, `name` and `attributes`. | `string` | `"-"` | no |
| enabled | Flag to control the module creation. | `bool` | `true` | no |
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | `[]` | no |
| location | Location where resource should be created. | `string` | `""` | no |
| managedby | ManagedBy, eg 'CloudDrove'. | `string` | `"hello@clouddrove.com"` | no |
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
| read | Used when retrieving the Resource Group. | `string` | `"5m"` | no |
| repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-azure-resource-group"` | no |
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(any)` | `{}` | no |
| update | Used when updating the Resource Group. | `string` | `"90m"` | no |

## Outputs

Expand All @@ -118,7 +119,7 @@ Here is an example of how you can use this module in your inventory structure:


## 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 AZURE 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 @@ -127,7 +128,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-azure-resource-group/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-azure-resource-group)!
Expand Down

0 comments on commit 03d3c80

Please sign in to comment.