16 KiB
G14 Platform Infra
platform-infra is the G14 k3s namespace for UniDesk-operated shared platform services. It is separate from HWLAB runtime lanes, AgentRun lanes, D601 user services, and legacy devops-infra control-plane helpers. New shared infra should land here first; old devops-infra resources migrate gradually only when a concrete owner and validation path exist.
Source Of Truth
- UniDesk-owned platform configuration must be YAML-first.
config/platform-infra/*.yamlis the durable source for images, versions, endpoints, FRP exposure, account profile selection, and local consumer configuration. - Runtime Secrets and local
~/.codex/config.toml*/auth.json*files are inputs or generated local state, not committed truth. CLI output may show Secret paths, byte counts, fingerprints, and short previews only; it must not print complete API keys. - Code that reads platform YAML must validate object shape, field types, required fields, Kubernetes names, image strings, and ports before mutating G14 k3s or local consumer files.
- Do not hide image versions, namespace names, endpoint URLs, FRP ports, or profile lists in Python/TOML/JSON helper constants when they are UniDesk-owned choices. External tools may still require their own TOML/JSON/env file formats at the edge.
Sub2API Deployment Boundary
- Sub2API is a G14 platform service operated by UniDesk in namespace
platform-infra. It is not a HWLAB lane workload, AgentRun workload, D601 service, or master server daemon. - The canonical deployment entrypoint is
bun scripts/cli.ts platform-infra sub2api plan|apply|status|validate|codex-pool; daily operation procedures live in$unidesk-sub2apiat.agents/skills/unidesk-sub2api/SKILL.md. This reference keeps only development boundaries and project-specific source-of-truth rules. - Raw
kubectlthroughtrans G14:k3sis only for bounded diagnosis and evidence, not a formal mutate path. - The image version is controlled by
config/platform-infra/sub2api.yaml. Image update procedures are daily operations owned by$unidesk-sub2api; the development boundary is that image choices remain YAML-controlled. - Sub2API should stay ClusterIP-only by default. Do not add Ingress, NodePort, LoadBalancer, or broad FRP exposure unless a YAML-controlled public exposure decision exists.
- Sub2API currently has no resource limits by design. Do not add CPU or memory limits unless a later explicit decision changes that policy and stores the new policy in YAML.
- Master server is a consumer/control host, not the runtime location. Do not deploy Sub2API, PostgreSQL, Redis, or heavy validation loops on master server.
Codex Pool Routing
config/platform-infra/sub2api-codex-pool.yaml controls the Codex-facing OpenAI-compatible pool:
pool.groupNamenames the Sub2API group that represents the pool.pool.apiKeySecretNameandpool.apiKeySecretKeyname the k3s Secret that stores the single consumer API key.pool.minOwnerConcurrencydeclares the minimum concurrency for the Sub2API user that owns the unified consumer API key. Keep it high enough to cover the declared account capacity set, so the shared key does not fail WS sessions at the user-concurrency layer. Do not compensate for owner-concurrency 1013 errors by pinning capacity to one provider.pool.defaultTempUnschedulabledeclares Sub2API account-level temporary unschedulable rules. Keep 429/overload/capacity, service-unavailable, gateway timeout, and stable model-routing failures in this YAML policy so the scheduler can cool down a failing account and choose another candidate instead of hard-pinning one provider.profiles.entriesselects local Codex profile files from~/.codex/and maps them to Sub2API account names.- The unsuffixed master
~/.codex/config.tomland~/.codex/auth.jsonare reserved for the unified Sub2API consumer.config.tomlmust keepbase_url = "https://sub2api.74-48-78-17.nip.io/", andauth.jsonmust contain the unified pool API key frompool.apiKeySecretName/pool.apiKeySecretKey. Do not replace these two files with direct upstream account credentials. - Additional upstream accounts must use suffixed local profile files such as
config.toml.<profile>andauth.json.<profile>, then be declared throughprofiles.entriesinconfig/platform-infra/sub2api-codex-pool.yaml. profiles.entries[].capacityoptionally overridespool.defaultAccountCapacityfor one account. Capacity is a YAML-controlled routing input; concrete current values belong only inconfig/platform-infra/sub2api-codex-pool.yamland runtime validation output, not in long-term reference prose. Code constants, Secrets, ad-hoc runtime patches, or stale tests must not override YAML source of truth.profiles.entries[].loadFactoroptionally overridespool.defaultAccountLoadFactorfor one account and is rendered to Sub2APIload_factor. Treat it as routing policy: values belong in YAML andcodex-pool validateoutput, not code constants, Secrets, or ad-hoc runtime patches.- Do not change account membership, priority, capacity, load factor, WebSocket mode, or other routing policy from inference alone. Unless the user explicitly asks for a configuration change, first preserve the current YAML, collect provenance and runtime evidence, and write the finding to the relevant issue or runbook before proposing a change.
profiles.entries[].tempUnschedulablemay override the pool default for one account. The CLI renders it into Sub2API credentials astemp_unschedulable_enabledandtemp_unschedulable_rules; rules match HTTP status plus response-body keywords and place only that account into a temporary unschedulable cooldown.- Codex account-state or quota prompts that stop a task and ask the operator to switch accounts belong in
pool.defaultTempUnschedulable, not in account membership, priority, capacity, load factor, WebSocket mode, orpool_mode. Keep stable body phrases such as weekly-limit and/statusprompts in both the 403 account-state rule and the 429 quota/rate-limit rule, then runcodex-pool sync --confirmandcodex-pool validate. The validation evidence must include runtime temporary-unschedulable alignment for each managed account, not only successful group-level/v1/modelsor/v1/responsessmoke output. - Upstream model-routing failures that surface as 503 responses, such as
model_not_foundor "no available channel for model" wrappers, also belong inpool.defaultTempUnschedulable. Gateway and timeout failures that surface as 502, 504, or 524 responses, includingGateway Timeout,Unknown error,Upstream request failed,context deadline exceeded,context canceled, or recovered upstream-error wrappers, belong in the same YAML policy. This is especially important for compact requests, where an upstream Cloudflare 524 may eventually reach Codex as a 502/504 unknown-error wrapper after failover or client cancellation. They are not membership, priority, capacity, load factor, WebSocket mode, or User-Agent decisions by themselves. After adding stable body phrases, runcodex-pool sync --confirmandcodex-pool validate, and verify the affected account's runtime status-specific rule includes the new keywords. profiles.entries[].openaiResponsesWebSocketsV2Modeis the account-level Responses WebSocket v2 switch for OpenAI-compatible upstreams that require WebSocket transport. Allowed values areoff,ctx_pool, andpassthrough; omit the field unless that upstream needs it.profiles.entries[].upstreamUserAgentis an optional account-level upstream request User-Agent override. Use it only for upstreams that require a Codex CLI compatible User-Agent; keep the value YAML-controlled and newline-free.publicExposurecontrols the optional FRP bridge from master server to the G14 ClusterIP service.publicExposure.masterCaddy.responseHeaderTimeoutSecondscontrols the master Caddyresponse_header_timeoutfor the public Sub2API site. It must be long enough for Codex/responses/compactrequests; otherwise Caddy can return a client-visible 504 before Sub2API finishes the upstream compact request, and that edge timeout is not an account-level upstream failure that Sub2API can use for temporary-unschedulable failover.localCodexcontrols how the master server's current~/.codexconsumer files are backed up and rewritten. KeepsupportsWebSocketsandresponsesWebSocketsV2in the same state, and enable them only when at least one YAML-managed account has a current direct Codex WSv2 smoke that passes. If no upstream profile can sustain Responses WSv2, the honest long-term state isfalse/falseso Codex uses HTTP Responses directly instead of repeatedly reconnecting beforeresponse.completed.localCodex.responsesSmokeModelis the YAML-declared model used bycodex-pool validatefor the lightweightPOST /v1/responsessmoke.
Enable account-level WebSocket v2 only for upstream profiles that have passed a direct Codex WSv2 probe. Treat this as a YAML-declared capability set, not a hard scheduling pin to one profile; if localCodex enables WebSocket transport, codex-pool validate must show at least one current webSocketsV2.schedulableEnabled account, and runtime smoke remains the availability proof. The same validation reports each managed account's runtime WebSocket v2 mode and whether it matches YAML, so stale ctx_pool / passthrough settings cannot silently keep routing Codex WS sessions to an upstream that closes with no available account, WS handshake 5xx/4xx, or before response.completed.
When Codex startup repeatedly reports WebSocket reconnects or HTTPS fallback, preserve membership, priority, capacity, load factor, and other routing policy until runtime logs identify the failing account and transport. If bounded Sub2API logs show repeated openai.websocket_proxy_failed, openai.websocket_account_select_failed, upstream WS handshake 4xx/5xx, or repeated close-before-response.completed for the only WS-capable account, remove that account from the WSv2 capability set in YAML; if the resulting capability set is empty, also turn off the localCodex WS feature flags. Then run codex-pool sync --confirm, codex-pool validate, and prove the result with a Codex smoke that no longer emits reconnects.
Do not encode current availability assumptions in long-term reference prose. If an account needs a higher concurrency or load factor than the pool default, make that a deliberate YAML override and verify it with codex-pool validate; the reference document should describe the rule, not repeat the current numeric value.
Do not enable Sub2API pool_mode for UniDesk-managed Codex accounts. pool_mode retries the same selected account path, while UniDesk's desired failover behavior is to mark the failing account temporarily unschedulable and let Sub2API choose another account from the group. codex-pool validate reports each managed account's temporary-unschedulable runtime alignment and should be used after codex-pool sync --confirm. Generic 502/503/504 bodies such as Recovered upstream error 502, Bad Gateway, Gateway Timeout, Codex-facing Upstream request failed, Unknown error, context-deadline/canceled wrappers, and stable model_not_found / "no available channel for model" wrappers must stay in the YAML cooldown policy so an intermittently bad account is cooled down instead of repeatedly adding latency at the next compact or Responses request. The Codex pool default error cooldown is severity-tiered: temporary signals can start at ten minutes, gateway/service/overload/model-routing failures should cool down longer, and credential, permission, quota, or account-state failures should use the longest cooldown. Exact current values belong in YAML and runtime validation output.
Sub2API temporary-unschedulable rules require both an HTTP status match and a response-body keyword match. Do not treat them as a general successful-response content filter. If an upstream returns a quota warning as normal HTTP 200 assistant content, keep the same stable phrases in the 403/429 rules and track a separate response-classification capability issue; a YAML 200 rule may document the desired classification signal, but account cooling is only proven when codex-pool validate reports runtimeCapabilities.successBodyReclassification.outcome=supported. An unsupported-runtime-image result is visibility for the capability gap, not proof that successful assistant content currently cools the selected account.
The request path is:
- A client sends an OpenAI-compatible request to the configured consumer base URL, normally
https://sub2api.74-48-78-17.nip.io/v1/..., with the unified API key. - master
frpsforwards the TCP connection toplatform-infra/sub2api-frpcwhenpublicExposure.enabledis true. sub2api-frpcforwards tosub2api.platform-infra.svc.cluster.local:8080.- Sub2API validates the unified key and resolves its
group_id. - Accounts listed in
profiles.entriesare bound to the same group viagroup_ids, so Sub2API dispatches through that group using its own account selection semantics.
Adding, removing, exposing, validating, and configuring local Codex consumers are daily operations covered by $unidesk-sub2api. The development rule is that ordinary pool membership changes stay YAML-only and do not add code or CI/CD. Code changes are only appropriate when the YAML schema needs a new reusable capability such as account-level WebSocket mode or per-account upstream User-Agent.
After codex-pool configure-local --confirm, the default ~/.codex/config.toml / auth.json pair must remain the unified Sub2API consumer and must not be reused as an upstream account profile. Keep every upstream source profile in suffixed files such as config.toml.<profile> / auth.json.<profile> and register it through YAML profiles.entries.
Public FRP Boundary
When publicExposure.enabled is true, the same FRP TCP bridge exposes both OpenAI-compatible API paths and the built-in Sub2API management frontend. The management UI is reachable at the configured publicExposure.publicBaseUrl and its /login route; do not allocate a second public port unless a separate YAML-controlled exposure decision exists.
The public management UI is an operations endpoint. Keep Sub2API itself in platform-infra, keep the Kubernetes Service as ClusterIP, and treat FRP as the only public bridge unless a later decision explicitly changes the exposure model.
Availability And Probes
Kubernetes readiness is not the same as pool availability:
- The Sub2API app, PostgreSQL, and Redis manifests include container-level health probes. These only prove the pods and local dependencies are healthy enough for Kubernetes scheduling.
- The FRP client deployment is currently a simple connector deployment and does not itself prove that master-local traffic reaches Sub2API.
- No scheduled
CronJob,ServiceMonitor, orPodMonitorcurrently proves the full unified Codex API path. platform-infra sub2api validateandplatform-infra sub2api codex-pool validateare on-demand checks. Operational usage is documented in$unidesk-sub2api; they are acceptable for deployment closeout, but they are not continuous monitoring.codex-pool validatemust test bothGET /v1/modelsand a smallPOST /v1/responsesrequest, and the Responses smoke should report request id, selected/final account evidence, upstream failover count, and whether the validation succeeded only after failover.
When an automatic availability probe is added, it should be YAML-controlled and cover these layers without printing secrets:
- G14 in-cluster
GET /v1/modelsthroughsub2api.platform-infra.svc.cluster.local:8080with the unified key. - master-local
GET /v1/modelsthrough the configured FRP endpoint when public exposure is enabled. - A tiny
POST /v1/responsescall through the same consumer URL for true OpenAI-compatible request validation. - Optional per-upstream account probes if Sub2API exposes a safe account selection or admin-health mechanism; otherwise document that group-level success does not prove every upstream account is healthy.
Until continuous probing exists, closeout comments must state that validation was on-demand and include the exact CLI/API entrypoints used.