Updated references to 'service discovery' in dns docs (now dns aliases) (#556)
* Updated references to 'service discovery' in dns docs (now dns aliases) * add entry to side bar menu & update references within page to match title
|
Before Width: | Height: | Size: 238 KiB After Width: | Height: | Size: 238 KiB |
|
Before Width: | Height: | Size: 264 KiB After Width: | Height: | Size: 264 KiB |
|
Before Width: | Height: | Size: 209 KiB After Width: | Height: | Size: 209 KiB |
|
Before Width: | Height: | Size: 259 KiB After Width: | Height: | Size: 259 KiB |
|
Before Width: | Height: | Size: 188 KiB After Width: | Height: | Size: 188 KiB |
|
Before Width: | Height: | Size: 154 KiB After Width: | Height: | Size: 154 KiB |
|
Before Width: | Height: | Size: 195 KiB After Width: | Height: | Size: 195 KiB |
@@ -165,6 +165,7 @@ export const docsNavigation = [
|
||||
{ title: 'Configuring Nameservers', href: '/manage/dns/nameserver-groups' },
|
||||
{ title: 'DNS Settings', href: '/manage/dns/dns-settings' },
|
||||
{ title: 'Custom Zones', href: '/manage/dns/custom-zones' },
|
||||
{ title: 'DNS Aliases for Routed Networks', href: '/manage/dns/dns-aliases-for-routed-networks' },
|
||||
{ title: 'DNS Troubleshooting', href: '/manage/dns/troubleshooting' },
|
||||
]
|
||||
},
|
||||
|
||||
@@ -111,4 +111,4 @@ Custom DNS Zones have the following limitations:
|
||||
|
||||
## Use Cases
|
||||
|
||||
- [Service Discovery for Routed Networks](/manage/dns/service-discovery-for-routed-networks)
|
||||
- [DNS Aliases for Routed Networks](/manage/dns/dns-aliases-for-routed-networks)
|
||||
@@ -1,4 +1,4 @@
|
||||
# Service Discovery for Routed Networks
|
||||
# DNS Aliases for Routed Networks
|
||||
|
||||
This guide explains how to use Custom DNS Zones with NetBird's Networks to provide easy-to-remember DNS names for resources in private
|
||||
networks.
|
||||
@@ -23,11 +23,11 @@ This works, but it's problematic:
|
||||
|
||||
### The Solution
|
||||
|
||||
Service Discovery with Custom DNS Zones solves this by giving your private network resources friendly, memorable DNS names. Instead of `192.168.0.68`, your developers connect to `postgres.netbird.internal` or simply `postgres`.
|
||||
DNS Aliases with Custom DNS Zones solve this by giving your private network resources friendly, memorable DNS names. Instead of `192.168.0.68`, your developers connect to `postgres.netbird.internal` or simply `postgres`.
|
||||
|
||||
### How the DNS Resolution Works
|
||||
|
||||
Here's what happens when you set up service discovery and a developer tries to connect to `postgres.netbird.internal`:
|
||||
Here's what happens when you set up a DNS Alias and a developer tries to connect to `postgres.netbird.internal`:
|
||||
|
||||
**Setup (One-Time):**
|
||||
|
||||
@@ -68,7 +68,7 @@ First, create a Custom DNS Zone to manage the DNS records for your private servi
|
||||
- **Enable Search Domain**: Keep this enabled to allow using short names (e.g., `postgres` instead of `postgres.netbird.internal`).
|
||||
4. Click **Add Zone**.
|
||||
|
||||
<img src="/docs-static/img/manage/dns/service-discovery/zone-config.png" alt="Delete DNS Zone" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/dns/dns-aliases/zone-config.png" alt="Delete DNS Zone" className="imagewrapper-big"/>
|
||||
|
||||
### Step 2: Add DNS Records
|
||||
|
||||
@@ -87,7 +87,7 @@ Next, add DNS records for each of your services.
|
||||
- **Type**: `A`
|
||||
- **Value**: `192.168.0.78`
|
||||
|
||||
<img src="/docs-static/img/manage/dns/service-discovery/records-created.png" alt="DNS Records Created" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/dns/dns-aliases/records-created.png" alt="DNS Records Created" className="imagewrapper-big"/>
|
||||
|
||||
### Step 3: Configure Network Routing
|
||||
|
||||
@@ -102,7 +102,7 @@ To enable access to your private resources, you need to set up a network with ro
|
||||
- **Description**: `Provides access to internal service resources`
|
||||
4. Click **Add Network**.
|
||||
|
||||
<img src="/docs-static/img/manage/dns/service-discovery/create-network.png" alt="Create Network" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/dns/dns-aliases/create-network.png" alt="Create Network" className="imagewrapper-big"/>
|
||||
|
||||
#### Add Network Resources
|
||||
|
||||
@@ -114,7 +114,7 @@ Add a wildcard resource that will match all services in your DNS zone.
|
||||
- **Groups**: Assign to a resource group (e.g., `internal-services`)
|
||||
2. Click **Add Resource**.
|
||||
|
||||
<img src="/docs-static/img/manage/dns/service-discovery/add-resource.png" alt="Add Network Resource" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/dns/dns-aliases/add-resource.png" alt="Add Network Resource" className="imagewrapper-big"/>
|
||||
|
||||
<Note>
|
||||
Repeat the same steps to add the **Internal Postgres** resource with the address `postgres.netbird.internal`.
|
||||
@@ -132,7 +132,7 @@ Create a policy to allow your developers to access these resources.
|
||||
- **Ports**: `All`
|
||||
2. Click **Continue** twice, then click **Add Policy**.
|
||||
|
||||
<img src="/docs-static/img/manage/dns/service-discovery/create-policy.png" alt="Create Access Control Policy" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/dns/dns-aliases/create-policy.png" alt="Create Access Control Policy" className="imagewrapper-big"/>
|
||||
|
||||
|
||||
#### Add a Routing Peer
|
||||
@@ -142,13 +142,13 @@ Next, add a routing peer that has access to your private network.
|
||||
1. Click **Add Routing Peer** and select the peer that is running in your data center or VPC.
|
||||
2. Click **Continue** and then **Add Routing Peer** to confirm.
|
||||
|
||||
<img src="/docs-static/img/manage/dns/service-discovery/add-routing-peer.png" alt="Add Routing Peer" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/dns/dns-aliases/add-routing-peer.png" alt="Add Routing Peer" className="imagewrapper-big"/>
|
||||
|
||||
After completing the wizard, your network routing is configured, and the DNS names you created will now work seamlessly with the network routes.
|
||||
|
||||
You can view your fully configured network in the Networks dashboard:
|
||||
|
||||
<img src="/docs-static/img/manage/dns/service-discovery/network-overview.png" alt="Fully Configured Network" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/dns/dns-aliases/network-overview.png" alt="Fully Configured Network" className="imagewrapper-big"/>
|
||||
|
||||
### Step 4: Verify the Setup
|
||||
|
||||