diff --git a/README.md b/README.md index cce7abb..49d47d4 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,20 @@

- Terraform Azure Resource Group + Terraform AZURE RESOURCE-GROUP

-

- Terraform module to create Resource Group on Azure. +

+ Terraform module to create RESOURCE-GROUP resource on AZURE.

- Terraform + Terraform - Licence + Licence @@ -27,10 +27,10 @@ - + - + @@ -38,7 +38,7 @@


-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 Bigger problems are always solved by breaking them into smaller manageable problems. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller connected yet manageable pieces 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 Bigger problems are always solved by breaking them into smaller manageable problems. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller connected yet manageable pieces 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. @@ -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) @@ -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" } ``` @@ -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 | `` | 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 | `` | 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 @@ -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 @@ -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)!