osp-web
Overview
The Web module is responsible for the communication between front-end and back-end.
The Web module exposes an HTTP/Websocket API to the front-end. The requests on the API are translated and sent to modules responsible for the task. Then the module responses are translated and sent back to the front-end over the API.
List of configuration files
Filename |
Short description |
Format |
Documentation |
|---|---|---|---|
module.service |
Each service is defined in a separate file and then combined into a unified compose stack file |
yml |
See the Swarm administration or Official documentation |
module.web |
Define the module configuration |
json |
|
endpoint.webhook |
Define a endpoint that can be used to trigger a webhook. |
json |
|
owner.webhook |
Define how to handle a request received on the endpoint. |
json |
|
severity.ospp |
Define the property of a severity (name, description). |
json |
|
severity.web |
Define how to display the link severity. |
json |
|
filter.ospp |
Define the property of a filter (name, description). |
json |
|
filter.web |
Define the filter available to the front-end. |
json |
|
view.ospp |
Define the property of a view (name, description, fields). |
json |
|
view.web |
Define how to display an alarm. |
json |
|
menu.web |
Define a menu to interact with the dashboard. |
json |
|
dashboard.view |
Define the information displayed on the dashboard. |
json |
|
dashboard.web |
Define the property of the link dashboard. |
json |
Environment Variables
Variable Name |
Default Value |
Usage |
|---|---|---|
MODULE_CONTROL_OWNED_TIMEOUT_S |
300 |
Defines the minimum delay (in seconds) before sending a new restart request for the web-module after one has already been issued. |
MODULE_CONTROL_OWNED_TIMEOUT_RETRIES |
2 |
Specifies the maximum number of restart attempts the orchestrator can perform for the web-module before it terminates itself. |
Environment Variables
All modules env variables
Variable Name |
Default Value |
Usage |
|---|---|---|
PROMETHEUS_PORT |
9100 |
The internal port used for Openmetrics exposition. |
DISPATCHER_HOST |
modules_configuration-dispatcher_main |
The hostname on which the modules can fetch the configuration. |
DISPATCHER_PORT |
10000 |
The port used by the module to listen for configuration request. |
USE_LEGACY_RESTART |
Not set |
When this flag is enabled, the container will terminate itself whenever a restart is needed (for example, after a configuration change). This is the legacy restart (before version 2.1.0). Otherwise, the system will simply restart the process running inside the container. |
CUSTOM_JVM_OPTIONS |
Not set |
Allow to inject JVM options. See Configuration changes for more information. |
ALLOW_VERSION_MISMATCH |
Not set |
Allow to disable the version check when a new configuration is published to a module. By default, a module will not be restarted if its configuration does not match its version. |
Dedicated variables
None
Hot-reload
Hot reload is supported for most elements. However, changes to the following configurations will trigger a full module reload:
Messaging configuration