automation-suite
2021.10
false
UiPath logo, featuring letters U and I in white
OUT OF SUPPORT

Automation Suite installation guide

Last updated Feb 24, 2025

Online Single-node Evaluation Mode

Preparation

  1. Make sure that there is enough disk space on the node. For more details, see Hardware requirements.
  2. Download and unzip the new installer (installer.zip) on the server.
    1. Connect to the machine using SSH.
      • If you set a password, the command is as follows: ssh <user>@<dns_of_vm>
      • If you used an SSH key, the command is as follows: ssh -i <path/to/Key.pem> <user>@<dns_of_vm>
    2. Become root:
      sudo su -sudo su -
    3. Move to home directory:
      cd ~cd ~
    4. Download the installation package. Make sure to keep the ' (single quotes) around the download URL.
      wget 'https://download.uipath.com/automation-suite/installer.zip' -O installer.zipwget 'https://download.uipath.com/automation-suite/installer.zip' -O installer.zip
    5. Create an installation folder and unzip the installation package:
      mkdir /opt/UiPathAutomationSuite/<installer-folder> -R
unzip ./installer.zip -d /opt/UiPathAutomationSuite/<installer-folder>mkdir /opt/UiPathAutomationSuite/<installer-folder> -R
unzip ./installer.zip -d /opt/UiPathAutomationSuite/<installer-folder>
    6. Give proper permissions to the folder by running the following command:
      sudo chmod 755 -R /opt/UiPathAutomationSuite/<installer-folder>sudo chmod 755 -R /opt/UiPathAutomationSuite/<installer-folder>
  3. Make the original cluster_config.json file available on the server.
  4. Generate the new cluster_config.json file as follows:
    • If you have the old cluster_config.json , use the following command to generate the configuration file from the cluster: cd /path/to/new-installer ./configureUiPathAS.sh config get -i /path/to/old/cluster_config.json -o /path/to/store/generated/cluster_config.json
    • If you do not have the old cluster_config.json file, run the following command: cd /path/to/new-installer ./configureUiPathAS.sh config get -o /path/to/store/generated/cluster_config.json
    Note: For details on how to configure the cluster_config.json parameters, see Advanced installation experience.

Execution

Maintenance and Backup

  1. Make sure you enabled the backup on the cluster. For details, see Backing up and restoring the cluster.
  2. Connect to the server node via SSH.
  3. Verify that all desired volumes have backups in the cluster by running the following command:
    /path/to/new-installer/configureUiPathAS.sh verify-volumes-backup/path/to/new-installer/configureUiPathAS.sh verify-volumes-backup
    Note: The backup might take some time, so wait for approximately 15-20 minutes, and then verify the volumes backup again.
  4. To verify if Automation Suite is healthy, run:
    kubectl get applications -n argocdkubectl get applications -n argocd
  5. Put the cluster in maintenance mode as follows:
    1. Execute the following command:
      /path/to/new-installer/configureUiPathAS.sh enable-maintenance-mode/path/to/new-installer/configureUiPathAS.sh enable-maintenance-mode
    2. Verify that the cluster is in maintenance mode by running the following command:
      /path/to/new-installer/configureUiPathAS.sh is-maintenance-enabled/path/to/new-installer/configureUiPathAS.sh is-maintenance-enabled
  6. Make an SQL database backup.

Upgrade Infrastructure and Services on Servers

  1. Connect to the server via SSH.
  2. Become root by running sudo su -.
  3. Upgrade the infrastructure and servers by running the following command:
    /path/to/new-installer/install-uipath.sh --upgrade -k -f -s -i /path/to/cluster_config.json --accept-license-agreement -o /path/to/output.json/path/to/new-installer/install-uipath.sh --upgrade -k -f -s -i /path/to/cluster_config.json --accept-license-agreement -o /path/to/output.json
    Note: This command disables the maintenance mode that you enabled before the upgrade because all services are required to be up during the upgrade. The command also creates a backup of the cluster state and pauses all other scheduled backups.
  4. After the successful upgrade and verification, resume the backup scheduling on the node by running the following command:
    /path/to/new-installer/configureUiPathAS.sh resume-scheduled-backups/path/to/new-installer/configureUiPathAS.sh resume-scheduled-backups

Rollback on Error

Preparation

  1. Create a separate folder to store older bundles, and perform the following operations inside that folder.
  2. Download and unzip the installer of the older version (installer.zip) on the node.
    Note: Give proper permissions to the folder by running sudo chmod 755 -R <installer-folder>.
  3. Create a restore.json file and copy it to all the nodes. For details, see Backing up and restoring the cluster.
  4. Verify that the etcd backup data is present on the primary server at the following location: /mnt/backup/backup/<etcdBackupPath>/<node-name>/snapshots.
    • etcdBackupPath - this is the same as the one specified in backup.json while enabling the backup's node-name;
    • node-name - the hostname of the primary server VM.

Cluster Cleanup

  1. Copy and run the dedicated script to uninstall everything from that node. Do this for all the nodes. For details, see Troubleshooting.
  2. Restore all UiPath databases to the backup created before the upgrade.

Restore Infra on Server Nodes

  1. Connect to the server via SSH.
  2. Restore infra by running the following command:
    /path/to/older-installer/install-uipath.sh -i /path/to/restore.json -o /path/to/output.json -r --accept-license-agreement --install-type online/path/to/older-installer/install-uipath.sh -i /path/to/restore.json -o /path/to/output.json -r --accept-license-agreement --install-type online

Restore Volumes Data

  1. Connect to the server via SSH.
  2. Go to the new installer folder.
    Note: The previous infra restore commands were executed using the old installer, and the following commands are executed using the new installer bundle.
  3. Disable the maintenance mode on the cluster by running the following command:
    /path/to/new-installer/configureUiPathAS.sh disable-maintenance-mode/path/to/new-installer/configureUiPathAS.sh disable-maintenance-mode
  4. Verify that maintenance mode is disabled by running the following command:
    /path/to/new-installer/configureUiPathAS.sh is-maintenance-enabled/path/to/new-installer/configureUiPathAS.sh is-maintenance-enabled
  5. Copy the restore.json file that was used in the infra restore stage to the new installer bundle folder.
  6. Restore volumes by running the following command from the newer installer bundle:
    /path/to/new-installer/install-uipath.sh -i /path/to/new-installer/restore.json -o /path/to/new-installer/output.json -r --volume-restore --accept-license-agreement --install-type online/path/to/new-installer/install-uipath.sh -i /path/to/new-installer/restore.json -o /path/to/new-installer/output.json -r --volume-restore --accept-license-agreement --install-type online
  7. Once the restore is completed, verify if everything is restored and working properly.
  8. During the upgrade, scheduled backups were disabled on the primary node. To enable them again, run the following command:
    /path/to/new-installer/configureUiPathAS.sh resume-scheduled-backups/path/to/new-installer/configureUiPathAS.sh resume-scheduled-backups

Was this page helpful?

Support and Services
Get The Help You Need
UiPath Academy
Learning RPA - Automation Courses
UiPath Forum
UiPath Community Forum
Uipath Logo
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2025 UiPath. All rights reserved.