docs: align with new storage architecture (s3 + local + server-proxied PUT)
All operator- and developer-facing docs updated to reflect:
- The unified AsyncStorageBackend abstraction (s3 + local backends).
- The STORAGE_BACKEND toggle ("s3" default, "local" for dev /
single-node / air-gapped deployments).
- The 4-purpose-bucket layout (workspace / version / run_log / trash)
in both modes — 4 separate S3 buckets in s3 mode, 4 subdirectories
of LOCAL_STORAGE_BASE_DIR in local mode.
- The S3_* env var naming (was RUSTFS_*).
- The server-proxied upload flow (was browser-direct presign-PUT):
POST /internal/v1/uploads → PUT /internal/v1/uploads/{id} with
raw bytes → server calls backend.put().
- The factory helpers workspaces_root() (runtime's view of the
workspace bucket on disk) and rclone_remote_spec() (s3-mode mount
source).
- The "two settings describing the same thing" cleanup: the deleted
settings.workspace_root, settings.workspaces_root, and
settings.remote_bucket fields.
Files touched:
- API.md (§5 data-resource upload flow, §9 storage control plane,
§10 readiness example)
- ARCHITECTURE.md (storage layer diagram)
- CLAUDE.md (architecture description + volume-preservation note)
- DEVELOP.md (settings list, Storage section, "Wire a new bucket"
how-to, dev-export example, troubleshooting network hint)
- README.md (architecture diagram, container table, quick-start
credentials note, tear-down note, Storage layout section)
- REFACTOR_NOTES.md (final container list with s3 explanation)
- backend/README.md (storage backend description)
- migrations/data/README.md (step 11/12 record mentioning object
storage)
A handful of historical "RustFS" mentions are intentionally retained
where they name a specific S3-compatible product (e.g. as an example
in REFACTOR_NOTES.md's container list) or document the pre-2026
abstraction name (DEVELOP.md Storage section).
This commit is contained in:
+7
-2
@@ -28,8 +28,8 @@
|
||||
|
||||
```text
|
||||
mysql
|
||||
rustfs
|
||||
jupyter
|
||||
s3 # 外部 S3-兼容服务(MinIO/RustFS/SeaweedFS/...),由运维在 compose 外启动
|
||||
jupyter # 注释保留;当前实现未在 compose 启此独立容器
|
||||
migrate(一次性)
|
||||
backend
|
||||
runtime
|
||||
@@ -37,6 +37,11 @@ schedule
|
||||
gateway
|
||||
```
|
||||
|
||||
> 补充说明:`STORAGE_BACKEND=local` 模式下不需要外部 S3 服务,backend
|
||||
> 与 runtime 共享 docker 卷 `local-storage`,挂载到
|
||||
> `LOCAL_STORAGE_BASE_DIR`(默认 `/data/storage`);runtime 也跳过
|
||||
> rclone FUSE 挂载(见 `runtime/src/runtime/mount.py`)。
|
||||
|
||||
## 已执行检查
|
||||
|
||||
- Python 全项目 `compileall` 通过;
|
||||
|
||||
Reference in New Issue
Block a user