Skip to content
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

docs: update documentation pages removing old networking and profiles references #5321

Merged
merged 6 commits into from
Jul 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 9 additions & 99 deletions docs/gateway-configuration/cellular-configuration.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Cellular Configuration

If it is not configured, the cellular interface is presented on the interface list either by modem USB address, or if serial modem is used, by modem name. This 'fake' interface name is replaced by 'proper' interface name (e.g., ppp0) when the first modem configuration is submitted.
If it is not configured, the cellular interface is presented on the interface list by modem USB address (i.e. 2-1). This 'fake' interface name is completed by 'proper' interface name (e.g., ppp0) when the first modem configuration is submitted.

The cellular interface should be configured by first enabling it in the **TCP/IP** tab, and then setting the **Cellular** tab. Note that the cellular interface can only be set as _WAN using DHCP_. The cellular interface configuration options are described below.
The cellular interface should be configured by first enabling it in the **IPv4** or **IPv6** tab, and then setting the **Cellular** tab. Note that the cellular interface can only be set as _WAN using DHCP_, _Disabled_ or _Not Managed_ (only for IPv4 connections). The cellular interface configuration options are described below.

## Cellular Configuration

Expand All @@ -13,6 +13,9 @@ The **Cellular** tab contains the following configuration parameters:
- **Network Technology**: describes the network technology used by this modem.
- HSDPA
- EVDO
- EDGE

- **Connection Type**: specifies the type of connection to the modem.

- **Modem Identifier**: provides a unique name for this modem.

Expand Down Expand Up @@ -50,103 +53,10 @@ The **Cellular** tab contains the following configuration parameters:

- **LCP Echo Failure**: sets the _lcp-echo-failure_ option of the PPP daemon. If set to a positive number, the modem presumes the peer to be dead if a specified number of LCP echo-requests are sent without receiving a valid LCP echo-reply. To disable this option, set it to zero.

The **GPS** tab allows the user to enable or disable the GPS module provided by the cellular modem. The property is:

- **Enable GPS**: enables GPS with the following conditions:
- One modem port will be dedicated to NMEA data stream.
- This port may not be used to send AT commands to the modem.
- _PositionService_ should be enabled. Serial settings of _PositionService_ should not be changed; it will be redirected to the modem GPS port automatically.

# Cellular Linux Configuration

This section describes the changes applied by Kura at the Linux networking configuration. Please read the following note before proceeding with manual changes of the Linux networking configuration.

!!! warning
It is **NOT** recommended performing manual editing of the Linux networking configuration files when the gateway configuration is being managed through Kura. While Linux may correctly accept manual changes, Kura may not be able to interpret the new configuration resulting in an inconsistent state.

When the cellular configuration is submitted, Kura generates peer and chat scripts used by the PPP daemon to establish a PPP connection. Examples of these scripts for HSPA and EVDO modems are shown below.

### Example Peer Script for HSPA Modem

```shell
921600
unit 0
logfile /var/log/HE910-D_2-1.5
debug
connect 'chat:v:f /etc/ppp/scripts/chat_HE910-D_2-1.5'
disconnect 'chat:v:f /etc/ppp/scripts/disconnect_HE910-D_2-1.5'
modem
lock
noauth
noipdefault
defaultroute
usepeerdns
noproxyarp
novj
novjccomp
nobsdcomp
nodeflate
nomagic
idle 95
active-filter 'inbound'
persist
holdoff 1
maxfail 5
connect-delay 1000
```

### Example Chat Script for HSPA Modem

```shell
ABORT "BUSY"
ABORT "VOICE"
ABORT "NO CARRIER"
ABORT "NO DIALTONE"
ABORT "NO DIAL TONE"
ABORT "ERROR"
"" "+++ath"
OK "AT"
OK AT+CGDCONT=1,"IP","c1.korem2m.com"
OK "\d\d\d"
"" "atd-99---1#"
CONNECT "\c"
```

### Example Peer Script for EVDO Modem

```shell
921600
unit 0
logfile /var/log/DE910-DUAL_1-1.5
debug
connect 'chat:v:f /etc/ppp/scripts/chat_DE910-DUAL_1-1.5'
disconnect 'chat:v:f /etc/ppp/scripts/disconnect_DE910-DUAL_1-1.5'
crtscts
lock
noauth
defaultroute
usepeerdns
idle 95
active-filter 'inbound'
persist
holdoff 1
maxfail 5
connect-delay 10000
```

## Example Chat Script for EVDO Modem

```shell
ABORT "BUSY"
ABORT "VOICE"
ABORT "NO CARRIER"
ABORT "NO DIALTONE"
ABORT "NO DIAL TONE"
ABORT "ERROR"
"" "+++ath"
OK "AT"
OK "ATE1V1&F&D2&C1&C2S0=0"
OK "ATE1V1"
OK "ATS7=60"
OK "\d\d\d"
"" "atd#777"
CONNECT "\c"
```
- The _PositionService_ should be enabled. Serial settings of the _PositionService_ should not be changed; it will be redirected to the modem GPS port automatically.

6 changes: 3 additions & 3 deletions docs/gateway-configuration/ethernet-configuration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Ethernet Configuration

As described in the Network Configuration section, Ethernet interfaces have two configuration tabs: **TCP/IP** and **DHCP & NAT**. Each Ethernet interface may be configured either as LAN or WAN; it may also be disabled.
As described in the Network Configuration section, Ethernet interfaces have four configuration tabs: **IPv4**, **IPv6**, **DHCPv4 & NAT** and **Advanced**. Each Ethernet interface may be configured either as LAN or WAN; it may also be disabled.

If the interface is designated as LAN and is manually configured, the **DHCP & NAT** tab is enabled to allow DHCP server and/or 'many-to-one' NAT setup; otherwise, the **DHCP & NAT** tab is disabled.
If the interface is designated as LAN in the **IPv4** tab and is manually configured, the **DHCPv4 & NAT** tab is enabled to allow DHCP server and/or 'many-to-one' NAT setup; otherwise, the **DHCPv4 & NAT** tab is disabled.

For more information on **TCP/IP** and **DHCP & NAT** settings, please refer to the [Network Configuration](./network-configuration.md) section.
For more information on **IPv4**, **IPv6** and **DHCPv4 & NAT** settings, please refer to the [Network Configuration](./network-configuration.md) section. For the advanced settings, see the [Advanced Settings](./network-advanced.md) section.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/gateway-configuration/images/wifi-configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions docs/gateway-configuration/network-advanced.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Advanced Network Settings

