Section sites

Description

List of sites.

The section contains a list of all sites of the current configuration and their parameters. Servers are not related to the parameters. Binding of servers to sites is performed in the section structure.

Partition parameters

Table 1. Partition parameters
Specification Description

Key: name
Mandatory: yes
Default: ``

String, may consist of Latin letters and numbers, must begin with a letter

Key: sitetype
Mandatory: yes
Default: — 

Site Type.
Possible options:

  • master – master site.

  • communication – working site with full functionality.

  • master_communication – master site with full functionality.

Key: domains
Mandatory: yes
Default: — 

List of domains served on the site. Specified by names, not by fqdn.
The site also serves all domains from the child trees specified in the domains property.
A single domain can be served on multiple sites.

If any domain is listed on site A, and not listed on site B, with one of its parent domains listed on site B, then this domain and domains from its child tree are served only on site B.

Thus each domain of the full domain tree is served on at least one of the sites - where it is explicitly specified, or explicitly specified its parent domain and so on up to the master domain.

The master domain is automatically linked exclusively to the master site and does not need to be specified separately.

Key: descr
Mandatory: no
Default: ``

Site Description. Default: not set

Key: ctrl_domains
Mandatory: no
Default: []

List of domains that can be managed through a connection to the current site.
The way of specifying is similar to the field domains.

Key: num
Mandatory: no
Default: — 

Numeric site number of three digits to apply in site element names

Key: prefix
Mandatory: no
Default: — 

A three-character letter prefix for use in site element names

Key: check_quorum
Mandatory: no
Default: false

Site quorum accounting switch.
If the value is unassigned or empty, a similar global parameter is applied.
If the parameter is not set anywhere, the quorum accounting mechanism on the site does not apply.

Quorum - a group of actively linked and accessible servers on a site totaling more than half.
The use of quorum ensures the integrity of data at the moment when the site is scattered into several parts, due to the fact that functioning is maintained only on the part that has a quorum, and such at any given time is not more than one.
The quorum detection algorithm is executed in nodes where a master instance of any of the roles reserved in Active-Passive mode is started or running - at the time of activation and every 10 seconds during operation.

The special case of even halves is solved using arbitration servers (parameter odd_referee).

Key: check_offline
Mandatory: no
Default: false

Offline server state accounting switch (unavailability of arbitration servers).
If the value is unassigned or empty, a similar global parameter is applied.
If the parameter is not set anywhere, then the mechanism of taking into account the offline state of servers on the site is not applied.

Offline state is a condition where the server has no access to arbitration servers (odd_referee parameter) that are in the same zone as the users and the outside world (outside the data center).
The check applies if the site is hosted on two data centers connected by a separate direct link, and have independent external links. Read more about the mode.
The mode protects against the loss of an external channel by one of the data centers, taking microservices that interact with external services and subscribers out of service: im, email, mware, mg, script, ivrscript.

Key: odd_referee
Mandatory: no
Default: — 

The address or domain name of the third-party server that acts as the odd arbitrator server in determining quorum among an even number of servers on the site.
The arbitration server is verified by sending a ping request.
If the value is unassigned or empty, a similar global parameter is applied.
If the parameter is not set anywhere, the quorum check on the site assumes that the arbitration server is available and a quorum is present.
Multiple addresses or domain names listed comma separated (e.g. "8.8.8.8.8, my.domain.ru, yandex.ru") can be specified as a value. Then the availability check is considered successful if at least one of the arbitration servers is available.

Arbitration servers are checked for availability:

  • When the check_quorum setting is enabled. If the number of configured servers on the site is even, and exactly half of them are available in a connectivity group. All servers in this group are accessed with regularity of 2, 10, 30 seconds in different conditions.

  • When the check_offline setting is enabled. If the site is deployed on two data centers connected by a direct channel between them. Access is performed from all site servers where microservices interacting with external services and subscribers are deployed: im, email, mware, mg, script, ivrscript.

Key: leader_site
Mandatory: no
Default: — 

The name of another site in the system, the main site for the domain group that is assigned to serve the current site.
Specified if the current site is to be a backup site, i.e. to provide functionality only in case the specified site is unavailable.
During the passive state, some microservices are forcibly deactivated. Other microservices remain active, provide data synchronization and monitor the availability of the active site.
The setting assumes that the current backup site serves a subset of the specified site’s domains.

Key: logging_default_level
Mandatory: no
Default: empty

Default logging level applied to nodes served by this site’s servers.

Applies to those nodes that do not have a default logging level set server configuration settings.

If no level is specified, the value of this parameter from global configuration settings is applied.

Possible values:

  • CRASH

  • ERROR

  • WARNING

  • INFO

  • TRACE

  • DEBUG

Key: sip_stat_timeout_callinfo
Mandatory: no
Default: 1200

Storage time in seconds for call statistical information. Applies to monitoring requests /api/monitor/v1/trace/calls.
By default, data is saved for 20 minutes.
The longer the time - the longer in time from the moment of making a call the data can be provided by the monitoring request. At the same time, more RAM is required in the nodes of the cip alarm system.

If no value is given, the value of this parameter from global configuration settings is applied.

Possible values from 0 to 86400. 0 - no saving is performed.

Key: sip_stat_timeout_closure
Mandatory: no
Default: 12600

Time to store in seconds the statistical information about the mappings between Call-Id of phone calls of one session to calculate closures. It is used when building call diagrams.
Also stores information about Call-Id call relationships to system domains to enable diagramming in work domains on their own calls.
By default, data is saved for 3.5 hours.
The longer the time - the longer in time from the moment of making a call can be built closures and diagrams on SIP-signaling session. At the same time, more RAM is required in the SIP signaling nodes.

If no value is specified, the value of this parameter from global configuration settings is applied.

Possible values from 0 to 86400. 0 - no saving is performed.

Example of field value

{
  ...
  "sites": [
    {
      "descr": "Main Domain",
      "domains": [
        "td2",
        "td3",
        "td4"
      ],
      "name": "slave2",
      "sitetype": "communication"
    },
    {
      "ctrl_domains": [
        "td3"
      ],
      "descr": "Main Domain2",
      "domains": [
        "td_main",
        "td2",
        "td3",
        "td_test",
        "td5",
        "td6"
      ],
      "name": "central",
      "sitetype": "master_communication"
    }
  ],
  ...
}
json