Skip to content

Commit 638af62

Browse files
Deployed a17fcdd to docs-develop with MkDocs 1.6.0 and mike 1.1.2
1 parent aa84588 commit 638af62

File tree

2 files changed

+66
-68
lines changed

2 files changed

+66
-68
lines changed

docs-develop/gateway-configuration/network-configuration/index.html

Lines changed: 65 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -648,21 +648,6 @@
648648
</span>
649649
</a>
650650

651-
<nav class="md-nav" aria-label="TCP/IP Configuration">
652-
<ul class="md-nav__list">
653-
654-
<li class="md-nav__item">
655-
<a href="#more-details-about-the-not-managed-interface-status-tbd-not-applicable-in-nm" class="md-nav__link">
656-
<span class="md-ellipsis">
657-
More details about the Not Managed interface Status - (TBD: not applicable in NM)
658-
</span>
659-
</a>
660-
661-
</li>
662-
663-
</ul>
664-
</nav>
665-
666651
</li>
667652

668653
<li class="md-nav__item">
@@ -681,6 +666,15 @@
681666
</span>
682667
</a>
683668

669+
</li>
670+
671+
<li class="md-nav__item">
672+
<a href="#ipv6-addressing-modes" class="md-nav__link">
673+
<span class="md-ellipsis">
674+
IPv6 Addressing Modes
675+
</span>
676+
</a>
677+
684678
</li>
685679

686680
<li class="md-nav__item">
@@ -4822,21 +4816,6 @@
48224816
</span>
48234817
</a>
48244818

4825-
<nav class="md-nav" aria-label="TCP/IP Configuration">
4826-
<ul class="md-nav__list">
4827-
4828-
<li class="md-nav__item">
4829-
<a href="#more-details-about-the-not-managed-interface-status-tbd-not-applicable-in-nm" class="md-nav__link">
4830-
<span class="md-ellipsis">
4831-
More details about the Not Managed interface Status - (TBD: not applicable in NM)
4832-
</span>
4833-
</a>
4834-
4835-
</li>
4836-
4837-
</ul>
4838-
</nav>
4839-
48404819
</li>
48414820

48424821
<li class="md-nav__item">
@@ -4855,6 +4834,15 @@
48554834
</span>
48564835
</a>
48574836

4837+
</li>
4838+
4839+
<li class="md-nav__item">
4840+
<a href="#ipv6-addressing-modes" class="md-nav__link">
4841+
<span class="md-ellipsis">
4842+
IPv6 Addressing Modes
4843+
</span>
4844+
</a>
4845+
48584846
</li>
48594847

