From f0f6b6869f53129efe7eeac644b1ee7a4006d684 Mon Sep 17 00:00:00 2001 From: Sacha Saint-Leger Date: Wed, 14 Apr 2021 16:48:11 +0200 Subject: [PATCH] Nimbus guide: updates for new release (#2504) * update nimbus book readme * Revert "update nimbus book readme" This reverts commit d568f0f7a37f6e833b37a0111fd59e523864cd97. * backupadd web3 provider pader page * add checksums page * update grafana: dashboard challenge recommendations --- docs/the_nimbus_book/src/SUMMARY.md | 2 ++ docs/the_nimbus_book/src/checksums.md | 20 ++++++++++++++ .../src/metrics-pretty-pictures.md | 27 +++++++++++++++++++ docs/the_nimbus_book/src/web3-backup.md | 12 +++++++++ 4 files changed, 61 insertions(+) create mode 100644 docs/the_nimbus_book/src/checksums.md create mode 100644 docs/the_nimbus_book/src/web3-backup.md diff --git a/docs/the_nimbus_book/src/SUMMARY.md b/docs/the_nimbus_book/src/SUMMARY.md index 82e1ba6ca..e04f4341e 100644 --- a/docs/the_nimbus_book/src/SUMMARY.md +++ b/docs/the_nimbus_book/src/SUMMARY.md @@ -18,6 +18,7 @@ - [Install dependencies](./install.md) - [Build the beacon node](./build.md) - [Run an eth1 node](./eth1.md) +- [Add a backup web3 provider](./web3-backup.md) - [Sync the beacon node](./start-syncing.md) - [Make a deposit for your validator](./deposit.md) - [Import your validator keys](./keys.md) @@ -34,6 +35,7 @@ - [Perform a voluntary exit](./voluntary-exit.md) - [Setup a systemd service](./beacon-node-systemd.md) - [Setup log rotation](./log-rotate.md) +- [Verify the integrity of Nimbus](./checksums.md) # Tutorials - [Grafana and Prometheus](./metrics-pretty-pictures.md) diff --git a/docs/the_nimbus_book/src/checksums.md b/docs/the_nimbus_book/src/checksums.md new file mode 100644 index 000000000..fa3694113 --- /dev/null +++ b/docs/the_nimbus_book/src/checksums.md @@ -0,0 +1,20 @@ +# Verify the integrity of Nimbus + +We've recently added checksums to the end of our [release notes](https://github.com/status-im/nimbus-eth2/releases/) (a practice we will be continuing from now on). Please make sure you get into the habit of verifying these 🙏 + +For those of you who are unfamiliar, a [checksum](https://en.wikipedia.org/wiki/Checksum) is a special type of [hash](https://en.wikipedia.org/wiki/Hash_function) used to verify the integrity of a file. Verifying a checksum ensures there was no corruption or manipulation during the download and that the file was downloaded completely and correctly. For a short and simple guide on how to do so, [see here](https://www.devdungeon.com/content/how-verify-checksum). + +In the case of the [v1.1.0](https://github.com/status-im/nimbus-eth2/releases/tag/v1.1.0) release for example, the SHA512 checksums are: + +``` +# Linux AMD64 +8d553ea5422645b5f06001e7f47051706ae5cffd8d88c45e4669939f3abb6caf41a2477431fce3e647265cdb4f8671fa360d392f423ac68ffb9459607eaab462 nimbus_beacon_node +# Linux ARM64 +93ffd03a0ce67f7d035e3dc45e97de3c2c9a05a8dd0c6d5f45402ddb04404dc3cf15b80fee972f34152ef171ce97c40f794448bc779ca056081c945f71f19788 nimbus_beacon_node +# Linux ARM +f2e75f3fae2aea0a9f8d45861d52b0e2546c3990f453b509fab538692d18c64e65f58441c5492064fc371e0bc77de6bab970e05394cfd124417601b55cb4a825 nimbus_beacon_node +# Windows AMD64 +fd68c8792ea60c2c72e9c2201745f9698bfd1dae4af4fa9e1683f082109045efebd1d80267f13cafeb1cd7414dc0f589a8a73f12161ac2758779369289d5a832 nimbus_beacon_node + +``` + diff --git a/docs/the_nimbus_book/src/metrics-pretty-pictures.md b/docs/the_nimbus_book/src/metrics-pretty-pictures.md index 7023d46d3..d621fc2c9 100644 --- a/docs/the_nimbus_book/src/metrics-pretty-pictures.md +++ b/docs/the_nimbus_book/src/metrics-pretty-pictures.md @@ -171,6 +171,33 @@ You'll be directed to the dashboard where you'll be able to gain insights into t And voila! That's all there is to it :) +## Recommended setups (Nimbus dashboard challenge winners) + +### Joe Clapis + +![](https://i.imgur.com/05eJeBr.png) + +Joe – who’s done some brilliant work [integrating Nimbus with Rocket Pool](https://our.status.im/rocket-pool-integration/) – has created a [wonderful guide](https://github.com/jclapis/rp-pi-guide/blob/main/Grafana.md) where he takes you through how to set up a Grafana server on your Pi – using his dashboard as an example. + +In his words: + +> This captures just about every metric I think I’d like to see at a glance. + +Whether or not you're running a Pi, we recommend you check out his guide [here]( https://github.com/jclapis/rp-pi-guide/blob/main/Grafana.md). + + +### Metanull + +![](https://i.imgur.com/OlvNGlq.jpg) + +A dashboard aimed primarily at users rather than developers. + +Note that this dashboard does rely heavily on three prometheus exporter tools: `node_exporter` for system metrics, `json_exporter` for ETH price, and `blackbox_exporter` for ping times. + +The good news is that you don't need to use all these tools, as long as you take care of removing the related panels. + +See [here](https://github.com/metanull-operator/eth2-grafana/tree/master/nimbus) for a detailed guide explaining how to use it. + ## Enabling mobile alerts ### Telegram diff --git a/docs/the_nimbus_book/src/web3-backup.md b/docs/the_nimbus_book/src/web3-backup.md new file mode 100644 index 000000000..6432c6297 --- /dev/null +++ b/docs/the_nimbus_book/src/web3-backup.md @@ -0,0 +1,12 @@ +# Add a backup web3 provider + +It's a good idea to add a backup web3 provider in case your main one goes down. You can do this by simply repeating the `--web3-url` parameter on launch. + +For example, if your primary eth1 node is a [local Geth](./eth1.md), but you want to use [Infura](./infura-guide.md) as a backup you would run: + +``` +./run-mainnet-beacon-node.sh --web3-url="ws://127.0.0.1:8546" --web3-url="wss://mainnet.infura.io/ws/v3/..." +``` + + +> **Note:** that as it stands, when you run this command, you'll be prompted once again for a web3url again -- **please enter your primary one**. This is a UX bug and [we've pushed a fix](https://github.com/status-im/nimbus-eth2/pull/2501) that will be integrated into our next release.