Merge pull request #2 from TheIronRock95/task/firstrelease

BREAKING CHANGE:
- First release version virtual network

.gitignore

@@ -31,4 +31,5 @@ override.tf.json
 
 # Ignore CLI configuration files
 .terraformrc
-terraform.rc
+terraform.rc
+*.lock.hcl

.terraform-docs.yml

@@ -6,7 +6,7 @@ footer-from: "docs/footer-doc.tf"
 content: |-
   {{ .Header }}
 
-  # Examples
+  # Usage - Module
 
   ```hcl
   {{ include "examples/virtual-network/main.tf" }}

CHANGELOG.md

@@ -1,6 +1,5 @@
-# V1.0.0 - 2023-01-18
+# v1.0.0 - 2023-01-18
 
-feat: first release
+Added
+  * First release
 
-BREAKING CHANGE:
-- First Major Template release

README.md

@@ -0,0 +1,57 @@
+<!-- BEGIN_TF_DOCS -->
+ # Azure Virtual Network
+[![Changelog](https://img.shields.io/badge/changelog-release-green.svg)](CHANGELOG.md) [![Notice](https://img.shields.io/badge/notice-copyright-yellow.svg)](NOTICE) [![Apache V2 License](https://img.shields.io/badge/license-Apache%20V2-orange.svg)](LICENSE) [![TF Registry](https://img.shields.io/badge/terraform-registry-blue.svg)](https://registry.terraform.io/modules/TheIronRock95/virtualnetwork/azurerm/latest)
+
+# Usage - Module
+
+```hcl
+module "virtual-network" {
+  source  = "TheIronRock95/virtualnetwork/azurerm"
+  version = "x.x.x"
+
+  name                = var.virtual_network_name
+  location            = var.azure_location
+  resource_group_name = var.resource_group_name
+  address_space       = var.virtual_network_cidr
+}
+```
+## Providers
+
+| Name | Version |
+|------|---------|
+| azurerm | n/a |
+
+## Modules
+
+No modules.
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [azurerm_virtual_network.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_network) | resource |
+
+## Inputs
+
+| Name | Description | Type | Required |
+|------|-------------|------|:--------:|
+| azure\_location | The location/region where the virtual network is created. Changing this forces a new resource to be created. | `string` | yes |
+| resource\_group\_name | The name of the resource group in which to create the virtual network. Changing this forces a new resource to be created. | `string` | yes |
+| virtual\_network\_cidr | The address space that is used the virtual network. You can supply more than one address space. | `list(string)` | yes |
+| virtual\_network\_name | The name of the virtual network. Changing this forces a new resource to be created. | `string` | yes |
+| virtual\_network\_dns | List of IP addresses of DNS servers | `list(string)` | no |
+| virtual\_network\_tags | A mapping of tags to assign to the resource. | `map(string)` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| virtual\_network\_address\_space | The list of address spaces used by the virtual network. |
+| virtual\_network\_guid | The GUID of the virtual network. |
+| virtual\_network\_id | The virtual NetworkConfiguration ID. |
+| virtual\_network\_location | The location/region where the virtual network is created. |
+| virtual\_network\_name | The name of the virtual network |
+| virtual\_network\_resource\_group\_name | The name of the resource group in which to create the virtual network. |
+
+## Related documentation
+<!-- END_TF_DOCS -->

docs/header-doc.tf

@@ -1,6 +1,6 @@
 /**
- *  # Module Name
- * [![Changelog](https://img.shields.io/badge/changelog-release-green.svg)](CHANGELOG.md) [![Notice](https://img.shields.io/badge/notice-copyright-yellow.svg)](NOTICE) [![Apache V2 License](https://img.shields.io/badge/license-Apache%20V2-orange.svg)](LICENSE) [![TF Registry](https://img.shields.io/badge/terraform-registry-blue.svg)](https://registry.terraform.io/)
+ *  # Azure Virtual Network
+ * [![Changelog](https://img.shields.io/badge/changelog-release-green.svg)](CHANGELOG.md) [![Notice](https://img.shields.io/badge/notice-copyright-yellow.svg)](NOTICE) [![Apache V2 License](https://img.shields.io/badge/license-Apache%20V2-orange.svg)](LICENSE) [![TF Registry](https://img.shields.io/badge/terraform-registry-blue.svg)](https://registry.terraform.io/modules/TheIronRock95/virtualnetwork/azurerm/latest)
  *
  * 
  *

examples/virtual-network/README.md

@@ -0,0 +1,36 @@
+# Terraform module | AzureRM - Virtual Network
+
+This Terraform module is designed to create a virtual network for Azure.
+
+## Pre-requisites
+
+Using the modules requires the following pre-requisites:
+ * Active Azure account and subscription 
+
+## Usage
+
+`virtual-network`
+
+```hcl
+module "virtual-network" {
+  source  = "TheIronRock95/virtualnetwork/azurerm"
+  version = "x.x.x"
+
+  name                = var.virtual_network_name
+  location            = var.azure_location
+  resource_group_name = var.resource_group_name
+  address_space       = var.virtual_network_cidr
+}
+```
+
+## Authors
+
+The module is maintained by [Wouter Damman](https://github.com/TheIronRock95)
+
+## Documentation
+
+> product: https://azure.microsoft.com/en-us/
+> 
+> Provider: https://registry.terraform.io/providers/hashicorp/azurerm/latest
+> 
+> Documentation: https://learn.microsoft.com/en-us/azure/?product=popular

examples/virtual-network/main.tf

@@ -0,0 +1,9 @@
+module "virtual-network" {
+  source  = "TheIronRock95/virtualnetwork/azurerm"
+  version = "x.x.x"
+
+  name                = var.virtual_network_name
+  location            = var.azure_location
+  resource_group_name = var.resource_group_name
+  address_space       = var.virtual_network_cidr
+}

examples/virtual-network/variables.tf

@@ -0,0 +1,25 @@
+variable "virtual_network_name" {
+  description = "The name of the virtual network. Changing this forces a new resource to be created."
+  type        = string
+  sensitive   = false
+}
+
+variable "azure_location" {
+  description = "The location/region where the virtual network is created. Changing this forces a new resource to be created."
+  type        = string
+  sensitive   = false
+}
+
+variable "resource_group_name" {
+  description = "The name of the resource group in which to create the virtual network. Changing this forces a new resource to be created."
+  type        = string
+  sensitive   = false
+}
+
+variable "virtual_network_cidr" {
+  description = "The address space that is used the virtual network. You can supply more than one address space."
+  type        = list(string)
+  sensitive   = false
+}
+
+

locals.tf

@@ -0,0 +1,3 @@
+locals {
+
+}

main.tf

@@ -0,0 +1,9 @@
+resource "azurerm_virtual_network" "this" {
+  name                = var.virtual_network_name
+  location            = var.azure_location
+  resource_group_name = var.resource_group_name
+  address_space       = var.virtual_network_cidr
+  dns_servers         = var.virtual_network_dns
+
+  tags = var.virtual_network_tags
+}

outputs.tf

@@ -0,0 +1,35 @@
+output "virtual_network_name" {
+  description = "The name of the virtual network"
+  sensitive   = false
+  value       = try(azurerm_virtual_network.this.name)
+}
+
+output "virtual_network_id" {
+  description = "The virtual NetworkConfiguration ID."
+  sensitive   = false
+  value       = try(azurerm_virtual_network.this.id)
+}
+
+output "virtual_network_resource_group_name" {
+  description = "The name of the resource group in which to create the virtual network."
+  sensitive   = false
+  value       = try(azurerm_virtual_network.this.resource_group_name)
+}
+
+output "virtual_network_location" {
+  description = "The location/region where the virtual network is created."
+  sensitive   = false
+  value       = try(azurerm_virtual_network.this.location)
+}
+
+output "virtual_network_address_space" {
+  description = "The list of address spaces used by the virtual network."
+  sensitive   = false
+  value       = try(azurerm_virtual_network.this.address_space)
+}
+
+output "virtual_network_guid" {
+  description = "The GUID of the virtual network."
+  sensitive   = false
+  value       = try(azurerm_virtual_network.this.guid)
+}

variables.tf

@@ -0,0 +1,37 @@
+variable "virtual_network_name" {
+  description = "The name of the virtual network. Changing this forces a new resource to be created."
+  type        = string
+  sensitive   = false
+}
+
+variable "azure_location" {
+  description = "The location/region where the virtual network is created. Changing this forces a new resource to be created."
+  type        = string
+  sensitive   = false
+}
+
+variable "resource_group_name" {
+  description = "The name of the resource group in which to create the virtual network. Changing this forces a new resource to be created."
+  type        = string
+  sensitive   = false
+}
+
+variable "virtual_network_cidr" {
+  description = "The address space that is used the virtual network. You can supply more than one address space."
+  type        = list(string)
+  sensitive   = false
+}
+
+variable "virtual_network_dns" {
+  description = "List of IP addresses of DNS servers"
+  type        = list(string)
+  sensitive   = false
+  default     = []
+}
+
+variable "virtual_network_tags" {
+  description = "A mapping of tags to assign to the resource."
+  type        = map(string)
+  sensitive   = false
+  default     = {}
+}