Merge pull request #809 from 916BGAI/main

update nanocluster docs
This commit is contained in:
Caize Wu
2025-05-16 14:15:10 +08:00
committed by GitHub
7 changed files with 258 additions and 200 deletions

View File

@@ -0,0 +1,105 @@
---
title: Switch Management
---
## Introduction
NanoCluster is equipped with the JL6108 Gigabit switch chip, which is based on the **RISC-V** architecture. It can be used as a plug-and-play switch or as a locally managed Layer 2 switch, supporting configuration via a web interface. Its main features include:
- **System Management**: Displays system information, supports reboot, factory reset, and firmware upgrades
- **Network Configuration**: Supports static IP and DHCP dynamic IP configuration
- **Port Management**: Enables/disables ports, configures link speed, and manages flow control
- **Port Aggregation**: Supports port binding to increase bandwidth utilization
- **Security and Isolation**: Port isolation to prevent data leakage
- **Traffic Monitoring**: Port MIB statistics and traffic analysis
- **Loop Protection**: Prevents network loops to enhance stability
- **VLAN Configuration**: Supports MTU VLAN, port-based VLAN, 802.1Q VLAN, and PVID settings
- **QoS Configuration**: Manages traffic priority based on port, PCP, and DSCP
- **Bandwidth and Storm Control**: Supports port-based bandwidth limitation and broadcast storm suppression
## Port Allocation
The cluster backplane connects to each core board (SOM) via the JL6108 switch. The port allocation is as follows:
| Switch Port | Connected Device |
|------------|--------------------------------------|
| Port 1 | Slot 7 |
| Port 2 | Slot 6 |
| Port 3 | Slot 5 |
| Port 4 | Slot 4 |
| Port 5 | Slot 3 |
| Port 6 | Slot 2 |
| Port 7 | Slot 1 |
| Port 8 | Cluster backplane RJ45 port (for external network connection) |
## User Guide
### Logging into the Web Management Interface
1. **Ensure Device Connection**
Make sure the NanoCluster is powered on and connected to the management host via an Ethernet cable.
2. **Configure IP Address**
The switch's default IP address is **10.10.11.10/24**. Ensure the management host has an IP in the same subnet, e.g., **10.10.11.x** (where x is between 1-254 but not 10), with a subnet mask of **255.255.255.0**.
![IP Configuration](../../../zh/cluster/NanoCluster/assets/ip.jpeg)
3. **Access the Management Interface**
Open a browser and enter `http://10.10.11.10`, then press Enter to reach the login page.
![Login Page](../../../zh/cluster/NanoCluster/assets/login_en.jpeg)
4. **Login to the Management System**
Enter the **admin username and password** (both default to `admin`), then click **Login** to access the main interface.
![Management Homepage](../../../zh/cluster/NanoCluster/assets/homepage_en.jpeg)
## Basic Configuration
### Port Management
The JL6108 switch provides port status management, supporting **port enable/disable**, **speed configuration**, and **flow control**.
- **Enable/Disable Ports**: Navigate to the **Port Management** page, select the desired port, and enable or disable it.
- **Modify Port Speed**: Supports 10Mbps / 100Mbps / 1000Mbps modes.
- **Flow Control**: Can be enabled to prevent packet loss.
![Port Management](../../../zh/cluster/NanoCluster/assets/portsetting_en.jpeg)
### VLAN Configuration
VLAN (Virtual Local Area Network) is used to segment different network areas, prevent broadcast storms, and enhance security.
#### Configuring Port VLAN
1. **Access the Port VLAN Page**
Navigate to `VLAN` >> `Port VLAN` in the Web interface.
2. **Enable Port VLAN**
Check the **"Enable Port VLAN"** option and click **`Apply`**.
3. **Create VLAN 2 and Assign Ports**
- Enter **`2`** in the **VLAN ID** field
- Select **Ports 2 to 4**
- Click **`Apply`** to save the configuration
4. **View the Port Member Table**
After configuration, **Ports 2-4 will be automatically removed from VLAN 1** and assigned to VLAN 2.
![Port VLAN Configuration](../../../zh/cluster/NanoCluster/assets/vlan_en.jpeg)
### QoS Configuration (Traffic Prioritization)
QoS ensures stable performance for high-priority traffic such as video conferencing and VoIP:
1. **Navigate to "QoS Settings"**
2. Select **Port-Based / 802.1P / DSCP** QoS strategy
3. Set **High / Medium / Low Priority Queues**
4. **Save the settings** to apply the QoS rules
![QoS Configuration](../../../zh/cluster/NanoCluster/assets/qos_en.jpeg)
## Additional Configuration
The JL6108 switch also supports more advanced features. For detailed configuration instructions, please refer to the official manual.
[Click here to view the full manual](https://dl.sipeed.com/shareURL/Cluster/NanoCluster/06_Switch_JL6108)
We provide the **JL6108 SDK** based on the **RISC-V** architecture. Users can download the SDK and develop independently from the following link:
[JL6108 SDK](https://dl.sipeed.com/shareURL/Cluster/NanoCluster/06_Switch_JL6108)

View File

@@ -157,6 +157,8 @@ If you need to debug or control multiple slots simultaneously, we recommend usin
![uart_board](../../../zh/cluster/NanoCluster/assets/uart.jpeg)
> ⚠️ Due to the serial port expansion module partially obstructing the airflow and the module itself supporting only 4 serial ports, it is recommended to insert only 4 to 5 SOMs when using this module to ensure system cooling and debugging stability.
## Power Control
The reset pins for slots 1~7 are controlled by slot 1 through **I2C extended IO**, enabling remote power on/off functionality.
@@ -187,7 +189,21 @@ sudo gpioset gpiochip2 2=0 && sudo gpioset gpiochip2 2=1
**CM4/CM5 Control Method Example:**
todo。
To enable I2C and load the PCA9557 driver on CM4 or CM5, you can control it in the same way:
Edit `/boot/firmware/config.txt` and add the following content:
``` txt
dtparam=i2c_arm=on
dtoverlay=pca953x,addr=0x18,pca9557
```
After saving and rebooting, you can control the slot reset using the `gpioset` method.
> - **CM4** corresponds to GPIO controller index: `gpiochip2`
> - **CM5** corresponds to GPIO controller index: `gpiochip14`
The control method is the same as for LM3H, but you only need to replace `gpiochip` with the actual index corresponding to the platform.
## Fan Speed Adjustment
@@ -213,7 +229,7 @@ echo enabled | sudo tee /sys/class/thermal/thermal_zone2/mode
### CM4 Fan Control
Add the following line to /boot/config.txt:
Add the following line to /boot/firmware/config.txt:
```bash
dtoverlay=pwm-2chan,pin=12,func=4,pin2=13,func2=4
@@ -255,109 +271,15 @@ pwm.start(0) # Off
pwm.start(100) # Full speed
```
## Switch Management
## Thermal Management
### Introduction
1. It is recommended to place the device in a well-ventilated environment with a temperature below **30°C** to reduce the overall thermal load.
NanoCluster is equipped with the JL6108 Gigabit switch chip, which is based on the **RISC-V** architecture. It can be used as a plug-and-play switch or as a locally managed Layer 2 switch, supporting configuration via a web interface. Its main features include:
2. For optimal performance, maintain the system's continuous operating power below **50W**, with peak power not exceeding **60W**, to match the power supply capacity and thermal performance.
- **System Management**: Displays system information, supports reboot, factory reset, and firmware upgrades
- **Network Configuration**: Supports static IP and DHCP dynamic IP configuration
- **Port Management**: Enables/disables ports, configures link speed, and manages flow control
- **Port Aggregation**: Supports port binding to increase bandwidth utilization
- **Security and Isolation**: Port isolation to prevent data leakage
- **Traffic Monitoring**: Port MIB statistics and traffic analysis
- **Loop Protection**: Prevents network loops to enhance stability
- **VLAN Configuration**: Supports MTU VLAN, port-based VLAN, 802.1Q VLAN, and PVID settings
- **QoS Configuration**: Manages traffic priority based on port, PCP, and DSCP
- **Bandwidth and Storm Control**: Supports port-based bandwidth limitation and broadcast storm suppression
3. If no SSD is installed, the system's space and cooling capacity can support **up to 7 SOMs running simultaneously**. If SSDs are installed, to ensure proper airflow, it is recommended to **install SOMs with spacing, supporting up to 4 SOMs**.
### Port Allocation
The cluster backplane connects to each core board (SOM) via the JL6108 switch. The port allocation is as follows:
| Switch Port | Connected Device |
|------------|--------------------------------------|
| Port 1 | Slot 7 |
| Port 2 | Slot 6 |
| Port 3 | Slot 5 |
| Port 4 | Slot 4 |
| Port 5 | Slot 3 |
| Port 6 | Slot 2 |
| Port 7 | Slot 1 |
| Port 8 | Cluster backplane RJ45 port (for external network connection) |
### User Guide
#### Logging into the Web Management Interface
1. **Ensure Device Connection**
Make sure the NanoCluster is powered on and connected to the management host via an Ethernet cable.
2. **Configure IP Address**
The switch's default IP address is **10.10.11.10/24**. Ensure the management host has an IP in the same subnet, e.g., **10.10.11.x** (where x is between 1-254 but not 10), with a subnet mask of **255.255.255.0**.
![IP Configuration](../../../zh/cluster/NanoCluster/assets/ip.jpeg)
3. **Access the Management Interface**
Open a browser and enter `http://10.10.11.10`, then press Enter to reach the login page.
![Login Page](../../../zh/cluster/NanoCluster/assets/login_en.jpeg)
4. **Login to the Management System**
Enter the **admin username and password** (both default to `admin`), then click **Login** to access the main interface.
![Management Homepage](../../../zh/cluster/NanoCluster/assets/homepage_en.jpeg)
### Basic Configuration
#### Port Management
The JL6108 switch provides port status management, supporting **port enable/disable**, **speed configuration**, and **flow control**.
- **Enable/Disable Ports**: Navigate to the **Port Management** page, select the desired port, and enable or disable it.
- **Modify Port Speed**: Supports 10Mbps / 100Mbps / 1000Mbps modes.
- **Flow Control**: Can be enabled to prevent packet loss.
![Port Management](../../../zh/cluster/NanoCluster/assets/portsetting_en.jpeg)
#### VLAN Configuration
VLAN (Virtual Local Area Network) is used to segment different network areas, prevent broadcast storms, and enhance security.
##### Configuring Port VLAN
1. **Access the Port VLAN Page**
Navigate to `VLAN` >> `Port VLAN` in the Web interface.
2. **Enable Port VLAN**
Check the **"Enable Port VLAN"** option and click **`Apply`**.
3. **Create VLAN 2 and Assign Ports**
- Enter **`2`** in the **VLAN ID** field
- Select **Ports 2 to 4**
- Click **`Apply`** to save the configuration
4. **View the Port Member Table**
After configuration, **Ports 2-4 will be automatically removed from VLAN 1** and assigned to VLAN 2.
![Port VLAN Configuration](../../../zh/cluster/NanoCluster/assets/vlan_en.jpeg)
#### QoS Configuration (Traffic Prioritization)
QoS ensures stable performance for high-priority traffic such as video conferencing and VoIP:
1. **Navigate to "QoS Settings"**
2. Select **Port-Based / 802.1P / DSCP** QoS strategy
3. Set **High / Medium / Low Priority Queues**
4. **Save the settings** to apply the QoS rules
![QoS Configuration](../../../zh/cluster/NanoCluster/assets/qos_en.jpeg)
### Additional Configuration
The JL6108 switch also supports more advanced features. For detailed configuration instructions, please refer to the official manual.
[Click here to view the full manual](https://dl.sipeed.com/shareURL/Cluster/NanoCluster/06_Switch_JL6108)
We provide the **JL6108 SDK** based on the **RISC-V** architecture. Users can download the SDK and develop independently from the following link:
[JL6108 SDK](https://dl.sipeed.com/shareURL/Cluster/NanoCluster/06_Switch_JL6108)
4. Slot 7 is located at the edge of the chassis, where fan airflow is lower but there is sufficient space to install a heatsink. It is recommended to install a larger heatsink in this position to enhance cooling efficiency.
## FAQ (Troubleshooting)

View File

@@ -512,6 +512,8 @@ items:
file: cluster/NanoCluster/k3s.md
- label: distcc Deployment
file: cluster/NanoCluster/distcc.md
- label: Switch Management
file: cluster/NanoCluster/switch.md
# - label: Maix Audio
# items:
# - label: MA USB 16

Binary file not shown.

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 35 KiB

View File

@@ -0,0 +1,103 @@
---
title: 交换机管理
---
## 简介
NanoCluster 搭载 JL6108 千兆交换机芯片,该芯片基于 **RISC-V** 架构,既可作为即插即用的傻瓜交换机使用,也可作为可本地管理的二层交换机,支持通过 Web 进行配置。主要功能包括:
- **系统管理**:显示系统信息、支持重启、恢复出厂设置、固件升级
- **网络配置**:支持静态 IP 和 DHCP 动态 IP 配置
- **端口管理**:端口启用/禁用、链路速率设置、流控管理
- **端口汇聚**:支持端口绑定,提高带宽利用率
- **安全与隔离**:端口隔离、防止数据泄露
- **流量监控**:端口 MIB 统计、流量分析
- **环路保护**:防止网络环路,提升网络稳定性
- **VLAN 配置**:支持 MTU VLAN、基于端口的 VLAN、802.1Q VLAN、PVID 设置
- **QoS 配置**基于端口、PCP、DSCP 进行流量优先级管理
- **带宽与风暴控制**:支持基于端口的带宽限制与广播风暴抑制
## 端口分配
集群底板通过 JL6108 交换机连接各个核心板SOM端口分配如下
| 交换机端口 | 连接设备 |
|------------|--------------------------------------|
| Port 1 | Slot 7 |
| Port 2 | Slot 6 |
| Port 3 | Slot 5 |
| Port 4 | Slot 4 |
| Port 5 | Slot 3 |
| Port 6 | Slot 2 |
| Port 7 | Slot 1 |
| Port 8 | 集群底板 RJ45 接口(用于连接外部网络) |
## 使用教程
1. **确保设备连接**
确保 NanoCluster 已上电,并通过网线将板载网口与管理主机相连。
2. **配置 IP 地址**
交换机的默认 IP 地址为 **10.10.11.10/24**,请确保管理主机的 IP 地址与其处于同一网段,例如 **10.10.11.x**x 取值范围1-254且不能为 10子网掩码设为 **255.255.255.0**
![IP 配置](./assets/ip.jpeg)
3. **访问管理界面**
在浏览器地址栏输入 `http://10.10.11.10` 并回车,即可进入交换机的登录界面。
![登录界面](./assets/login.jpeg)
4. **登录管理系统**
在登录界面输入 **管理员账号和密码**(默认均为 `admin`),然后点击 **登录**,进入交换机管理界面首页。
![管理系统首页](./assets/homepage.jpeg)
## 基本配置
### 端口管理
JL6108 交换机提供端口状态管理功能,支持 **端口启用/禁用**、**速率设置**、**流控管理**。
- **启用/禁用端口**:可在 **端口管理** 页面找到目标端口,选择“启用”或“禁用”
- **修改端口速率**:支持 10Mbps / 100Mbps / 1000Mbps 三种模式
- **流控**:可开启端口流控,防止数据丢失
![端口管理](./assets/portsetting.jpeg)
### VLAN 配置
VLAN虚拟局域网用于划分不同的网络区域防止广播风暴提高网络安全性。
#### 配置端口 VLAN
1. **进入端口 VLAN 界面**
在 Web 管理界面,依次进入:`VLAN` >> `端口 VLAN`,进入 VLAN 配置页面。
2. **启用端口 VLAN 功能**
勾选 **“端口 VLAN 使能”** 选项,并点击 **`应用`** 按钮。
3. **创建 VLAN 2 并配置端口成员**
-**VLAN ID** 输入框中输入 **`2`**
- 勾选 **端口 2 ~ 4**
- 点击 **`应用`** 按钮以保存配置
4. **查看端口成员表**
配置完成后,**端口 2 ~ 4 将自动从 VLAN 1 中移除**,并加入 VLAN 2。
![端口 VLAN 配置示例](./assets/vlan.jpeg)
### QoS 配置(流量优先级)
QoS 用于保障高优先级流量如视频会议、VoIP的稳定性
1. **进入“QoS 设置”**
2. 选择 **基于端口/802.1P/DSCP** 的 QoS 策略
3. 设置 **高/中/低优先级队列**
4. **保存设置**QoS 规则生效
![QoS 配置](./assets/qos.jpeg)
## 更多配置
JL6108 交换机还支持更多高级功能,详细配置说明,请参考官方手册。
[点击此处查看完整手册](https://dl.sipeed.com/shareURL/Cluster/NanoCluster/06_Switch_JL6108)
我们提供基于 **RISC-V** 架构的 **JL6108 SDK**,用户可以从以下链接下载 SDK 并进行自主开发。
[JL6108 SDK](https://dl.sipeed.com/shareURL/Cluster/NanoCluster/06_Switch_JL6108)

View File

@@ -155,6 +155,8 @@ ssh sipeed@lpi3h-xxxx.local
![串口小板](./assets/uart.jpeg)
> ⚠️ 由于串口扩展模块会部分遮挡风道,且模块本身仅支持 4 路串口,建议在使用该模块时,仅插入 45 个 SOM以保证系统散热与调试稳定性。
## 电源控制
slot1~7 的复位脚由 slot1 通过 **I2C 扩展的 IO** 进行控制,可实现远程开关机。
@@ -185,7 +187,21 @@ sudo gpioset gpiochip2 2=0 && sudo gpioset gpiochip2 2=1
**CM4/CM5 控制方法示例:**
todo。
在 CM4 或 CM5 上启用 I2C 并加载 PCA9557 驱动,即可使用相同方式控制:
编辑 /boot/firmware/config.txt添加以下内容
``` txt
dtparam=i2c_arm=on
dtoverlay=pca953x,addr=0x18,pca9557
```
保存并重启后,即可通过 gpioset 方法控制 slot 的复位。
> - **CM4** 对应的 GPIO 控制器编号为:`gpiochip2`
> - **CM5** 对应的 GPIO 控制器编号为:`gpiochip14`
控制方法与 LM3H 相同,只需将 gpiochip 替换为实际平台对应的编号。
## 风扇调速
@@ -211,7 +227,7 @@ echo enabled | sudo tee /sys/class/thermal/thermal_zone2/mode
### CM4 调速
将以下内容添加到 /boot/config.txt:
将以下内容添加到 /boot/firmware/config.txt:
```bash
dtoverlay=pwm-2chan,pin=12,func=4,pin2=13,func2=4
@@ -253,107 +269,15 @@ pwm.start(0) # 不转
pwm.start(100) # 满速
```
## 交换机管理
## 散热控制
### 简介
1. 建议将整机放置在通风良好、温度低于 **30 摄氏度** 的环境中,以减轻整体散热负担。
NanoCluster 搭载 JL6108 千兆交换机芯片,该芯片基于 **RISC-V** 架构,既可作为即插即用的傻瓜交换机使用,也可作为可本地管理的二层交换机,支持通过 Web 进行配置。主要功能包括:
2. 推荐整机持续工作功率控制在 **50W 以内**,峰值功率不超过 **60W**,以匹配电源输出能力与系统散热性能。
- **系统管理**:显示系统信息、支持重启、恢复出厂设置、固件升级
- **网络配置**:支持静态 IP 和 DHCP 动态 IP 配置
- **端口管理**:端口启用/禁用、链路速率设置、流控管理
- **端口汇聚**:支持端口绑定,提高带宽利用率
- **安全与隔离**:端口隔离、防止数据泄露
- **流量监控**:端口 MIB 统计、流量分析
- **环路保护**:防止网络环路,提升网络稳定性
- **VLAN 配置**:支持 MTU VLAN、基于端口的 VLAN、802.1Q VLAN、PVID 设置
- **QoS 配置**基于端口、PCP、DSCP 进行流量优先级管理
- **带宽与风暴控制**:支持基于端口的带宽限制与广播风暴抑制
3. 若未安装 SSD整机空间与散热能力可支持 **最多 7 个 SOM 同时运行**。若安装 SSD为确保良好的散热风道建议 **间隔安装 SOM最多 4 个**。
### 端口分配
集群底板通过 JL6108 交换机连接各个核心板SOM端口分配如下
| 交换机端口 | 连接设备 |
|------------|--------------------------------------|
| Port 1 | Slot 7 |
| Port 2 | Slot 6 |
| Port 3 | Slot 5 |
| Port 4 | Slot 4 |
| Port 5 | Slot 3 |
| Port 6 | Slot 2 |
| Port 7 | Slot 1 |
| Port 8 | 集群底板 RJ45 接口(用于连接外部网络) |
### 使用教程
1. **确保设备连接**
确保 NanoCluster 已上电,并通过网线将板载网口与管理主机相连。
2. **配置 IP 地址**
交换机的默认 IP 地址为 **10.10.11.10/24**,请确保管理主机的 IP 地址与其处于同一网段,例如 **10.10.11.x**x 取值范围1-254且不能为 10子网掩码设为 **255.255.255.0**。
![IP 配置](./assets/ip.jpeg)
3. **访问管理界面**
在浏览器地址栏输入 `http://10.10.11.10` 并回车,即可进入交换机的登录界面。
![登录界面](./assets/login.jpeg)
4. **登录管理系统**
在登录界面输入 **管理员账号和密码**(默认均为 `admin`),然后点击 **登录**,进入交换机管理界面首页。
![管理系统首页](./assets/homepage.jpeg)
### 基本配置
#### 端口管理
JL6108 交换机提供端口状态管理功能,支持 **端口启用/禁用**、**速率设置**、**流控管理**。
- **启用/禁用端口**:可在 **端口管理** 页面找到目标端口,选择“启用”或“禁用”
- **修改端口速率**:支持 10Mbps / 100Mbps / 1000Mbps 三种模式
- **流控**:可开启端口流控,防止数据丢失
![端口管理](./assets/portsetting.jpeg)
#### VLAN 配置
VLAN虚拟局域网用于划分不同的网络区域防止广播风暴提高网络安全性。
##### 配置端口 VLAN
1. **进入端口 VLAN 界面**
在 Web 管理界面,依次进入:`VLAN` >> `端口 VLAN`,进入 VLAN 配置页面。
2. **启用端口 VLAN 功能**
勾选 **“端口 VLAN 使能”** 选项,并点击 **`应用`** 按钮。
3. **创建 VLAN 2 并配置端口成员**
- 在 **VLAN ID** 输入框中输入 **`2`**
- 勾选 **端口 2 ~ 4**
- 点击 **`应用`** 按钮以保存配置
4. **查看端口成员表**
配置完成后,**端口 2 ~ 4 将自动从 VLAN 1 中移除**,并加入 VLAN 2。
![端口 VLAN 配置示例](./assets/vlan.jpeg)
#### QoS 配置(流量优先级)
QoS 用于保障高优先级流量如视频会议、VoIP的稳定性
1. **进入“QoS 设置”**
2. 选择 **基于端口/802.1P/DSCP** 的 QoS 策略
3. 设置 **高/中/低优先级队列**
4. **保存设置**QoS 规则生效
![QoS 配置](./assets/qos.jpeg)
### 更多配置
JL6108 交换机还支持更多高级功能,详细配置说明,请参考官方手册。
[点击此处查看完整手册](https://dl.sipeed.com/shareURL/Cluster/NanoCluster/06_Switch_JL6108)
我们提供基于 **RISC-V** 架构的 **JL6108 SDK**,用户可以从以下链接下载 SDK 并进行自主开发。
[JL6108 SDK](https://dl.sipeed.com/shareURL/Cluster/NanoCluster/06_Switch_JL6108)
4. Slot7 处于机壳边缘,风扇风量较小,但具备充足的空间安装散热片。建议为该位置安装较大的散热片以增强散热效果。
## 常见问题排查FAQ

View File

@@ -523,6 +523,8 @@ items:
file: cluster/NanoCluster/k3s.md
- label: distcc 部署
file: cluster/NanoCluster/distcc.md
- label: 交换机管理
file: cluster/NanoCluster/switch.md
# - label: Maix Audio
# items:
# - label: MA USB 16