Subscribe

UiPath Automation Suite

The UiPath Automation Suite Guide

Step 3: Post-deployment steps

This page provides instructions on the operations you can perform after deploying Automation Suite to AWS.

Validating the installation


  1. Under CloudFormation > Stacks, you can find all of your deployments.

  2. Click on the stack you deployed, a status of CREATE_COMPLETE indicates the deployment has completed successfully.

 

Updating certificates


🚧

Important!

The installation process generates self-signed certificates on your behalf. By default, these certificates expire after 1825 days, but you can choose any of the following expiry periods at the time of deployment: 90, 365, 730, 1825, or 3650 days.

You must replace the self-signed certificates with certificates signed by a trusted Certificate Authority (CA) as soon as the installation completes. If you do not update the certificates, the installation will stop working after the certificate expiry date.

For instructions, see Managing certificates.

 

Accessing the installer package


In AWS deployments, the installer package containing all the scripts for post-deployment operations is decompressed in the /root/installer directory.

 

Accessing the deployment outputs


  1. From the Stack you selected, click the Output tab on the top. On this tab, you should have access to all the information you need for next steps.

  2. For any of the credentials, you can access them via the secrets link provided in the table. Click on the link and go to Retrieve Secret Value for the credentials.

KeyValueDescription
ArgoCDhttps://alm.${CONFIG_CLUSTER_FQDN}You can use the ArgoCD console to manage installed products.
ArgoCD Secret< See link in console >Credentials for ArgoCD
Automation Suite Secret< See link in console >Credentials for Automation Suite Portal
Cluster Administration URLhttps://${CONFIG_CLUSTER_FQDN}/uipath-managementPortal centralizes the resources required to complete an Automation Suite installation and perform common post-installation operations.
Automation Suite URLhttps://${CONFIG_CLUSTER_FQDN}Automation Suite Portal
Host Administration Portalhttps://${CONFIG_CLUSTER_FQDN}The host portal is for system administrators to configure the Automation Suite instance. The settings that you configure from this portal are inherited by all your organizations, and some can be overwritten at the organization level.
Host Administration Secret< See link in console >Credentials for Host Administration
Interface TourInterface tourThe general-use Automation Suite user interface serves as a portal for both organization administrators and organization users. It is a common organization-level resource from where everyone can access all the Automation Suite areas: administration pages, platform-level pages, service-specific pages, and user-specific pages.
Rancherhttps://monitoring.${CONFIG_CLUSTER_FQDN}Automation Suite uses Rancher to provide cluster management tools out of the box. This helps you manage the cluster and access monitoring and troubleshooting.

 

Accessing the Cluster Administration portal


The Cluster Administration portal is a centralized location where you can find all the resources required to complete an Automation Suite installation and perform common post-installation operations. For details, see Getting started with the Cluster Administration portal.

To access the Cluster Administration portal, take the following step:

  1. Go to the following URL: https://${CONFIG_CLUSTER_FQDN}/uipath-management.

📘

You do not need any credentials to access the Cluster Administration portal.

 

Accessing the Automation Suite portal


The general-use Automation Suite user interface serves as a portal for both organization administrators and organization users. It is a common organization-level resource from where everyone can access all Automation Suite areas: administration pages, platform-level pages, service-specific pages, and user-specific pages.
For more details, see Interface tour.

To access Automation Suite, take the following steps:

  1. Go to the following URL: https://{CONFIG_CLUSTER_FQDN}.
  2. Switch to the Default organization.
  3. The username is orgadmin.
  4. Retrieve the password by clicking the secrets link provided in the output table for AutomationSuiteSecret. Go to Retrieve Secret Value for the credentials.

 

Accessing host administration


The host portal is where system administrators configure the Automation Suite instance. The settings configured from this portal are inherited by all your organizations, and some can be overwritten at the organization level.
For more on host administrators, see Managing system administrators.
For more on the host portal, see Interface tour.

To access host administration, take the following steps:

  1. Go to the following URL: https://{CONFIG_CLUSTER_FQDN}.
  2. Switch to the Host organization.
  3. The username is admin.
  4. Retrieve the password by clicking the secrets link provided in the output table for HostAdministrationSecret. Go to Retrieve Secret Value for the credentials.

 

Accessing ArgoCD


You can use the ArgoCD console to manage installed products.

To access ArgoCD, take the following steps:

  1. Go to the following URL: https://alm.${CONFIG_CLUSTER_FQDN}.
  2. The username is admin if you want to use the ArgoCD admin account, or argocdro if you want to use the ArgoCD read-only account.
  3. Retrieve the password by clicking to the secrets link provided in the output table for ArgoCdSecret. Go to Retrieve Secret Value for the credentials.

 

Accessing Rancher


Automation Suite uses Rancher to provide cluster management tools out of the box. This helps you manage the cluster and access monitoring and troubleshooting.
For more details, see Rancher documentation.
For more on how to use Rancher monitoring in Automation Suite, see Using the monitoring stack.

To access the Rancher console, take the following steps:

  1. Go to the following URL: https://monitoring.${CONFIG_CLUSTER_FQDN}
  2. The username is admin.
  3. To access the password, run the following command on a server node:
kubectl get secrets/rancher-admin-password -n cattle-system \
-o "jsonpath={.data['password']}" | echo $(base64 -d)

📘

Note:

Make sure kubectl is enabled. For more information, see Accessing Automation Suite.

 

Accessing cluster VMs


  1. Navigate to EC2 and find your Automation Suite instance(s) depending if you deployed single-node or multi-node.
  2. Find the public IP of the Bastion or instance you want to connect to.
1640
  1. Open a terminal and use SSH to connect to Bastion.
ssh -i <path_to_private_key> <username>@<bastion_ip>
  1. From Bastion, you can access other nodes via SSH using the following command. The username must be the same as the one used to connect to Bastion.
ssh -i .ssh/private_key <username>@<node_address>

 

Performing cluster operations


The templates provide automations for cluster operations leveraging Systems Manager documents.

Using Systems Manager documents

To use the Systems Manager documents, take the following steps:

  1. Go to the Systems Manager service.
787
  1. In the left menu, click Documents.
1908
  1. In the Owned by me tab, click the SSM document you want to run.
1836
  1. Click the Execute automation button.
1821
  1. Fill in the parameters and click the Execute button.
1822

 

UpdateAMIDocument

Description

The SSM document creates a new Launch Template version for the server and agent Automatic Scaling Groups with an updated AMI ID.

Usage

The document exposes 2 parameters:

  • ImageName (e.g.: RHEL-8.6*_HVM-20*) – If the ImageName parameter is provided and AMI that matches the ImageName will be set on the Automatic Scaling Groups;
  • AmiId (e.g.: ami-032e5b6af8a711f30) – If provided, the AmiId takes precedence over ImageName and is set on the Automatic Scaling Groups.

If you did not use a custom AMI at deployment time, you can leave the parameters empty. In this case, the ImageName stored in Parameter Store is used as default value.

 

RegisterAiCenter

Description

The SSM document registers AI Center to the external Orchestrator provided at deployment time.

Usage

The document exposes a single, mandatory, parameter: IdentityToken, which is an installation access token generated by the external Identity service. Since the token has a short availability (approximately 1-2 hours), we recommend generating it just before running the SSM document. For instructions, see Installation key.

 

OnDemandBackup

Description

Creates a snapshot of the Automation Suite cluster. Does not perform a backup on the SQL server.

Usage

This SSM document does not require any parameters.

Execution logs

To check the logs of the file, click the Step ID for the captureOnDemandBackup step.

2446

 

GetAllBackups

Description

Lists all snapshot available in the Automation Suite cluster.

Usage

This SSM document does not require any parameters.

Execution logs

To check the list of available snapshots, click the Step ID for the getSnapshotList step.

1835

 

OnDemandRestore

Description

Restores the Automation Suite cluster to a snapshot.

Usage

The SSM document exposes the SnapshotName parameter. To get a snapshot, use the GetAllBackups document and check the logs.

Execution logs

To view the execution logs, take the following steps:

  1. See the restore flow by clicking State machines.
852
  1. Click OnDemandRestoreStateMachine.
1592
  1. Click the name of the running execution.
1592
  1. Click the step for which you want to check the execution logs and look in the output section for the CommandInformation.CommandId and copy it.
1842
  1. Go to the Run Command service.
880
  1. In Command history, search for the command ID you copied earlier.
1625
  1. Click the instance ID.
1638
  1. In the output section, click CloudWatch Logs to see the full logs.
1629

 

Completing an upgrade


After performing an Automation Suite cluster upgrade, AWS template deployments require some changes to ensure a new node joins the cluster correctly. To automate the changes, we recommend using the dedicated script. For instructions, see the AWS deployment template docs.

Updated 2 days ago


Step 3: Post-deployment steps


This page provides instructions on the operations you can perform after deploying Automation Suite to AWS.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.