From a68e812753138db97ab1eae67765d20f3066e802 Mon Sep 17 00:00:00 2001 From: Filip Djokic Date: Wed, 11 Dec 2024 13:14:39 +0100 Subject: [PATCH] docs: Add more details for the upgrade instructions --- docs/upgrades/propose-software-upgrade.md | 43 +++++++++++++++++++---- 1 file changed, 37 insertions(+), 6 deletions(-) diff --git a/docs/upgrades/propose-software-upgrade.md b/docs/upgrades/propose-software-upgrade.md index 2533f7d..2a86b2b 100644 --- a/docs/upgrades/propose-software-upgrade.md +++ b/docs/upgrades/propose-software-upgrade.md @@ -94,18 +94,23 @@ Also, deposits should be refunded back to the operators. ## Upgrade -After getting proposal status as passed, upgrade plan will be active. It can be requested by: +After the proposal status is marked as passed, the upgrade plan will become active. You can query the upgrade plan details using the following command: + +```bash +cheqd-noded query upgrade plan --chain-id cheqd-mainnet-1 +``` + +This will return output similar to: ```bash -$ cheqd-noded query upgrade plan --chain-id cheqd -testnet-2 0 [19:06:50] height: "1000" info: "" name: ``` -It means, that at height 1000 `BeginBlocker` will be set and node will be out of consensus and wait for moving to the new version of application. +At block height 1000, the `BeginBlocker` will be triggered. At this point, the node will be out of consensus, awaiting the upgrade to the new version. -It will be stopped and the next messages in log are expected: +The log messages like these should be expected: ```bash 5:17PM ERR UPGRADE "" NEEDED at height: 1000: @@ -113,6 +118,32 @@ It will be stopped and the next messages in log are expected: panic: UPGRADE "" NEEDED at height: 1000: ``` -After setting up new version of application node will continue ordering process. +Once the new application version is installed and running and 1/3 of the voting power on the network is restored, the node will resume normal operations. + +### Automatic upgrades with Cosmovisor + +If your node is configured to use **Cosmovisor**, the upgrade action will be performed **automatically** at the specified block height. + +To check if your node is configured to run with Cosmovisor, run the following command: + +```bash +systemctl status cheqd-cosmovisor.service +``` + +If there's a running systemd service, running this sub-process `/usr/bin/cosmovisor run start`, then your node is using Cosmovisor. + +### Manual Upgrades for Standalone Nodes + +For **standalone nodes**, follow the instructions in [our installation guide](../setup-and-configure/README.md). Make sure to choose the release suggested in the software upgrade proposal. + +### Node Built from Source Code + +If you are running a node built from source, you will need to: + +1. Refer to the upgrade proposal details. +2. Check out the **git tag** corresponding to the latest release. This is important in cases code in our **main** branch doesn't match the latest release. +3. Build the updated binary. + +### Docker Users -Instructions on setting up a new node/version can be found in [our installation guide](../setup-and-configure/README.md). +Additionally, we're also publishing the docker images in our [GitHub Container Registry](https://github.com/cheqd/cheqd-node/pkgs/container/cheqd-node), so in case you're running cheqd node in Docker, you can always find the latest image there.