ltcluster 5.2.1 Documentation

Hundsun LightDB Ltd

Legal Notice


This is the official documentation of ltcluster 5.2.1 for use with LightDB 21.

ltcluster is being continually developed and we strongly recommend using the latest version. Please check the ltcluster website for details about the current ltcluster version as well as the current ltcluster documentation.

ltcluster is fully supported by Hundsun LightDB's 24/7 Production Support. Hundsun LightDB, a Major Sponsor of the LightDB project, continues to develop and maintain ltcluster. Other organisations as well as individual developers are welcome to participate in the efforts.

Table of Contents

I. Getting started
1. ltcluster overview
2. Quick-start guide
II. ltcluster administration manual
3. ltcluster configuration
4. Cloning standbys
5. Promoting a standby server with ltcluster
6. Following a new primary
7. Performing a switchover with ltcluster
8. Event Notifications
III. Using ltclusterd
9. ltclusterd overview
10. Automatic failover with ltclusterd
11. ltclusterd setup and configuration
12. ltclusterd operation
IV. ltcluster command reference
ltcluster primary register — initialise a ltcluster installation and register the primary node
ltcluster primary unregister — unregister an inactive primary node
ltcluster standby clone — clone a LightDB standby node from another LightDB node
ltcluster standby register — add a standby's information to the ltcluster metadata
ltcluster standby unregister — remove a standby's information from the ltcluster metadata
ltcluster standby promote — promote a standby to a primary
ltcluster standby follow — attach a running standby to a new upstream node
ltcluster standby switchover — promote a standby to primary and demote the existing primary to a standby
ltcluster witness register — add a witness node's information to the ltcluster metadata
ltcluster witness unregister — remove a witness node's information to the ltcluster metadata
ltcluster node status — show overview of a node's basic information and replication status
ltcluster node check — performs some health checks on a node from a replication perspective
ltcluster node rejoin — rejoin a dormant (stopped) node to the replication cluster
ltcluster node service — show or execute the system service command to stop/start/restart/reload/promote a node
ltcluster cluster show — display information about each registered node in the replication cluster
ltcluster cluster matrix — runs ltcluster cluster show on each node and summarizes output
ltcluster cluster crosscheck — cross-checks connections between each combination of nodes
ltcluster cluster event — output a formatted list of cluster events
ltcluster cluster cleanup — purge monitoring history
ltcluster service status — display information about the status of ltclusterd on each node in the cluster
ltcluster service pause — Instruct all ltclusterd instances in the replication cluster to pause failover operations
ltcluster service unpause — Instruct all ltclusterd instances in the replication cluster to resume failover operations
ltcluster daemon start — Start the ltclusterd daemon on the local node
ltcluster daemon stop — Stop the ltclusterd daemon on the local node