Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Main #38

Open
wants to merge 81 commits into
base: fatman13-doc
Choose a base branch
from
Open

Main #38

Changes from 1 commit
Commits
Show all changes
81 commits
Select commit Hold shift + click to select a range
5caf2c4
Merge pull request #1 from ipfs-force-community/fatman13-doc
Fatman13 Jan 4, 2023
1ac0ae4
feat: lock node's version
LinZexiao Feb 22, 2023
dff05f2
Merge pull request #2 from ipfs-force-community/feat/tanlang/lock-nod…
LinZexiao Feb 22, 2023
435f5d4
fix: ref for chain-co
LinZexiao Mar 6, 2023
c3db48c
Merge pull request #3 from ipfs-force-community/feat/fix-ref-for-chai…
Fatman13 Mar 6, 2023
94ffa5a
docs: add flag auth-token
simlecode Apr 24, 2023
0b89180
docs: update mainnet snapshot link
simlecode Apr 24, 2023
11ac4ed
docs: fix typ
simlecode Apr 24, 2023
634f4d6
docs: use SHARED_ADMIN_AUTH_TOKEN instead of venus-auth token
simlecode Apr 24, 2023
efcbcf7
Merge pull request #4 from ipfs-force-community/docs/auth-token
Fatman13 Apr 24, 2023
9c7331b
update sophon-docs layout
Fatman13 Jun 7, 2023
a630f42
Merge pull request #5 from ipfs-force-community/fatman13-d1
Fatman13 Jun 7, 2023
58a7a38
fix deploy prep doc layout
Fatman13 Jun 7, 2023
4d72a26
Merge pull request #6 from ipfs-force-community/fatman13-d1
Fatman13 Jun 7, 2023
4ec3f85
fix wallet link
Fatman13 Jun 7, 2023
d98665e
Merge pull request #7 from ipfs-force-community/fatman13-d1
Fatman13 Jun 7, 2023
9a2f9f7
add design docs link
Fatman13 Jun 7, 2023
fcdd5e8
Merge pull request #8 from ipfs-force-community/fatman13-d1
Fatman13 Jun 7, 2023
5a78a82
feat: update docker usage
LinZexiao Jun 8, 2023
4cd88bc
Update docs/zh/operation/venus-run-in-docker.md
LinZexiao Jun 9, 2023
54f85e6
Merge pull request #9 from ipfs-force-community/feat/tanlang/update-f…
Fatman13 Jun 9, 2023
c71ef5c
remove .DS_Store
0x5459 Jun 14, 2023
1ed77a5
chore(*): formatting docs with `autocorrect`
0x5459 Jun 14, 2023
5cb28e6
Merge pull request #11 from ipfs-force-community/chore/0x5459/format-…
0x5459 Jun 14, 2023
deb02b5
add github link
0x5459 Jun 14, 2023
dc009fa
Merge pull request #12 from ipfs-force-community/add-github-link
0x5459 Jun 14, 2023
f610922
fix wording per new rebranding
Fatman13 Jun 16, 2023
9e175fa
Merge pull request #13 from ipfs-force-community/fatman13-p13
Fatman13 Jun 19, 2023
c0dfcbb
update en sophon layout
Fatman13 Jun 21, 2023
9d4f376
update sophon layout p2
Fatman13 Jun 21, 2023
faea308
Merge pull request #14 from ipfs-force-community/fatman13-p15
Fatman13 Jun 21, 2023
2d489df
add dev tab
Fatman13 Jun 21, 2023
af81918
Merge pull request #15 from ipfs-force-community/fatman13-p15
Fatman13 Jun 21, 2023
a24a880
update before deployment doc
Fatman13 Jun 26, 2023
1f4c9bd
Merge pull request #16 from ipfs-force-community/fatman13-p15
Fatman13 Jun 26, 2023
75e1590
fix wording
Fatman13 Jun 26, 2023
86ff23c
Merge pull request #17 from ipfs-force-community/fatman13-p15
Fatman13 Jun 26, 2023
e922c72
fix sophon-docs wording
Fatman13 Jun 26, 2023
6c5283d
Merge pull request #18 from ipfs-force-community/fatman13-p15
Fatman13 Jun 26, 2023
7eb43c9
fix en docs wording
Fatman13 Jun 26, 2023
13d7fbb
Merge pull request #19 from ipfs-force-community/fatman13-p15
Fatman13 Jun 26, 2023
c6491b0
add config description /添加配置文件描述
elvin-du Jul 7, 2023
013017d
remove old cmd
elvin-du Jul 7, 2023
9a3d2cd
Update venus-daemon.md / 构建命令和测试命令已经失效
elvin-du Jul 12, 2023
e280f55
Merge pull request #21 from ipfs-force-community/docs/elvin/remove-ol…
Fatman13 Jul 12, 2023
383a1ca
Merge pull request #22 from ipfs-force-community/docs/elvindu/udpate-…
Fatman13 Jul 12, 2023
6ac1e99
Remove venus sealer related information
cloudxin Jul 13, 2023
9583f8d
Merge pull request #23 from cloudxin/Remove_venus_sealer_related_info…
Fatman13 Jul 14, 2023
fe3736d
Update docs/.vuepress/config.js
elvin-du Jul 17, 2023
90e5770
rename venus -> sohpon
elvin-du Jul 17, 2023
81136a3
Merge pull request #20 from ipfs-force-community/elvin-du-patch-1
Fatman13 Jul 17, 2023
3ef5782
update github url
elvin-du Jul 17, 2023
cba2edf
Merge pull request #24 from ipfs-force-community/elvin-du-patch-2
elvin-du Jul 17, 2023
23db121
Update join-a-cs.md
cloudxin Jul 18, 2023
aef6d04
update arch illustration
Fatman13 Jul 31, 2023
d2e6f11
Merge pull request #26 from ipfs-force-community/fatman13-p15
Fatman13 Jul 31, 2023
e04ac80
Update deploy-a-cs.md
elvin-du Aug 1, 2023
cfd9191
Update config.js
elvin-du Aug 2, 2023
c9272f9
Merge pull request #28 from ipfs-force-community/elvin-du-patch-3
elvin-du Aug 2, 2023
68ab4a9
Merge pull request #27 from ipfs-force-community/elvin-du-patch-2
elvin-du Aug 2, 2023
eee4234
fix broken link
Fatman13 Aug 16, 2023
2458186
Merge pull request #29 from ipfs-force-community/fatman13-patch13
Fatman13 Aug 16, 2023
50c6311
Update docs/zh/operation/join-a-cs.md
Fatman13 Sep 6, 2023
c5df673
Update docs/zh/operation/join-a-cs.md
Fatman13 Sep 6, 2023
51d6b0e
Update docs/zh/operation/join-a-cs.md
Fatman13 Sep 6, 2023
08a7c8d
Update docs/zh/operation/join-a-cs.md
Fatman13 Sep 6, 2023
cbd7435
Update docs/zh/operation/join-a-cs.md
Fatman13 Sep 6, 2023
e6af332
Merge pull request #25 from cloudxin/patch-1
Fatman13 Sep 6, 2023
fb3b551
Update join-a-cs.md
elvin-du Sep 12, 2023
3bb687a
Merge pull request #30 from ipfs-force-community/elvin-du-patch-2
elvin-du Sep 12, 2023
5ddb501
Update deploy-a-cs.md
cloudxin Oct 20, 2023
9d94bd5
Merge pull request #31 from cloudxin/patch-2
simlecode Oct 20, 2023
0f1ed25
feat: update config for damocles manager
LinZexiao Oct 25, 2023
6b22db8
Apply suggestions from code review
LinZexiao Oct 25, 2023
c1ccc5c
add full text search
Fatman13 Oct 25, 2023
7d10171
Merge pull request #32 from ipfs-force-community/feat/update
Fatman13 Oct 25, 2023
06807fc
Merge pull request #33 from ipfs-force-community/fatman13-patch13
LinZexiao Nov 6, 2023
176eb87
update snapshot link & error db config
Jan 17, 2024
51b0622
Merge pull request #35 from ipfs-force-community/docs/vladmair/udpate…
Fatman13 Jan 17, 2024
168b9ce
fix: Update ha.md
tediou5 Mar 20, 2024
394570b
Merge pull request #36 from tediou5/patch-1
0x5459 Mar 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
feat: update config for damocles manager
  • Loading branch information
