Skip to content

CloudNationHQ/terraform-azure-sa

Repository files navigation

Storage Account

This terraform module simplifies the process of creating and managing storage accounts on azure with customizable options and features, offering a flexible and powerful solution for managing azure storage through code.

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

  • offers support for shares, tables, containers, and queues.
  • employs management policies using a variety of rules.
  • provides advanced threat protection capabilities.
  • utilization of terratest for robust validation.
  • facilitates cors to securely control access to assets across different domains.
  • supports optional active directory authentication for enhanced security in azure file shares.
  • integrates seamlessly with private endpoint capabilities for direct and secure connectivity.
  • support for ADLS Gen 2 file systems and file system paths

Requirements

Name Version
terraform ~> 1.0
azurerm ~> 4.0
random ~> 3.6

Providers

Name Version
azurerm ~> 4.0

Resources

Name Type
azurerm_advanced_threat_protection.prot resource
azurerm_role_assignment.managed_identity resource
azurerm_storage_account.sa resource
azurerm_storage_container.sc resource
azurerm_storage_data_lake_gen2_filesystem.fs resource
azurerm_storage_data_lake_gen2_path.pa resource
azurerm_storage_management_policy.mgmt_policy resource
azurerm_storage_queue.sq resource
azurerm_storage_share.sh resource
azurerm_storage_table.st resource
azurerm_user_assigned_identity.identity resource
azurerm_subscription.current data source

Inputs

Name Description Type Default Required
location default azure region to be used. string null no
naming contains naming convention map(string) {} no
resource_group default resource group to be used. string null no
storage storage account details any n/a yes
tags tags to be added to the resources map(string) {} no

Outputs

Name Description
account storage account details
containers container configuration specifics
file_system_paths file system paths configuration specifics
file_systems file systems configuration specifics
queues queues configuration specifics
shares shares configuration specifics
subscription_id contains the current subscription id
tables tables configuration specifics

Testing

For more information, please see our testing guidelines

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.

To update the module's documentation run make doc

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.

References