48604848
<li class="md-nav__item">
@@ -5090,7 +5078,7 @@ <h2 id="tcpip-configuration">TCP/IP Configuration</h2>
50905078
<li>Disabled: disables the selected interface (i.e., administratively down).</li>
50915079
<li>Enabled for LAN: designates the interface for a local network. It can be set as a DHCP server for hosts on the local network and can serve as a default gateway for those hosts; however, it cannot be set as an actual gateway interface for this device. That is, packets must be routed from this interface to another interface that is configured as WAN. The interface is automatically brought up at boot.</li>
50925080
<li>Enabled for WAN: designates the interface as a gateway to an external network. The interface is automatically brought up at boot.</li>
5093-
<li>Not Managed: the interface will be ignored by Kura (available only for <strong>IPv4</strong>).</li>
5081+
<li>Not Managed: the interface will be ignored by Kura. The user can configure the interface with the network tools provided by the OS. This option is available only in the <strong>IPv4</strong> tab and it applies to both <strong>IPv4</strong> and <strong>IPv6</strong>. </li>
50945082
</ul>
50955083
</li>
50965084
<li><strong>WAN Priority</strong> - configure the network failover. See <a href="../network-failover/">here</a> for more details.</li>
@@ -5117,42 +5105,6 @@ <h2 id="tcpip-configuration">TCP/IP Configuration</h2>
51175105
</li>
51185106
</ul>
51195107
<p>If the network interface is configured as <em>Enabled for LAN</em> and manually configured (i.e., not a DHCP client) in the <strong>IPV4</strong> tab, the <strong>DHCPv4 &amp; NAT</strong> tab allows the DHCP server to be configured and/or NAT (IP forwarding with masquerading) to be enabled.</p>
5120-
<h3 id="more-details-about-the-not-managed-interface-status-tbd-not-applicable-in-nm">More details about the Not Managed interface Status - (TBD: not applicable in NM)</h3>
5121-
<p>When a network interface is configured as <strong>Not Managed</strong>, Kura will ignore it and the configuration will not be touched. The user can configure the interface with the network tools provided by the OS, allowing unusual network setups.</p>
5122-
<p>Regarding DNS, both Kura and the external tools store the DNS addresses in the <code>/etc/resolv.conf</code> file. So, if multiple interfaces are configured to get the DNS information and store it in the same file, the device can be misconfigured. To avoid that, the following table presents who is responsible to update the DNS file depending on the network interfaces configurations.</p>
5123-
<table>
5124-
<thead>
5125-
<tr>
5126-
<th>Is there at least an interface set as <code>WAN</code>?</th>
5127-
<th>Is there at least one interface set as <code>Not Managed</code>?</th>
5128-
<th>Does Kura manage resolv.conf?</th>
5129-
</tr>
5130-
</thead>
5131-
<tbody>
5132-
<tr>
5133-
<td>NO</td>
5134-
<td>NO</td>
5135-
<td><strong>YES</strong></td>
5136-
</tr>
5137-
<tr>
5138-
<td>NO</td>
5139-
<td>YES</td>
5140-
<td><strong>NO</strong></td>
5141-
</tr>
5142-
<tr>
5143-
<td>YES</td>
5144-
<td>NO</td>
5145-
<td><strong>YES</strong></td>
5146-
</tr>
5147-
<tr>
5148-
<td>YES</td>
5149-
<td>YES</td>
5150-
<td><strong>YES</strong></td>
5151-
</tr>
5152-
</tbody>
5153-
</table>
5154-
<p>So, the only way to configure the DNS addresses with external tools, is to configure at least one interface as <strong>Not Managed</strong> and not to set any interface as <strong>Enabled For Wan</strong> using Kura. If at least one WAN interface is configured by Kura, it will take the control of the <code>/etc/resolv.conf/</code> file. Finally, if any interface is configured in <strong>Enabled For Wan</strong> or <strong>Not Managed</strong> mode, Kura will empty the file.</p>
5155-
<p>To avoid device misconfigurations when <strong>Not Managed</strong> interfaces are used, <strong>don't</strong> use the <em>dns-nameservers</em> directive in the <code>/etc/network/interfaces</code> file. Please add the DNS addresses directly to the <code>/etc/resolv.conf</code> file.</p>
51565108
<p><img alt="Network Configuration TCP/IP" src="../images/network-configuration-tcpip.png" /></p>
51575109
<h2 id="dhcpv4-nat-configuration">DHCPv4 &amp; NAT Configuration</h2>
51585110
<p>The <strong>DHCPv4 &amp; NAT</strong> tab contains the following configuration parameters:</p>
@@ -5189,6 +5141,52 @@ <h2 id="network-linux-configuration">Network Linux Configuration</h2>
51895141
<p class="admonition-title">Warning</p>
51905142
<p>It is <strong>NOT</strong> recommended performing manual editing of the Linux networking configuration files or manually configuring NetworkManager or ModemManager when the gateway configuration is being managed through Kura. Kura will be notified by NM/MM and it will roll-back the configuration.</p>
51915143
</div>
5144+
<h2 id="ipv6-addressing-modes">IPv6 Addressing Modes</h2>
5145+
<p>When the <strong>Configure</strong> option in the <strong>IPv6</strong> tab is set to <strong>Using DHCPv6</strong>, the network interface obtains its IPv6 address and DNS information from the DHCPv6 server. However, the default gateway is not provided in this mode, even if the interface is marked as <strong>Enabled for WAN</strong>.</p>
5146+
<p>To retrieve the default gateway, set the <strong>Configure</strong> option to <strong>SLAAC</strong>. In this configuration, the default gateway is obtained through Router Advertisements (RA) sent as part of the Neighbor Discovery Protocol (NDP).</p>
5147+
<p>If the interface is configured in <strong>Using DHCPv6</strong> mode, ensure that UDP port 546 is open in the IPv6 firewall so the DHCPv6 client can receive replies.</p>
5148+
<p>It is important to note that the actual behavior also depends on how the router is configured. Router Advertisements include two flags (M (Managed) and O (Other)) which influence whether hosts should use SLAAC, DHCPv6, or a combination of both. The following table summarizes these combinations:</p>
5149+
<table>
5150+
<thead>
5151+
<tr>
5152+
<th>Flags (M/O)</th>
5153+
<th>Address source</th>
5154+
<th>DNS Source</th>
5155+
<th>Default Gateway Source</th>
5156+
<th>Description</th>
5157+
</tr>
5158+
</thead>
5159+
<tbody>
5160+
<tr>
5161+
<td>M=0, O=0</td>
5162+
<td>SLAAC</td>
5163+
<td>RA</td>
5164+
<td>RA</td>
5165+
<td>Pure SLAAC environment. The router provides all required configuration through Router Advertisements. No DHCPv6 services are used.</td>
5166+
</tr>
5167+
<tr>
5168+
<td>M=0, O=1</td>
5169+
<td>SLAAC</td>
5170+
<td>DHCPv6</td>
5171+
<td>RA</td>
5172+
<td>SLAAC for addressing, with DHCPv6 used only for “other” configuration such as DNS. A mixed or “hybrid” setup.</td>
5173+
</tr>
5174+
<tr>
5175+
<td>M=1, O=0</td>
5176+
<td>DHCPv6</td>
5177+
<td>DHCPv6</td>
5178+
<td>RA</td>
5179+
<td>Fully managed IPv6 network. Hosts rely on DHCPv6 for address and configuration details.</td>
5180+
</tr>
5181+
<tr>
5182+
<td>M=1, O=1</td>
5183+
<td>DHCPv6</td>
5184+
<td>DHCPv6</td>
5185+
<td>RA</td>
5186+
<td>Same as M=1/O=0: a stateful, DHCPv6-managed network. Both flags instruct hosts to use DHCPv6 for address assignment and additional configuration.</td>
5187+
</tr>
5188+
</tbody>
5189+
</table>
51925190
<h2 id="network-configuration-properties">Network Configuration properties</h2>
51935191
<p>The Network configuration can be modified using the Kura Gateway Administration Console, as described above, the <a href="doc:configuration-service">Configuration Service</a> or appling a proper <a href="doc:snapshot-management">snapshot</a>.</p>
51945192
<p>The following table describes all the properties related to the Network Configuration. It includes the name of the property, the type, a description and the default value (if applicable). The network configuration pid is <code>org.eclipse.kura.net.admin.NetworkConfigurationService</code>.</p>

docs-develop/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)