Configuring Tamr

To set custom values for configuration variables in Tamr, use the unify-admin.sh tool.

📘

Restart Tamr to Apply Configuration Changes

After updating configuration variables, you must restart Tamr and its dependencies to apply the changes.

Configuring Tamr Using the Admin Tool

Use the Tamr admin tool, unify-admin.sh, to configure Tamr. For the full list of parameters this command takes, see Admin Tool Command Reference.

📘

Working with spaces and quote characters

When running unify-admin.sh, use these tips:

• If values contain space characters, wrap them in double quotes, as in: "Value with a space".
• If values contain quote characters, add a back slash to escape quotes: Quoted_\"Value\"

Getting configuration variables

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

1. To obtain a list of all configuration variables, run:

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

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

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

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.

To set configuration variables as command line arguments:

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

2. Restart Tamr and its dependencies. See Restarting.

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

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

2. Run the script as follows:

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

3. Restart Tamr and its dependencies. See Restarting.

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.

1. To reset all configuration variables, run:

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

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

Changing the default Tamr port

You can change the access HTTP port that Tamr uses by default from 9100 to another port.

To change the port:

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

3. To apply the new values, restart Tamr and its dependencies. See Restarting.