From 98ff729cadda90f4957b898486e99a0324450894 Mon Sep 17 00:00:00 2001 From: Yu Date: Wed, 16 Mar 2022 15:14:59 +0800 Subject: [PATCH 1/2] update EN master course --- docs/.vuepress/config.js | 7 ++-- docs/master/Chain_service_construction.md | 26 +++++++++++--- docs/master/Course_introduction.md | 15 ++------ docs/master/Daily_op_and_maintenance.md | 9 ++--- docs/master/Incubation_exit_guide.md | 2 +- docs/master/Intro_to_Venus.md | 11 +++--- docs/master/Q&A.md | 6 ++-- docs/master/README.md | 37 ++++---------------- docs/zh/master/Chain_service_construction.md | 6 +++- 9 files changed, 50 insertions(+), 69 deletions(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 3a81956c5..d71bd8fbe 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -168,10 +168,9 @@ module.exports = { title: 'Master Course', collapsable: false, children: [ - ['', 'Overview'], - ['Course_introduction.md', 'Master course'], + ['', 'TOC'], ['Intro_to_Venus.md', 'Introduction'], - ['Chain_service_construction.md', 'Deploy a Chain Service'], + ['Chain_service_construction.md', 'Deploy/join a Chain Service'], ['Daily_op_and_maintenance.md', 'Node operations'], ['Q&A.md', 'Q&A'], ['Incubation_exit_guide.md', 'Exit incubation program'], @@ -298,7 +297,7 @@ module.exports = { children: [ ['', '目录'], ['Intro_to_Venus.md', 'Venus概要'], - ['Chain_service_construction.md', '部署链服务'], + ['Chain_service_construction.md', '部署/加入链服务'], ['Daily_op_and_maintenance.md', '节点日常运维'], ['Q&A.md', 'Q&A'], ['Incubation_exit_guide.md', '节点迁出指南'], diff --git a/docs/master/Chain_service_construction.md b/docs/master/Chain_service_construction.md index 3f95471dc..8ac592b19 100644 --- a/docs/master/Chain_service_construction.md +++ b/docs/master/Chain_service_construction.md @@ -1,8 +1,8 @@ -## Chain services +### Chain services -The implementation of the venus system uses a microservice architecture, decoupling overlapping functionalities to form different components. Depending on different one's core functions, Venus components are loosely broken into chain service components and independent components. Venus chain services can serve multiple clusters of different storage providers. Chain services can be built by storage providers or dedicated service provider. Each cluster gaining access to chain services only needs to focus on independent components, which is mainly for the growth and maintenance of storage power. +The implementation of the venus system uses a microservice architecture, decoupling overlapping functionalities to form different components. Depending on different one's core functions, Venus components are loosely broken into chain service components and local components. Venus chain services can serve multiple storage systems of different storage providers. Chain services can be built by storage providers or dedicated chain service provider. Each storage system gaining access to chain services only needs to focus on local components, which is mainly for the growth, maintenance of storage power and optionally deal-making. -In the venus architecture, the continuous operation of the chain service is particularly important. Once the chain service is down, clusters using its service may fail. This article introduces how to deploy a chain services. +In the venus architecture, the continuous operation of the chain service is particularly important. If the chain service is down, storage systems using its service may fail. This article introduces how to deploy a chain service along with intros on how to use a chain service, venus-cluster and deal-making. ### Hardware requirement @@ -13,8 +13,24 @@ Venus chain service is responsible for chain synchronization, message packaging, - venus-gateway *1: 16Core/32G/200G(essd)； - venus-miner *1: 16Core/32G/200G(essd)； -One chain services can support multiple storage providers. To minimize the risks of single point failure, make sure there are redundancy for each venus modules and load balance to guard chain services from DDos. +:::tip -### Deploy your chain services +One chain service can support multiple storage providers. To minimize the risks of single point failure, make sure there are redundancy for each venus modules and load balance to guard chain services from DDos. + +::: + +### Deploy a chain service Follow this guide for deployment of your [chain services](https://venus.filecoin.io/guide/How-To-Deploy-MingPool.html). + +### Use a chain service + +To join a self-deployed or a thrid-party chain service, please refer to documentation [here](/guide/Using-venus-Shared-Modules.html). + +### venus-cluster + +To use venus-cluster for growth of storage power, please refer to documentation [here](/guide/Using-venus-cluster-alt.html). + +### Deal making + +To use venus-market, please refer to documentation [here](https://github.com/filecoin-project/venus/discussions/4735). \ No newline at end of file diff --git a/docs/master/Course_introduction.md b/docs/master/Course_introduction.md index 4a5532b1b..852fc513c 100644 --- a/docs/master/Course_introduction.md +++ b/docs/master/Course_introduction.md @@ -1,15 +1,4 @@ -# venus master classes - -Introducing the ["Venus Master Fellowship"]() program for teams or individuals who have demonstrated their technical-know-how in setuping a storage providing oeration with Venus. If you wish to become a **Venus Master**, please make sure that you go through the following classes which we have prepared so that you may help others to bootstrap their storage providing operations. - -Responsibilities for being a venus master includes but not limited to: -- Help participants establish connection to chain services -- Answer the technical questions from the community -- Help daily maintain maintenance and operation of chain services - -To better serve incubation participants as a ***venus master***, it is necessary to have a solid understanding of the venus chain service and access process. To this end, we have prepared master classes so that the venus master can get started quickly and learn systematically. - -## contents +### TOC 1. [Venus storage pool introduction](Intro_to_Venus.md) @@ -21,4 +10,4 @@ To better serve incubation participants as a ***venus master***, it is necessary 5. [Incubation Exit Guide](Incubation_exit_guide.md) -If you have more questions, please contact us via [Slack](https://filecoinproject.slack.com/archives/CEHHJNJS3), or send an email to [venus@filecoin.com](venus@filecoin.com). \ No newline at end of file +If you have more questions, please contact us via [Slack](https://filecoinproject.slack.com/archives/CEHHJNJS3), or send an email to [venus@ipfsforce.com](venus@ipfsforce.com). \ No newline at end of file diff --git a/docs/master/Daily_op_and_maintenance.md b/docs/master/Daily_op_and_maintenance.md index 6188e4f3d..59b4360f8 100644 --- a/docs/master/Daily_op_and_maintenance.md +++ b/docs/master/Daily_op_and_maintenance.md @@ -1,6 +1,4 @@ -## Daily operations - -### Independent modules +### Local modules The independent components of the venus system are venus-sealer/venus-cluster and venus-wallet. venus-sealer is 1st generation of PoRep and PoSt component which will no longer be maintained in the second phase of the incubation center. **venus-cluster** is latest generation of Venus' PoRep and PoSt component. Compared with venus-sealer, it has a great improvement in task scheduling and system resources management. **venus-cluster** will be actively maintained and is now the recommended component for PoRep and PoSt. @@ -77,8 +75,7 @@ $ ./venus-sealer proving check --only-bad 7 #### venus-cluster -To be released - +Please refer to documentations [here](https://github.com/ipfs-force-community/venus-cluster/tree/main/docs/zh). ### Chain services monitoring @@ -88,8 +85,6 @@ To be released ![venus-all](../../docs/.vuepress/public/monitor/venus-all.jpg) -统计特定矿工的独立组件请求链服务所有组件提供接口的次数，起始点后和结束点前的半个小时数据可以忽略。 - Chain service API usage Statistics for a single storage provider. Note: ignore starting half an hour and ending half an hour in a given interval. - venus diff --git a/docs/master/Incubation_exit_guide.md b/docs/master/Incubation_exit_guide.md index abc58c3ff..664efe82a 100644 --- a/docs/master/Incubation_exit_guide.md +++ b/docs/master/Incubation_exit_guide.md @@ -1,4 +1,4 @@ -## Incubation Exit Guide +### Incubation Exit Guide There are couple options for storage providers to exit incubation program either voluntarily or after each phase ends. diff --git a/docs/master/Intro_to_Venus.md b/docs/master/Intro_to_Venus.md index 32d6bb9ae..2a9ac2219 100644 --- a/docs/master/Intro_to_Venus.md +++ b/docs/master/Intro_to_Venus.md @@ -1,10 +1,10 @@ -## Venus overview +## Overview -Venus is one of the implementations of Filecoin storage network, which focuses on distributed architecture and a more concise division of functionalities. Storage resources are geographically dipersed, which means as long as there is internet connection a storage cluster can be connected to the Venus storage pool. +Venus is one of the 4 implementations of Filecoin storage network, which focuses on distributed architecture and a more concise division of functionalities. Storage resources are geographically dipersed, which means as long as there is internet connection a storage system can be connected to a Venus chain service. ## Architecture -The venus components/modules includes includes [venus](https://github.com/filecoin-project/venus), [venus-auth](https://github.com/filecoin-project/venus-auth), [venus-miner](https://github.com/filecoin-project/venus-miner), [venus-messager](https://github.com/filecoin-project/venus-messager), [venus-gateway](https://github.com/ipfs-force-community/venus-gateway), [venus-wallet](https://github.com/filecoin-project/venus-wallet), [venus-sealer](https://github.com/filecoin-project/venus-sealer), and [venus-market](https://github.com/filecoin-project/venus-market). Based on functionalities, the components can be broken into shared components (chain services) and independent components. As a storage provider using chain services, it is no longer required to maintain chain synchronization, micro manage the sending of each message and more. As a chain services provider with hardware resources, it can build chain services for other storage providers and potentially charge service fees from them. For large storage providers, they can also take advantage of venus architecture to allow quicker expansion and easier maintenance. +The Venus components/modules includes includes [venus](https://github.com/filecoin-project/venus), [venus-auth](https://github.com/filecoin-project/venus-auth), [venus-miner](https://github.com/filecoin-project/venus-miner), [venus-messager](https://github.com/filecoin-project/venus-messager), [venus-gateway](https://github.com/ipfs-force-community/venus-gateway), [venus-wallet](https://github.com/filecoin-project/venus-wallet), [venus-sealer](https://github.com/filecoin-project/venus-sealer)（soon to be replaced by `venus-cluster`），[venus-cluster](https://github.com/ipfs-force-community/venus-cluster) and [venus-market](https://github.com/filecoin-project/venus-market). Based on functionalities, the components can be broken into shared components (chain services) and local components. As a storage provider using chain services, it is no longer required to maintain chain synchronization, micro manage the sending of each message and other interactions with the chain. As a chain services provider with hardware resources, it can build chain services for other storage providers and potentially charge service fees from them. For large storage providers, they can also take advantage of venus architecture to allow quicker expansion and easier maintenance. The following figure demonstrates how each component interacts with each other. In this illustration, chain services is serving one storage provider and can easily scale to serve multiple storage providers. @@ -15,12 +15,13 @@ The following shows venus components to lotus components relationship. * venus-auth --> token authentication service extend lotus jwt * venus-miner --> lotus-miner block produce part & multi miner * venus-sealer --> lotus-miner sealer scheduler part/wd +* venus-cluster --> lotus-miner sealer scheduler part/wd * venus-worker --> lotus-worker * venus daemon --> lotus daemon * venus-wallet -> lotus wallet part * venus-messager --> lotus mpool -* venus-market --> lotus-miner market part +* venus-market --> lotus-market node ## How venus works -For more on how each venus components work, please go through this document [here](https://venus.filecoin.io/guide/#how-venus-works). +For more on how each Venus components work, please go through this document [here](https://venus.filecoin.io/guide/#how-venus-works). diff --git a/docs/master/Q&A.md b/docs/master/Q&A.md index d7c2b8c86..600afa0d9 100644 --- a/docs/master/Q&A.md +++ b/docs/master/Q&A.md @@ -1,6 +1,6 @@ -## Q&A +### Q&A -Q&As are loosely broken into two categories, chain services (venus shared modules) and independent modules. +For more questions SP encounters when using Venus, please refer to [#fil-venus](https://filecoinproject.slack.com/archives/CEHHJNJS3) and [#fil-venus-cn](https://filecoinproject.slack.com/archives/C028PCH8L31) for more. ### chain services (venus shared modules) @@ -55,7 +55,7 @@ During sealer init, user chose wrong sector size for the network. Check [network Check if there is wallet addresses registered on gateway. Also see if connection between venus-messager and Venus-gateway is okay. -### venus independent modules +### Venus local modules TBC diff --git a/docs/master/README.md b/docs/master/README.md index e16d09bd4..43cac6eb2 100644 --- a/docs/master/README.md +++ b/docs/master/README.md @@ -1,36 +1,13 @@ -## Introduce Venus Master Fellowship Project Phase1 +### TOC -The [Storage Provider Incubation Center](https://venus.filecoin.io/incubation/Rules.html) brings together the resources of the Filecoin Foundation and Venus Team to provide funding and technical support to small and medium storage providers. +1. [Introduction to Venus](Intro_to_Venus.md) -The idea is to make it simple and convenient for small storage providers to join the Filecoin network by lowering the barrier to entry. There are two ways to participate (two sub projects): join the Incubation Center or be an Venus Master. +2. [To deploy and join a Chain Service](Chain_service_construction.md) -Some nodes from Europe, Asia and North America are running stably in the phase 1 of the Incubation Center with the support by Venus team and community. We are working on the preparation for the Venus Master program, so masters can get prepared and get ready when the phase 2 of the Incubation Center get started. +3. [Daily maintenance and operation](Daily_op_and_maintenance.md) -To be an Venus Master, participant must continuously contribute to the development of the Filecoin network with full experience in coding, mining or servicing. Selected Masters will provide consulting services and technical support to the storage providers in the Incubation Center, ensure these participants to expand the distributed storage pool service in the Filecoin network. +4. [Q&A](Q&A.md) -## Work as an Venus Master +5. [Exit Guide](Incubation_exit_guide.md) -1. Provide services to the storage providers (expected to be 5) of the Incubation Center, services include helping storage providers connect to the distributed storage pool with Venus independent modules(venus-sealer/wallet), thus providing more storage power to the Filecoin network. - -2. Serve for at least one full phase of the project (3months). - -3. Sync with storage providers in the storage pool during debugging or version upgrades to make necessary preparations after receiving the notification. - -4. Coordinate testing with the Venus Dev team to verify the quality of service during the version upgrades. - -5. Provide feedback on the tools/implementation to ensure the continuous improvement of Venus storage providers’ experience. - -6. Provide feedback and suggestions on productivity and load balance, such as energy consumption, cost efficiency, etc. - -## 1,000Fil+ Prize Pool - -In exchange for their work, Masters will receive access to a prize pool of more than 1,000 FIL tokens, which will be distributed based on the length and quality of service. At the end of each phase, Masters can choose to continue their work by applying to be a part of the next phase. - -## How to become an Venus Masters - -To join the Venus Masters Project, fill out this [Application Form](http://venusteam.mikecrm.com/KWWYu0F) with as much information as possible. - -The application of phase 1 will start from September 20 to October 10. In addition to the documents already published, we will publish a series of Master Classes with tutorial videos and documents to help Venus Masters work better. The selected Masters can complete the learning process before October 31, and complete the testing in the provided Calibration network with the assistance of Venus team. - -After learning process and testing, 3 Masters will be selected to start working in early November, so be consistent with the phase 2 of the Incubation Center. -Participant who have any issues joining the Venus Masters can reach out to the Venus team by email（venus@ipfsforce.com）or on Filecoin Slack: [fil-venus](https://filecoinproject.slack.com/archives/CEHHJNJS3). +If you have more questions, please contact us via [Slack](https://filecoinproject.slack.com/archives/CEHHJNJS3), or send an email to [venus@ipfsforce.com](venus@ipfsforce.com). \ No newline at end of file diff --git a/docs/zh/master/Chain_service_construction.md b/docs/zh/master/Chain_service_construction.md index a3775f2f3..1b5a37938 100644 --- a/docs/zh/master/Chain_service_construction.md +++ b/docs/zh/master/Chain_service_construction.md @@ -410,7 +410,11 @@ $ ./venus-miner address update ## 使用链服务 -请学习参见[这个](/guide/Using-venus-Shared-Modules.html)文档。 +请学习参见[这个](/zh/guide/Using-venus-Shared-Modules.html)文档。 + +## 使用venus-cluster + +请学习参见[这个](/zh/guide/Using-venus-cluster-alt.html)文档。 ## 接收存储订单 From d5cb9f6ca4af4e322e7244f97fcaf05b1e4ed95e Mon Sep 17 00:00:00 2001 From: Yu Date: Wed, 16 Mar 2022 17:10:20 +0800 Subject: [PATCH 2/2] update wording --- docs/master/Course_introduction.md | 2 +- docs/master/Daily_op_and_maintenance.md | 2 +- docs/master/Incubation_exit_guide.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/master/Course_introduction.md b/docs/master/Course_introduction.md index 852fc513c..028a16666 100644 --- a/docs/master/Course_introduction.md +++ b/docs/master/Course_introduction.md @@ -8,6 +8,6 @@ 4. [Q&A](Q&A.md) -5. [Incubation Exit Guide](Incubation_exit_guide.md) +5. [Exit Guide](Incubation_exit_guide.md) If you have more questions, please contact us via [Slack](https://filecoinproject.slack.com/archives/CEHHJNJS3), or send an email to [venus@ipfsforce.com](venus@ipfsforce.com). \ No newline at end of file diff --git a/docs/master/Daily_op_and_maintenance.md b/docs/master/Daily_op_and_maintenance.md index 59b4360f8..5d1913828 100644 --- a/docs/master/Daily_op_and_maintenance.md +++ b/docs/master/Daily_op_and_maintenance.md @@ -1,6 +1,6 @@ ### Local modules -The independent components of the venus system are venus-sealer/venus-cluster and venus-wallet. venus-sealer is 1st generation of PoRep and PoSt component which will no longer be maintained in the second phase of the incubation center. **venus-cluster** is latest generation of Venus' PoRep and PoSt component. Compared with venus-sealer, it has a great improvement in task scheduling and system resources management. **venus-cluster** will be actively maintained and is now the recommended component for PoRep and PoSt. +The local components of the venus system are venus-sealer/venus-cluster and venus-wallet. venus-sealer is 1st generation of PoRep and PoSt component which will no longer be maintained in the second phase of the incubation center. **venus-cluster** is latest generation of Venus' PoRep and PoSt component. Compared with venus-sealer, it has a great improvement in task scheduling and system resources management. **venus-cluster** will be actively maintained and is now the recommended component for PoRep and PoSt. #### venus-wallet diff --git a/docs/master/Incubation_exit_guide.md b/docs/master/Incubation_exit_guide.md index 664efe82a..cdad3635f 100644 --- a/docs/master/Incubation_exit_guide.md +++ b/docs/master/Incubation_exit_guide.md @@ -1,6 +1,6 @@ -### Incubation Exit Guide +### Exit Guide -There are couple options for storage providers to exit incubation program either voluntarily or after each phase ends. +There are couple options for storage providers to exit a hosted chain service either voluntarily or after each phase ends. - Join a hosted chain service (venus shared modules) by third party. - Deploy a chain service (venus shared modules) by yourself.