Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gsoft-inc/terraform-azurerm-naming

Terraform Azure RM Module for naming resources and resource groups following Microsoft's naming guidelines.
https://github.com/gsoft-inc/terraform-azurerm-naming

azure naming-conventions terraform terraform-module

Last synced: about 2 months ago
JSON representation

Terraform Azure RM Module for naming resources and resource groups following Microsoft's naming guidelines.

Host: GitHub
URL: https://github.com/gsoft-inc/terraform-azurerm-naming
Owner: gsoft-inc
License: apache-2.0
Created: 2019-10-23T21:03:45.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2022-04-04T19:58:50.000Z (over 2 years ago)
Last Synced: 2023-08-05T03:53:23.363Z (over 1 year ago)
Topics: azure, naming-conventions, terraform, terraform-module
Language: HCL
Homepage:
Size: 89.8 KB
Stars: 23
Watchers: 4
Forks: 10
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# terraform-azurerm-naming
Terraform Module for naming Azure resources and resource groups following [Microsoft's naming guidelines](https://docs.microsoft.com/en-us/azure/architecture/best-practices/resource-naming).

_Note: Since this module is comprised of multiple sub-modules, you need to [reference them in a particular fashion](https://www.terraform.io/docs/modules/sources.html#modules-in-package-sub-directories)._

## Why Use This?
1. Abstract the hassle of knowing which resource type needs to follow which naming convention (length, dashes or no dashes, etc.)
2. Make it easier to follow naming conventions
3. Follow best pratices such as suffixing with a random string to avoid name collisions

## Example Usage
```hcl
provider "azurerm" {
features {}
}

variable "location" {
default = "eastus2"
}

module "resource_group_name" {
source = "gsoft-inc/naming/azurerm//modules/general/resource_group"
name = "example"
prefixes = ["organization", "project", "production"]
}

module "storage_account_name" {
source = "gsoft-inc/naming/azurerm//modules/storage/storage_account"
name = "example"
prefixes = ["org", "proj", "prod"]
}

resource "azurerm_resource_group" "example" {
name = module.resource_group_name.result
location = var.location
}

resource "azurerm_storage_account" "example" {
name = module.storage_account_name.result
resource_group_name = azurerm_resource_group.example.name
location = var.location
account_kind = "StorageV2"
account_tier = "Standard"
account_replication_type = "LRS"
}
```

This example would result into something like this:

- `organization-project-production-example-35xvzaq251lja` (resource group)
- `org0proj0prod0example01x` (storage account)

*Note: Random suffix is automatically generated but can but overriden.*

## Updating the module
```hcl
terraform get -update
```

## License