Installation and Configuration

Version 23.4.8799


Installation and Configuration


Getting started with CData Sync is quick and easy. This page provides system requirements for both the .NET and Cross-Platform Editions, and it provides the steps for installing the software.

For more detailed information about all editions of Sync, see the following topics:

System Requirements

This section provides system requirements for both the Cross-Platform and .NET Editions. These requirements apply to both on-premises applications and virtual machines.

Cross-Platform Edition

  • Java 11 or later

  • Recommended Minimum: 4 GB RAM (8+ GB recommended for higher volumes of traffic)

  • Adequate free disk space for job logging

.NET Edition

  • Microsoft Windows 10, Windows Server 2016, or later

  • Microsoft .NET Framework 4.5 or later

  • Recommended Minimum: 4 GB RAM (8+ GB recommended for higher volumes of traffic)

  • Adequate free disk space for job logging

Note: To use earlier versions of Windows, you must host the application on the Microsoft Internet Information Services (IIS) web server.

Determining Machine Size Requirements

Without enough RAM or virtual CPUs (vCPUs), machine performance degrades over time. Therefore, you need to consider the following criteria to determine appropriate sizing requirements for your machine:  

  • the number of jobs you have  

  • the number of tables in a job   

  • the number of jobs that are running at any given time 

  • the amount of data that you replicate at any given time

Along with this information, also consider the number of threads you are running. You can have a job that contains just one thread, or you can have a job that contains multiple threads running in parallel (parallel processing). As a general recommendation, you should have no more than one thread per vCPU. 

With 4 vCPUs, you should be able to run 2-4 jobs in parallel easily. With 8 or more vCPUs, you can run 6-8 jobs simultaneously without sacrificing performance. However, as you increase the amount of data movement, scaling up is important for maintaining throughput.

Installation Steps

Download the installation file from the CData Sync website and follow the installation steps below for your operating system.

Windows

Both the Cross-Platform and .NET Editions come with a setup.exe installer. Run the setup.exe file and follow the installation steps. After the setup and installation steps complete, the Sync service is installed and the application starts automatically.

Linux

The Linux setup file ships as CDataSync.tar.gz. This is an archive file that contains the application files.

Note: This file is not intended for Microsoft Windows setups. If you are installing Sync on a Windows machine, download and run the Windows installer instead.

Follow these steps to install the application:

  1. Extract the files from the archive. If you have not extracted a .tar.gz archive before, the following steps outline a common method:

    1. Create a folder in the same directory as the downloaded archive to which you want to extract the files.

    2. Open a terminal window and change the directory to the download location (for example, cd Downloads).

    3. Submit the following command to extract the archive into the folder that you created (in this example, the folder is named CDataSync):

      tar -xvzf CDataSync.tar.gz -C CDataSync

  2. Move the folder that contains the extracted files to the location in which you want to place it on the disk.

  3. Follow the steps in Starting the Server for options around starting the application.