Skip to content

Latest commit

 

History

History
166 lines (136 loc) · 15.2 KB

README.md

File metadata and controls

166 lines (136 loc) · 15.2 KB
Raw

nventive

terraform-aws-ecs-cluster

License Latest Release

Terraform module to provision an ECS Cluster.

Providers

This modules uses two instances of the AWS provider. One for Route 53 resources and one for the rest. The reason why is that Route 53 is often in a different account (ie. in the prod account when creating resources for dev).

You must provide both providers, whether you use Route 53 or not. In any case, you can specify the same provider for both if need be.

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.

module "ecs_cluster" {
  source = "nventive/ecs-cluster/aws"
  # We recommend pinning every module to a specific version
  # version = "x.x.x"

  namespace = "eg"
  stage     = "test"
  name      = "app"

  providers = {
    aws         = aws
    aws.route53 = aws.route53
  }
  subnet_ids       = ["subnet-xxxxxxxxxxxxxxxx1", "subnet-xxxxxxxxxxxxxxxx2"]
  parent_zone_name = "example.com"
  alb_enabled      = true
  alb_dns_aliases  = ["test.example.com", "demo.example.com"]
}

Should you want to use the same AWS provider for both Route 53 and the default one.

module "ecs_cluster" {
  source = "nventive/ecs-cluster/aws"
  # We recommend pinning every module to a specific version
  # version = "x.x.x"

  providers = {
    aws         = aws
    aws.route53 = aws
  }

  # ...
}

Requirements

Name Version
terraform >= 0.13.0
aws >= 3.0
local >= 1.3
null >= 2.0
random >= 3.0
time >= 0.7.0

Providers

Name Version
aws >= 3.0
null >= 2.0

Modules

Name Source Version
alb_dns_alias cloudposse/route53-alias/aws 0.13.0
kms_key cloudposse/kms-key/aws 0.12.1
lb nventive/lb/aws 1.2.0
this cloudposse/label/null 0.25.0

Resources

Name Type
aws_cloudwatch_log_group.ecs_insights resource
aws_ecs_cluster.default resource
null_resource.aliases_parent_zone_validation resource
aws_caller_identity.current data source
aws_iam_policy_document.kms_key data source
aws_kms_key.default data source
aws_lb.default data source
aws_region.current data source
aws_subnet.lb data source

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
alb_access_logs_enabled Whether or not ALB access logs should be enabled. bool true no
alb_access_logs_force_destroy Whether or not force destroy option should be enabled for the ALB access logs Bucket. bool true no
alb_access_logs_prefix Prefix for ALB access logs. string "" no
alb_arn Set if you want to use an existing Application Load Balancer. string "" no
alb_dns_aliases List of custom domain name aliases for ALB. list(string) [] no
alb_enabled Set to false to prevent the module from creating an Application Load Balancer.
This setting defaults to false if alb_arn is specified.		 bool true no
alb_internal Set to true to make the ALB internal. bool false no
alb_ip_address_type Address type for ALB possible. Specify one of ipv4, dualstack. Only when alb_enabled = true. string null 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
cloudwatch_log_group_retention_in_days Number of days to retain Cloudwatch logs. number 60 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
ecs_cluster_container_insights_enabled Whether or not Container Insights should be enabled. bool true 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
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
logs_kms_key_arn ARN of the KMS key for CloudWatch encryption, if blank, one will be created. string "" 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_zone_id ID of the hosted zone to contain this record (or specify parent_zone_name). Requires dns_alias_enabled set to true. string null no
parent_zone_name Name of the hosted zone to contain this record (or specify parent_zone_id). Requires dns_alias_enabled set to true. 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
stage ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' string null no
subnet_ids List of subnet IDs for the Load Balancer. The Load Balancer will be created in the VPC associated with the subnet IDs. 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

Outputs

Name Description
alb_arn ARN of the Application Load Balancer
alb_arn_suffix ARN suffix of the ALB
alb_security_group_id ID of the ALB security group
cluster_arn ARN of the ECS cluster
cluster_name The name of the ECS cluster
kms_key_arn KMS Key ARN for log encryption

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