NODECTL
NODECTL is the pgEdge Command Line Interface (CLI) for managing components. The individual modules are:
- Update Manager (UM)
- SERVICE
- SPOCK
- CLUSTER
- ACE
Synopsis
./nodectl <module_name> <command> [parameters] [options]
When calling a NODECTL command, specify the name of the module, followed by the command name and any
command options. To review help for a module, use the command:
./nodectl <module_name> --help
UM
Commands in the UM module include:
| Command | Description |
|---|---|
| list | Display available/installed components |
| update | Retrieve new list of latest components & update nodectl |
| install | Install a component (for example, pg15, pg16, spock, postgis) |
| remove | Un-install component |
| upgrade | Perform an upgrade of a component |
| clean | Delete downloaded component files from local cache |
SERVICE
Commands in the SERVICE module include:
| Command | Description |
|---|---|
| start | Start server components |
| stop | Stop server components |
| status | Display status of installed server components |
| reload | Reload server config files (without a restart) |
| restart | Stop & then start server components |
| enable | Enable a server component |
| disable | Disable component from starting automatically |
| config | Configure a component |
| init | Initialize a component |
SPOCK
Commands in the SPOCK module include:
| Command | Description |
|---|---|
| tune | Tune for this configuration |
| node-create | Define a node for spock |
| node-drop | Remove a spock node |
| node-alter-location | Set location details for spock node |
| node-list | Display node table |
| node-add-interface | Add a new node interafce |
| node-drop-interface | Delete a node interface |
| repset-create | Define a replication set |
| repset-alter | Modify a replication set |
| repset-drop | Remove a replication set |
| repset-add-table | Add table(s) to replication set |
| repset-remove-table | Remove table from replication set |
| repset-add-seq | Add a sequence to a replication set |
| repset-remove-seq | Remove a sequence from a replication set |
| repset-alter-seq | Change a replication set sequence |
| repset-list-tables | List tables in replication sets |
| sub-create | Create a subscription |
| sub-drop | Delete a subscription |
| sub-alter-interface | Modify an interface to a subscription |
| sub-enable | Make a subscription live |
| sub-disable | Put a subscription on hold and disconnect from provider |
| sub-add-repset | Add a replication set to a subscription |
| sub-remove-repset | Drop a replication set from a subscription |
| sub-show-status | Display the status of the subcription |
| sub-show-table | Show subscription tables |
| sub-sync | Synchronize a subscription |
| sub-resync-table | Resynchronize a table |
| sub-wait-for-sync | Pause until the subscription is synchronized |
| table-wait-for-sync | Pause until a table finishes synchronizing |
| health-check | Check if PG instance is accepting connections |
| metrics-check | Retrieve advanced DB & OS metrics |
| set-readonly | Turn PG read-only mode 'on' or 'off' |
CLUSTER
Commands in the CLUSTER module include:
| Command | Description |
|---|---|
| create-secure | Provision a secure cluster in the Cloud using your own account |
| create-local | Create a localhost test cluster of N pgEdge nodes on different ports |
| destroy-local | Stop and then nuke a cluster |
| init-remote | Initialize pgEdge on a remote cluster that you create & manage yourself |
| reset-remote | Reset pgEdge on a remote cluster |
| validate | Validate a remote cluster configuration |
| init | Initialize a remote cluster for SPOCK |
| command | Run nodectl command on one or all nodes of a cluster |
ACE
Commands in the ACE module include:
| Command | Description |
|---|---|
| diff-tables | Evaluate the difference between two tables |
| diff-schemas | Evaluate the difference between two schemas |
| diff-spock | Evaluate the difference between two configurations |
Command Options
Use the following command options with selected commands listed above:
| Command | Description |
|---|---|
| --json | Turn on JSON output |
| --debug | Turn on debug logging |
| --silent | Return less output |
| --verbose or -v | Return more output |