Erda 项目教程

Erda 项目教程

erda An enterprise-grade Cloud-Native application platform for Kubernetes. 项目地址: https://gitcode.com/gh_mirrors/er/erda

1. 项目的目录结构及介绍

Erda 项目的目录结构如下：

erda/
├── api/
├── apistructs/
├── build/
├── bundle/
├── cmd/
├── conf/
├── docs/
├── internal/
├── pkg/
├── tools/
├── .dockerignore
├── .gitattributes
├── .gitignore
├── .golangci.yml
├── .licenserc.json
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── README.md
├── VERSION
├── codecov.yml
├── erda.yml
├── go.mod
├── go.sum
└── pipeline.yml

目录介绍

• api/: 包含项目的 API 定义文件。
• apistructs/: 包含 API 结构定义文件。
• build/: 包含构建相关的文件。
• bundle/: 包含项目打包相关的文件。
• cmd/: 包含项目的命令行工具和启动文件。
• conf/: 包含项目的配置文件。
• docs/: 包含项目的文档文件。
• internal/: 包含项目的内部实现文件。
• pkg/: 包含项目的公共库文件。
• tools/: 包含项目的工具文件。
• .dockerignore: Docker 构建时忽略的文件列表。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件列表。
• .golangci.yml: GolangCI 配置文件。
• .licenserc.json: 许可证配置文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建脚本文件。
• README.md: 项目介绍文件。
• VERSION: 项目版本文件。
• codecov.yml: Codecov 配置文件。
• erda.yml: Erda 项目配置文件。
• go.mod: Go 模块依赖文件。
• go.sum: Go 模块校验文件。
• pipeline.yml: 流水线配置文件。

2. 项目的启动文件介绍

Erda 项目的启动文件主要位于 cmd/ 目录下。每个子目录通常对应一个可执行文件的入口点。例如：

cmd/
├── erda-admin/
│   └── main.go
├── erda-api/
│   └── main.go
├── erda-worker/
│   └── main.go
└── ...

启动文件介绍

• erda-admin/main.go: 管理后台的启动文件。
• erda-api/main.go: API 服务的启动文件。
• erda-worker/main.go: 工作节点的启动文件。

每个 main.go 文件通常包含 main 函数，负责初始化配置、启动服务等操作。

3. 项目的配置文件介绍

Erda 项目的配置文件主要位于 conf/ 目录下，以及根目录下的 erda.yml 文件。

配置文件介绍

• conf/: 包含项目的各种配置文件，如数据库配置、日志配置等。
• erda.yml: 项目的核心配置文件，包含全局配置、服务配置等。

erda.yml 示例

global:
  environment: production
  logLevel: info

services:
  api:
    port: 8080
    timeout: 30s
  worker:
    concurrency: 10
    retry: 3

配置文件说明

• global: 全局配置，如运行环境、日志级别等。
• services: 服务配置，如端口、超时时间、并发数等。

通过这些配置文件，可以灵活地调整 Erda 项目的运行参数，以适应不同的部署环境。

erda An enterprise-grade Cloud-Native application platform for Kubernetes. 项目地址: https://gitcode.com/gh_mirrors/er/erda