Prerequisites

The following section lists the Synchronizer prerequisites.

Hardware requirements

For each node (server/VM) where the Synchronizer will be running:

CPU Quad Core AMD64 processor or equivalent x86-compatible processor
Memory (RAM) 16 GB minimum
Free Disk Space 80 GB minimum
Operating System

Red Hat Enterprise Linux (RHEL) 6.5 or higher

CentOS 6.5 or higher

Database requirements

  • Oracle 12C Standard or Enterprise edition, character set AL32UTF8
  • MS SQL Server 2017, 2016, 2014, 2012 SP3

Software requirements

  • OpenJDK 1.8 update 65 or higher, or compliant with this version of OpenJDK.

    To install Java, use OpenJDK by running:

    yum install -y java-1.8.0-openjdk-devel

    If you can only use OpenJRE, see Running the Synchronizer service on OpenJRE.

  • In ALM Octane on Windows environments you need to install the cURL utility on your Windows machine, placing curl.exe in the octane\install folder.

    This enables you to run the generateadminapikey.bat command which generates an API client ID and secret to communicate with ALM Octane.

Permissions

File system

  • Regular user for installation process, or root

  • Root for installing OS service

  • Write permissions to the log folder specified in the property general/logFolder, in the .yml configuration file described in Install the Synchronizer

  • Write permissions to the repository folder specified in the property repository/rootFolder, in the .yml configuration file described in Install the Synchronizer

Oracle

  • CREATE USER

  • CREATE SESSION WITH ADMIN OPTION

  • CREATE TABLE WITH ADMIN OPTION

  • DROP USER

  • CREATE SEQUENCE WITH ADMIN OPTION

  • SELECT on SYS.DBA_USERS

MSSQL

  • dbcreator

  • securityadmin

Firewall requirements

On the Synchronizer server, you must have an open inbound port. By default, the Synchronizer uses port 8080 for HTTP or port 8443 for HTTPS (SSL).

The service uses the following:

Purpose Port (default) Config property name in sync.yml
Inbound communication to the Synchronizer

8080

SSL: 8443

sync/general/port

Outbound communication to the database

Oracle: 1521

MSSQL: 1433

sync/database/connectionString

Outbound communication to ALM Octane 8080 serviceLocations/octane
Communication between nodes in cluster configuration 5701

sync/distributedCache/port

Outbound communication to Synchronizer 8080

sync/general/port