From bd1b0a16ba8e58c0abe3582718906a7bcbe06777 Mon Sep 17 00:00:00 2001 From: mlukanova Date: Tue, 1 Nov 2022 18:04:15 +0200 Subject: [PATCH] Bring back backupp in the readme --- tools-bash/upgrade/readme.md | 40 ++++++++++++++++++++++++++---------- 1 file changed, 29 insertions(+), 11 deletions(-) diff --git a/tools-bash/upgrade/readme.md b/tools-bash/upgrade/readme.md index feda5f1..0d418e9 100644 --- a/tools-bash/upgrade/readme.md +++ b/tools-bash/upgrade/readme.md @@ -66,15 +66,33 @@ vim ./config/node.env # Usage -There is 1 main script - node. It can validate the current version and execute an upgrade. - +There are 2 main scripts - node and backup. **Important**: The side effect of executing any of these scripts will be a folder, defined in PARAM_SOURCE_DIR at node.env on target computer - **Important**: Execute these scripts only when all config files are ready. - **Important**: All of the scripts below must be executed from ./upgrade folder. - -**Important**: Make sure that ./src/node.sh have execute permission. +**Important**: Make sure that ./src/backup.sh and ./src/node.sh have execute permission. +## Backup +Backup script has four usages: +### Create a backup +The command below creates a backup of current source files and data files. +``` +sudo ./src/backup.sh create +``` +### Restore a backup +The command restores a backup that has been created using Create a backup +``` +sudo ./src/backup.sh restore +``` +### Validate a backup +The command validates whether a created backup using Create a backup is valid +``` +sudo ./src/backup.sh validate +``` +### Clean a backup +The command deletes previously created backup using Create a backup +``` +sudo ./src/backup.sh clean +``` ## Node @@ -94,10 +112,10 @@ sudo ./src/node.sh upgrade ## Launch sequence -1. Validate - +1. Create a backup + + Note: Creating of a backup could take a lot of time. It is very important to do it ONCE upgrade hight has been reached NOT before that. Make sure there is no error messages in the console. If something went wrong you can always re-create the backup. Make sure that the backup is correct (You can check it using Validate a backup) before proceeding to the next step. +2. Validate Note: The validate command will print the information about current node. Read it carefully and proceed with the next step only if this information is valid. If it is not valid, please contact CUDOS and make the appropriate changes. If the changes invole any of the previously backup-ed files, you must re-create the backup. - -2. Upgrade - +3. Upgrade Note: The upgrade could take up to 20min. If there is any error message during the upgrade you must restore a backup (using Restore a backup) and start over.