naming conventions

Author: kolosovpetro

.terraform.lock.hcl

@@ -23,3 +23,5 @@ and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec
 - Add default values to tf variables
 - Fix encoding script
 - Add public key and password files mocks CI
+- Adopt naming conventions
+- Utilize azure naming module for terraform

CHANGELOG.md

@@ -5,6 +5,11 @@ Includes pre-commit hooks that lint the terraform code and generate module's
 documentation as part of README file.
 Contains examples of terraform CI/CD pipelines for GitHub Actions and Azure Pipelines.
 
+## Azure naming conventions
+
+- [Define your naming convention](https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-naming)
+- [Azure naming module](https://registry.terraform.io/modules/Azure/naming/azurerm/latest)
+
 ## Terraform Init
 
 - Create and configure Azure Storage Account for Terraform state
@@ -19,8 +24,9 @@ Contains examples of terraform CI/CD pipelines for GitHub Actions and Azure Pipe
 
 ## Module referencing
 
-- Bitbucket: `git::git@bitbucket.org:kolosovpetro/terraform.git//modules/storage`
-- Github: `git::git@github.com:kolosovpetro/terraform.git//modules/storage`
+- Bitbucket SSH: `git::git@bitbucket.org:kolosovpetro/terraform.git//modules/storage`
+- Github SSH: `git::git@github.com:kolosovpetro/terraform.git//modules/storage`
+- Github HTTP: `github.com/kolosovpetro/AzureLinuxVMTerraform.git//modules/ubuntu-vm-key-auth-no-pip?ref=master`
 
 ## Pre-commit configuration
 
@@ -46,57 +52,6 @@ Contains examples of terraform CI/CD pipelines for GitHub Actions and Azure Pipe
 - https://terraform-docs.io/user-guide/installation/
 - https://pre-commit.com/
 
-## Storage account configuration file
-
-  ```bash
-  storage_account_name = "storage_account_name"
-  container_name       = "container_name"
-  key                  = "terraform.tfstate"
-  sas_token            = "sas_token"
-  ```
-
 ## Deploy storage account for terraform state
 
 - See [CreateAzureStorageAccount.ps1](./CreateAzureStorageAccount.ps1)
-
-# Module documentation
-
-<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
-## Requirements
-
-| Name                                                                | Version |
-|---------------------------------------------------------------------|---------|
-| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | =3.71.0 |
-
-## Providers
-
-| Name                                                          | Version |
-|---------------------------------------------------------------|---------|
-| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | 3.71.0  |
-
-## Modules
-
-| Name                                                                             | Source                      | Version |
-|----------------------------------------------------------------------------------|-----------------------------|---------|
-| <a name="module_resource_group"></a> [resource\_group](#module\_resource\_group) | ./modules/example_submodule | n/a     |
-
-## Resources
-
-| Name                                                                                                                              | Type        |
-|-----------------------------------------------------------------------------------------------------------------------------------|-------------|
-| [azurerm_resource_group.public](https://registry.terraform.io/providers/hashicorp/azurerm/3.71.0/docs/resources/resource_group)   | resource    |
-| [azurerm_client_config.current](https://registry.terraform.io/providers/hashicorp/azurerm/3.71.0/docs/data-sources/client_config) | data source |
-
-## Inputs
-
-| Name                                                                                                        | Description              | Type     | Default | Required |
-|-------------------------------------------------------------------------------------------------------------|--------------------------|----------|---------|:--------:|
-| <a name="input_prefix"></a> [prefix](#input\_prefix)                                                        | Prefix for all resources | `string` | n/a     |   yes    |
-| <a name="input_resource_group_location"></a> [resource\_group\_location](#input\_resource\_group\_location) | Resource group location  | `string` | n/a     |   yes    |
-| <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name)             | Resource group name      | `string` | n/a     |   yes    |
-
-## Outputs
-
-No outputs.
-<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

README.md

@@ -1,6 +1,11 @@
 data "azurerm_client_config" "current" {}
 data "azurerm_subscription" "current" {}
 
+module "naming" {
+  source = "Azure/naming/azurerm"
+  suffix = ["template", var.prefix]
+}
+
 #################################################################################################################
 # LOCALS
 #################################################################################################################
@@ -18,7 +23,7 @@ locals {
 
 resource "azurerm_resource_group" "public" {
   location = var.location
-  name     = "rg-tf-template-${var.prefix}"
+  name     = module.naming.resource_group.name_unique
   tags     = var.tags
 }
 
@@ -27,14 +32,14 @@ resource "azurerm_resource_group" "public" {
 #################################################################################################################
 
 resource "azurerm_virtual_network" "public" {
-  name                = "vnet-${var.prefix}"
+  name                = module.naming.virtual_network.name
   address_space       = local.vnet_cidr
   location            = azurerm_resource_group.public.location
   resource_group_name = azurerm_resource_group.public.name
 }
 
 resource "azurerm_subnet" "vm" {
-  name                 = "snet-vm-${var.prefix}"
+  name                 = module.naming.subnet.name_unique
   resource_group_name  = azurerm_resource_group.public.name
   virtual_network_name = azurerm_virtual_network.public.name
   address_prefixes     = local.vm_subnet_cidr
@@ -53,13 +58,3 @@ resource "azurerm_subnet" "bastion_snet" {
   virtual_network_name = azurerm_virtual_network.public.name
   address_prefixes     = local.bastion_subnet_cidr
 }
-
-#################################################################################################################
-# MODULE CALL EXAMPLE
-#################################################################################################################
-
-module "resource_group" {
-  source                  = "./modules/module"
-  resource_group_location = var.location
-  resource_group_name     = "rg-from-module-${var.prefix}"
-}