Merge pull request #82 from GaiaNet-AI/feat-upgrade

apepkuss · web-flow · commit 2f82a88b073c · 2024-07-07T14:18:33.000+08:00
feat: add `--upgrade` CLI option in installer
diff --git a/gaianet b/gaianet
@@ -3,6 +3,7 @@
 set -e
 
 # version of CLI tool
+# Note that the version should kept same as the version of installer
 version="0.1.3"
 
 # version of the GaiaNet node
diff --git a/install.sh b/install.sh
@@ -18,6 +18,8 @@ dashboard_version="v3.1"
 
 # 0: do not reinstall, 1: reinstall
 reinstall=0
+# 0: do not upgrade, 1: upgrade
+upgrade=0
 # 0: must be root or sudo, 1: regular unprivileged user
 unprivileged=0
 # url to the config file
@@ -49,6 +51,7 @@ function print_usage {
     printf "  --config <Url>     Specify a url to the config file\n"
     printf "  --base <Path>      Specify a path to the gaianet base directory\n"
     printf "  --reinstall        Install and download all required deps\n"
+    printf "  --upgrade          Upgrade the gaianet node\n"
     printf "  --tmpdir <Path>    Specify a path to the temporary directory [default: /tmp]\n"
     printf "  --ggmlcuda [11/12] Install a specific CUDA enabled GGML plugin version [Possible values: 11, 12].\n"
     # printf "  --unprivileged: install the gaianet CLI tool into base directory instead of system directory\n"
@@ -74,6 +77,10 @@ while [[ $# -gt 0 ]]; do
             reinstall=1
             shift
             ;;
+        --upgrade)
+            upgrade=1
+            shift
+            ;;
         --tmpdir)
             tmp_dir="$2"
             shift
@@ -151,10 +158,86 @@ EOF
 
 printf "\n\n"
 
-# if need to reinstall, remove the $gaianet_base_dir directory
-if [ "$reinstall" -eq 1 ] && [ -d "$gaianet_base_dir" ]; then
-    printf "[+] Removing the existing $gaianet_base_dir directory ...\n\n"
-    rm -rf $gaianet_base_dir
+# If need to upgrade, remove the all existing files and subdirectories in the base directory, except for the backup subdirectory and its contents
+# If need to reinstall, remove the $gaianet_base_dir directory
+if [ -d "$gaianet_base_dir" ]; then
+    if [ "$upgrade" -eq 1 ]; then
+
+        # check version
+        if ! command -v gaianet &> /dev/null; then
+            current_version=""
+        else
+            current_version=$(gaianet --version)
+        fi
+
+        if [ -n "$current_version" ] && [ "GaiaNet CLI Tool v$version" = "$current_version" ]; then
+            info "The current version ($current_version) is the same as the target version (GaiaNet CLI Tool v$version). Skip the upgrade process."
+            exit 0
+
+        else
+            read -p "The gaianet node will be upgraded to v$version. It is stongly recommended to (1) STOP the running node and (2) backup $gaianet_base_dir directory before continue the upgrade process. Continue? (y/n): " answer
+            case $answer in
+                [Yy]* ) printf "\n";;
+                [Nn]* ) printf "Exiting upgrade process.\n"; exit;;
+                * ) printf "Please answer y or n.\n"; exit;;
+            esac
+        fi
+
+        printf "[+] Performing backup before upgrading to v$version ...\n\n"
+
+        if [ ! -d "$gaianet_base_dir/backup" ]; then
+            printf "    * Create $gaianet_base_dir/backup\n"
+            mkdir -p "$gaianet_base_dir/backup"
+        fi
+
+        # backup keystore file
+        keystore_filename=$(grep '"keystore":' $gaianet_base_dir/nodeid.json | awk -F'"' '{print $4}')
+        if [ -z "$keystore_filename" ]; then
+            error "Failed to read the 'keystore' field from $gaianet_base_dir/nodeid.json."
+            exit 1
+        else
+            if [ -f "$gaianet_base_dir/$keystore_filename" ]; then
+                printf "    * Copy $keystore_filename to $gaianet_base_dir/backup/\n"
+                cp $gaianet_base_dir/$keystore_filename $gaianet_base_dir/backup/
+            else
+                error "Failed to copy the keystore file. Reason: the keystore file does not exist in $gaianet_base_dir."
+                exit 1
+            fi
+        fi
+        # backup config.json
+        if [ -f "$gaianet_base_dir/config.json" ]; then
+            printf "    * Copy config.json to $gaianet_base_dir/backup/\n"
+            cp $gaianet_base_dir/config.json $gaianet_base_dir/backup/
+        else
+            error "Failed to copy the config.json. Reason: the config.json does not exist in $gaianet_base_dir."
+            exit 1
+        fi
+        # backup nodeid.json
+        if [ -f "$gaianet_base_dir/nodeid.json" ]; then
+            printf "    * Copy nodeid.json to $gaianet_base_dir/backup/\n"
+            cp $gaianet_base_dir/nodeid.json $gaianet_base_dir/backup/
+        else
+            error "Failed to copy the nodeid.json. Reason: the nodeid.json does not exist in $gaianet_base_dir."
+            exit 1
+        fi
+        # backup frpc.toml
+        if [ -f "$gaianet_base_dir/gaianet-domain/frpc.toml" ]; then
+            printf "    * Copy frpc.toml to $gaianet_base_dir/backup/\n"
+            cp $gaianet_base_dir/gaianet-domain/frpc.toml $gaianet_base_dir/backup/
+        else
+            error "Failed to copy the frpc.toml. Reason: the frpc.toml does not exist in $gaianet_base_dir/gaianet-domain."
+            exit 1
+        fi
+
+        # remove the all existing files and subdirectories in the base directory, except for the backup subdirectory and its contents
+        find "$gaianet_base_dir" -mindepth 1 -not -name 'backup' -not -path '*/backup/*' -not -name '*.gguf' -exec rm -rf {} +
+
+        printf "\n"
+
+    elif [ "$reinstall" -eq 1 ]; then
+        printf "[+] Removing the existing $gaianet_base_dir directory ...\n\n"
+        rm -rf $gaianet_base_dir
+    fi
 fi
 
 # Check if $gaianet_base_dir directory exists
