Skip to content

Terraform module to provision a Tailscale Subnet Router into your AWS VPC

License

Notifications You must be signed in to change notification settings

masterpointio/terraform-aws-tailscale

Repository files navigation

Masterpoint Logo

terraform-aws-tailscale Latest Release

This is a Terraform Module to create a simple, autoscaled Tailscale Subnet Router on EC2 instance along with generated auth key, and its corresponding IAM resources. The instance should cycle itself on a schedule.

It's 100% Open Source and licensed under the APACHE2.

Usage

Here's how to invoke this example module in your projects

module "vpc" {
  source  = "cloudposse/vpc/aws"
  version = "2.1.1"

  namespace = "eg"
  stage     = "test"
  name      = "tailscale"

  ipv4_primary_cidr_block = "172.16.0.0/16"
}

module "subnets" {
  source  = "cloudposse/dynamic-subnets/aws"
  version = "2.4.1"

  namespace = "eg"
  stage     = "test"
  name      = "tailscale"

  availability_zones = ["us-east-1a", "us-east-1b"]

  vpc_id          = module.vpc.vpc_id
  igw_id          = [module.vpc.igw_id]
  ipv4_cidr_block = [module.vpc.vpc_cidr_block]
}

module "tailscale" {
  source  = "masterpointio/tailscale/aws"
  version = "X.X.X"

  namespace = "eg"
  stage     = "test"
  name      = "tailscale"

  vpc_id           = module.vpc.vpc_id
  subnet_ids       = module.subnets.private_subnet_ids
  advertise_routes = [module.vpc.vpc_cidr_block]

  ephemeral = true
}

Examples

Here is an example of using this module:

Requirements

Name Version
terraform >= 1.0
aws >= 4.0
tailscale >= 0.13.7

Providers

Name Version
tailscale >= 0.13.7

Modules

Name Source Version
tailscale_subnet_router masterpointio/ssm-agent/aws 1.2.0
this cloudposse/label/null 0.25.0

Resources

Name Type
tailscale_tailnet_key.default resource

Inputs

Name Description Type Default Required
additional_security_group_ids Additional Security Group IDs to associate with the Tailscale Subnet Router EC2 instance. list(string) [] no
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
additional_tags Additional Tailscale tags to apply to the Tailscale Subnet Router machine in addition to primary_tag. These should not include the tag: prefix. list(string) [] no
advertise_routes The routes (expressed as CIDRs) to advertise as part of the Tailscale Subnet Router.
Example: ["10.0.2.0/24", "0.0.1.0/24"]
list(string) [] no
ami The AMI to use for the Tailscale Subnet Router EC2 instance.
If not provided, the latest Amazon Linux 2 AMI will be used.
Note: This will update periodically as AWS releases updates to their AL2 AMI.
Pin to a specific AMI if you would like to avoid these updates.
string "" no
associate_public_ip_address Associate public IP address with subnet router bool 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
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
create_run_shell_document Whether or not to create the SSM-SessionManagerRunShell SSM Document. bool true 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
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
ephemeral Indicates if the key is ephemeral. bool false no
exit_node_enabled Advertise Tailscale Subnet Router EC2 instance as exit node. Defaults to false. bool false no
expiry The expiry of the auth key in seconds. number 7776000 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
instance_type The instance type to use for the Tailscale Subnet Router EC2 instance. string "t3.nano" no
key_pair_name The name of the key-pair to associate with the Tailscale Subnet Router EC2 instance. string 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
monitoring_enabled Enable detailed monitoring of instances bool true 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
preauthorized Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default. bool true no
primary_tag The primary tag to apply to the Tailscale Subnet Router machine. Do not include the tag: prefix. This must match the OAuth client's tag. If not provided, the module will use the module's ID as the primary tag, which is configured in context.tf 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
reusable Indicates if the key is reusable or single-use. bool true no
session_logging_enabled To enable CloudWatch and S3 session logging or not.
Note this does not apply to SSH sessions as AWS cannot log those sessions.
bool true no
session_logging_kms_key_alias Alias name for session_logging KMS Key.
This is only applied if 2 conditions are met: (1) session_logging_kms_key_arn is unset,
(2) session_logging_encryption_enabled = true.
string "alias/session_logging" no
session_logging_ssm_document_name Name for session_logging SSM document.
This is only applied if 2 conditions are met: (1) session_logging_enabled = true,
(2) create_run_shell_document = true.
string "SSM-SessionManagerRunShell-Tailscale" no
ssh_enabled Enable SSH access to the Tailscale Subnet Router EC2 instance. Defaults to true. bool true 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 IDs which the Tailscale Subnet Router EC2 instance will run in. These should be private subnets. list(string) n/a yes
tags Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string) {} no
tailscale_up_extra_flags Extra flags to pass to tailscale up for advanced configuration.
See more in the docs.
list(string) [] no
tailscaled_extra_flags Extra flags to pass to Tailscale daemon for advanced configuration. Example: ["--state=mem:"]
See more in the docs.
list(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
user_data The user_data to use for the Tailscale Subnet Router EC2 instance.
You can use this to automate installation of all the required command line tools.
string "" no
vpc_id The ID of the VPC which the Tailscale Subnet Router EC2 instance will run in. string n/a yes

Outputs

Name Description
autoscaling_group_id The ID of the Tailscale Subnet Router EC2 instance Autoscaling Group.
instance_name The name tag value of the Tailscale Subnet Router EC2 instance.
launch_template_id The ID of the Tailscale Subnet Router EC2 instance Launch Template.
security_group_id The ID of the Tailscale Subnet Router EC2 instance Security Group.