FTL Server Configuration

Specify all the values for a localized cluster of cooperating FTL servers, along with the services they provide in a single YAML formatted configuration file. A cluster of three or five servers in a quorum are recommended. A cluster of seven servers is not supported.

One FTL server command line parameter specifies the file name of the configuration file. A second command line parameter selects one named configuration from within that file.

For clarity, specify sections in the order listed in the following table.

Note: Configuration file examples in the documentation are for explanatory purposes. If you copy and paste excerpts from these examples, ensure that the resulting configuration file obeys correct YAML syntax and specifies a valid configuration.
Note: Data directories and files used by FTL server should not be read/write accessible by non-privileged users.

Example Configuration File for FTL Servers

# The "globals" section defines parameters that apply to all FTL servers
# in the cluster.
globals:
 #   The "core.servers" map defines which FTL servers participate in a quorum
  # for managing realm configuration.
core.servers:
    ftlserver1: localhost:8585
    ftlserver2: localhost:8685
    ftlserver3: localhost:8785
# The "servers" section defines parameters that apply to a specific
# FTL server and its services. Include an entry for each core server
# Auxiliary servers are optional.
servers
 # Configuration for ftlserver1.
 ftlserver1:
  # The "ftlserver.properties" element defines parameters that apply
  # to the entire FTL server.
   - ftlserver.properties:
    # Location of the log file.
    logfile: TIBCO_HOME/ftlserver1/logs/ftlserver1.log
# The "realm" element defines parameters that apply to the realm service.
- realm:
   # Location for storing realm configuration data.
  data: TIBCO_HOME/ftlserver1/realm/data
# Define optional services by adding "bridge", "persistence", or "eftl"
# elements.
# Configuration for ftlserver2.
ftlserver2:
 # The "ftlserver.properties" element defines parameters that apply
 # to the entire FTL server.
 - ftlserver.properties:
  # Location of the log file.
  logfile: TIBCO_HOME/ftlserver1/logs/ftlserver2.log
# The "realm" element defines parameters that apply to the realm service.
- realm:
  # Location for storing realm configuration data.
  data: TIBCO_HOME/ftlserver1/realm/data
# Define optional services by adding "bridge", "persistence", or "eftl"
# elements.
# Configuration for ftlserver3
ftlserver3:
 # The "ftlserver.properties" element defines parameters that apply
 # to the entire FTL server.
 - ftlserver.properties:
    # Location of the log file
    logfile: TIBCO_HOME/ftlserver1/logs/ftlserver3.log
# The "realm" element defines parameters that apply to the realm service.
- realm:
   # Location for storing realm configuration data.
   data: TIBCO_HOME/ftlserver1/realm/data
# Define optional services by adding "bridge", "persistence", or "eftl"
# elements.
# Auxiliary FTL servers (additional servers to expand capacity) may be
# optionally defined

Sections in the FTL Server Configuration File

Section Description
globals: Required.

The globals section can contain key/value pairs that directly affect the operation of FTL servers.

servers: Optional.

The servers section contains a map of the FTL servers you are configuring. Each item in the map pairs a server name with a list of services that the server provides. The map must contain an item configuring each core server, and may also include optional items configuring auxiliary servers.

Each FTL server item in this map begins with a unique name. The FTL server command line parameter --name selects one of the server names from this map. The resulting process instantiates an FTL server with that name.

For each server, configure a list of services that that server provides. An FTL server provides a service if and only if the service is configured at this level.

You may omit the servers section if the file specifies only one core server, and specifies its extended server name with host and port.