Skip to main content


Part 1: Installing Unravel Server on CDH+CM

This topic explains how to deploy Unravel Server on Cloudera Distribution of Hadoop (CDH). Your CDH environment must be running Cloudera Manager (CM).


If you have not already done so, confirm your cluster meets Unravel's CDH​ compatibility matrix hosting requirements.

1. Configure the host

Use Cloudera Manager to allocate a cluster gateway/edge/client host with HDFS access, and create a gateway configuration for the host. The gateway configuration must have client roles for HDFS, YARN, Spark, Hive, and optionally, Spark2.

3. Install Unravel
  1. Download the Unravel Server RPM.

  2. Ensure that the host machine's local disks have the minimum space required.

    Unravel Server uses two separate disks: one for binaries (/usr/local/unravel) and one for data (/srv/unravel). The separate disk /srv/unravel is beneficial for performance. If either of the disks do not have the minimum space required, create symbolic links for them to another disk drive.


    To check the space on a volume use the df command. For example,

    df -h /srv
  3. Install the Unravel Server RPM.

    sudo rpm -Uvh unravel-version.rpm

The installation creates the following items:

  • /usr/local/unravel/, which contains executables, scripts, properties file (, and logs.

  • /etc/init.d/unravel_*, which contains scripts for controlling services, such as for manually stopping, starting, and getting the status of all daemons in proper order.

  • User unravel if it doesn't exist already.

Run the following steps for installing Unravel Tarball:

The following section provides information about deploying Unravel binaries from a tar file. The Unravel binaries can be deployed in any directory on the server. The user who installs Unravel must have the write permissions to the directory where Unravel binaries are deployed.

To deploy Unravel binaries from a tar file, do the following:

  1. Deploy Unravel from a tar file.

    1. Create an Installation directory and grant ownership of the directory to the user who installs Unravel. This user executes all the processes involved in Unravel installation.

      mkdir /path/to/installation/directory
      chown -R username:groupname /path/to/installation/directory
    2. Download Unravel.

    3. Extract the Unravel tar file to the installation directory, which was created as part of the prerequisite.

      tar zxf unravel-<version>tar.gz -C /path/to/installation/directory
  2. Run setup.

    After deploying the Unravel binaries, run the setup command.

    1. Run the following setup command:


      For example:

      /opt/unravel/versions/ --extra /tmp/mysql --external-database mysql localhost 3306 unravel_mysql_prod unravel unraveldata
    2. Configure unravel using the following commands:

      <unravel_installation_directory>/manager config auto

      These will configure Unravel, start the daemons, and check the status of the daemon processes.


      Run --help with the setup command as well as with any combination of the setup command for the complete usage details.

      <unravel_installation_directory>/versions/4.6.x.x/setup --help
      <unravel_installation_directory>/manager/setup manager config auto --help
  3. Verify Unravel installation.

    1. Verify the Unravel sensor, properties, and files. Run the following command from the manager tool:

      manager verify <sensor|properties|files>
      • sensor: Checks the cluster configuration and ensures that the sensor parameters are correct.

      • properties: Validates, checking for invalid, unknown, duplicate properties.

      • files: Verifies and reports on any unexpected changes to unravel components, scripts, and configuration.

    2. Start all services and verify the status for all the services.

      manager start
      manager report
5. Configure Unravel Server with basic options
  1. (Optional) Enable additional daemons for high-volume workloads.

  2. In /usr/local/unravel/etc/, set general properties for Unravel Server.

  3. Point Unravel Server to logs on HDFS.

    Unravel collects HDFS logs for analysis. To point Unravel Server to these logs, set the following properties in /usr/local/unravel/etc/

    For example,


    To confirm that you have the right path, use the hdfs dfs -ls command. For example,

    hdfs dfs -ls /user/history/done
    hdfs dfs -ls /tmp/logs
  4. If Kerberos is enabled, create or identify a principal and keytab for Unravel daemons to use for access to HDFS and the REST API.

  5. If Sentry is enabled:

    1. Create your own alternate principal with narrow privileges and HDFS access permissions.

    2. Verify that the user running the Unravel daemon /etc/unravel_ctl has the permissions shown in the table below.






      Your alt principal


      Spark event log


      Your alt principal


      Spark2 event log (if Spark2 is installed)


      Your alt principal


      MapReduce logs


      Your alt principal


      YARN aggregation folder


      Your alt principal


      Obtain table partition sizes with "stat" only

  6. If you are using a virus scanner

    We recommend you disable your virus scanner from scanning the elasticsearch directories which are located under /srv/unravel.

6. Change the run-as user and group for Unravel daemons

Unravel daemons run under the local user unravel by default. However, if you have Kerberos or Sentry enabled, or a non-Kerberos cluster with simple Unix security, or a different username for the Unravel user, or a non-local user such as an LDAP user, run script to change the Unix owner and group of the Unravel daemons.

8. Start Unravel services

Run the following command to start all Unravel services:

sudo /etc/init.d/ start
sleep 60

This completes the basic/core configuration.

9. Log into Unravel UI
  1. Find the hostname of Unravel Server.

    echo "http://$(hostname -f):3000/"

    If you're using an SSH tunnel or HTTP proxy, you might need to make adjustments.

  2. Using a supported web browser, (see ​Unravel's ​​Databricks​ compatibility matrix), navigate to http://unravel-host:3000 and log in with username admin with password unraveldata.


    Unravel UI displays collected data.