Documentation
¶
Overview ¶
Package cmd wires the pgEdge Control Plane command tree: the module root, its persistent connection flags, and the HTTP API client shared by every resource command.
Index ¶
- Constants
- func NewClusterCmd(rt *module.Runtime) *cobra.Command
- func NewControlplaneCmd(rt *module.Runtime) *cobra.Command
- func NewDatabaseCmd(rt *module.Runtime) *cobra.Command
- func NewDatabaseInstanceCmd(rt *module.Runtime) *cobra.Command
- func NewDatabaseNodeCmd(rt *module.Runtime) *cobra.Command
- func NewHostCmd(rt *module.Runtime) *cobra.Command
- func NewTaskCmd(rt *module.Runtime) *cobra.Command
- type ExitError
Constants ¶
const ( ExitOK = 0 ExitGeneral = 1 ExitUsage = 2 ExitTimeout = 3 ExitNotFound = 4 ExitAuth = 5 )
Exit codes used by controlplane commands.
const SupportFloor = "0.10.0"
SupportFloor is THE minimum Control Plane server version this CLI module supports (decision 2026-08-05; issue #34's dev-snapshot mislabeling is why the policy exists at all). It must be kept in sync with the `CP_TAG=` pin in openapi/SOURCE — that file is what `make vendor-spec` actually vendors from, and this constant is what the running binary compares against. TestControlplaneSupportFloorMatchesSource (internal/clitest) parses SOURCE's pin and fails the build the two drift apart, so bump both together.
Variables ¶
This section is empty.
Functions ¶
func NewClusterCmd ¶
NewClusterCmd builds `pgedge controlplane cluster`.
func NewControlplaneCmd ¶
NewControlplaneCmd builds the `pgedge controlplane` command tree: the module root, its persistent connection flags, and the resource subcommands.
func NewDatabaseCmd ¶
NewDatabaseCmd builds `pgedge controlplane database`.
func NewDatabaseInstanceCmd ¶
NewDatabaseInstanceCmd builds `pgedge controlplane database instance`: lifecycle control of individual database instances.
func NewDatabaseNodeCmd ¶
NewDatabaseNodeCmd builds `pgedge controlplane database node`: per-node operations (backup, switchover, failover) on a database.
func NewHostCmd ¶
NewHostCmd builds `pgedge controlplane host`.
Types ¶
Source Files
¶
- api.go
- client.go
- cluster.go
- config.go
- database.go
- database_detail.go
- database_init.go
- database_instance.go
- database_instance_list.go
- database_node.go
- database_ops.go
- database_restore_template.go
- database_spec.go
- database_spec_ports.go
- database_spec_template.go
- doctor.go
- floor.go
- helpers.go
- host.go
- instance_render.go
- orchestrator.go
- prompt.go
- root.go
- task.go
- version.go
- wait.go