From 14cb68c72fac3788c256b326a42b497424f700f5 Mon Sep 17 00:00:00 2001 From: sacha Date: Mon, 15 Nov 2021 20:07:30 +0100 Subject: [PATCH] Book: upgrade / downgrade page (#3105) * cp * cp --- docs/the_nimbus_book/src/SUMMARY.md | 2 +- docs/the_nimbus_book/src/keep-updated.md | 48 +++++++++++++++++++++--- 2 files changed, 43 insertions(+), 7 deletions(-) diff --git a/docs/the_nimbus_book/src/SUMMARY.md b/docs/the_nimbus_book/src/SUMMARY.md index 7c7edc2a0..a1b366458 100644 --- a/docs/the_nimbus_book/src/SUMMARY.md +++ b/docs/the_nimbus_book/src/SUMMARY.md @@ -26,7 +26,7 @@ - [Monitor attestation performance](./attestation-performance.md) # How-to (misc) -- [Update Nimbus](./keep-updated.md) +- [Upgrade / downgrade Nimbus](./keep-updated.md) - [Run an eth1 node](./eth1.md) - [Obtain Goerli ETH](./goerli-eth.md) - [Set up a systemd service](./beacon-node-systemd.md) diff --git a/docs/the_nimbus_book/src/keep-updated.md b/docs/the_nimbus_book/src/keep-updated.md index 0e38a3565..7a240276d 100644 --- a/docs/the_nimbus_book/src/keep-updated.md +++ b/docs/the_nimbus_book/src/keep-updated.md @@ -1,16 +1,16 @@ -# Keep Nimbus updated +# Upgrade / downgrade Nimbus -Make sure you stay on the lookout for any critical updates to Nimbus. This best way to do so is through the **announcements** channel on our [discord](https://discord.com/invite/XRxWahP). The Nimbus eth2 releases page can be found [here](https://github.com/status-im/nimbus-eth2/releases/). +Make sure you stay on the lookout for any critical updates to Nimbus. This best way to do so is through the **announcements** channel on our [discord](https://discord.com/invite/XRxWahP). The release page can be found [here](https://github.com/status-im/nimbus-eth2/releases/). > **Note:** If your beacon node is already running, you'll need to disconnect and reconnect for the changes to take effect. -To update to the latest version, either download the binary or compile the beacon node release. +To update to the latest version, either download the binary or compile the beacon node release (see below). > **Tip:** To check which version of Nimbus you're currently running, run `build/nimbus_beacon_node --version` ## Download the binary -Open the latest [Nimbus eth2 release](https://github.com/status-im/nimbus-eth2/releases/latest) and copy the link for the file that works on your system. +Open the latest [Nimbus release](https://github.com/status-im/nimbus-eth2/releases/latest) and copy the link for the file that works on your system. ``` wget @@ -20,7 +20,7 @@ rm nimbus-eth2_Linux_arm64v8*.tar.gz ## Compile the beacon node release -> ⚠️ In order to minimise downtime, we recommend updating and rebuilding the beacon node before restarting. +Run: ``` git pull && make update @@ -32,7 +32,10 @@ Followed by: make nimbus_beacon_node ``` -to [rebuild the beacon node](./build.md). +Now, restart your node. + +> **Tip:** In order to minimise downtime, we recommend updating and [rebuilding](./build.md) the beacon node **before restarting**. + ## Urgency guidelines As of `v1.4.0`, releases are marked with the following tags: @@ -44,3 +47,36 @@ As of `v1.4.0`, releases are marked with the following tags: `high-urgency`: update as soon as you can, this is a critical update required for Nimbus to function correctly +## Install a specific version + +*Occassionally you may need to either upgrade or downgrade to a specific version of Nimbus.* + +To pull a specific version of Nimbus (e.g. `v1.3.0`), run: +``` +git checkout v1.3.0 && make update +``` + +Followed by: + +``` +make nimbus_beacon_node +``` + +Now, restart your node. + +> **Note:** Alternatively, you can grab the appropriate binary release - create a backup of your `build` folder, then download the appropriate binary from here: [https://github.com/status-im/nimbus-eth2/releases/tag/v1.3.0](https://github.com/status-im/nimbus-eth2/releases/tag/v1.3.0) + +### Go back to stable +If you need to go back to the latest (stable) version, run: +``` +git checkout stable && make update +``` + +Followed by + +``` +make nimbus_beacon_node +``` + +Don't forget to restart your node. +