readme: improve formatting

Signed-off-by: Jakub Sokołowski <jakub@status.im>
This commit is contained in:
Jakub Sokołowski 2023-10-04 15:43:14 +02:00
parent 8228675ead
commit 5737509777
No known key found for this signature in database
GPG Key ID: FE65CD384D5BF7B4

View File

@ -1,23 +1,25 @@
# Description # Description
This repo defines infrastructure for running [nim-waku](github.com/status-im/nim-waku) nodes shards. This repo defines infrastructure for running [nim-waku](github.com/status-im/nim-waku) nodes shards.
There are 3 kinds of nodes: There are 3 kinds of nodes:
- `boot` - bootstrap nodes, no storage
- `enrtree://AMOJVZX4V6EXP7NTJPMAYJYST2QP6AJXYW76IU6VGJS7UVSNDYZG4@boot.test.shards.nodes.status.im` * `boot` - Bootstrap nodes. No `store` protcol enabled.
- `store` - messages store nodes * `store` - Messages store nodes with `relay`, and `store` protocols.
- `enrtree://AMOJVZX4V6EXP7NTJPMAYJYST2QP6AJXYW76IU6VGJS7UVSNDYZG4@store.test.shards.nodes.status.im` * `store-db` - PostgreSQL used by `store` nodes for envelope storage.
- `store-db` - PostgreSQL used by `store` nodes for storage
# Address # Address
| Fleet | enrtree | | Node | DNS ENRTree |
| ----- | ------------------------------------------------------------------------------------------------- | | ------- | --------------------------------------------------------------------------------------------------- |
| boot | enrtree://AMOJVZX4V6EXP7NTJPMAYJYST2QP6AJXYW76IU6VGJS7UVSNDYZG4@boot.test.shards.nodes.status.im | | `boot` | `enrtree://AMOJVZX4V6EXP7NTJPMAYJYST2QP6AJXYW76IU6VGJS7UVSNDYZG4@boot.test.shards.nodes.status.im` |
| store | enrtree://AMOJVZX4V6EXP7NTJPMAYJYST2QP6AJXYW76IU6VGJS7UVSNDYZG4@store.test.shards.nodes.status.im | | `store` | `enrtree://AMOJVZX4V6EXP7NTJPMAYJYST2QP6AJXYW76IU6VGJS7UVSNDYZG4@store.test.shards.nodes.status.im` |
# Continious Integration # Continious Integration
Jenkins CI builds can be used to build and deploy new Docker images: Jenkins CI builds can be used to build and deploy new Docker images:
- `shards.test`: https://ci.infra.status.im/job/nim-waku/job/deploy-shards-test/
* `shards.test`: https://ci.infra.status.im/job/nim-waku/job/deploy-shards-test/
# Repo Usage # Repo Usage