Resource reference¶
Declarative resources applied with pgctl apply -f …. Each document is a YAML object with a shared envelope and a kind-specific spec.
Envelope¶
| Field | Required | Description |
|---|---|---|
kind |
yes | Resource type (see below) |
version |
yes | API version — currently v1 |
metadata |
— | Identity and labels |
spec |
— | Kind-specific fields |
metadata¶
| Field | Required | Description |
|---|---|---|
name |
no* | Resource ID. If omitted, a ULID is generated on apply |
labels |
no | map[string]string — used by dynamic pools and placement |
*Prefer an explicit name so stacks stay referencable (pool_id, flow_id, …).
Kinds¶
| Kind | Page |
|---|---|
Proxy |
Proxy |
Pool |
Pool |
LoadBalancer |
LoadBalancer |
Router |
Router |
Flow |
Flow |
Entrypoint |
Entrypoint |
How they connect¶
flowchart LR
EP[Entrypoint] -->|flow_id| FL[Flow]
FL -->|router_id optional| RT[Router]
FL -->|balancer_id| LB[LoadBalancer]
RT -->|rules.target| LB
LB -->|pool_id| PL[Pool]
PL -->|members / labels| PX[Proxy]
Mental model: Resources & flow model.