Code Monkey home page Code Monkey logo

terraform-azure-container-apps's Introduction

terraform-azurerm-container-apps

A Terraform module to deploy a container app in Azure with the following characteristics:

  • Ability to specify all the parameters of log analytics workspace resource.
  • Specify the container app image using image parameter in template block under container_apps variable.
  • For multiple apps, specify the container parameters under containers. It's a set of objects with the following parameters:
    • name - (Required) The name of the container.
    • image - (Required) The container image.
    • resources - (Optional) The resource requirements for the container.
    • ports - (Optional) The ports exposed by the container.
    • environment_variables - (Optional) The environment variables for the container.
    • command - (Optional) The command to run within the container in exec form.
    • args - (Optional) The arguments to the command in command field.
    • liveness_probe - (Optional) The liveness probe for the container.
    • readiness_probe - (Optional) The readiness probe for the container.
    • volume_mounts - (Optional) The volume mounts for the container.
    • volumes - (Optional) The volumes for the container.
    • secrets - (Optional) The secrets for the container.
    • image_pull_secrets - (Optional) The image pull secrets for the container.
    • security_context - (Optional) The security context for the container.
    • resources - (Optional) The resource requirements for the container.
    • ports - (Optional) The ports exposed by the container.
    • environment_variables - (Optional) The environment variables for the container.
    • command - (Optional) The command to run within the container in exec form.
    • args - (Optional) The arguments to the command in command field.
    • liveness_probe - (Optional) The liveness probe for the container.

Usage in Terraform 1.2.0

Please view folders in examples.

Pre-Commit & Pr-Check & Test

Configurations

We assumed that you have setup service principal's credentials in your environment variables like below:

export ARM_SUBSCRIPTION_ID="<azure_subscription_id>"
export ARM_TENANT_ID="<azure_subscription_tenant_id>"
export ARM_CLIENT_ID="<service_principal_appid>"
export ARM_CLIENT_SECRET="<service_principal_password>"

On Windows Powershell:

$env:ARM_SUBSCRIPTION_ID="<azure_subscription_id>"
$env:ARM_TENANT_ID="<azure_subscription_tenant_id>"
$env:ARM_CLIENT_ID="<service_principal_appid>"
$env:ARM_CLIENT_SECRET="<service_principal_password>"

We provide a docker image to run the pre-commit checks and tests for you: mcr.microsoft.com/azterraform:latest

To run the pre-commit task, we can run the following command:

$ docker run --rm -v $(pwd):/src -w /src mcr.microsoft.com/azterraform:latest make pre-commit

On Windows Powershell:

$ docker run --rm -v ${pwd}:/src -w /src mcr.microsoft.com/azterraform:latest make pre-commit

In pre-commit task, we will:

  1. Run terraform fmt -recursive command for your Terraform code.
  2. Run terrafmt fmt -f command for markdown files and go code files to ensure that the Terraform code embedded in these files are well formatted.
  3. Run go mod tidy and go mod vendor for test folder to ensure that all the dependencies have been synced.
  4. Run gofmt for all go code files.
  5. Run gofumpt for all go code files.
  6. Run terraform-docs on README.md file, then run markdown-table-formatter to format markdown tables in README.md.

Then we can run the pr-check task to check whether our code meets our pipeline's requirement(We strongly recommend you run the following command before you commit):

$ docker run --rm -v $(pwd):/src -w /src mcr.microsoft.com/azterraform:latest make pr-check

On Windows Powershell:

$ docker run --rm -v ${pwd}:/src -w /src mcr.microsoft.com/azterraform:latest make pr-check

To run the e2e-test, we can run the following command:

docker run --rm -v $(pwd):/src -w /src -e ARM_SUBSCRIPTION_ID -e ARM_TENANT_ID -e ARM_CLIENT_ID -e ARM_CLIENT_SECRET mcr.microsoft.com/azterraform:latest make e2e-test

On Windows Powershell:

docker run --rm -v ${pwd}:/src -w /src -e ARM_SUBSCRIPTION_ID -e ARM_TENANT_ID -e ARM_CLIENT_ID -e ARM_CLIENT_SECRET mcr.microsoft.com/azterraform:latest make e2e-test

Prerequisites

License

MIT

Requirements

Name Version
terraform >= 1.2
azurerm >= 3.11, < 4.0

Providers

Name Version
azurerm >= 3.11, < 4.0

Modules

No modules.

Resources

Name Type
azurerm_container_app.container_app resource
azurerm_container_app_environment.container_env resource
azurerm_container_app_environment_dapr_component.dapr resource
azurerm_container_app_environment_storage.storage resource
azurerm_log_analytics_workspace.laws resource

Inputs

Name Description Type Default Required
container_app_environment_infrastructure_subnet_id (Optional) The existing subnet to use for the container apps control plane. Changing this forces a new resource to be created. string null no
container_app_environment_internal_load_balancer_enabled (Optional) Should the Container Environment operate in Internal Load Balancing Mode? Defaults to false. Changing this forces a new resource to be created. bool false no
container_app_environment_name (Required) The name of the container apps managed environment. Changing this forces a new resource to be created. string n/a yes
container_app_environment_tags A map of the tags to use on the resources that are deployed with this module. map(string) {} no
container_app_secrets (Optional) The secrets of the container apps. The key of the map should be aligned with the corresponding container app. 
map(list(object({
    name  = string
    value = string
  })))
 {} no
