Tailscale on Porter
Tailscale is a VPN that creates a secure network between your servers, computers, and cloud instances. Unlike many other VPNs, setting up a new network on Tailscale requires minimal user configuration and virtually no experience with networking. To learn more about how Tailscale works under the hood, you can check out this excellent overview on their official blog.
We will be deploying a Tailscale “subnet router” which will allow any services deployed on your Porter cluster to be accessible over the Tailscale network (Tailnet).
Setting up Tailscale
Installing Tailscale Addon
- On the Porter dashboard, click on the “Addons” tab on the left sidebar.
- Click “New Addon”
- Select “Tailscale” from the list of addons
- Click “Deploy Addon”
- Enter a name for the addon, such as “Tailscale”
Retrieving Tailscale API Key
- Visit your Tailscale Admin Panel
- Go to
Settings
->Auth Keys
- Click on
Generate one-off key
- Copy the API key as we will need it for the next step
Adding the Tailscale API Key to Porter
- On the Porter dashboard, click “Addons”, and click on the “Tailscale” addon
- Select the
Tailscale Settings
tab - Paste the API key from above into the
Tailscale Auth Key
field, then clickDeploy
Adding Routes to your Tailnet
By default, every time that you click “Provision” on your cluster from the Infrastructure
tab, Porter will ensure that all of your Porter-managed applications and Datastores are accessbile over the Tailnet.
As each route is added, it must be approved by an admin in the Tailscale Admin Panel.
- Visit your Tailscale Admin Panel
- Click on
Machines
- Click on the
ABC-subnet-router-relay
, whereABC
is the name that you gave the Tailscale addon on Porter - Click on the 3 dots on the right side of the
ABC-subnet-router-relay
, clickReview Route Settings
- Click
Approve All
to approve all routes - If you intend to use
porter app run
orporter datastore connect
commands, also checkUse as Exit Node
.
Your Tailscale Subnet Router should now be online. All of your Porter applications and Datastores should be accessible over the Tailnet.