- Overview
- Requirements
- Installation
- Prerequisite checks
- Downloading the installation packages
- uipathctl cluster
- uipathctl cluster maintenance
- uipathctl cluster maintenance disable
- uipathctl cluster maintenance enable
- uipathctl cluster maintenance is-enabled
- uipathctl cluster migration
- uipathctl cluster migration export
- uipathctl cluster migration import
- uipathctl cluster migration run
- uipathctl cluster upgrade
- uipathctl config
- uipathctl config add-host-admin
- uipathctl config additional-ca-certificates
- uipathctl config additional-ca-certificates get
- uipathctl config additional-ca-certificates update
- uipathctl config alerts
- uipathctl config alerts add-email
- uipathctl config alerts remove-email
- uipathctl config alerts update-email
- uipathctl config argocd
- uipathctl config argocd ca-certificates
- uipathctl config argocd ca-certificates get
- uipathctl config argocd ca-certificates update
- uipathctl config argocd generate-dex-config
- uipathctl config argocd generate-rbac
- uipathctl config argocd registry
- uipathctl config argocd registry get
- uipathctl config argocd registry update
- uipathctl config enable-basic-auth
- uipathctl config orchestrator
- uipathctl config orchestrator get-config
- uipathctl config orchestrator update-config
- uipathctl config saml-certificates get
- uipathctl config saml-certificates rotate
- uipathctl config saml-certificates update
- uipathctl config tls-certificates
- uipathctl config tls-certificates get
- uipathctl config tls-certificates update
- uipathctl config token-signing-certificates
- uipathctl config token-signing-certificates get
- uipathctl config token-signing-certificates rotate
- uipathctl config token-signing-certificates update
- uipathctl health
- uipathctl health bundle
- uipathctl health check
- uipathctl health diagnose
- uipathctl health test
- uipathctl manifest
- uipathctl manifest apply
- uipathctl manifest diff
- uipathctl manifest get
- uipathctl manifest get-revision
- uipathctl manifest list-applications
- uipathctl manifest list-revisions
- uipathctl manifest render
- uipathctl prereq
- uipathctl prereq create
- uipathctl prereq run
- uipathctl resource
- uipathctl resource report
- uipathctl snapshot
- uipathctl snapshot backup
- uipathctl snapshot backup create
- uipathctl snapshot backup disable
- uipathctl snapshot backup enable
- uipathctl snapshot delete
- uipathctl snapshot list
- uipathctl snapshot restore
- uipathctl snapshot restore create
- uipathctl snapshot restore delete
- uipathctl snapshot restore history
- uipathctl snapshot restore logs
- uipathctl version
- Post-installation
- Migration and upgrade
- Upgrading Automation Suite on EKS/AKS
- Step 1: Moving the Identity organization data from standalone to Automation Suite
- Step 2: Restoring the standalone product database
- Step 3: Backing up the platform database in Automation Suite
- Step 4: Merging organizations in Automation Suite
- Step 5: Updating the migrated product connection strings
- Step 6: Migrating standalone Orchestrator
- Step 7: Migrating standalone Insights
- Step 8: Deleting the default tenant
- B) Single tenant migration
- Migrating from Automation Suite on Linux to Automation Suite on EKS/AKS
- Monitoring and alerting
- Cluster administration
- Product-specific configuration
- Troubleshooting
Storage
In addition to Microsoft SQL Server, the Automation Suite cluster requires a storage component for storing the files. Automation Suite requires the objectstore and the block/file storage, depending on the service type you choose. Storage is also required to back up the Automation Suite cluster.
The following services require the storage component. These are only necessary if you have opted to enable them as part of the Automation Suite installation or later.
Services |
Storage type |
Purpose |
Estimate |
Orchestrator |
Objectstore |
|
Typically, a package is 5 Mb, and buckets, if any, are less than 1 Mb. A mature enterprise deploys around 10 GB of packages and 12 GB of Queues. |
Action Center |
Objectstore |
|
Typically, a document takes 0.15 Mb, and the forms to fill take an additional 0.15 Kb. In a mature enterprise, this can roll up to 4GB in total. |
Test Manager |
Objectstore |
|
Typically, all files and attachments add up to approximately 5 GB. |
Insights |
Blockstore |
|
2 GB is required for enablement, with the storage footprint growing with the number. A well-established enterprise-scale deployment requires another few GB for all the dashboards. Approximately 10GB of storage should be sufficient. |
Apps |
Objectstore |
|
Typically, the database takes approximately 5 GB, and a typical complex app consumes about 15 Mb. |
AI Center |
Objectstore / Filestore |
|
A typical and established installation will consume 8 GB for five packages and an additional 1 GB for the datasets. A pipeline may consume an additional 50 GB of block storage, but only when actively running. |
Document Understanding |
Objectstore |
|
In a mature deployment, 12GB will go to the ML model, 17GB to the OCR, and 50GB to all documents stored. |
Task Mining |
Objectstore |
|
About 200 GB of activity log data should be analyzed to suggest meaningful automation. Highly repetitive tasks, however, may require much less data. |
Automation Suite Robots |
Filestore |
|
Typically, a mature enterprise deploys around 10 GB of the packages. |
Process Mining |
Objectstore |
|
The minimal footprint is only used to store the SQL files. Approximately a GB of storage should be enough in the beginning. |
The following shared suite services require the storage component. These are only necessary if you opted to install them as part of the Automation Suite installation.
Services |
Storage type |
Purpose |
Estimate |
---|---|---|---|
Monitoring |
Block storage |
Kubernetes and infrastructure related metrics data |
Approximately around 100 GB to store the last ten days of monitoring data |
Logging |
Block storage |
Application running logs |
About 20 GB to keep the previous few days of the logs |
Automation Suite on EKS and AKS supports the following objectstores:
Kubernetes |
Objectstore |
Supported authentication |
---|---|---|
EKS |
Amazon S3 |
|
AKS |
Azure Storage (blob) |
|
Additionally, you may have to enable the following CORS policy at the storage account/bucket level if you face any CORS-related error during the S3 connection while using the Automation Suite cluster.
{{fqdn}}
with the FQDN of the Automation Suite cluster in the following CORS policy.
This is the CORS policy in JSON format:
[
{
"AllowedHeaders": [
"*"
],
"AllowedMethods": [
"POST",
"GET",
"HEAD",
"DELETE",
"PUT"
],
"AllowedOrigins": [
"https://{{fqdn}}"
],
"ExposeHeaders": [
"etag",
"x-amz-server-side-encryption",
"x-amz-request-id",
"x-amz-id-2"
],
"MaxAgeSeconds": 3000
}
]
[
{
"AllowedHeaders": [
"*"
],
"AllowedMethods": [
"POST",
"GET",
"HEAD",
"DELETE",
"PUT"
],
"AllowedOrigins": [
"https://{{fqdn}}"
],
"ExposeHeaders": [
"etag",
"x-amz-server-side-encryption",
"x-amz-request-id",
"x-amz-id-2"
],
"MaxAgeSeconds": 3000
}
]
This is the CORS policy in XML format:
<CORSConfiguration>
<CORSRule>
<AllowedOrigin>{{fqdn}}</AllowedOrigin>
<AllowedMethod>HEAD</AllowedMethod>
<AllowedMethod>GET</AllowedMethod>
<AllowedMethod>PUT</AllowedMethod>
<AllowedMethod>POST</AllowedMethod>
<AllowedMethod>DELETE</AllowedMethod>
<AllowedHeader>*</AllowedHeader>
<MaxAgeSeconds>3000</MaxAgeSeconds>
<ExposeHeader>x-amz-server-side-encryption</ExposeHeader>
<ExposeHeader>x-amz-request-id</ExposeHeader>
<ExposeHeader>x-amz-id-2</ExposeHeader>
<ExposeHeader>etag</ExposeHeader>
</CORSRule>
</CORSConfiguration>
<CORSConfiguration>
<CORSRule>
<AllowedOrigin>{{fqdn}}</AllowedOrigin>
<AllowedMethod>HEAD</AllowedMethod>
<AllowedMethod>GET</AllowedMethod>
<AllowedMethod>PUT</AllowedMethod>
<AllowedMethod>POST</AllowedMethod>
<AllowedMethod>DELETE</AllowedMethod>
<AllowedHeader>*</AllowedHeader>
<MaxAgeSeconds>3000</MaxAgeSeconds>
<ExposeHeader>x-amz-server-side-encryption</ExposeHeader>
<ExposeHeader>x-amz-request-id</ExposeHeader>
<ExposeHeader>x-amz-id-2</ExposeHeader>
<ExposeHeader>etag</ExposeHeader>
</CORSRule>
</CORSConfiguration>
To configure the objectstore, see External Objectstore Configuration.
Since the containers are created within the scope of the Azure Storage Account, it is recommended to have a separate container for each service.
Similarly, in AWS, it is highly recommended to have a dedicated bucket for each service installed on Automation Suite. However, if the bucket is created globally, you may face limitations in providing the dedicated bucket for each service. In this case, you can configure a single bucket and use it for all purposes.
make
permissions. Alternatively, you can provision the required containers/buckets before installation and their information to
the installer.
Objectstore |
500 GB |
The size of the objectstore depends on the size of the deployed and running automation. Therefore, it is difficult to provide an accurate objectstore estimate initially during the installation. However, you should expect anything between 350 GB to 500 GB of objectstore size to be a good start. To understand the usage of the objectstore, see Storage estimates for each Automation Suite component.
Block storage must have CSI drivers configured with the Kubernetes storage classes.
The following table provides details of the block storage, storage class, and provisioner:
Kubernetes |
Storage |
StorageClass |
Provisioner |
---|---|---|---|
EKS |
EBS Volumes |
|
|
AKS |
Azure Manage Disk |
Premium LRS Disk |
|
You can follow the official guide from AWS and Azure to create a storage class in your EKS and AKS clusters.
storage_class
parameter in the input.json
file.
-
Sometimes the EKS or AKS cluster already installs the CSI driver and provides the storage class. If these storage classes are not configured, you must configure them before installation.
-
You must make the storage class for the block storage the default one, as shown in the following example.
Example
input.json
during the installation:
 |
AKS |
EKS |
---|---|---|
input.json |
|
|
StorageClass |
|
|
Block storage |
50 GB |
The size of the block store depends on the size of the deployed and running automation. Therefore, it is difficult to provide an accurate estimate initially during the installation. However, you should expect approximately 50 GB of storageto be a good start. To understand the usage of the block store, see Storage estimates for each Automation Suite component.
File storage must have CSI drivers configured with the Kubernetes storage classes.
Kubernetes |
Storage |
StorageClass |
Provisioner |
EKS |
EFS |
|
|
AKS |
Azure Files |
|
|
You can follow the official guide from AWS and Azure to create a storage class in your EKS and AKS clusters.
storage_class_single_replica
parameter in the input.json
file.
Sometimes the EKS or AKS cluster already installs the CSI driver and provides the storage class. If this storage class is not configured, you must configure it before installation.
Example
input.json
during the installation:
 |
AKS |
EKS |
|
|
|
|
|
Note:
Replace
$(EFS_ID) with the actual File Share ID you created while provisioning infrastructure.
|
Storage class for the file share must have the required permissions set to 700 for the directory and files.
UID
and GID
must be set to 1000 in Azure, and gidRangeStart
and gidRangeEnd
to 1000 and 2000, respectively, in AWS.
File storage |
510 GB |
The size of the file store depends on the size of the deployed and running automation. Therefore, it is difficult to provide an actual estimate initially during the installation. However, you should expect approximately 510 GB of storage size to be enough to run ten concurrent training pipelines and forAutomation Suite Robots. To understand the usage of the filestore, please refer to Storage estimates for each Automation Suite component.
As your automation scales, you may need to account for an increase in the size of your file storage.
To back up the Automation Suite cluster, you need an additional objectstore to back up the cluster configuration and user data.
The following table describes the supported storage for the backup:
Kubernetes |
Objectstore |
---|---|
EKS |
AWS S3 |
AKS |
Azure Storage Account |
A separate objectstore is recommended for storing the backup.