HA Shared Configuration
This chapter explains the parameters that can be configured for FioranoMQ Servers running in Shared High Availability mode. These are the various parameters that are configured under the FioranoMQàFioranoàHAà* tree node in Shared HA Profiles in Offline configuration using Studio.
For more information on High Availability, refer to the FioranoMQ High Availability Guide
Primary Server Configuration
FioranoHAKRPCProvider
Presented below are the details for the parameters in Fiorano->HA->HAKRPCProvider->FioranoHAKRPCProvider->config
BackupHAPort
The BackupHAPort parameter specifies the port of the backup peer Server on which the peer is listenens for status requests sent by the Server.
Valid values:
The default value of the BackupHAPort parameter is 3000.
Note: It is mandatory to have the BackupHAPort parameter to run HA.
BackupHAIPAddress
The BackupHAIPAddress parameter specifies the IP address of the backup peer Server on which the peer listens for status requests sent by the Server.
Valid values:
The default value of the BackupHAIPAddress parameter is localhost.
Note: It is mandatory to have the BackupHAIPAddress parameter to run HA.
SocketTimeout
The SocketTimeOut parameter indicates the time in milliseconds before the socket created for communication with the peer Server times out occurs.
Valid values:
The default value for the SocketTimeOut parameter is 30000.
The range of integer values considered valid by the SocketTimeout are -2^31 to 2^31 -1
All values less than zero retrieve the same result.
SocketCreationTimeout
The SocketCreationTimeout indicates the time in milliseconds within which socket must connect with the peer Server failing which the socket creation attempt fails.
Valid values:
The default value for the SocketCreationTimeout is 30000.
The range of integer values considered valid by the SocketCreationTimeout are -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
FioranoHAConnectionManager
Presented below are the details for the parameters in Fiorano->HA->HAConnectionManager->FioranoHAConnectionManager->config
Port
The Port parameter specifies the port on which the HA Manager listens on for connections from the peer HA Server. i This parameter listens for a connection from HA Peer Server in order to know the status of its peer.
Valid values:
The default value of the Port parameter is 2000.
The range of integer values considered valid by the Port parameter in java are -2^31 to 2^31 -1.
Note: The port may not be used by other services when being used to listen to Peer servers.
NagleAlgo
The NagleAlgo parameter is a boolean value that determines whether Nagle's Algorithm is enabled during socket creation with peer HA Server. Nagle's algorithm is used in TCP/IP networks for congestion control. It works by coalescing a number of small outgoing messages and sending them together, all at once. If there is a sent packet for which the sender has received no acknowledgment, the sender should keep buffering its output until it has a full packet worth of output, so as to send the entire output in one go.
Valid values:
The default value for the NagleAlgo parameter is no.
- yes – Indicates that the NagleAlgo is enabled.
- no – Indicates that the NagleAlgo is not enabled.
Example:
The Nagle algorithm should not be enabled in situations involving Delayed ACK as that will cause TCP performance problems.
SocketInitializationTimeout
The SocketInitializationTimeout parameter indicates the time in milliseconds within which a client socket should identify itself and exchange its version number with the Server. The version number exchange is an authentication mechanism that FioranoMQ employs.
Valid values:
The default value for the SocketInitializationTimeout parameter is 60000 (which is equal to one minute).
The range of integer values considered valid by the SocketInitializationTimeout parameter in java are -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
FioranoHAStateStubManager
Presented below are the details for the parameters in Fiorano->HA->HAConnectionManager->HAServiceManager->HAStateStubManager->FioranoHAStateStubManager->config
MinServiceID
The MinServiceID parameter defines a serviceID in FioranoMQ. Each request is associated with a subsystem. A range of serviceIDs associated with a subsystem determine the operations accessible to the subsystem. The MinServiceID defines the minimum value of the range that exists for the serviceIDs.
Valid values:
The default value for the MinServiceID parameter is null. If the value is specified as null, there is no range defined for serviceIDs.
The range of integer values considered valid by the MinServiceID parameter in java are -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
MaxServiceID
The MaxServiceID parameter defines a serviceID in FioranoMQ. Each request is associated with a subsystem. A range of serviceIDs associated with a subsystem determine the operations accessible to the subsystem. The MaxServiceID defines the maximum value of the range that exists for the serviceIDs.
Valid values:
The default value for the MaxServiceID parameter is null. If the value is specified as null, there is no range defined for serviceIDs.
The range of integer values considered valid by the MaxServiceID parameter in java are -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
FioranoHAManager
Presented below are the details for the parameters in Fiorano->HA->HAManager->FioranoHAManager->config
Primary
The Primary parameter is a boolean parameter that indicates whether the acting Server acts as the primary HA Server when in the Replication HA mode. In FioranoMQ's HA implementation, one of the two HA Servers is the primary server while the other is the secondary Server. For more information about FioranoMQ's HA implementation please refer to FioranoMQ Concepts Guide Chapter 16 or FioranoMQ High Availability Guide.
Valid values:
The default value of the Primary parameter is yes.
- yes - Indicates that the Server is the primary server.
- no - Indicates that the Server is the secondary server.
GatewayListenerNotUpMesg
In FioranoMQ's HA implementation a gateway machine is used to detect the HA Server that is no longer available on the network. It becomes imperative to choose a gateway machine that is least expected to be out of the network. It makes sense to use the actual gateway Server of the network where the enterprise Server is deployed as the Gateway machine for HA.
The GatewayListenerNotUpMesg parameter helps identify the message that will be displayed when the acting Server finds that no listener is present on the port configured.
Valid values:
The default value for the GatewayListenerNotUpMesg parameter is Connection refused.
Any String may be used as a valid value for this parameter.
GatewayServerPort
In FioranoMQ's HA implementation a gateway machine is used to detect the HA Server that is no longer available on the network. It becomes imperative to choose a gateway machine that is least expected to be out of the network. It makes sense to use the actual gateway Server of the network where the enterprise Server is deployed as the Gateway machine for HA.
The GatewayServerPort parameter helps specify the port on which the Gateway machine listenens for incoming requests.
Valid values:
The default value GatewayServerPort parameter is 7.
The range of integer values considered valid by the GatewayServerPort are -2^31 to 2^31 -1.
Note: The port should not be in use..
PingInterval
The acting HA Server pings its peer Server intermittently to exchange status information. PingInterval is the time interval in milliseconds after which the remote Server is pinged in Replication HA mode.
Valid values:
The default value for the PingInterval parameter is 30000.
The range of integer values considered valid by the PingInterval are -2^31 to 2^31 -1.All values less than zero retrieve the same result.
SocketCreationTimeout
The SocketCreationTimeout indicates the time in milliseconds within which socket must connect with the peer Server failing which the socket creation attempt fails.
Valid values:
The default value for the SocketCreationTimeout is 10000.
The range of integer values considered valid by the SocketCreationTimeout are -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
ServerName
The ServerName parameter specifies the name of the Server running in the Replication HA mode.
Valid values:
The default value for the ServerName is FMQServer
Any String may be used as a valid value for this parameter.
Example:
Naming the server in the most relevant way that explains its purpose makes distinguishing it from other servers easier.
GatewayServerIPAddress
In FioranoMQ's HA implementation a gateway machine is used to detect the HA Server which is no longer available on the network. It makes sense to use the actual gateway Server of the network in which the enterprise Server is deployed as the Gateway machine for HA.
The GatewayServerIPAddress parameter helps specify the IP address on which the Gateway machine listens for incoming requests.
Valid values:
The default value for the GatewayServerIPAddress parameter is localhost.
Example:
Choose a machine thath is least expected to be out of the network to ensure that it is most likely to performs its function as a Gateway machine.
FioranoFMQKernel
Presented below are the details for the parameters in Fiorano->HA->FMQKernel->FioranoFMQKernel->config
MQUnDeploymentLists
While in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connections to the Server when it is in the Passive mode are refused. If a peer Server goes dead the acting Server goes into the Standalone state. In order to not accept any client connections while in the Passive state, a few components of the Server need to be undeployed.
These components are listed in FioranoMQ specified files. The MQUnDeploymentLists parameter helps specify lists of files (separated by commas) containing Fiorano specific components that are to be undeployed when necessary.
Valid values:
The default value for the MQUnDeploymentLists parameter is kernel.lst,DefaultMQObjects.lst.
A comma separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in that directory.
ExternalUnDeploymentLists
When in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connection to the Server when it is in the Passive mode are refused. If a peer Server goes dead the Server goes into the Standalone state. In order to not accept any client connections while in passive state, a few components of the Server need to be undeployed. When the Server is in the Active state these components need to be undeployed.
The components that need to be undeployed are listed in FioranoMQ specified files. The ExternalUnDeploymentLists parameter helps specify lists of files (separated by commas) containing external components that are to be undeployed when necessary.
Valid values:
The default value for the ExternalUnDeploymentLists parameter is null.
A comma separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in the directory.
MQDeploymentLists
When in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connections to the Server when it is in the Passive mode are refused. If a peer Server goes dead then the acting Server goes into the Standalone state. In order to not accept any client connections while in passive state, a few components of the Server need to be undeployed. These components are redeployed when the Server starts accepting connections.
The components that need to be redeployed are listed in FioranoMQ specified files. The MQDeploymentLists parameter helps specify lists of files (separated by commas) containing Fiorano specific components that are to be redeployed when necessary.
Valid values
The default value MQDeploymentLists parameter is kernel.lst,DefaultMQObjects.lst
A comma separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in that directory.
ExternalDeploymentLists
When in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connections to the Server when it is in the Passive mode are refused. In case a peer Server goes dead the acting Server goes into the Standalone state. In order to not accept any client connections while in the Passive state, a few components of the Server need to be undeployed. There may be external components that need to be redeployed when the Server goes back to the Active state.
The components to be undeployed are listed in Fiorano files. The ExternalDeploymentLists parameter helps specify lists of files (separated by commas) containing external components that are to be redeployed when necessary.
Valid values:
The default value for the ExternalDeploymentLists parameter is null.
A comma separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in the directory.
Secondary Server Configuration
FioranoHAKRPCProvider
Presented below are the details for the parameters in Fiorano->HA->HAKRPCProvider->FioranoHAKRPCProvider->config
BackupHAPort
The BackupHAPort parameter specifies the port of the backup peer Server on which the peer is listenens for status requests sent by the Server.
Valid values:
The default value of the BackupHAPort parameter is 2000.
Note: It is mandatory to have the BackupHAPort parameter to run HA.
BackupHAIPAddress
The BackupHAIPAddress parameter specifies the IP address of the backup peer Server on which the peer listens for status requests sent by the Server.
Valid values:
The default value of the BackupHAIPAddress parameter is localhost.
Note: It is mandatory to have the BackupHAIPAddress parameter to run HA.
SocketTimeout
The SocketTimeOut parameter indicates the time in milliseconds before the socket created for communication with the peer Server times out occurs.
Valid values:
The default value for the SocketTimeOut parameter is 30000.
The range of integer values considered valid by the SocketTimeout are -2^31 to 2^31 -1
All values less than zero retrieve the same result.
SocketCreationTimeout
The SocketCreationTimeout indicates the time in milliseconds within which socket must connect with the peer Server failing which the socket creation attempt fails.
Valid values:
The default value for the SocketCreationTimeout is 30000.
The range of integer values considered valid by the SocketCreationTimeout are -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
FioranoHAConnectionManager
Presented below are the details for the parameters in Fiorano->HA->HAConnectionManager->FioranoHAConnectionManager->config
Port
The Port parameter specifies the port on which the HA Manager listens on for connections from the peer HA Server. This parameter listens for a connection from HA Peer Server in order to know the status of its peer.
Valid values:
The default value of the Port parameter is 3000.
The range of integer values considered valid by the Port parameter in java are -2^31 to 2^31 -1.
Note: The port may not be used by other services when being used to listen to Peer servers.
NagleAlgo
The NagleAlgo parameter is a doolean value that determines whether Nagle's Algorithm is enabled during socket creation with peer HA Server. Nagle's algorithm is used in TCP/IP networks for congestion control. It works by coalescing a number of small outgoing messages and sending them together, all at once. If there is a sent packet for which the sender has received no acknowledgment, the sender should keep buffering its output until it has a full packet worth of output, so as to send the entire output in one go.
Valid values:
The default value for the NagleAlgo parameter is no.
- yes – Indicates that the NagleAlgo is enabled.
- no – Indicates that the NagleAlgo is not enabled.
Example:
The Nagle algorithm should not be enabled in situations involving Delayed ACK as that will cause TCP performance problems.
SocketInitializationTimeout
The SocketInitializationTimeout parameter indicates the time in milliseconds within which a client socket should identify itself and exchange its version number with the Server. The version number exchange is an authentication mechanism that FioranoMQ employs.
Valid values:
The default value for the SocketInitializationTimeout parameter is 60000 (which is equal to one minute).
The range of integer values considered valid by the SocketInitializationTimeout parameter in java are -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
FioranoHAManager
Presented below are the details for the parameters in Fiorano->HA->HAManager->FioranoHAManager->config
Primary
The Primary parameter is a boolean parameter that indicates whether the acting Server acts as the primary HA Server when in the Replication HA mode. In FioranoMQ's HA implementation, one of the two HA Servers is the primary server while the other is the secondary Server. For more information about FioranoMQ's HA implementation, please refer to FioranoMQ Concepts Guide Chapter 16 or FioranoMQ High Availability Guide.
Valid values:
The default value of the Primary parameter is no.
- yes - Indicates that the Server is the primary server.
- no - Indicates that the Server is the secondary server.
GatewayListenerNotUpMesg
In FioranoMQ's HA implementation a gateway machine is used to detect the HA Server which is no longer available on the network. It becomes imperative to choose the gateway machine which itself is least expected to be out of network. It makes sense to use the actual gateway server of the network in which enterprise server is deployed as the Gateway machine for HA.
This parameter helps specify the message which will be displayed when the owning server finds that no listener is present on the configured port but machine is up.
Valid values:
Default value is Connection refused
Any String
GatewayServerPort
In FioranoMQ's HA implementation a gateway machine is used to detect the HA Server which is no longer available on the network. It becomes imperative to choose the gateway machine which itself is least expected to be out of network. It makes sense to use the actual gateway server of the network in which enterprise server is deployed as the Gateway machine for HA.
This parameter helps specify the port on which Gateway machine is listening for incoming requests.
Valid values:
Default value is 7
Legal values: range of integer values in java. (-2^31 to 2^31 -1)
Note: The port must not be anything that is being used already, obviously.
PingInterval
The acting HA Server pings its peer Server intermittently to exchange status information. PingInterval is the time interval in milliseconds after which the remote Server is pinged in Replication HA mode.
Valid values:
The default value for the PingInterval parameter is 30000.
The range of integer values considered valid by the PingInterval are -2^31 to 2^31 -1.All values less than zero retrieve the same result.
SocketCreationTimeout
The SocketCreationTimeout indicates the time in milliseconds within which socket must connect with the peer Server failing which the socket creation attempt fails.
Valid values:
The default value for the SocketCreationTimeout is 10000.
The range of integer values considered valid by the SocketCreationTimeout are -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
ServerName
The ServerName parameter specifies the name of the Server running in the Replication HA mode.
Valid values:
The default value for the ServerName is FMQServer
Any String may be used as a valid value for this parameter.
Example:
Naming the server in the most relevant way that explains its purpose makes distinguishing it from other servers easier.
GatewayServerIPAddress
In FioranoMQ's HA implementation a gateway machine is used to detect the HA Server which is no longer available on the network. It makes sense to use the actual gateway Server of the network in which the enterprise Server is deployed as the Gateway machine for HA.
The GatewayServerIPAddress parameter helps specify the IP address on which the Gateway machine listens for incoming requests.
Valid values:
The default value for the GatewayServerIPAddress parameter is localhost.
Example:
Choose a machine that is least expected to be out of the network to ensure that it is most likely to performs its function as a Gateway machine.
In FioranoMQ's HA implementation a gateway machine is used to detect the HA Server which is no longer available on the network. It makes sense to use the actual gateway Server of the network in which the enterprise Server is deployed as the Gateway machine for HA.
The GatewayServerIPAddress parameter helps specify the IP address on which the Gateway machine listens for incoming requests.
Valid values:
The default value for the GatewayServerIPAddress parameter is localhost.
Example:
Choose a machine thath is least expected to be out of the network to ensure that it is most likely to performs its function as a Gateway machine.
FioranoFMQKernel
Presented below are the details for the parameters in Fiorano->HA->FMQKernel->FioranoFMQKernel->config
MQUnDeploymentLists
While in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connections to the Server when it is in the Passive mode are refused. If a peer Server goes dead the acting Server goes into the Standalone state. In order to not accept any client connections while in the Passive state, a few components of the Server need to be undeployed.
These components are listed in FioranoMQ specified files. The MQUnDeploymentLists parameter helps specify lists of files (separated by commas) containing Fiorano specific components that are to be undeployed when necessary.
Valid values:
The default value for the MQUnDeploymentLists parameter is kernel.lst,DefaultMQObjects.lst.
A comma separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in that directory.
ExternalUnDeploymentLists
When in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connection to the Server when it is in the Passive mode are refused. If a peer Server goes dead the Server goes into the Standalone state. In order to not accept any client connections while in passive state, a few components of the Server need to be undeployed. When the Server is in the Active state these components need to be undeployed.
The components that need to be undeployed are listed in FioranoMQ specified files. The ExternalUnDeploymentLists parameter helps specify lists of files (separated by commas) containing external components that are to be undeployed when necessary.
Valid values:
The default value for the ExternalUnDeploymentLists parameter is null.
A comma separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in that directory.
MQDeploymentLists
When in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connections to the Server when it is in the Passive mode are refused. If a peer Server goes dead then the acting Server goes into the Standalone state. In order to not accept any client connections while in passive state, a few components of the Server need to be undeployed. These components are redeployed when the Server starts accepting connections.
The components that need to be redeployed are listed in FioranoMQ specified files. The MQDeploymentLists parameter helps specify lists of files (separated by commas) containing Fiorano specific components that are to be redeployed when necessary.
Valid values
The default value MQDeploymentLists parameter is kernel.lst,DefaultMQObjects.lst
A comma separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in that directory.
ExternalDeploymentLists
When in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connections to the Server when it is in the Passive mode are refused. In case a peer Server goes dead the acting Server goes into the Standalone state. In order to not accept any client connections while in the Passive state, a few components of the Server need to be undeployed. There may be external components that need to be redeployed when the Server goes back to the Active state.
The components to be undeployed are listed in Fiorano files. The ExternalDeploymentLists parameter helps specify lists of files (separated by commas) containing external components that are to be redeployed when necessary.
Valid values:
The default value for the ExternalDeploymentLists parameter is null.
A comma separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in the directory.