Key: generaldomain
Required: yes
Default: —
|
Alias of the main domain from the "tds" section
|
Key: version
Required: yes
Default: —
|
Configuration version. A strict value known to the system. Currently "3.0"
|
Key: master_admin_login
Required: no
Default: —
|
Master administrator login.
The credentials allow requests into the system under the administrator role.
The account itself does not exist in the domain.
|
Key: master_admin_pwd
Required: no
Default: —
|
Master administrator password.
Can be specified as plaintext or encrypted: when the configuration is saved, it is encrypted with the installation key.
Secret: ciphertext when read; the plaintext value is not returned via API and is decrypted by the service when used; a plaintext value can be supplied on input (Encryption and keys).
|
Key: logging_min_disk_space
Required: no
Default: 3
|
Minimum free disk space in GB at which logging is disabled.
|
Key: logging_role_store_days
Required: no
Default: 2
|
Number of days for which log files are stored in the working directory of the role node.
|
Key: logging_role_max_size
Required: no
Default: 100
|
Maximum size of log files in GB that can be occupied by one role node (the log directory in the role node’s working directory).
|
Key: logging_default_level
Required: no
Default: "INFO"
|
Default logging level applied to all nodes.
Applied to nodes for which the default logging level is not set by the configuration settings of a role, server, or site, and the current logging level is not set via the API or from the master domain administrator application.
The default level is applied before role/microservice applications start.
Keep in mind that individual microservices have their own logging level settings for specific journals. For example, SIP signaling trn logs, media gateway debug logs, and web server WebSocket tracing.
-
CRASH
-
ERROR
-
WARNING
-
INFO
-
TRACE
-
DEBUG
|
Key: logging_store_mode
Required: no
Default: "text"
|
Mode of transferring logs and other files from node log directories to the logstore storage.
Applied to nodes for which the mode is not set by the configuration settings of a server or site.
The change takes effect for subsequent file transfers.
-
text — files are transferred as is
-
gzip — files are transferred compressed (<name>.gz); the compressed copy is created on the node next to the source file and deleted together with it; the source logs on the nodes remain uncompressed
|
Key: pang_to_disconnect_sec
Required: no
Default: 10
|
Time in whole seconds counted by availability monitoring services that must pass before the next failed ping attempt causes a forced disconnect.
Used by the rpci service and by leadership management services.
If set to 0, the first failed ping between nodes causes a forced connection break and follower activation.
|
Key: takeover
Required: no
Default: global
|
Takeover mode switch used by default for all cluster microservices.
Failover - activation of a lower-priority service instance when the higher-priority service instance (leader of an active-passive group) is detected as unavailable.
Takeover - activation of the higher-priority service instance (leader of an active-passive group) during its recovery, accompanied by stopping the service on the lower-priority service instance.
Applied only to microservice instances for which no individual value is set in the role configuration parameter.
* If the mode is enabled, takeover is performed automatically.
* If the mode is disabled, takeover is not performed; the recovered group leader temporarily becomes a follower and waits for the service to be unloaded on the lower-priority instance.
* If the option is not set, the mode is enabled by default for more accurate load distribution according to the priorities configured.
|
Key: sip_stat_timeout_callinfo
Required: no
Default: 1200
|
Call statistics retention time in seconds. Used for monitoring requests /api/monitor/v1/trace/calls.
By default, data is retained for 20 minutes.
The longer the time, the longer after the call the data can be provided by a monitoring request. At the same time, more RAM is required in SIP signaling nodes.
Applied to nodes for which the value is not set by the server or site configuration setting.
Possible values from 0 to 86400. 0 - no retention.
|
Key: sip_stat_timeout_closure
Required: no
Default: 12600
|
Retention time in seconds of statistics about links between Call-Ids of telephone calls in one session for closure calculation. Used when building call diagrams.
It also stores information about links between call Call-Ids and system domains to enable building diagrams in working domains for their own calls.
By default, data is retained for 3.5 hours.
The longer the time, the longer after the call the closures and SIP signaling diagrams of the session can be built. At the same time, more RAM is required in SIP signaling nodes. When the callid log is enabled (the log_closure role parameter), closures are also built from it: the time can be reduced, but not below sip_stat_timeout_callinfo (domain links are used in the current calls list of working domains), volume estimate.
Applied to nodes for which the value is not set by the server or site configuration setting.
Possible values from 0 to 86400. 0 - no retention.
|
Key: cdr
Required: no
Default: true
|
CDR event switch. Used for test environments and call generators on load stands. Without CDR events, the load is significantly reduced, but CTI events, CCS call center interaction events, and call recording are unavailable.
|
Key: check_quorum
Required: no
Default: false
|
Default quorum accounting switch.
Used as the default value unless otherwise specified in the properties of a specific site.
If the parameter is not set globally and is not defined in the settings of a specific site, the quorum accounting mechanism is not applied on that site.
Quorum is a group of active, interconnected, and mutually available site servers totaling more than half.
Quorum ensures data integrity when a site splits into several parts, because operation is maintained only in the part that has quorum, and there is at most one such part at any time.
The quorum determination algorithm runs in nodes where the master instance of any role made redundant in Active-Passive mode is started or running: at activation and every 10 seconds during operation.
If quorum unavailability is detected, 2 more attempts are made at 2-second intervals, after which the node restarts and enters the waiting-for-quorum mode from its server.
A special case is splitting a site strictly into two equal halves, each a candidate for quorum.
Under high load, servers in the candidate subgroup may spend more time checking connectivity due to additional check timeouts when polling other servers (10 seconds).
To apply the quorum concept, the resulting equal islands require an external arbiter (50%+1). The island that has communication with the arbiter obtains quorum.
|
Key: check_offline
Required: no
Default: false
|
Switch for accounting the offline state of servers (unavailability of arbitration servers).
Used as the default value unless otherwise specified in the properties of a specific site.
If the parameter is not set globally and is not defined in the settings of a specific site, the offline state accounting mechanism is not applied on the site.
Offline state is a condition when a server has no access to arbitration servers (the odd_referee parameter) located in the same zone as users and the outside world (outside the datacenter).
This may indicate that the external channel is unavailable for the current server.
The check can be used, for example, when a site is placed in several datacenters connected by a separate direct channel and having independent external channels. More about the mode.
The mode protects against problems arising when one datacenter loses its external channel by removing from service microservices that interact with external services and subscribers:
im, email, mware, mg, svc, ivr.
|
Key: odd_referee
Required: no
Default: —
|
Address or domain name of a third-party server acting as an odd arbiter when determining quorum among an even number of servers.
The arbitration server is checked by sending a ping request.
Used as the default value unless otherwise specified in the site properties.
If the parameter is not set globally and is not defined in the settings of a specific site, then when determining quorum on that site, the arbitration server is considered available and quorum is considered present.
The arbitration server is used only if the number of configured servers on the site is even and exactly half of them are available.
|
Key: crypto_kid
Required: no
Default: —
|
Installation key identifier (16 hexadecimal characters) used to encrypt domain secrets (storage passwords, cloud account keys and passwords and connection strings in domain settings, tokens) and configuration secrets (DB connection string passwords, master_admin_pwd, mware role passwords, role keypass).
The key file is delivered to all servers through the synchronized :SYNC/secure/keys/ directory; the server key service copies new keys from it to the server’s local secure/keys/ directory at the root of :LOCAL (for example, /var/lib/era_files/local/secure/keys/), and from the installer directory /var/lib/era/_workdir/erainstaller/secure/keys/ (the key created during installation) to :SYNC/secure/keys/ it copies only the active configuration key (or all keys if the :SYNC/secure/keys/ directory is accessible and contains no key file, even a corrupted one). The directories are not accessible via API or scripts; permissions are owner-only (0700, files 0600). Files are not overwritten or deleted by the service (a corrupted or partially written file is replaced with an intact copy); deleting old keys is an administrator decision (more). A mismatch in the contents of the same key file in different directories is logged as an error. A configuration with a new identifier for which no file exists is considered invalid.
Configuration secrets are encrypted when it is created and modified with the key from its parameter (if not set, with the active configuration key); when the configuration is activated, its secrets and those of other saved configurations are re-encrypted with its key.
During installation, the key is created automatically and specified in the base configuration; the configuration master carries it into new configurations. During restore, key files from the backup are placed in the installer directory before installation: the key is not created, the previous one is used (installation parameter CRYPTOKID).
In an existing system, the key is created by the erainstaller.sh keygen command on the server with the mic role: a key file and a new configuration are created — a copy of the active one with this parameter. The administrator activates the configuration.
Storage passwords are re-encrypted with the key when the storage is saved; setting secrets are re-encrypted when a new value is entered. If the parameter is not set, secrets are encrypted in the previous way. Values saved earlier remain readable with any parameter value. Encryption formats (v4 with the built-in key, v5 with the installation key) are described in Encryption and keys.
Key files are included in the backup of the :SYNC directory; after creating a new key, back up :SYNC. Without the key file, values encrypted with it cannot be decrypted. Keys are not deleted automatically: without the old key file, its values cannot be decrypted, including in the change log and backups. During domain hot standby, key files are copied to :SYNC/secure/keys/ of the other system before specifying the parameter.
|
Key: pwd_hash_alg
Required: no
Default: —
|
Hash function for storing user passwords. By default, the parameter is absent and no hash function is used; user passwords are stored in the DB in plain text. Equivalent to the value "none".
If sha, sha256, sha384, sha512, or md5 is specified, when a user password is changed it is stored in the DB in hashed form, and verification hashes the checked value.
Any other value disables hashing.
Changing the parameter does not change data in the DB and requires setting new passwords for all users.
When external authorization scripts are used (password verification in an external system), user account passwords stored in the DB are not used in normal mode and can be used only when assigning or running the script fails.
|
Key: virtualip_automation
Required: no
Default: false
|
Switch for the service that assigns virtual IP addresses to cluster servers.
The value applies to servers for which a similar server or site parameter is not set.
The operating principle is described in the servers section.
|
Key: sip_supported_events
Required: no
Default: []
|
Additional SIP SUBSCRIBE event types (Event header) accepted by the b2b microservice beyond the built-in ones. Changing the value restarts b2b nodes.
|
Key: update_download_timeout
Required: no
Default: 1
|
Pause in milliseconds between chunks (128 KB each) when downloading update files from a remote node. Limits network and disk load.
|