KEMBAR78
UiPath Automation Suite deployment and support | PDF
Automation Suite On AKS/EKS
2
Meet the Presenter
Vikash Kumar
Principal Product Support Engineer
3
▪ Introduction
▪ Automation Suite Overview
▪ Automation Suite Products
▪ Deployment Options
▪ AS on AKS/EKS
▪ Installation Walkthrough/Best Practices
▪ Preparing for the Installation
▪ Input parameters
▪ Installation
▪ Post-Installation Operations
▪ Managing the certificates
▪ Cluster Administration
▪ Backup & Restore
▪ Monitoring, Troubleshooting & Maintenance
▪ Alerts, Metrics and Logs
▪ Diagnostic tool, Support bundle tool
▪ Connecting to UiPath Support
▪ Q&A
Agenda
4
Introduction
Automation Suite enables you to deploy the UiPath business automation platform in your environment of your choice.
Depending on your needs, you can deploy the platform on Linux servers (bare-metal or virtual machines) in your data center or
public cloud (Azure, AWS, or GCP), or on your Kubernetes clusters in Amazon Web Services (Elastic Kubernetes Service) or
Microsoft Azure (Azure Kubernetes Service)
Managing multiple server product deployments independently usually requires configuring integrations with enterprise
systems for authenticating and managing users, as well as managing and monitoring each deployment from an availability and
scale perspective.
Automation Suite contains everything in one package that you can deploy in multi-node HA-ready production mode with
automatic scaling and built-in HA, and monitor, configure, and upgrade as a whole. All the functionality available in Automation
Cloud is adapted to make it easier for you to manage everything yourself with low total cost of ownership.
Automation Suite on AKS allows you to bring and manage your own Kubernetes cluster, dedicated to Automation Suite.
Key Benefits-
5
Automation Suite lets you manage your self-hosted UiPath platform as one product where
Shared Suite Capabilities enable you to easily configure the integration with existing enterprise
systems, such as AD, AAD, or SAML, across all products; a common experience is offered
across the suite for the user, tenant, external applications, and license management in a
common end user portal. This is hosted on Kubernetes-based infrastructure which enables
running all the products at scale and with HA.
The following products are part of the Automation Suite bundle. You can enable or disable
products at any time after their installation.
Automation Suite products
•Document Understanding
•Insights
•Orchestrator
•Automation Suite Robots
•Process Mining
•Task Mining
•Test Manager
•Action Center
•AI Center
•AI Computer Vision
•Apps
•Automation Hub
•Automation Ops
•Data Service
6
Deployment Option
Individual Products
UiPath Platform products
individually installed
and managed
Automation Cloud
The cloud native UiPath
Platform delivered as SaaS
from UiPath
No installation required – start
instantly, scale infinitely
One-package install on-prem (including
air-gapped) or in public cloud Linux VM,
or in existing AKS/EKS cluster
Available products installed on
supported operating systems and
physical/virtual hardware
Automation Suite
The cloud native UiPath
Platform delivered as a single
installation package
6
All the products*
Integrated High Availability, backup and scale management
Integrated UiPath Portal suite experience, and shared suite functionality
Unified admin experience for organization, tenant, user and license management
*All server products except Integration Service, which is planned for future updates
7
AS on AKS- Stacks
There are 3 stacks-
1. UiPath® managed: UiPath® services and
components optimized for Automation Suite
provided and supported by UiPath®.
2. Optional to install: If you have the same
components pre-configured in your
Kubernetes cluster, you can choose to skip
installing them via Automation Suite. In this
case, you will manage the lifecycle of these
components.
3. Customer managed: Prerequisites for
deploying Automation Suite on your cloud
infrastructure managed and supported by
customer. For supported EKS/AKS
configurations, see the Compatibility matrix.
8
Scenarios
An AKS cluster is deployed in a single region
where the worker nodes are distributed across
the system and user node pools. The core AKS
components (except the control plane)are hosted
in the system node pool, such as CNI, CoreDNS,
etc. Additionally, UiPath® core services are also
hosted in the same Node Pool. Additional User
Node Pools can host the worker nodes for
Automation Suite Robots, Task Mining, and GPU.
The static IP address associated with the Load
Balancer is passed to Automation Suite during
installation to register that as an endpoint where
Istio must listen for any incoming traffic. For the
same reason, Azure Load Balancer (L4) must use
these endpoints to forward any request to
Automation Suite.
Datasources such as Microsoft SQL Server, Azure
Storage Account, and Azure Redis Cache should
be set up to have enough redundancy in case of
failure and must be accessed from the subnet
where the AKS worker nodes are hosted.
Online Deployment Offline Deployment
Deployment- AKS
9
Overview
An EKS cluster is deployed in a single AWS region,
where the EC2 worker nodes are in an autoscaling
group distributed across three availability zones. The
distribution of nodes across availability zones is what
brings resiliency to complete zone failure.
Each zone has a private subnet and a public subnet.
EC2 worker nodes are hosted in a private subnet,
whereas the public subnet hosts an elastic IP address
and NAT gateway. The NAT gateway is required to
connect to the internet while accessing the EKS control
plane from the worker nodes and connecting to the
docker registry to get the container images for the
Automation Suite deployment.
Elastic IP addresses hosted in each public subnet are
passed to Automation Suite during installation to
register that as an endpoint where Istio must listen for
any incoming traffic. For the same reason, the Network
Load Balancer (NLB) must use these endpoints to
forward any request made to Automation Suite.
Datasources such as Amazon RDS for Microsoft SQL
Server, S3 bucket, Elastic File System, and Elastic Cache
should be set up to have enough redundancy in case of
failure and must be accessed from the private subnet
where the EC2 worker instances are hosted.
Online Deployment Offline Deployment
Deployment- EKS
10
Installation Walkthrough/Best Practices
Setting up the infrastructure-
1. Requirements-
kubernetes-cluster-and-nodes
Proxy
SQL Database
Caching
Storage
Network
Certificate
2. Capacity planning
To calculate the minimum resources required for deploying any Automation Suite products, use the UiPath Automation Suite Install Sizing Calculator.
3. Preparing the input.json file
11
Installation Walkthrough/Best Practices
Common Best Practices-
Swap – Disabled
Best Practices-
• Ensure that the requirements are met.
• Ensure that the SQL server connectivity is there, and the connection strings are in required format
• Role of DB user should be validated.
• Ensure that the required ports are open, as well as reun the preinstall validation check to ensure all the prerequisites are
in place-
https://docs.uipath.com/automation-suite/automation-suite/2023.10/installation-guide-eks-aks/prerequisite-checks
Output Example- https://docs.uipath.com/automation-suite/automation-suite/2023.10/installation-guide-eks-aks/output-
example-prerequisite-check
Run the installer if all the checks are successful-
https://docs.uipath.com/automation-suite/automation-suite/2023.10/installation-guide-eks-aks/installing-automation-suite-on-
eksaks
Output Example - https://docs.uipath.com/automation-suite/automation-suite/2023.10/installation-guide-eks-aks/output-
example-automation-suite-installation
12
Post-Installation Operations
Managing the certificates
• TLS Certificate-
• Managing identity token-signing certificates
• Managing additional CA certificates
uipathctl config update-tls-certificates –help
Updating the tls certificate-
uipathctl config tls-certificates update --cert server.crt --cacert ca.crt --key server.key
Accessing TLS certificate-
uipathctl config tls-certificates get
uipathctl config token-signing-certificates –help
Updating the token-signing certificate-
uipathctl config token-signing-certificates update --cert server.crt --key server.key
Accessing token-signing certificate-
uipathctl config token-signing-certificates get
uipathctl config additional-ca-certificates --help
Updating additional ca certificate-
uipathctl config additional-ca-certificates update --cacert additional_ca.crt
Accessing the CA certificates
uipathctl config additional-ca-certificates get
13
Post-Installation Operations
Cluster Administration-
- Database maintenance
- Using splunk to monitor the logs
Backup & Restore-
- Configuring the backup – To configure the backup, add backup config to input.json file and run the below command
./uipathctl manifest apply input.json --only velero --versions versions.json
- Taking a backup-
Enable a scheduled backup - ./uipathctl snapshot backup enable --schedule "*/45 * * * *" --retention 168h --prefix "mysnapshot”
Disable a backup- ./uipathctl snapshot disable --prefix <prefix_name>
List a backup - ./uipathctl snapshot list
On demand backup - ./uipathctl snapshot backup create <snapshot_name>
14
Monitoring- Troubleshooting & Maintenance
Using the monitoring stack-
Troubleshooting –
Diagnostic Tool - https://docs.uipath.com/automation-suite/automation-suite/2023.10/installation-guide-eks-
aks/running-the-diagnostics-tool
Support Bundle Tool - https://docs.uipath.com/automation-suite/automation-suite/2023.10/installation-guide-eks-
aks/running-the-support-bundle-tool
- You can use uipathctl diagnostic tool for health checks and based on the outcome, if there is an error, either check
the documentation, forum or knowledgebase on customer portal to find a probable solution, if that doesn’t help.
Reach out to UiPath product support team for further help.
15
Monitoring: Application Health in ArgoCD
• To check health status for all
apps, including UiPath
products
• AS and other components
version check
• To Check the sync status
• To check health status of
pods and SVCs
• To check the logs, Events and
configurations
16
There are multiple channels through which you can reach out to UiPath Support-
1. Customer Portal - It’s a one-stop shop where you can create tickets and, at the
same time, see a history of all your closed and in progress cases, and access our
knowledge base articles. Being enrolled under one of our Success Support
programs, gives you the option to request for services through the portal. The
primary medium to reach out to support is our Webform present on our portal. If you
are authenticated through your license key, you can create a case by providing us
the following information:
• Contact details of the person creating the ticket.
• Product component affected.
• The UiPath platform version in use.
• The affected environment(s) (Production, Dev, etc.).
• The priority of the reported issue (only select the priority from urgent,
high, medium, low).
• The number of affected robots.
• Description of the issue.
• Relevant error messages / logs related to the issue
2. Incident Support Call Center- This service is available for the success tier
customers where they can reach out to the Incident Support Call Center to request
information regarding the status of your cases or to find out more about your cases.
You can also request the Incident Support Call Center representatives to help you
with extraction of the right logs and for updating the cases. Toll free numbers for the
Incident Support Call Center can be accessed by our Success tier customers via the
Customer Portal.
How to Reach to UiPath Support
17
➢ Always be on the supported product versions: You are expected to use the supported
versions. UiPath will not be able to extend support if your organization is using an out-of-
support version or any unsupported activities package. For the supported version details,
click on the following URL: https://docs.uipath.com/overview/other/latest/ overview/product-
lifecycle
➢ Provide complete, accurate and timely information: Always provide complete information in
your initial ticket to ensure expedited resolution. The Support Engineer may ask for various
logs to perform the troubleshooting; timely replies from your end will ensure the ticket
resolution at the earliest.
➢ Adhere to UiPath best practices: Always provide the right priority assessment and ensure
that every ticket has only one issue mentioned. Multiple issues tagged to a single ticket will
not be accepted by UiPath.
➢ Plan ahead: Before going ahead with any upgrades or installations please go through the
guides. These are available on the UiPath website. We recommend that you follow the
guidelines laid in these documents and have a “crisis” plan in place that will provide UiPath
support reasonable time to respond. Click on the URL for the UiPath product guides:
https://docs.uipath.com/
➢ Ensure you have the right resources and access: Many times troubleshooting gets affected
as the person raising the issue does not have the right access or the right person from IT
team is not available. This affects the resolution timelines.
➢ Use the self-help documents and guides: UiPath has created a robust Knowledge base
repository based on the experience of our Support engineers. Many times customers can
resolve the issues themselves just by referring to these articles.
Best practices for expedited case resolution
Q&A
The UiPath word mark, logos, and robots are registered trademarks owned by UiPath, Inc. and its affiliates.
©2023 UiPath. All rights reserved.

