Skip to content

Commit ee4842b

Browse files
committed
docs: add private networking troubleshooting page
1 parent 570b4e8 commit ee4842b

4 files changed

Lines changed: 56 additions & 4 deletions

File tree

docs/docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,8 @@
133133
"group": "Private networking",
134134
"pages": [
135135
"private-networking/overview",
136-
"private-networking/aws-console-setup"
136+
"private-networking/aws-console-setup",
137+
"private-networking/troubleshooting"
137138
]
138139
},
139140
{

docs/private-networking/aws-console-setup.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,9 @@ By default, no one can connect to your endpoint service. You need to explicitly
204204

205205
## Troubleshooting
206206

207+
See the dedicated [Troubleshooting](/private-networking/troubleshooting) page for common problems
208+
such as the "Private link not found" wizard error. A few quick checks specific to this setup flow:
209+
207210
<Expandable title="Status stays at Pending or Provisioning for several minutes">
208211
- Confirm Trigger.dev's AWS account ID is in your endpoint service's **Allow principals** list.
209212
- Confirm the endpoint service is **Available** in the AWS console.

docs/private-networking/overview.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -147,8 +147,11 @@ All three conditions must be true. No organization can route traffic to another
147147
Step-by-step instructions for creating the NLB, target group, and VPC Endpoint Service in your
148148
AWS account.
149149
</Card>
150-
<Card title="Use Terraform" icon="terminal" href="/private-networking/aws-console-setup">
151-
Prefer infrastructure as code? Use the Terraform wizard on the "Add connection" page in the
152-
Trigger.dev dashboard to generate a ready-to-apply script.
150+
<Card
151+
title="Troubleshooting"
152+
icon="circle-question"
153+
href="/private-networking/troubleshooting"
154+
>
155+
Common problems when setting up a private connection and how to resolve them.
153156
</Card>
154157
</CardGroup>
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: "Troubleshooting private networking"
3+
sidebarTitle: "Troubleshooting"
4+
description: "Common problems when setting up an AWS PrivateLink connection to Trigger.dev, and how to resolve them."
5+
---
6+
7+
This page collects common issues when adding a private connection. If your problem isn't listed here, [get in touch](/community).
8+
9+
## "Private link not found" in the setup wizard
10+
11+
If the setup wizard errors out with **Private link not found** when you submit the VPC Endpoint Service name, it almost always means your endpoint service has not been shared with Trigger.dev's AWS account.
12+
13+
Trigger.dev cannot provision a VPC Endpoint until your endpoint service explicitly authorizes our AWS account as a consumer. Until that happens, the service name is invisible to us — even though the name itself is correct.
14+
15+
### How to fix it
16+
17+
<Steps>
18+
<Step title="Open your endpoint service in the AWS console">
19+
Go to **VPC → Endpoint services** in the AWS region where you created the service, and select
20+
your service.
21+
</Step>
22+
<Step title="Open the Allow principals tab">
23+
Click the **Allow principals** tab and check whether Trigger.dev's AWS account is listed.
24+
</Step>
25+
<Step title="Add Trigger.dev's account if it's missing">
26+
Click **Allow principals** and add an entry in this format, replacing `<account-id>` with the
27+
Trigger.dev AWS account ID shown on the **Add connection** page in your dashboard:
28+
29+
```text
30+
arn:aws:iam::<account-id>:root
31+
```
32+
33+
<Warning>
34+
Always copy the account ID from your Trigger.dev dashboard. The correct value differs between
35+
environments — don't reuse an ID from another source.
36+
</Warning>
37+
38+
</Step>
39+
<Step title="Retry in the Trigger.dev dashboard">
40+
Once the principal is allow-listed, return to the **Add connection** page in Trigger.dev and
41+
submit the form again. The wizard should now find your endpoint service and start provisioning.
42+
</Step>
43+
</Steps>
44+
45+
For full setup instructions including this step, see [Setting up PrivateLink in the AWS Console](/private-networking/aws-console-setup).

0 commit comments

Comments
 (0)