container_apps The container apps to deploy. 
map(object({
    name          = string
    tags          = optional(map(string))
    revision_mode = string

    template = object({
      containers = set(object({
        name    = string
        image   = string
        args    = optional(list(string))
        command = optional(list(string))
        cpu     = string
        memory  = string
        env = optional(set(object({
          name        = string
          secret_name = optional(string)
          value       = optional(string)
        })))
        liveness_probe = optional(object({
          failure_count_threshold = optional(number)
          header = optional(object({
            name  = string
            value = string
          }))
          host             = optional(string)
          initial_delay    = optional(number, 1)
          interval_seconds = optional(number, 10)
          path             = optional(string)
          port             = number
          timeout          = optional(number, 1)
          transport        = string
        }))
        readiness_probe = optional(object({
          failure_count_threshold = optional(number)
          header = optional(object({
            name  = string
            value = string
          }))
          host                    = optional(string)
          interval_seconds        = optional(number, 10)
          path                    = optional(string)
          port                    = number
          success_count_threshold = optional(number, 3)
          timeout                 = optional(number)
          transport               = string
        }))
        startup_probe = optional(object({
          failure_count_threshold = optional(number)
          header = optional(object({
            name  = string
            value = string
          }))
          host             = optional(string)
          interval_seconds = optional(number, 10)
          path             = optional(string)
          port             = number
          timeout          = optional(number)
          transport        = string
        }))
        volume_mounts = optional(object({
          name = string
          path = string
        }))
      }))
      max_replicas    = optional(number)
      min_replicas    = optional(number)
      revision_suffix = optional(string)

      volume = optional(set(object({
        name         = string
        storage_name = optional(string)
        storage_type = optional(string)
      })))
    })

    ingress = optional(object({
      allow_insecure_connections = optional(bool, false)
      external_enabled           = optional(bool, false)
      target_port                = number
      transport                  = optional(string)
      traffic_weight = object({
        label           = optional(string)
        latest_revision = optional(string)
        revision_suffix = optional(string)
        percentage      = number
      })
    }))

    identity = optional(object({
      type         = string
      identity_ids = optional(list(string))
    }))

    dapr = optional(object({
      app_id       = string
      app_port     = number
      app_protocol = optional(string)
    }))

    registry = optional(list(object({
      server               = string
      username             = optional(string)
      password_secret_name = optional(string)
      identity             = optional(string)
    })))
  }))
 n/a yes
dapr_component (Optional) The Dapr component to deploy. 
map(object({
    name           = string
    component_type = string
    version        = string
    ignore_errors  = optional(bool, false)
    init_timeout   = optional(string, "5s")
    scopes         = optional(list(string))
    metadata = optional(set(object({
      name        = string
      secret_name = optional(string)
      value       = string
    })))
  }))
 {} no
dapr_component_secrets (Optional) The secrets of the Dapr components. The key of the map should be aligned with the corresponding Dapr component. 
map(list(object({
    name  = string
    value = string
  })))
 {} no
env_storage (Optional) Manages a Container App Environment Storage, writing files to this file share to make data accessible by other systems. 
map(object({
    name         = string
    account_name = string
    share_name   = string
    access_mode  = string
  }))
 {} no
environment_storage_access_key (Optional) The Storage Account Access Key. The key of the map should be aligned with the corresponding environment storage. map(string) null no
location (Required) The location this container app is deployed in. This should be the same as the environment in which it is deployed. string n/a yes
log_analytics_workspace (Optional) A Log Analytics Workspace already exists. 
object({
    id = string
  })
 null no
log_analytics_workspace_allow_resource_only_permissions (Optional) Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to true. bool true no
log_analytics_workspace_cmk_for_query_forced (Optional) Is Customer Managed Storage mandatory for query management? Defaults to false. bool false no
log_analytics_workspace_daily_quota_gb (Optional) The workspace daily quota for ingestion in GB. Defaults to -1 which means unlimited. number -1 no
log_analytics_workspace_internet_ingestion_enabled (Optional) Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to true. bool true no
log_analytics_workspace_internet_query_enabled (Optional) Should the Log Analytics Workspace support query over the Public Internet? Defaults to true. bool true no
log_analytics_workspace_local_authentication_disabled (Optional) Specifies if the log analytics workspace should enforce authentication using Azure Active Directory. Defaults to false. bool false no
log_analytics_workspace_name (Required) Specifies the name of the Log Analytics Workspace. Changing this forces a new resource to be created. string n/a yes
log_analytics_workspace_reservation_capacity_in_gb_per_day (Optional) The capacity reservation level in GB for this workspace. Must be in increments of 100 between 100 and 5000. reservation_capacity_in_gb_per_day can only be used when the sku is set to CapacityReservation. number null no
log_analytics_workspace_retention_in_days (Optional) The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730. number null no
log_analytics_workspace_sku (Optional) Specifies the SKU of the Log Analytics Workspace. Possible values are Free, PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, and PerGB2018(new SKU as of 2018-04-03). Defaults to PerGB2018. string "PerGB2018" no
log_analytics_workspace_tags (Optional) A mapping of tags to assign to the resource. map(string) null no
resource_group_name (Required) The name of the resource group in which the resources will be created. string n/a yes

Outputs

Name Description
container_app_environment_id The ID of the Container App Environment within which this Container App should exist.
container_app_fqdn The FQDN of the Latest Revision of the Container App.

terraform-azure-container-apps's People

Contributors

jiaweitao001 avatar github-actions[bot] avatar lonegunmanb avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.