Skip to content

Commit

Permalink
Merge pull request #281 from filecoin-project/fatman13-patch2
Browse files Browse the repository at this point in the history
nv15 upgrade doc
  • Loading branch information
Joss-Hua authored Feb 23, 2022
2 parents 2a99c78 + 15c606c commit b383a42
Show file tree
Hide file tree
Showing 3 changed files with 221 additions and 103 deletions.
2 changes: 2 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ module.exports = {
['Efficiency_of_sealing.md', 'Finding optimal configurations'],
['System_monitor_of_Zabbix.md', 'System monitoring (Zabbix)'],
['lotus-vs-venus.md', 'Coming from Lotus'],
['Nv15_upgrade_guide.md', 'nv15 upgrade'],
]
}
],
Expand Down Expand Up @@ -273,6 +274,7 @@ module.exports = {
['Efficiency_of_sealing.md', '最大化利用资源提升密封扇区效率'],
['System_monitor_of_Zabbix.md', '系统监控安装与使用之Zabbix'],
['lotus-vs-venus.md', '从Lotus中来'],
['Nv15_upgrade_guide.md', 'nv15网络升级'],
]
}
],
Expand Down
219 changes: 116 additions & 103 deletions docs/operation/Nv15_upgrade_guide.md
Original file line number Diff line number Diff line change
@@ -1,103 +1,116 @@
# nv15升级指南

## 版本信息


1. venus-wallet
2. venus
3. lotus兼容版本
4. chain-co
5. messager
6. venus-gateway
7. venus-miner
8. venus-market
9. venus-sealer


## 升级细节
1. venus-auth: 可选择升级
分支: v1.3.2
影响功能: 无
2. venus: 升级
分支:v1.2.0
影响功能:支持新网络版本
注意事项:
1. 升级后检查vk文件是否完整
2. 升级后检查配置文件,升级高度是否正常设置:
```
# cali
"upgradeOhSnapHeight": 682006
# mainnet
"upgradeOhSnapHeight": 1594680
```
3. 升级后检查mpool下maxfee配置是否由数字转换成xxFil形式
```
"mpool": {
"maxNonceGap": 100,
"maxFee": "10 FIL"
},
```
4. 升级后需检查是否正常同步区块
5. api版本发生变化,影响sealer的连接,升级方式需要按照大升级的方式来处理

3. lotus兼容版本: 升级
分支: venus/v1.14.0
影响功能: 支持新网络版本
注意事项:
1. 检查是否正常同步
2. 检查和venus-auth的连接是否完好(curl 命令验证)

4. chain-co: 升级
分支:v0.1.0
注意事项:
影响功能:
1. 暴露新的接口MpoolPending/MpoolGetNonce
2. 升级后检查两个接口是否存在,且能正常工作

5. venus-messager: 升级
分支:v1.4.0
影响功能: 仅支持新的网络版本
注意事项: 无

6. venus-miner: 升级
Tag: v1.4.0
影响功能:
1. 计算证明的接口(ComputeProof)参数发生变化
注意事项:无

7. venus-gateway: 升级
分支:v1.2.0
影响功能:
1. ComputeProof接口参数发生变化,
2. 需同时支持新老两组接口
注意事项:
1. 升级后需检查是否v0/v1两组接口都在正常工作

8. venus-wallet: 可选择升级
Tag:v1.4.0
影响功能:无

9. venus-market: 可选择升级
分支: v2.0.0
影响功能 新版本
## 升级顺序

1. venus-wallet Tag:v1.4.0
2. venus v1.2.0
3. lotus for venuspool venus/v1.14.0
4. chain-co v0.1.0
5. venus-messager v1.4.0
6. venus-gateway v1.2.0
7. venus-miner Tag:v1.4.0
8. venus-market v2.0.0
9. venus-sealer v1.4.0

## 升级建议

1. 对于还有证明空窗期的用户, 选择一个安全的时间来升级。
2. 对于已经不具备空窗期的用户,最好的办法是在建立一个环境来进行过度。
3. 建议运行一个备用的兼容版本lotus用于备份。



有任何关于升级的问题可以到disscusion讨论: https://github.com/filecoin-project/venus/discussions/4688
## Upgrading to network version 15