LinZexiao committed Oct 25, 2023
commit 0f1ed25153c442930be8f60c65bf575cbb6ce012
4 changes: 4 additions & 0 deletions docs/operation/deploy-a-cs.md
Original file line number Diff line number Diff line change
@@ -279,6 +279,10 @@ List all miner ids that have connected to sophon-miner.
$ ./sophon-miner address list
```

### Configure unified entry for chain service

Due to the existence of multiple chain service components, it can be cumbersome for downstream components to connect to multiple chain service components of the same chain service. Additionally, it requires configuring multiple entry points for the chain services. To simplify this process and provide a unified entry point for chain services, you can use sophon-gateway to proxy requests for other chain services. [configure unified entry](https://sophon.venus-fil.io/zh/operation/sophon-gateway.html#%E4%BD%BF%E7%94%A8-gateway-%E4%BB%A3%E7%90%86%E5%AF%B9%E5%85%B6%E4%BB%96%E7%BA%BF%E4%B8%8A%E7%BB%84%E4%BB%B6%E7%9A%84%E8%AF%B7%E6%B1%82)

## Next steps

Next, please follow this [guide](join-a-cs.md) to connect to the Sophon service you just deployed!
47 changes: 32 additions & 15 deletions docs/operation/join-a-cs.md
Original file line number Diff line number Diff line change
@@ -180,7 +180,7 @@ Pls keep the wallet unlock state. If the state is locked , it will block sealer

:::

## Install Damocles
## Install damocles

Download source code.

@@ -192,6 +192,7 @@ Compile `damocles`.

```bash
$ cd damocles
$ git checkout <LATEST_RELEASE>
$ make all
```

@@ -236,21 +237,37 @@ You will see logs similar to the following once successfully created new miner-i

### damocles-manager configurations

Tailor `~/.damocles-manager/sector-manager.cfg` to your own hardware. Detailed instructions on each configurations could be found [here](/zh/cluster/Venus-Sector-Manager).
Tailor `~/.damocles-manager/sector-manager.cfg` to your own hardware. Detailed instructions on each configurations could be found [here](/zh/cluster/damocles-manager).

```toml
[Common]
[Common.API]
# *mandatory* node address (chain service)
Chain = "/ip4/{api_host}/tcp/{api_port}"
# *mandatory* messager address (chain service)
Messager = "/ip4/{api_host}/tcp/{api_port}"
# market node address
# Market = "/ip4/{api_host}/tcp/{api_port}"
# *mandatory* gateway address (chain service)
Gateway = "/ip4/{api_host}/tcp/{api_port}"
# *mandatory* authentication token (chain service)
Token = "{auth token}"
# Gateway service infos, required, string type
# Fill in according to the actual situation of the service used
# For each one contained, if the item is valid as a token-included-info-string ("{token}:{multiaddr}"), the token included would be used to construct the rpc client instead of the common token.
Gateway = ["/ip4/{api_host}/tcp/{api_port}"]

