https://github.com/launchbynttdata/tf-azurerm-module_primitive-iothub_dps

Last synced: 13 days ago
JSON representation
Host: GitHub
URL: https://github.com/launchbynttdata/tf-azurerm-module_primitive-iothub_dps
Owner: launchbynttdata
License: apache-2.0
Created: 2025-03-04T17:06:24.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2026-03-19T18:23:08.000Z (4 months ago)
Last Synced: 2026-03-20T09:51:28.480Z (4 months ago)
Language: HCL
Size: 117 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Notice: NOTICE
Awesome Lists containing this project

README

          # tf-azurerm-module_primitive-iothub_dps

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![License: CC BY-NC-ND 4.0](https://img.shields.io/badge/License-CC_BY--NC--ND_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-nd/4.0/)

## Overview

Manages an Azure Device Provisioning Service.

## Pre-Commit hooks

[.pre-commit-config.yaml](.pre-commit-config.yaml) file defines certain `pre-commit` hooks that are relevant to terraform, golang and common linting tasks. There are no custom hooks added.

`commitlint` hook enforces commit message in certain format. The commit contains the following structural elements, to communicate intent to the consumers of your commit messages:

- **fix**: a commit of the type `fix` patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).

- **feat**: a commit of the type `feat` introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).

- **BREAKING CHANGE**: a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.

footers other than BREAKING CHANGE:  may be provided and follow a convention similar to git trailer format.

- **build**: a commit of the type `build` adds changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)

- **chore**: a commit of the type `chore` adds changes that don't modify src or test files

- **ci**: a commit of the type `ci` adds changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)

- **docs**: a commit of the type `docs` adds documentation only changes

- **perf**: a commit of the type `perf` adds code change that improves performance

- **refactor**: a commit of the type `refactor` adds code change that neither fixes a bug nor adds a feature

- **revert**: a commit of the type `revert` reverts a previous commit

- **style**: a commit of the type `style` adds code changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

- **test**: a commit of the type `test` adds missing tests or correcting existing tests

Base configuration used for this project is [commitlint-config-conventional (based on the Angular convention)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum)