@@ -184,21 +267,78 @@ chmod u+x $bin_dir/gaianet
 info "    * gaianet CLI tool is installed in $bin_dir"
 
 # 2. Download default `config.json`
-printf "[+] Downloading default config file ...\n"
-if [ ! -f "$gaianet_base_dir/config.json" ]; then
-    check_curl https://github.com/GaiaNet-AI/gaianet-node/releases/download/$version/config.json $gaianet_base_dir/config.json
+if [ "$upgrade" -eq 1 ]; then
+    printf "[+] Recovering config.json ...\n"
+
+    if [ -f "$gaianet_base_dir/backup/config.json" ]; then
+        cp $gaianet_base_dir/backup/config.json $gaianet_base_dir/config.json
+
+        if ! grep -q '"chat_batch_size":' $gaianet_base_dir/config.json; then
+            # Prepend the field to the beginning of the JSON object
+            if [ "$(uname)" == "Darwin" ]; then
+                sed -i '' '2i\
+                "chat_batch_size": "512",
+                ' "$gaianet_base_dir/config.json"
+
+            elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
+                sed -i '2i\
+                "chat_batch_size": "512",
+                ' "$gaianet_base_dir/config.json"
+
+            elif [ "$(expr substr $(uname -s) 1 10)" == "MINGW32_NT" ]; then
+                error "    * For Windows users, please run this script in WSL."
+                exit 1
+            else
+                error "    * Only support Linux, MacOS and Windows."
+                exit 1
+            fi
+        fi
+
+        if ! grep -q '"embedding_batch_size":' $gaianet_base_dir/config.json; then
+            # Prepend the field to the beginning of the JSON object
+            if [ "$(uname)" == "Darwin" ]; then
+                sed -i '' '2i\
+                "embedding_batch_size": "512",
+                ' "$gaianet_base_dir/config.json"
+
+            elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
+                sed -i '2i\
+                "embedding_batch_size": "512",
+                ' "$gaianet_base_dir/config.json"
+
+            elif [ "$(expr substr $(uname -s) 1 10)" == "MINGW32_NT" ]; then
+                error "    * For Windows users, please run this script in WSL."
+                exit 1
+            else
+                error "    * Only support Linux, MacOS and Windows."
+                exit 1
+            fi
+        fi
+
+        info "    * The config.json is recovered in $gaianet_base_dir"
+    else
+        error "    * Failed to recover the config.json. Reason: the config.json does not exist in $gaianet_base_dir/backup/."
+        exit 1
+    fi
 
-    info "    * The default config file is downloaded in $gaianet_base_dir"
 else
-    warning "    * Use the cached config file in $gaianet_base_dir"
-fi
+    printf "[+] Downloading default config.json ...\n"
+
+    if [ ! -f "$gaianet_base_dir/config.json" ]; then
+        check_curl https://github.com/GaiaNet-AI/gaianet-node/releases/download/$version/config.json $gaianet_base_dir/config.json
 
