From 59279d2e1e06daa65672f09296f2d6327682349c Mon Sep 17 00:00:00 2001 From: Petr Stefan Date: Mon, 21 Mar 2016 12:39:53 +0100 Subject: [PATCH] Describe config files --- Configuration-and-usage.md | 44 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/Configuration-and-usage.md b/Configuration-and-usage.md index da143f3..e43888b 100644 --- a/Configuration-and-usage.md +++ b/Configuration-and-usage.md @@ -18,6 +18,34 @@ Installation of **worker** program does following step to your computer: Worker should have some default configuration which is applied to worker itself or may be used in given jobs (implicitly if something is missing, or explicitly with special variables). This configuration should be hardcoded and can be rewritten by explicitly declared configuration file. Format of this configuration is yaml like in the job config. +#### Configuration items + +If not specified otherwise than its mandatory item! Mandatory items are bold, optional italic. + +- **worker-id** - unique identification of worker at one server. This id is used by _isolate_ sanbox on linux systems, so make sure to meet isolates requirements (default is number from 1 to 999). +- **broker-uri** - URI of the broker (hostname, IP address, including port, ...) +- _broker-ping-interval_ - time interval how often to send ping messages to broker. Used units are milliseconds. +- _max-broker-liveness_ - specifies how many pings in a row can broker miss without making the worker dead. +- _headers_ - headers specifies worker's capabilities + - _env_ - map of enviromental variables + - _threads_ - information about available threads for this worker +- **hwgroup** - hardware group of this worker. Hardware group must specify worker hardware and software capabilities and it's main item for broker routing decisions. +- _working-directory_ - where will be stored all needed files. Can be the same for multiple workers on one server. +- **file-managers** - addresses and credentials to all file managers used (eq. all different frontends using this worker) + - **hostname** - URI of file manager + - _username_ - username for http authentication (if needed) + - _password_ - password for http authentication (if needed) +- _file-cache_ - configuration of caching feature + - _cache-dir_ - path to caching directory. Can be the same for mutltiple workers. +- _logger_ - settings of logging capabilities + - _file_ - path to the logging file with name without suffix. `/var/log/recodex/worker` item will produce `worker.log`, `worker.1.log`, ... + - _level_ - level of logging, one of `off`, `emerg`, `alert`, `critical`, `err`, `warn`, `notice`, `info` and `debug` + - _max-size_ - maximal size of log file before rotating + - _rotations_ - number of rotation kept +- _limits_ - default sandbox limits for this worker. All items are described on [assignments page](https://github.com/ReCodEx/GlobalWiki/wiki/Assignments-overview#configuration-items). + +#### Example config file + ``` worker-id: 1 broker-uri: tcp://localhost:9657 @@ -103,6 +131,22 @@ Installation of **broker** program does following step to your computer: ### Default broker configuration +#### Configuration items + +- _clients_ - specifies address and port to bind for clients (eq. frontends) + - _address_ - hostname or IP address as string (`*` for any) + - _port_ - desired port +- _workers_ - specifies address and port to bind for workers + - _address_ - hostname or IP address as string (`*` for any) + - _port_ - desired port +- _logger_ - settings of logging capabilities + - _file_ - path to the logging file with name without suffix. `/var/log/recodex/broker` item will produce `broker.log`, `broker.1.log`, ... + - _level_ - level of logging, one of `off`, `emerg`, `alert`, `critical`, `err`, `warn`, `notice`, `info` and `debug` + - _max-size_ - maximal size of log file before rotating + - _rotations_ - number of rotation kept + +#### Example config file + ``` # Address and port for clients (frontend) clients: