Altova FlowForce Server 2024 Advanced Edition

Operation in Worker Mode

Home Prev Top Next

Converting FlowForce Server to worker mode means that you allocate its resources exclusively for processing job instances assigned by the master FlowForce Server instance. Once converted to a worker, the FlowForce Server instance can no longer execute any locally configured triggers and jobs, unless it is converted back to standalone mode. The worker status of a FlowForce Server instance is displayed in the web administration interface at all times.


You can convert a FlowForce Server instance to worker mode at any time, from the cluster management page, as illustrated below. When worker mode is no longer required, you can terminate it and convert FlowForce Server back to standalone mode (see Terminate Worker Mode below).



Note the following prerequisites:


The FlowForce Server instance must be installed, licensed, and running. The same requirement applies to a second FlowForce Server instance, the one that will act as the master.

On each machine where you need to take cluster-related actions, your FlowForce user account must have the Maintain cluster privilege (see About Privileges). By default, the root user account has this privilege.

If the worker runs jobs that require a MapForce Server, StyleVision Server, RaptorXML Server, or RaptorXML+XBRL Server license, these tools must be installed and licensed on the worker instance. If the master instance does not run such jobs (assuming that all jobs and queues are configured to redistribute workload to workers), then these tools need not be installed on the master.


Convert a FlowForce Server instance to worker mode

To convert a FlowForce Server instance to worker mode, follow the instructions below:


1.Log on to the FlowForce Server instance that you want to convert to a worker.

2.Access the cluster-management interface, by clicking Administration | Cluster.

3.Click Request to Join Master Instance.

4.Enter the host name and port of the master machine. Ensure that the bind address is configured correctly on the master machine and the port is not blocked by the firewall.

5.Optionally, enter a text message to accompany your join request (in this example, "Hello from worker machine!").


6.Click Send Request to Join Master.

7.Log on to the master FlowForce Server instance and access the cluster-management interface.

8.Find the join request from the worker machine and click Accept Request (screenshot below).


9.Click Show Token next to the request from the worker machine. The secret key required to join this worker to the cluster is displayed (see below).


10.Copy the token to the worker machine.

11.Access the cluster-management interface on the worker machine.

12.Click Complete to Join Master Instance. This action will open a section with several fields (see below).


13.Enter the host name of the master, paste the secret key (token) in the Token text box, and click Complete to Join Master.


On success, a notification message is displayed on the Cluster Management page. The FlowForce Server instance is now in worker mode and can only execute jobs assigned by the master machine.


Terminate worker mode

If you need to convert a worker machine to a standalone FlowForce Server instance, you can do so from the cluster-management interface of the worker machine. Take the steps below:


1.Make sure that your FlowForce user account has the Maintain cluster privilege.

2.On the worker machine, click Administration | Cluster.

3.Click Leave Master Instance.


This converts the FlowForce Server instance to normal operating mode; however, it still remains registered with the master instance until explicitly removed by the master. In this state, you can still generate a secret key for this worker on the master machine in the event that you want to rejoin the cluster. To remove a worker completely from the master machine as well, follow the instructions below.


Remove a worker from the master

On the master machine, any workers that requested to join the master instance in the past are visible at all times on the Cluster Management page. This includes both workers that confirmed their security tokens and those that have not. The latter category includes machines that were converted to standalone (not worker) mode.


Removing a worker without first terminating worker mode leaves the worker in worker mode, and it will not be able to connect to the master any longer. To make connection to master possible again, perform the Leave Master Instance action on the worker machine, as described above.


To remove a worker from the master instance, follow the instructions below:


1.Make sure that your FlowForce user account has the Maintain cluster privilege.

2.On the master machine, click Administration | Cluster. The list of machines is available in the Members section of the Cluster Management page (see below).


3.Select the worker you want to remove and click Remove Worker. A confirmation message appears.

4.Click Confirm and Remove.


© 2018-2024 Altova GmbH