多miner支持特性升级须知

[Fatman13]

原文 by @zl03jsj

升级背景描述

• 此次多miner功能升级非强制升级；但若venus-auth，venus-gateway，venus-miner，venus-market其中任何一个升级的话，其他模块必须一起升级；
• 支持多个miner之间可共享使用token的特性
• 支持venus-cluser和venus-sealer服务多个miner_id

版本信息

组件	版本
venus-auth	v1.4.0
venus-gateway	v1.4.0
venus-miner	v1.4.1
venus-market	master分支(924e595c)

组件升级顺序

graph LR;
auth(auth)
miner[miner]
gateway[gateway]
market[market]
auth-->gateway
gateway-->miner
gateway-->market

Loading

升级Venus-auth

• 新特性
  支持多个miner共享同一个token的功能

• 命令行变化

  增加miner子命令集, 用于miner的管理操作

  ./venus-auth user miner --help
  

• 数据库迁移

  之前是miner和user有1:1对应的关系, 现在变成了n:1的关系, 导致数据库结构变动.

  迁移方式:部署后自动迁移

• API变化

  • 新增API: GetUserByMiner, ListUsersWithMiners
  • 接口变化:
    • GetUser -> GetUserByMiner
    • ListUsers, GetUser接口返回的user信息中不再包含对应的miner信息;

• 组件升级影响

  • 破坏兼容性, venus-market, venus-gateway, venus-miner需同步升级

• 启动完成后检查项:

  • 日志观察

    • 数据库自动迁移

      • 成功日志:migrate from:0, to:1 success.

      • 失败日志:migrate from store version:0 failed:

  • 检查user状态信息, 确保被使用的user状态都为enabled状态.

     ./venus-auth user get 1-125
    name: 1-125
    sourceType: 0 	// miner:1
    state: enabled 	// 0: disable, 1: enable

  • 检查user和miner的绑定关系, 确保关联正确

    ./venus-auth user miner list 1-125
    user: 1-125, miner count:3
    idx  miner   create-time
    0    f01087  Tue, 22 Mar 2022 17:30:36 CST
    1    f01143  Wed, 23 Mar 2022 10:20:14 CST
    2    f01153  Tue, 12 Apr 2022 15:24:26 CST`

升级Venus-gateway

• 新特性

  • 当market, sealer注册到gateway时, gateway在验证miner时, 增加了对miner的检查:

    • miner是否与其token对应的user的映射关系

    • user是否为激活状态

• 组件升级影响

  • 破坏兼容性, sealer,market需同步升级

• 启动完成后检查项

  • 日志观察

    • 当venus-sealer注册到gateway时, 如果验证miner失败可以看到相关日志:

  error in RPC call to 'Gateway.ListenProofEvent': verify miner:t01087 failed:user:1-125 is disabled, please enable it on 'venus-auth'
  error in RPC call to 'Gateway.ListenMarketEvent': verify miner:t01087 failed:user:1-125 is disabled, please enable it on 'venus-auth'

升级Venus-miner

• 组件升级影响

  • 破坏兼容性, 使用新的venus-auth api, 需与新版本venu-auth同步升级

• 启动完成后检查项

  • 日志观察
    • venus-miner在刷新miner列表是, 新增了验证了miner对应的user是否为激活状态, 如果user未激活, 可以看到相关的日志:

    2022-04-11T14:49:26.636+0800    WARN    auth-miners     auth/auth.go:103        user: f01031 state is disabled, it's miners won't be updated
    2022-04-11T14:49:26.636+0800    WARN    auth-miners     auth/auth.go:103        user: 200-22 state is disabled, it's miners won't be updated
    2022-04-11T14:49:26.636+0800    WARN    auth-miners     auth/auth.go:103        user: 1.125 state is disabled, it's miners won't be updated
    2022-04-11T14:49:26.639+0800    WARN    auth-miners     auth/auth.go:103        user: zl state is disabled, it's miners won't be updated

升级Venus-market

• 组件升级影响

  • 破坏兼容性, 使用新的venus-auth api, 需与新版本venu-auth同步升级

• 启动完成后检查项

  • 日志观察
    • venus-market运行在pool模式下, 会自动从veus-auth刷新miner列表,验证了miner对应的user是否为激活状态, 如果user未激活, 可以看到相关的日志:

  2022-04-11T15:17:17.929+0800    WARN    address-manager minermgr/minermgr.go:158        user:f01031 state is: disabled, won't list its mienrs
  2022-04-11T15:17:17.929+0800    WARN    address-manager minermgr/minermgr.go:158        user:200-22 state is: disabled, won't list its mienrs
  2022-04-11T15:17:17.929+0800    WARN    address-manager minermgr/minermgr.go:158        user:1.125 state is: disabled, won't list its mienrs
  2022-04-11T15:17:17.929+0800    WARN    address-manager minermgr/minermgr.go:158        user:zl state is: disabled, won't list its mienrs

[Fatman13]

原文 by @zl03jsj

Backgroud

• This is an optional feature upgrade for multi miner authentication support; Although the upgrade is optional, if you happen to upgrade any one of venus-auth，venus-gateway，venus-miner，venus-market component, you have to upgrade the other three component too
• Support for usage of token shared by different miner_id
• Thus allows venus-cluser and venus-sealer to work for multiple miner_ids

Commit information

Component	Commit
venus-auth	master commit (896f44f)
venus-gateway	master commit (2e500a7)
venus-miner	master commit (7c714d0)
venus-market	master commit (122f6ad)

Upgrade Order

graph LR;
auth(auth)
miner[miner]
gateway[gateway]
market[market]
auth-->gateway
gateway-->miner
gateway-->market

Loading

venus-auth

• feature: Support for usage of token shared by different miner_id

• CLI change: Added miner sub command for miner admin

$ ./venus-auth user miner --help

• Data migration: miner and user used to be of 1 to 1 relationship which is changed to allow n to 1 relationship causing change of database structure; Data migration will happen when new binary is deployed

• API change:

  • New API: GetUserByMiner, ListUsersWithMiners
  • API change: user returned by ListUsers, GetUser will not contain miner information anymore;

• Log check after upgrade:

  • data migration check:
    • Success log: migrate from:0, to:1 success.
    • Failure log: migrate from store version:0 failed:
  • check user state information; Make sure that user are all enabled

./venus-auth user get 1-125
name: 1-125
sourceType: 0 	// miner:1
state: enabled 	// 0: disable, 1: enable

• Check the binding of user and miner

$ ./venus-auth user miner list 1-125
user: 1-125, miner count:3
idx  miner   create-time
0    f01087  Tue, 22 Mar 2022 17:30:36 CST
1    f01143  Wed, 23 Mar 2022 10:20:14 CST
2    f01153  Tue, 12 Apr 2022 15:24:26 CST`

