Skip to content

Commit 68bf049

Browse files
committed
add Network and Firewall Requirements page with list of domains
1 parent b7dec49 commit 68bf049

6 files changed

Lines changed: 48 additions & 2 deletions

docs/guides/operator-guide-aks-enclave.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,10 @@ az network vnet subnet update \
254254
--nat-gateway ${NAT_GATEWAY_NAME}
255255
```
256256

257+
:::note
258+
The NAT gateway provides the operator's outbound internet access. If your environment restricts outbound network traffic, you must allow the destinations listed in [Network and firewall requirements](operator-private-network-requirements.md).
259+
:::
260+
257261
#### Get the AKS Subnet ID
258262

259263
To create the AKS subnet ID, run the following command, using your own values as needed:

docs/guides/operator-guide-aws-marketplace.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ To avoid passing certificates associated with your domain into the enclave, inbo
154154
| ----------- | --------- | -------- | ------ |
155155
| 80 | Inbound | HTTP | Serves all UID2 APIs, including the healthcheck endpoint `/ops/healthcheck`.<br/>When everything is up and running, the endpoint returns HTTP 200 with a response body of `OK`. For details, see [Checking UID2 Operator status](#checking-uid2-operator-status). |
156156
| 9080 | Inbound | HTTP | Serves Prometheus metrics (`/metrics`). |
157-
| 443 | Outbound | HTTPS | Calls the UID2 Core Service, AWS S3, to download files for opt-out data and key store. |
157+
| 443 | Outbound | HTTPS | Calls the UID2 Core Service and AWS S3, to download files for opt-out data and key store. If your environment restricts outbound network traffic, you must allow the destinations listed in [Network and firewall requirements](operator-private-network-requirements.md). |
158158

159159
### VPC chart
160160

docs/guides/operator-guide-azure-enclave.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ The following table provides information about supported protocols.
330330
| ----------- | --------- | -------- | ------ |
331331
| 80 | Inbound | HTTP | Serves all UID2 APIs, including the health check endpoint `/ops/healthcheck`.<br/>When everything is up and running, the endpoint returns HTTP 200 with a response body of `OK`. For details, see [Running the health check](#running-the-health-check). |
332332
| 9080 | Inbound | HTTP | Serves Prometheus metrics (`/metrics`). For details, see [Scraping metrics](#scraping-metrics). |
333-
| 443 | Outbound | HTTPS | Calls the UID2 Core Service and Azure Blob Storage, to download files for opt-out data and key store. |
333+
| 443 | Outbound | HTTPS | Calls the UID2 Core Service and AWS S3, to download files for opt-out data and key store. If your environment restricts outbound network traffic, you must allow the destinations listed in [Network and firewall requirements](operator-private-network-requirements.md). |
334334

335335
## Upgrading
336336

docs/guides/operator-private-gcp-confidential-space.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,8 @@ Before choosing your deployment option, complete these Google Cloud setup steps:
9090

9191
1. Enable egress rule. If your VPC infrastructure only allows egress to known endpoints, you will need to enable an egress rule to allow the operator to retrieve the certificates required for attestation. To enable this, follow the details in this document from Google: [VPC Service Controls](https://cloud.google.com/vpc-service-controls/docs/supported-products#table_confidential_space).
9292

93+
You must also allow outbound access to the UID2 service and storage destinations that the operator depends on. For the full list, see [Network and firewall requirements](operator-private-network-requirements.md).
94+
9395
### UID2 Operator account setup
9496

9597
Ask your UID2 contact to register your organization as a UID2 Operator. If you're not sure who to ask, see [Contact info](../getting-started/gs-account-setup.md#contact-info).
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Private Operator network and firewall requirements
3+
sidebar_label: Network and firewall requirements
4+
pagination_label: Private Operator network and firewall requirements
5+
description: Outbound network destinations a Private Operator must reach, for configuring egress firewall allowlists.
6+
hide_table_of_contents: false
7+
sidebar_position: 16
8+
displayed_sidebar: docs
9+
---
10+
11+
import Link from '@docusaurus/Link';
12+
13+
# Private Operator network and firewall requirements
14+
15+
A <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link> connects to the UID2 <Link href="../ref-info/glossary-uid#gl-core-service">Core</Link> and <Link href="../ref-info/glossary-uid#gl-opt-out-service">Opt-Out</Link> services, and downloads data files directly from AWS S3 using URLs that the Core service provides. For details, see [Private Operator workflow](integration-options-private-operator.md#private-operator-workflow).
16+
17+
If your environment restricts outbound network traffic, you must allow outbound HTTPS (port 443) to all of the destinations below, or the operator cannot start.
18+
19+
## Integration
20+
21+
| Hostname | Purpose |
22+
| --- | --- |
23+
| `core-integ.uidapi.com` | Core Service (attestation, keys, salts, configuration) |
24+
| `optout-integ.uidapi.com` | Opt-Out Service |
25+
| `uid2-core-integ-store.s3.us-east-2.amazonaws.com` | Core data storage |
26+
| `uid2-optout-integ-store.s3.us-east-2.amazonaws.com` | Opt-out data storage |
27+
28+
## Production
29+
30+
| Hostname | Purpose |
31+
| --- | --- |
32+
| `core-prod.uidapi.com` | Core Service (attestation, keys, salts, configuration) |
33+
| `optout-prod.uidapi.com` | Opt-Out Service |
34+
| `uid2-core-prod-store.s3.us-east-2.amazonaws.com` | Core data storage |
35+
| `uid2-core-prod-store-replica.s3.us-west-2.amazonaws.com` | Core data storage (failover replica) |
36+
| `uid2-optout-prod-store.s3.us-east-2.amazonaws.com` | Opt-out data storage |
37+
| `uid2-optout-prod-store-replica.s3.us-west-2.amazonaws.com` | Opt-out data storage (failover replica) |
38+
39+
Allow these by hostname rather than by IP address, as the underlying addresses change.

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,7 @@ const fullSidebar = [
259259
'guides/operator-private-gcp-confidential-space',
260260
'guides/operator-guide-azure-enclave',
261261
'guides/operator-guide-aks-enclave',
262+
'guides/operator-private-network-requirements',
262263
],
263264
},
264265
],

0 commit comments

Comments
 (0)