Automation Suite
2022.4
false
Banner background image
Automation Suite Installation Guide
Last updated Apr 24, 2024

Manual, Offline: Restoring the Cluster

Before You Begin

  • Make sure you meet the Prerequisites.
  • Make sure the backup is disabled on the backup cluster. Inconsistencies will occurs if a new backup is created while cluster restore is in progress. See Disabling the backup on the cluster.
  • Make sure package wget, unzip, jq are available on all the restore nodes.
  • All external data sources must be the same (SQL Server).
  • Restart the NFS server before restoring the cluster by running the following command on the NFS server node: systemctl restart nfs-server.
  • The restore cluster should have the same FQDN as the backup cluster.

    Installation type

    Configuration instructions

    Requirements

    Offline single-node evaluation mode

    Download the following files:

    • sf-installer.zipMandatory. See sf-installer.zip for download instructions.
    • sf-infra.tar.gzMandatory. See sf-infra.tar.gz for download instructions.

    Offline multi-node HA-ready production mode

    Download below files

    • sf-installer.zipMandatory. See sf-installer.zip for download instructions.
    • sf-infra.tar.gzMandatory. See sf-infra.tar.gz for download instructions.

Preparing the Restore Operation

Important: If you have multiple nodes in the cluster, follow these steps on all the nodes.
  1. Log into any machine.
  2. To create the /opt/UiPathAutomationSuite folder, run:
    # Become root
    sudo su -
    
    # Replace {version} with actual installer version
    
    mkdir -p /opt/UiPathAutomationSuite/{version}/installer
    chmod -R 777 /opt/UiPathAutomationSuite# Become root
    sudo su -
    
    # Replace {version} with actual installer version
    
    mkdir -p /opt/UiPathAutomationSuite/{version}/installer
    chmod -R 777 /opt/UiPathAutomationSuite
  3. To copy restore.json and other installer files to the /opt/UiPathAutomationSuite/{version} folder, run the following command. For details, see Preparing the restore configuration.
    # Replace {version} with actual installer version
    
    cp /path/to/restore.json /opt/UiPathAutomationSuite/${version}/installer
    cp /path/to/sf-installer.zip /opt/UiPathAutomationSuite/${version}/installer
    cp /path/to/sf-infra.tar.gz /opt/UiPathAutomationSuite/${version}# Replace {version} with actual installer version
    
    cp /path/to/restore.json /opt/UiPathAutomationSuite/${version}/installer
    cp /path/to/sf-installer.zip /opt/UiPathAutomationSuite/${version}/installer
    cp /path/to/sf-infra.tar.gz /opt/UiPathAutomationSuite/${version}
  4. To unzip sf-installer.zip, run:
    # Navigate to installer folder. Replace {version} with actual installer version
    cd /opt/UiPathAutomationSuite/${version}/installer
    
    unzip sf-installer.zip -d .# Navigate to installer folder. Replace {version} with actual installer version
    cd /opt/UiPathAutomationSuite/${version}/installer
    
    unzip sf-installer.zip -d .

Restoring Etcd on the First Server Node

To restore etcd on the first node of the cluster, run:

./install-uipath.sh -i restore.json -o output.json -r --offline-bundle "../sf-infra.tar.gz" --offline-tmp-folder /opt/UiPathAutomationSuite/tmp --install-offline-prereqs --accept-license-agreement --install-type offline./install-uipath.sh -i restore.json -o output.json -r --offline-bundle "../sf-infra.tar.gz" --offline-tmp-folder /opt/UiPathAutomationSuite/tmp --install-offline-prereqs --accept-license-agreement --install-type offline
Note: This command restores the node configuration only on the first server node.

Restoring Etcd on the Remaining Server Nodes

To restore etcd on the other server nodes of the cluster, run:

