[Documentation] Cosmovisor #768

okdas · 2024-08-28T22:41:31Z

Summary

Adds documentation on how to deploy a Validator and a Full Node using Cosmovisor.

Issue

[Documentation] More ways to deploy poktrolld #526

Type of change

Select one or more:

Testing

Documentation: make docusaurus_start; only needed if you make doc changes
Unit Tests: make go_develop_and_test
LocalNet E2E Tests: make test_e2e
DevNet E2E Tests: Add the devnet-test-e2e label to the PR.

Sanity Checklist

I have tested my changes using the available tooling
I have commented my code
I have performed a self-review of my own code; both comments & source code
I create and reference any new tickets, if applicable
I have left TODOs throughout the codebase, if applicable

tools/installer/full-node.sh

docusaurus/docs/operate/run_a_node/full_node_cosmovisor.md

okdas · 2024-08-30T18:33:13Z

Note for the reviewer:

The URL of the script is not live until this is merged. Use https://raw.githubusercontent.com/pokt-network/poktroll/dk-docs/tools/installer/full-node.sh if you want to pull the script from this branch;
Similarly, the config changes are not live until the PR is merged, and the release is cut. In order for the node to start successfully, the min-gas-prices needs to be adjusted in app.toml. With this code, that will become the default value when we provision the configs. I have not performed much research on what this value should be but left a TODO_MAINNET for this and other values.

okdas · 2024-09-04T22:57:14Z

Added cosmovisor to container images in #796.

Olshansk

Pushed some changes and leaving some comments.

Great job!

cmd/poktrolld/cmd/config.go

config.yml

cmd/poktrolld/cmd/config.go

tools/installer/full-node.sh

Olshansk

A couple small comments but looks good otherwise.

Olshansk · 2024-09-06T22:59:08Z

cmd/poktrolld/cmd/config.go

+// The code below changes how the default configuration files are rendered on `poktrolld init` command. This command
+// is often used by the validator and full node runners to provision the configuration prior to starting the node.
+// These are the values **WE WANT** participants to have. This doesn't guarantee the node runners won't adjust the values
+// but it helps making sure most of them are using the following configuration.


Suggested change

// but it helps making sure most of them are using the following configuration.

// but it helps ensure most of them are using the same configuration; as a baseline.

Olshansk · 2024-09-06T22:59:57Z

cmd/poktrolld/cmd/config.go

+// is often used by the validator and full node runners to provision the configuration prior to starting the node.
+// These are the values **WE WANT** participants to have. This doesn't guarantee the node runners won't adjust the values
+// but it helps making sure most of them are using the following configuration.
+// Worth noting that changing these values in the future won't magically update them in the existing configuration,


I'm not completely sure what you mean by this sentence. Please update or delete.

Pushed the new version that I think better explains what's going on.

I'll merge it, but if you don't like it for some reason, please let me know and I'll address.

Thank you for your review!

