Skip to content

数据模型

本页描述核心领域对象,字段以业务语义为主。

Config

配置是 Mesh 的根对象。

字段说明
id配置 ID,形如 cfg_xxx
name配置名称,也会影响生成的接口名。
virtual_subnetMesh 虚拟网段。
default_listen_port新端点默认监听端口。
default_mtu默认 MTU。
default_dns默认 DNS。
auto_sync只影响新建端点的默认自动同步值。
tunnel_protocolwireguardamneziawg_2
awg_s1..awg_s4AmneziaWG 配置级 S 参数。
awg_h1..awg_h4AmneziaWG 配置级 H 参数。

Node

端点代表加入 Mesh 的设备。

字段说明
id端点 ID,形如 node_xxx
config_id所属配置。
name端点名称。
ipv4_address公网 IPv4 或域名。
ipv6_address公网 IPv6 或域名。
listen_port端点监听端口。
virtual_ipMesh 虚拟 IP。
node_typedynamicstatic
auto_sync是否允许自动同步。
pre_up/post_up/pre_down/post_down生命周期命令。
awg_jc/awg_jmin/awg_jmaxAmneziaWG 端点本地扰动参数。
awg_i1..awg_i5AmneziaWG CPS 伪装包参数。

Mesh 对是双向关系中的单向记录。一个双向 Mesh 对由同一个 link_group_id 下的 forward 和 reverse 两条记录组成。

字段说明
local_node_id本端端点。
peer_node_id对端端点。
allowed_ips写入 Peer 的 AllowedIPs。
persistent_keepalivePersistentKeepalive。
preshared_keyPSK,可为空。
endpoint_modeautomanualnone
endpoint_ref_family自动 Endpoint 使用 ipv4ipv6
endpoint_port_mode使用对端监听端口或手动端口。

NodeConfigState

同步态分为:

  • desired:系统根据当前配置生成的目标态。
  • staged:待下发给客户端的同步态。
  • confirmed:客户端确认已应用的状态。

EndpointRuntimeStatus

运行态记录动态端点的在线、隧道和同步状态。

在线判断以服务端运行态为准。离线信号收到后一定离线;否则只要心跳、探测、控制通道等任一在线条件成立即可视为在线。

PortForwardRule

端口转发规则由工具管理。

字段说明
from_node_idFrom 端点,也就是源端点,服务真实存在的位置。
from_portFrom 端口,也就是源端口,服务真实监听的端口。
to_node_idTo 端点,也就是目的端点,承接访问并持有生命周期命令。
to_portTo 端口,也就是目的端口,对外暴露的访问端口。
to_platformlinuxdarwin
protocoltcpudpall