search

cardano-foundation / developer-portal

The Cardano Developer Portal
https://developers.cardano.org
MIT License
376 stars 907 forks source link

Info about topologyUpdater.sh and relay-topology_pull.sh is missing #369

Closed os11k closed 2 years ago

os11k commented 2 years ago

Hi,

I think we should add details somewhere in course about need to run topologyUpdater.sh hourly and need to generate topology file using relay-topology_pull.sh. I'm willing to create a pull request, but I personally find current page structure of Handbook a bit odd/outdated, so before adding this information I want to confirm that it is ok if I will just update "Configure Topology Files" page?

rdlrt commented 2 years ago

While using topologyUpdater.sh is helpful, it's not a hard requirement (as long as you add relay registration details to the guide). If adding a mention, it would be worth clarifying the same.

The handbook itself is quite outdated indeed. There are two ways ahead:

  1. We rewrite entire handbook from scratch
  2. Start updating in parts, which could be easier to commit/review
os11k commented 2 years ago

Hi! Sorry for being a bit ignorant, but I'm quite new to this. By relay registration you mean adding relays when creating pool registration certificate? As described here: https://developers.cardano.org/docs/stake-pool-course/handbook/register-stake-pool-metadata#generate-stake-pool-registration-certificate

After reading some posts in forum, it seems that topologyUpdater.sh is kind of mandatory, it is used for sending keep alive messages, so your relay will be considered as live, otherwise our relay will not be propagated to other relays? OR? https://forum.cardano.org/t/why-do-we-need-the-topology-updater/67955/7

rdlrt commented 2 years ago

After reading some posts in forum, it seems that topologyUpdater.sh is kind of mandatory

What is mandatory is having an incoming peer who is indirectly fetching blocks from another block producer. Until P2P is live, IOG uses the relays specified in stake pool registration to extract and connect to peers (twice per day). topologyUpdater provides a method for community to discover other live peers without a specific preference - you can read more about it here.

os11k commented 2 years ago

Ok, got it. Thank you! I think there are still value to add all of this information. I will prepare a pull request and then you can provide your feedback.

os11k commented 2 years ago

Ok, I decided just to add small remark about topologyUpdater.sh script on that page, I think it will be useful just for information. How to run it and more details probably can be found on Guild Operators site. I'm creating pull request now.