venus-gateway

• New feature:

  • Added two more verifications when market and sealer registered on gateway
    • if miner is bind to the token of that particular user
    • if user is enabled

• Check after deployment

  • Example log of venus-sealer fail the authentication when it register itself on gateway

error in RPC call to 'Gateway.ListenProofEvent': verify miner:t01087 failed:user:1-125 is disabled, please enable it on 'venus-auth'
error in RPC call to 'Gateway.ListenMarketEvent': verify miner:t01087 failed:user:1-125 is disabled, please enable it on 'venus-auth'

venus-miner

• Check after deployment
  • Log: now shows user disabled log

2022-04-11T14:49:26.636+0800    WARN    auth-miners     auth/auth.go:103        user: f01031 state is disabled, it's miners won't be updated
2022-04-11T14:49:26.636+0800    WARN    auth-miners     auth/auth.go:103        user: 200-22 state is disabled, it's miners won't be updated
2022-04-11T14:49:26.636+0800    WARN    auth-miners     auth/auth.go:103        user: 1.125 state is disabled, it's miners won't be updated
2022-04-11T14:49:26.639+0800    WARN    auth-miners     auth/auth.go:103        user: zl state is disabled, it's miners won't be updated

venus-market

• Check after deployment
  • Log: venus-market under pool mode will fetch user list by itself and shows user state in the log

2022-04-11T15:17:17.929+0800    WARN    address-manager minermgr/minermgr.go:158        user:f01031 state is: disabled, won't list its mienrs
2022-04-11T15:17:17.929+0800    WARN    address-manager minermgr/minermgr.go:158        user:200-22 state is: disabled, won't list its mienrs
2022-04-11T15:17:17.929+0800    WARN    address-manager minermgr/minermgr.go:158        user:1.125 state is: disabled, won't list its mienrs
2022-04-11T15:17:17.929+0800    WARN    address-manager minermgr/minermgr.go:158        user:zl state is: disabled, won't list its mienrs