Giter Site home page Giter Site logo

getindata / terraform-azurerm-atlantis Goto Github PK

View Code? Open in Web Editor NEW
8.0 6.0 10.0 83 KB

Terraform module for deploying Atlantis in Azure Container Group

License: Apache License 2.0

HCL 99.92% Smarty 0.08%
atlantis azure terraform terraform-module terragrunt

terraform-azurerm-atlantis's Introduction

Atlantis in Azure Container Group Terraform Module

Azure Terraform

License Release

We help companies turn their data into assets

Terraform Module for deploying Atlantis in Azure Container Group instance.

This module takes advantage of terraform-null-atlantis-repo-config, which supplies a set of predefined custom workflows that are ready to use.

There is also available a caddy-automatic-https submodule, which adds automatic HTTPS integration via Caddy.

USAGE

module "atlantis" {
  source = "github.com/getindata/terraform-azurerm-atlantis"

  resource_group_name = "example-rg"
  
  atlantis_server_config = {
    repo_allowlist = "github.com/getindata/*"
  }

  atlantis_repo_config_repos = [
    {
      id                     = "/.*/"
      allowed_overrides      = ["workflow", "apply_requirements", "delete_source_branch_on_merge"]
      allow_custom_workflows = true
    }
  ]
}

EXAMPLES

  • Complete example - a complete example with Automatic HTTPS via Caddy, basic auth enabled and more

Inputs

Name Description Type Default Required
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
atlantis_container Atlantis container configuration. First item of the ports list must refer to the Atlantis 
object({
    image  = optional(string, "ghcr.io/runatlantis/atlantis")
    cpu    = optional(number, 1)
    memory = optional(number, 1)
    ports = optional(list(object({
      port     = number
      protocol = optional(string, "TCP")
      })), [{
      port     = 4141
      protocol = "TCP"
    }])
    commands                     = optional(list(string), ["atlantis", "server"])
    environment_variables        = optional(map(string), {})
    secure_environment_variables = optional(map(string), {})
    secure_environment_variables_from_key_vault = optional(map(object({
      key_vault_id = string
      name         = string
    })), {})
    volumes = optional(map(object({
      mount_path = string
      read_only  = optional(bool, false)
      empty_dir  = optional(bool)
      git_repo = optional(object({
        url       = string
        directory = optional(string)
        revision  = optional(string)
      }))
      secret = optional(map(string))
      secret_from_key_vault = optional(map(object({
        key_vault_id = string
        name         = string
      })), {})
      storage_account_name = optional(string)
      storage_account_key  = optional(string)
      share_name           = optional(string)
    })), {})
  })
 {} no
atlantis_repo_config_file Configures config file generation if enabled 
object({
    enabled = optional(bool, false)
    path    = optional(string, ".")
    name    = optional(string, "repo_config.yaml")
    format  = optional(string, "yaml")
  })
 {} no
atlantis_repo_config_repos Map of repositories and their configs. Refer to https://www.runatlantis.io/docs/server-side-repo-config.html#example-server-side-repo 
list(object({
    id                            = optional(string, "/.*/")
    branch                        = optional(string)
    apply_requirements            = optional(list(string))
    allowed_overrides             = optional(list(string))
    allowed_workflows             = optional(list(string))
    allow_custom_workflows        = optional(bool)
    delete_source_branch_on_merge = optional(bool)
    pre_workflow_hooks = optional(list(object({
      run = string
    })))
    post_workflow_hooks = optional(list(object({
      run = string
    })))
    workflow = optional(string)
    ######### Helpers #########
    allow_all_server_side_workflows = optional(bool, false)
    terragrunt_atlantis_config = optional(object({
      enabled              = optional(bool)
      output               = optional(string)
      automerge            = optional(bool)
      autoplan             = optional(bool)
      parallel             = optional(bool)
      cascade_dependencies = optional(bool)
      filter               = optional(string)
      use_project_markers  = optional(bool)
    }))
  }))
 [] no
atlantis_repo_config_repos_common_config Common config that will be merged into each item of the repos list 
object({
    id                            = optional(string)
    branch                        = optional(string)
    apply_requirements            = optional(list(string))
    allowed_overrides             = optional(list(string))
    allowed_workflows             = optional(list(string))
    allow_custom_workflows        = optional(bool)
    delete_source_branch_on_merge = optional(bool)
    pre_workflow_hooks = optional(list(object({
      run = string
    })))
    post_workflow_hooks = optional(list(object({
      run = string
    })))
    workflow = optional(string)
    ######### Helpers #########
    allow_all_server_side_workflows = optional(bool, false)
    terragrunt_atlantis_config = optional(object({
      enabled              = optional(bool)
      output               = optional(string)
      automerge            = optional(bool)
      autoplan             = optional(bool)
      parallel             = optional(bool)
      cascade_dependencies = optional(bool)
      filter               = optional(string)
      use_project_markers  = optional(bool)
    }))
  })
 {} no
atlantis_repo_config_workflows List of custom workflow that will be added to the repo config file 
map(object({
    plan = optional(object({
      steps = optional(list(object({
        env = optional(object({
          name    = string
          command = string
        }))
        run      = optional(string)
        multienv = optional(string)
        atlantis_step = optional(object({
          command    = string
          extra_args = optional(list(string))
        }))
      })))
    }))
    apply = optional(object({
      steps = optional(list(object({
        env = optional(object({
          name    = string
          command = string
        }))
        run      = optional(string)
        multienv = optional(string)
        atlantis_step = optional(object({
          command    = string
          extra_args = optional(list(string))
        }))
      })))
    }))
    import = optional(object({
      steps = optional(list(object({
        env = optional(object({
          name    = string
          command = string
        }))
        run      = optional(string)
        multienv = optional(string)
        atlantis_step = optional(object({
          command    = string
          extra_args = optional(list(string))
        }))
      })))
    }))
    state_rm = optional(object({
      steps = optional(list(object({
        env = optional(object({
          name    = string
          command = string
        }))
        run      = optional(string)
        multienv = optional(string)
        atlantis_step = optional(object({
          command    = string
          extra_args = optional(list(string))
        }))
      })))
    }))
    template = optional(string, "terragrunt-basic")
    asdf = optional(object({
      enabled = optional(bool, false)
    }), {})
    checkov = optional(object({
      enabled   = optional(bool, false)
      soft_fail = optional(bool, false)
      file      = optional(string, "$SHOWFILE")
    }), {})
    pull_gitlab_variables = optional(object({
      enabled = optional(bool, false)
    }), {})
    check_gitlab_approvals = optional(object({
      enabled = optional(bool, false)
    }), {}),
    infracost = optional(object({
      enabled                    = optional(bool, false)
      platform                   = optional(string, "gitlab")
      token_environment_variable = optional(string)
      behavior                   = optional(string, "new")
    }), {}),
  }))
 {} no
atlantis_server_config Atlantis server config. If any option is not available here, it can be passed by environment_variables variable 
object({
    allow_draft_prs                 = optional(string)
    allow_fork_prs                  = optional(string)
    allow_repo_config               = optional(string)
    atlantis_url                    = optional(string)
    automerge                       = optional(string)
    autoplan_file_list              = optional(string)
    autoplan_modules                = optional(string)
    autoplan_modules_from_projects  = optional(string)
    azuredevops_hostname            = optional(string)
    azuredevops_webhook_password    = optional(string)
    azuredevops_webhook_user        = optional(string)
    azuredevops_token               = optional(string)
    azuredevops_user                = optional(string)
    bitbucket_base_url              = optional(string)
    bitbucket_token                 = optional(string)
    bitbucket_user                  = optional(string)
    bitbucket_webhook_secret        = optional(string)
    checkout_strategy               = optional(string)
    config                          = optional(string)
    data_dir                        = optional(string)
    default_tf_version              = optional(string)
    disable_apply                   = optional(string)
    disable_apply_all               = optional(string)
    disable_autoplan                = optional(string)
    disable_markdown_folding        = optional(string)
    disable_repo_locking            = optional(string)
    enable_policy_checks            = optional(string)
    enable_regexp_cmd               = optional(string)
    enable_diff_markdown_format     = optional(string)
    gh_hostname                     = optional(string)
    gh_token                        = optional(string)
    gh_user                         = optional(string)
    gh_webhook_secret               = optional(string)
    gh_org                          = optional(string)
    gh_app_id                       = optional(string)
    gh_app_slug                     = optional(string)
    gh_app_key_file                 = optional(string)
    gh_app_key                      = optional(string)
    gh_team_allowlist               = optional(string)
    gh_allow_mergeable_bypass_apply = optional(string)
    gitlab_hostname                 = optional(string)
    gitlab_token                    = optional(string)
    gitlab_user                     = optional(string)
    gitlab_webhook_secret           = optional(string)
    help                            = optional(string)
    hide_prev_plan_comments         = optional(string)
    locking_db_type                 = optional(string)
    log_level                       = optional(string)
    markdown_template_overrides_dir = optional(string)
    parallel_pool_size              = optional(string)
    port                            = optional(string)
    quiet_policy_checks             = optional(string)
    redis_host                      = optional(string)
    redis_password                  = optional(string)
    redis_port                      = optional(string)
    redis_db                        = optional(string)
    redis_tls_enabled               = optional(string)
    redis_insecure_skip_verify      = optional(string)
    repo_config                     = optional(string)
    repo_config_json                = optional(string)
    repo_whitelist                  = optional(string)
    repo_allowlist                  = optional(string)
    require_approval                = optional(string)
    require_mergeable               = optional(string)
    silence_fork_pr_errors          = optional(string)
    silence_whitelist_errors        = optional(string)
    silence_allowlist_errors        = optional(string)
    silence_no_projects             = optional(string)
    silence_vcs_status_no_plans     = optional(string)
    skip_clone_no_changes           = optional(string)
    slack_token                     = optional(string)
    ssl_cert_file                   = optional(string)
    ssl_key_file                    = optional(string)
    stats_namespace                 = optional(string)
    tf_download_url                 = optional(string)
    tfe_hostname                    = optional(string)
    tfe_local_execution_mode        = optional(string)
    tfe_token                       = optional(string)
    var_file_allowlist              = optional(string)
    vcs_status_name                 = optional(string)
    write_git_creds                 = optional(string)
    web_basic_auth                  = optional(bool)
    web_username                    = optional(string)
    web_password                    = optional(string)
    websocket_check_origin          = optional(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_diagnostics_log_analytics Log Analytics workspace to be used with container logs 
object({
    workspace_id  = string
    workspace_key = string
    log_type      = optional(string, "ContainerInsights")
  })
 null no
containers List of containers that will be running in the container group 
map(object({
    image  = string
    cpu    = number
    memory = number
    ports = optional(list(object({
      port     = number
      protocol = optional(string, "TCP")
    })), [])
    commands                     = optional(list(string), [])
    environment_variables        = optional(map(string), {})
    secure_environment_variables = optional(map(string), {})
    secure_environment_variables_from_key_vault = optional(map(object({
      key_vault_id = string
      name         = string
    })), {})
    volumes = optional(map(object({
      mount_path = string
      read_only  = optional(bool, false)
      empty_dir  = optional(bool)
      git_repo = optional(object({
        url       = string
        directory = optional(string)
        revision  = optional(string)
      }))
      secret = optional(map(string))
      secret_from_key_vault = optional(map(object({
        key_vault_id = string
        name         = string
      })), {})
      storage_account_name = optional(string)
      storage_account_key  = optional(string)
      share_name           = optional(string)
    })), {})
  }))
 {} 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
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
descriptor_name Name of the descriptor used to form a resource name string "azure-container-group" no
diagnostic_settings Enables diagnostics settings for a resource and streams the logs and metrics to any provided sinks 
object({
    enabled               = optional(bool, false)
    logs_destinations_ids = optional(list(string), [])
  })
 {} no
dns_name_label The DNS label/name for the container group's IP. If not provided it will use the name of the resource string null no
dns_name_servers DNS name servers configured with containers list(string) [] no
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
exposed_ports It can only contain ports that are also exposed on one or more containers in the group 
list(object({
    port     = number
    protocol = optional(string, "TCP")
  }))
 [] 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
identity Managed identity block. For type possible values are: SystemAssigned and UserAssigned 
object({
    enabled      = optional(bool, false)
    type         = optional(string, "SystemAssigned")
    identity_ids = optional(list(string), [])
    user_assigned_identity = optional(object({
      enabled         = optional(bool, false)
      descriptor_name = optional(string, "azure-managed-service-identity")
    }), {})
    role_assignments = optional(list(object({
      scope                = string
      role_definition_name = string
    })), [])
  })
 {} no
image_registry_credential Credentials for ACR, so the images can be pulled by the container instance 
list(object({
    username = string
    password = string
    server   = string
  }))
 [] 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
location Location where resources will be deployed. If not provided it will be read from resource group location string null 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
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_name Azure resource group name where resources will be deployed string n/a yes
restart_policy Restart policy for the container group. Allowed values are Always, Never, OnFailure. Defaults to Always string "Always" no
stage ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' string null no
subnet_ids The subnet resource IDs for a container group. At the moment it supports 1 subnet maximum list(string) [] 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

Modules

Name Source Version
atlantis_repo_config getindata/atlantis-repo-config/null 2.3.0
azure_container_group getindata/container-group/azurerm 3.1.1
this cloudposse/label/null 0.25.0

Outputs

Name Description
container_group_fqdn The FQDN of the container group derived from dns_name_label
container_group_id ID of the container group
container_group_identity_principal_id ID of the assigned principal
container_group_ip_address The IP address allocated to the container group
container_group_name Name of the container group
container_group_resource_group_name Name of the container group resource group
container_group_user_assigned_identity_id ID of the user assigned identity

Providers

No providers.

Requirements

Name Version
terraform >= 1.3

Resources

No resources.

CONTRIBUTING

Contributions are very welcomed!

Start by reviewing contribution guide and our code of conduct. After that, start coding and ship your changes by creating a new PR.

LICENSE

Apache 2 Licensed. See LICENSE for full details.

AUTHORS

Made with contrib.rocks.

terraform-azurerm-atlantis's People

Contributors

github-actions[bot] avatar jakubigla avatar jwilkinsonmb avatar kacpermuda avatar maciejmacq-dev avatar mariusz89016 avatar samuelb avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar

Forkers

quintindk da-moon quincy120 patrick-merchant duddit2ltd jakubigla marcinwala icornett samuelb benf99

terraform-azurerm-atlantis's Issues

Unable to Target Specific Commands in Pre/Post Workflow Hooks

Observation

In the current setup of pre/post workflow hooks, there seems to be no field that allows specifying the commands (e.g., plan, apply) for which you want to trigger a particular hook. This functionality is crucial for fine-grained control over the execution of hooks based on specific commands.

Documentation Reference: Atlantis Command Targeting

In examining the configurations, it appears that there's no direct provision for targeting specific commands:

Expected Behavior:

Users should be able to define the target commands explicitly within the configuration of pre/post workflow hooks, as supported by Atlantis.

Emphesize `dns_name_label` to be changed to unique value per region

Hi

I ran into an issue with deploying this module where I got a "InternalServerError" when applying my TF code. The error came from the Azure APIs. After scratching my head for way to long, it turned out that the default of the dns_name_label variable, which is "atlantis", needs to be unique within the Azure region. See https://learn.microsoft.com/en-us/azure/container-instances/container-instances-quickstart-portal#create-a-container-instance for reference. After I set a different value for the dns_name_label variable, I was able to deploy the Atlantis with this module.

Maybe mentioning in the documentation that the dns_name_label varbiable should be set to a something unique for the Azure region, or maybe even choose and random default value for this variable (eg with random_pet), would make sense to prevent others to run into the same issue. What do you think?

Best regards
Samuel

Clarification on container image needed to use helpers

Hi there,

Possibly an issue, maybe more a lacking in my understanding.

I am interested in implementing this, I think it's really good! And I see that you have lots of optional helpers available which I may want to use in the future. However my understanding is that those helpers would need to be installed onto the container image before they would work.

I can see that the default image seems to be the main Atlantis repo's image. However wouldn't this need a custom image to work with the helper functions?

I also see that you have a custom image (docker-atlantis) in another repo, which includes the helper components. First I just wanted to check my understanding is correct of the setup. Second, may I suggest an example that uses your docker-atlantis container as the main image? In theory, your complete example shouldn't work as it has the default image with helpers configured... (If I'm understanding correctly?)

caddy-automatic-https module using storage account name for the share name when using caddy_persistence_storage_account variable

When using the caddy_persistence_storage_account variable to pass existing storage details to the module, the local for share_name is taking the storage account name (var.caddy_persistence_storage_account.name) instead of the share name (var.caddy_persistence_storage_account.share_name)

To workaround the issue you have to create a share name the same as the account name

Fix submitted in PR #16

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.