-# 3. download nodeid.json
-if [ ! -f "$gaianet_base_dir/nodeid.json" ]; then
-    printf "[+] Downloading nodeid.json ...\n"
-    check_curl https://github.com/GaiaNet-AI/gaianet-node/releases/download/$version/nodeid.json $gaianet_base_dir/nodeid.json
+        info "    * The default config file is downloaded in $gaianet_base_dir"
+    else
+        warning "    * Use the cached config file in $gaianet_base_dir"
+    fi
+
+    # 3. download nodeid.json
+    if [ ! -f "$gaianet_base_dir/nodeid.json" ]; then
+        printf "[+] Downloading nodeid.json ...\n"
+        check_curl https://github.com/GaiaNet-AI/gaianet-node/releases/download/$version/nodeid.json $gaianet_base_dir/nodeid.json
 
-    info "    * The nodeid.json is downloaded in $gaianet_base_dir"
+        info "    * The nodeid.json is downloaded in $gaianet_base_dir"
+    fi
 fi
 
 # 4. Install vector and download vector config file
@@ -380,21 +520,45 @@ else
     warning "    * Use the cached dashboard in $gaianet_base_dir"
 fi
 
-# 9. Generate node ID and copy config to dashboard
-printf "[+] Generating node ID ...\n"
+# 9. Download registry.wasm
 if [ ! -f "$gaianet_base_dir/registry.wasm" ] || [ "$reinstall" -eq 1 ]; then
-    printf "    * Download registry.wasm\n"
+    printf "[+] Downloading registry.wasm ...\n"
     check_curl https://github.com/GaiaNet-AI/gaianet-node/raw/main/utils/registry/registry.wasm $gaianet_base_dir/registry.wasm
-    info "      The registry.wasm is downloaded in $gaianet_base_dir"
+    info "    * The registry.wasm is downloaded in $gaianet_base_dir"
 else
     warning "    * Use the cached registry.wasm in $gaianet_base_dir"
 fi
-printf "    * Generate node ID\n"
-cd $gaianet_base_dir
-wasmedge --dir .:. registry.wasm
-printf "\n"
 
-# 10. Install gaianet-domain
+# 10. Generate node ID
+if [ "$upgrade" -eq 1 ]; then
+    printf "[+] Recovering node ID ...\n"
+
+    # recover the keystore file
+    if [ -f "$gaianet_base_dir/backup/$keystore_filename" ]; then
+        cp $gaianet_base_dir/backup/$keystore_filename $gaianet_base_dir/
+        info "    * The keystore file is recovered in $gaianet_base_dir"
+    else
+        error "Failed to recover the keystore file. Reason: the keystore file does not exist in $gaianet_base_dir/backup/."
+        exit 1
+    fi
+
+    # recover the nodeid.json
+    if [ -f "$gaianet_base_dir/backup/nodeid.json" ]; then
+        cp $gaianet_base_dir/backup/nodeid.json $gaianet_base_dir/nodeid.json
+        info "    * The node ID is recovered in $gaianet_base_dir"
+    else
+        error "Failed to recover the node ID. Reason: the nodeid.json does not exist in $gaianet_base_dir/backup/."
+        exit 1
+    fi
+
+else
+    printf "[+] Generating node ID ...\n"
+    cd $gaianet_base_dir
+    wasmedge --dir .:. registry.wasm
+    printf "\n"
+fi
+
+# 11. Install gaianet-domain
 printf "[+] Installing gaianet-domain...\n"
 # Check if the directory exists, if not, create it
 if [ ! -d "$gaianet_base_dir/gaianet-domain" ]; then
@@ -452,17 +616,27 @@ else
     exit 1
 fi
 
-# Copy frpc from $gaianet_base_dir/gaianet-domain to $gaianet_base_dir/bin
+# Copy frpc binary from $gaianet_base_dir/gaianet-domain to $gaianet_base_dir/bin
 printf "    * Install frpc binary\n"
 cp $gaianet_base_dir/gaianet-domain/frpc $gaianet_base_dir/bin/
 info "      frpc binary is installed in $gaianet_base_dir/bin"
 
-# 11. Download frpc.toml, generate a subdomain and print it
-printf "    * Download frpc.toml\n"
-
-check_curl_silent https://github.com/GaiaNet-AI/gaianet-node/releases/download/$version/frpc.toml $gaianet_base_dir/gaianet-domain/frpc.toml
-
-info "      frpc.toml is downloaded in $gaianet_base_dir/gaianet-domain"
+# 12. Download frpc.toml, generate a subdomain and print it
+if [ "$upgrade" -eq 1 ]; then
+    # recover the frpc.toml
+    if [ -f "$gaianet_base_dir/backup/frpc.toml" ]; then
+        printf "    * Recover frpc.toml\n"
+        cp $gaianet_base_dir/backup/frpc.toml $gaianet_base_dir/gaianet-domain/frpc.toml
+        info "      frpc.toml is recovered in $gaianet_base_dir/gaianet-domain"
+    else
+        error "Failed to recover the frpc.toml. Reason: the frpc.toml does not exist in $gaianet_base_dir/backup/."
+        exit 1
+    fi
+else
+    printf "    * Download frpc.toml\n"
+    check_curl_silent https://github.com/GaiaNet-AI/gaianet-node/releases/download/$version/frpc.toml $gaianet_base_dir/gaianet-domain/frpc.toml
+    info "      frpc.toml is downloaded in $gaianet_base_dir/gaianet-domain"
+fi
 
 # Read address from config.json as node subdomain
 subdomain=$(awk -F'"' '/"address":/ {print $4}' $gaianet_base_dir/config.json)
