Linux Server Pools

Generic Linux Server Pools provide monitoring and management for a wide range of Linux infrastructure. They support OpenLiteSpeed, MariaDB, Galera Cluster, and other Linux-based services running on Ubuntu, Debian, Rocky Linux, AlmaLinux, CentOS, Red Hat Enterprise Linux (RHEL), and compatible distributions.

Part 1 - Overview & Concepts

What ServersCTL hosting pools are

ServersCTL (serversctl.com) is the control plane for redundant server infrastructure: enrol Linux VMs with the ServersCTL agent, monitor heartbeats, cut over DNS between peers, run stack backups, and (on the cPanel preset) orchestrate account replication and live WHM transfers.

server pool is one deployment in your dashboard — a set of members sharing failover DNS and pool-level settings. Members run what you actually install on each host. The dashboard exposes member tabs for OpenLiteSpeedMariaDB/MySQLGalera, and cPanel/WHM; each tab fills in when the agent detects that stack on that server.

ServersCTL does not host traffic. It moves DNS, queues remote jobs, and calls APIs where configured.

PoolOverviewLinuxGeneric.png

Pool Presets

Server pools are created using a preset template in the UI. This chapter is for the Generic Linux Server Preset. For HAProxy Server Pools, see the HAProxy chapter.


What runs on a member (stack compatibility)

Do not assume one VM runs every stack. Common deployments:

Deployment Typical member stacks Notes
cPanel / WHM hosting
cPanel tab + MariaDB tab (cPanel-managed MySQL)
Apache/httpd via cPanel — not OpenLiteSpeed
OpenLiteSpeed web farm
OpenLiteSpeed tab only
Standalone OLS
MariaDB / Galera nodes
MariaDB tab + Galera readout
DNS swing ≠ Galera quorum
Mixed pool
Different tabs per member
e.g. two cPanel standbys + one OLS edge — each member’s tabs reflect its OS

Core terminology

Term Meaning
Pool
One ServersCTL Pool.
Member
One enrolled server (hostname, egress IP, enrollment secret)
Active member
Host whose IPv4 receives the pool failover A record.
Stack tab
Member workspace: OpenLiteSpeed, MariaDB, cPanel, etc.
Protected account
cPanel account with a replication job.
Agent
balctl_heartbeat.py on each member — heartbeats to serversctl.com

Architecture

Clients → DNS (Cloudflare / WHM) → A record → Active member IPv4
ServersCTL Worker (serversctl.com)
Standby members' ← agent heartbeats (+ WHM replication on cPanel preset)

Failover health: missed heartbeat beyond failover delay (10–120 s). No HAProxy systemd check on hosting presets.

All Linux Servers should use the Generic Server Preset when adding a pool. Only ever select the HAProxy Preset if HAProxy is installed on your server.

Create a Generic Linux pool

CreatePool.png

    • Configuration preset: Generic Linux servers.

CreatePool-1.png

    • Name the Pool.
    • Now, go to the pool. Pool  Overview  Add server. Choose — RHEL/Ubuntu - Enter hostname, allowed egress IP.

CreateEnrollmentKey.png

  1. On the VM: 
    • Paste the install command into the console to install the agent. 
    • If you have existing installs of cPanel, OpenLiteSpeed, MariaDB etc. The agent will report this to the UI. 
    • When 2+ members run cPanel: pool Protection and Managed DNS tabs appear (see Chapter 1).
    • Optional: Configure DNS on Managed DNS for account-level cutover.

Add further members to the Pool

  1. From the pool overview tab click "Add Member".
  2. Name the member and supply the member's egress IP.
  3. Copy the install command into the console of the server being added to the pool.
  4. Repeat the process to add further members. There are no limits to the number of pools or members you may have.

How pool navigation works

Two layers on one screen


The UI is split into two sections. The top tabs manage overall pool settings and the lower tabs manage member settings.

Layer What it controls Examples
Pool tabs
Settings and services that span all members or protected accounts across members
Overview fleet, Protection replication, Managed DNS catalogue, pool Monitoring presets, pool Settings
Member tabs
One enrolled Linux server — host OS, detected stacks, jobs, and backups
Control panel, Security, cPanel, MariaDB, Cron & Jobs

Linux-Server-Pool-O2.png

Protection and Managed DNS are pool settings. They float in the top tab bar above the member server tabs. They coordinate account replicationDNS cutover, and provider keys across the fleet — not operations on a single box.

Pool tab visibility (Generic Linux template)

