OpenSpirit Master and Satellite Configurations
OpenSpirit master and satellite configurations are sets of configuration files that control how OpenSpirit enabled applications, tools, and data connectors behave. OpenSpirit master configurations and satellite configurations are created using the Install Config Manager tool.
config
located at the top level of the OpenSpirit software installation that the Install Config Manager is being run from. Normally an OSP_CONFIG
environment variable must be set to the fully qualified path to a configuration directory in order to run the OpenSpirit Desktop or to run third-party OpenSpirit enabled applications on Linux. Selecting the default location eliminates the need to set an OSP_CONFIG
environment variable before running the OpenSpirit Desktop. However, the OSP_CONFIG
environment variable must be set for third-party OpenSpirit enabled applications to connect even if the default config directory location is used. The OSP_CONFIG
environment variable is not needed on Windows. The configuration directory is required to be in a fixed location on Windows.Master Configuration
A master configuration is composed of a config.properties
file, a data
directory, and a logs
directory.
The config.properties
file is a text file that contains some of the configuration properties specified when creating the configuration using the Install Config Manager. Additional configuration properties are stored in the master's metadata repository. The purpose of the master config.properties
file is to provide information needed to run the OpenSpirit shared service, to run the OpenSpirit Desktop, and to enable third-party OpenSpirit enabled applications to connect to OpenSpirit.
Following is an example of the contents of a master configuration config.properties
file.
#OpenSpirit configuration file.
# #Wed Nov 10 10:43:11 CST 2017 HOST=osp-server.bigoil.com DATA=/apps/OpenSpiritConfigs/offshore-group/data
LOG=/apps/OpenSpiritConfigs/offshore-group/logs
HOME=/apps/OpenSpirit/v4.3 DB_UUID=67b5c8f0-cc6c-9161-1c3d-001296b0312e
PORT=15430
The data
directory contains the files and subdirectories that represent the OpenSpirit master's metadata repository. The logs
directory is the directory that the OpenSpirit shared service writes its log files to. The default is to create the data
directory and the logs
directory as subdirectories under the master configuration directory. The default locations can be changed when creating the master configuration using the Install Config Manager.
Satellite Configuration
A satellite configuration is composed of a directory containing only a config.properties
file. A satellite config.properties
file contains a subset of the information contained in a master config.properties
file. Its purpose is to indicate the OpenSpirit master that the satellite is to be associated with. The satellite config.properties
file provides information needed to enable the OpenSpirit Desktop and third-party OpenSpirit enabled applications to connect to the metadata repository managed by the satellite's associated master.
Following is an example of the contents of a satellite configuration config.properties
file.
#OpenSpirit configuration file.
# #Wed Nov 11:15:12 CST 2017 HOST=osp-server.bigoil.com
HOME=/apps/OpenSpirit/v4.3
PORT=15430