terraform-aws-ecs-service-tsrecorder

Terraform module for deploying tailscale's SSH session recorder to an ECS cluster

---

It's 100% Open Source and licensed under the GNU General Public License.

Introduction

This is a module for deploying tailscale as a standalone ECS service. It features:

• Bring your own ECS cluster, works with Fargate
• A lambda that rotates the tailscale auth-key automatically using AWS Secrets Manager
• Automatic state persistence with AWS EFS

Usage

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.

Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.

module "recorder" {
  context                    = module.this.context
  vpc_id                     = module.vpc.vpc_id
  ecs_cluster_arn            = module.ecs_cluster.arn
  public_subnet_ids          = module.subnets.public_subnet_ids
  private_subnet_ids         = module.subnets.private_subnet_ids
  tsrecorder_hostname        = each.value.hostname
  tailscale_tailnet          = var.tailscale_tailnet
  tailscale_client_id        = var.tailscale_client_id
  tailscale_client_secret    = var.tailscale_client_secret
  tailscale_tags             = var.tailscale_tags
  tsrecorder_node_count      = each.value.count
  tsrecorder_bucket          = aws_s3_bucket.tsrecorder[0].id
  task_cpu                   = 512
  task_memory                = 1024
  tsrecorder_container_image = var.tsrecorder_container_image
  kms_key_arn                = var.kms_key_arn
}

Requirements

Name	Version
terraform	>= 1.3
aws	>= 5.0.0
random	>= 3.6.3
tls	>= 4.0.6

Providers

Name	Version
aws	>= 5.0.0

Modules

Name	Source	Version
label_log_group_tailscale	cloudposse/label/null	0.25.0
label_rotate	cloudposse/label/null	0.25.0
label_ssm_params_tailscale	cloudposse/label/null	0.25.0
tailscale_def	cloudposse/ecs-container-definition/aws	0.61.1
this	cloudposse/label/null	0.25.0
ts_rotate	guardianproject-ops/lambda-secrets-manager-tailscale/aws	0.0.2
tsrecorder	cloudposse/ecs-alb-service-task/aws	0.76.1

Resources

Name	Type
aws_cloudwatch_log_group.tailscale	resource
aws_efs_access_point.tailscale_state	resource
aws_efs_file_system.tailscale_state	resource
aws_efs_mount_target.tailscale_state	resource
aws_iam_policy.tailscale_exec	resource
aws_iam_policy.tailscale_task	resource
aws_iam_role_policy_attachment.tailscale_exec	resource
aws_iam_role_policy_attachment.tailscale_task	resource
aws_secretsmanager_secret.authkey	resource
aws_secretsmanager_secret_rotation.authkey	resource
aws_secretsmanager_secret_version.authkey	resource
aws_security_group.tailscale	resource
aws_security_group.tailscale_to_efs_state	resource
aws_vpc_security_group_egress_rule.tailscale_egress_all	resource
aws_vpc_security_group_egress_rule.tailscale_to_efs_state_egress_all	resource
aws_vpc_security_group_ingress_rule.tailscale_tailscale	resource
aws_vpc_security_group_ingress_rule.tailscale_to_efs_state_tailscale	resource
aws_iam_policy_document.tailscale_exec	data source
aws_iam_policy_document.tailscale_task	data source
aws_region.this	data source
aws_s3_bucket.this	data source

Inputs

Name	Description	Type	Default	Required
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_arn	The ECS cluster ARN this service will be deployed in	string	n/a	yes
exec_enabled	Specifies whether to enable Amazon ECS Exec for the tasks within the service	bool	false	no
kms_key_arn	Used for transit and tailscale state encryption	string	n/a	yes
log_group_retention_in_days	The number in days that cloudwatch logs will be retained.	number	30	no
port_efs_tailscale_state	The port number at which the tailscale state efs mount is available	number	2049	no
private_subnet_ids	The ids for the private subnets that EFS will be deployed into	list(string)	n/a	yes
public_subnet_ids	The ids for the public subnets that ECS will be deployed into	list(string)	n/a	yes
tailscale_client_id	The OIDC client id for tailscale that has permissions to create auth keys with the tailscale_tags tags	string	n/a	yes
tailscale_client_secret	The OIDC client secret paired with tailscale_client_id	string	n/a	yes
tailscale_tags	The list of tags that will be assigned to tailscale node created by this stack.	list(string)	n/a	yes
tailscale_tailnet	description = The tailnet domain (or "organization's domain") for your tailscale tailnet, this s found under Settings > General > Organization	string	n/a	yes
task_cpu	The number of CPU units used by the task. If using FARGATE launch type task_cpu must match supported memory values (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size)	number	n/a	yes
task_memory	The amount of memory (in MiB) used by the task. If using Fargate launch type task_memory must match supported cpu value (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size)	number	n/a	yes
tsrecorder_bucket	The S3 bucket name, in this region, to put ssh session recordings.	string	n/a	yes
tsrecorder_bucket_prefix	The prefix the tsrecorder will use.	string	null	no
tsrecorder_container_image	The fully qualified container image for tsrecorder.	string	"docker.io/tailscale/tsrecorder:stable"	no
tsrecorder_hostname	The hostname for this tailscale device, will default to to the context id	string	null	no
tsrecorder_node_count	The number of instances to run in this service.	number	1	no
tsrecorder_ui_enabled	Whether or not to enable the recorder ui.	bool	true	no
vpc_id	The VPC that the ECS cluster is in	string	n/a	yes

Label Inputs

This Terraform module makes use of the cloudposse/label/null module to generate consistent names and tags for resources. The label module contains many inputs that are common across all our modules that use the label module, and so these inputs have been seperated here to make it clearer which inputs are specific to this module.

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
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
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
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
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
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	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
cloudwatch_log_group_arn_tailscale	Cloudwatch log group ARN for tailscale
cloudwatch_log_group_name_tailscale	Cloudwatch log group name for tailscale
cloudwatch_log_group_tailscale	All outputs from aws_cloudwatch_log_group.tailscale
efs_file_system_id	n/a
efs_security_group_id	n/a
secrets_manager_secret_authkey_arn	n/a
secrets_manager_secret_authkey_id	n/a
security_group_id	n/a

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Help

Got a question? We got answers.

File a GitLab issue, send us an email or join our Matrix Community.

Matrix Community

Join our Open Source Community on Matrix. It's FREE for everyone! This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build on our open source code.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. Fork the repo on GitLab
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

Copyright © 2021-2024 The Guardian Project

License

GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained by The Guardian Project.

We're a collective of designers, developers, and ops folk focused on useable privacy and security with a focus on digital human rights and humanitarian projects.

Everything we do is 100% FOSS.

Follow us on Mastodon or twitter, apply for a job, or partner with us.

We offer paid support on all of our projects.

Check out our other DevOps projects or our entire other set of projects related to privacy and security related software, or hire us to get support with using our projects.

Contributors

Abel Luck