-
Notifications
You must be signed in to change notification settings - Fork 260
feat(vpc): add info on DNS #4159
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
9f83f16
feat(dns): first draft
RoRoJ fe8af41
feat(vps): dns more info
RoRoJ cc89416
fix(vpc): juggle info
RoRoJ f9850ad
fix(vpc): add info
RoRoJ 64af8fb
Apply suggestions from code review
RoRoJ 03a82a7
Apply suggestions from code review
RoRoJ 6a7c8ac
fix(vpc): add info to dns doc
RoRoJ File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,79 @@ | ||
| --- | ||
| meta: | ||
| title: Understanding Scaleway DNS | ||
| description: Learn more about how internal DNS works within the Scaleway ecosystem, and how to ensure your infrastructure is using DNS efficiently. | ||
| content: | ||
| h1: Understanding Scaleway DNS | ||
RoRoJ marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| paragraph: Learn more about how internal DNS works within the Scaleway ecosystem, and how to ensure your infrastructure is using DNS efficiently. | ||
| tags: vpc private-network dns dns-server dns-resolution hostname | ||
| dates: | ||
| validation: 2024-12-31 | ||
| posted: 2024-12-31 | ||
| categories: | ||
| - network | ||
| --- | ||
|
|
||
| Scaleway VPC and Private Networks integrate managed DNS, for the effective resolution of hostnames to IP addresses. Read on to find out more. | ||
|
|
||
| ## What is DNS? | ||
|
|
||
| The **D**omain **N**ame **S**ystem (DNS) is a naming system for devices connected to the internet or any network. Most prominently, DNS servers translate text-based domain names (e.g. www.scaleway.com) to numerical IP addresses (e.g. 51.158.66.220). This allows traffic to find its destination by resolving a human-readable text-based name, to the numerical IP addresses used by networks and servers. | ||
|
|
||
| ## Scaleway DNS overview | ||
|
|
||
| Scaleway Private Networks benefit from managed internal DNS. This allows the resolution of resources' **hostnames** on the Private Network, into their private IP addresses. This managed DNS service is automatically exposed in each Private Network and no user configuration is required. | ||
|
|
||
| <Message type="note"> | ||
| When a Private Network is attached to a [legacy Public Gateway](/network/public-gateways/concepts/#ipam), the gateway’s DNS takes priority over that of the Private Network. | ||
| </Message> | ||
|
|
||
| ## Hostname format | ||
|
|
||
| A resource's hostname is equivalent to the name you gave the resource when creating it. The full format for internal addressing is `<hostname>.<private-network-name>.internal`. For example, if you have an Instance with the name `instance123` attached to a Private Network named `prodpn`, its address on that network is `instance123.prodpn.internal`. | ||
|
|
||
| <Message type="tip"> | ||
| - If you update the resource's name after creating it, and thus its hostname changes, it will not be automatically updated on our DNS records unless you detach and reattach the resource to the Private Network. <br/><br/> | ||
| - If you created the resource via the API, and it has dots in its name, these dots should be replaced by dashes for the purposes of DNS resolution (`my.instance` --> `my-instance`). We generally recommend avoiding using dots in your resource names to avoid issues.<br/><br/> | ||
| - You can also reach a resource via its resource ID, e.g. `e49902a6-ed4c-431f-bd62-0fc41063eec0.prodpn.internal` - see below for full details. | ||
| </Message> | ||
|
|
||
| ## DNS resolution details | ||
|
|
||
| The managed DNS resolver service is exposed on each Private Network through the following IP addresses: | ||
|
|
||
| - IPv4: `169.254.169.254` | ||
| - IPv6: `fe80::200:22ff:fe05:ca1e` | ||
|
|
||
| The service resolves both regular public records, as well as internal VPC records | ||
RoRoJ marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| <Message type="tip"> | ||
| The `.internal` at the end of internal addresses is important in enabling the resolver to distinguish between internal and external/public DNS. For this reason, you should always add `.internal` when addressing resources within your VPC. | ||
| </Message> | ||
|
|
||
| The DNS service resolves the following formats: | ||
|
|
||
| ``` | ||
| <resource_name>.<private-network_name>.internal | ||
| <resource_name>.<private-network_uuid>.internal | ||
| <resource_uuid>.<private-network_uuid>.internal | ||
| ``` | ||
|
|
||
| Note that DNS cannot resolve or forward queries between different VPCs. It can only resolve hostnames for resources within the same VPC, though they may be on different Private Networks within that VPC. | ||
|
|
||
| ## Rate limiting | ||
|
|
||
| Currently, DNS requests are rate-limited to 50 requests per second per resource. Watch this space as we work to be able to increase this limit to accommodate higher traffic volumes. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| If you experience problems with DNS, try the following steps: | ||
|
|
||
| 1. **Detach and reattach the affected resources from/to the Private Network.** This is effective in solving many issues for older resources, or resources whose name you have changed. | ||
|
|
||
| 2. **Check resource hostname**. Issues can arise if your resource has a dot in its name. Rename it if necessary to eliminate the dot, and detach/reattach it from the Private Network. | ||
|
|
||
| 3. **Check Private Network name**. Issues can arise with Private Networks who share a name with a TLD. See our [dedicated document](/network/vpc/troubleshooting/pn-name/) for more help. | ||
|
|
||
| 4. **Check whether you are using Network Manager**: DNS does not work out of hte box for Linux distributions using Network Managed, such as **RockyLinux**. Find out how to resolve this problem [in our troubleshooting page](/network/vpc/troubleshooting/private-dns-dhcp-not-working/#distributions-running-network-manager) | ||
RoRoJ marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| If you are still having problems reaching a resource attached to a Private Network via its hostname, [open a support ticket](https://console.scaleway.com/support). | ||
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.