UiPath Automation Suite deployment and support

  • 1.
  • 2.
    2 Meet the Presenter VikashKumar Principal Product Support Engineer
  • 3.
    3 ▪ Introduction ▪ AutomationSuite Overview ▪ Automation Suite Products ▪ Deployment Options ▪ AS on AKS/EKS ▪ Installation Walkthrough/Best Practices ▪ Preparing for the Installation ▪ Input parameters ▪ Installation ▪ Post-Installation Operations ▪ Managing the certificates ▪ Cluster Administration ▪ Backup & Restore ▪ Monitoring, Troubleshooting & Maintenance ▪ Alerts, Metrics and Logs ▪ Diagnostic tool, Support bundle tool ▪ Connecting to UiPath Support ▪ Q&A Agenda
  • 4.
    4 Introduction Automation Suite enablesyou to deploy the UiPath business automation platform in your environment of your choice. Depending on your needs, you can deploy the platform on Linux servers (bare-metal or virtual machines) in your data center or public cloud (Azure, AWS, or GCP), or on your Kubernetes clusters in Amazon Web Services (Elastic Kubernetes Service) or Microsoft Azure (Azure Kubernetes Service) Managing multiple server product deployments independently usually requires configuring integrations with enterprise systems for authenticating and managing users, as well as managing and monitoring each deployment from an availability and scale perspective. Automation Suite contains everything in one package that you can deploy in multi-node HA-ready production mode with automatic scaling and built-in HA, and monitor, configure, and upgrade as a whole. All the functionality available in Automation Cloud is adapted to make it easier for you to manage everything yourself with low total cost of ownership. Automation Suite on AKS allows you to bring and manage your own Kubernetes cluster, dedicated to Automation Suite. Key Benefits-
  • 5.
    5 Automation Suite letsyou manage your self-hosted UiPath platform as one product where Shared Suite Capabilities enable you to easily configure the integration with existing enterprise systems, such as AD, AAD, or SAML, across all products; a common experience is offered across the suite for the user, tenant, external applications, and license management in a common end user portal. This is hosted on Kubernetes-based infrastructure which enables running all the products at scale and with HA. The following products are part of the Automation Suite bundle. You can enable or disable products at any time after their installation. Automation Suite products •Document Understanding •Insights •Orchestrator •Automation Suite Robots •Process Mining •Task Mining •Test Manager •Action Center •AI Center •AI Computer Vision •Apps •Automation Hub •Automation Ops •Data Service
  • 6.
    6 Deployment Option Individual Products UiPathPlatform products individually installed and managed Automation Cloud The cloud native UiPath Platform delivered as SaaS from UiPath No installation required – start instantly, scale infinitely One-package install on-prem (including air-gapped) or in public cloud Linux VM, or in existing AKS/EKS cluster Available products installed on supported operating systems and physical/virtual hardware Automation Suite The cloud native UiPath Platform delivered as a single installation package 6 All the products* Integrated High Availability, backup and scale management Integrated UiPath Portal suite experience, and shared suite functionality Unified admin experience for organization, tenant, user and license management *All server products except Integration Service, which is planned for future updates
  • 7.
    7 AS on AKS-Stacks There are 3 stacks- 1. UiPath® managed: UiPath® services and components optimized for Automation Suite provided and supported by UiPath®. 2. Optional to install: If you have the same components pre-configured in your Kubernetes cluster, you can choose to skip installing them via Automation Suite. In this case, you will manage the lifecycle of these components. 3. Customer managed: Prerequisites for deploying Automation Suite on your cloud infrastructure managed and supported by customer. For supported EKS/AKS configurations, see the Compatibility matrix.
  • 8.
    8 Scenarios An AKS clusteris deployed in a single region where the worker nodes are distributed across the system and user node pools. The core AKS components (except the control plane)are hosted in the system node pool, such as CNI, CoreDNS, etc. Additionally, UiPath® core services are also hosted in the same Node Pool. Additional User Node Pools can host the worker nodes for Automation Suite Robots, Task Mining, and GPU. The static IP address associated with the Load Balancer is passed to Automation Suite during installation to register that as an endpoint where Istio must listen for any incoming traffic. For the same reason, Azure Load Balancer (L4) must use these endpoints to forward any request to Automation Suite. Datasources such as Microsoft SQL Server, Azure Storage Account, and Azure Redis Cache should be set up to have enough redundancy in case of failure and must be accessed from the subnet where the AKS worker nodes are hosted. Online Deployment Offline Deployment Deployment- AKS
  • 9.
    9 Overview An EKS clusteris deployed in a single AWS region, where the EC2 worker nodes are in an autoscaling group distributed across three availability zones. The distribution of nodes across availability zones is what brings resiliency to complete zone failure. Each zone has a private subnet and a public subnet. EC2 worker nodes are hosted in a private subnet, whereas the public subnet hosts an elastic IP address and NAT gateway. The NAT gateway is required to connect to the internet while accessing the EKS control plane from the worker nodes and connecting to the docker registry to get the container images for the Automation Suite deployment. Elastic IP addresses hosted in each public subnet are passed to Automation Suite during installation to register that as an endpoint where Istio must listen for any incoming traffic. For the same reason, the Network Load Balancer (NLB) must use these endpoints to forward any request made to Automation Suite. Datasources such as Amazon RDS for Microsoft SQL Server, S3 bucket, Elastic File System, and Elastic Cache should be set up to have enough redundancy in case of failure and must be accessed from the private subnet where the EC2 worker instances are hosted. Online Deployment Offline Deployment Deployment- EKS
  • 10.
    10 Installation Walkthrough/Best Practices Settingup the infrastructure- 1. Requirements- kubernetes-cluster-and-nodes Proxy SQL Database Caching Storage Network Certificate 2. Capacity planning To calculate the minimum resources required for deploying any Automation Suite products, use the UiPath Automation Suite Install Sizing Calculator. 3. Preparing the input.json file
  • 11.
    11 Installation Walkthrough/Best Practices CommonBest Practices- Swap – Disabled Best Practices- • Ensure that the requirements are met. • Ensure that the SQL server connectivity is there, and the connection strings are in required format • Role of DB user should be validated. • Ensure that the required ports are open, as well as reun the preinstall validation check to ensure all the prerequisites are in place- https://docs.uipath.com/automation-suite/automation-suite/2023.10/installation-guide-eks-aks/prerequisite-checks Output Example- https://docs.uipath.com/automation-suite/automation-suite/2023.10/installation-guide-eks-aks/output- example-prerequisite-check Run the installer if all the checks are successful- https://docs.uipath.com/automation-suite/automation-suite/2023.10/installation-guide-eks-aks/installing-automation-suite-on- eksaks Output Example - https://docs.uipath.com/automation-suite/automation-suite/2023.10/installation-guide-eks-aks/output- example-automation-suite-installation
  • 12.
    12 Post-Installation Operations Managing thecertificates • TLS Certificate- • Managing identity token-signing certificates • Managing additional CA certificates uipathctl config update-tls-certificates –help Updating the tls certificate- uipathctl config tls-certificates update --cert server.crt --cacert ca.crt --key server.key Accessing TLS certificate- uipathctl config tls-certificates get uipathctl config token-signing-certificates –help Updating the token-signing certificate- uipathctl config token-signing-certificates update --cert server.crt --key server.key Accessing token-signing certificate- uipathctl config token-signing-certificates get uipathctl config additional-ca-certificates --help Updating additional ca certificate- uipathctl config additional-ca-certificates update --cacert additional_ca.crt Accessing the CA certificates uipathctl config additional-ca-certificates get
  • 13.
    13 Post-Installation Operations Cluster Administration- -Database maintenance - Using splunk to monitor the logs Backup & Restore- - Configuring the backup – To configure the backup, add backup config to input.json file and run the below command ./uipathctl manifest apply input.json --only velero --versions versions.json - Taking a backup- Enable a scheduled backup - ./uipathctl snapshot backup enable --schedule "*/45 * * * *" --retention 168h --prefix "mysnapshot” Disable a backup- ./uipathctl snapshot disable --prefix <prefix_name> List a backup - ./uipathctl snapshot list On demand backup - ./uipathctl snapshot backup create <snapshot_name>
  • 14.
    14 Monitoring- Troubleshooting &Maintenance Using the monitoring stack- Troubleshooting – Diagnostic Tool - https://docs.uipath.com/automation-suite/automation-suite/2023.10/installation-guide-eks- aks/running-the-diagnostics-tool Support Bundle Tool - https://docs.uipath.com/automation-suite/automation-suite/2023.10/installation-guide-eks- aks/running-the-support-bundle-tool - You can use uipathctl diagnostic tool for health checks and based on the outcome, if there is an error, either check the documentation, forum or knowledgebase on customer portal to find a probable solution, if that doesn’t help. Reach out to UiPath product support team for further help.
  • 15.
    15 Monitoring: Application Healthin ArgoCD • To check health status for all apps, including UiPath products • AS and other components version check • To Check the sync status • To check health status of pods and SVCs • To check the logs, Events and configurations
  • 16.
    16 There are multiplechannels through which you can reach out to UiPath Support- 1. Customer Portal - It’s a one-stop shop where you can create tickets and, at the same time, see a history of all your closed and in progress cases, and access our knowledge base articles. Being enrolled under one of our Success Support programs, gives you the option to request for services through the portal. The primary medium to reach out to support is our Webform present on our portal. If you are authenticated through your license key, you can create a case by providing us the following information: • Contact details of the person creating the ticket. • Product component affected. • The UiPath platform version in use. • The affected environment(s) (Production, Dev, etc.). • The priority of the reported issue (only select the priority from urgent, high, medium, low). • The number of affected robots. • Description of the issue. • Relevant error messages / logs related to the issue 2. Incident Support Call Center- This service is available for the success tier customers where they can reach out to the Incident Support Call Center to request information regarding the status of your cases or to find out more about your cases. You can also request the Incident Support Call Center representatives to help you with extraction of the right logs and for updating the cases. Toll free numbers for the Incident Support Call Center can be accessed by our Success tier customers via the Customer Portal. How to Reach to UiPath Support
  • 17.
    17 ➢ Always beon the supported product versions: You are expected to use the supported versions. UiPath will not be able to extend support if your organization is using an out-of- support version or any unsupported activities package. For the supported version details, click on the following URL: https://docs.uipath.com/overview/other/latest/ overview/product- lifecycle ➢ Provide complete, accurate and timely information: Always provide complete information in your initial ticket to ensure expedited resolution. The Support Engineer may ask for various logs to perform the troubleshooting; timely replies from your end will ensure the ticket resolution at the earliest. ➢ Adhere to UiPath best practices: Always provide the right priority assessment and ensure that every ticket has only one issue mentioned. Multiple issues tagged to a single ticket will not be accepted by UiPath. ➢ Plan ahead: Before going ahead with any upgrades or installations please go through the guides. These are available on the UiPath website. We recommend that you follow the guidelines laid in these documents and have a “crisis” plan in place that will provide UiPath support reasonable time to respond. Click on the URL for the UiPath product guides: https://docs.uipath.com/ ➢ Ensure you have the right resources and access: Many times troubleshooting gets affected as the person raising the issue does not have the right access or the right person from IT team is not available. This affects the resolution timelines. ➢ Use the self-help documents and guides: UiPath has created a robust Knowledge base repository based on the experience of our Support engineers. Many times customers can resolve the issues themselves just by referring to these articles. Best practices for expedited case resolution
  • 18.
    Q&A The UiPath wordmark, logos, and robots are registered trademarks owned by UiPath, Inc. and its affiliates. ©2023 UiPath. All rights reserved.