very minor docs update (#17117)
* very minor docs update * Apply suggestions from code review * fix typos backup-restore.md --------- Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
Fotis Voutsas committed
Mar 6, 2024 at 11:46 UTC
0eeedf7847ff51d8d78119eb41e0a067ffc05315
1 file changed
+13
-13
docs/maintenance/backup-restore.md
+13
-13
@@ -15,29 +15,29 @@ When preparing to backup a Netdata Agent it is worth considering that there are
15
16
### Backing up to restore data in case of a node failure
17
18
-In this standard scenario you are backing up your Netdata Agent in case of a node failure or data corruption so that the metrics and the configuration can be recovered. The purpose is not to backup/restore the application itself.
18
+In this standard scenario, you are backing up your Netdata Agent in case of a node failure or data corruption so that the metrics and the configuration can be recovered. The purpose is not to backup/restore the application itself.
19
20
-1. Verify that the directory-paths in the table above contain the information you expect.
20
+1. Verify that the directory paths in the table above contain the information you expect.
21
22
> **Note**
23
- > The specific paths may vary depending upon installation method, Operating System and whether it is a Docker/Kubernetes deployment.
23
+ > The specific paths may vary depending on installation method, Operating System, and whether it is a Docker/Kubernetes deployment.
24
25
2. It is recommended that you [stop the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) when backing up the Metrics/database files.
26
- Backing up the Agent configuration and Identity folders is straight-forward as they should not be changing very frequently.
26
+ Backing up the Agent configuration and Identity folders is straightforward as they should not be changing very frequently.
27
28
-3. Using a backup tool such as `tar` you will need to run the backup as _root_ or as the _netdata_ user in order to access all the files in the directories.
28
+3. Using a backup tool such as `tar` you will need to run the backup as _root_ or as the _netdata_ user to access all the files in the directories.
29
+
30
+ ```
31
+ sudo tar -cvpzf netdata_backup.tar.gz /etc/netdata/ /var/cache/netdata /var/lib/netdata
32
+ ```
33
+
34
+ Stopping the Netdata agent is typically necessary to back up the database files of the Netdata Agent.
35
30
- ```
31
- sudo tar -cvpzf netdata_backup.tar.gz /etc/netdata/ /var/cache/netdata /var/lib/netdata
32
- ```
33
-
34
- Stopping the Netdata agent is mostly required in order to back up the _database files_ of the Netdata Agent.
35
-
36
- If you wish to minimize the gap in metrics caused by stopping the Netdata Agent, then you could have a backup job or script that uses the following sequence:
36
+If you want to minimize the gap in metrics caused by stopping the Netdata Agent, consider implementing a backup job or script that follows this sequence:
37
38
- Backup the Agent configuration Identity directories
39
- Stop the Netdata service
40
-- Backup up up the database files
40
+- Backup up the database files
41
- Restart the netdata agent.
42
43
### Restoring Netdata