Configuration

Default Configuration

If no other configuration is provided, the Cuneiform worker application uses the following default configuration:

{
  "n_wrk":    "auto",
  "cre_node": "node",
  "wrk_dir":  "./cuneiform/tmp",
  "repo_dir": "./cuneiform/repo",
  "data_dir": "./data"
}

This configuration can be superseded by

  • creating a global configuration file with a subset of the above entries in /usr/local/etc/cuneiform/cf_worker.json
  • creating a user-specific configuration file with a subset of the above entries in ~/.config/cuneiform/cf_worker.json
  • providing a custom configuration file provided at the command line (see Integration and Build)
  • providing explicit command line flags (see Integration and Build)

Configuration Entries

The Cuneiform worker application has the following configuration entries:

  • n_wrk The number of worker processes to start under this application master. A positive integer or the string "auto". If the entry is set to "auto", the application tries to guess the number of cores on the machine and start as many workers. If the number of cores could not be determined, one worker process is started.
  • cre_node The Erlang node name on which the CRE application is running. Any string or "node". If the entry is set to "node" the CRE application is looked up on the current Erlang node.
  • work_dir Local directory where the worker application performs work, i.e., copies input data to, runs scripts, and copies output data from.
  • repo_dir Possibly remote repository directory where intermediate and output data is read from and written to.
  • data_dir Possibly remote input data directory. This directory is never altered by the cf_worker or any other Cuneiform-related application.

Attention

Leaving the CRE node at the default value "node" will most likely result in an error. Typically, if the CRE computer’s hostname is my_host you need to set the CRE Erlang node to "cre@my_host". However, you have the freedom to set this parameter as early as in the global configuration file or as late as on the command line.