Configure Tamr Core using the administrative utility, unify-admin.sh.

Guidance for Using the Administrative Utility

You run unify-admin.sh as the functional user. To change to the functional user, sudo su - <functional-user>.

When running unify-admin.sh:

If values contain space characters, wrap them in double quotes, as in: "Value with a space".
If values contain quote characters, add a backslash to escape each quotation mark: Quoted_\"Value\".

Important: After you update configuration variables, you must restart Tamr Core and its dependencies to apply the changes.

Resources for Using the Administrative Utility

For the full list of parameters that unify-admin.sh takes, see the Command Reference.
For a list of all of the Tamr configuration variables, see the Configuration Variable Reference.

Obtaining a Full List of Configuration Variables

You can fetch all configuration variables at once or individually. You can also fetch only those variables that you have explicitly set.

To obtain a list of all configuration variables:

Run:

<tamr-home-directory>/tamr/utils/unify-admin.sh config:get

To obtain one or more configuration variables:

Run a command similar to this example, separating variable names with spaces:

<tamr-home-directory>/tamr/utils/unify-admin.sh config:get TAMR_LICENSE_KEY TAMR_TOTAL_CORES

To obtain all user-defined configuration variables:

Run:

<tamr-home-directory>/tamr/utils/unify-admin.sh config:get --userDefined

Note: --userDefined excludes all default and computed variables.

Writing User-Defined Configuration Variables to a File

You can write your user-defined configuration variables directly to a .yaml file to store or edit them by specifying the file name:

<tamr-home-directory>/tamr/utils/unify-admin.sh config:get --userDefined > my-config.yaml

To use a .yaml file to set configurations, see Setting configuration variables below.

For more information about the configuration variables, see the Configuration Variable Reference.

Setting Configuration Variables

You can set configuration variables using unify-admin.sh in two ways:

Provide key/value pairs as command arguments. This is useful when configuring a few variables.
Provide a YAML file containing their key/value pairs. This is useful when you must set many variables at once.

Note: When setting the values, boolean values must be enclosed in quotes ("true" or "false").

To set configuration variables as command line arguments:

Run a command similar to this example, separating variable names with spaces:

<tamr-home-directory>/tamr/utils/unify-admin.sh config:set TAMR_LICENSE_KEY="12345abc" TAMR_TOTAL_CORES=4

Restart Tamr Core and its dependencies. See Restarting Tamr Core.

To set configuration variables for many variables at once with a .yaml file:

Create a YAML file, such as my-config.yaml, with a list of newline-delimited key-value pairs as in this example:

---
TAMR_LICENSE_KEY: "12345abc"
TAMR_TOTAL_CORES: 4

Run the script as follows:

shell
<tamr-home-directory>/tamr/utils/unify-admin.sh config:set --file <path-to-file>/my-config.yaml

Restart Tamr Core and its dependencies. See Restarting Tamr Core.

Resetting Configuration Variables to their Defaults

You can reset one or more user-defined values. When values are reset, they will go back to their defaults, or the formulas will be re-evaluated, as applicable. If other properties depend on the values that have been reset, they will also be re-evaluated.

To reset all configuration variables:

Run:

<tamr-home-directory>/tamr/utils/unify-admin.sh config:reset

Restart Tamr Core and its dependencies. See Restarting Tamr Core.

To reset one or more configuration variables:

Run a command similar to this example, separating variable names with spaces:

<tamr-home-directory>/tamr/utils/unify-admin.sh config:reset TAMR_LICENSE_KEY TAMR_TOTAL_CORES

Restart Tamr Core and its dependencies. See Restarting Tamr Core.

Configuring Tamr Core Deployment Settings

Changing the Tamr Core Port

By default, the HTTP access port for Tamr Core is 9100. You can change this to another port.

To change the port:

Set the following configuration variables to the new port number:

<tamr-home-directory>/tamr/utils/unify-admin.sh config:set TAMR_UNIFY_BIND_PORT="port-number" TAMR_UNIFY_PORT="port-number"

Restart Tamr Core and its dependencies. See Restarting Tamr Core.

Changing the Tamr Core Timeout

By default, the timeout for Tamr Core services is 5 minutes. You can change the timeout using the following variables:

TAMR_SERVICES_START_UP_NUMBER_OF_RETRIES: The number of retries to connect to Tamr Core microservices upon startup. The default is 50 times.
TAMR_SERVICES_START_UP_RETRY_INTERVAL_SECONDS: The interval (in seconds) between retries to connect to Tamr Core microservices upon startup. The default is 6.

To change the timeout:

Set the following configuration variables to the new interval and number of retries:

<tamr-home-directory>/tamr/utils/unify-admin.sh config:set TAMR_SERVICES_START_UP_NUMBER_OF_RETRIES="number-of-retries" TAMR_SERVICES_START_UP_RETRY_INTERVAL_SECONDS="interval-length"

Restart Tamr Core and its dependencies. See Restarting Tamr Core.

Changing the Storage Space Alert Thresholds

Tamr Core is configured by default to warn that the system is unhealthy when storage space is below 20% and to become read-only when storage space is below 10%. Tamr Core polls for storage space every minute, in all storage locations. You can change these thresholds and the polling interval using several configuration variables. See System Health Status for instructions.