-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds AWS PrivateLink documentation (#17076)
Co-authored-by: nate nowack <thrast36@gmail.com>
- Loading branch information
1 parent
032194e
commit 93a270f
Showing
3 changed files
with
39 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 36 additions & 0 deletions
36
docs/v3/manage/cloud/manage-users/secure-access-by-private-link.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
title: Secure access over PrivateLink | ||
description: Manage network access to Prefect Cloud accounts over PrivateLink. | ||
--- | ||
|
||
PrivateLink is an available upgrade to certain Enterprise plans. | ||
[PrivateLink](https://aws.amazon.com/privatelink/) enables account administrators to restrict access to Prefect Cloud APIs and the UI at the network level, by routing all network traffic through AWS and GCP. | ||
Traffic between your network and Prefect Cloud is encrypted, and does not traverse the public internet. | ||
|
||
To learn more, please contact your account manager or the Prefect team at sales@prefect.io. | ||
|
||
Your Prefect team will provide the service endpoint to register. | ||
Provide the following information for the registered endpoint so that Prefect can accept the connection: | ||
|
||
- AWS Account Number | ||
- AWS VPC IDs | ||
- Source Region for each VPC (for example, `us-east-1`, `us-east-2`, etc.) | ||
- VPC Endpoint ID | ||
|
||
Prefect will match your pending connection to the information provided, and accept the connection once approved. | ||
|
||
Once accepted, customers should enable "Modify Private DNS" to ensure the VPCs can resolve the Prefect service endpoint. | ||
|
||
With Private DNS and the accepted connection, connectivity can be validated through curl: | ||
|
||
```bash | ||
curl -i https://api-internal.private.prefect.cloud/api/health | ||
``` | ||
|
||
To configure Prefect clients and workers to use the endpoint, `PREFECT_API_URL` and `PREFECT_CLOUD_API_URL` should be set to the endpoint provided by Prefect. | ||
|
||
```bash | ||
prefect config set PREFECT_API_URL=https://api-internal.private.prefect.cloud/api/accounts/<ACCOUNT_ID>/workspaces/<WORKSPACE_ID> | ||
prefect config set PREFECT_CLOUD_API_URL=https://api-internal.private.prefect.cloud/api | ||
``` | ||
|