forked from osmosis-labs/osmosis
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: release notes for v26 (osmosis-labs#8693) (osmosis-labs#8695)
* chore: release notes for v26 * chore: release notes for v26 rename binary json file (cherry picked from commit 543b131) Co-authored-by: PaddyMc <[email protected]>
- Loading branch information
1 parent
f14820a
commit dd64424
Showing
2 changed files
with
123 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
# Mainnet Upgrade Guide: From Version v25 to v26 | ||
|
||
## Overview | ||
|
||
- **v26 Proposal**: [Proposal Page](https://www.mintscan.io/osmosis/proposals/TODO) | ||
- **v26 Upgrade Block Height**: TODO | ||
- **v26 Upgrade Countdown**: [Block Countdown](https://www.mintscan.io/osmosis/blocks/TODO) | ||
|
||
## Hardware Requirements | ||
|
||
### Memory Specifications | ||
|
||
Although this upgrade is not expected to be resource-intensive, a minimum of 64GB of RAM is advised. If you cannot meet this requirement, setting up a swap space is recommended. | ||
|
||
#### Configuring Swap Space | ||
|
||
*Execute these commands to set up a 32GB swap space*: | ||
|
||
```sh | ||
sudo swapoff -a | ||
sudo fallocate -l 32G /swapfile | ||
sudo chmod 600 /swapfile | ||
sudo mkswap /swapfile | ||
sudo swapon /swapfile | ||
``` | ||
|
||
*To ensure the swap space persists after reboot*: | ||
|
||
```sh | ||
sudo cp /etc/fstab /etc/fstab.bak | ||
echo '/swapfile none swap sw 0 0' | sudo tee -a /etc/fstab | ||
``` | ||
|
||
For an in-depth guide on swap configuration, please refer to [this tutorial](https://www.digitalocean.com/community/tutorials/how-to-add-swap-space-on-ubuntu-20-04). | ||
|
||
--- | ||
|
||
## Cosmovisor Configuration | ||
|
||
### Initial Setup (For First-Time Users) | ||
|
||
If you have not previously configured Cosmovisor, follow this section; otherwise, proceed to the next section. | ||
|
||
Cosmovisor is strongly recommended for validators to minimize downtime during upgrades. It automates the binary replacement process according to on-chain `SoftwareUpgrade` proposals. | ||
|
||
Documentation for Cosmovisor can be found [here](https://docs.cosmos.network/main/tooling/cosmovisor). | ||
|
||
#### Installation Steps | ||
|
||
*Run these commands to install and configure Cosmovisor*: | ||
|
||
```sh | ||
go install github.com/cosmos/cosmos-sdk/cosmovisor/cmd/[email protected] | ||
mkdir -p ~/.osmosisd | ||
mkdir -p ~/.osmosisd/cosmovisor | ||
mkdir -p ~/.osmosisd/cosmovisor/genesis | ||
mkdir -p ~/.osmosisd/cosmovisor/genesis/bin | ||
mkdir -p ~/.osmosisd/cosmovisor/upgrades | ||
cp $GOPATH/bin/osmosisd ~/.osmosisd/cosmovisor/genesis/bin | ||
mkdir -p ~/.osmosisd/cosmovisor/upgrades/v25/bin | ||
cp $GOPATH/bin/osmosisd ~/.osmosisd/cosmovisor/upgrades/v25/bin | ||
``` | ||
|
||
*Add these lines to your profile to set up environment variables*: | ||
|
||
```sh | ||
echo "# Cosmovisor Setup" >> ~/.profile | ||
echo "export DAEMON_NAME=osmosisd" >> ~/.profile | ||
echo "export DAEMON_HOME=$HOME/.osmosisd" >> ~/.profile | ||
echo "export DAEMON_ALLOW_DOWNLOAD_BINARIES=false" >> ~/.profile | ||
echo "export DAEMON_LOG_BUFFER_SIZE=512" >> ~/.profile | ||
echo "export DAEMON_RESTART_AFTER_UPGRADE=true" >> ~/.profile | ||
echo "export UNSAFE_SKIP_BACKUP=true" >> ~/.profile | ||
source ~/.profile | ||
``` | ||
|
||
### Upgrading to v26 | ||
|
||
*To prepare for the upgrade, execute these commands*: | ||
|
||
```sh | ||
mkdir -p ~/.osmosisd/cosmovisor/upgrades/v26/bin | ||
cd $HOME/osmosis | ||
git pull | ||
git checkout v26.0.0 | ||
make build | ||
cp build/osmosisd ~/.osmosisd/cosmovisor/upgrades/v26/bin | ||
``` | ||
|
||
At the designated block height, Cosmovisor will automatically upgrade to version v26. | ||
|
||
--- | ||
|
||
## Manual Upgrade Procedure | ||
|
||
Follow these steps if you opt for a manual upgrade: | ||
|
||
1. Monitor Osmosis until it reaches the specified upgrade block height: TODO. | ||
2. Observe for a panic message followed by continuous peer logs, then halt the daemon. | ||
3. Perform these steps: | ||
|
||
```sh | ||
cd $HOME/osmosis | ||
git pull | ||
git checkout v26.0.0 | ||
make install | ||
``` | ||
|
||
4. Restart the Osmosis daemon and observe the upgrade. | ||
|
||
--- | ||
|
||
## Additional Resources | ||
|
||
- Osmosis Documentation: [Website](https://docs.osmosis.zone) | ||
- Community Support: [Discord](https://discord.gg/pAxjcFnAFH) | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"binaries": { | ||
"linux/amd64": "TODO", | ||
"linux/arm64": "TODO" | ||
} | ||
} |