@@ -495,48 +669,56 @@ $sed_i_cmd "s/name = \".*\"/name = \"$subdomain.$gaianet_domain\"/g" $gaianet_ba
 $sed_i_cmd "s/metadatas.deviceId = \".*\"/metadatas.deviceId = \"$device_id\"/g" $gaianet_base_dir/gaianet-domain/frpc.toml
 
 # Remove all files in the directory except for frpc and frpc.toml
-find $gaianet_base_dir/gaianet-domain -type f -not -name 'frpc' -not -name 'frpc.toml' -exec rm -f {} \;
+find $gaianet_base_dir/gaianet-domain -type f -not -name 'frpc.toml' -exec rm -f {} \;
 
-printf "[+] COMPLETED! The gaianet node has been installed successfully.\n\n"
+if [ "$upgrade" -eq 1 ]; then
 
-info "Your node ID is $subdomain. Please register it in your portal account to receive awards!"
+    printf "[+] COMPLETED! The gaianet node has been upgraded to v$version.\n\n"
 
-# Command to append
-cmd="export PATH=\"$bin_dir:\$PATH\""
+    info ">>> Next, you should run the command 'gaianet init' to initialize the GaiaNet node."
 
-shell="${SHELL#${SHELL%/*}/}"
-shell_rc=".""$shell""rc"
+else
+    printf "[+] COMPLETED! The gaianet node has been installed successfully.\n\n"
 
-# Check if the shell is zsh or bash
-if [[ $shell == *'zsh'* ]]; then
-    # If zsh, append to .zprofile
-    if ! grep -Fxq "$cmd" $HOME/.zprofile
-    then
-        echo "$cmd" >> $HOME/.zprofile
-    fi
+    info "Your node ID is $subdomain. Please register it in your portal account to receive awards!"
 
-    # If zsh, append to .zshrc
-    if ! grep -Fxq "$cmd" $HOME/.zshrc
-    then
-        echo "$cmd" >> $HOME/.zshrc
-    fi
+    # Command to append
+    cmd="export PATH=\"$bin_dir:\$PATH\""
 
-elif [[ $shell == *'bash'* ]]; then
+    shell="${SHELL#${SHELL%/*}/}"
+    shell_rc=".""$shell""rc"
 
-    # If bash, append to .bash_profile
-    if ! grep -Fxq "$cmd" $HOME/.bash_profile
-    then
-        echo "$cmd" >> $HOME/.bash_profile
-    fi
+    # Check if the shell is zsh or bash
+    if [[ $shell == *'zsh'* ]]; then
+        # If zsh, append to .zprofile
+        if ! grep -Fxq "$cmd" $HOME/.zprofile
+        then
+            echo "$cmd" >> $HOME/.zprofile
+        fi
+
+        # If zsh, append to .zshrc
+        if ! grep -Fxq "$cmd" $HOME/.zshrc
+        then
+            echo "$cmd" >> $HOME/.zshrc
+        fi
 
-    # If bash, append to .bashrc
-    if ! grep -Fxq "$cmd" $HOME/.bashrc
-    then
-        echo "$cmd" >> $HOME/.bashrc
+    elif [[ $shell == *'bash'* ]]; then
+
+        # If bash, append to .bash_profile
+        if ! grep -Fxq "$cmd" $HOME/.bash_profile
+        then
+            echo "$cmd" >> $HOME/.bash_profile
+        fi
+
+        # If bash, append to .bashrc
+        if ! grep -Fxq "$cmd" $HOME/.bashrc
+        then
+            echo "$cmd" >> $HOME/.bashrc
+        fi
     fi
-fi
 
-info ">>> Next, you should initialize the GaiaNet node with the LLM and knowledge base. To initialize the GaiaNet node, you need to\n>>> * Run the command 'source $HOME/$shell_rc' to make the gaianet CLI tool available in the current shell;\n>>> * Run the command 'gaianet init' to initialize the GaiaNet node."
+    info ">>> Next, you should initialize the GaiaNet node with the LLM and knowledge base. To initialize the GaiaNet node, you need to\n>>> * Run the command 'source $HOME/$shell_rc' to make the gaianet CLI tool available in the current shell;\n>>> * Run the command 'gaianet init' to initialize the GaiaNet node."
 
+fi
 
 exit 0
