From df332ce0333a40bbed361e482066baafaf0db812 Mon Sep 17 00:00:00 2001 From: Maksim Kurbatov <94808996+yungwine@users.noreply.github.com> Date: Mon, 30 Dec 2024 17:06:58 +0400 Subject: [PATCH] move mtc backup to guidelines (#906) --- .../maintenance-guidelines}/mytonctrl-backup-restore.md | 2 +- .../mytonctrl-validator-standby.md | 4 ++-- sidebars/documentation.js | 2 -- sidebars/guidelines.js | 8 ++++++++ 4 files changed, 11 insertions(+), 5 deletions(-) rename docs/v3/{documentation/infra/nodes/mytonctrl => guidelines/nodes/maintenance-guidelines}/mytonctrl-backup-restore.md (94%) rename docs/v3/{documentation/infra/nodes/mytonctrl => guidelines/nodes/maintenance-guidelines}/mytonctrl-validator-standby.md (90%) diff --git a/docs/v3/documentation/infra/nodes/mytonctrl/mytonctrl-backup-restore.md b/docs/v3/guidelines/nodes/maintenance-guidelines/mytonctrl-backup-restore.md similarity index 94% rename from docs/v3/documentation/infra/nodes/mytonctrl/mytonctrl-backup-restore.md rename to docs/v3/guidelines/nodes/maintenance-guidelines/mytonctrl-backup-restore.md index 1e302923a7..03c2671808 100644 --- a/docs/v3/documentation/infra/nodes/mytonctrl/mytonctrl-backup-restore.md +++ b/docs/v3/guidelines/nodes/maintenance-guidelines/mytonctrl-backup-restore.md @@ -2,7 +2,7 @@ MyTonCtrl allows users to create and restore node configuration backups with two simple, easy-to-use commands. This feature allows node operations to quickly and efficiently transfer node configuration from one host to another. ### Manually create backup package -# Manual backup creation is initialized with the `create_backup` command, the backup creation process should not take more than a few seconds. +Manual backup creation is initialized with the `create_backup` command, the backup creation process should not take more than a few seconds. MyTonCtrl will create a backup package in the home directory of the MyTonCtrl user, the package name will include the hostname as well as the epoch timestamp of the backup. diff --git a/docs/v3/documentation/infra/nodes/mytonctrl/mytonctrl-validator-standby.md b/docs/v3/guidelines/nodes/maintenance-guidelines/mytonctrl-validator-standby.md similarity index 90% rename from docs/v3/documentation/infra/nodes/mytonctrl/mytonctrl-validator-standby.md rename to docs/v3/guidelines/nodes/maintenance-guidelines/mytonctrl-validator-standby.md index 0d6602e63d..18980f2e74 100644 --- a/docs/v3/documentation/infra/nodes/mytonctrl/mytonctrl-validator-standby.md +++ b/docs/v3/guidelines/nodes/maintenance-guidelines/mytonctrl-validator-standby.md @@ -22,12 +22,12 @@ In order to transfer validation duties from the main node to the standby node, o * up-to-date node configuration file and keyring * keys required for MyTonCtrl functionality -MyTonCtrl provides functionality to [create backups](mytonctrl-backup-restore) that contain all required data. If you are running a validator node, we strongly recommend that you set up [automated backups](mytonctrl-backup-restore#automated-backup-creation) and download backup archives from your machine frequently. +MyTonCtrl provides functionality to [create backups](mytonctrl-backup-restore.md) that contain all required data. If you are running a validator node, we strongly recommend that you set up [automated backups](mytonctrl-backup-restore.md#automated-backup-creation) and download backup archives from your machine frequently. ## Restore Before transferring the validator configuration to the standby machine, please ensure that you have stopped / disabled the TON node on the donor machine for ~20 minutes. Failure to do so will result in connectivity issues and crashes on both the donor and target machines. -The restore process is [described in Backups](mytonctrl-backup-restore) +The restore process is [described in Backups](mytonctrl-backup-restore.md) Please ensure that you create and retain the backup of your standby node original configuration before you apply/restore a backup package from another machine, as you will need this to bring the standby node back into standby mode. diff --git a/sidebars/documentation.js b/sidebars/documentation.js index 6f895c74fa..f2cd0f161f 100644 --- a/sidebars/documentation.js +++ b/sidebars/documentation.js @@ -202,8 +202,6 @@ module.exports = [ 'v3/documentation/infra/nodes/mytonctrl/mytonctrl-alerting', 'v3/documentation/infra/nodes/mytonctrl/mytonctrl-status', 'v3/documentation/infra/nodes/mytonctrl/mytonctrl-errors', - 'v3/documentation/infra/nodes/mytonctrl/mytonctrl-backup-restore', - 'v3/documentation/infra/nodes/mytonctrl/mytonctrl-validator-standby', ], }, 'v3/documentation/infra/nodes/node-commands', diff --git a/sidebars/guidelines.js b/sidebars/guidelines.js index e5a04b06d8..9043d096e3 100644 --- a/sidebars/guidelines.js +++ b/sidebars/guidelines.js @@ -225,6 +225,14 @@ module.exports = [ 'v3/guidelines/nodes/running-nodes/secure-guidelines', ], }, + { + type: 'category', + label: 'Maintenance Guidelines', + items: [ + 'v3/guidelines/nodes/maintenance-guidelines/mytonctrl-backup-restore', + 'v3/guidelines/nodes/maintenance-guidelines/mytonctrl-validator-standby', + ], + }, 'v3/guidelines/nodes/custom-overlays', 'v3/guidelines/nodes/nodes-troubleshooting', 'v3/guidelines/nodes/node-maintenance-and-security',