Harness CD Community 项目启动与配置教程

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

Harness CD Community 是一个持续交付（Continuous Delivery）的开源项目，其目录结构如下：

harness-cd-community/
├── .circleci/           # CircleCI CI/CD 配置文件
├── .gitignore           # Git 忽略文件列表
├── .mvn/wrapper/        # Maven Wrapper 配置
├── .vscode/             # Visual Studio Code 项目配置
├── admission/           # 准入控制器相关代码
├── api/                 # API 定义与协议
├── bin/                 # 执行脚本和工具
├── build/               # 构建相关文件
├── chart/               # Helm 图表定义
├── client/              # 客户端库
├── common/              # 公共代码库
├── config/              # 配置文件模板
├── contrib/             # 贡献代码和插件
├── deploy/              # 部署脚本和配置
├── docs/                # 项目文档
├── harness-core/        # 核心代码库
├── harness-tests/       # 测试代码
├── harness-web/         # Web UI 相关代码
├── integration/         # 集成测试代码
├── packaging/           # 打包配置和脚本
├── scripts/             # 脚本和实用工具
├── setup/               # 安装和初始化脚本
├── tools/               # 开发和构建工具
└── web/                 # Web UI 静态资源

每个目录的功能简要介绍如下：

• .circleci/: 包含项目在 CircleCI 上运行的 CI/CD 配置。
• .gitignore: 指定在 Git 仓库中应忽略的文件和目录。
• .mvn/wrapper/: 包含 Maven Wrapper 的配置，方便项目构建。
• .vscode/: 包含 Visual Studio Code 的项目配置。
• admission/: 包含项目准入控制器的代码。
• api/: 包含 API 定义和协议代码。
• bin/: 包含可执行脚本和工具。
• build/: 包含构建相关的文件。
• chart/: 包含 Helm 图表的定义。
• client/: 包含客户端库的代码。
• common/: 包含项目公共代码库。
• config/: 包含配置文件模板。
• contrib/: 包含项目贡献的代码和插件。
• deploy/: 包含部署脚本和配置。
• docs/: 包含项目文档。
• harness-core/: 包含项目核心代码库。
• harness-tests/: 包含项目的测试代码。
• harness-web/: 包含 Web UI 相关代码。
• integration/: 包含集成测试代码。
• packaging/: 包含项目打包配置和脚本。
• scripts/: 包含脚本和实用工具。
• setup/: 包含项目安装和初始化脚本。
• tools/: 包含开发和构建工具。
• web/: 包含 Web UI 的静态资源。

2. 项目的启动文件介绍

项目的启动文件主要集中在 bin/ 目录下，以下是几个主要的启动文件：

• harness.sh: Linux 系统下启动 Harness 的脚本。
• harness.ps1: Windows 系统下启动 Harness 的 PowerShell 脚本。

以 harness.sh 为例，该脚本通常用于启动 Harness 服务，其内容大致如下：

#!/bin/bash

# 设置 Harness 服务的运行环境变量
export H RuntimeObject=/path/to/harness

# 启动 Harness 服务
java -jar $H RuntimeObject/harness.jar

用户需要根据实际情况修改环境变量 H RuntimeObject 的值，指向 Harness 的运行目录。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，以下是几个重要的配置文件：

• harness.yml: 主配置文件，包含了 Harness 服务的各种配置。
• log4j2.xml: 日志配置文件，定义了日志的格式和存储位置。

以 harness.yml 为例，该文件可能包含以下内容：

server:
  port: 8080  # Harness 服务端口
  host: 0.0.0.0  # 绑定地址

# 数据库配置
database:
  url: jdbc:mysql://localhost:3306/harness  # 数据库连接地址
  username: root  # 数据库用户名
  password: password  # 数据库密码

# 其他配置...

用户需要根据实际情况修改这些配置文件的相应部分，以适应自己的运行环境。