Xcalar Installation Guide

Xcalar installation overview

This section provides an overview of the Xcalar installation tasks.


This guide is intended for system administrators who install and configure analytics software. For users who are not system administrators but are responsible for installing the Xcalar software, you must be familiar with Linux operating systems, networking, storage, and computer cluster concepts. Xcalar recommends that all users responsible for installing Xcalar read and follow the guidelines in Ensuring a successful Xcalar installation.

Overview of the Xcalar installation tasks

The following is a brief overview of the installation procedure for Xcalar:

  1. Validate that your system has the required supported software and hardware and the required network services and devices for installing Xcalar. For more information, see Xcalar system requirements.
  2. Perform the pre-installation tasks for the Xcalar installation option that best suites your business requirements. According to the Xcalar installation option you chose , see either Xcalar pre-installation tasks for restrictive environments or Xcalar pre-installation tasks for non-restrictive environments.
  3. Install and deploy Xcalar. For more information, see Installing Xcalar.

Ensuring a successful Xcalar installation

Follow these guidelines for a successful Xcalar installation:

  • Decide on the type of Xcalar installation from the Xcalar installation options that best suits your business requirements. For more information, see Understanding and planning your Xcalar installation.
  • Read the Xcalar system requirements. This ensures that your system has the required base hardware and software.
  • Read the pre-installation and installation requirements and steps. This ensures that you understand the tasks required and how they are completed.
  • Understand what third-party software services are required and what account information is needed when configuring dependent third-party services. Software services, such as NFS, Active Directory, and network and firewall security, must be configured by you or the Xcalar installation Wizard. Account names and user names for these services are required during installation.
  • Record all the required configuration values, such as host names, port numbers, user names, and passwords.
  • During the pre-installation tasks, record any new configuration values as you create them. You will be required to enter these configuration values later when you install Xcalar. The Information requirements form can be found online from the Xcalar documentation portal at: Xcalar.com and in the Information requirements section.

  • After installing Xcalar, verify that the Xcalar software stack installed successfully.

If you have any issues during the installation and deployment of Xcalar, see Troubleshooting.

Terms used in this guide

Table 1 Terms



Xcalar cluster

A group of two or more bare metal computers or Cloud virtual machines (called nodes) that run Xcalar Design and Xcalar Compute Engine on each node.

Xcalar Admin

The account that is used for administering and monitoring Xcalar Design.

If you have multiple Xcalar Admins they must belong to an administrator group:

  • The Microsoft Active Directory Group Xce Admin.
  • The OpenLDAP admin group, which is the employeeType administrator.
Xcalar Owner

The operating system user name who owns the Xcalar software and runs the Xcalar Design and Xcalar Compute Engine processes on all the nodes of the Xcalar cluster.

IMPORTANT: The Xcalar Owner must NOT be root.

The identity of the Xcalar Owner is provided to the Xcalar GUI installer from either:

  • The XCE_USER and XCE_GROUP values of the Pre-Config setup file that holds your Xcalar cluster environment and user credentials. This file is created by you and used by the Pre-Config script during the pre-installation tasks for restrictive environments. For more information, see the Pre-Config script and the Pre-Config setup file descriptions below.
  • The user name that you provide in the USERNAME field of the Credentials section during the Xcalar installation, which is used to connect to each node of the Xcalar cluster.

Xcalar Root Directory

The network file system (NFS) mount that is shared between all nodes of the Xcalar cluster. Xcalar Design and Xcalar Compute Engine write configuration information and session data into this directory.

Xcalar Install Directory

The directory on each node in which the Xcalar software is installed.

LDAP Authentication server

Xcalar uses an LDAP server for authentication, such as Microsoft Active Directory. The Xcalar GUI Installer requires the following server information:

  • LDAP URI: the server’s name or IP address and the server’s port number. For example, ldap://xcalarad.xcalar.com:389.
  • USER DN: the location in the LDAP server in which to search for user entries. For example, dc=int,dc=xcalar,dc=net.
  • SEARCH FILTER: an LDAP filter that limits the returned number of user entries to one. For example, (&(objectclass=user)(userPrincipalName=%username%))
  • SERVER KEY FILE: The path to the LDAP security certificates that identify the server.
  • TLS usage: A true or false value that lets Xcalar know if the server accepts TLS requests. For example, true.
  • ActiveDirectory identity: A true or false value that lets Xcalar know if the server is an Active Directory server. For example, true.

Configuration Tarball

A tar archive containing software and script packages, which is run with superuser privileges (run as root) during the pre-installation tasks for restrictive environments, prior to running the Xcalar GUI Installer. For more information, see Configuring the Xcalar cluster nodes.

The Xcalar Configuration Tarball with the Xcalar GUI Installer are downloaded from the Xcalar customer portal at:


Pre-Config script

A configuration script in the Configuration Tarball named pre-config.sh, which performs necessary operating system level configuration for each Xcalar cluster node. This script must be run by a superuser or with a su or sudo program.

Pre-Config setup file

The setup.txt file that holds your Xcalar cluster environment and user credentials, which is used by the pre-config.sh configuration script. The setup.txt file parameters are:

  • XCE_USER and XCE_GROUP - The Xcalar Owner user name and group name.
  • XCE_ROOTDIR - The network file system (NFS) mount directory name and path, which is known as the Xcalar Root Directory.
  • XCE_INSTALLDIR - The path and directory name of the Xcalar Install Directory.
  • XCE_KERBEROS_ENABLE - One of two values that will either install or not install Kerboros software packages.
  • XCE_FIREWALL_CONFIG - One of two values that will either configure or not configure the Linux software firewall settings.

Verification script

A script in the Configuration Tarball named verify.sh, which tests the pre-config.sh script's configuration steps. This script can be run by any user on the node.

Xcalar GUI Installer

A self-extracting shell archive file that contains a web server, a small web site, and software for installing Xcalar in parallel on all the Xcalar cluster nodes. The Xcalar GUI Installer can be run by any user on any host that has a Xcalar supported Linux operating system and that can connect to all the Xcalar cluster nodes with secure shell (SSH).

The Xcalar GUI Installer and the Configuration Tarball are downloaded from the Xcalar customer portal at:


Installation host

The computer on which you run the Xcalar GUI Installer. This can be one of the nodes within the Xcalar cluster, or a host running one of the Xcalar supported Linux operating systems.

Go to top