Files
workspace-directory-standard/templates/w2-service-app.md
T

2.2 KiB

W2 服务型应用模板

来源:三端统一目录规范(README.md)2.2 节 适用:需要部署、运行、端口、配置、监控、日志、备份恢复或值班操作的应用。 服务已有固定启动路径时以现状为准,模板用于登记和逐步补全。

结构

<service>/
├── README.md                    # 服务卡片,必建
├── .workspace.yaml              # 类型登记,新建必建
├── src/                         # 主程序;已有 app/ 等名称可保留
├── tests/                       # 单元、集成、接口测试
├── config/
│   ├── examples/                # 可提交的配置样例
│   └── README.md                # 配置项和密钥来源说明
├── deploy/
│   ├── compose/                 # Docker Compose 等
│   ├── systemd/                 # 服务单元
│   ├── containers/              # Dockerfile、镜像构建文件
│   └── migrations/              # 服务自身升级迁移
├── ops/
│   ├── runbooks/                # 启停、故障、恢复手册
│   ├── monitoring/              # 指标、告警、仪表盘配置
│   └── backup/                  # 备份与恢复脚本/说明
├── scripts/                     # 服务专用运维脚本
├── data/                        # 运行数据;可链接到独立数据盘
├── logs/                        # 本地日志;可链接到共享日志层
├── research/                    # 架构、调研、变更设计
└── archive/                     # 已冻结配置或旧产物,不放源码版本副本

README 必填项(服务卡片额外)

监听地址和端口、启动方式、依赖服务、配置来源、数据权威路径、日志路径、健康检查、备份频率、恢复步骤入口、负责人。

约束

  • 密钥不得进 Git;仅提交 .env.example 或 config/examples/
  • 源码版本用 Git tag;部署产物用镜像标签/发布版本,不复制 v1/v2 整套源码目录
  • data/ logs/ backup/ 可为软链接,但 README 必须写明真实路径
  • W2 不套 v2 三层结构;服务专用脚本与平台通用脚本分开,平台通用脚本归 W6