For devices running Kura installed using a Generic Profile, it is possible to to fine tune network traffic settings. Take a look at our [installer profiles](../getting-started/install-kura.md#installer-types) to know which are supported.

The Advanced configuration tab is designed for users who seek a higher level of control and customization over their network experience. Whether you are an IT professional, network administrator, or enthusiast looking to fine-tune specific aspects of your network, this tab provides access to advanced parameters like Maximum Transmission Unit (MTU) and Promiscuous Mode. Adjusting these settings allows for optimized performance in unique network environments, troubleshooting capabilities, and enhanced security monitoring. Please exercise caution when modifying these settings, ensuring that you have a clear understanding of their implications on your network's behavior.

!!! tip
Expand Down
40 changes: 24 additions & 16 deletions docs/gateway-configuration/network-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,38 @@ In case of typing errors, the **Reset** button can be used to reload the prior c
Since the network configuration shown on the screen may not be synchronized with the current state of the system, it can be updated pressing the **Refresh** button. This can be used also to force the reload of specific parameters like the RSSI or dynamic IP addresses. The refresh procedure reads all the needed parameters from the system and can take several seconds before updating.

!!! tip
It is recommended that the **TCP/IP** tab is configured first since it defines how the interface is going to be used.
It is recommended that the **IPv4** or **IPv6** tab is configured first since it defines how the interface is going to be used.

## TCP/IP Configuration

The **TCP/IP** tab contains the following configuration parameters:
The **IPv4** and **IPv6** tabs contain the following configuration parameters:

- **Status**
- Disabled: disables the selected interface (i.e., administratively down).
- 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.
- Enabled for WAN: designates the interface as a gateway to an external network. The interface is automatically brought up at boot.
- Not Managed: the interface will be ignored by Kura.
- Layer 2 Only: only the Layer 2 portion of the interface will be configured. The interface is automatically brought up at boot.
- Not Managed: the interface will be ignored by Kura (available only for **IPv4**).
- Layer 2 Only: only the Layer 2 portion of the interface will be configured. The interface is automatically brought up at boot (available only for **IPv4**).
- **WAN Priority** - configure the network failover. See [here](network-failover.md) for more details.
- **Configure**
- Manually: allows manual entry of the _IP Address_ and _Netmask_ fields, if the interface is configured as LAN; allows manual entry of the _IP Address_, _Netmask_, _Gateway_, and _DNS Servers_ fields, if the interface is designated as WAN.
- Using DHCP: configures the interface as a DHCP client obtaining the IP address from a network DHCP server.
- Using DHCP/DHCPv6: configures the interface as a DHCP client obtaining the IP address from a network DHCP server.
- Stateless Address Auto-Configuration (SLAAC): automatically assign an IP address (available only for **IPv6**).
- **Address Generation Mode** - defines the method used to automatically generate the IP address with SLAAC (available only for **IPv6**)
- EUI64: use EUI-64 method for address generation
- Stable-privacy: use RFC7217 method for address generation
- **IP Address** - defines the IP address of the interface, if manually configured.
- **Subnet Mask** - defines the subnet mask of the interface, if manually configured.
- **Gateway** - specifies the default gateway for the unit. (Required field if the interface is designated as WAN and manually configured.)
- **DNS Servers** - provides a list of DNS servers, if the interface is designated as WAN and is manually configured.
- **Search Domains** - Not implemented.
- **Privacy** - configure privacy extension for SLAAC (available only for **IPv6**).
- Disabled: disables the privacy extension.
- Prefer public addresses: use public address for outgoing traffic.
- Prefer temporary addresses: prefer temporary address for outgoing traffic.

If the network interface is *Enabled for LAN* and manually configured (i.e., not a DHCP client), the **DHCP & NAT** tab allows the DHCP server to be configured and/or NAT (IP forwarding with masquerading) to be enabled.
If the network interface is configured as *Enabled for LAN* and manually configured (i.e., not a DHCP client) in the **IPV4** tab, the **DHCPv4 & NAT** tab allows the DHCP server to be configured and/or NAT (IP forwarding with masquerading) to be enabled.

### More details about the Not Managed interface Status
### More details about the Not Managed interface Status - (TBD: not applicable in NM)

When a network interface is configured as **Not Managed**, 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.

Expand All @@ -48,23 +56,23 @@ To avoid device misconfigurations when **Not Managed** interfaces are used, **do

![Network Configuration TCP/IP](./images/network-configuration-tcpip.png)

## DHCP & NAT Configuration
## DHCPv4 & NAT Configuration

The **DHCP & NAT** tab contains the following configuration parameters:
The **DHCPv4 & NAT** tab contains the following configuration parameters:

- **Router Mode**
- DHCP and NAT: indicates that both DHCP server and NAT are enabled.
- DHCP Only: indicates that DHCP server is enabled and NAT is disabled.
- NAT Only: indicates that NAT is enabled and DHCP server is disabled.
- Off: indicates that both DHCP server and NAT are disabled.
- DHCP and NAT: indicates that both DHCP server and NAT are enabled.
- DHCP Only: indicates that DHCP server is enabled and NAT is disabled.
- NAT Only: indicates that NAT is enabled and DHCP server is disabled.
- Off: indicates that both DHCP server and NAT are disabled.
- **DHCP Beginning Address**: specifies the first address of DHCP pool (i.e., first available client IP address).
- **DHCP Ending Address**: specifies the last address of DHCP pool (i.e., last IP address that can be assigned to a client).
- **DHCP Subnet Mask**: defines the subnet mask that is assigned to a client.
- **DHCP Default Lease Time**: sets the default time (in minutes) that the client retains the provided IP address. It must be greater than 0.
- **DHCP Max Lease Time**: sets the maximum time (in minutes) that the client retains the provided IP address. It must be greater than 0.
- **Pass DNS Servers through DHCP**: enables DNS Proxy (i.e., passing DNS servers through DHCP).

If NAT is enabled and there is another interface designated as WAN (e.g., ppp0), the following iptables rules are added to the *custom automatic NAT service rules*_* section of the `/etc/init.d/firewall` script:
If NAT is enabled and there is another interface designated as WAN (e.g., ppp0), the following iptables rules are added to the *custom automatic NAT service rules* section of the `/etc/init.d/firewall` script:

```shell
# custom automatic NAT service rules (if NAT option is enabled for LAN interface)
Expand All @@ -80,7 +88,7 @@ Also, IP forwarding is enabled in the kernel as follows:
echo 1 > /proc/sys/net/ipv4/ip_forward
```

The rules shown above create an *Overloaded*_* (i.e., many-to-one) NAT. This type of network address translation maps multiple IP addresses on the LAN side to a single IP address on the WAN side, allowing internet access from hosts on a local network via a gateway (WAN) interface. Note that for NAT rules to be added, it is insufficient to enable NATing through the **DHCP & NAT** tab of the LAN interface; there must also be another interface designated as WAN.
The rules shown above create an *Overloaded* (i.e., many-to-one) NAT. This type of network address translation maps multiple IP addresses on the LAN side to a single IP address on the WAN side, allowing internet access from hosts on a local network via a gateway (WAN) interface. Note that for NAT rules to be added, it is insufficient to enable NATing through the **DHCPv4 & NAT** tab of the LAN interface; there must also be another interface designated as WAN.

![Network Configuration DHCP and NAT](./images/network-configuration-dhcp-nat.png)

Expand Down
2 changes: 0 additions & 2 deletions docs/gateway-configuration/vlan-configuration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# VLAN Configuration

For devices running Kura installed using a Generic Profile, it is possible to configure multiple VLAN interfaces. Take a look at our [installer profiles](../getting-started/install-kura.md#installer-types) to know which are supported.

A VLAN, or Virtual Local Area Network, is a network segmentation technology that allows a single physical network to be logically divided into multiple isolated networks. These virtual networks operate as if they are independent, even though they share the same physical infrastructure.
This is achieved via a VLAN ID, or VLAN tag, a numerical label added to network frames to identify the specific Virtual Local Area Network (VLAN) to which they belong. It's a critical component in VLAN technology, allowing network switches and routers to differentiate and route traffic within a VLAN. VLAN tags are added to the Ethernet frame's header, indicating which virtual network a data packet should be directed to when it traverses the physical network infrastructure. Therefore, VLANs must also be supported and configured on the network equipment a device is connected to.

Expand Down
2 changes: 1 addition & 1 deletion docs/gateway-configuration/wifi-configuration-8021x.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Wi-Fi 802.1x Configuration
Enterprise Wi-Fi is currently only supported on gateways running our [generic profiles](../getting-started/install-kura.md#installer-types). The following is a list of currently supported 802.1x authentication methods.
To enable the Enterprise Wi-Fi, the **Wireless Security** property in the **Wireless** tab has to be set to _WPA2/WPA3-Enterprise_. This feature is available only if the _Wireless Mode_ is _Station Mode_. The following is a list of currently supported 802.1x authentication methods.

- [TTLS-MSCHAPv2](#ttls-mschapv2)
- [PEAP-MSCHAPv2](#peap-mschapv2)
Expand Down
Loading
Loading