Installing Zoomdata Manually

If running the installer script is not a viable options for you, you can install Zoomdata manually.

To install Zoomdata manually, complete the following steps:

Step 1. Review the Prerequisites

Refer to System Requirements and Sizing Guidelines for information on the recommended settings for deploying Zoomdata on-premises.

The target server for the Zoomdata software should meet the following conditions:

  • The server does not have PostgreSQL already installed
  • The server does not contain any Zoomdata or Zoomdata property files, meaning if a previous version of Zoomdata or Zoomdata was installed in this server, ensure that all property files have been deleted.
  • The user installing Zoomdata is able to use the sudo command in the server

CentOS Requirements

If your server is running either CentOS v7 or Ubuntu v16, you can skip this prerequisite step. Zoomdata has no requirements specific to these two environments.

If you are installing Zoomdata on a server running Ubuntu 14, then you must configure the maximum number of open processes and files that can be run in your operating environment. See Installation Prerequisites for instructions. Be sure to complete this prerequisite setup before installing Zoomdata.

Time Synchronization Requirements

In addition, Zoomdata benefits from time synchronization in your network. Specifically, Zoomdata leverages Network Time Protocol (NTP), which performs time synchronization of networked servers to Coordinated Universal Time (UTC). If needed, read Using the Network Time Protocol to Synchronize Time for instructions on setting this up.

Java Requirements

You must have Java 8 (1.8.0_131) or later installed to use Zoomdata. Without it, Zoomdata will not start.

CentOS 6 is no longer supported by this product. CentOS 6 is no longer supported by Red Hat Linux (RHEL). Use CentOS 7 instead.

After you have made any needed adjustments to your network configurations, return to this topic to continue the installation process. See also How Zoomdata Validates an Environment's Java Version.

Step 2. Set Up Zoomdata's Metadata Store

Zoomdata uses a standard PostgreSQL v9.5 database instance to store its metadata. Zoomdata strongly recommends using this instance as it is configured with the appropriate settings.

If you would like to use your own or alternative PostgreSQL instance, contact Zoomdata Technical Support for further guidance.

Read Installing and Setting Up Zoomdata's Metadata Store. Complete the setup instructions and then return to this topic to continue the manual installation of Zoomdata on your server.

Step 3. Configure a Dedicated Directory

Before you can download the Zoomdata installation packages onto your server, you need to create the Zoomdata directory where the installation and property files are stored. After the directory is created, you need to create property files in that directory.

Create the Zoomdata Directory

Create the following directory to store all Zoomdata-related files:

sudo install -o root -g root -m 0755 -d /etc/zoomdata

Create the Default Zoomdata Properties File

Create the default Zoomdata properties file that contains the available variables and parameters related to Zoomdata operation:

sudo touch /etc/zoomdata/zoomdata.properties
sudo chmod 0644 /etc/zoomdata/zoomdata.properties
sudo vi /etc/zoomdata/zoomdata.properties

Create the Query Engine Properties File

Create the Zoomdata query engine properties file that contains the available variables and parameters related to query engine operation:

sudo touch /etc/zoomdata/query-engine.properties
sudo chmod 0644 /etc/zoomdata/query-engine.properties
sudo vi /etc/zoomdata/query-engine.properties

Add the Default Metadata Parameters to the Appropriate Zoomdata Properties File

  1. Add the following metadata store-related parameters in the newly-created zoomdata.properties file. Essentially, you are storing the username and password details for the metadata store in this property file.

    spring.datasource.url=jdbc:postgresql://<ip of host>:<port>/zoomdata
    spring.datasource.username=<db_username>
    spring.datasource.password=<db_password>
    keyset.destination.params.jdbc_url=jdbc:postgresql://<ip of host>:<port>/zoomdata-keyset
    keyset.destination.params.user_name=<db_username>
    keyset.destination.params.password=<db_password>
    keyset.destination.schema=public
    upload.destination.params.jdbc_url=jdbc:postgresql://<ip of host>:<port>/zoomdata-upload
    upload.destination.params.user_name=<db_username>
    upload.destination.params.password=<db_password>
    upload.destination.schema=public
    upload.batch-size=1000
  2. Add the following zoomdata-qe database metadata store-related parameters in the newly-created query-engine.properties file.

    spring.qe.datasource.jdbcUrl=jdbc:postgresql://<ip of host>:<port>/zoomdata-qe
    spring.qe.datasource.username=<db_username>
    spring.qe.datasource.password=<db_password>

In each case, remember to save the files before exiting the editor.

Step 4. Download Dependencies and the Zoomdata Installation Packages

Zoomdata requires the following external dependencies for a successful installation:

If you have not already received the Zoomdata installation package, contact Zoomdata Technical Support to request it. In the request, be sure to include the Linux operating system version you are using (for example, CentOS 7). You can select the Support button on this page to create your request.

If your server does not have internet access, you will need an internet-enabled computer to download the packages and then move them to the intended server.

Step 5. Obtain Download Instructions and Installation Packages

Contact your Zoomdata technical support representative and obtain download instructions for the Zoomdata installation packages. Follow the instructions and download the installation packages, remembering to place them in the Zoomdata directory on the target server. The following Zoomdata components are included in your installation packages:

  • The Zoomdata server
  • Connector microservices
  • Query Engine

Step 6. Install the Zoomdata Server

Use the following command to install Zoomdata in a CentOS environment:

sudo yum install zoomdata* -y

Use the following command to install Zoomdata in an Ubuntu environment:

sudo dpkg -i zoomdata*

Step 7: Set Zoomdata Microservices to Start Whenever the Server Boots

Zoomdata microservices need to be set to automatically start whenever the server is started or rebooted.

In a CentOS 7 or 8 or an Ubuntu 16 or 18 environment, run the following command:

sudo systemctl enable $(systemctl list-unit-files | grep zoomdata | awk '{print $1}')

Optionally, you can manually set up each Zoomdata microservice by running the following commands in CentOS 7 or 8 and Ubuntu 16 or 18:

sudo systemctl enable zoomdata-edc-<connector-name>
sudo systemctl enable zoomdata-screenshot-service
sudo systemctl enable zoomdata-consul
sudo systemctl enable zoomdata
sudo systemctl enable zoomdata-query-engine

Step 8: Start Zoomdata Microservices

The Zoomdata microservices must be enabled.

In a CentOS 7 or 8 or an Ubuntu 16 or 18 environment, run the following command:

sudo systemctl start $(systemctl list-unit-files | grep zoomdata | awk '{print $1}')

Optionally, you can manually enable each Zoomdata microservice by running the following commands in CentOS 7 or 8 and Ubuntu 16 or 18:

sudo systemctl start zoomdata-edc-<connector-name>
sudo systemctl start zoomdata-edc-rts
sudo systemctl start zoomdata-screenshot-service
sudo systemctl start zoomdata-query-engine
sudo systemctl start zoomdata

Step 9. Configure the Firewall

Read Configuring the Firewall for complete information.

Step 10. Identify the Zoomdata IP Address

Read Identifying the Zoomdata IP Address for complete information.

Step 11. Access Zoomdata

Read Accessing Zoomdata for more information.

Step 12. Complete Post-Installation Steps

Complete any post-installation actions needed for your environment. These include, but are not limited to:

  1. Enabling the Real-Time Sales demo data source
  2. Setting up the Screenshot microservice.

See Post-Installation Options for more information and links to instructions.