Web Server (ws)

Содержание

Описание
Ограничения
Параметры
Пример конфигурации
См. также

Описание

Предоставляет доступ к API системы через HTTP и WebSocket, а также обслуживает выдачу статических файлов системных и ролевых веб-приложений. Для доступа к API проводит авторизацию и работает с HTTP-сессиями через выставление и использование Cookie. Для некоторых endpoint’ов доступна авторизация по токену с использованием заголовка `Authorization: Bearer <intergation_point.token_local>`.

Резервируется и масштабируется в режиме Active-Active.

При запуске функциональной роли проверяется сертификат указанный в параметре *certdir*. Если валидация не пройдена, функциональная роль запускается с неизменяемым сертификатом. Сертификат может быть переопределен через настройки домена.

Table 1. Системные характеристики

Код	`ws`
Режим работы	`Сервис`
Режим резервирования	`Active-Active`
Типы сайтов	`Любые`
Слой	`Бизнес-логика`
Размещение	`Пограничный`
Сохранение и восстановление состояния при перезагрузке	`Нет`
Приложение	`rostell_ws`

Ограничения

Присутствует в начальной конфигурации.
Является пограничной функциональной ролью, использует сертификат TLS для HTTPS и WSS подключений.

Параметры

Описание столбцов в таблице

Table 2. Параметры
Имя	Тип	Умолчание	Описание
`name`	`str`	required	Имя. Может состоять из латинских букв и цифр, должно начинаться с буквы.
`roletype`	`str`	required	Тип функциональной роли. Возможные значения: `"ws"`.
`iface`	`str`	required	Алиас сетевого интерфейса сервера, на котором будет происходить внутреннее взаимодействие функциональных ролей между собой.
`roleid`	`int`	required	Идентификатор функциональной роли. Уникален для всей системы, независимо от сайта или сервера. Нельзя изменить после присвоения. Целое число от `1` до `9999`
`separate`	`bool`	`false`	Признак выделения функциональной роли в отдельную ноду.
`apdir`	`str`	empty	Алиас каталога на сервере для хранения файлов autoprovision.
`certdir`	`str`	empty	Алиас каталога на сервере для хранения сертификатов (файлы server.crt и server.key), в случае необходимости указания цепочки сертификатов до центра сертификации (CA - Certification Authority) его необходимо разместить в конце файла сертификата. Если путь не указан, то поиск сертификатов осуществляется в каталоге `"/usr/lib/rostell/rostell_ws/priv/ssl"`
`keypass`	`str`	empty	Пароль для расшифровки файла секретного ключа сертификата.
`httpport`	`int`	`80`	Локальный порт веб-сервера для открытых TCP подключений.
`httpsport`	`int`	`443`	Локальный порт веб-сервера для TLS поключений.
`ports_mode`	`str`	`"both"`	Режим работы портов. Возможные значения: `"both"` – http и https порты открыты; `"http-only"` – открыт только http порт; `"https-only"` – открыт только https порт; `"http+redir"` – http и https порты открыты, но https работает в режиме перенаправления на http; `"https+redir"` – http и https порты открыты, но http работает в режиме перенаправления на https.
`service_mode`	`str`	empty	Режим обслуживания запросов `"both"` – обе части работают (и API, и статика (системные и ролевые веб-приложения)); `"api-only"` – работает только api; `"static-only"` – работает только статика.
`websock_debug_level`	`int`	`0`	Уровень логирования сообщений протокола websocket. По умолчанию: `0`. Возможные значения: `0` – не логирует; `1` – логирует старты стопы подключений; `2` – логирует простые ошибки; `3` – логирует ошибки с упоминанием тела ошибочного сообщения; `4` – логирует факт всех входящих и исходящих сообщений; `5` – логирует все входящие и исходящие сообщения, отрезая первые 1024 байта; `6` – логирует полностью все входящие и исходящие сообщения.
`wwwdir`	`string`	empty	Алиас каталога на сервере со статическими ресурсами web-сервера. По умолчанию: `"/usr/lib/rostell/rostell_ws/priv/www"`

Пример конфигурации

Управление конфигурацией производится в приложении, доступном для администраторов мастер-домена. Приложение скрывает полное содержание конфигурации, однако тем не менее оно доступно через API.

Конфигурация содержит раздел для описания всех экземпляров всех функциональных ролей. Параметры определяются для каждого конкретного экземпляра функциональной роли.

Пример узла

{
  "iface": "eth0",
  "name": "lwmws1",
  "roletype": "ws",

  "certdir": "/var/lib/rostell/certificates",
  "keypass": "eb9c4458016d3f1e378d02004c4f4f50"
}

См. также

Конфигурация