Skip to content

Latest commit

 

History

History
198 lines (153 loc) · 17.9 KB

README.md

File metadata and controls

198 lines (153 loc) · 17.9 KB
Raw

nventive

terraform-azurerm-linux-docker-app-service

License Latest Release

Terraform module to provision an Azure Linux Web App (App Service) that runs a Docker image.

Important Azure App Service Limitation

Please note that Azure App Service will terminate TSL/SSL at the front ends. That means that TLS/SSL requests never get to your app. You don't need to, and shouldn't implement any support for TLS/SSL into your app. The front ends are located inside Azure data centers. If you use TLS/SSL with your app, your traffic across the Internet will always be safely encrypted.

See the following documentation.

Examples

IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.

With a public registry

module "echo_ghcr" {
  source = "nventive/linux-docker-app-service/azurerm"
  # We recommend pinning every module to a specific version
  # version = "x.x.x"

  resource_group_name     = azurerm_resource_group.example.name
  resource_group_location = azurerm_resource_group.example.location

  docker_registry_url = "https://ghcr.io"
  docker_image_name   = "mendhak/http-https-echo"
  docker_image_tag    = "latest"
  container_port      = 8080

  app_settings = {
    SOME_APP_SETTING = "foo"
  }
}

With Azure Container Registry

module "acr_with_role_assignment" {
  source = "nventive/linux-docker-app-service/azurerm"
  # We recommend pinning every module to a specific version
  # version = "x.x.x"

  resource_group_name     = azurerm_resource_group.example.name
  resource_group_location = azurerm_resource_group.example.location

  docker_registry_url = "https://${azurerm_container_registry.example.login_server}"
  docker_image_name   = "nginx"
  docker_image_tag    = "latest"
  container_port      = 80

  container_registry_use_managed_identity = true
  create_acr_role_assignment              = true
  acr_id                                  = azurerm_container_registry.example.id
}

With Custom Domain

module "with_custom_domain" {
  source = "nventive/linux-docker-app-service/azurerm"
  # We recommend pinning every module to a specific version
  # version = "x.x.x"

  resource_group_name     = azurerm_resource_group.example.name
  resource_group_location = azurerm_resource_group.example.location

  docker_registry_url = "https://ghcr.io"
  docker_image_name   = "mendhak/http-https-echo"
  docker_image_tag    = "latest"
  container_port      = 8080

  custom_sub_domain_name              = "echo"
  parent_dns_zone_name                = "parent-dns-zone"
  parent_dns_zone_resource_group_name = "some-resource-group"
}

Requirements

Name Version
terraform >= 1.5.0
azurerm ~>3.86

Providers

Name Version
azurerm ~>3.86

Modules

Name Source Version
this cloudposse/label/null 0.25.0

Resources

Name Type
azurerm_app_service_custom_hostname_binding.default resource
azurerm_dns_cname_record.cname_default resource
azurerm_dns_txt_record.txt_default resource
azurerm_linux_web_app.default resource
azurerm_role_assignment.default resource
azurerm_service_plan.default resource
azurerm_dns_zone.parent data source

Inputs

Name Description Type Default Required
acr_id Azure Container Registry ID to create role assignment for ACR_Pull action. Only required to create a RBAC role for the App Service when using an Azure Container Registry as the image source. string null no
additional_tag_map Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.		 map(string) {} no
app_service_always_on If this Linux Web App is Always On enabled. bool true no
app_settings App Settings or environment variables to apply. map(string) {} no
attributes ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.		 list(string) [] no
container_port The port number to which requests will be sent, corresponds to the port exposed by the container. number n/a yes
container_registry_use_managed_identity Should connections for Azure Container Registry use Managed Identity. bool false no
context Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.		 any 
{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
 no
cors_allowed_origins Specifies a list of origins that should be allowed to make cross-origin calls. list(string) null no
create_acr_role_assignment Should a role assignment be created so that the App Service can pull the image from the Azure Container Registry. bool false no
custom_sub_domain_name When creation a custom domain, the sub domain name to create. For example, for creating myapp.contoso.com, set the value myapp. string null no
delimiter Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.		 string null no
descriptor_formats Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br> format = string<br> labels = list(string)<br>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).		 any {} no
docker_image_name The docker image name to be used. string n/a yes
docker_image_tag The docker image tag to be used. string n/a yes
docker_registry_url The URL of the container registry where the docker_image_name is located. e.g. https://index.docker.io or https://mcr.microsoft.com . string n/a yes
enabled Set to false to prevent the module from creating any resources bool null no
environment ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' string null no
https_only Should the Linux Web App require HTTPS connections. bool true no
id_length_limit Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.		 number null no
label_key_case Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.		 string null no
label_order The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.		 list(string) null no
label_value_case Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.		 string null no
labels_as_tags Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.		 set(string) 
[
  "default"
]
 no
name ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.		 string null no
namespace ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique string null no
parent_dns_zone_name When creating a custom domain, the name of the parent dns zone. string null no
parent_dns_zone_resource_group_name When creating a custom domain, the name of the parent dns zone resource group. string null no
regex_replace_chars Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.		 string null no
resource_group_location Location of the resource group to deploy the App Service to. string n/a yes
resource_group_name Name of the resource group to deploy the App Service to. string n/a yes
sku_name The SKU for the plan. Possible values include B1, B2, B3, D1, F1, I1, I2, I3, I1v2, I2v2, I3v2, I4v2, I5v2, I6v2, P1v2, P2v2, P3v2, P0v3, P1v3, P2v3, P3v3, P1mv3, P2mv3, P3mv3, P4mv3, P5mv3, S1, S2, S3, SHARED, EP1, EP2, EP3, WS1, WS2, WS3, and Y1. string "B1" no
stage ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' string null no
tags Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.		 map(string) {} no
tenant ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for string null no

Outputs

Name Description
app_service_id The ID of the Linux Web App.
app_service_name Created Azure App Service name
custom_domain_verification_id The identifier used by App Service to perform domain ownership verification via DNS TXT record.
hosting_environment_id The ID of the App Service Environment used by App Service.
hostname The default hostname of the Linux Web App.
identity An identity block, which contains the Managed Service Identity information for this App Service.
kind The Kind value for this Linux Web App.
outbound_ip_address_list A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12"].
outbound_ip_addresses A comma separated list of outbound IP addresses - such as 52.23.25.3, 52.143.43.12.
possible_outbound_ip_address_list A list of possible outbound ip address.
possible_outbound_ip_addresses A comma-separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12,52.143.43.17 - not all of which are necessarily in use. Superset of outbound_ip_addresses.
site_credential A site_credential block.

Breaking Changes

Please consult BREAKING_CHANGES.md for more information about version history and compatibility.

Contributing

Please read CONTRIBUTING.md for details on the process for contributing to this project.

Be mindful of our Code of Conduct.

We're hiring

Look for current openings on BambooHR https://nventive.bamboohr.com/careers/

Stay in touch

nventive.com | Linkedin | Instagram | YouTube | Spotify