./install-uipath.sh -i ../restore.json -o output.json -r -j server --offline-bundle "../sf-infra.tar.gz" --offline-tmp-folder /opt/UiPathAutomationSuite/tmp --install-offline-prereqs --accept-license-agreement --install-type offline./install-uipath.sh -i ../restore.json -o output.json -r -j server --offline-bundle "../sf-infra.tar.gz" --offline-tmp-folder /opt/UiPathAutomationSuite/tmp --install-offline-prereqs --accept-license-agreement --install-type offline
Note: This command restores the node configuration on the remaining server nodes.

Restoring Etcd on Agent Nodes

To restore etcd on agent nodes of the cluster, run:

./install-uipath.sh -i restore.json -o output.json -r -j agent --offline-bundle "../sf-infra.tar.gz" --offline-tmp-folder /opt/UiPathAutomationSuite/tmp --install-offline-prereqs --accept-license-agreement --install-type offline./install-uipath.sh -i restore.json -o output.json -r -j agent --offline-bundle "../sf-infra.tar.gz" --offline-tmp-folder /opt/UiPathAutomationSuite/tmp --install-offline-prereqs --accept-license-agreement --install-type offline
Note: This command restores the node configuration on the remaining agent nodes.

Restoring Etcd on Task Mining Nodes

To restore etcd on Task Mining agent nodes of the cluster, run:

./install-uipath.sh -i restore.json -o output.json -r -j task-mining --offline-bundle "../sf-infra.tar.gz" --offline-tmp-folder /opt/UiPathAutomationSuite/tmp --install-offline-prereqs --accept-license-agreement --install-type offline./install-uipath.sh -i restore.json -o output.json -r -j task-mining --offline-bundle "../sf-infra.tar.gz" --offline-tmp-folder /opt/UiPathAutomationSuite/tmp --install-offline-prereqs --accept-license-agreement --install-type offline
Note: This command restores the node configuration on the Task Mining nodes.

Restoring Etcd on GPU Nodes

Note: Before restoring the GPU machine, make sure you have followed Installing a GPU driver on the machine.

To restore etcd on GPU agent nodes of the cluster, run:

./install-uipath.sh -i restore.json -o output.json -r -j gpu --offline-bundle "../sf-infra.tar.gz" --offline-tmp-folder /opt/UiPathAutomationSuite/tmp --install-offline-prereqs --accept-license-agreement --install-type offline./install-uipath.sh -i restore.json -o output.json -r -j gpu --offline-bundle "../sf-infra.tar.gz" --offline-tmp-folder /opt/UiPathAutomationSuite/tmp --install-offline-prereqs --accept-license-agreement --install-type offline
Note: This command restores the node configuration on the remaining GPU nodes.

Disabling the Maintenance Mode

Note: This step is required only if the restore is part of the rollback operation during the upgrade.

Before restoring the volume, you need to disable the maintenance mode:

./configureUiPathAS.sh disable-maintenance-mode./configureUiPathAS.sh disable-maintenance-mode

Running Volume Restore on Any Server Node

Once the etcd restore is complete, restore the volume on any of the server node by running:

\./install-uipath.sh -i restore.json -o output.json -r --volume-restore --accept-license-agreement --install-type offline\./install-uipath.sh -i restore.json -o output.json -r --volume-restore --accept-license-agreement --install-type offline
Note: This command restores the volume data on the cluster.

Enabling AI Center on the Restored Cluster

After restoring an Automation Suite cluster with AI Center™ enabled, follow the steps from the Enabling AI Center on the Restored Cluster procedure.

Restoring Cluster_config.json

Following the Automation Suite cluster recovery, you may want to recover the cluster_config.json for future. You may need it when adding new nodes to the cluster, when upgrading, etc.
To restore cluster_config.json, run the following command from any of the server nodes:
./configureUiPathAS.sh config get -o ./cluster_config.json./configureUiPathAS.sh config get -o ./cluster_config.json
Note: The backup is not enabled on the restored cluster. If you want to enable the backup, refer to Enabling the backup on the cluster.

Adding CA certificates to the trust store

After restoring the cluster, make sure to add your CA certificates to the trust store of the restored VMs. For details, see:

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.