osp-variables

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.variables	The configuration of the module	json	module.variables
owner.variables	Define the owner of the variable	json	module.variables
output.variables	Permits changing the value of the variable	json	output.variables

Overview

The osp-variables provides features to manage internal variables which can be used by other modules.

Persistent storage

The osp-variables plugin provides access to variables where data can be stored and retrieved from. It also provides an option to store the variables on the filesystem to keep persistent state across systems restarts.

The data are stored on /osp/data/store and this must be persisted between restart.

Note

See persistent storage section for more details

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