platform-doc

PGEDGE NODECTL CLUSTER CONTROLLER

Installation and configuration of a pgEdge SPOCK cluster

Synopsis

./nodectl cluster <command> [parameters] [options]   

local-create - Create a localhost test cluster of N pgEdge nodes on different ports.
local-destroy - Stop and then nuke a localhost cluster.
remote-init - Configure a test SSH cluster from a JSON cluster definition file.
remote-reset - Reset a test SSH cluster.
remote-import-def - Import a cluster definition file so we can work with it like a pgEdge cluster.
command - Run nodectl command on one or all nodes of a cluster.
app-install - Install an application such as NorthWind or pgBench.
app-remove - Remove an application.

Options

--json             # Turn on JSON output
--debug            # Turn on debug logging
--silent           # Less noisy
--verbose or -v    # More noisy

Example cluster.json file

{
  "cluster": "cl1",
  "create_dt": "2023-06-08",
  "db_name": "lcdb",
  "db_user": "lcdb",
  "db_init_passwd": "lcpasswd",
  "os_user": "pgedge",
  "ssh_key": "~/key/abc123.key",
  "pg_ver": "15",
  "count": 2,
  "nodes": [
    {
      "nodename": "n1",
      "ip": "10.0.0.1",
      "port": 5432,
      "path": "~"
    },
    {
      "nodename": "n2",
      "ip": "10.0.0.2",
      "port": 5432,
      "path": "~"
    }
  ]
}