Pool tab Always? When it appears
Overview
Yes
Default landing
Member tabs (one per server)
When enrolled
Subtitle Member on Generic pools (not Active/Standby)
Protection
No
2+ members with cPanel detected
Managed DNS
No
Same as Protection on Generic pools (2+ cPanel members)
Monitoring
Yes
Pool-wide alert presets
Settings
Yes
Pool name, API providers, delete pool

Tab: Overview (first pool tab).

Purpose: Fleet-wide health — are agents reporting, are backups and jobs healthy across Linux servers?

What you see

Section Content
Fleet Status header
KPI widgets: member count, healthy agents, last check-in, backup count, cron jobs, running jobs, outdated agents
Fleet geography map
Members plotted when geo is set on each member’s Settings tab
Server tiles
One tile per enrolled member — click to open that member’s workspace
Actions
Add serverPool settings

Operator actions

Tab: Protection (pool tab bar).

When visible: 2+ pool members where the agent reports cPanel.

Purpose: Account-level warm standby — scheduled WHM backup → Secure Storage → restore on a standby server, with optional DNS cutover per protected account.

What you see

Section Content
Protection dashboard
KPIs: protected accounts, replication health, last sync
Server cards
Each cPanel-eligible member — readiness, WHM link, geography
Protected accounts
Per-account source → standby mapping, schedule, TTL, DNS provider
Replication log
Sync, DNS cut, transfer, and failure events
Geo map
Primary / standby geography when locations are set

Operator workflow

  1. Ensure 2+ cPanel members and WHM API keys (Settings or Managed DNS → API providers).
  2. Add protection — pick source account, target standby member, schedule (1h … 1mo), DNS TTL, DNS provider (Cloudflare or WHM).
  3. Replicate now / Replicate protected (Pro) — on-demand sync.
  4. Account Cut DNS — per-account A record swing to standby (coordinates with Managed DNS).
  5. After DNS cut: post-failover hook on standby.

Relationship to member tabs

Task Where
Bulk account replication, schedules, protection DNS
Pool Protection
Single-account migrate, live transfer sessions
Member cPanel → Migrate & Recovery
WHM account CRUD, suspend, AutoSSL
Member cPanel → Accounts

Protection is pool-wide orchestration; member cPanel is per-server WHM operations.

Replication Transfer

Replication can take anywhere from a few minutes to several hours, depending on the size of the account.

ReplicationTopologySync.png

The source agent will package the account and split it into multiple chunks, which are securely stored temporarily in D2 storage. Once all chunks have been uploaded, the UI instructs the receiving agent to download them and begin the restore process.

After the restore has completed successfully, all stored chunks are automatically removed from S3. As a guide, a 1.8GB backup typically takes around 5 minutes to replicate. Please take replication time into account when configuring your schedule. If the account is large, you may need to replicate once per day or every few days to avoid overlap and ensure the process completes cleanly.

ReplicationTopology.png

Tab: Managed DNS (pool tab bar).

When visible (Generic Linux): 2+ cPanel-detected members

Purpose: Pool-level DNS catalogue for protected accounts and optional dynamic DNS — WHM vs Cloudflare zones, record health, sync, import. The API keys listed here are for DNS only. Do not use your production WHM API key here. You must use Cloudflare or a cPanel DNS Cluster API Key.

What you see

Section Content
DNS Health
Zone summary, provider linkage, drift, topology banner (DNS Provider → Primary → Standby) when Protection is active
Protected account records
Per-FQDN proxied/DNS-only, enabled, active IP, cut actions
API providers
Cloudflare account keys (one Global), per-member WHM keys
Dynamic DNS card
Failover hostname and sync toggle (Generic pools — primary place for DNS failover config)
Actions
Refresh DNS, Sync WHM→CF, Add record, Import from Cloudflare

Operator actions

Protected DNS

The UI treats WHM servers as the source of truth and replicates changes to any linked DNS provider, as long as the account is marked as Managed. By default, the only record that will cut over automatically is the domain’s A record.

Multiple DNS Record Cut Over

You can configure the UI to cut over additional DNS records from the Protected Account DNS list. From here, you can specify A, AAAA, MX, and SRV records that should automatically cut to a standby server when the primary becomes unavailable.

Actions

The three‑dot menu under the Action column provides additional fine‑tuning options:

ManagedDNSActions.png

Pool vs member DNS

Scope Tab
Protected accounts, zone catalogue, provider keys, and failover FQDN
Pool Managed DNS
Per-member WHM key rotation
Pool Settings or Managed DNS API panel
Host TLS / Let’s Encrypt on a single VM
Member Control Panel or Recipes

Tab: Monitoring (pool tab bar).

Purpose: Pool-wide monitoring presets — distinct from per-member alerts on each server’s Monitoring tab.

Generic pool without Protection (0–1 cPanel members)

Infrastructure alerts section:

Generic pool with Protection (2+ cPanel members)

Protection DNS failover section (in addition to or instead of infrastructure, depending on layout):

Preset Meaning
Failover banner
How long pool header shows Failover active after DNS cut (Community: 2 h max)
Failover email
Notify when DNS moves to standby
Failover alert recipients
Team inboxes for protection cutover

Operator note

Configure per-member heartbeat and resource alerts on each server’s member Monitoring tab. Pool Monitoring is for fleet-level and protection DNS behavior.

Tab: Settings (pool tab bar).

Purpose: Pool identity, shared API credentials, danger zone.

What you see (Generic Linux)

Card Content
Pool name
Rename the pool
API providers
Cloudflare account keys (mark one Global). Each cPanel server needs its own WHM key (pool-level + per-member rows)
Danger zone
Delete pool
What is NOT on the Generic pool Settings
Feature Where instead
Balancer failover (auto-failover delay, make-active hostname)
Managed DNS (when tab visible) or optional — Generic pools work without DNS
Protection jobs
Protection tab
DNS record catalog
Managed DNS tab

HAProxy pools include Balancer failover on Settings.

Part 2 - Member workspace (per-server tabs)

Member tab bar (Generic Linux Server Pool)

Tab Always in nav? Active when
Control panel
Yes
Always
Security
Yes
Always
OpenLiteSpeed
Yes (Generic)
Content when OpenLiteSpeed detected; else frosted not detected overlay
MariaDB
Yes (Generic)
Content when MariaDB/MySQL detected or cPanel-managed MySQL
cPanel
Yes (Generic)
Content when cPanel detected else frosted overlay
Status
Yes
Always — host/agent health summary
Cron & Jobs
Yes
Always
Restore Backups
Yes
Always
Recipes
Yes
Always
Monitoring
Yes
Always
Settings
Yes
Always

Member Control Panel

Purpose: Host-level operations on this Server — OS family, uptime, services, quick actions, TLS.

What you see

Section Content
Health strip
Agent version, heartbeat age, firewall summary
Console
Open a secure SSH session to the member
KPI row
CPU, memory, disk, load
Quick actions
Reboot, shutdown, install updates, backup (stack-aware), Let’s Encrypt (when applicable)
Services
Running units relevant to detected stacks
SSL / TLS
Certificate expiry, sync domain from DNS
Recent activity
Latest completed jobs

Member Security

Tab: Security.

Purpose: Host firewall and SSH on this member.

What you see

Section Content
Firewall KPIs
Enabled/disabled, rule count, last sync
Action tiles
Enable/disable firewall, add rule, manage rules, backup UFW config
SSH access
Key-based access helpers

Member OpenLiteSpeed

Tab: OpenLiteSpeed.
Sub Tabs: Overview, Recovery Wizard

For: VMs where OpenLiteSpeed is the web server — standalone OLS hosts.

Not for: Default cPanel/Apache hosting — expect a not-detected overlay on cPanel servers.

Overview

Web admin (:7080 link), KPIs, virtual hosts table, reload/restart/config test/backup/upgrade/LSPHP, logs.

OpenLitespeed-Overview.png

Recovery Wizard

Also known as Cross‑Member Restore, this feature allows you to automatically take a full backup of an OpenLiteSpeed account, including SSL certificates and the database*. The backup is stored within your Pool API Storage, and the Recovery Wizard allows you to restore that backup to a different OpenLiteSpeed server.

If you have a DNS API Key scoped for the domain, DNS records can be updated automatically during the recovery process. Simply select the appropriate API Key when using the Recovery Wizard.

* Database restoration requires that no additional MySQL/MariaDB password is set when accessing mysql from the command line. If an additional password has been configured, the automated restore process cannot proceed, and the database will need to be restored manually.

Recipes & backups

Install OpenLiteSpeedHarden OpenLiteSpeed on Recipes. Restore on Restore Backups (backup_openlitespeed, Pro).

Member MariaDB

Tab: MariaDB.
Subtabs: Overview, Databases

For: Dedicated DB servers or cPanel-managed MySQL on WHM hosts.

Standalone database server

Overview

Health, KPIs, schema cards, restart, config test, flush privileges, logical backup, harden, logs.

MariaDB-MySQL-Overview.png

Databases

The Databases tab lists all databases discovered on the OpenLiteSpeed server. Databases are detected by scanning for common configuration files such as wp-config.php and parsing their contents.

Databases can be backed up individually or via cron. For a full account backup, use the Recovery Wizard.

MariaDB-MySQL-Databases.png

cPanel-managed MySQL

If cPanel is on the same host: MariaDB tab shows a cPanel host notice — use member cPanel (§11) for account-level DB ops.

MariaDB-MySQL-cPanel.png

Galera (wsrep) (In Alpha)

When Galera is enabled, the agent will report the wsrep state. ServersCTL does not run quorum, SST, or writer election. DNS is active ≠ Galera primary.

Recipes & backups

Install MariaDB/MySQLHarden the database. Restore Backups. Advanced recipes require Pro.

Member-Recepies.png

Member cPanel

Tab: cPanel.

For: WHM servers — the most common ServersCTL hosting workload.

Inner tabs: Overview · Operations · Accounts · Migrate & Recovery

Overview (inner)

DNS banner, protection topology (when account is protected), service badges, WHM audit summary.

Operations (inner)

Restart web/mail/cPanel, config check, WHM backup, harden, WHM API status, listeners, disk, metrics.

Accounts (inner) (Pro)

CRUD, suspend, terminate, backups, AutoSSL, one-time login. Free: read-only, 5 accounts cap.

Live Migrate & Recovery (inner) (Pro)

Live transfer, sessions, push copy. Bulk replication and schedules: pool Protection (§3), not this inner tab alone.

WHM Binding

Full WHM API when member matches pool host. Run WHM link check recipe after DNS connect.

Member Status

Tab: Status.

Purpose: Read-only health and readiness snapshot for this member.

Generic Linux member

Section Content
OS / agent
OS family, agent version (outdated warning), generic probe template
Live stats
CPU, memory, disk from last heartbeat
Updates
Pending package updates
Firewall
Summary from heartbeat

Member Cron & Jobs

Tab: Cron & Jobs.

Purpose: Scheduled tasks on this member and visibility into recent job activity.

What you see

Section Content
KPI row
Cron count, backup schedules, last run
Schedules
Enable/disable, edit schedule (UTC), add from presets
Recent jobs
Timeline of agent and worker jobs

Common presets

Stack backups (backup.cpanelbackup.database, etc.), failover.evaluate where applicable.

Member Restore Backups

We are developing off-site backups. We currently only backup configuration unless stated in the UI. Contact us if you have questions.

Tab: Restore Backups.

Purpose: Snapshot catalog for this member — run backup, restore, delete.

Modes

Tab adapts to detected stack: cpanelopenlitespeeddatabase, or mixed.

Section Content
KPI row
Snapshot count, total size, last backup
Calendar
Backup history
Snapshot cards
Restore or delete individual snapshots

Pro required for restore actions on stack backups. 

Member Recipes

In development - Only ever use recipes on clean servers. 

Tab: Recipes.

Purpose: Guided install and harden flows — one-click enqueue of multi-step agent jobs.

Examples by stack

Recipe Stack
Install cPanel / harden
cPanel
Install OpenLiteSpeed / harden
OLS
Install MariaDB / harden
MariaDB
Galera cluster (read-only)
MariaDB + wsrep
SSH hardening, agent update
Host
WHM link check
cPanel + DNS
Let’s Encrypt (host or HAProxy)
Host / edge

Member Monitoring

Tab: Monitoring

Purpose: Per-member alert settings.

What you configure

Setting Meaning
Heartbeat miss alerts
Email when agent stops checking in
CPU / disk / service thresholds
Resource alerts for this server
Alert recipients
Account email + optional team inboxes
Recovery notifications
Notify when member recovers

Member Settings

Tab: Settings (member tab bar).

Purpose: Identity and location for this enrolled server.

What you see

Section Content
Display name / hostname
Must match agent JSON; BALCTL_HOSTNAME to override
Allowed source IPs
Member egress IPv4 allowed to call serversctl.com
Server location
Geo for pool Overview map and Protection geo map
Monitor settings
Member-level alert toggles (overlaps with Monitoring tab)
Remove member
Detach server from pool

WHM API keys for cPanel: prefer pool Settings / Managed DNS API providers; per-member WHM edit is available there.