From 0495d3e8a3707414018a0c74d991043ae0ab259e Mon Sep 17 00:00:00 2001 From: Madeline Murray Date: Thu, 27 Feb 2020 10:48:10 +1000 Subject: [PATCH 1/2] Added caution Signed-off-by: Madeline Murray --- docs/Concepts/Pruning.md | 3 +++ docs/HowTo/Get-Started/System-Requirements.md | 10 ++++++++-- docs/Reference/CLI/CLI-Syntax.md | 3 +++ 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/Concepts/Pruning.md b/docs/Concepts/Pruning.md index 76301a5f60c..83226e5f638 100644 --- a/docs/Concepts/Pruning.md +++ b/docs/Concepts/Pruning.md @@ -3,6 +3,9 @@ description: Pruning # Pruning +!!! caution + Hyperledger Besu v1.4.0 has a [known pruning bug](https://github.com/hyperledger/besu/blob/master/CHANGELOG.md#known-issues). + Use pruning to reduce storage required for the world state. Pruning removes state trie nodes that are not required. diff --git a/docs/HowTo/Get-Started/System-Requirements.md b/docs/HowTo/Get-Started/System-Requirements.md index 865f1be2bda..38559d4372e 100644 --- a/docs/HowTo/Get-Started/System-Requirements.md +++ b/docs/HowTo/Get-Started/System-Requirements.md @@ -18,7 +18,8 @@ To determine system requirements, monitor CPU and disk space requirements using A sample [Grafana dashboard](https://grafana.com/grafana/dashboards/10273) is provided for Besu. !!! tip - CPU requirements are highest when syncing to the network and typically reduce once the node is synchronized to the chain head. + CPU requirements are highest when syncing to the network and typically reduce once the node is + synchronized to the chain head. ## RAM @@ -27,7 +28,12 @@ a minimum of 8GB of RAM is required. ## Disk Space -Syncing to the Ethereum Mainnet requires 3TB for a full sync. To reduce the requirement, use [pruning](../../Concepts/Pruning.md). With pruning, we recommend approximately 750GB of available disk space. +Syncing to the Ethereum Mainnet requires 3TB for a full sync. To reduce the requirement, use +[pruning](../../Concepts/Pruning.md). With pruning, we recommend approximately 750GB of available disk +space. + +!!! caution + Hyperledger Besu v1.4.0 has a [known pruning bug](https://github.com/hyperledger/besu/blob/master/CHANGELOG.md#known-issues). ## VM Requirements diff --git a/docs/Reference/CLI/CLI-Syntax.md b/docs/Reference/CLI/CLI-Syntax.md index d2f7b4733e3..5d899604dc6 100644 --- a/docs/Reference/CLI/CLI-Syntax.md +++ b/docs/Reference/CLI/CLI-Syntax.md @@ -1334,6 +1334,9 @@ URL on which the [Orion node](../../Tutorials/Privacy/Configuring-Privacy.md#4-c ### pruning-enabled +!!! caution + Hyperledger Besu v1.4.0 has a [known pruning bug](https://github.com/hyperledger/besu/blob/master/CHANGELOG.md#known-issues). + ```bash tab="Syntax" --pruning-enabled ``` From 18ba39b10538681c88a15f923b7bfd728e1a85e0 Mon Sep 17 00:00:00 2001 From: Madeline Murray Date: Thu, 27 Feb 2020 11:31:58 +1000 Subject: [PATCH 2/2] rewokr Signed-off-by: Madeline Murray --- docs/Concepts/Pruning.md | 4 +++- docs/HowTo/Get-Started/System-Requirements.md | 8 +++++--- docs/Reference/CLI/CLI-Syntax.md | 4 +++- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/Concepts/Pruning.md b/docs/Concepts/Pruning.md index 83226e5f638..56e9552125c 100644 --- a/docs/Concepts/Pruning.md +++ b/docs/Concepts/Pruning.md @@ -4,7 +4,9 @@ description: Pruning # Pruning !!! caution - Hyperledger Besu v1.4.0 has a [known pruning bug](https://github.com/hyperledger/besu/blob/master/CHANGELOG.md#known-issues). + Do not use pruning in Hyperledger Besu v1.4.0. Pruning has a [known bug](https://github.com/hyperledger/besu/blob/master/CHANGELOG.md#known-issues). + + If using fast sync in v1.4.0, explicitly disable pruning using [`--pruning-enabled=false`](../Reference/CLI/CLI-Syntax.md#pruning-enabled). Use pruning to reduce storage required for the world state. Pruning removes state trie nodes that are not required. diff --git a/docs/HowTo/Get-Started/System-Requirements.md b/docs/HowTo/Get-Started/System-Requirements.md index 38559d4372e..4cee2942187 100644 --- a/docs/HowTo/Get-Started/System-Requirements.md +++ b/docs/HowTo/Get-Started/System-Requirements.md @@ -28,13 +28,15 @@ a minimum of 8GB of RAM is required. ## Disk Space +!!! caution + Do not use pruning in Hyperledger Besu v1.4.0. Pruning has a [known bug](https://github.com/hyperledger/besu/blob/master/CHANGELOG.md#known-issues). + + If using fast sync in v1.4.0, explicitly disable pruning using [`--pruning-enabled=false`](../../Reference/CLI/CLI-Syntax.md#pruning-enabled). + Syncing to the Ethereum Mainnet requires 3TB for a full sync. To reduce the requirement, use [pruning](../../Concepts/Pruning.md). With pruning, we recommend approximately 750GB of available disk space. -!!! caution - Hyperledger Besu v1.4.0 has a [known pruning bug](https://github.com/hyperledger/besu/blob/master/CHANGELOG.md#known-issues). - ## VM Requirements You can run Besu on a virtual machine (VM) on a cloud service such as AWS or Azure, or locally diff --git a/docs/Reference/CLI/CLI-Syntax.md b/docs/Reference/CLI/CLI-Syntax.md index 5d899604dc6..ac8eb063fae 100644 --- a/docs/Reference/CLI/CLI-Syntax.md +++ b/docs/Reference/CLI/CLI-Syntax.md @@ -1335,7 +1335,9 @@ URL on which the [Orion node](../../Tutorials/Privacy/Configuring-Privacy.md#4-c ### pruning-enabled !!! caution - Hyperledger Besu v1.4.0 has a [known pruning bug](https://github.com/hyperledger/besu/blob/master/CHANGELOG.md#known-issues). + Do not use pruning in Hyperledger Besu v1.4.0. Pruning has a [known bug](https://github.com/hyperledger/besu/blob/master/CHANGELOG.md#known-issues). + + If using fast sync in v1.4.0, explicitly disable pruning using `--pruning-enabled=false`. ```bash tab="Syntax" --pruning-enabled