docs: Update Cosmovisor README.md (#10284)
<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description Changes discussed on the call with @robert-zaremba Closes: #XXXX <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> --- ### 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 [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] 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 [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
This commit is contained in:
parent
1d1fcc9d20
commit
2135de9d17
|
@ -30,6 +30,29 @@ To install the latest version of `cosmovisor`, run the following command:
|
|||
go install github.com/cosmos/cosmos-sdk/cosmovisor/cmd/cosmovisor@latest
|
||||
```
|
||||
|
||||
To install a previous version, you can specify the version. IMPORTANT: Chains that use Cosmos-SDK v0.42.x and want to use auto-download feature MUST use Cosmovisor v0.1.0
|
||||
|
||||
```
|
||||
go install github.com/cosmos/cosmos-sdk/cosmovisor/cmd/cosmovisor@v0.1.0
|
||||
```
|
||||
|
||||
It is possible to confirm the version of cosmovisor when using Cosmovisor v1.0.0, but it is not possible to do so with `v0.1.0`.
|
||||
|
||||
You can also install from source by pulling the cosmos-sdk repository and switching to the correct version and building as follows:
|
||||
|
||||
```
|
||||
git clone git@github.com:cosmos/cosmos-sdk
|
||||
cd cosmos-sdk
|
||||
git checkout cosmovisor/vx.x.x
|
||||
cd cosmovisor
|
||||
make
|
||||
```
|
||||
This will build cosmovisor in your current directory. Afterwards you may want to put it into your machine's PATH like as follows:
|
||||
|
||||
```
|
||||
cp cosmovisor ~/go/bin/cosmovisor
|
||||
```
|
||||
|
||||
*Note: If you are using go `v1.15` or earlier, you will need to use `go get`, and you may want to run the command outside a project directory.*
|
||||
|
||||
### Command Line Arguments And Environment Variables
|
||||
|
@ -128,6 +151,35 @@ If `DAEMON_ALLOW_DOWNLOAD_BINARIES` is set to `true`, and no local binary can be
|
|||
}
|
||||
```
|
||||
|
||||
You can include multiple binaries at once to ensure more than one environment will receive the correct binaries:
|
||||
|
||||
```json
|
||||
{
|
||||
"binaries": {
|
||||
"linux/amd64":"https://example.com/gaia.zip?checksum=sha256:aec070645fe53ee3b3763059376134f058cc337247c978add178b6ccdfb0019f",
|
||||
"linux/arm64":"https://example.com/gaia.zip?checksum=sha256:aec070645fe53ee3b3763059376134f058cc337247c978add178b6ccdfb0019f",
|
||||
"darwin/amd64":"https://example.com/gaia.zip?checksum=sha256:aec070645fe53ee3b3763059376134f058cc337247c978add178b6ccdfb0019f"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
When submitting this as a proposal ensure there are no spaces. An example command using `gaiad` could look like:
|
||||
|
||||
```
|
||||
> gaiad tx gov submit-proposal software-upgrade Vega \
|
||||
--title Vega \
|
||||
--deposit 100uatom \
|
||||
--upgrade-height 7368420 \
|
||||
--upgrade-info '{"binaries":{"linux/amd64":"https://github.com/cosmos/gaia/releases/download/v6.0.0-rc1/gaiad-v6.0.0-rc1-linux-amd64","linux/arm64":"https://github.com/cosmos/gaia/releases/download/v6.0.0-rc1/gaiad-v6.0.0-rc1-linux-arm64","darwin/amd64":"https://github.com/cosmos/gaia/releases/download/v6.0.0-rc1/gaiad-v6.0.0-rc1-darwin-amd64"}}' \
|
||||
--description "upgrade to Vega" \
|
||||
--gas 400000 \
|
||||
--from user \
|
||||
--chain-id test \
|
||||
--home test/val2 \
|
||||
--node tcp://localhost:36657 \
|
||||
--yes
|
||||
```
|
||||
|
||||
2. Store a link to a file that contains all information in the above format (e.g. if you want to specify lots of binaries, changelog info, etc. without filling up the blockchain). For example:
|
||||
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue