# helios

**Repository Path**: open-byte/helios

## Basic Information

- **Project Name**: helios
- **Description**: Helios(太阳神)是针对WindowServer服务器开发的一款优秀的开源CI/CD工具，直接手动部署、自动部署、编排(类流水线)部署等丰富的部署功能，还提供了客户端监控告警、日志收集、脚本作业极大的方便了开发和运维人员的工作。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 1
- **Created**: 2024-06-15
- **Last Updated**: 2025-12-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Helios
#### 介绍
Helios(太阳神)是针对WindowServer服务器开发的一款优秀的开源CI/CD工具，直接手动部署、自动部署、编排(类流水线)部署等丰富的部署功能，还提供了客户端监控告警、日志收集、脚本作业极大的方便了开发和运维人员的工作。

#### 当前版本拥有的特性

- 支持手动部署、自动部署、编排(类流水线)部署，目前仅支持Maven、Node.js类型的项目
- 支持对部署节点的部署监控状态的监控
- 支持客户端监控与告警
- 支持在线收集客户端服务的日志
- 支持脚本作业

#### 下个版本预览

- 计划新增对Gradle、Nginx、Tomcat、React类型项目的支持
- 计划新增对多日志文件同时监听和上报的功能
- 计划优化日志上报时的性能
- 计划更改编排部署的编排形式，采用选择的方式进行编排
- 计划新增对脚本作业进行定时执行


#### 安装教程

1. 从gitee或github上拉取源码到本地，
2. 提供一个mysql环境版本>8，执行docs/schema下的helios.sql的建表脚本。
3. 提供一个redis服务实例
4. 从deploy文件中获取helios-server的部署文件，需要配置好mysql、redis等配置，后启动服务端。
5. 从deploy文件中获取helios-client的部署文件，在目标服务器启动客户端。
6. 登录控制台节点进行CI/CD等操作，默认账号：`helios`, 密码：`666666`
![功能界面](docs/images/func00.png "功能界面")


#### 使用文档
##### 1.CI/CD
- 构建一个部署节点，示例：java项目
   - 基础配置：选择对应客户端及其部署目录，服务端的工作目录（用来在服务端编译和打包对应项目）
   - 源码管理：配置对应项目的源码托管地址，如github、gitee、gitlab、svn等
   - 配置文件：可以在线添加配置文件对默认的配置文件进行替换，注意是替换
   - 构建环境：选择项目对应类型的构建环境，如java项目选择maven进行构建
   - 前置脚本：在部署前执行的脚本
   - 后置脚本：部署的脚本
   - 自动部署：开启自动部署，服务端会定时去源码托管的地方拉取最新的源码进行校对，如果发现有新的源码，则自动进行部署
     ![功能界面](docs/images/node.png "功能界面")
- 点击节点列表的开始按钮，即可开始部署，节点部署会进行部署等待队列，等待开始部署，可以点击查看部署进度
  ![功能界面](docs/images/func03.png "功能界面")


##### 2.编排部署
- 支持对多个节点进行编排部署，按顺序进行依次执行部署
  ![功能界面](docs/images/func05.png "功能界面")

##### 3.日志收集
- 支持创建目标服务器的日志收集节点
- 支持直接从已有客户端直接创建日志收集节点

##### 4.服务器监控
- 支持CPU使用率、内存使用率、磁盘使用率三个维度，在指定时间区间内触发次数达到阈值的时候，进行告警

##### 5.脚本作业
- 可以在目标服务器执行指定脚本，目前仅支持手动执行 

#### 最佳实践
- 集群模式下，建议配置三个以上节点

#### 功能界面
![功能界面](docs/images/func01.png "功能界面")
![功能界面](docs/images/func02.png "功能界面")
![功能界面](docs/images/func03.png "功能界面")
![功能界面](docs/images/func05.png "功能界面")
![功能界面](docs/images/func06.png "功能界面")
![功能界面](docs/images/func07.png "功能界面")
![功能界面](docs/images/func08.png "功能界面")
![功能界面](docs/images/func09.png "功能界面")
![功能界面](docs/images/func10.png "功能界面")
#### 参与贡献

1. 非常欢迎您来参与共建该项目，如果有什么建议和意见也欢迎提出。
2. 您可以 Fork 本仓库、新建 Feat_xxx 分支、提交代码、新建 Pull Request来参与本项目
3. 如果本代码对你有用，欢迎您给个star，谢谢！