Skip to main content


Unravel Tarball installation

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. 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

After deploying the Unravel binaries, run the setup command.

  1. Run setup command:


    For example:

    <Unravel installation directory>/versions/4.6.x.x/setup 
  2. Configure unravel using the following commands:

    <unravel_installation_directory>/manager config auto
    <unravel_installation_directory>/manager start
    <unravel_installation_directory>/manager report

    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/manager config auto --help

After you have set the Unravel configurations, you can verify the installation by running the following steps:

  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

In the case of Databricks, run the following steps to connect to Databricks workspace.

  1. Navigate to the installation directory and enable Databricks using the following command:

    <installation_directory>/unravel/manager config databricks enable
  2. Configure Databricks workspace.

    <installation_directory>/unravel/manager config databricks add -i <WORKSPACE_ID> -n <WORKSPACE_NAME> -r <WORKSPACE_INSTANCE> -u <LR_ENDPOINT> -p {premium,standard} -t <WORKSPACE_ACCESS_TOKEN>

    For example

    /opt/unravel/manager config databricks add -i 6520864603684*** -n AWSDatabricks -r https://dbc-*** -u -p standard -t ***
  3. Run the following command to refresh files so that the configurations are pushed into dbfs:

    <installation_directory>/unravel/manager refresh databricks