Install Fusion on a Single Node

Note
These instructions are for an initial installation of Fusion on a single node (computer). To install Fusion on multiple nodes (a Fusion cluster), see Install a Fusion Cluster. If you already have a version of Fusion installed and want to upgrade it, see the Fusion upgrade instructions.

Out of the box, Fusion uses the instances of Solr, ZooKeeper, and Spark that are included in the Fusion distribution. See the Release Notes to find out which versions of Solr, Spark, and ZooKeeper are included in each Fusion release.

To use Fusion with an existing Solr deployment, see Integrating with existing Solr instances.

Ports

This table lists the default port numbers used by Fusion processes. Port settings are defined in the fusion.properties file in fusion/4.1.x/conf/ (on Unix or macOS) or fusion\4.1.x\conf\ (on Windows).

Port Service

8091

Fusion agent

8763

Fusion UI service (use port 8764 to access the Fusion UI)

8764

Fusion proxy

This service includes the Fusion Authorization Proxy.

8765

Fusion API Services

8766

Spark Master

8769

Spark Worker

8771

Connectors RPC Service

This service can distribute connector jobs to as many Fusion nodes as you want. It uses HTTP/2 and has an SDK that you can use to build your own connectors.

8780

Web Apps

This service delivers the UIs of Fusion apps.

8781

Log shipper

Monitoring port that agent uses to check the health of the log shipper process. This port does not need to be accessible from other nodes.

8983

Solr

This is the embedded Solr instance included in the Fusion distribution.

8984

Connectors Classic Service

This service runs nondistributed connector jobs. It uses HTTP/1.1 and has no SDK.

9983

ZooKeeper

The embedded ZooKeeper used by Fusion services.

Important
The ZooKeeper port is also defined in the configuration file for the embedded ZooKeeper, fusion/4.1.x/conf/zookeeper/zoo.cfg (on Unix or macOS) or fusion\4.1.x\conf\zookeeper\zoo.cfg (on Windows). Look for clientPort. If you run Fusion with the embedded ZooKeeper, remember to change the port number in both places.

47100-48099

Apache Ignite TCP communication port range (used by the API, Connectors Classic, Connectors RPC, and Proxy services)

48100-48199

Apache Ignite shared memory port range (used by the API, Connectors Classic, Connectors RPC, and Proxy services)

49200-49299

Apache Ignite discovery port range (used by API, Connectors Classic, Connectors RPC, and Proxy services)

Additional ports might be required. See Port configuration for more information or to modify the default ports before starting Fusion.

Unix installation

Fusion for Unix is distributed as a gzipped tar file.

To install Fusion on Linux or Mac
  1. Verify that the node on which you plan to install Fusion meets hardware and software requirements.

  2. Download the Fusion tar/zip file for the latest version of Fusion and move it to where you would like it to reside in your filesystem (if you would like to use Upstart for process management, you must install Fusion in /opt/lucidworks).

  3. Become the user that will run Fusion.

    Important
    Do not run Fusion as the root user.
  4. Change your working directory to the directory in which you placed the fusion-version.x.tar.gz file, for example:

    $ cd /opt/lucidworks

  5. Unpack the archive with tar -xf (or tar -xvf), for example:

    $ tar -xf fusion-version.x.tar.gz

    The resulting directory is named fusion/4.1.x. You can rename this if you wish. This directory is considered your Fusion home directory. See Directories, Files, and Ports for the contents of the fusion/4.1.x directory.

Starting Fusion

All Fusion start scripts must be executed by a user who has permissions to read and write to the directories where Fusion is installed. These scripts don’t need to be run as root (or sudo), nor should they be. Use a suitable user, or create a new one, and then ensure that it owns the directory where Fusion resides, (for example, C:\lucidworks).

Give the commands that follow from the directory fusion/4.1.x/bin.

Start the required services that are defined in the group.default property.

To start all required services

./fusion start

Tip
This is equivalent to ./fusion start default. You can omit the group name default.

For information about starting groups of services or individual services, see Start and Stop Fusion.

Running Fusion In The Foreground

To run Fusion or any of its services in the foreground, use the run command-line argument in place of start.

Stopping Fusion

To stop Fusion or any of its services, use the stop command-line argument in place of start.

Using systemd to manage processes

On Red Hat Enterprise Linux, CentOS 7 and newer, and Ubuntu 15.04 LTS and newer, we support using the operating system-provided systemd for process management.

For more information about using systemd, see Using systemd to manage processes.

Using Ubuntu Upstart to manage processes

Under Ubuntu 12.04 LTS through Ubuntu 14.10, we support using Upstart for process management. This requires Fusion to be installed in the /opt/lucidworks/ directory.

For more information about using Upstart, see Using Ubuntu Upstart to manage processes.

Windows installation

Fusion for Windows is distributed as a compressed zip file. To unpack the Fusion zip file on Windows, you can use a native compression utility or the freely available 7zip file archiver. Visit the 7zip download page for the latest version.

To install Fusion on Windows
  1. Verify that the node on which you plan to install Fusion meets hardware and software requirements.

  2. Download the zip file for the latest version of Fusion and move it to where you would like Fusion to reside in your filesystem. It will appear as a compressed folder.

  3. Unpack the archive. In most cases, you need only right-click and choose "Extract all…​". If you don’t see this option, check that you have permissions to extract folders on your system.

    The resulting directory is named fusion\4.1.x. This directory is considered your Fusion home directory. See Directories, Files, and Ports for the contents of the fusion/4.1.x directory.

To install Fusion as a set of Windows services
  1. Run bin/install-services.cmd.

  2. Enter the name of the windows user that is used to launch this service.

    Remember the username is COMPUTERNAME\username or DOMAIN\username (if your computer is part of a Windows domain).

  3. Enter the user’s password.

  4. Enter the path to the directory containing the JDK to use for running the services.

Starting Fusion

All Fusion start scripts must be executed by a user who has permissions to read and write to the directories where Fusion is installed. Ensure that the user owns the directory where Fusion resides (for example, C:\lucidworks).

Give the commands that follow from the directory fusion{version}.x\bin.

To start all required Fusion services as Java processes
fusion.cmd start
To start all required Fusion services as Windows services
start-services.cmd

For information about starting groups of services or individual services, see Start and Stop Fusion.

Stopping Fusion

To stop Fusion or any of its services, use the stop command-line argument in place of start.

Installation with an existing Solr instance or cluster

Before you install Fusion with an existing Solr instance or cluster, confirm that the Solr version is supported by Fusion.

If installing Fusion to work with an existing Solr instance, either in SolrCloud mode or standalone, you should install Fusion as described above. You should start each of the services as described above.

Once Fusion installation is complete, you can register your existing Solr installation with Fusion to be able to use the two systems together. For details on how to do that, see the section Integrate Fusion with an Existing Solr Deployment.

Troubleshooting

For information about problems you might encounter when installing Fusion, and solutions, see Troubleshoot When Installing Fusion.