If you are a developer using vscode, [this](https://marketplace.visualstudio.com/items?itemName=joshbolduc.commitlint) plugin may be helpful.

`detect-secrets-hook` prevents new secrets from being introduced into the baseline. TODO: INSERT DOC LINK ABOUT HOOKS

In order for `pre-commit` hooks to work properly

- You need to have the pre-commit package manager installed. [Here](https://pre-commit.com/#install) are the installation instructions.

- `pre-commit` would install all the hooks when commit message is added by default except for `commitlint` hook. `commitlint` hook would need to be installed manually using the command below

```

pre-commit install --hook-type commit-msg

```

## To test the resource group module locally

1. For development/enhancements to this module locally, you'll need to install all of its components. This is controlled by the `configure` target in the project's [`Makefile`](./Makefile). Before you can run `configure`, familiarize yourself with the variables in the `Makefile` and ensure they're pointing to the right places.

```

make configure

```

This adds in several files and directories that are ignored by `git`. They expose many new Make targets.

2. _THIS STEP APPLIES ONLY TO MICROSOFT AZURE. IF YOU ARE USING A DIFFERENT PLATFORM PLEASE SKIP THIS STEP._ The first target you care about is `env`. This is the common interface for setting up environment variables. The values of the environment variables will be used to authenticate with cloud provider from local development workstation.

`make configure` command will bring down `azure_env.sh` file on local workstation. Devloper would need to modify this file, replace the environment variable values with relevant values.

These environment variables are used by `terratest` integration suit.

Service principle used for authentication(value of ARM_CLIENT_ID) should have below privileges on resource group within the subscription.

```

"Microsoft.Resources/subscriptions/resourceGroups/write"

"Microsoft.Resources/subscriptions/resourceGroups/read"

"Microsoft.Resources/subscriptions/resourceGroups/delete"

```

Then run this make target to set the environment variables on developer workstation.

```

make env

```

3. The first target you care about is `check`.

**Pre-requisites**

Before running this target it is important to ensure that, developer has created files mentioned below on local workstation under root directory of git repository that contains code for primitives/segments. Note that these files are `azure` specific. If primitive/segment under development uses any other cloud provider than azure, this section may not be relevant.

- A file named `provider.tf` with contents below

```

provider "azurerm" {

  features {}

}

```

- A file named `terraform.tfvars` which contains key value pair of variables used.

Note that since these files are added in `gitignore` they would not be checked in into primitive/segment's git repo.

After creating these files, for running tests associated with the primitive/segment, run

```

make check

```

If `make check` target is successful, developer is good to commit the code to primitive/segment's git repo.

`make check` target

- runs `terraform commands` to `lint`,`validate` and `plan` terraform code.

- runs `conftests`. `conftests` make sure `policy` checks are successful.

- runs `terratest`. This is integration test suit.

- runs `opa` tests

## Requirements

| Name | Version |

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

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

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

## Providers

| Name | Version |

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

|  [azurerm](#provider\_azurerm) | 3.117.1 |

## Modules

No modules.

## Resources

| Name | Type |

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

| [azurerm_iothub_dps.dps](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/iothub_dps) | resource |

## Inputs

| Name | Description | Type | Default | Required |

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

|  [name](#input\_name) | (Required) Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created. | `string` | n/a | yes |

|  [resource\_group\_name](#input\_resource\_group\_name) | (Required) The name of the resource group under which the Iot Device Provisioning Service resource has to be created. | `string` | n/a | yes |

|  [location](#input\_location) | (Required) Specifies the supported Azure location where the resource exists. | `string` | n/a | yes |

|  [allocation\_policy](#input\_allocation\_policy) | (Optional) The allocation policy of the IoT Device Provisioning Service (Hashed, GeoLatency or Static). Defaults to Hashed. | `string` | `"Hashed"` | no |

|  [data\_residency\_enabled](#input\_data\_residency\_enabled) | Optional) Specifies if the IoT Device Provisioning Service has data residency and disaster recovery enabled. Defaults to false. | `bool` | `false` | no |

|  [public\_network\_access\_enabled](#input\_public\_network\_access\_enabled) | (Optional) Boolean flag to specify whether or not public network access is enabled or not. Defaults to true. | `bool` | `true` | no |

|  [sku](#input\_sku) | (Required) The pricing tier for the IoT Device Provisioning Service.
    object({
      name     = (Required) The name of the sku. Currently can only be set to S1.
      capacity = (Required) The number of provisioned IoT Device Provisioning Service units. Currently set to 1.
    }) | 
object({
    name     = string
    capacity = number
  })
 | {
  "capacity": 1,
  "name": "S1"
} | no |

|  [linked\_hubs](#input\_linked\_hubs) | (Optional) A list of iothub objects linked to the Device Provisioning Service. Defaults to an empty list `[]`.
  list(object({
    connection\_string       = (Required) The connection string to connect to the IoT Hub.
    location                = (Required) The location of the IoT hub.
    apply\_allocation\_policy = (Optional) Determines whether to apply allocation policies to the IoT Hub. Defaults to true.
    allocation\_weight       = (Optional) The weight applied to the IoT Hub. Defaults to 1.
  })) | list(object({
    connection_string       = string
    location                = string
    apply_allocation_policy = optional(bool)
    allocation_weight       = optional(number)
  })) | `[]` | no |

|  [ip\_filter\_rules](#input\_ip\_filter\_rules) | (Optional) A list of ip\_filter\_rule objects. Defaults to an empty list `[]`.
  list(object({
    name    = (Required) The name of the filter.
    ip\_mask = (Required) The IP address range in CIDR notation for the rule.
    action  = (Required) The desired action for requests captured by this rule. Possible values are Accept, Reject
    target  = (Optional) Target for requests captured by this rule. Possible values are all, deviceApi and serviceApi.
  })) | list(object({
    name    = string
    ip_mask = string
    action  = string
    target  = optional(string)
  })) | `[]` | no |

|  [tags](#input\_tags) | (Optional) A mapping of tags to assign to the resource. | `map(string)` | `{}` | no |

## Outputs

| Name | Description |

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

|  [id](#output\_id) | The Device Provisioning Service Id. |

|  [name](#output\_name) | The Device Provisioning Service Name. |

|  [id\_scope](#output\_id\_scope) | The Device Provisioning Service Id Scope. |

|  [device\_provisioning\_host\_name](#output\_device\_provisioning\_host\_name) | The Device Provisioning Service Device Provisioning Host Name. |

|  [service\_operations\_host\_name](#output\_service\_operations\_host\_name) | The Device Provisioning Service Service Operations Host Name. |
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/launchbynttdata/tf-azurerm-module_primitive-iothub_dps

Awesome Lists containing this project

README
