- Overview
- Requirements
- Pre-installation
- Preparing the installation
- Installing and configuring the service mesh
- Downloading the installation packages
- Configuring the OCI-compliant registry
- Granting installation permissions
- Installing and configuring the GitOps tool
- Deploying Redis through OperatorHub
- Applying miscellaneous configurations
- Running uipathctl
- Installation
- Post-installation
- Migration and upgrade
- Upgrading Automation Suite
- Migrating standalone products to Automation Suite
- Step 1: Restoring the standalone product database
- Step 2: Updating the schema of the restored product database
- Step 3: Moving the Identity organization data from standalone to Automation Suite
- Step 4: Backing up the platform database in Automation Suite
- Step 5: Merging organizations in Automation Suite
- Step 6: Updating the migrated product connection strings
- Step 7: Migrating standalone Orchestrator
- Step 8: Migrating standalone Insights
- Step 9: Migrating standalone Test Manager
- Step 10: Deleting the default tenant
- Performing a single tenant migration
- Migrating between Automation Suite clusters
- Monitoring and alerting
- Cluster administration
- Product-specific configuration
- Orchestrator advanced configuration
- Configuring Orchestrator parameters
- Configuring appSettings
- Configuring the maximum request size
- Overriding cluster-level storage configuration
- Configuring NLog
- Saving robot logs to Elasticsearch
- Configuring credential stores
- Configuring encryption key per tenant
- Cleaning up the Orchestrator database
- Skipping host library creation
- Troubleshooting

Automation Suite on OpenShift installation guide
Deploying Redis through OperatorHub
UiPath® products on Automation Suite require Redis to ensure caching capabilities. You have the following options for meeting the Redis caching requirements:
- Install and configure Redis, either on your OpenShift cluster or on different servers external to the OpenShift cluster.
- Install the Redis Enterprise Operator on your OpenShift cluster. To install Redis Enterprise Operator through OperatorHub, follow the instructions in this section. If you install multiple Automation Suite instances on the same cluster, make sure to install Redis in all the corresponding namespaces and replace the redis host accordingly in the
input.jsonfile based on each installation.Note:- Automation Suite does not come with a Redis Enterprise Operator license. You must obtain a license directly from Redis or use a UiPath-provided HAA Redis license.
- If you use Redis Enterprise Operator version 6.2.18-41 or earlier, you must install the security context constraint before installing the operator. For more information, see the Redis documentation.
Installing Redis Enterprise Operator
Take the following steps to install Redis Enterprise Operator through OperatorHub:
- In the OpenShift interface, navigate to Operators > OperatorHub.
- In the search field, search for Redis Enterprise.
- Select Redis Enterprise Operator provided by Redis in the result list. The entry is marked as Certified. By default, the image is pulled from the Red Had registry.
- On the Install Operator page, specify the namespace for the operator. Only one namespace per operator is supported.
- Update the channel with the version you want to install. For more information about specific versions, see the operator release notes.
- Choose an approval strategy. For production systems, use Manual to make sure that operator updates require your approval.
- Select Install and approve the installation plan.
You can monitor the status of your Redis Enterprise Operator subscription in Operators > Installed Operators.
Creating the Redis Enterprise cluster
Take the following steps to create the Redis Enterprise cluster:
-
Create a
redis-enterprise-cluster.yamlfile with the following contents:--- apiVersion: app.redislabs.com/v1 kind: RedisEnterpriseCluster metadata: name: rec spec: bootstrapperImageSpec: repository: registry.connect.redhat.com/redislabs/redis-enterprise-operator persistentSpec: enabled: true redisEnterpriseServicesRiggerImageSpec: repository: registry.connect.redhat.com/redislabs/services-manager redisEnterpriseImageSpec: imagePullPolicy: IfNotPresent repository: registry.connect.redhat.com/redislabs/redis-enterprise nodes: 1 uiServiceType: ClusterIP--- apiVersion: app.redislabs.com/v1 kind: RedisEnterpriseCluster metadata: name: rec spec: bootstrapperImageSpec: repository: registry.connect.redhat.com/redislabs/redis-enterprise-operator persistentSpec: enabled: true redisEnterpriseServicesRiggerImageSpec: repository: registry.connect.redhat.com/redislabs/services-manager redisEnterpriseImageSpec: imagePullPolicy: IfNotPresent repository: registry.connect.redhat.com/redislabs/redis-enterprise nodes: 1 uiServiceType: ClusterIPSet the value of the
nodesparameter in the YAML file to determine the number of pods running in the Redis Enterprise cluster. -
Apply the configuration in the YAML file to the OpenShift cluster by running the following command:
Note:Replace the
<redis-namespace>placeholder in the command with the namespace that you used in the previous step.oc apply -f redis-enterprise-cluster.yaml -n "<redis-namespace>"oc apply -f redis-enterprise-cluster.yaml -n "<redis-namespace>" -
Verify that the cluster is in a
Runningstate by using the following command. The command requires thejqutility to be installed on your machine.oc get RedisEnterpriseCluster -n <redis-system> -o json | jq -r '.items[0].status.state'oc get RedisEnterpriseCluster -n <redis-system> -o json | jq -r '.items[0].status.state'To install
jq, use one of the following options:- Option 1: Run the following command:
yum install -y epel-release yum install -y jqyum install -y epel-release yum install -y jq- Option 2: Run the following commands:
shell curl https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/j/jq-1.6-2.el7.x86_64.rpm --output /tmp/jq-1.6-2.el7.x86_64.rpm yum localinstall /tmp/jq-1.6-2.el7.x86_64.rpmshell curl https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/j/jq-1.6-2.el7.x86_64.rpm --output /tmp/jq-1.6-2.el7.x86_64.rpm yum localinstall /tmp/jq-1.6-2.el7.x86_64.rpm
Creating the Redis database
Take the following steps to create the Redis database:
- Create a
redis-database.yamlfile with the following contents:--- apiVersion: app.redislabs.com/v1alpha1 kind: RedisEnterpriseDatabase metadata: name: redb spec: tlsMode: disabled databasePort: 6380--- apiVersion: app.redislabs.com/v1alpha1 kind: RedisEnterpriseDatabase metadata: name: redb spec: tlsMode: disabled databasePort: 6380 - Apply the configuration in the YAML file to the OpenShift cluster by running the following command:
Note:
Replace the
<redis-namespace>placeholder in the command with the namespace that you used in the previous step.oc apply -f redis-database.yaml -n "<redis-namespace>"oc apply -f redis-database.yaml -n "<redis-namespace>" - Verify that the database is in an
activestate by running the following command:oc get redisenterprisedatabase -n "<redis_namespace>" -o json | jq -r '.items[0].status.status'oc get redisenterprisedatabase -n "<redis_namespace>" -o json | jq -r '.items[0].status.status'
Updating the cluster configuration file
Deploying Redis through OperatorHub requires you to add the following section to the input.json configuration file. Replace the <redis-namespace> and <password> placeholders with appropriate values:
"fabric": {
"redis": {
"hostname": "redb.<redis-namespace>.svc.cluster.local",
"port": 6380,
"password": "<password>",
"tls": false
}
},
"fabric": {
"redis": {
"hostname": "redb.<redis-namespace>.svc.cluster.local",
"port": 6380,
"password": "<password>",
"tls": false
}
},
To retrieve the password, run the following command:
oc get secret -n <redis-namespace> redb-redb -o json | jq -r '.data.password' | base64 -d
oc get secret -n <redis-namespace> redb-redb -o json | jq -r '.data.password' | base64 -d