cloudnationhq / terraform-azure-sql

Terraform module which creates mssql related resources used by workloads and accelerators.

Sql Server

This terraform module simplifies the creation and management of azure sql servers, offering a flexible and customizable solution for deploying fully-configured instances. It encapsulates best practices and provides a range of options to meet various requirements.

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.

Non-Goals

These modules are not intended to be complete, ready-to-use solutions; they are designed as components for creating your own patterns.

They are not tailored for a single use case but are meant to be versatile and applicable to a range of scenarios.

Security standardization is applied at the pattern level, while the modules include default values based on best practices but do not enforce specific security standards.

End-to-end testing is not conducted on these modules, as they are individual components and do not undergo the extensive testing reserved for complete patterns or solutions.

Features

• manages multiple sql databases and elastic pools.
• ability to associate multiple databases within a single elastic pool.
• support for adding virtual network and firewall rules
• utilization of terratest for robust validation.
• integrates seamlessly with private endpoint capabilities for direct and secure connectivity
• supports both system and multiple user assigned identities

Requirements

Name	Version
terraform	~> 1.0
azurerm	~> 3.61

Providers

Name	Version
azurerm	~> 3.61

Resources

Name	Type
azurerm_mssql_server	resource
azurerm_mssql_firewall_rule	resource
azurerm_mssql_virtual_network_rule	resource
azurerm_mssql_elasticpool	resource
azurerm_mssql_database	resource
azurerm_user_assigned_identity	resource

Inputs

Name	Description	Type	Required
instance	describes sql server related configuration	object	yes
naming	used for naming purposes	string	yes
location	default azure region tho be used	string	no
resourcegroup	default resource group to be used	string	no
tags	tags to be added to the resources	map(string)	no

Outputs

Name	Description
server	contains all sql server details
elasticpools	contains elastic pools
databases	contains databases

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

Authors

Module is maintained by these awesome contributors.

Contributing

We welcome contributions from the community! Whether it's reporting a bug, suggesting a new feature, or submitting a pull request, your input is highly valued.

For more information, please see our contribution guidelines.

License

MIT Licensed. See LICENSE for full details.

Reference

• Documentation
• Rest Api

terraform-azure-sql's Issues

Default admin account name should be generic

Currently the default admin account name contains a vendor name. This should be a generic value.

https://github.com/CloudNationHQ/terraform-azure-sql/blob/main/main.tf#L10C67-L10C83

Add option to change backup policy

Please add support for the following paramaters so we can configure backup retention from the module:

long_term_retention_policy
short_term_retention_policy

Should be added to "azurerm_mssql_database"

add support for transparant data encryption with cmk

available at:

https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/mssql_server#example-usage-for-transparent-data-encryptiontde-with-a-customer-managed-keycmk-during-create

[BUG] - xyz does not work

Is there an existing issue for this?

• I have searched the existing issues

Module Version

1.0.0

Terraform Version

1.0.0

AzureRM Provider Version

1.0.0

Short Description

this is a test

Terraform Configuration Files

module "naming" {
  source  = "cloudnationhq/naming/azure"
  version = "~> 0.1"

  suffix = ["demo", "dev"]
}

module "rg" {
  source  = "cloudnationhq/rg/azure"
  version = "~> 0.1"

  groups = {
    demo = {
      name   = module.naming.resource_group.name
      region = "westeurope"
    }
  }
}

module "kv" {
  source  = "cloudnationhq/kv/azure"
  version = "~> 0.1"

  naming = local.naming

  vault = {
    name          = module.naming.key_vault.name_unique
    location      = module.rg.groups.demo.location
    resourcegroup = module.rg.groups.demo.name

    secrets = {
      random_string = {
        sql = {
          length  = 24
          special = true
        }
      }
    }
  }
}

module "sql" {
  source  = "cloudnationhq/sql/azure"
  version = "~> 0.1"

  naming = local.naming

  instance = {
    name                         = module.naming.mssql_server.name_unique
    location                     = module.rg.groups.demo.location
    resourcegroup                = module.rg.groups.demo.name
    administrator_login_password = module.kv.secrets.sql.value
  }
}

Expected Behaviour

test

Actual Behaviour

No response

Steps to Reproduce

No response

Additional Context

No response

References

No response

add extended tests

[REQUEST] - add support for xyz

Is there an existing issue for this?

• I have searched the existing issues

Description

Test description

Potential Terraform Configuration

module "naming" {
  source  = "cloudnationhq/naming/azure"
  version = "~> 0.1"

  suffix = ["demo", "dev"]
}

module "rg" {
  source  = "cloudnationhq/rg/azure"
  version = "~> 0.1"

  groups = {
    demo = {
      name   = module.naming.resource_group.name
      region = "westeurope"
    }
  }
}

module "kv" {
  source  = "cloudnationhq/kv/azure"
  version = "~> 0.1"

  naming = local.naming

  vault = {
    name          = module.naming.key_vault.name_unique
    location      = module.rg.groups.demo.location
    resourcegroup = module.rg.groups.demo.name

    secrets = {
      random_string = {
        sql = {
          length  = 24
          special = true
        }
      }
    }
  }
}

module "sql" {
  source  = "cloudnationhq/sql/azure"
  version = "~> 0.1"

  naming = local.naming

  instance = {
    name                         = module.naming.mssql_server.name_unique
    location                     = module.rg.groups.demo.location
    resourcegroup                = module.rg.groups.demo.name
    administrator_login_password = module.kv.secrets.sql.value
  }
}

References

no references