Refresh upstreams doc into current dependency reference
This commit is contained in:
parent
9f4bbd1317
commit
718ba24887
94
UPSTREAMS.md
94
UPSTREAMS.md
@ -1,37 +1,68 @@
|
|||||||
# Upstream Dependencies
|
# Upstreams / Dependency Notes
|
||||||
|
|
||||||
## Portal
|
This file is a concise reference for important repo/runtime dependencies that affect current implementation work.
|
||||||
- Next.js
|
|
||||||
- Axios
|
|
||||||
- Websocket console
|
|
||||||
- Multipart FormData upload
|
|
||||||
|
|
||||||
## API
|
Use it for:
|
||||||
- Node.js (ESM)
|
- major framework/runtime dependencies
|
||||||
- Express
|
- important transport or proxy assumptions
|
||||||
- Raw http.request for upload proxy
|
- shared infrastructure dependencies such as the artifact server
|
||||||
- Prisma
|
|
||||||
- Token auth
|
|
||||||
|
|
||||||
## Agent
|
Do not use this file as a backlog.
|
||||||
- Go
|
|
||||||
- Runtime root sandboxing
|
|
||||||
- Atomic file writes
|
|
||||||
- Metadata tracking
|
|
||||||
- Shadow backup system
|
|
||||||
|
|
||||||
No external reverse proxy required for internal upload.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## zlh-artifacts (Artifact Server)
|
## Portal (`zpack-portal`)
|
||||||
|
|
||||||
|
Core dependencies / assumptions:
|
||||||
|
- Next.js
|
||||||
|
- Axios for API interaction
|
||||||
|
- WebSocket-backed console UI through the API bridge
|
||||||
|
- multipart/FormData upload flows through API/agent paths
|
||||||
|
|
||||||
|
Portal boundary:
|
||||||
|
- Portal talks to API, not directly to agents, for normal state/actions
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## API (`zpack-api`)
|
||||||
|
|
||||||
|
Core dependencies / assumptions:
|
||||||
|
- Node.js (ESM)
|
||||||
|
- Express
|
||||||
|
- Prisma
|
||||||
|
- token/cookie-based auth flows
|
||||||
|
- WebSocket proxying for console / IDE flows
|
||||||
|
- raw `http.request` piping for upload proxy paths
|
||||||
|
|
||||||
|
API boundary:
|
||||||
|
- API is the polling/heartbeat authority for agent state
|
||||||
|
- API normalizes state for Portal consumption
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Agent (`zlh-agent`)
|
||||||
|
|
||||||
|
Core dependencies / assumptions:
|
||||||
|
- Go
|
||||||
|
- filesystem enforcement / sandboxing
|
||||||
|
- PTY and WebSocket console transport
|
||||||
|
- local metadata tracking for managed files/workloads
|
||||||
|
- local Minecraft backup / restore support
|
||||||
|
|
||||||
|
Agent boundary:
|
||||||
|
- agent owns local workload-aware behavior
|
||||||
|
- agent does not own offsite/PBS durability strategy
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## `zlh-artifacts` (Artifact Server)
|
||||||
|
|
||||||
Role:
|
Role:
|
||||||
Central artifact distribution for runtime and addon installs.
|
- central artifact distribution for runtime and addon installs
|
||||||
|
|
||||||
Artifacts currently hosted:
|
Artifacts currently hosted:
|
||||||
|
|
||||||
```
|
```text
|
||||||
devcontainer/
|
devcontainer/
|
||||||
_catalog.json
|
_catalog.json
|
||||||
go/
|
go/
|
||||||
@ -44,12 +75,17 @@ addons/
|
|||||||
code-server/
|
code-server/
|
||||||
```
|
```
|
||||||
|
|
||||||
Used by: zlh-agent
|
Used by:
|
||||||
|
- `zlh-agent`
|
||||||
|
|
||||||
Artifacts are downloaded during provisioning using:
|
Artifacts are downloaded during provisioning via artifact URL helpers (for example, `provcommon.BuildArtifactURL(...)`).
|
||||||
|
|
||||||
```
|
|
||||||
provcommon.BuildArtifactURL(...)
|
|
||||||
```
|
|
||||||
|
|
||||||
Containers do not rely on prepositioned artifacts.
|
Containers do not rely on prepositioned artifacts.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Operational reminders
|
||||||
|
|
||||||
|
- upload transport uses raw piping, not `fetch()`, on proxy/upload paths
|
||||||
|
- hosted browser IDE flow is edge → API → container, not direct edge → container
|
||||||
|
- game publish flow and dev IDE flow should not be conflated
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user