diff --git a/aks/application/README.md b/aks/application/README.md index 5d0024d..4432409 100644 --- a/aks/application/README.md +++ b/aks/application/README.md @@ -16,10 +16,10 @@ module "web_application" { service_name = local.service_name cluster_configuration_map = module.cluster_data.configuration_map - + kubernetes_config_map_name = module.application_configuration.kubernetes_config_map_name kubernetes_secret_name = module.application_configuration.kubernetes_secret_name - + docker_image = var.docker_image } @@ -89,6 +89,13 @@ app.MapHealthChecks("/healthcheck/all"); [ASP.NET Core Health Checks Middleware]: https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/health-checks?view=aspnetcore-7.0 +### Monitoring + +If `azure_enable_monitoring` is `true`, it’s expected that the following resources already exist: + +- A resource group named `${azure_resource_prefix}-${service_short}-mn-rg` (where `mn` stands for monitoring and `rg` stands for resource group). +- A monitor action group named `${azure_resource_prefix}-${service_name}` within the above resource group. + ## Outputs ### `hostname` diff --git a/aks/application/tfdocs.md b/aks/application/tfdocs.md index f35c79c..e1c3a02 100644 --- a/aks/application/tfdocs.md +++ b/aks/application/tfdocs.md @@ -30,7 +30,7 @@ No modules. | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -| [azure\_enable\_monitoring](#input\_azure\_enable\_monitoring) | n/a | `bool` | `false` | no | +| [azure\_enable\_monitoring](#input\_azure\_enable\_monitoring) | Whether to enable monitoring of container failures | `bool` | `false` | no | | [azure\_resource\_prefix](#input\_azure\_resource\_prefix) | Prefix of Azure resources for the service | `string` | `null` | no | | [cluster\_configuration\_map](#input\_cluster\_configuration\_map) | Configuration map for the cluster |
object({| n/a | yes | | [command](#input\_command) | Custom command that overwrites Docker image | `list(string)` | `[]` | no | diff --git a/aks/application/variables.tf b/aks/application/variables.tf index a7c197c..b76f5f4 100644 --- a/aks/application/variables.tf +++ b/aks/application/variables.tf @@ -122,6 +122,7 @@ variable "azure_resource_prefix" { } variable "azure_enable_monitoring" { - type = bool - default = false + type = bool + default = false + description = "Whether to enable monitoring of container failures" }
resource_group_name = string,
resource_prefix = string,
dns_zone_prefix = optional(string),
cpu_min = number
})