Skip to main content

Home

Configurations

The essential Unravel configurations are set when you install Unravel. Following are additional Unravel configurations that can be set if required.

Setting Unravel configurations

You can update Unravel settings using any of the following methods. Most configurations are set by the auto-configuration method when you install Unravel. However, some configurations must be manually configured. For each configuration, instructions are provided based on whether to use the auto-configuration method or the manual configuration method.

Auto-configuration

Run the manager config auto command to pull in the Unravel configurations automatically. Most of the Unravel configurations can be set with this command. When you run this command, the cluster information is automatically read, and the Hadoop properties are configured.

This is the most recommended method to configure Unravel. Auto-configuration is usually run during Unravel installation. However, if you want to update any specific cluster-level changes, you can run auto-configuration as follows:

  1. Stop Unravel

    <Unravel installation directory>/unravel/manager stop

  2. Run auto-configuration

    <unravel_installation_directory>/unravel/manager config auto

  3. Apply the changes.

    <Unravel installation directory>/unravel/manager config apply

  4. Start Unravel

    <Unravel installation directory>/unravel/manager start

Manual configuration

The manager service is used to perform manual configurations in Unravel.

Manual configuration with commands

The configurations are set with the manager config <setting> command. Refer to Quick reference - Manager tool commands for all configurations that can be updated using the manager config <setting> command.

Perform the following steps when you manually set the configurations with manager commands:

  1. Stop Unravel

    <Unravel installation directory>/unravel/manager stop

  2. Change the setting.

    <Unravel installation directory>/unravel/manager config <setting> <subcommand>

For example:
<Unravel installation directory>/unravel/manager config kerberos enable

  3. Apply the changes.

    <Unravel installation directory>/unravel/manager config apply

  4. Start Unravel

    <Unravel installation directory>/unravel/manager start
Manual configuration with properties

Properties can be used to set configurations. You can set the properties either by using the manager config properties set command or by importing a property file where the properties are defined.

  • Option 1: Set properties by importing the properties file

    1. Create a file containing the properties that you want to configure and their corresponding values as shown in the example below:

      com.unraveldata.ext.kafka.cluster.list=CLTR1,CLTR2
com.unraveldata.ext.kafka.CLTR1.bootstrap_servers=broker1-host:9092,broker2-host:9092,broker3-host:9092
com.unraveldata.ext.kafka.CLTR1.jmx_servers=kafka1,kafka2,kafka3
com.unraveldata.ext.kafka.CLTR1.jmx.kafka1.host=broker1-host
com.unraveldata.ext.kafka.CLTR1.jmx.kafka1.port=9393
com.unraveldata.ext.kafka.CLTR1.jmx.kafka2.host=broker2-host
com.unraveldata.ext.kafka.CLTR1.jmx.kafka2.port=9393
com.unraveldata.ext.kafka.CLTR1.jmx.kafka3.host=broker3-host
com.unraveldata.ext.kafka.CLTR1.jmx.kafka3.port=9393
com.unraveldata.ext.kafka.CLTR1.jmx.kafka1.run_period_sec=60
com.unraveldata.ext.kafka.CLTR1.jmx.kafka2.run_period_sec=60
com.unraveldata.ext.kafka.CLTR1.jmx.kafka3.run_period_sec=60
com.unraveldata.ext.kafka.CLTR2.bootstrap_servers=broker1-host:9092,broker2-host:9092,broker3-host:9092
com.unraveldata.ext.kafka.CLTR2.jmx_servers=kafka1,kafka2,kafka3
com.unraveldata.ext.kafka.CLTR2.jmx.kafka1.host=broker1-host
com.unraveldata.ext.kafka.CLTR2.jmx.kafka1.port=9393
com.unraveldata.ext.kafka.CLTR2.jmx.kafka2.host=broker2-host
com.unraveldata.ext.kafka.CLTR2.jmx.kafka2.port=9393
com.unraveldata.ext.kafka.CLTR2.jmx.kafka3.host=broker3-host
com.unraveldata.ext.kafka.CLTR2.jmx.kafka3.port=9393
com.unraveldata.ext.kafka.CLTR2.jmx.kafka1.run_period_sec=60
com.unraveldata.ext.kafka.CLTR2.jmx.kafka2.run_period_sec=60
com.unraveldata.ext.kafka.CLTR2.jmx.kafka3.run_period_sec=60
com.unraveldata.ext.kafka.insight.interval_min=5
com.unraveldata.ext.kafka.insight.lag_threshold=75
com.unraveldata.ext.kafka.insight.sw_size=10

    2. From the installation directory, where Unravel binaries are installed, run the following command and provide the path to the properties file.

      <Unravel installation directory>/unravel/manager config properties import <path to the properties file>
