SODA Strato 项目安装与使用教程
1. 项目的目录结构及介绍
SODA Strato 项目的目录结构如下:
strato/
├── CHANGELOG
├── K8s
├── aks
├── api
├── backend
├── block
├── contrib
├── dataflow
├── datamover
├── docs
├── examples
├── file
├── install/CI
├── installer
├── metadata
├── mongodb
├── openapi-spec
├── s3
├── script
├── testhelper
├── testutils
├── vendor
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── codecov.yml
├── docker-compose.yml
├── go.mod
├── go.sum
目录介绍
- CHANGELOG: 项目变更日志。
- K8s: Kubernetes 相关文件。
- aks: Azure Kubernetes Service 相关文件。
- api: API 接口相关文件。
- backend: 后端服务相关文件。
- block: 块存储相关文件。
- contrib: 贡献者相关文件。
- dataflow: 数据流相关文件。
- datamover: 数据迁移相关文件。
- docs: 项目文档。
- examples: 示例代码。
- file: 文件存储相关文件。
- install/CI: 安装和持续集成相关文件。
- installer: 安装程序相关文件。
- metadata: 元数据相关文件。
- mongodb: MongoDB 相关文件。
- openapi-spec: OpenAPI 规范相关文件。
- s3: S3 兼容接口相关文件。
- script: 脚本文件。
- testhelper: 测试辅助工具。
- testutils: 测试工具。
- vendor: 第三方依赖库。
- .gitignore: Git 忽略文件配置。
- LICENSE: 项目许可证。
- Makefile: 项目构建文件。
- README.md: 项目介绍文件。
- codecov.yml: Codecov 配置文件。
- docker-compose.yml: Docker Compose 配置文件。
- go.mod: Go 模块依赖文件。
- go.sum: Go 模块校验文件。
2. 项目的启动文件介绍
SODA Strato 项目的启动文件主要集中在 api
和 backend
目录中。以下是主要的启动文件:
- api/main.go: 这是 API 服务的主启动文件,负责启动 API 服务。
- backend/main.go: 这是后端服务的主启动文件,负责启动后端服务。
启动步骤
- 进入项目根目录。
- 使用
go run
命令启动 API 服务:go run api/main.go
- 使用
go run
命令启动后端服务:go run backend/main.go
3. 项目的配置文件介绍
SODA Strato 项目的配置文件主要集中在 config
目录中。以下是主要的配置文件:
- config/config.yaml: 这是项目的主配置文件,包含了 API 和后端服务的配置参数。
- config/database.yaml: 这是数据库配置文件,包含了数据库连接信息。
配置文件示例
config/config.yaml:
api:
port: 8080
timeout: 30s
backend:
port: 9090
timeout: 60s
config/database.yaml:
database:
host: localhost
port: 27017
name: strato_db
username: admin
password: password
配置文件加载
在启动项目时,配置文件会自动加载并应用到相应的服务中。如果需要修改配置,可以直接编辑相应的配置文件并重启服务。