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

feat(docs): new node operator documentation #3

Merged
merged 17 commits into from
Aug 16, 2024
Merged

Conversation

outerlook
Copy link
Collaborator

@outerlook outerlook commented Aug 9, 2024

Description

Solved Friction Points

  • What are the prerequisites?
  • Easy download of prerequisites?
  • How to configure?
  • What are the steps to deploy?

Related Problem

How Has This Been Tested?

Create README.md for staging network setup, detailing configuration files and public keys. Introduce network-nodes.csv with initial validator node information.
Introduced a comprehensive guide to configuring Kwil node operators, covering database, performance, network, and peer configurations. Updated README with step-by-step instructions for setting up a TSN node, deploying it, and optionally becoming a validator.
@outerlook outerlook changed the title docs: new node operator documentation feat(docs): new node operator documentation Aug 9, 2024
@outerlook outerlook self-assigned this Aug 9, 2024
Renamed Kwil Node Operator to TSN Node and updated configuration instructions accordingly. Added details on specifying the genesis file and other network configurations.
Update the staging network nodes CSV to include a new column for node CometBFT ID.
Replaced `--config` with `--root-dir` in the deployment command.
@markholdex
Copy link

@outerlook do we need to specify anything related to the download of prerequisites? When can we review this PR?

@markholdex
Copy link

I would like to merge this PR if there is nothing else we can add at this stage. And if something will be reported, we can add it later.

@outerlook
Copy link
Collaborator Author

Alright! Im in transit now, I'd just do a final check while testing. However, we can create an issue later if I find any

@outerlook outerlook marked this pull request as ready for review August 15, 2024 16:55
@outerlook
Copy link
Collaborator Author

Oh wait, there are conflicts. I'll resolve them soon

@outerlook outerlook requested review from a team and removed request for a team August 15, 2024 17:26
@outerlook outerlook requested a review from a team August 15, 2024 17:30
Copy link

@KwilLuke KwilLuke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @outerlook,

Overall, I think this looks pretty good. In my opinion, the main area for improvement is making the instructions clearer about the correct P2P address a new node operator should use when setting up their peer nodes.

For some reason, I could not sync a node using the domain names; however, I could sync a node using the current tsn nodes' IP addresses.

Once we resolve the domain name versus IP address question, we can proceed with setting up our node in Kwil's cloud account and adding that node as a validator.

README.md Show resolved Hide resolved
docs/creating-config.md Outdated Show resolved Hide resolved
docs/creating-config.md Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/creating-config.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/creating-config.md Show resolved Hide resolved
docs/creating-config.md Outdated Show resolved Hide resolved
Copy link

pr-time-tracker bot commented Aug 15, 2024

@KwilLuke
⚠️⚠️⚠️
You must submit the time spent on this PR.
⚠️⚠️⚠️

Moved custom PostgreSQL setup instructions and peer configuration to more appropriate sections for better readability. Updated example commands to include persistent peers configuration, ensuring consistency and clarity in the documentation.
Expanded the setup section to include specific commands for generating initial configuration using `kwil-admin`. Improved clarity by defining the Truflation Stream Network and updating labels accordingly.
@outerlook
Copy link
Collaborator Author

Thank you for the comments @KwilLuke, I highly appreciate them! Just some of these conversations are pending now.

about the domain issue:
the specified endpoints were wrong:

- staging.node-2.tsn.truflation.com
+ staging.node-2.tsn.test.truflation.com

now they are fixed.

related to trufnetwork/node#446

Copy link
Contributor

@MicBun MicBun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice one, will be merged once the previous conversation has been acknowledged.

@MicBun MicBun enabled auto-merge (squash) August 16, 2024 19:10
@MicBun MicBun merged commit 5d4e354 into main Aug 16, 2024
3 of 4 checks passed
@MicBun MicBun deleted the docs/validator-guide branch August 16, 2024 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Problem: Node operators don't know how to connect to TSN
4 participants