Voice Mail Server (vmail)

Table of Contents

Description
Limitations
Parameters
Configuration example
See also

Description

Provides voice mailbox service and voice mail service operation.

Divided into microservices by domain.
Reserved in Active-Passive mode. Scaled by domain tree partitioning.

Table 1. System Characteristics

Code	`vmail`
Mode of operation	`Storage, service`
Backup mode	`Active-Passive`
Types of sites	`Any`
Layer	`Business logic`
Placement	`Internal`
Saving and restoring state on reboot	`Yes`
appendix	`era_vmail`
Own storage	`File system, :SITESHARE`

Limitations

The repository of records is SiteShare.
The mail is hosted on the site from which the request originated, and when received, the data from all sites where the domain is served is produced.

Parameters

Description of columns in the table

Table 2. Parameters
Name	Type	Default	Description
`name`	`str`	required	Name. May consist of Latin letters and numbers, must begin with a letter.
`roletype`	`str`	required	Role Type. Possible values: `"vmail"`.
`iface`	`str`	required	The alias of the server network interface on which the roles will interact internally with each other.
`ext`	`json`	empty	Additional role options. Contains a json object or list.
`enabled`	`bool`	empty	Role activity flag. When set to false, the role does not participate in validation and is not started.
`group`	`int`	required	Group Number. As part of horizontal scaling, a role can be divided into multiple groups on a site, with only one instance active in each group and the rest reserved. Responsibilities between groups are shared across domain sets. Together, all groups maintain a complete domain set. All roles in the same group must have the same responsibility. Integer from `1` to `9999999`.
`order`	`int`	required	The order of a role instance within a group. Defines in what order the flow in the mode will take place Active-Passive.
`include_domains`	`array<str>`	empty	A list of domain names served by this group. Any domain of any level can be specified. Specifying a domain causes its subdomain tree to be served on this group and not on other role groups, excluding only those branches mentioned in other groups. Collectively, all role groups on a site serve a complete domain tree.

Configuration example

The configuration is managed in an application available to master domain administrators. The application hides the full content of the configuration, but it is nevertheless accessible via the API.

The configuration contains a section to describe all instances of all roles. Parameters are defined for each specific role instance.

Example node

{
  "name": "vmail1",
  "roletype": "vmail",
  "iface": "eth0",

  "group": 11390,
  "order": 3,

  "include_domains": [
    "test.rootdomain.ru"
  ]
}

Voice Mail Server (vmail)

Description

Limitations

Parameters

Configuration example

See also