docs: add chain upgrade guide v0.43 #9567

ryanchristo · 2021-06-23T04:29:47Z

Description

This pull request adds a chain upgrade guide and example for v0.43. This pull request also removes migration documentation specific to v0.42 and adds links to v0.42 documentation when referencing genesis migrations.

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

included the correct docs: prefix in the PR title
targeted the correct branch (see PR Targeting)
provided a link to the relevant issue or specification - n/a
followed the documentation writing guidelines
reviewed "Files changed" and left comments if necessary
confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

confirmed the correct docs: prefix in the PR title
confirmed all author checklist items have been addressed
confirmed that this PR only changes documentation
reviewed content for consistency
reviewed content for thoroughness
reviewed content for spelling and grammar
tested instructions (if applicable)

ryanchristo · 2021-07-02T17:45:03Z

This will need to be updated to reflect the decision made in #9616.

clevinson

Pending updates re #9616, this looks good!

One question I had was around the terminology of "genesis binary" in cosmovisor. Seem a bit confusing to me, but maybe its just something we need to stick with for now and should file an issue separately if we deem its worth upgrading terminology?

clevinson · 2021-07-06T13:43:24Z

cosmovisor/README.md


 `cosmovisor` reads its configuration from environment variables:

-* `DAEMON_HOME` is the location where the `cosmovisor/` directory is kept that contains the upgrade binaries (e.g. `$HOME/.gaiad`, `$HOME/.regend`, `$HOME/.simd`, etc.).
+* `DAEMON_HOME` is the location where the `cosmovisor/` directory is kept that contains the genesis binary, the upgrade binaries, and any additional auxiliary files associated with each binary (e.g. `$HOME/.gaiad`, `$HOME/.regend`, `$HOME/.simd`, etc.).


Suggested change

* `DAEMON_HOME` is the location where the `cosmovisor/` directory is kept that contains the genesis binary, the upgrade binaries, and any additional auxiliary files associated with each binary (e.g. `$HOME/.gaiad`, `$HOME/.regend`, `$HOME/.simd`, etc.).

* `DAEMON_HOME` is the location where the `cosmovisor/` directory is kept that contains the source binary, the upgrade binaries, and any additional auxiliary files associated with each binary (e.g. `$HOME/.gaiad`, `$HOME/.regend`, `$HOME/.simd`, etc.).

I don't think we should the old one "genesis binary" maybe "source binary" or "original binary" is better? Genesis implies it has been the binary since genesis of the chain, but this may not be the case if we're doing the Nth upgrade of a given chain using cosmovisor.

I think it would make sense to change the name to "source binary" but this would also need to be changed within cosmovisor because cosmovisor is currently set up to read the binary from the genesis/bin directory. Maybe we can update this in cosmovisor and then here in the documentation. Let's double check with @robert-zaremba on our daily sync tomorrow.

@robert-zaremba recommended that we keep "genesis binary" and that we instruct node operators to add an "upgrade binary" and point the current link to the "upgrade binary" instead of changing the name "genesis binary". Leaving this as is but will update the upgrade guide.

clevinson · 2021-07-06T13:45:58Z

cosmovisor/README.md

-Each version of the Cosmos SDK application is stored under either `genesis` or `upgrades/<name>`, which holds `bin/$DAEMON_NAME` along with any other needed files such as auxiliary client programs or libraries. `current` is a symbolic link to the currently active folder and `current/bin/$DAEMON_NAME` is the currently active binary.
-
-*Note: The `name` variable in `upgrades/<name>` holds the URI-encoded name of the upgrade as specified in the upgrade module plan.*
+The `cosmovisor/` directory incudes a subdirectory for each version of the application (i.e. `genesis` or `upgrades/<name>`). Within each subdirectory is the application binary (i.e. `bin/$DAEMON_NAME`) and any additional auxiliary files associated with each binary. `current` is a symbolic link to the currently active directory (i.e `genesis` or `upgrades/<name>`). The `name` variable in `upgrades/<name>` is the URI-encoded name of the upgrade as specified in the upgrade module plan.


hmm... maybe its that I haven't used cosmovisor as much before. I'm confused by the use of "genesis binary" terminology here. A good example is the upcoming Cosmos Hub v0.43 upgrade (whenever it happens...). Validators are expected to use cosmovisor for this. Will the existing binary be in the 'genesis' folder?

Yup, as mentioned above, I think it would make sense to make this change but let's double check with @robert-zaremba and then update cosmovisor to read from a source/bin directory rather than a genesis/bin directory.

As mentioned above, we will keep "genesis binary" and instruct node operators to add an "upgrade binary" and point the current link to the "upgrade binary" instead of changing the name "genesis binary". Leaving this as is but will update the upgrade guide.

