Skip to content

Commit bc72a40

Browse files
RebeccaTamachiroRebeccaTamachiro
authored
[DNS] Internal DNS docs components adjustments (#20594)
* Add conditional rendering for create internal zone * Clear out unused components from internal-zone-create * Fix syntax to make conditional property opitional * Add .yaml file so that iDNS comes up in /products * Update DNS records link to point to #internal-dns-records * Create and apply partial for reference-zone-intro * Add info about CNAME flatenning to iDNS docs * Add note about wildcard record and reference zones * Revert "Add .yaml file so that iDNS comes up in /products" This reverts commit 5dff074. * Remove CNAME flattening desc to be added on a separate PR
1 parent 1af0a73 commit bc72a40

File tree

9 files changed

+46
-32
lines changed

9 files changed

+46
-32
lines changed

‎src/content/docs/dns/cname-flattening/index.mdx‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,12 @@ sidebar:
66
label: About
77
---
88

9-
import { Render } from "~/components"
9+
import { Render, GlossaryTooltip } from "~/components"
1010

11-
CNAME flattening speeds up CNAME resolution and allows you to use a CNAME record at your root/apex domain (`example.com`).
11+
CNAME flattening speeds up CNAME resolution and allows you to use a CNAME record at your <GlossaryTooltip term="zone apex" link="/dns/concepts/#zone-apex">zone apex</GlossaryTooltip> (`example.com`).
1212

1313
:::note
14-
15-
1614
This functionality is also what allows you to use a [root custom domain](/pages/configuration/custom-domains/) with a Cloudflare Pages site.
17-
18-
1915
:::
2016

2117
## How it works

‎src/content/docs/dns/internal-dns/get-started.mdx‎

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,9 @@ Although there are some steps that can be achieved on the dashboard, currently t
4141

4242
## 1. Set up your internal DNS zone
4343

44-
1. Use the [Create Zone](/api/resources/zones/) endpoint to create an [internal zone](/dns/internal-dns/internal-zones/). Specify your account ID and set the `type` to `internal`.
45-
46-
<Details header="Internal zone configuration conditions">
47-
<Render file="internal-zones-conditions" />
48-
</Details>
49-
50-
2. Add DNS records to your internal zone using your preferred option:
51-
- [Import](/api/resources/dns/subresources/records/methods/import/) a formatted BIND file. Refer to the [DNS records how-to](/dns/manage-dns-records/how-to/import-and-export/) for guidance.
52-
- Use other API endpoints, such as [`/batch`](/api/resources/dns/subresources/records/methods/batch/), to manage DNS records. Refer to [Batch record changes](/dns/manage-dns-records/how-to/batch-record-changes/#use-the-api) for details.
53-
3. Repeat this process for each internal zone you wish to add.
44+
<Render file="internal-zone-create" params={{
45+
conditional: "get-started-detail"}}
46+
/>
5447

5548
### (Optional) Reference a zone from another zone
5649

‎src/content/docs/dns/internal-dns/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ flowchart LR
7676
end
7777
```
7878

79-
Internal DNS zones contain the <GlossaryTooltip term="DNS record" link="/dns/manage-dns-records/">DNS records</ GlossaryTooltip> that should be used to resolve an internal DNS query. Also, if no internal record is found within a matching internal zone, Cloudflare will check if the matching internal zone is [referencing another internal zone](/dns/internal-dns/internal-zones/#reference-zones).
79+
Internal DNS zones contain the <GlossaryTooltip term="DNS record" link="/dns/internal-dns/internal-zones/#internal-dns-records">DNS records</ GlossaryTooltip> that should be used to resolve an internal DNS query. Also, if no internal record is found within a matching internal zone, Cloudflare will check if the matching internal zone is [referencing another internal zone](/dns/internal-dns/internal-zones/#reference-zones).
8080

8181
<Example>
8282

‎src/content/docs/dns/internal-dns/internal-zones/index.mdx‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@ Internal DNS zones do not get assigned Cloudflare nameservers and can only be qu
1717

1818
## Reference zones
1919

20-
During an [internal DNS query resolution](/dns/internal-dns/#architecture-overview), if no internal record is found within a matching internal zone, Cloudflare will check if the matching internal zone is referencing another internal zone. Successive references can be followed with a maximum of five references in a chain.
21-
22-
Each internal zone can only reference one other zone, but the same zone can be referenced by multiple internal zones. Public zones cannot be used as reference zones.
20+
<Render file="reference-zone-intro" />
2321

2422
Refer to [Set up reference zones](/dns/internal-dns/internal-zones/reference-zones/) for step-by-step instructions.
2523

‎src/content/docs/dns/internal-dns/internal-zones/reference-zones.mdx‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ sidebar:
77

88
import { Example, Render } from "~/components";
99

10-
During an [internal DNS query resolution](/dns/internal-dns/#architecture-overview), if no internal record is found within a matching internal zone, Cloudflare will check if the matching internal zone is referencing another internal zone. Successive references can be followed with a maximum of five references in a chain.
11-
12-
Each internal zone can only reference one other zone, but the same zone can be referenced by multiple internal zones. Public zones cannot be used as reference zones.
10+
<Render file="reference-zone-intro" />
1311

1412
## Steps
1513

‎src/content/docs/dns/internal-dns/internal-zones/setup.mdx‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,7 @@ When setting up internal zones, observe the following conditions:
1717

1818
## Create an internal zone
1919

20-
1. Use the [Create Zone](/api/resources/zones/) endpoint to create an internal zone. Specify your account ID and set the `type` to `internal`.
21-
2. Add DNS records to your internal zone using your preferred option:
22-
- [Import](/api/resources/dns/subresources/records/methods/import/) a formatted BIND file. Refer to the [DNS records how-to](/dns/manage-dns-records/how-to/import-and-export/) for guidance.
23-
- Use other API endpoints, such as [`/batch`](/api/resources/dns/subresources/records/methods/batch/), to manage DNS records. Refer to [Batch record changes](/dns/manage-dns-records/how-to/batch-record-changes/#use-the-api) for details.
24-
3. Repeat this process for each internal zone you wish to add.
25-
26-
Since the resolver policy configuration will require a DNS view, you must link the internal zones to at least one view to be able to use them when routing requests to Internal DNS. For a full procedure overview, refer to [get started](/dns/internal-dns/get-started/).
27-
20+
<Render file="internal-zone-create" />
2821

2922
## Other actions
3023

‎src/content/glossary/dns.yaml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ entries:
2727

2828
- term: DNS record
2929
general_definition: |-
30-
DNS records are instructions that live in authoritative DNS servers and provide information about a domain including what IP address is associated with that domain and how to handle requests for that domain.
30+
DNS records are instructions that live in authoritative DNS servers and provide information about a domain, including what IP address is associated with that domain and how to handle requests for that domain.
3131
3232
- term: DNS server
3333
general_definition: |-
@@ -79,3 +79,7 @@ entries:
7979
When a [DNS record is proxied](/dns/proxy-status/), requests are processed according to your configurations, and Cloudflare can optimize, cache, and protect your domain. Refer to [How Cloudflare works](/fundamentals/concepts/how-cloudflare-works/) for details.
8080
associated_products:
8181
- Fundamentals
82+
83+
- term: zone apex
84+
general_definition: |-
85+
zone apex refers to the domain or subdomain on which the control of DNS records starts.

‎src/content/partials/dns/internal-zone-create.mdx‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
params:
3+
- conditional?
4+
---
5+
6+
import { Details, Render } from "~/components";
7+
8+
1. Use the [Create Zone](/api/resources/zones/) endpoint to create an [internal zone](/dns/internal-dns/internal-zones/). Specify your account ID and set the `type` to `internal`.
9+
10+
{ props.conditional === "get-started-detail" && (
11+
<Details header="Internal zone configuration conditions">
12+
<Render file="internal-zones-conditions" />
13+
</Details>
14+
)
15+
}
16+
17+
2. Add DNS records to your internal zone using your preferred option:
18+
- [Import](/api/resources/dns/subresources/records/methods/import/) a formatted BIND file. Refer to the [DNS records how-to](/dns/manage-dns-records/how-to/import-and-export/) for guidance.
19+
- Use other API endpoints, such as [`/batch`](/api/resources/dns/subresources/records/methods/batch/), to manage DNS records. Refer to [Batch record changes](/dns/manage-dns-records/how-to/batch-record-changes/#use-the-api) for details.
20+
3. Repeat this process for each internal zone you wish to add.

‎src/content/partials/dns/reference-zone-intro.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
{}
3+
4+
---
5+
6+
During an [internal DNS query resolution](/dns/internal-dns/#architecture-overview), if no internal record is found within a matching internal zone, Cloudflare will check if the matching internal zone is referencing another internal zone. Successive references can be followed with a maximum of five references in a chain.
7+
8+
:::note
9+
A wildcard record in the matching internal zone will take precedence over an exact match in a referenced zone.
10+
:::
11+
12+
Each internal zone can only reference one other zone, but the same zone can be referenced by multiple internal zones. Public zones cannot be used as reference zones.

0 commit comments

Comments
 (0)