HummerRisk 入门 3:开发手册
本文是 HummerRisk 的开发手册,介绍项目的结构及如何配置 HummerRisk 的开发环境和开发中的注意事项,快速参与到 HummerRisk 项目的开发中来。
一、项目结构
二、配置开发环境
1、环境准备
后端
HummerRisk 后端使用了 Java 语言的 Spring Boot 框架,并使用 Maven 作为项目管理工具。开发者需要先在开发环境中安装 JDK 11 及 Maven。
前端
HummerRisk 前端使用了 Vue.js 作为前端框架,ElementUI 作为 UI 框架,并使用 npm 或 yarn 作为包管理工具。开发者请先下载 Node.js 或 Yarn 作为运行环境,IDEA 用户建议安装 Vue.js 插件,便于开发
安装 npm 或 yarn
进入网站 https://nodejs.org/en/download 或 https://yarn.bootcss.com/docs/install, 选择相应的安装包进行安装即可。
2、初始化配置
数据库初始化
HummerRisk 使用 MySQL 数据库,推荐使用 MySQL 5.7 版本。同时 hummerrisk 对数据库部分配置项有要求,请参考下附的数据库配置,修改开发环境中的数据库配置文件
注意:Windows 系统数据库初始化配置应删除 innodb_flush_method 参数,请参考文章[1]。
请参考文档中的建库语句创建 HummerRisk 使用的数据库,HummerRisk 服务启动时会自动在配置的库中创建所需的表结构及初始化数据。
配置文件
HummerRisk 会默认加载该路径下的配置文件 /opt/hummerrisk/conf/hummerrisk.properties,请参考下列配置创建对应目录及配置文件,请参考下面配置创建对应目录及配置文件。提示: 请自行将 MYSQL_HOST 配置为自己的 MySQL 地址。
三、代码运行
1、IDEA 方式运行
注意:在 Windows 环境下对配置文件的路径会有所要求,一般可以采用下面配置方案,非 Windows 环境以下方案可跳过。
Windows 下环境配置方案
将配置文件放置到工程源码的所在盘的指定路径下,以 hummerrisk.properties 配置文件举例,如源码工程在 D 盘下,则配置文件存放路径为 d:\opt\hummerrisk\conf\hummerrisk.properties。其他配置文件类似。
配置文件可以随意放置在任意路径下,但需要修改工程源码中配置文件的路径信息。以 hummerrisk.properties 配置文件举例,如该配置文件存放在 D 盘根目录下,则需要按下图修改两个地方的配置路径。
新建项目
新建一个 git 项目 输入主工程 git 地址: git@github.com:HummerRisk/HummerRisk.git
配置 maven
配置 maven 并引入 pom.xml。
启动项目
在启动配置中添加 Spring Boot 启动项,直接启动 Spring Boot 项目即可。
启动后端,两种启动方式:
可以使用 io.hummerrisk.Application 入口方法直接启动
可以使用 maven 插件中的 backend>spring-boot>spring-boot:start 启动
运行后端服务
后端服务成功运行如下所示。
配置前端
进入 hummerrisk/frontend/ 目录,执行以下命令安装相关前端组件。
进入到 hummerrisk/frontend/ 目录,执行以下命令启动前端服务。
或者使用 yarn 启动
运行前端服务
前端服务成功运行如下所示。
四、本地安装引擎组件
1、准备运行环境
注意: 若需要调试相应的检测功能,需要安装相应的组件引擎
Cloud Custodian 作为云平台检测引擎,详细的相关操作,请参考 Cloud Custodian [2]
Prowler 作为 AWS 检测引擎,详细的相关操作,请参考 Prowler [3]
Nuclei 作为漏洞检测引擎,详细的相关操作,请参考 Nuclei [4]
Xray 作为漏洞检测引擎,详细的相关操作,请参考 Xray [5]
Trivy 作为云原生检测引擎 ,详细的相关操作,请参考 Trivy [6]
配置本地目录和配置文件
下载 installer 工程:
初始化目录:
准备配置文件:
2、安装引擎
注意:以下组件引擎的安装可以按需进行,这里仅列举 Custodian 和 Trivy ,其他的请参考对应的链接。
安装 Custodian
安装 Trivy
Yum 源方式安装
rpm 方式安装
二进制方式安装
五、镜像打包
源码中包含 Dockerfile 文件,建议将项目打包成镜像运行,建议 Dockerfile_base 打包用官方版本即可, 用户可以替换自己的 Dockerfile 研发版本。
其他注意事项
内置示例数据以 flyway 的形式在 HummerRisk 启动时自动插入到了 MySQL 数据库中,在源码运行的情况下可自动初始化获取内置检测规则等数据;
参考资料
[1]https://bugs.mysql.com/bug.php?id=40757
[2]https://docs.hummerrisk.com/related/opensource-tool/custodian/
[3]https://docs.hummerrisk.com/related/opensource-tool/prowler/
[4]https://docs.hummerrisk.com/related/opensource-tool/nuclei/
[5]https://docs.hummerrisk.com/related/opensource-tool/xray/
[6]https://docs.hummerrisk.com/related/opensource-tool/trivy/
关于 HummerRisk
HummerRisk 是开源的云原生安全平台,以非侵入的方式解决云原生的安全和治理问题。核心能力包括混合云的安全治理和 K8s 容器云安全检测。
GitHub 地址:https://github.com/HummerRisk/HummerRisk
版权声明: 本文为 InfoQ 作者【HummerCloud】的原创文章。
原文链接:【http://xie.infoq.cn/article/59e0fa47170af6b708a02b093】。文章转载请联系作者。
评论