docs/migrations/chain-upgrade-guide-043.md

amaury1093 · 2021-07-13T10:27:23Z

Looks good to me @ryanchristo, thanks! I left a couple of small comments.

alexanderbez

Looks great so far 👍

Co-authored-by: Amaury <[email protected]>

orijbot · 2021-07-13T20:17:36Z

Visit https://dashboard.github.orijtech.com?pr=9567&repo=cosmos%2Fcosmos-sdk to see benchmark details.

amaury1093

lgtm 👍

ryanchristo · 2021-07-19T16:07:36Z

@Mergifyio backport release/v0.43.x

## Description  This pull request adds a chain upgrade guide and example for v0.43. This pull request also removes migration documentation specific to v0.42 and adds links to v0.42 documentation when referencing genesis migrations. --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct `docs:` prefix in the PR title - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - n/a - [x] followed the [documentation writing guidelines](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOC_WRITING_GUIDELINES.md) - [x] reviewed "Files changed" and left comments if necessary - [x] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [x] confirmed the correct `docs:` prefix in the PR title - [x] confirmed all author checklist items have been addressed - [ ] confirmed that this PR only changes documentation - [ ] reviewed content for consistency - [ ] reviewed content for thoroughness - [ ] reviewed content for spelling and grammar - [ ] tested instructions (if applicable) (cherry picked from commit 6098d7e) # Conflicts: # cosmovisor/README.md

mergify · 2021-07-19T16:08:24Z

Command backport release/v0.43.x: success

Backports have been created

#9725 docs: add chain upgrade guide v0.43 (backport #9567) has been created for branch release/v0.43.x