# common token for services, required, string type
# Fill in according to the actual situation of the service used
Token = "{some token}"

# Chain service info, optional, string type
# Fill in according to the actual situation of the service used
# If the field is valid as a token-included-info-string ("{token}:{multiaddr}"), the token included would be used to construct the rpc client instead of the common token.
# If not set, use value of Gateway as default
Chain = "/ip4/{api_host}/tcp/{api_port}"

# Message service info, optional, string type
# Fill in according to the actual situation of the service used
# If the field is valid as a token-included-info-string ("{token}:{multiaddr}"), the token included would be used to construct the rpc client instead of the common token.
# If not set, use value of Gateway as default
Messager = "/ip4/{api_host}/tcp/{api_port}"

# Market service info, optional, string type
# Fill in according to the actual situation of the service used
# If the field is valid as a token-included-info-string ("{token}:{multiaddr}"), the token included would be used to construct the rpc client instead of the common token.
# If not set, use value of Gateway as default
Market = "/ip4/{api_host}/tcp/{api_port}"

[[Common.PieceStores]]
# *mandatory*
@@ -354,11 +371,11 @@ Attach permanent storage and init directories.
$ ./dist/bin/damocles-worker store file-init -l <dir1>
```

Plan CPU cores, numa, etc for eahc sealing tasks and tailor your configuration file to it. The following is an example configuration for `damocles-worker`. More detailed instructions on each configurations could be found [here](/zh/cluster/Venus-Worker-c)
Plan CPU cores, numa, etc for eahc sealing tasks and tailor your configuration file to it. The following is an example configuration for `damocles-worker`. More detailed instructions on each configurations could be found [here](/zh/cluster/damocles-worker-c)

```toml
[worker]
# optional, instance name of venus-sector-manager
# optional, instance name of damocles-manager
# name = "bytest"
# rpc_server.host = "0.0.0.0"
# rpc_server.port = 17890
@@ -369,7 +386,7 @@ Plan CPU cores, numa, etc for eahc sealing tasks and tailor your configuration f
# piece_token = "{auth token}"

