Skip to content

Commit 1c1b751

Browse files
authored
Merge pull request #59695 from bmcelvee/OSDOCS-5568
Add DNS forwarding content to ROSA and OSD
2 parents 608c9f6 + af1ca5c commit 1c1b751

File tree

4 files changed

+34
-2
lines changed

4 files changed

+34
-2
lines changed

_topic_maps/_topic_map_osd.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,8 @@ Name: Networking
232232
Dir: networking
233233
Distros: openshift-dedicated
234234
Topics:
235+
- Name: Understanding the DNS Operator
236+
File: dns-operator
235237
- Name: Understanding the Ingress Operator
236238
File: ingress-operator
237239
- Name: OpenShift SDN default CNI network provider

_topic_maps/_topic_map_rosa.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,8 @@ Name: Networking
329329
Dir: networking
330330
Distros: openshift-rosa
331331
Topics:
332+
- Name: Understanding the DNS Operator
333+
File: dns-operator
332334
- Name: Understanding the Ingress Operator
333335
File: ingress-operator
334336
- Name: OpenShift SDN default CNI network provider

modules/nw-dns-forward.adoc

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,21 @@
99
You can use DNS forwarding to override the default forwarding configuration in the `/etc/resolv.conf` file in the following ways:
1010

1111
* Specify name servers for every zone. If the forwarded zone is the Ingress domain managed by {product-title}, then the upstream name server must be authorized for the domain.
12+
+
13+
ifdef::openshift-rosa,openshift-dedicated[]
14+
[IMPORTANT]
15+
====
16+
You must specify at least one zone. Otherwise, your cluster can lose functionality.
17+
====
18+
endif::[]
19+
+
1220
* Provide a list of upstream DNS servers.
1321
* Change the default forwarding policy.
1422
1523
[NOTE]
16-
=====
24+
====
1725
A DNS forwarding configuration for the default domain can have both the default servers specified in the `/etc/resolv.conf` file and the upstream DNS servers.
18-
=====
26+
====
1927

2028
.Procedure
2129

@@ -55,6 +63,14 @@ spec:
5563
----
5664
<1> Must comply with the `rfc6335` service name syntax.
5765
<2> Must conform to the definition of a subdomain in the `rfc1123` service name syntax. The cluster domain, `cluster.local`, is an invalid subdomain for the `zones` field.
66+
ifdef::openshift-rosa,openshift-dedicated[]
67+
+
68+
[IMPORTANT]
69+
====
70+
Only forward to specific zones, such as your intranet. You must specify at least one zone. Otherwise, your cluster can lose functionality.
71+
====
72+
+
73+
endif::[]
5874
<3> Defines the policy to select upstream resolvers. Default value is `Random`. You can also use the values `RoundRobin`, and `Sequential`.
5975
<4> A maximum of 15 `upstreams` is allowed per `forwardPlugin`.
6076
<5> Optional. You can use it to override the default policy and forward DNS resolution to the specified DNS resolvers (upstream resolvers) for the default domain. If you do not provide any upstream resolvers, the DNS name queries go to the servers in `/etc/resolv.conf`.
@@ -103,6 +119,14 @@ spec:
103119
----
104120
<1> Must comply with the `rfc6335` service name syntax.
105121
<2> Must conform to the definition of a subdomain in the `rfc1123` service name syntax. The cluster domain, `cluster.local`, is an invalid subdomain for the `zones` field. The cluster domain, `cluster.local`, is an invalid `subdomain` for `zones`.
122+
ifdef::openshift-rosa,openshift-dedicated[]
123+
+
124+
[IMPORTANT]
125+
====
126+
Only forward to specific zones, such as your intranet. You must specify at least one zone. Otherwise, your cluster can lose functionality.
127+
====
128+
+
129+
endif::[]
106130
<3> When configuring TLS for forwarded DNS queries, set the `transport` field to have the value `TLS`.
107131
By default, CoreDNS caches forwarded connections for 10 seconds. CoreDNS will hold a TCP connection open for those 10 seconds if no request is issued. With large clusters, ensure that your DNS server is aware that it might get many new connections to hold open because you can initiate a connection per node. Set up your DNS hierarchy accordingly to avoid performance issues.
108132
<4> When configuring TLS for forwarded DNS queries, this is a mandatory server name used as part of the server name indication (SNI) to validate the upstream TLS server certificate.

networking/dns-operator.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,19 @@ The DNS Operator deploys and manages CoreDNS to provide a name resolution
1010
service to pods, enabling DNS-based Kubernetes Service discovery in
1111
{product-title}.
1212

13+
ifndef::openshift-rosa,openshift-osd[]
1314
include::modules/nw-dns-operator.adoc[leveloffset=+1]
1415

1516
include::modules/nw-dns-operator-managementState.adoc[leveloffset=+1]
1617

1718
include::modules/nw-controlling-dns-pod-placement.adoc[leveloffset=+1]
1819

1920
include::modules/nw-dns-view.adoc[leveloffset=+1]
21+
endif::[]
2022

2123
include::modules/nw-dns-forward.adoc[leveloffset=+1]
2224

25+
ifndef::openshift-rosa,openshift-osd[]
2326
include::modules/nw-dns-operator-status.adoc[leveloffset=+1]
2427

2528
include::modules/nw-dns-operator-logs.adoc[leveloffset=+1]
@@ -29,3 +32,4 @@ include::modules/nw-dns-loglevel.adoc[leveloffset=+1]
2932
include::modules/nw-dns-operatorloglevel.adoc[leveloffset=+1]
3033

3134
include::modules/nw-dns-cache-tuning.adoc[leveloffset=+1]
35+
endif::[]

0 commit comments

Comments
 (0)