Skip to content

Commit 4fdd169

Browse files
Clarify resolv.conf requirements (#197)
1 parent d33f0c3 commit 4fdd169

File tree

3 files changed

+53
-14
lines changed

3 files changed

+53
-14
lines changed

dnsmasq.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ DNSMasq
66

77
The DNSMasq module is a lightweight DNS and DHCP server designed to provide its services within a private network. It is not recommended for use as a public DNS server.
88

9-
It can be installed through the :ref:`software_center-section`.
9+
.. note::
10+
11+
Do not configure Dnsmasq as the NS8 node name resolver in
12+
``/etc/resolv.conf``. For more information, see :ref:`resolv-conf`.
1013

1114

1215
Prerequisites

system_requirements.rst

Lines changed: 42 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,38 +47,70 @@ Static IP address
4747
=================
4848

4949
A working internet connection is necessary for the installation,
50-
configuration, and updating of the system. It is required also if an
50+
configuration, and updating of the node. It is required also if an
5151
active :ref:`subscription <subscription-section>` is in place.
5252

53-
Assign a static IP address to the system. DHCP and any other
53+
Assign a static IP address to the node. DHCP and any other
5454
dynamic IP discovery protocols are not allowed.
5555

56+
.. _resolv-conf:
57+
58+
Name resolution
59+
===============
60+
61+
The node name resolver must be configured to use DNS servers that are not
62+
provided by NS8 itself. This is required because the ``/etc/resolv.conf``
63+
file is inherited by application containers, which may use private network
64+
setups that can conflict with the node’s own DNS service.
65+
66+
The ``/etc/resolv.conf`` file should contain one or more ``nameserver``
67+
lines specifying the IP addresses of DNS servers available to the node.
68+
These servers can be in the same LAN or on the public Internet. If the
69+
file is managed by tools such as ``NetworkManager`` or ``cloud-init``, do
70+
not edit it directly. Instead, follow the configuration guidelines
71+
provided by those tools.
72+
73+
Avoid the following configurations:
74+
75+
- Do not use ``nameserver 127.0.0.1`` or any IP address assigned to the
76+
node itself. If the Linux distribution has installed a local DNS
77+
resolver service, refer to its documentation to disable or remove it.
78+
79+
- Do not use any NS8 application providing DNS service as the node name
80+
resolver, such as Samba Active Directory or DNSMasq. This can cause
81+
name resolution loops or prevent node updates.
82+
83+
- Do not mix DNS servers from different network scopes, for example,
84+
``1.1.1.1`` (public, Cloudflare) and ``192.168.1.1`` (private). Doing so
85+
can lead to inconsistent DNS query results.
86+
87+
5688
.. _dns-reqs:
5789

5890
DNS configuration
5991
=================
6092

61-
To ensure network clients can connect to the server, its fully qualified
93+
To ensure network clients can connect to the node, its fully qualified
6294
domain name (FQDN) must resolve to a routable IP address via DNS. Register
6395
the FQDN with DNS record type A for IPv4 addresses and type AAAA for IPv6
6496
addresses.
6597

6698
A correct FQDN and DNS setup is essential for TLS encryption to function
67-
properly. Once connected to the server, network clients verify the TLS
99+
properly. Once connected to the node, network clients verify the TLS
68100
certificate against the given FQDN.
69101

70102
To meet these requirements, follow these steps:
71103

72-
1. **Determine your DNS provider**: Based on your server's purpose, DNS
104+
1. **Determine your DNS provider**: Based on your node's purpose, DNS
73105
can be provided by a public internet service, a private network appliance,
74106
or a combination of both. Review and understand the documentation for
75107
your chosen DNS provider.
76108

77-
2. **Register the FQDN**: Choose the FQDN for your server and register it
78-
in the DNS with the server's public IP address. An FQDN consists of a
79-
hostname prefix (a single word) and a DNS domain suffix. For example,
80-
if the hostname is ``jupiter`` and the domain suffix is ``example.org``,
81-
the resulting FQDN will be ``jupiter.example.org``.
109+
2. **Register the FQDN**: Choose the FQDN for your node and register it in
110+
the DNS with its public IP address. An FQDN consists of a hostname
111+
prefix (a single word) and a DNS domain suffix. For example, if the
112+
hostname is ``jupiter`` and the domain suffix is ``example.org``, the
113+
resulting FQDN will be ``jupiter.example.org``.
82114

83115

84116
.. _worker-node-reqs:

user_domains.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,12 @@ must also be able to resolve AD domain names.
104104
Active Directory DNS server while directing other requests to your
105105
preferred DNS service (ISP or public DNS).
106106

107+
.. note::
108+
109+
Do not configure Samba Active Directory as the NS8 node name resolver in
110+
``/etc/resolv.conf``. For more information, see :ref:`resolv-conf`.
111+
112+
107113
.. _openldap-section:
108114

109115
LDAP server RFC2307
@@ -138,7 +144,7 @@ Then click the :guilabel:`Add provider` button, select the target node and proce
138144

139145
Replicas are configured in master-master mode.
140146

141-
.. warning:: Active Directory provider does not replicate the SysVol volume.
147+
.. note:: Active Directory provider does not replicate the SysVol volume.
142148
Therefore Microsoft's Group Policy Object (GPO) will not be synchronized between replicas.
143149

144150
.. _domain_bind-section:
@@ -418,8 +424,6 @@ The portal is available at the following URL: ::
418424

419425
Where ``<fqdn_node>`` is the FQDN of the node where the provider is and ``<domain_name>`` is the name of the domain provided while configuring the domain.
420426

421-
.. warning:: Without the trailing slash, the portal will not work.
422-
423427
Once reached the page, the user is prompted for login and they can authenticate to the domain with user name and password.
424428

425429
If the login is successful, the user is directed to the ``User Management`` page, where they can proceed to change the password. The password must comply with the domain password policy during this process.

0 commit comments

Comments
 (0)