Skip to content

CloudNationHQ/terraform-azure-lb

Repository files navigation

Load Balancer

This terraform module simplifies the setup and management of azure load balancers, providing flexible frontend and backend configurations for optimized traffic distribution and network efficiency.

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

  • utilization of terratest for robust validation.
  • enables multiple backend pools and address configurations.
  • allows multiple IP configurations on frontend endpoints.
  • multiple load balancing rules and probes per backend pool.
  • multiple outbound rules per backend pool.
  • supports multiple nat pools.
  • enables creation of multiple nat rules.
  • multiple tunnel interfaces on backend pools on gateway load balancers.

Requirements

Name Version
terraform ~> 1.0
azurerm ~> 4.0

Providers

Name Version
azurerm ~> 4.0

Resources

Name Type
azurerm_lb.lb resource
azurerm_lb_backend_address_pool.pools resource
azurerm_lb_backend_address_pool_address.pool_addresses resource
azurerm_lb_nat_pool.nat_pools resource
azurerm_lb_nat_rule.nat_rules resource
azurerm_lb_outbound_rule.outbound_rules resource
azurerm_lb_probe.probes resource
azurerm_lb_rule.rules resource

Inputs

Name Description Type Default Required
config contains load balancer configuration any n/a yes
location default azure region to be used. string null no
resource_group default resource group to be used. string null no
tags tags to be added to the resources map(string) {} no

Outputs

Name Description
backend_pools contains load balancer backend pools
config contains load balancer configuration
nat_pools contains load balancer nat pools
nat_rules contains load balancer nat rules
probes contains load balancer probes
rules contains load balancer rules

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