Skip to content

Editorial mdlint and vale updates to Howto/Backup directory #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MadelineMurray merged 26 commits into from
Feb 25, 2020
Merged

Editorial mdlint and vale updates to Howto/Backup directory #186

Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
365ab79
Moved license note (#129)
MadelineMurray Jan 31, 2020
e5c4406
Windows is now supported in the quickstart (#143)
EdJoJob Feb 6, 2020
1071531
quickstart updates all round (#141)
joshuafernandes Feb 9, 2020
0a93b6b
Fixed typo (#150)
MadelineMurray Feb 10, 2020
87c0234
Add multi-tenancy information. (#131)
bgravenorst Feb 10, 2020
3b063e7
Apply renames for the quickstart repo (#152)
EdJoJob Feb 12, 2020
625e1a1
Added content on protocol upgrades (#132)
MadelineMurray Feb 13, 2020
3302707
Fixed Ansible link and renamed topic (#168)
MadelineMurray Feb 14, 2020
776d400
permissioning (#170)
wslyvh Feb 14, 2020
3f128b7
Vale and mdlint editorial updates - DCO.md (#162)
Feb 14, 2020
e92521c
updated CI and customised checks (#165)
NicolasMassart Feb 19, 2020
2485785
Added new NAT options (#179)
MadelineMurray Feb 20, 2020
3544224
Editorial mdlint vale updates for Concepts/Transactions directory (#185)
Feb 20, 2020
6f00338
Editorial mklint and vale updates in Concepts/Permissioning dir (#181)
Feb 20, 2020
691ecf8
mdlint and vale editorial updates in Concepts/Consensus-Protocols dir…
Feb 20, 2020
15598ef
mdlint and vale editorial edits in the Concepts directory (#177)
Feb 20, 2020
799e4c7
vale and mklint editorial updates - CONTRIBUTING.md (#163)
Feb 20, 2020
d497e48
mdlint and vale editorial updates - index.md (#169)
Feb 20, 2020
380f822
Editorial mdlint and vale updates for HowTo/Backups directory
Feb 20, 2020
a3b8b52
the cloud
Feb 20, 2020
f14614e
Merge branch 'master' into grantnoble-howto-backup-mdlint-vale
Feb 20, 2020
52c03d9
Merge branch 'master' into grantnoble-howto-backup-mdlint-vale
Feb 23, 2020
3c5c7e4
Updates based on @MadelineMurray review
Feb 23, 2020
0a4ce1c
Merge branch 'master' into grantnoble-howto-backup-mdlint-vale
Feb 24, 2020
9843a05
Replacing html comment after metadata with markdown comment
Feb 24, 2020
4a026dd
Merge branch 'master' into grantnoble-howto-backup-mdlint-vale
MadelineMurray Feb 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 37 additions & 39 deletions docs/HowTo/Backup/Backup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,57 +1,55 @@
description: Backing up and restoring Besu
<!--- END of page meta data -->
---
description: Backing up and restoring Besu
---

# Backups
# Backups

In a decentralized blockchain, data is replicated on other nodes so it cannot be lost. However, backing up
configuration and data ensures a smoother recovery.
In a decentralized blockchain, data replicates between nodes so it is not lost. However,backing up
configuration and data ensures a smoother recovery from corrupted data or other failures.
Copy link
Copy Markdown
Contributor

@MadelineMurray MadelineMurray Feb 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a pretty long sentence now - 29 words. I'd probably break it into two but will leave it to you to decide.

Copy link
Copy Markdown
Author

@grantnoble grantnoble Feb 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. Updated.


## Genesis File
## Genesis file

The genesis file for a network must be accessible on every node. We recommend the genesis file is
stored under source control.
The genesis file for a network must be accessible on every node. We recommend the genesis file is
stored under source control.

## Data Backups
## Data backups

If installed locally, the default data location is the directory in which Besu is installed.
If installed locally, the default data location is the Besu installation directory.

We recommend mounting a [separate volume to store data](../Get-Started/Run-Docker-Image.md#starting-besu).
Use the [`--data-path`](../../Reference/CLI/CLI-Syntax.md#data-path) command line option to pass the path to Besu.
We recommend mounting a
[separate volume to store data](../Get-Started/Run-Docker-Image.md#starting-besu). Use the
[`--data-path`](../../Reference/CLI/CLI-Syntax.md#data-path) command line option to pass the path
to Besu.

The default data location is the directory in which Besu is installed
or `/opt/besu/database` if using the [Besu Docker image](../../HowTo/Get-Started/Run-Docker-Image.md).
The default data location is the Besu installation directory, or `/opt/besu/database` if using the
[Besu Docker image](../../HowTo/Get-Started/Run-Docker-Image.md).

The default data location is the directory in which Besu is installed
or `/opt/besu/database` if using the [Besu Docker image](../../HowTo/Get-Started/Run-Docker-Image.md).
Having some data reduces the time to synchronise a new node. You can perform periodic backups of
Copy link
Copy Markdown
Contributor

@MadelineMurray MadelineMurray Feb 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should there be a line between these two paragraphs?

Copy link
Copy Markdown
Author

@grantnoble grantnoble Feb 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good pick up.

the data directory and send the data to your preferred backup mechanism. For example, cron job and
rsync, archives to the cloud such as s3, or `tar.gz` archives.

The default data location is the directory in which Besu is installed
or `/opt/besu/database` if using the [Besu Docker image](../../HowTo/Get-Started/Run-Docker-Image.md).
## Data restores

The default data location is the directory in which Besu is installed
or `/opt/besu/database` if using the [Besu Docker image](../../HowTo/Get-Started/Run-Docker-Image.md).
To restore data:

Having some data reduces the time to synchronise a new node. Periodic backups can be performed of
the data directory and the data sent to your preferred backup mechanism. For example, cron job and
rsync, archives to cloud such as s3, or `tar.gz` archives.
1. If the node is running, stop the node.
1. If required, move the data directory to another location for analysis.
1. Restore the data from your last known good backup to the same directory.
1. Ensure user permissions are valid so the data directory can be read from and written to.
1. Restart the node.

## Data Restores
## Corrupted data

To restore data:
If log messages signify a corrupt database, the cleanest way to recover is:

1. If the node is running, stop the node.
1. If required, move the data directory to another location for analysis.
1. Restore the data from your last known good backup to the same directory.
1. Ensure user permissions are valid so the data directory can be read from and written to.
1. Restart the node.
1. Stop the node.
1. Restore the data from a [previous backup](#data-backups).
1. Restart the node.

## Corrupted Data
## Finding peers after restarting

If log messages indicate a corrupt database, the cleanest way to recover is:
The process for finding peers after restarting is the same as for
[finding peers after upgrading and restarting].

1. Stop the node.
1. Restore the data from a [previous backup](#data-backups).
1. Restart the node.

## Finding Peers on Restarting

The process for finding peers on restarting is the same as [finding peers after upgrading and restarting](../Upgrade/Upgrade-Node.md#finding-peers-on-restarting).
<!-- Links -->
[finding peers after upgrading and restarting]: ../Upgrade/Upgrade-Node.md#finding-peers-on-restarting