…ke-transfer * pokt/main: [Tooling, Code Health] refactor: split Makefile into multiple files (#816) [Tooling] fix and add makefile targets (#814) [Docs] Add a debugging tip: using transaction hashes (#786) [Refactor] Replace embedded Service with ServiceId (#802) [Session,Service] Ensure SessionHeader and Service basic validation. (#782) [Tokenomics] Preparation for Global Mint Reimbursement Request (#755) [Quick PR][LocalNet] Turn off minimum-gas-prices (#805) [GATEWAY POC] A couple helpers to help deploy a PATH gateway (#801) [Documentation] Cosmovisor (#768) [CI] Add cosmovisor to container images (#796) Use a descriptive error if service ID is not found (#787) [SessionManager] Implement off-chain proof params usage (#765) [SDK] Update shannon sdk dependency (#800) [E2E Test] Remove redundant logging (#798)

…actor/transfer-msg_period-param * issues/657/feat/app-stake-transfer: [Tooling, Code Health] refactor: split Makefile into multiple files (#816) [Tooling] fix and add makefile targets (#814) [Docs] Add a debugging tip: using transaction hashes (#786) [Refactor] Replace embedded Service with ServiceId (#802) [Session,Service] Ensure SessionHeader and Service basic validation. (#782) [Tokenomics] Preparation for Global Mint Reimbursement Request (#755) [Quick PR][LocalNet] Turn off minimum-gas-prices (#805) [GATEWAY POC] A couple helpers to help deploy a PATH gateway (#801) [Documentation] Cosmovisor (#768) [CI] Add cosmovisor to container images (#796) Use a descriptive error if service ID is not found (#787) [SessionManager] Implement off-chain proof params usage (#765) [SDK] Update shannon sdk dependency (#800) [E2E Test] Remove redundant logging (#798)

…ues/657/chore/app-transfer-period * issues/657/refactor/transfer-msg_period-param: [Tooling, Code Health] refactor: split Makefile into multiple files (#816) [Tooling] fix and add makefile targets (#814) [Docs] Add a debugging tip: using transaction hashes (#786) [Refactor] Replace embedded Service with ServiceId (#802) [Session,Service] Ensure SessionHeader and Service basic validation. (#782) [Tokenomics] Preparation for Global Mint Reimbursement Request (#755) [Quick PR][LocalNet] Turn off minimum-gas-prices (#805) [GATEWAY POC] A couple helpers to help deploy a PATH gateway (#801) [Documentation] Cosmovisor (#768) [CI] Add cosmovisor to container images (#796) Use a descriptive error if service ID is not found (#787) [SessionManager] Implement off-chain proof params usage (#765) [SDK] Update shannon sdk dependency (#800) [E2E Test] Remove redundant logging (#798)

Cosmovisor docs

907833b

okdas added the documentation Improvements or additions to documentation label Aug 28, 2024

okdas added this to the Shannon Beta TestNet Launch milestone Aug 28, 2024

okdas self-assigned this Aug 28, 2024

okdas added 10 commits August 29, 2024 17:55

more docs updates & configs

a1d6c4d

update links

70495bb

--wip-- [skip ci]

ae5ca6f

--wip-- [skip ci]

aded1f8

--wip-- [skip ci]

1464977

--wip-- [skip ci]

456bd97

--wip-- [skip ci]

35feee1

redundant comment

b321d27

Merge remote-tracking branch 'origin/main' into dk-docs

be4def8

resolve conflicts

c86ff04

github-actions bot reviewed Aug 30, 2024

View reviewed changes

tools/installer/full-node.sh Show resolved Hide resolved

okdas commented Aug 30, 2024

View reviewed changes

docusaurus/docs/operate/run_a_node/full_node_cosmovisor.md Outdated Show resolved Hide resolved

okdas marked this pull request as ready for review August 30, 2024 18:30

okdas requested a review from Olshansk August 30, 2024 18:30

adjust the docs a little

353fe44

okdas mentioned this pull request Sep 4, 2024

[Foundation] Add constant gas fees #794

Open

6 tasks

okdas added 2 commits September 4, 2024 12:26

new defaults

60745e9

Set min has prices on localnet

5955972

Olshansk added 2 commits September 5, 2024 14:18

Merge branch 'main' into dk-docs

23794be

Review #768

e9182e7

Olshansk requested changes Sep 5, 2024

View reviewed changes

okdas added 3 commits September 6, 2024 12:40

--wip-- [skip ci]

3a85b8b

update wording more

02366a3

Merge remote-tracking branch 'origin/main' into dk-docs

1748b83

spellcheck

7d5c12d

okdas requested a review from Olshansk September 6, 2024 20:29

Olshansk approved these changes Sep 6, 2024

View reviewed changes

change wording a bit

d3de458

okdas merged commit 5ee73d4 into main Sep 9, 2024
11 of 12 checks passed

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Documentation] Cosmovisor #768

[Documentation] Cosmovisor #768

okdas commented Aug 28, 2024

okdas commented Aug 30, 2024 •

edited

Loading

okdas commented Sep 4, 2024

Olshansk left a comment

Olshansk left a comment

Olshansk Sep 6, 2024

Olshansk Sep 6, 2024

okdas Sep 9, 2024

	// but it helps making sure most of them are using the following configuration.
	// but it helps ensure most of them are using the same configuration; as a baseline.

[Documentation] Cosmovisor #768

[Documentation] Cosmovisor #768

Conversation

okdas commented Aug 28, 2024

Summary

Issue

Type of change

Testing

Sanity Checklist

okdas commented Aug 30, 2024 • edited Loading

okdas commented Sep 4, 2024

Olshansk left a comment

Choose a reason for hiding this comment

Olshansk left a comment

Choose a reason for hiding this comment

Olshansk Sep 6, 2024

Choose a reason for hiding this comment

Olshansk Sep 6, 2024

Choose a reason for hiding this comment

okdas Sep 9, 2024

Choose a reason for hiding this comment

okdas commented Aug 30, 2024 •

edited

Loading