docs: chain upgrade procedure, for operators #4097
Merged
+97
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 tasks
cratelyn
added
A-docs
|
Also closes #1812. |
erwanor
reviewed
Mar 25, 2024
| The value after `now=` is what should be copied. In practice, for testnets, Penumbra Labs will advise on a genesis time | ||
| and provide that value in the documentation. Or should we just pick a genesis start ahead of time, and use that for all? | ||
| --> | ||
| 5. Apply the migration: `pd migrate --genesis-start "GENESIS_TIME" --target-directory ~/.penumbra/testnet_net/node0/pd-exported-state/ --migrate-archive ~/.penumbra/testnet_data/node0/pd-migrated-state-{{ #include ../penumbra_version.md }}.tar.gz`. |
There was a problem hiding this comment.
I think I would add a section about genesis time and explain that this is decided by validators/node runners, possibly via the governance proposal itself (non-binding, opt-in). And describe how genesis time works: if it is set in the future, the node will start and wait for the time of genesis to be reached before it can start producing blocks (and peering?).
Adds documentation for the specific steps to be performed by a node operator in order to participate in a chain upgrade. These docs are largely based on the existing wiki notes [0], adapted for a generalized Penumbra setup. Similarly, sketched out some corresponding changes to the `pd testnet join` docs, but left them commented out for now: those docs are only relevant for joining a chain that has already been upgraded. If things go well with #4087, we'll uncomment those docs and start using them. Finishes and therefore closes #3841. [0] https://github.com/penumbra-zone/penumbra/wiki/Performing-upgrades
conorsch
force-pushed
the
docs-chain-upgrade
branch
from
4049a18
to
26544e0
Compare
|
Great comments, @erwanor, thanks for the deep read. I've amended the docs according to your suggestions. |
conorsch
added a commit
that referenced
this pull request
Apr 19, 2024
Follow-up to #4097. We performed a chain upgrade on Penumbra for v0.71.0. Based on feedback from the community validators, we've refined the procedure somewhat. Substantive changes to the docs are as follows: * backup the entire pd & cometbft data dirs, as a precaution * upgrade to new pd early, prior to running export, for simplicity's sake * only move the exported rocksdb directory, which allows preservation of other dirs in pd state, e.g. acme tls info * do not reset priv validator state * do not delete historical cometbft state data Not yet included in these docs are specifics about the upcoming release; we'll add those soon. Finishes and therefore closes #1812.
1 task
conorsch
added a commit
that referenced
this pull request
Apr 19, 2024
Follow-up to #4097. We performed a chain upgrade on Penumbra for v0.71.0. Based on feedback from the community validators, we've refined the procedure somewhat. Substantive changes to the docs are as follows: * backup the entire pd & cometbft data dirs, as a precaution * upgrade to new pd early, prior to running export, for simplicity's sake * only move the exported rocksdb directory, which allows preservation of other dirs in pd state, e.g. acme tls info * do not reset priv validator state Not yet included in these docs are specifics about the upcoming release; we'll add those soon. Finishes and therefore closes #1812.
conorsch
added a commit
that referenced
this pull request
Apr 19, 2024
Follow-up to #4097. We performed a chain upgrade on Penumbra for v0.71.0. Based on feedback from the community validators, we've refined the procedure somewhat. Substantive changes to the docs are as follows: * backup the entire pd & cometbft data dirs, as a precaution * upgrade to new pd early, prior to running export, for simplicity's sake * only move the exported rocksdb directory, which allows preservation of other dirs in pd state, e.g. acme tls info * do not reset priv validator state * use `cometbft reset-state` rather than a custom find command Not yet included in these docs are specifics about the upcoming release; we'll add those soon. Finishes and therefore closes #1812.
conorsch
added a commit
that referenced
this pull request
Apr 22, 2024
Follow-up to #4097. We performed a chain upgrade on Penumbra for v0.71.0. Based on feedback from the community validators, we've refined the procedure somewhat. Substantive changes to the docs are as follows: * backup the entire pd & cometbft data dirs, as a precaution * upgrade to new pd early, prior to running export, for simplicity's sake * only move the exported rocksdb directory, which allows preservation of other dirs in pd state, e.g. acme tls info * do not reset priv validator state * amend custom find command to preserve `tx_index.db` Not yet included in these docs are specifics about the upcoming release; we'll add those soon. Finishes and therefore closes #1812.
conorsch
added a commit
that referenced
this pull request
Apr 22, 2024
Follow-up to #4097. We performed a chain upgrade on Penumbra for v0.71.0. Based on feedback from the community validators, we've refined the procedure somewhat. Substantive changes to the docs are as follows: * backup the entire pd & cometbft data dirs, as a precaution * upgrade to new pd early, prior to running export, for simplicity's sake * only move the exported rocksdb directory, which allows preservation of other dirs in pd state, e.g. acme tls info * do not reset priv validator state * amend custom find command to preserve `tx_index.db` Not yet included in these docs are specifics about the upcoming release; we'll add those soon. Finishes and therefore closes #1812.
conorsch
added a commit
that referenced
this pull request
Apr 22, 2024
Follow-up to #4097. We performed a chain upgrade on Penumbra for v0.71.0. Based on feedback from the community validators, we've refined the procedure somewhat. Substantive changes to the docs are as follows: * backup the entire pd & cometbft data dirs, as a precaution * upgrade to new pd early, prior to running export, for simplicity's sake * only move the exported rocksdb directory, which allows preservation of other dirs in pd state, e.g. acme tls info * do not reset priv validator state * amend custom find command to preserve `tx_index.db` Not yet included in these docs are specifics about the upcoming release; we'll add those soon. Finishes and therefore closes #1812.
erwanor
pushed a commit
that referenced
this pull request
Apr 24, 2024
Follow-up to #4097. We performed a chain upgrade on Penumbra for v0.71.0. Based on feedback from the community validators, we've refined the procedure somewhat. Substantive changes to the docs are as follows: * backup the entire pd & cometbft data dirs, as a precaution * upgrade to new pd early, prior to running export, for simplicity's sake * only move the exported rocksdb directory, which allows preservation of other dirs in pd state, e.g. acme tls info * do not reset priv validator state * amend custom find command to preserve `tx_index.db` Not yet included in these docs are specifics about the upcoming release; we'll add those soon. Finishes and therefore closes #1812.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds documentation for the specific steps to be performed by a node operator in order to participate in a chain upgrade. These docs are largely based on the existing wiki notes [0], adapted for a generalized Penumbra setup.
Similarly, sketched out some corresponding changes to the
pd testnet joindocs, but left them commented out for now: those docs are only relevant for joining a chain that has already been upgraded. If things go well with #4087, we'll uncomment those docs and start using them.Finishes and therefore closes #3841.
[0] https://github.com/penumbra-zone/penumbra/wiki/Performing-upgrades