Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/launchbynttdata/tf-azurerm-module_primitive-function_app

azure primitive terraform
Last synced: 5 days ago
JSON representation
Host: GitHub
URL: https://github.com/launchbynttdata/tf-azurerm-module_primitive-function_app
Owner: launchbynttdata
License: apache-2.0
Created: 2024-09-04T14:41:27.000Z (4 months ago)
Default Branch: main
Last Pushed: 2024-12-16T21:59:44.000Z (23 days ago)
Last Synced: 2024-12-16T22:50:55.873Z (23 days ago)
Topics: azure, primitive, terraform
Language: HCL
Size: 46.9 KB
Stars: 0
Watchers: 0
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project

README

        # tf-azurerm-module_primitive-function_app

[![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

This terraform module provisions an Azure Function App with additional pre-requisite resources

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

## Providers

| Name | Version |

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

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

## Modules

No modules.

## Resources

| Name | Type |

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

| [azurerm_linux_function_app.func](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/linux_function_app) | resource |

| [azurerm_windows_function_app.windows_func](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/windows_function_app) | resource |

| [azurerm_service_plan.asp](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/service_plan) | data source |

| [azurerm_storage_account.sa](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/storage_account) | data source |

## Inputs

| Name | Description | Type | Default | Required |

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

|  [function\_app\_name](#input\_function\_app\_name) | Name of the function app to create | `string` | n/a | yes |

|  [service\_plan\_name](#input\_service\_plan\_name) | Name of the service plan to create | `string` | n/a | yes |

|  [storage\_account\_name](#input\_storage\_account\_name) | Name of the storage account to create | `string` | n/a | yes |

|  [storage\_account\_access\_key](#input\_storage\_account\_access\_key) | Access key for the storage account | `string` | `null` | no |

|  [resource\_group\_name](#input\_resource\_group\_name) | name of the resource group where the function app will be created | `string` | n/a | yes |

|  [location](#input\_location) | Location where the function app will be created | `string` | n/a | yes |

|  [app\_settings](#input\_app\_settings) | Environment variables to set on the function app | `map(string)` | `{}` | no |

|  [functions\_extension\_version](#input\_functions\_extension\_version) | The version of the Azure Functions runtime to use | `string` | `"~4"` | no |

|  [https\_only](#input\_https\_only) | If true, the function app will only accept HTTPS requests | `bool` | `true` | no |

|  [public\_network\_access\_enabled](#input\_public\_network\_access\_enabled) | If true, the function app will be accessible from the public internet | `bool` | `true` | no |

|  [site\_config](#input\_site\_config) | object({
  always\_on        = If this Linux Web App is Always On enabled. Defaults to false.
  app\_command\_line = The App command line to launch.
  app\_scale\_limit  = The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
  application\_insights\_connection\_string = The connection string of the Application Insights instance to use.
  application\_insights\_key               = The key of the Application Insights instance to use.
  application\_stack = optional(object({
    docker = optional(object({
      image\_name        = The name of the Docker image to use.
      image\_tag         = The image tag of the image to use.
      registry\_url      = The URL of the docker registry.
      registry\_username = The username to use for connections to the registry.
      registry\_password = The password for the account to use to connect to the registry.
    }))
    dotnet\_version              = optional(string)
    use\_dotnet\_isolated\_runtime = optional(bool)
    java\_version                = optional(string)
    node\_version                = optional(string)
    python\_version              = optional(string)
    powershell\_core\_version     = optional(string)
    use\_custom\_runtime          = optional(bool)
  }))
  container\_registry\_managed\_identity\_client\_id = The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry.
  container\_registry\_use\_managed\_identity       = Should connections for Azure Container Registry use Managed Identity.
  cors = optional(object({
    allowed\_origins     = list(string)
    support\_credentials = optional(bool)
  }))
  health\_check\_path = The path to be checked for this function app health.
  http2\_enabled     = Specifies if the HTTP2 protocol should be enabled. Defaults to false.
  ip\_restriction = optional(list(object({
    ip\_address = The CIDR notation of the IP or IP Range to match.
    action     = The action to take. Possible values are Allow or Deny. Defaults to Allow.
  })))
  minimum\_tls\_version = The configures the minimum version of TLS required for SSL requests. Defaults to '1.2'
}) | 
object({
    always_on                              = optional(bool)
    app_command_line                       = optional(string)
    app_scale_limit                        = optional(number)
    application_insights_connection_string = optional(string)
    application_insights_key               = optional(string)
    application_stack = optional(object({
      docker = optional(object({
        image_name        = string
        image_tag         = string
        registry_url      = optional(string)
        registry_username = optional(string)
        registry_password = optional(string)
      }))
      dotnet_version              = optional(string)
      use_dotnet_isolated_runtime = optional(bool)
      java_version                = optional(string)
      node_version                = optional(string)
      python_version              = optional(string)
      powershell_core_version     = optional(string)
      use_custom_runtime          = optional(bool)
    }))
    container_registry_managed_identity_client_id = optional(string)
    container_registry_use_managed_identity       = optional(bool)
    cors = optional(object({
      allowed_origins     = list(string)
      support_credentials = optional(bool)
    }))
    health_check_path             = optional(string)
    http2_enabled                 = optional(bool)
    ip_restriction_default_action = optional(string)
    scm_use_main_ip_restriction   = optional(bool)
    vnet_route_all_enabled        = optional(bool)
    ip_restriction = optional(list(object({
      ip_address                = optional(string)
      action                    = string
      name                      = optional(string)
      priority                  = optional(number)
      service_tag               = optional(string)
      virtual_network_subnet_id = optional(string)
      headers = optional(list(object({
        x_forwarded_for   = optional(string)
        x_forwarded_host  = optional(string)
        x_fd_health_probe = optional(string)
        x_azure_fdid      = optional(list(string))
      })))
    })))
    minimum_tls_version = optional(string)
  }) | `{}` | no |

|  [identity](#input\_identity) | (Optional) An identity block. | object({
    type         = string
    identity_ids = optional(list(string))
  }) | `null` | no |

|  [key\_vault\_reference\_identity\_id](#input\_key\_vault\_reference\_identity\_id) | (Optional) The identity ID of the Key Vault reference. Required when identity.type is set to UserAssigned or SystemAssigned, UserAssigned. | `string` | `null` | no |

|  [virtual\_network\_subnet\_id](#input\_virtual\_network\_subnet\_id) | (Optional) The ID of the subnet to place the function app in. | `string` | `null` | no |

|  [tags](#input\_tags) | n/a | `map(string)` | `{}` | no |

|  [os\_type](#input\_os\_type) | The operating system type of the function app | `string` | `"Linux"` | no |

## Outputs

| Name | Description |

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

|  [default\_hostname](#output\_default\_hostname) | The default hostname for the function app |

|  [function\_app\_name](#output\_function\_app\_name) | The name of the function app |

|  [function\_app\_id](#output\_function\_app\_id) | The ID of the function app |

|  [principal\_id](#output\_principal\_id) | The principal ID of the function app |

## Requirements

| Name | Version |

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

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

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

## Providers

| Name | Version |

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

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

## Modules

No modules.

## Resources

| Name | Type |

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

| [azurerm_linux_function_app.func](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/linux_function_app) | resource |

| [azurerm_windows_function_app.windows_func](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/windows_function_app) | resource |

| [azurerm_service_plan.asp](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/service_plan) | data source |

| [azurerm_storage_account.sa](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/storage_account) | data source |

## Inputs

| Name | Description | Type | Default | Required |

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

|  [function\_app\_name](#input\_function\_app\_name) | Name of the function app to create | `string` | n/a | yes |

|  [service\_plan\_name](#input\_service\_plan\_name) | Name of the service plan to create | `string` | n/a | yes |

|  [storage\_account\_name](#input\_storage\_account\_name) | Name of the storage account to create | `string` | n/a | yes |

|  [storage\_account\_access\_key](#input\_storage\_account\_access\_key) | Access key for the storage account | `string` | `null` | no |

|  [resource\_group\_name](#input\_resource\_group\_name) | name of the resource group where the function app will be created | `string` | n/a | yes |

|  [location](#input\_location) | Location where the function app will be created | `string` | n/a | yes |

|  [app\_settings](#input\_app\_settings) | Environment variables to set on the function app | `map(string)` | `{}` | no |

|  [functions\_extension\_version](#input\_functions\_extension\_version) | The version of the Azure Functions runtime to use | `string` | `"~4"` | no |

|  [https\_only](#input\_https\_only) | If true, the function app will only accept HTTPS requests | `bool` | `true` | no |

|  [public\_network\_access\_enabled](#input\_public\_network\_access\_enabled) | If true, the function app will be accessible from the public internet | `bool` | `true` | no |

|  [site\_config](#input\_site\_config) | object({
  always\_on        = If this Linux Web App is Always On enabled. Defaults to false.
  app\_command\_line = The App command line to launch.
  app\_scale\_limit  = The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
  application\_insights\_connection\_string = The connection string of the Application Insights instance to use.
  application\_insights\_key               = The key of the Application Insights instance to use.
  application\_stack = optional(object({
    docker = optional(object({
      image\_name        = The name of the Docker image to use.
      image\_tag         = The image tag of the image to use.
      registry\_url      = The URL of the docker registry.
      registry\_username = The username to use for connections to the registry.
      registry\_password = The password for the account to use to connect to the registry.
    }))
    dotnet\_version              = optional(string)
    use\_dotnet\_isolated\_runtime = optional(bool)
    java\_version                = optional(string)
    node\_version                = optional(string)
    python\_version              = optional(string)
    powershell\_core\_version     = optional(string)
    use\_custom\_runtime          = optional(bool)
  }))
  container\_registry\_managed\_identity\_client\_id = The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry.
  container\_registry\_use\_managed\_identity       = Should connections for Azure Container Registry use Managed Identity.
  cors = optional(object({
    allowed\_origins     = list(string)
    support\_credentials = optional(bool)
  }))
  health\_check\_path = The path to be checked for this function app health.
  http2\_enabled     = Specifies if the HTTP2 protocol should be enabled. Defaults to false.
  ip\_restriction = optional(list(object({
    ip\_address = The CIDR notation of the IP or IP Range to match.
    action     = The action to take. Possible values are Allow or Deny. Defaults to Allow.
  })))
  minimum\_tls\_version = The configures the minimum version of TLS required for SSL requests. Defaults to '1.2'
}) | 
object({
    always_on                              = optional(bool)
    app_command_line                       = optional(string)
    app_scale_limit                        = optional(number)
    application_insights_connection_string = optional(string)
    application_insights_key               = optional(string)
    application_stack = optional(object({
      docker = optional(object({
        image_name        = string
        image_tag         = string
        registry_url      = optional(string)
        registry_username = optional(string)
        registry_password = optional(string)
      }))
      dotnet_version              = optional(string)
      use_dotnet_isolated_runtime = optional(bool)
      java_version                = optional(string)
      node_version                = optional(string)
      python_version              = optional(string)
      powershell_core_version     = optional(string)
      use_custom_runtime          = optional(bool)
    }))
    container_registry_managed_identity_client_id = optional(string)
    container_registry_use_managed_identity       = optional(bool)
    cors = optional(object({
      allowed_origins     = list(string)
      support_credentials = optional(bool)
    }))
    health_check_path             = optional(string)
    http2_enabled                 = optional(bool)
    ip_restriction_default_action = optional(string)
    scm_use_main_ip_restriction   = optional(bool)
    vnet_route_all_enabled        = optional(bool)
    ip_restriction = optional(list(object({
      ip_address                = optional(string)
      action                    = string
      name                      = optional(string)
      priority                  = optional(number)
      service_tag               = optional(string)
      virtual_network_subnet_id = optional(string)
      headers = optional(list(object({
        x_forwarded_for   = optional(string)
        x_forwarded_host  = optional(string)
        x_fd_health_probe = optional(string)
        x_azure_fdid      = optional(list(string))
      })))
    })))
    minimum_tls_version = optional(string)
  }) | `{}` | no |

|  [identity](#input\_identity) | (Optional) An identity block. | object({
    type         = string
    identity_ids = optional(list(string))
  }) | `null` | no |

|  [key\_vault\_reference\_identity\_id](#input\_key\_vault\_reference\_identity\_id) | (Optional) The identity ID of the Key Vault reference. Required when identity.type is set to UserAssigned or SystemAssigned, UserAssigned. | `string` | `null` | no |

|  [virtual\_network\_subnet\_id](#input\_virtual\_network\_subnet\_id) | (Optional) The ID of the subnet to place the function app in. | `string` | `null` | no |

|  [tags](#input\_tags) | n/a | `map(string)` | `{}` | no |

|  [os\_type](#input\_os\_type) | The operating system type of the function app | `string` | `"Linux"` | no |

## Outputs

| Name | Description |

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

|  [default\_hostname](#output\_default\_hostname) | The default hostname for the function app |

|  [function\_app\_name](#output\_function\_app\_name) | The name of the function app |

|  [function\_app\_id](#output\_function\_app\_id) | The ID of the function app |

|  [principal\_id](#output\_principal\_id) | The principal ID of the function app |