Orchestrator

Changing an orchestrator's configuration

To change the configuration of an orchestrator, edit conf/orchestrator/platform.properties and tune these parameters.

Global

Parameter Description

com.axway.platform.name

If you want more than one instance of orchestrator installed as services on the same environment, you should edit this property.

Its value will be used as the service name. (Default name is DecisionInsightMessagingSystemOrchestrator)

Storage

Data are stored in the {working directory}/data/orchestrator. The {working directory} can be changed in the conf/path.conf.

Connectivity

Parameter Description
clientPort The port at which to listen for and receive incoming client connections.
maxClientCnxns Limits the number of concurrent connections (at the socket level) that a single client, identified by IP address, may make to this orchestrator. This is used to prevent certain classes of DoS attacks, including file descriptor exhaustion. Setting this to 0 or omitting it entirely removes the limit on concurrent connections.

The default configuration is:

# the port at which the clients will connect
clientPort=2181
# disable the per-ip limit on the number of connections since this is a non-production config
maxClientCnxns=0

Cluster

For high availability, orchestrators can be configured in a cluster. To create an orchestrator cluster, specify:

  • connection strings to other orchestrators
  • the current orchestrator's unique identifier

Cluster connection description

In  conf/orchestrator/platform.properties, all orchestrators' connection strings must be declared. Format is:

server.<uniqueId>=<host>:<inter communication port>:<leader elections port>
  • uniqueId: unique orchestrator identifier. Must be unique in the orchestrator cluster and fall in the range of 1 to 255.
  • host: orchestrator host.
  • inter communication port: used by orchestators to communicate/replicate data. The default value is 2888.
  • leader elections port: in the cluster, only one leader is elected. This port is used for the purpose of the election. The default value is 3888.

Example of configuration:

// current orchestrator with unique id '2'
server.2=0.0.0.0:2888:3888
// existing orchestator with unique id '1'
server.1=my.server2.com:2888:3888

Unique identifier 

The unique identifier must be set when the orchestrator starts. To this end, a specific file is used, located in var/data/orchestrator/myid.

This file should only contain the unique identifier value, which must be the same value set for this orchestrator in the file  conf/orchestrator/platform.properties

example of 'myid' file content, according to previous platform.properties configuration
2

Logs

The default configuration of a DIMS node is to log all of its activity

  • <installation directory>/var/logs/orchestrator/node.log: global log (network, registration and leader election)

You can change the log settings by editing the <installation directory>/conf/orchestrator/log4j2.properties file, and your changes will take effect the next time you start the node and for all subsequent runs.

Edit log4j2.properties file

Please refer to the official Log4j documentation to configure this file: Apache Log4J manual (external).

Related Links