Virtual Machine

This Terraform module simplifies the configuration and management of virtual machines. It offers extensive customization options to match your specific deployment needs, streamlining the provisioning and maintenance process.

Goals

The main objective is to create a more logic data structure, achieved by combining and grouping related resources together in a complex object.

The structure of the module promotes reusability. It's intended to be a repeatable component, simplifying the process of building diverse workloads and platform accelerators consistently.

A primary goal is to utilize keys and values in the object that correspond to the REST API's structure. This enables us to carry out iterations, increasing its practical value as time goes on.

A last key goal is to separate logic from configuration in the module, thereby enhancing its scalability, ease of customization, and manageability.

Features

• flexibility to incorporate multiple extensions
• utilization of Terratest for robust validation
• ability to use multiple interfaces and disks
• supports both system and multiple user assigned identities
• supports custom data integration
• compatible with both Linux and Windows environments
• supports availability sets to enhance fault tolerance and availability

Requirements

Name	Version
terraform	~> 1.0
azurerm	~> 3.61
random	~> 3.5.1
tls	~> 4.0.4

Providers

Name	Version
azurerm	~> 3.61
random	~> 3.5.1
tls	~> 4.0.4

Resources

Name	Type
random_password	resource
azurerm_key_vault_secret	resource
azurerm_linux_virtual_machine	resource
azurerm_windows_virtual_machine	resource
azurerm_network_interface	resource
azurerm_virtual_machine_extension	resource
azurerm_subscription	data source
tls_private_key	resource
azurerm_key_vault_secret	resource
azurerm_managed_disk	resource
azurerm_virtual_machine_data_disk_attachment	resource
azurerm_user_assigned_identity	resource
azurerm_availability_set	resource

Modules

Name	Source
availability-sets	resource

Inputs

Name	Description	Type	Required
instance	contains all virtual machine config	object	yes
naming	used for naming purposes	string	yes
keyvault	keyvault to store secrets	string	yes
location	default azure region and can be used if location is not specified inside the object	string	no
resourcegroup	default resource group and can be used if resourcegroup is not specified inside the object	string	no
tags	tags to be added to the resources	map(string)	no

Outputs

Name	Description
instance	contains all virtual machine config
subscriptionId	contains the current subscription id
uai	contains the user assigned identity

Testing

As a prerequirement, please ensure that both go and terraform are properly installed on your system.

The Makefile includes two distinct variations of tests. The first one is designed to deploy different usage scenarios of the module. These tests are executed by specifying the TF_PATH environment variable, which determines the different usages located in the example directory.

To execute this test, input the command make test TF_PATH=default, substituting default with the specific usage you wish to test.

The second variation is known as a extended test. This one performs additional checks and can be executed without specifying any parameters, using the command make test_extended.

Both are designed to be executed locally and are also integrated into the github workflow.

Each of these tests contributes to the robustness and resilience of the module. They ensure the module performs consistently and accurately under different scenarios and configurations.

Notes

Using a dedicated module, we've developed a naming convention for resources that's based on specific regular expressions for each type, ensuring correct abbreviations and offering flexibility with multiple prefixes and suffixes

Full examples detailing all usages, along with integrations with dependency modules, are located in the examples directory

Authentication for linux virtual machines can be done with either ssh keys or passwords.

Authors

Module is maintained by these awesome contributors.

License

MIT Licensed. See LICENSE for full details.

Reference

• Documentation
• Rest Api
• Rest Api Specs