docs

inventory.example.yaml

@@ -44,12 +44,9 @@ rcloud:
     ansible_ssh_user: root
     ansible_python_interpreter: python3
     smartdns:
-      tls_dns:
-        - 8.8.8.8
-        - 8.8.4.4
       https_dns:
-        - cloudflare-dns.com
-        - dns.quad9.net
+        - 9.9.9.9
+        - 149.112.112.112
       china_dns:
         - 114.114.114.114
         - 223.5.5.5
@@ -58,14 +55,14 @@ router_nextgen:
   hosts:
     example-2.com: # 在这里的基本上都是需要改的
       links:
-        - name: eno1 # 物理网卡
+        - name: eno2 # 物理网卡，如果有 bond 就不要设置在这里。
       bonds: # 没有可以删
-        - name: bond0 # bond，一般用mode 4来LACP
+        - name: bond0 # bond，一般用 mode 4 来LACP
           links:
             - eno1
           mode: 4
       vlans: # 没有可以删
-        - link: bond0 # vlan，只需要写link和tag，最后网卡名字会变成 link.tag
+        - link: bond0 # vlan，只需要写 link和 tag，最后网卡名字会变成 link.tag
           tag: 2
         - link: bond0
           tag: 3
@@ -77,21 +74,21 @@ router_nextgen:
         - name: brlan # 名称，必须填写
           links:
             - bond0 # 上行链路，必须填写
-          type: static # dhcp还是static，manual理论上也可以，必须填写
+          type: static # dhcp还是 static，manual 理论上也可以，必须填写
           address: 10.0.0.1/24 # 首选地址
           moreAddresses:
             - 10.0.0.2/24 # 备选地址
           gateways: null # 网关，看下面
-          masq: false # 是否MASQ
-          stp: false # 是否开启STP，默认false
+          masq: false # 是否M ASQ
+          stp: false # 是否开启 STP，默认 false
           macvlan: false # 是不是 macvlan，有时候复用网卡有用
-          linkUp: echo 'link up' # 链路启动脚本，用于奇怪的特殊链路或者netns
+          linkUp: echo 'link up' # 链路启动脚本，用于奇怪的特殊链路或者 netns
           up: echo "up" # 启动脚本和关闭脚本
           down: echo "down"
           linkDown: echo 'link down'
-          mac: null # 自定义mac地址，否则bridge随机，注意dhcp会以原始mac请求dhcp，因此不建议dhcp模式使用
+          mac: null # 自定 mac 地址，否则 bridge 随机，注意 dhcp 会以原始 mac 请求 dhcp，因此不建议 dhcp 模式使用
           dhcpv6Client: false # 是否进行 dhcpv6 请求
-          dhcpv6Receive: true # DHCPv6得到的地址的落脚点，只能有1个LAN获得
+          dhcpv6Receive: true # DHCPv6 得到的地址的落脚点，只能有 1 个 LAN 获得
           mtu: 1500
           dhcp: # 是否开启dhcp，不是的话直接没有这一栏
             start: 10.0.0.100
@@ -108,11 +105,11 @@ router_nextgen:
           address: null
           moreAddresses: null
           masq: true
-          gateways: # 网关定义，DHCP关闭自动获取网关，需要手写地址。
-            - id: 0 # 网关ID，关乎mark和table。该网关的table计算方法为 1100+id
+          gateways: # 网关定义，DHCP 关闭自动获取网关，需要手写地址。
+            - id: 0 # 网关ID，关乎 mark 和table。该网关的 table 计算方法为 1100+id
               address: 10.198.21.1 # 网关地址，填写 _use_first 使用可用地址第一个，填写 _use_last 使用可用地址最后一个
-              mac: null # 网关mac地址，为null则自动ping获取，但是bridge有启动坑容易获取失败
-              noOrigin: false # 是否关闭源进源出，对于专门peer的网关，这个可能很有用。
+              mac: null # 网关 mac 地址，为 null 则自动 ping 获取，但是 bridge 有启动坑容易获取失败
+              noOrigin: false # 是否关闭源进源出，对于专门 peer 的网关，这个可能很有用。
           up: null
           down: null
           mac: null
@@ -120,11 +117,11 @@ router_nextgen:
           dhcpv6Receive: false
           dhcp: null
       ppps: # 没有可以删
-        - id: 0 # ppp id，例如0代表ppp0，该网关的table计算方法为 1000+id
+        - id: 0 # ppp id，例如 0 代表 ppp0，该网关的 table 计算方法为 1000+id
           link: bond0.41 # 上行链路
-          username: user # 拨号用户名，密码在pppoeUsers给出
-          mac: null # 给ISP看的mac地址，null为随机
-          dhcpv6Client: false # 使用这里的DHCPv6，所有ppp只能有1个
+          username: user # 拨号用户名，密码在 pppoeUsers 给出
+          mac: null # 给 ISP 看的 mac 地址，null 为随机
+          dhcpv6Client: false # 使用这里的 DHCPv6，所有 ppp 只能有1个
           restartCron: '0 4 * * *' # 重启 crontab
       pppoeUsers: # PPPoE帐号，没有可以删
         - username: user
@@ -133,12 +130,12 @@ router_nextgen:
         address: 10.0.0.1 # 各内网服务主要监听的地址，必须填写
         ddns: # 没有可以删
           - name: test-ddns
-            email: name@example.com # cf邮箱
-            apiKey: qweqwe # api密钥
-            zone: mycard.moe # ddns主域名
-            subdomain: test # ddns子域名
-            ipv6: false # 是否解析ipv6
-            interface: brwan # 网卡名，可以是null，null则用公网解析结果
+            email: name@example.com # cf 邮箱
+            apiKey: qweqwe # api 密钥
+            zone: mycard.moe # ddns 主域名
+            subdomain: test # ddns 子域名
+            ipv6: false # 是否解析 ipv6
+            interface: brwan # 网卡名，可以是 null，null 则用公网解析结果
   vars: # 这里的都是默认设置，没什么事情可以不改，改的话需要整段抄上去
     ansible_ssh_user: root
     ansible_python_interpreter: python3
@@ -147,7 +144,7 @@ router_nextgen:
       - '192.168.5.0/24' # gzzchh
       - '192.168.123.0/24' # ayane 公司
     smartdns: 
-      disable_ipv6: false # 是否禁用IPv6解析
+      disable_ipv6: false # 是否禁用 IPv6 解析
       tls_dns:
         - 8.8.8.8
         - 1.1.1.1