Please upgrade each venus component in the order as it is presented in this document. We recommend that you go through the document before upgrading. When in doubt, please do not hesitate to reach out to us [here](https://github.com/filecoin-project/venus/discussions/4688).

:::warning

Please make sure that your storage system is not doing any windowPost when you upgrade and leave ample time before the next upcoming windowPost

:::

:::tip

If you have partitions in all deadlines, it is recommended that you build another transition environment for the upgrade.

:::

:::tip

It is recommended that you backup your old binary and critical data as you go through the upgrade process.

:::

:::tip

For large scale storage systems, it is recommended that running chain-co with both venus daemon and venus wrapped daemon.

:::

1. venus-auth: `optional` upgrade; branch/tag `v1.3.2`;

2. venus-wallet: `optional` upgrade; branch/tag `v1.4.0`;

3. venus daemon: `mandatory` upgrade; branch/tag `v1.2.0`;

:::tip

Checkups after upgrading:

- integrity of vk files
- see if upgrade epochs are properly set in config files

```toml
# cali
"upgradeOhSnapHeight": 682006
# mainnet
"upgradeOhSnapHeight": 1594680
```

- see if `maxfee` under `mpool` section is now in the format of `[x] Fil`

```
"mpool": {
"maxNonceGap": 100,
"maxFee": "10 FIL"
},
```

- see if chain synchronization is working properly

:::

:::warning

As a result of a mandatory network upgrade with API changes, sealer connection maybe lost during the this step of the upgrade.

:::

4. venus wrapped deamon: `mandatory` upgrade (if you are using `chain-co`); branch/tag `venus/v1.14.0`;

:::tip

Checkups after upgrading:

- see if chain synchronization is working properly
- see if connection to venus-auth is okay

```
curl http://127.0.0.1:3453/rpc/v0 -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <YOUR_TOKEN>" -d '{"method": "Filecoin.ChainHead","params":[], "id": 0}'
```

:::

5. chain-co: `mandatory` upgrade (if you deployed chain-co for your HA solution); branch/tag `v0.1.0`;

:::tip

Checkups after upgrading:

- see if two new API MpoolPending and MpoolGetNonce are working properly

:::

6. venus-messager: `mandatory` upgrade; branch/tag `v1.4.0`;

7. venus-gateway: `mandatory` upgrade; branch/tag `v1.2.0`;

:::tip

- support for both old and new API due to changes in ComputeProof's params
- see if both v0 and v1 APIs are working properly

:::

8. venus-miner: `mandatory` upgrade; branch/tag `v1.4.0`;

:::tip

Parameter changes for ComputeProof.

:::

9. venus-market: `optional` upgrade; branch/tag `v2.0.0`;

10. venus-sealer: `mandatory` upgrade; branch/tag `v1.4.0`;

For more question regarding nv15 upgrade, please refer to this discussion [thread](https://github.com/filecoin-project/venus/discussions/4688).
103 changes: 103 additions & 0 deletions docs/zh/operation/Nv15_upgrade_guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# nv15升级指南

## 版本信息


1. venus-wallet
2. venus
3. lotus兼容版本
4. chain-co
5. messager
6. venus-gateway
7. venus-miner
8. venus-market
9. venus-sealer


## 升级细节
1. venus-auth: 可选择升级
分支: v1.3.2
影响功能: 无
2. venus: 升级
分支:v1.2.0
影响功能:支持新网络版本
注意事项:
1. 升级后检查vk文件是否完整
2. 升级后检查配置文件,升级高度是否正常设置:
```
# cali
"upgradeOhSnapHeight": 682006
# mainnet
"upgradeOhSnapHeight": 1594680
```
3. 升级后检查mpool下maxfee配置是否由数字转换成xxFil形式
```
"mpool": {
"maxNonceGap": 100,
"maxFee": "10 FIL"
},
```
4. 升级后需检查是否正常同步区块
5. api版本发生变化,影响sealer的连接,升级方式需要按照大升级的方式来处理

3. lotus兼容版本: 升级
分支: venus/v1.14.0
影响功能: 支持新网络版本
注意事项:
1. 检查是否正常同步
2. 检查和venus-auth的连接是否完好(curl 命令验证)

4. chain-co: 升级
分支:v0.1.0
注意事项:
影响功能:
1. 暴露新的接口MpoolPending/MpoolGetNonce
2. 升级后检查两个接口是否存在,且能正常工作

5. venus-messager: 升级
分支:v1.4.0
影响功能: 仅支持新的网络版本
注意事项: 无

6. venus-miner: 升级
Tag: v1.4.0
影响功能:
1. 计算证明的接口(ComputeProof)参数发生变化
注意事项:无

7. venus-gateway: 升级
分支:v1.2.0
影响功能:
1. ComputeProof接口参数发生变化,
2. 需同时支持新老两组接口
注意事项:
1. 升级后需检查是否v0/v1两组接口都在正常工作

8. venus-wallet: 可选择升级
Tag:v1.4.0
影响功能:无

9. venus-market: 可选择升级
分支: v2.0.0
影响功能 新版本

## 升级顺序

1. venus-wallet Tag:v1.4.0
2. venus v1.2.0
3. lotus for venuspool venus/v1.14.0
4. chain-co v0.1.0
5. venus-messager v1.4.0
6. venus-gateway v1.2.0
7. venus-miner Tag:v1.4.0
8. venus-market v2.0.0
9. venus-sealer v1.4.0

## 升级建议

1. 对于还有证明空窗期的用户, 选择一个安全的时间来升级。
2. 对于已经不具备空窗期的用户,最好的办法是在建立一个环境来进行过度。
3. 建议运行一个备用的兼容版本lotus用于备份。


有任何关于升级的问题可以到disscusion讨论: https://github.com/filecoin-project/venus/discussions/4688

0 comments on commit b383a42

Please sign in to comment.