Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/claranet/terraform-azurerm-eventhub

Terraform module for Azure Eventhub
https://github.com/claranet/terraform-azurerm-eventhub
azure claranet module terraform
Last synced: 3 months ago
JSON representation
Terraform module for Azure Eventhub
Host: GitHub
URL: https://github.com/claranet/terraform-azurerm-eventhub
Owner: claranet
License: apache-2.0
Created: 2020-03-24T15:40:07.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-10-16T23:46:04.000Z (4 months ago)
Last Synced: 2024-10-19T00:04:11.317Z (3 months ago)
Topics: azure, claranet, module, terraform
Language: HCL
Homepage:
Size: 186 KB
Stars: 5
Watchers: 8
Forks: 14
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project

README

        # Azure Eventhub feature

[![Changelog](https://img.shields.io/badge/changelog-release-green.svg)](CHANGELOG.md) [![Notice](https://img.shields.io/badge/notice-copyright-blue.svg)](NOTICE) [![Apache V2 License](https://img.shields.io/badge/license-Apache%20V2-orange.svg)](LICENSE) [![OpenTofu Registry](https://img.shields.io/badge/opentofu-registry-yellow.svg)](https://search.opentofu.org/module/claranet/eventhub/azurerm/)

This Terraform module creates an [Azure Eventhub](https://docs.microsoft.com/en-us/azure/event-hubs/).

## Global versioning rule for Claranet Azure modules

| Module version | Terraform version | OpenTofu version | AzureRM version |

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

| >= 8.x.x       | **Unverified**    | 1.8.x            | >= 4.0          |

| >= 7.x.x       | 1.3.x             |                  | >= 3.0          |

| >= 6.x.x       | 1.x               |                  | >= 3.0          |

| >= 5.x.x       | 0.15.x            |                  | >= 2.0          |

| >= 4.x.x       | 0.13.x / 0.14.x   |                  | >= 2.0          |

| >= 3.x.x       | 0.12.x            |                  | >= 2.0          |

| >= 2.x.x       | 0.12.x            |                  | < 2.0           |

| <  2.x.x       | 0.11.x            |                  | < 2.0           |

## Contributing

If you want to contribute to this repository, feel free to use our [pre-commit](https://pre-commit.com/) git hook configuration

which will help you automatically update and format some files for you by enforcing our Terraform code module best-practices.

More details are available in the [CONTRIBUTING.md](./CONTRIBUTING.md#pull-request-process) file.

## Usage

This module is optimized to work with the [Claranet terraform-wrapper](https://github.com/claranet/terraform-wrapper) tool

which set some terraform variables in the environment needed by this module.

More details about variables set by the `terraform-wrapper` available in the [documentation](https://github.com/claranet/terraform-wrapper#environment).

⚠️ Since modules version v8.0.0, we do not maintain/check anymore the compatibility with

[Hashicorp Terraform](https://github.com/hashicorp/terraform/). Instead, we recommend to use [OpenTofu](https://github.com/opentofu/opentofu/).

```hcl

module "azure_region" {

  source  = "claranet/regions/azurerm"

  version = "x.x.x"

  azure_region = var.azure_region

}

module "rg" {

  source  = "claranet/rg/azurerm"

  version = "x.x.x"

  location    = module.azure_region.location

  client_name = var.client_name

  environment = var.environment

  stack       = var.stack

}

module "logs" {

  source  = "claranet/run/azurerm//modules/logs"

  version = "x.x.x"

  client_name         = var.client_name

  environment         = var.environment

  stack               = var.stack

  location            = module.azure_region.location

  location_short      = module.azure_region.location_short

  resource_group_name = module.rg.resource_group_name

}

module "eventhub" {

  source  = "claranet/eventhub/azurerm"

  version = "x.x.x"

  location       = module.azure_region.location

  location_short = module.azure_region.location_short

  client_name    = var.client_name

  environment    = var.environment

  stack          = var.stack

  resource_group_name = module.rg.resource_group_name

  create_dedicated_cluster = true

  namespace_parameters = {

    sku      = "Standard"

    capacity = 2

  }

  namespace_authorizations = {

    listen = true

    send   = false

  }

  network_rules_enabled = true

  allowed_cidrs         = ["1.1.1.1/32"]

  allowed_subnet_ids = [

    var.subnet_id

  ]

  hubs_parameters = {

    main = {

      custom_name     = "main-queue-hub"

      partition_count = 2

      authorizations = {

        listen = true

        send   = true

        manage = false

      }

    }

  }

  logs_destinations_ids = [

    module.logs.logs_storage_account_id,

    module.logs.log_analytics_workspace_id

  ]

}

```

## Providers

| Name | Version |

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

| azurecaf | ~> 1.2, >= 1.2.22 |

| azurerm | ~> 3.39 |

## Modules

| Name | Source | Version |

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

| diagnostics | claranet/diagnostic-settings/azurerm | ~> 7.0.0 |

## Resources

| Name | Type |

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

| [azurerm_eventhub.eventhub](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/eventhub) | resource |

| [azurerm_eventhub_authorization_rule.listen](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/eventhub_authorization_rule) | resource |

| [azurerm_eventhub_authorization_rule.manage](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/eventhub_authorization_rule) | resource |

| [azurerm_eventhub_authorization_rule.send](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/eventhub_authorization_rule) | resource |

| [azurerm_eventhub_cluster.cluster](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/eventhub_cluster) | resource |

| [azurerm_eventhub_consumer_group.eventhub_consumer_group](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/eventhub_consumer_group) | resource |

| [azurerm_eventhub_namespace.eventhub](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/eventhub_namespace) | resource |

| [azurerm_eventhub_namespace_authorization_rule.listen](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/eventhub_namespace_authorization_rule) | resource |

| [azurerm_eventhub_namespace_authorization_rule.manage](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/eventhub_namespace_authorization_rule) | resource |

| [azurerm_eventhub_namespace_authorization_rule.send](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/eventhub_namespace_authorization_rule) | resource |

| [azurecaf_name.consumer_group](https://registry.terraform.io/providers/claranet/azurecaf/latest/docs/data-sources/name) | data source |

| [azurecaf_name.eventhub](https://registry.terraform.io/providers/claranet/azurecaf/latest/docs/data-sources/name) | data source |

| [azurecaf_name.eventhub_auth_rule](https://registry.terraform.io/providers/claranet/azurecaf/latest/docs/data-sources/name) | data source |

| [azurecaf_name.eventhub_namespace](https://registry.terraform.io/providers/claranet/azurecaf/latest/docs/data-sources/name) | data source |

| [azurecaf_name.eventhub_namespace_auth_rule](https://registry.terraform.io/providers/claranet/azurecaf/latest/docs/data-sources/name) | data source |

## Inputs

| Name | Description | Type | Default | Required |

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

| allowed\_cidrs | List of CIDR to allow access to that EventHub Namespace. | `list(string)` | `[]` | no |

| allowed\_subnet\_ids | Subnets to allow access to that EventHub Namespace. | `list(string)` | `[]` | no |

| client\_name | Client name/account used in naming. | `string` | n/a | yes |

| create\_dedicated\_cluster | If `true`, an EventHub Cluster is created and associated to the Namespace. | `bool` | `false` | no |

| custom\_diagnostic\_settings\_name | Custom name of the diagnostics settings, name will be 'default' if not set. | `string` | `"default"` | no |

| custom\_namespace\_auth\_rule\_name | Custom authorization rule name for EventHub namespace. | `string` | `null` | no |

| custom\_namespace\_name | Custom resource name for EventHub namespace. | `string` | `""` | no |

| default\_tags\_enabled | Option to enable or disable default tags | `bool` | `true` | no |

| environment | Project environment. | `string` | n/a | yes |

| extra\_tags | Extra tags to add | `map(string)` | `{}` | no |

| hubs\_parameters | Map of Event Hub parameters objects (key is hub shortname). | 
map(object({
    custom_name       = optional(string)
    partition_count   = number
    message_retention = optional(number, 7)
    capture_description = optional(object({
      enabled             = optional(bool, true)
      encoding            = string
      interval_in_seconds = optional(number)
      size_limit_in_bytes = optional(number)
      skip_empty_archives = optional(bool)
      destination = object({
        name                = optional(string, "EventHubArchive.AzureBlockBlob")
        archive_name_format = optional(string)
        blob_container_name = string
        storage_account_id  = string
      })
    }))

    consumer_group = optional(object({
      enabled       = optional(bool, false)
      custom_name   = optional(string)
      user_metadata = optional(string)
    }), {})

    authorizations = optional(object({
      listen = optional(bool, true)
      send   = optional(bool, true)
      manage = optional(bool, true)
    }), {})
  })) | `{}` | no |

| location | Azure location for Eventhub. | `string` | n/a | yes |

| location\_short | Short string for Azure location. | `string` | n/a | yes |

| logs\_categories | Log categories to send to destinations. | `list(string)` | `null` | no |

| logs\_destinations\_ids | List of destination resources IDs for logs diagnostic destination.
Can be `Storage Account`, `Log Analytics Workspace` and `Event Hub`. No more than one of each can be set.
If you want to specify an Azure EventHub to send logs and metrics to, you need to provide a formated string with both the EventHub Namespace authorization send ID and the EventHub name (name of the queue to use in the Namespace) separated by the `|` character. | `list(string)` | n/a | yes |

| logs\_metrics\_categories | Metrics categories to send to destinations. | `list(string)` | `null` | no |

| name\_prefix | Optional prefix for the generated name | `string` | `""` | no |

| name\_suffix | Optional suffix for the generated name | `string` | `""` | no |

| namespace\_authorizations | Object to specify which Namespace authorizations need to be created. | object({
    listen = optional(bool, true)
    send   = optional(bool, true)
    manage = optional(bool, true)
  }) | `{}` | no |

| namespace\_parameters | EventHub Namespace parameters:- sku:                  Defines which tier to use. Valid options are `Basic`, `Standard`, and `Premium`. Please not that setting this field to Premium will force the creation of a new resource and also requires setting zone_redundant to true.
- capacity:             Specifies the Capacity / Throughput Units for a Standard SKU namespace. Default capacity has a maximum of 2, but can be increased in blocks of 2 on a committed purchase basis.
- auto_inflate_enabled: Is Auto Inflate enabled for the Event Hub namespace?
- dedicated_cluster_id: Specifies the ID of the Event Hub Dedicated Cluster where this namespace should created.
- maximum_throughput_units: Specifies the maximum number of throughput units when Auto Inflate is Enabled. Valid values range from `1 - 20`.
- zone_redundant:       Specifies if the Event Hub namespace should be Zone Redundant (created across Availability Zones). Changing this forces a new resource to be created.
- local_authentication_enabled: Is SAS authentication enabled for the EventHub Namespace?
- public_network_access_enabled: Is public network access enabled for the EventHub Namespace? Defaults to `true`.
- minimum_tls_version:  The minimum supported TLS version for this EventHub Namespace. Valid values are: `1.0`, `1.1` and `1.2`. The current default minimum TLS version is `1.2`.
 | object({
    sku                           = optional(string, "Standard")
    capacity                      = optional(number, 2)
    auto_inflate_enabled          = optional(bool, false)
    dedicated_cluster_id          = optional(string)
    maximum_throughput_units      = optional(number)
    zone_redundant                = optional(bool, true)
    local_authentication_enabled  = optional(bool)
    public_network_access_enabled = optional(bool, true)
    minimum_tls_version           = optional(string, "1.2")
  }) | n/a | yes |

| network\_rules\_default\_action | The default action to take when a rule is not matched. Possible values are `Allow` and `Deny`. | `string` | `"Deny"` | no |

| network\_rules\_enabled | Boolean to enable Network Rules on the EventHub Namespace, requires `allowed_cidrs`, `allowed_subnet_ids`, `network_rules_default_action` or `network_trusted_service_access_enabled` correctly set if enabled. | `bool` | `false` | no |

| network\_trusted\_service\_access\_enabled | Whether Trusted Microsoft Services are allowed to bypass firewall. | `bool` | `true` | no |

| resource\_group\_name | Name of the resource group. | `string` | n/a | yes |

| stack | Project stack name. | `string` | n/a | yes |

| use\_caf\_naming | Use the Azure CAF naming provider to generate default resource name. `custom_namespace_name` override this if set. Legacy default name is used if this is set to `false`. | `bool` | `true` | no |

## Outputs

| Name | Description |

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

| consumer\_groups | Azure Event Hub Consumer Groups. |

| environment | Application environment. |

| eventhubs | Azure Event Hubs outputs. |

| hubs\_listen\_authorization\_rule | Event Hubs listen only authorization rules. |

| hubs\_manage\_authorization\_rule | Event Hubs Namespace manage authorization rules. |

| hubs\_send\_authorization\_rule | Event Hubs send only authorization rules. |

| location | Azure region. |

| namespace\_default\_authorization\_rule\_name | Event Hub Namespace default authorization rule name. |

| namespace\_default\_primary\_connection\_string | Event Hub Namespace default primary connection string. |

| namespace\_default\_primary\_key | Event Hub Namespace default primary key. |

| namespace\_default\_secondary\_connection\_string | Eventhub Namespace default secondary connection string. |

| namespace\_default\_secondary\_key | Event Hub Namespace default secondary key. |

| namespace\_id | Azure Event Hub Namespace ID. |

| namespace\_listen\_authorization\_rule | Event Hub Namespace listen only authorization rule. |

| namespace\_manage\_authorization\_rule | Event Hub Namespace manage authorization rule. |

| namespace\_name | Azure Event Hub Namespace name. |

| namespace\_send\_authorization\_rule | Event Hub Namespace send only authorization rule. |

| resource\_group\_name | Azure Resource Group name. |

## Related documentation

Microsoft Azure documentation: [docs.microsoft.com/en-us/azure/event-hubs/](https://docs.microsoft.com/en-us/azure/event-hubs/)