mirror of
https://github.com/netbirdio/docs.git
synced 2026-10-05 13:19:05 +02:00
docs: use netbird.example.com for the Management domain, as the rest of the self-hosted docs do
This commit is contained in:
@@ -43,7 +43,7 @@ This guide uses these public service URLs:
|
|||||||
|
|
||||||
| Service | Example URL | Used by |
|
| Service | Example URL | Used by |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
| Management | `https://app.example.com` | Dashboard, Management API, Management gRPC, and OAuth |
|
| Management | `https://netbird.example.com` | Dashboard, Management API, Management gRPC, and OAuth |
|
||||||
| Signal | `https://signal.example.com` | NetBird peers for signaling |
|
| Signal | `https://signal.example.com` | NetBird peers for signaling |
|
||||||
| Relay | One per instance, e.g. `rels://us-1.relay.example.com:443` and `rels://eu-1.relay.example.com:443`. With the geo-DNS option, also a shared `rels://relay.example.com:443`. | NetBird peers that need relay connectivity |
|
| Relay | One per instance, e.g. `rels://us-1.relay.example.com:443` and `rels://eu-1.relay.example.com:443`. With the geo-DNS option, also a shared `rels://relay.example.com:443`. | NetBird peers that need relay connectivity |
|
||||||
|
|
||||||
@@ -69,7 +69,7 @@ The Management and Signal pools each use one stable URL backed by load-balanced
|
|||||||
flowchart TB
|
flowchart TB
|
||||||
Peers[NetBird Peers]
|
Peers[NetBird Peers]
|
||||||
|
|
||||||
LBM[Load Balancer<br/>app.example.com]
|
LBM[Load Balancer<br/>netbird.example.com]
|
||||||
LBS[Load Balancer<br/>signal.example.com]
|
LBS[Load Balancer<br/>signal.example.com]
|
||||||
|
|
||||||
subgraph Mgmt[Management pool: Enterprise]
|
subgraph Mgmt[Management pool: Enterprise]
|
||||||
@@ -123,7 +123,7 @@ In single-node mode, the Signal service keeps peer connection state in memory an
|
|||||||
- At least **2 Relay instances**, on separate failure domains.
|
- At least **2 Relay instances**, on separate failure domains.
|
||||||
- At least **3 NATS instances** for the coordination cluster, on separate failure domains. NATS can colocate with NetBird hosts, but the 3 NATS instances must be on different failure domains.
|
- At least **3 NATS instances** for the coordination cluster, on separate failure domains. NATS can colocate with NetBird hosts, but the 3 NATS instances must be on different failure domains.
|
||||||
- A **load balancer** for the Management and Signal pools. These can be two independent load balancers, two frontends on one shared load balancer, or two managed load-balancer resources, as long as each pool is reachable through a single stable URL. Both require HTTP/2 + gRPC support. The Relay pool does not use a load balancer.
|
- A **load balancer** for the Management and Signal pools. These can be two independent load balancers, two frontends on one shared load balancer, or two managed load-balancer resources, as long as each pool is reachable through a single stable URL. Both require HTTP/2 + gRPC support. The Relay pool does not use a load balancer.
|
||||||
- Public **FQDNs** for Management and Signal, for example `app.example.com` and `signal.example.com`, each resolving to its load balancer. One more per Relay instance, for example `us-1.relay.example.com` and `eu-1.relay.example.com`, each resolving to that instance. With the geo-DNS option, also a shared `relay.example.com`.
|
- Public **FQDNs** for Management and Signal, for example `netbird.example.com` and `signal.example.com`, each resolving to its load balancer. One more per Relay instance, for example `us-1.relay.example.com` and `eu-1.relay.example.com`, each resolving to that instance. With the geo-DNS option, also a shared `relay.example.com`.
|
||||||
- Permissions to deploy services, mount configuration and secrets, expose network ports, manage DNS records, and register instances with the load balancers in your environment.
|
- Permissions to deploy services, mount configuration and secrets, expose network ports, manage DNS records, and register instances with the load balancers in your environment.
|
||||||
|
|
||||||
## Step 1: Make PostgreSQL highly available
|
## Step 1: Make PostgreSQL highly available
|
||||||
@@ -347,7 +347,7 @@ Plan one load-balancer frontend for each of the Management and Signal pools. The
|
|||||||
| Pool | Public FQDN | Backend port | Frontend protocol | Health check |
|
| Pool | Public FQDN | Backend port | Frontend protocol | Health check |
|
||||||
|---|---|---|---|---|
|
|---|---|---|---|---|
|
||||||
| Signal | e.g. `signal.example.com` | 443 | HTTPS, HTTP/2, gRPC | TCP/443 (or gRPC health if supported) |
|
| Signal | e.g. `signal.example.com` | 443 | HTTPS, HTTP/2, gRPC | TCP/443 (or gRPC health if supported) |
|
||||||
| Management | e.g. `app.example.com` | 443 | HTTPS, HTTP/2, gRPC | `GET /oauth2/.well-known/openid-configuration` → HTTP 200 |
|
| Management | e.g. `netbird.example.com` | 443 | HTTPS, HTTP/2, gRPC | `GET /oauth2/.well-known/openid-configuration` → HTTP 200 |
|
||||||
|
|
||||||
Common requirements for every pool:
|
Common requirements for every pool:
|
||||||
|
|
||||||
@@ -575,7 +575,7 @@ Now configure the Management replicas to point at everything you've set up: Post
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
server:
|
server:
|
||||||
exposedAddress: "https://app.example.com:443"
|
exposedAddress: "https://netbird.example.com:443"
|
||||||
dataDir: "/var/lib/netbird/"
|
dataDir: "/var/lib/netbird/"
|
||||||
|
|
||||||
# External STUN: one entry per Relay instance, see Step 5
|
# External STUN: one entry per Relay instance, see Step 5
|
||||||
@@ -618,7 +618,7 @@ server:
|
|||||||
|
|
||||||
trafficFlow:
|
trafficFlow:
|
||||||
enabled: true
|
enabled: true
|
||||||
address: "https://app.example.com:443"
|
address: "https://netbird.example.com:443"
|
||||||
interval: "60s"
|
interval: "60s"
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -641,7 +641,7 @@ Bring up replicas one at a time and register each in the Management LB once heal
|
|||||||
```
|
```
|
||||||
2. **Distribute `config.yaml`** to every Management replica host. Verify identical files (`sha256sum config.yaml`) on each.
|
2. **Distribute `config.yaml`** to every Management replica host. Verify identical files (`sha256sum config.yaml`) on each.
|
||||||
3. **Start replica 1**. Wait for `/oauth2/.well-known/openid-configuration` to return 200 and check the logs for `Management server created` followed by `Starting CloudServer`.
|
3. **Start replica 1**. Wait for `/oauth2/.well-known/openid-configuration` to return 200 and check the logs for `Management server created` followed by `Starting CloudServer`.
|
||||||
4. **Register replica 1** in the Management LB. Confirm the dashboard is reachable via `https://app.example.com/`.
|
4. **Register replica 1** in the Management LB. Confirm the dashboard is reachable via `https://netbird.example.com/`.
|
||||||
5. **Start replica 2**, verify health, register in the LB.
|
5. **Start replica 2**, verify health, register in the LB.
|
||||||
6. **Repeat for any additional replicas.**
|
6. **Repeat for any additional replicas.**
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user