Configuring a Master Installation

Master configurations are typically created by an IT administrator that has knowledge about your company's network and security infrastructure.

Click the create master configuration button in the Install Config Manager tool bar to open a new master configuration form. The form has some optional configuration setting fields and some mandatory fields. Each of the settings is described below. Enter the settings and press the save button to create a master.

A status icon is displayed to the right of each setting. The status icon appears as a green check mark when a setting contains a valid value. The status icon appears as a red stop sign when a required setting has not been entered, or when the value is not considered valid. Click the red stop sign icon to display information about why it is not considered being valid.

Each of the master configuration settings is described below.

Note: Note, the config directory, and database directory settings are not allowed to be changed once a new master configuration has been saved.

Description

The description setting is optional. The description provides a way to document the purpose for a master configuration, such as the business unit serves. It can contain any text.

Config Directory

The directory that the configuration's config.properties file is written to. This should be an empty directory before creating the master configuration. This setting is for informational purposes only when configuring a master on Windows. The default configuration directory must be used on Windows. Select an empty directory when configuring a master on Linux. The directory must be readable by the users that are running applications or data connectors from the master.

The config directory cannot be changed once the master configuration has been saved.

Tip: The default directory on Linux is a subdirectory named config in the top-level folder of the OpenSpirit software installation that the Install Config Manager is being run from.
Using the default directory eliminates the need to have an OSP_CONFIG environment variable set before running the OpenSpirit Desktop on Linux. The environment variable must be set if a different name or location is used.

Database Directory

The database directory setting determines where the master's metadata repository is created. The default it to create the database directory as a subdirectory under the config directory. The database will grow over time, so be sure to select a directory that will have enough space to accommodate your needs. The master's shared service process are read and write files in this directory, so the account used to run the shared service process must have read and write access to this directory. OpenSpirit users do not need read or write access to the database directory. See the Disk Space section of this guide for information that can help you estimate your metadata repository space requirements.

The database directory setting cannot be changed once the master configuration has been saved.

Log Directory

The log directory setting determines where the master's service processes write their log files. The default is to create the log file directory as a subdirectory under the config directory. OpenSpirit users do not need read or write access to the log directory.

Installation Directory

The installation directory is shown for informational purposes only. It shows the OpenSpirit software installation directory that the Install Config Manager is being run from. This setting cannot be changed.

Host and Port

The host and port setting determines the host and port used to run the master's shared service process. Click the edit button to open a window used to edit this setting.

The host setting displays the name of the computer that you are running the Install Config Manager on. The host name cannot be changed. Run the Install Config Manager on the host computer that is to run the master's shared service processes.

The port setting has a default value that can be modified. The port setting must be an integer number between 1024 and 65535. Do not use commas, only numbers. The port number must not already be in use by another service running on your computer. Your computer's security settings must allow the master's shared service process to publish a network TCP/IP socket with this port number and other computers on your network that need to access this OpenSpirit master must be allowed to connect to this port.

Anyone installing a satellite to the master needs to know this host and port setting.

Remote Startup Method

The remote startup method setting determines the network protocol that is used by the OpenSpirit framework to create data connector processes on a different computer from the computer that is running the OpenSpirit enabled application needing to access data. For example, when a user is running the OpenSpirit Desktop on a Windows desktop computer and would like to view data that resides in a GeoFrame database, a process must be created on Linux in order to call the GeoFrame libraries required to read and write the GeoFrame data. The Linux process is started using the network protocol selected for the remote startup method setting.

SSH with Password Authentication

This remote startup method uses the Secure Shell network protocol with account/password authentication. Users must use the User Setup Wizard in the OpenSpirit Desktop to save their login account and password in the OpenSpirit metadata repository. The OpenSpirit framework uses the saved account and password to create remote processes when they are needed.

The host computers that OpenSpirit users use to run remote data connector processes must be running a Secure Shell daemon that permits remote command execution using account/password authentication.

SSH with Password Authentication (interactive)

This remote startup method uses the same Secure Shell network protocol as the non- interactive method described above. The only difference is the account passwords are not entered in the User Setup Wizard and are not saved in the OpenSpirit metadata repository. OpenSpirit users are prompted to enter the password at the time the OpenSpirit framework receives the request to start a remote data connector process.

Note: The interactive remote startup method is not work for batch work flows, such starting data connector processes during Copy Manager or Scan Utility jobs scheduled to run at night when the user is not available to respond to a password prompt. See the tip about manually starting a locator process in the Host Account Settings section of the User Setup Wizard help guide.

REXEC

This remote startup method uses the Remote Process Execution network protocol with account/password authentication. Users must use the User Setup Wizard in the OpenSpirit Desktop to save their login account and password in the OpenSpirit metadata repository.

The OpenSpirit framework uses the saved account and password to create remote processes when they are needed.