* docs: add chain upgrade guide v0.43 (#9567) ## Description  This pull request adds a chain upgrade guide and example for v0.43. This pull request also removes migration documentation specific to v0.42 and adds links to v0.42 documentation when referencing genesis migrations. --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct `docs:` prefix in the PR title - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - n/a - [x] followed the [documentation writing guidelines](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOC_WRITING_GUIDELINES.md) - [x] reviewed "Files changed" and left comments if necessary - [x] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [x] confirmed the correct `docs:` prefix in the PR title - [x] confirmed all author checklist items have been addressed - [ ] confirmed that this PR only changes documentation - [ ] reviewed content for consistency - [ ] reviewed content for thoroughness - [ ] reviewed content for spelling and grammar - [ ] tested instructions (if applicable) (cherry picked from commit 6098d7e) # Conflicts: # cosmovisor/README.md * resolve conflicts Co-authored-by: Ryan Christoffersen <[email protected]> Co-authored-by: ryanchrypto <[email protected]>

* docs: add chain upgrade guide v0.43 (cosmos#9567) ## Description  This pull request adds a chain upgrade guide and example for v0.43. This pull request also removes migration documentation specific to v0.42 and adds links to v0.42 documentation when referencing genesis migrations. --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct `docs:` prefix in the PR title - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - n/a - [x] followed the [documentation writing guidelines](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOC_WRITING_GUIDELINES.md) - [x] reviewed "Files changed" and left comments if necessary - [x] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [x] confirmed the correct `docs:` prefix in the PR title - [x] confirmed all author checklist items have been addressed - [ ] confirmed that this PR only changes documentation - [ ] reviewed content for consistency - [ ] reviewed content for thoroughness - [ ] reviewed content for spelling and grammar - [ ] tested instructions (if applicable) (cherry picked from commit 6098d7e) # Conflicts: # cosmovisor/README.md * resolve conflicts Co-authored-by: Ryan Christoffersen <[email protected]> Co-authored-by: ryanchrypto <[email protected]>

ryanchristo added 3 commits June 22, 2021 21:28

docs: chain upgrade guide v0.43

765b2cc

update upgrade guide

34fa666

update cosmovisor readme

cc8056b

github-actions bot added the C:Cosmovisor Issues and PR related to Cosmovisor label Jun 24, 2021

ryanchristo added 4 commits June 25, 2021 12:00

update/remove migration docs

558335f

update chain upgrade guide

078fb31

more fixes and updates

a568129

minor fixes

9986acf

ryanchristo marked this pull request as ready for review June 28, 2021 15:43

ryanchristo requested review from aaronc and alexanderbez as code owners June 28, 2021 15:43

ryanchristo requested review from robert-zaremba, amaury1093 and clevinson June 28, 2021 15:44

clevinson self-assigned this Jun 30, 2021

ryanchristo mentioned this pull request Jun 30, 2021

Remove Legacy REST documentation #9615

Closed

4 tasks

ryanchristo marked this pull request as draft July 2, 2021 18:50

clevinson approved these changes Jul 7, 2021

View reviewed changes

amaury1093 reviewed Jul 13, 2021

View reviewed changes

alexanderbez reviewed Jul 13, 2021

View reviewed changes

ryanchristo and others added 4 commits July 13, 2021 11:29

Update docs/migrations/chain-upgrade-guide-043.md

53bd15f

Co-authored-by: Amaury <[email protected]>

Update docs/migrations/chain-upgrade-guide-043.md

728f5a9

Co-authored-by: Amaury <[email protected]>

address comments

d3e58ed

Merge branch 'master' into ryan/docs-chain-upgrade

305876d

amaury1093 approved these changes Jul 19, 2021

View reviewed changes

amaury1093 added A:automerge Automatically merge PR once all prerequisites pass. and removed A:automerge Automatically merge PR once all prerequisites pass. labels Jul 19, 2021

ryanchristo marked this pull request as ready for review July 19, 2021 14:49

Merge branch 'master' into ryan/docs-chain-upgrade

234de88

amaury1093 added the A:automerge Automatically merge PR once all prerequisites pass. label Jul 19, 2021

Merge branch 'master' into ryan/docs-chain-upgrade

a2e9d33

mergify bot merged commit 6098d7e into master Jul 19, 2021

mergify bot deleted the ryan/docs-chain-upgrade branch July 19, 2021 15:35

mergify bot mentioned this pull request Jul 19, 2021

docs: add chain upgrade guide v0.43 (backport #9567) #9725

Merged

fedekunze mentioned this pull request Nov 14, 2021

all: cherry pick olympus mons tharsis/cosmos-sdk#1

Closed

19 tasks

naiba4 mentioned this pull request Dec 14, 2023

[Snyk] Fix for 1 vulnerabilities naiba4/cosmos-sdk#5

Open

stefan-thothmind mentioned this pull request Dec 14, 2023

[Snyk] Fix for 1 vulnerabilities stefan-thothmind/cosmos-sdk#15

Open

keylogic1 mentioned this pull request Dec 15, 2023

[Snyk] Fix for 1 vulnerabilities neutron-org/cosmos-sdk#12

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add chain upgrade guide v0.43 #9567

docs: add chain upgrade guide v0.43 #9567

ryanchristo commented Jun 23, 2021 •

edited

Loading

ryanchristo commented Jul 2, 2021

clevinson left a comment •

edited

Loading

clevinson Jul 6, 2021

ryanchristo Jul 8, 2021

ryanchristo Jul 14, 2021

clevinson Jul 6, 2021

ryanchristo Jul 8, 2021

ryanchristo Jul 14, 2021

amaury1093 commented Jul 13, 2021

alexanderbez left a comment

orijbot commented Jul 13, 2021

amaury1093 left a comment

ryanchristo commented Jul 19, 2021

mergify bot commented Jul 19, 2021

	* `DAEMON_HOME` is the location where the `cosmovisor/` directory is kept that contains the genesis binary, the upgrade binaries, and any additional auxiliary files associated with each binary (e.g. `$HOME/.gaiad`, `$HOME/.regend`, `$HOME/.simd`, etc.).
	* `DAEMON_HOME` is the location where the `cosmovisor/` directory is kept that contains the source binary, the upgrade binaries, and any additional auxiliary files associated with each binary (e.g. `$HOME/.gaiad`, `$HOME/.regend`, `$HOME/.simd`, etc.).

docs: add chain upgrade guide v0.43 #9567

docs: add chain upgrade guide v0.43 #9567

Conversation

ryanchristo commented Jun 23, 2021 • edited Loading

Description

Author Checklist

Reviewers Checklist

ryanchristo commented Jul 2, 2021

clevinson left a comment • edited Loading

Choose a reason for hiding this comment

clevinson Jul 6, 2021

Choose a reason for hiding this comment

ryanchristo Jul 8, 2021

Choose a reason for hiding this comment

ryanchristo Jul 14, 2021

Choose a reason for hiding this comment

clevinson Jul 6, 2021

Choose a reason for hiding this comment

ryanchristo Jul 8, 2021

Choose a reason for hiding this comment

ryanchristo Jul 14, 2021

Choose a reason for hiding this comment

amaury1093 commented Jul 13, 2021

alexanderbez left a comment

Choose a reason for hiding this comment

orijbot commented Jul 13, 2021

amaury1093 left a comment

Choose a reason for hiding this comment

ryanchristo commented Jul 19, 2021

mergify bot commented Jul 19, 2021

ryanchristo commented Jun 23, 2021 •

edited

Loading

clevinson left a comment •

edited

Loading