Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cloudnationhq/terraform-azure-sb

Terraform module which creates servicebus resources used by workloads and accelerators.
https://github.com/cloudnationhq/terraform-azure-sb

azure terraform wam

Last synced: 29 days ago
JSON representation

Terraform module which creates servicebus resources used by workloads and accelerators.

Awesome Lists containing this project

README 

        
# Service Bus



This Terraform module streamlines the creation and management of azure service bus resources. It enables efficient messaging infrastructure for cloud native applications with minimal configuration.



## 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.

- supports creation of multiple service bus namespaces.

- enables multiple authorization rules per namespace.

- supports multiple queues with individual authorization rules.

- enables creation of multiple topics and subscriptions.

- allows multiple authorization rules per topic.

- supports multiple subscription rules per subscription.

- facilitates complex message filtering and routing configurations.



## Requirements



| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | ~> 1.0 |

|  [azurerm](#requirement\_azurerm) | ~> 4.0 |



## Providers



| Name | Version |

|------|---------|

|  [azurerm](#provider\_azurerm) | ~> 4.0 |



## Resources



| Name | Type |

|------|------|

| [azurerm_servicebus_namespace.ns](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/servicebus_namespace) | resource |

| [azurerm_servicebus_namespace_authorization_rule.auth_rule](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/servicebus_namespace_authorization_rule) | resource |

| [azurerm_servicebus_queue.queue](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/servicebus_queue) | resource |

| [azurerm_servicebus_queue_authorization_rule.queue_auth_rule](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/servicebus_queue_authorization_rule) | resource |

| [azurerm_servicebus_subscription.subscription](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/servicebus_subscription) | resource |

| [azurerm_servicebus_subscription_rule.rule](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/servicebus_subscription_rule) | resource |

| [azurerm_servicebus_topic.topic](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/servicebus_topic) | resource |

| [azurerm_servicebus_topic_authorization_rule.topic_auth_rule](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/servicebus_topic_authorization_rule) | resource |



## Inputs



| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [config](#input\_config) | contains service bus namespace configuration1 | `any` | n/a | yes |

|  [location](#input\_location) | default azure region to be used. | `string` | `null` | no |

|  [naming](#input\_naming) | contains naming convention | `map(string)` | `{}` | no |

|  [resource\_group](#input\_resource\_group) | default resource group to be used. | `string` | `null` | no |

|  [tags](#input\_tags) | tags to be added to the resources | `map(string)` | `{}` | no |



## Outputs



| Name | Description |

|------|-------------|

|  [config](#output\_config) | contains service bus namespace configuration1 |

|  [queue\_auth\_rules](#output\_queue\_auth\_rules) | contains service bus queue authorization rules configuration |

|  [queues](#output\_queues) | contains service bus queues configuration |

|  [subscriptions](#output\_subscriptions) | contains service bus topic subscriptions configuration |

|  [topic\_auth\_rules](#output\_topic\_auth\_rules) | contains service bus topic authorization rules configuration |

|  [topics](#output\_topics) | contains service bus topics configuration |



## Testing



Ensure go and terraform are installed.



Run tests for different usage scenarios by specifying the EXAMPLE environment variable. Usage examples are in the examples directory.



To execute a test, run `make test EXAMPLE=default`



Replace default with the specific example you want to test. These tests ensure the module performs reliably across various 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.



To update the module's documentation run `make doc`



## Authors



Module is maintained by [these awesome contributors](https://github.com/cloudnationhq/terraform-azure-sb/graphs/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](./CONTRIBUTING.md).



## License



MIT Licensed. See [LICENSE](./LICENSE) for full details.



## References



- [Documentation](https://learn.microsoft.com/en-us/azure/service-bus-messaging/)

- [Rest Api](https://learn.microsoft.com/en-us/rest/api/servicebus/)

- [Rest Api Specs](https://github.com/hashicorp/pandora/tree/main/api-definitions/resource-manager/ServiceBus)