Cluster Nodes lists the servers and printing nodes that make up a multi-node OptimiDoc deployment. From here administrators can see each node's type, address, version, and last activity, promote a server to be the cluster master, and edit or remove nodes.
Screenshot: Cluster Nodes view
Overview
In a cluster deployment, OptimiDoc runs across several machines that share one database and spooler. Two kinds of node take part: Server nodes (which run the full web and service stack) and Printing Nodes (lightweight nodes that handle print delivery, deployed as OptimiDoc Print Nodes / OPN). The Cluster Nodes page is the register of those machines. It is relevant to environments set up with Cluster Configuration; on a single-server installation it simply lists the one local node.
Accessing Cluster Nodes
-
Log in to the OptimiDoc web interface as an administrator.
-
Navigate to Diagnostics > Cluster Nodes in the left sidebar.
Node Information
Each node is listed with the following details:
|
Field |
Description |
|---|---|
|
Hostname |
The node's host name. A connectivity icon indicates whether the node is marked active (a Wi-Fi icon) or inactive (a crossed-out Wi-Fi icon). |
|
IP Address |
The node's IP address, used for inter-node communication. |
|
Type |
Server or Printing Node. The current cluster master carries a crown badge, and the node you are connected to is marked Current. |
|
Version |
The OptimiDoc software version running on the node. All nodes should run the same version. |
|
Last Activity |
The timestamp of the node's most recent recorded activity. |
This page is a management register, not a live performance monitor. It does not display per-node CPU, memory, or job counts. For live resource figures see the admin system panel on the Dashboard (current node), and use System Logs for detailed health and error information on each node.
Node Actions
Use the search box to filter by hostname or IP. Each node offers the following actions:
Edit
Update a node's hostname and IP address, and toggle whether the node is active. Hostnames must be unique within the cluster.
Set as Master
Promote a node to be the cluster master. Only Server nodes are eligible — the action is rejected for printing nodes. Promoting a node clears the master flag from the previous master and notifies the other nodes of the change, so there is always exactly one master.
Delete
Remove a node from the cluster register. The current node cannot be deleted. You can also select several nodes with the checkboxes and remove them together; the current node is skipped from a bulk delete.
Adding a New Node
A new server or printing node is deployed against the shared database and then appears in this list. When encryption is enabled, a fresh node starts without the master encryption key, so it cannot yet decrypt stored secrets or log an administrator in locally. To resolve this, the new node bootstraps the key from the master: over the cluster's IP-whitelisted internal channel, the master authenticates the request on the new node's behalf and releases the encryption key, which the node then stores under its own protected storage. After that the node operates like any other. This exchange only happens between machines that are on the cluster's trusted address list.
Tips
-
Check this page after deploying a new node to confirm it has registered and is showing recent activity.
-
Keep every node on the same OptimiDoc version; mixed versions are not supported. Complete an upgrade across all nodes before resuming normal operation.
-
Promote a healthy Server node with Set as Master before taking the current master offline for maintenance.
-
For failover behaviour and the architecture behind clustering, see Failover Architecture.
Related articles