osp-maps

Overview

The map module is responsible for storing and querying Geographical aggregation. Usage is bound with Map

Mapbox interactions

Access token

To use the maps module, you will need an access token. We recommend using an access token that only has the public scopes enabled. For more information, you can check these two links:

https://docs.mapbox.com/help/troubleshooting/how-to-use-mapbox-securely/
https://docs.mapbox.com/help/getting-started/access-tokens/#access-token-scopes

Warning

This token has to be passed through the web module configuration

Network Access

You will need access to the Mapbox API to load the maps.

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.maps	Defines the module configuration	json	module.maps
geo.maps	Defines a geographical location	json	geo.maps
layer.maps	Define a layer to display information base on their location.	json	layer.maps
layer.ospp	Define the properties of a layer (name, description).	json	layer.ospp

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