The host computers that OpenSpirit users use to run remote data connector processes must be running a REXEC daemon that permits remote command execution using account/password authentication.

REXEC (interactive)

Note: This remote startup method uses the same Remote Process Execution network protocol as the non-interactive method described above. The only difference is the account passwords are not entered in the User Setup Wizard and are not saved in the OpenSpirit metadata repository. OpenSpirit users are prompted to enter the password at the time the OpenSpirit framework receives the request to start a remote data connector process.

The interactive remote startup method is not work for batch work flows, such starting data connector processes during Copy Manager or Scan Utility jobs scheduled to run at night when the user is not available to respond to a password prompt. See the tip about manually starting a locator process in the Host Account Settings section of the User Setup Wizard help guide.

External Executable

The external executable remote startup method does not select a network protocol. This remote startup method provides a way for companies to supply their own remote process creation program or script. This setting works in concert with the external executable settings found on the Advanced Settings tab of the Install Config Manager.

The Advanced Settings tab provides an external executable command setting for each operating system platform supported by the OpenSpirit framework. The external executable command settings are used to construct commands to start remote data connector processes.

Substitution variables prefixed by a $ character can be referenced in the command setting. Some variables are required and some are optional. The OpenSpirit framework substitutes values for the variables before running the command. The following table describes the command substitution variables.

Variable Name

Required?

Description

host yes The name of the computer that the command should be ran on. The host name is determined by the user's preferences entered into the User Setup Wizard.
command yes The command to be runs. This is the path to an OpenSpirit executable with command-line options needed to start data connector processes
userhome no This is set to $HOME on Linux and %USERPROFILE% on Windows. It is the home directory on the local computer requesting the remote process to be started, not the home directory on the remote computer.
osphome no This is set to the top-level directory of the OpenSpirit software installation on the local computer requesting the remote process to be started, not the OpenSpirit installation directory on the remote computer.

The default settings are provided as an example of how to specify external executable commands. It is likely that the default commands that not work without customizing them for your company's environment.

Admin Password

The admin password setting establishes the password needed to perform administrative functions in the OpenSpirit installation. The password is not needed when running under the account used to create the OpenSpirit master configuration. The password is needed to perform administrative functions using a different account. Click the edit button to open a window used to enter the OpenSpirit administrator password.

Enter and confirm the value that you would like to use for the OpenSpirit administrator password.

License Path

Licenses are needed to run OpenSpirit software. OpenSpirit licenses are managed by a license service that must be installed and running somewhere on your network. The license path setting tells the OpenSpirit framework how to locate the OpenSpirit license service. See the License Service section of this guide for information about installing the OpenSpirit license service.

Click the edit button to open a window used to enter the license path.

A license path is an ordered list of OpenSpirit license services. OpenSpirit applications and data connectors go through the list to find a license service that has the required license available for checkout. The list is searched in the order that it appears in the license path list. Most companies only have a single license service in the license path.

Note: OpenSpirit licenses can be purchased for use at a single site or for global use. It is a violation of the TIBCO OpenSpirit license agreement to use single site licenses to service users working from another site. Consult with your TIBCO OpenSpirit sales representative if you are unsure about the geographic scope of your OpenSpirit licenses.

License services are added to the license path by clicking one of the insert buttons to the right of the license path list.

Single Host License Service

The Insert Single License button opens a window used to enter the host name and port number of the computer that is running the OpenSpirit license service configured to use a single host computer.

The host name should be a name of the computer that is running the OpenSpirit license service. The host name needs to be known to all computers that are used to run OpenSpirit applications and data connectors. The port number should be the port specified in the OpenSpirit license file that is being used by the OpenSpirit license service. See the License Service section of this help guide for information about setting the license service port number.

Redundant Host License Service

The Insert Redundant Lic. Button opens a window used to enter the host names and port service that have been configured to run in a three host redundant mode. See the Choosing the License Service Host section of this guide for information about the three host redundant license service model.

The redundant license service window requires the host names and port numbers of three hosts that have been configured to run a redundant license service. Note, the license service must be configured as a three host redundant service to use this option.

License Path Order

The order that license hosts appear in the license path determines the order they are used when a request is made to check out a license. The order can be changed by selecting a path element and clicking the Move Up or Move Down button.

Save Configuration

Click the save button to create the master or save changes to an existing master.

Starting Shared Services

The shared service process can be started once the master configuration has been saved.

The red off button indicates that the shared service process is not currently running. Click the button to start the services. The button changes to a green on button when the services are running. Clicking the green on button stops the services.

The button to the right of the on/off button opens the log file that the shared service process writes log messages to. The log for the currently running services is displayed. The log from the most recent run of the shared service process is displayed if the services are not running when the button is pressed.

Tip: The shared services must not be running when making changes to the master configuration settings and when importing metadata into the master. You may want to perform any imports and make advanced setting changes before starting the services.