[sealing]
# miner IDs that this venus-worker can serve; Ex: [22908, 11034, 191107]
# miner IDs that this damocles-worker can serve; Ex: [22908, 11034, 191107]
allowed_miners = [33680]
allowed_sizes = ["32GiB","64GiB"]
# When set to ture, you will need to configure `piece_token` in `sector_manager`
5 changes: 5 additions & 0 deletions docs/zh/operation/deploy-a-cs.md
Original file line number Diff line number Diff line change
@@ -349,6 +349,11 @@ $ ./sophon-miner address start <MINER_ID>
$ ./sophon-miner address stop <MINER_ID>
```

## 配置链服务统一入口

因为链服务组件比较多, 当下游组件想要链接同一个链服务的多个链服务组件时, 配置会比较繁琐, 并且需要提供多个链服务的入口.
可以使用 `sophon-gateway` 代理其他链服务的请求, 对外提供一个统一的链服务入口. [部署统一链服务入口](https://sophon.venus-fil.io/zh/operation/sophon-gateway.html#%E4%BD%BF%E7%94%A8-gateway-%E4%BB%A3%E7%90%86%E5%AF%B9%E5%85%B6%E4%BB%96%E7%BA%BF%E4%B8%8A%E7%BB%84%E4%BB%B6%E7%9A%84%E8%AF%B7%E6%B1%82)

## 启动 droplet(可选)

`droplet` 可以作为链服务组件之一来进行部署,具体部署文档请参考[文档](https://droplet.venus-fil.io/zh/operation/)
36 changes: 26 additions & 10 deletions docs/zh/operation/join-a-cs.md
Original file line number Diff line number Diff line change
@@ -271,16 +271,32 @@ $ ./damocles-manager util miner create
```toml
[Common]
[Common.API]
# 链服务地址,必填项,字符串类型
Chain = "/ip4/{api_host}/tcp/{api_port}"
# 消息服务地址,必填项,字符串类型
Messager = "/ip4/{api_host}/tcp/{api_port}"
# 市场服务地址,封装真实数据时为必填项,字符串类型,CC 数据非必填项
# Market = "/ip4/{api_host}/tcp/{api_port}"
# 网关服务地址,必填项,字符串类型
Gateway = "/ip4/{api_host}/tcp/{api_port}"
# 服务 token,必填项,字符串类型
Token = "{auth token}"
# 网关服务地址,必填项,字符串类型
# 根据所使用的服务实际情况填写
# 对于每一条信息,如果使用了合法的 "{token}:{multiaddr}" 格式,构造客户端时将使用本字段中提取的 token,否则使用通用 sophon-auth 产生的 token
Gateway = ["/ip4/{api_host}/tcp/{api_port}"]

# 链服务信息,可选项,字符串类型
# 根据所使用的服务实际情况填写
# 如果使用了合法的 "{token}:{multiaddr}" 格式,构造客户端时将使用本字段中提取的 token,否则使用通用 sophon-auth 产生的 token
# 如果不填写,会默认使用 Gateway 的地址和 token 作为链服务的入口
Chain = "/ip4/{api_host}/tcp/{api_port}"

# 消息服务信息,可选项,字符串类型
# 根据所使用的服务实际情况填写
# 如果使用了合法的 "{token}:{multiaddr}" 格式,构造客户端时将使用本字段中提取的 token,否则使用通用 sophon-auth 产生的 token
# 如果不填写,会默认使用 Gateway 的地址和 token 作为消息服务的入口
Messager = "/ip4/{api_host}/tcp/{api_port}"

# 市场服务信息,可选项,字符串类型
# 根据所使用的服务实际情况填写
# 如果使用了合法的 "{token}:{multiaddr}" 格式,构造客户端时将使用本字段中提取的 token,否则使用通用 sophon-auth 产生的 token
# 如果不填写,会默认使用 Gateway 的地址和 token 作为消息服务的入口
Market = "/ip4/{api_host}/tcp/{api_port}"

# 服务 sophon-auth 产生的 token,必填项,字符串类型
# 根据所使用的服务实际情况填写
Token = "{some token}"

[[Common.PieceStores]]
# 路径,必填项,字符串类型