Managing workers

To manage worker nodes in i2 TextChart Server, you use the Workers page of the manager's user interface:


The manager's Workers page

Registering a worker

All worker nodes have a configured manager, and they attempt to register with that manager when they start. Worker nodes that are not formally registered with the manager appear in the Unregistered Workers section of the page.

To register a worker node, select the drop-down next to it in the Unregistered Workers section, and select Register option. The worker is moved to the Registered Workers list and will soon enter the registered state. It can take up to 30 seconds for registration to complete.

Removing a worker

To remove a registered worker node from the system, select Remove Worker from the drop-down in the row that contains the worker in the Registered Workers table. The worker is moved to the Unregistered Workers list, and it will no longer process documents.

Assign a worker to a cluster

To assign a worker node to a cluster, click the drop-down menu in the Cluster column in the Registered Workers table. Select the desired cluster.

If the worker is already assigned to a cluster, then click the left-most drop-down in the corresponding row of the Registered Workers table, and select Unassign Worker. The worker is removed from the cluster, and you can assign it to a different cluster.

Enable or disable a worker

By default, when you register a worker node with the manager, it connects to the manager and completes all necessary configuration, but stays in the configured state.

Note: A disabled worker like this uses a license instance. A worker that you don't plan to use for processing should be removed from the system entirely.

To move a worker from (or back to) the configured state, click the drop-down in the row that corresponds to the worker in the Registered Workers table. Select Enable/Disable option to change its state.

When a worker node is enabled, it will start the Rosoka Series 7 engine and be ready to process documents.

Worker states

A worker can be in one of the following states:

State

Description

off

The worker is registered with the manager, but it is not currently connected. This is typically the case for a worker node that has been shut down, or where the worker process is not running.

awaiting registration

The worker is registered, and the manager is waiting for the worker node to contact it to complete the connection process.

registered

The worker is connected to the manager but has no assigned cluster.

configuring

The worker is downloading configuration assets corresponding to the selected cluster.

configured

The worker is fully configured with the current cluster configuration.

starting

The worker is starting the i2 TextChart Server engine.

ready

The worker is ready to process documents.

stopping

The worker is shutting down the i2 TextChart Server engine.

error

A configuration error has occurred. Typically, errors are caused by incorrect settings in an output connector (for example, specifying an unreachable host for the Elasticsearch connector). Correct the error by configuring the cluster and changing the problematic settings. Upon saving the cluster changes, the assigned worker nodes will automatically reconfigure.