Eventhubs

This Terraform module facilitates the setup and management of event hub resources on azure, providing flexible configurations for namespace creation and event hub instances. It ensures a robust and scalable messaging platform in the cloud, designed to handle massive amounts of event data in real-time.

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

• simplifies managing multiple event hubs
• supports multiple schema groups for consistent event data structuring
• streamlines setup of multiple consumer groups
• enables clustering with multiple namespaces
• supports setting up various authorization rules for detailed access control
• utilization of terratest for robust validation

Requirements

Name	Version
terraform	~> 1.0
azurerm	~> 3.61

Providers

Name	Version
azurerm	~> 3.61

Modules

Name	Source
cluster	resource

Resources

Name	Type
azurerm_eventhub	resource
azurerm_eventhub_consumer_group	resource
azurerm_eventhub_namespace	resource
azurerm_eventhub_namespace_authorization_rule	resource
azurerm_eventhub_namespace_schema_group	resource
azurerm_eventhub_cluster	resource

Inputs

Name	Description	Type	Required
namespace	contains eventhub namespace 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
namespace	contains the eventhub namespace
eventhubs	contains all eventhub config

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.

License

MIT Licensed. See LICENSE for full details.

Reference

• Documentation
• Rest Api
• Rest Api Specs