tenekev / terraform-tailscale Goto Github PK

This project is meant to configure an existing tailnet with custom DNS, keys and ACLs.

1. Configure a custom DNS server other than MagicDNS. That's done in order to resolve requests for an internally configured proxy.
2. Disable key expity on crucial infrastructure nodes like the DNS server, Docker server, etc.
3. Set ACL rules to prevent unwanted communication between nodes. This is useful when your tailnet has different people and you don't want them to see the rest of the network. The ACL are based on node tags.
4. Tag nodes. They are tagged recursively, based on a naming convention. The name of each node has:
   • The type of node - server, client, device
   • The access stage - whether or not this node should be public or private. A public node can be accessed by all other nodes on the network, opposed to a private one.
   • The access role - insider and outsider. You, the admin are an insider. Your SO are insiders. The discord friend you gave access to, is an outsider. They can see only public nodes.
   • The location - personally, I use a 3-letter abbr for different cities as my nodes are all accross the country.
   • The name - Docker, adguard, pihole, gitea. Initials for people - John Doe > jd.

1. A Tailscale network with some devices
2. A Tailscale API key
3. A device naming convention like so: type-access-role-location-name

1. Type*
   • server
   • laptop
   • phone
2. Access*
   • public
   • private
3. Role*
   • insider
   • outsider
4. Location
   • London > lon
   • Sofia > sof
5. Name
   • docker
   • adguard
   • John Doe > jd

⚠️ * If you are using other type, access and role tags, you need to define them in the ACL config under tagOwners. Otherwise they will not be applied.

All nodes require type, access and role defined. By combining them, you can achieve a basic but sufficient in most cases accsess control.

type-access-role-location-name

server-public-insider-sof-docker
laptop-private-outsider-sof-jd

terraform init -upgrade

terraform apply -auto-approve

terraform apply -destroy -auto-approve

Rename the variables.auto.tfvars.example to variables.auto.tfvars and fill it in.

TAILSCALE_TAILNET = "[email protected]"
# https://login.tailscale.com/admin/settings/keys
# Temp API key. 90 days since 25/04/2023
TAILSCALE_API_KEY = "tskey-api-yourapikeyhere"

TAILSCALE_DNS_SRV = "server-public-insider-your-dns-server-name"

TAILSCALE_ACL = {
    
    # https://tailscale.com/kb/1018/acls/#tag-owners
    # It's important to define all the tags that you are going to use in the machine names here.
    "tagOwners": {
      "tag:server":   ["[email protected]"],
      "tag:laptop":   ["[email protected]"],
      "tag:phone":    ["[email protected]"],
      "tag:outsider": ["[email protected]"],
      "tag:insider":  ["[email protected]"],
      "tag:public":   ["[email protected]"],
      "tag:private":  ["[email protected]"],
    },
   
    # https://tailscale.com/kb/1068/acl-tags/#acls
    "acls" : [
      # Match absolutely everything.
      # {"action": "accept", "src": ["*"], "dst": ["*:*"]},
      {
        "action": "accept",
        "src":    ["tag:insider"],
        "dst":    ["tag:public:*", "tag:private:*"],
      },
      {
        "action": "accept",
        "src":    ["tag:outsider"],
        "dst":    ["tag:public:443", "tag:public:80", "tag:public:53"],
      },
    ],
  }

• Documentation

• Basic Config

• API Keys
• DNS
• ACLs