For example:
/opt/unravel-install/unravel/manager config properties import /opt/properties.txt

  • Option 2: Set the properties with manager config properties set

    <Unravel installation directory>/unravel/manager config properties set property key

    For example:

    <Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.cluster.list CLTR1,CLTR2
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR1.bootstrap_servers broker1-host:9092,broker2-host:9092,broker3-host:9092
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR1.jmx_servers kafka1,kafka2,kafka3
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR1.jmx.kafka1.host broker1-host
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR1.jmx.kafka1.port 9393
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR1.jmx.kafka2.host broker2-host
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR1.jmx.kafka2.port 9393
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR1.jmx.kafka3.host broker3-host
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR1.jmx.kafka3.port 9393
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR1.jmx.kafka1.run_period_sec 60
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR1.jmx.kafka2.run_period_sec 60
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR1.jmx.kafka3.run_period_sec 60
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR2.bootstrap_servers broker1-host:9092,broker2-host:9092,broker3-host:9092
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR2.jmx_servers kafka1,kafka2,kafka3
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR2.jmx.kafka1.host broker1-host
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR2.jmx.kafka1.port 9393
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR2.jmx.kafka2.host broker2-host
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR2.jmx.kafka2.port 9393
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR2.jmx.kafka3.host broker3-host
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR2.jmx.kafka3.port 9393
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR2.jmx.kafka1.run_period_sec 60
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR2.jmx.kafka2.run_period_sec 60
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.CLTR2.jmx.kafka3.run_period_sec 60
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.insight.interval_min 5
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.insight.lag_threshold 75
<Unravel installation directory>/unravel/manager config properties set com.unraveldata.ext.kafka.insight.sw_size 10

    You can also return an updated property to its default value using the manager config <setting> unsetcommand. 

    ##For example
<Unravel installation directory>/unravel/manager config ports unset

Returns a custom port value to it's default value.

Manager service

Unravel manager is a service that provides a unified command-line method to manage all the Unravel configurations and services. It is the central point for interacting with Unravel on the command line.

Notice

Refer to Unravel manager commands to quickly reference all the manager commands.

After you have installed Unravel, the manager tool is available in the services and base directory as manager. You can use the manager tool for the following purposes:

  • Manage services

  • Upgrades and downgrades

  • Setting configurations and properties.

  • Integrate all command-line tools such as healthcheck, autoconfig, AppStore apps, installation, and so on.

Understanding manager tool commands

The commands in the manager tool follow the verb-noun pattern.

  • All: Affects all services. For example, the stop all stops all the services while keeping the monitor up.

  • Alias

    • Informal names: stop unravel_sersor_1 or stop us_1 or stop us are equivalent .

    • Group services: stop ma will stop ma_1, ma_2, ma_3. stop etl will stop all ETL-related services.

  • tier:n: To group services per dependency, ex: tier:2 depends on services from tier:1

  • CSL: A comma-separated list of services, aliases, etc. For example,  stop tier:4,ew,ngui stops all tier:4 services, all ew services, and the UI service.

You can also chain and run multiple commands with the manager tool. However, if any of the commands fail, the chain stops. For example, if you run the chained command: manager stop config auto refresh files start watch, it triggers the following actions:

  • Stops Unravel

  • Runs autoconfig in automatic mode.

  • Refreshes all scripts and configuration files

  • Starts Unravel

  • Displays the service watch.

In this section: