Installation Prerequisites
This page covers the minimum hardware and software requirements to install and run Digital.ai Release. Also, you will get information about the supported operating systems, databases, web browsers, kubernetes platforms, JDKs, message brokers, upgrade versions, and so on. Ensure that your setup is better than the stated minimum requirements, depending on your site's size and usage pattern. For more assistance, contact Digital.ai support.
Supported Operating Systems
The following operating systems are supported:
| Operating Systems | Versions Supported |
|---|---|
| Windows Server | 2022 and 2019 |
| Ubuntu | 24.04 LTS and 22.04 LTS |
| RHEL | 9.x and 8.x |
Supported Databases
The following databases are supported:
| Database | Versions Supported |
|---|---|
| PostgreSQL (recommended) | 15.7 and later and 16.3 and later |
| Oracle | 23ai and 19c |
| Microsoft SQL Server | 2019 (15.0) and 2022 (16.0) |
| MySQL | 8.4 and 8.0 |
The container-based task functionality is not compatible with DB2.
Release is installed with an embedded database, by default for easy setup in evaluation and test environments. For production use, we recommend using an industrial-grade external database server such as PostgreSQL, MySQL, Oracle, or Microsoft SQL Server. For more information, see Configure the SQL repository.
- In Release, you have the PostgreSQL streaming replication setup to create a high availability (HA) cluster configuration with one or more standby servers ready to take over operations if the primary server fails.
- You may use the older versions of Release and Databases. However, we have performed limited validations to ensure that Release works in database cluster environment. For example, we validated Release 10.2.x with PostgreSQL 12.4 cluster using Patroni.
Supported Web Browsers
The following web browsers are supported:
| Web Browsers | Versions Supported |
|---|---|
| Chrome | Latest 2 versions |
| Edge chromium | Latest version |
| Firefox | Latest 2 versions |
Minimum screen resolution of 1280 x 1024 is recommended to work with the Release UI.
Supported Kubernetes Platforms
The following Kubernetes platforms are supported:
- AWS EKS
- Azure AKS
- GCP GKE
- Kubernetes on-premise
- OpenShift on VMWare vSphere
- OpenShift on AWS
- This is only for operator-based installation, and not for JVM based installation. requirements-for-installing-xl-release
- We support Deploy installation on any flavor of Openshift that meets the below criteria:
- Kubernetes server versions 1.20-1.31
- Has storage class that supports RWO and RWX modes.
Supported Java Development Kit
The following Java Development Kits (JDK) is supported:
| JDKs | Versions Supported |
|---|---|
| Oracle JDK | 17 |
| Open JDK | 17 |
Release is not supported on non-LTS Java Development Kits (JDKs). For more information on LTS and non-LTS Java versions, see:
Supported Message Brokers
The following message brokers are supported:
- ActiveMQ
- RabbitMQ Classic
- RabbitMQ Quorum
Release Server Hardware Requirements
The following table lists the CPU, RAM, JVM Heap Size, and DB configuration recommendations for Small, Medium, and Large sites.
| Small | Medium | Large | |
|---|---|---|---|
| Users | 100 | 200 | 500 |
| CPU | Quad-core | Octa-core | >16-core |
| Memory | 8GB | 16GB | 32GB |
| JVM Heap Size | 4 GB (50% of available RAM) | 8 GB (50% of available RAM) | 16 GB (50% of available RAM) |
| DB Configuration | Quad-core | Octa-core | >16-core |
- These recommendations apply to general standard use cases. Adjust the heap size and other settings based on your specific needs. Heap size must be adjusted based on heap-intensive actions and tailored to your specific scenarios. For example, a larger heap size is required for complex task releases, the type of release orchestration used, the size of the files involved in the releases, extensive logging, and significant network activity
- Install Digital.ai Release on a hard drive that is persistent and not a Network File System (NFS)
- Hard disk usage depends on the configuration of the product
- At least 100GB of storage for the default installation that runs an embedded database
- Use a faster hard drive. For example, use SSDs in RAID 4 environment
Release Server Software Requirements
The following are the software requirements to install the Release server:
Release supports only IPv4 and does not yet support IPv6.
Network Time Protocol (NTP) synchronization
NTP synchronization must exist between the Release server and Database server(s).
From https://github.com/brettwooldridge/HikariCP#configuration-knobs-baby:
HikariCP relies on accurate timers for both performance and reliability. It is important that your server is synchronized with a time-source such as an NTP server. This is required if your server is running within a virtual machine. For more information, see HickariCP documentation.
Do not rely on the hypervisor settings to synchronize the clock of the virtual machine. Configure time-source synchronization inside the virtual machine.
Reference Setup
The following sections cover the hardware and configuration details of Release:
Release Application Server
- Intel(R) Xeon(R) Platinum 8275CL CPU
- 16GB RAM
- Two 300GB 10K SAS 2.5" disks
| Specification | Details |
|---|---|
| Operating system | Ubuntu 24.0 LTS Ubuntu 22.04 LTS |
| Installed software | A single Release instance running as a service and a monitoring system |
| Release version | 24.3 |
| Release setup | Standalone, non-clustered |
| Java version | JDK 17 |
Release configurations
| Parameter | Value | Location | Description |
|---|---|---|---|
wrapper.java.additional.1 | -Xms2048m | XL_RELEASE_SERVER_HOME/conf/xlr-wrapper-linux.conf | Sets the heap size to minimum 2GB. The default minimum value is 1GB. |
wrapper.java.additional.2 | -Xmx6144m | XL_RELEASE_SERVER_HOME/conf/xlr-wrapper-linux.conf | Sets the heap size to maximum 6GB. The default maximum value is 4GB. |
threads.min | 64 | XL_RELEASE_SERVER_HOME/conf/xl-release-server.conf | Sets the minimum number of HTTP threads to 64. |
threads.max | 256 | XL_RELEASE_SERVER_HOME/conf/xl-release-server.conf | Sets the maximum number of HTTP threads to 256. |
xl.executors.scheduler.maxThreadsCount | 128 | XL_RELEASE_SERVER_HOME/conf/xl-release.conf | Sets the maximum number of threads for asynchronous operations to 128. |
xl.database.max_pool_size | 64 | XL_RELEASE_SERVER_HOME/conf/xl-release.conf | Sets the maximum number of threads for database pool to 64. |
SQL Database Server
- Intel(R) Xeon(R) Platinum 8275CL CPU
- 16GB RAM
- Two 300GB 10K SAS 2.5" disks
| Specification | Details |
|---|---|
| Operating system | Ubuntu 24.0 LTS or 22.04 LTS |
| Release persistence | PostgreSQL 15.7 and later PostgreSQL 16.3 and later |
PostgreSQL configurations
| Parameter | Value |
|---|---|
max_connections | 512 |
shared_buffers | 4GB |
effective_cache_size | 12GB |
synchronous_commit | off |
max_wal_size | 1GB |
For more information about the configuration, see tuning your PostgreSQL server.
This configuration supports up to 2000 concurrent users running a test set of 200 active releases, 200 templates, 200 completed releases, and 200 folders. All of these, with a mean response time of less than 100 milliseconds.
Other configuration settings may be optimal for your environment (active-active) and load profile (number of concurrent users and release structure).
LDAP
To connect Release to your corporate Active Directory or LDAP server, see Configure LDAP security for Release.
Upgrade Release version
Upgrades are tested from supported versions; however, upgrades from older versions are expected to work. We recommend testing the upgrade in a test environment before applying it to production. For assistance with planning the upgrade from older versions, contact Digital.ai Support.