Documentation
¶
Overview ¶
Package cloud is the pgEdge Starfleet module: one product, one connection, three faces (account-level resources, byoc, managed).
Index ¶
Constants ¶
const Dir = "internal/starfleet"
Dir is this package's path under the repository root.
Variables ¶
var Version = "dev"
Version is stamped at build time from versions.env (STARFLEET_VERSION) via -ldflags; see the Makefile and .goreleaser.yaml. The default is what a plain `go build` reports.
Functions ¶
This section is empty.
Types ¶
type Module ¶
type Module struct{}
Module implements module.Module for the starfleet tree.
func (*Module) Describe ¶
func (m *Module) Describe() module.ModuleInfo
Describe returns the module's self-description. ContractVersion is intentionally empty: it is reserved for the future external-dispatch contract and carries no meaning while cloud ships in-process.
func (*Module) Documents ¶
Documents returns every page the starfleet tree ships: the module's own, then byoc's and managed's, so `pgedge llms starfleet byoc database` resolves through one list. There is no "account" page: account dissolved into the starfleet level, so its commands are documented in the module's own pages.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
account
|
|
|
api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
cmd
Package cmd wires the account-level commands of the pgedge starfleet tree: authentication, API clients, tenants, invites and memberships — everything the accounts half of the Starfleet API owns.
|
Package cmd wires the account-level commands of the pgedge starfleet tree: authentication, API clients, tenants, invites and memberships — everything the accounts half of the Starfleet API owns. |
|
Package byoc holds the byoc sub-tree of the starfleet module: its generated API client, its command tree and its reference pages.
|
Package byoc holds the byoc sub-tree of the starfleet module: its generated API client, its command tree and its reference pages. |
|
api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
cmd
Package cmd wires the pgEdge BYOC command tree: the module root, its persistent flags, and the authenticated API client shared by every resource command.
|
Package cmd wires the pgEdge BYOC command tree: the module root, its persistent flags, and the authenticated API client shared by every resource command. |
|
Package cmd wires the pgedge starfleet command tree: the starfleet root, its persistent connection flags, the account-level commands (auth, doctor, tenant, client, invite, membership), and the byoc and managed sub-trees.
|
Package cmd wires the pgedge starfleet command tree: the starfleet root, its persistent connection flags, the account-level commands (auth, doctor, tenant, client, invite, membership), and the byoc and managed sub-trees. |
|
Package conn owns the single pgEdge Starfleet API connection: base-URL and credential precedence, the token exchange and cache, the shared HTTP client, and the exit codes every Starfleet module reports.
|
Package conn owns the single pgEdge Starfleet API connection: base-URL and credential precedence, the token exchange and cache, the shared HTTP client, and the exit codes every Starfleet module reports. |
|
Package connstr assembles a libpq connection string from the parts a database GET returns, for the managed and byoc connection-string verbs.
|
Package connstr assembles a libpq connection string from the parts a database GET returns, for the managed and byoc connection-string verbs. |
|
Package managed holds the managed sub-tree of the starfleet module: its generated API client, its command tree and its reference pages.
|
Package managed holds the managed sub-tree of the starfleet module: its generated API client, its command tree and its reference pages. |
|
api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
cmd
Package cmd wires the pgEdge Managed command tree: the module root, its persistent flags, and the authenticated API client shared by every resource command.
|
Package cmd wires the pgEdge Managed command tree: the module root, its persistent flags, and the authenticated API client shared by every resource command. |