GitHubHelp

Gowiem/terraform-aws-n8n

Run N8n on AWS ECS Fargate (Gowiem Fork)

★ 0Forks 0HCLGitHub ↗Compare

README

Description

This module is a fork of the original N8n on AWS module. Working to try this out and potentially migrate this to a Masterpoint module.

This sets up a N8n cluster with two Fargate Spot instances and a ALB. It is backed by an EFS file system to store the state. The total costs are around 3 USD per month (provided your ALB is in the free tier). It does not come with SSL (optionally it can listen for SSL connections), but this would raise the cost. You can also use a service like Cloudflare to run the SSL for you.

Note: This module has been setup as a cheap and easy way to run N8n. Data is stored on a EFS volume (you must back this up yourself). We use a single instance (Fargate Spot) so it might be replaced every now and then. N8n is not ment to run stateless behind a load balancer (you will get issues with webhooks).

Check out or blog post about it here: Run n8n on AWS for less than a cup of coffee per month

About ElasticScale

Discover ES Foundation, the smart digital infrastructure for SaaS companies that want to grow and thrive.

Check out our website for more information.

ElasticScale banner

Requirements

No requirements.

Providers

Name Version
aws n/a

Modules

Name Source Version
vpc terraform-aws-modules/vpc/aws n/a

Resources

Name Type
aws_cloudwatch_log_group.logs resource
aws_ecs_cluster.ecs resource
aws_ecs_cluster_capacity_providers.main resource
aws_ecs_service.service resource
aws_ecs_task_definition.taskdef resource
aws_efs_access_point.access resource
aws_efs_file_system.main resource
aws_efs_mount_target.mount resource
aws_iam_role.executionrole resource
aws_iam_role.taskrole resource
aws_lb.main resource
aws_lb_listener.http resource
aws_lb_listener.https resource
aws_lb_target_group.ip resource
aws_security_group.alb resource
aws_security_group.efs resource
aws_security_group.n8n resource
aws_availability_zones.available data source
aws_caller_identity.current data source
aws_region.current data source

Inputs

Name Description Type Default Required
alb_allowed_cidr_blocks List of CIDR blocks allowed to access the ALB (default: allows all traffic) list(string) ["0.0.0.0/0"] no
certificate_arn Certificate ARN for HTTPS support string null no
container_image Container image to use for n8n string "n8nio/n8n:1.4.0" no
desired_count Desired count of n8n tasks, be careful with this to make it more than 1 as it can cause issues with webhooks not registering properly number 1 no
fargate_type Fargate type to use for n8n (either FARGATE or FARGATE_SPOT)) string "FARGATE_SPOT" no
prefix Prefix to add to all resources string "n8n" no
public_subnet_ids Public subnet IDs for ALB (optional, uses VPC public subnets if not provided) list(string) [] no
ssl_policy SSL policy for HTTPS listner. string ELBSecurityPolicy-TLS13-1-2-2021-06 no
subnet_ids Subnet IDs for ECS tasks (optional, uses VPC subnets if not provided) list(string) [] no
tags Tags to apply to all resources map(string) null no
url URL for n8n (default is LB url), needs a trailing slash if you specify it string null no
use_private_subnets Whether to deploy ECS tasks in private subnets (requires NAT Gateway or VPC endpoints for internet access) bool false no
vpc_id VPC ID to deploy n8n into (optional, creates new VPC if not provided) string null no

Outputs

Name Description
lb_dns_name Load balancer DNS name

Requirements

No requirements.

Providers

Name Version
aws n/a

Modules

Name Source Version
alb_label cloudposse/label/null 0.25.0
alb_sg_label cloudposse/label/null 0.25.0
ecs_cluster_label cloudposse/label/null 0.25.0
efs_label cloudposse/label/null 0.25.0
efs_sg_label cloudposse/label/null 0.25.0
executionrole_label cloudposse/label/null 0.25.0
executionrole_policy_label cloudposse/label/null 0.25.0
logs_label cloudposse/label/null 0.25.0
n8n_sg_label cloudposse/label/null 0.25.0
service_label cloudposse/label/null 0.25.0
taskdef_label cloudposse/label/null 0.25.0
taskrole_label cloudposse/label/null 0.25.0
taskrole_policy_label cloudposse/label/null 0.25.0
tg_label cloudposse/label/null 0.25.0
this cloudposse/label/null 0.25.0
vpc terraform-aws-modules/vpc/aws n/a
vpc_label cloudposse/label/null 0.25.0

Resources

Name Type
aws_cloudwatch_log_group.logs resource
aws_ecs_cluster.ecs resource
aws_ecs_cluster_capacity_providers.main resource
aws_ecs_service.service resource
aws_ecs_task_definition.taskdef resource
aws_efs_access_point.access resource
aws_efs_file_system.main resource
aws_efs_mount_target.mount resource
aws_iam_role.executionrole resource
aws_iam_role.taskrole resource
aws_iam_role_policy.executionrole resource
aws_iam_role_policy.taskrole resource
aws_lb.main resource
aws_lb_listener.http resource
aws_lb_listener.https resource
aws_lb_target_group.ip resource
aws_security_group.alb resource
aws_security_group.efs resource
aws_security_group.n8n resource
aws_availability_zones.available data source
aws_caller_identity.current data source
aws_region.current data source
aws_subnets.existing_private data source
aws_subnets.existing_public data source
aws_vpc.existing 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_allowed_cidr_blocks List of CIDR blocks allowed to access the ALB (default: allows all traffic) list(string) 
[
 "0.0.0.0/0"
]
 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
certificate_arn Certificate ARN for HTTPS support string null no
container_image Container image to use for n8n string "n8nio/n8n:1.4.0" 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
desired_count Desired count of n8n tasks, be careful with this to make it more than 1 as it can cause issues with webhooks not registering properly number 1 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
fargate_type Fargate type to use for n8n (either FARGATE or FARGATE_SPOT)) string "FARGATE_SPOT" 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
public_subnet_ids Public subnet IDs for ALB (optional, uses VPC public subnets if not provided) list(string) [] 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
ssl_policy The name of the SSL policy to use for the HTTPS Listener on the ALB string "ELBSecurityPolicy-TLS13-1-2-2021-06" no
stage ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' string null no
subnet_ids Subnet IDs for ECS tasks (optional, uses VPC subnets if not provided) 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
url URL for n8n (default is LB url), needs a trailing slash if you specify it string null no
use_private_subnets Whether to deploy ECS tasks in private subnets (requires NAT Gateway or VPC endpoints for internet access) bool false no
vpc_id VPC ID to deploy n8n into (optional, creates new VPC if not provided) string null no

Outputs

Name Description
lb_dns_name Load balancer DNS name

Contributors

alexjeenjimdostewValmareloxGowiemryan-horizonlseebach

Issues