Consul适配GaussDB开源开发任务
1 背景介绍
开源for Huawei（参考：https://developer.huaweicloud.cn/programs/opensource/contributing/）通过和公司、高校、社区的开发者合作，完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发，帮助繁荣Huawei的基础生态，同时让开源软件能够更加简单、高效的运行于华为云上。
开始之前，开发者可以下载 开源for Huawei Wiki（参考：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview） 了解详细的开发步骤，技术准备，以及开发过程需要的各种资源。
2 需求分析
2.1 开源软件基本情况
Consul 是一个由 HashiCorp 开发的开源工具，用于服务发现和配置管理，特别适用于现代微服务架构。它支持分布式系统的服务注册、发现、健康检查、键值存储、以及服务之间的通信。Consul 可以在本地环境或云环境中运行，提供高可用的服务注册和健康检查功能。
源码地址：https://github.com/hashicorp/consul
官网主页：https://www.consul.io/
主要开发语言：Go
LICENSE：BUSL-1.1
维护者：HashiCorp
项目数据：Fork 4.4K, Star 28.5K, Contributor 915，最近一次提交：2024-11-27 star历史（https://star-history.com/）：
2.2 任务目的和范围
本任务的主要目的是使用Consul作为GaussDB相关服务发现与健康检查，通过 Consul 提供的服务发现、健康检查，可以帮助确保 GaussDB 与其他微服务的高效、可靠和安全的协同工作。通过服务发现和健康检查功能保证系统的稳定性和可靠性。
能力要求
完成该任务需要具备微服务开发经验，熟悉Consul的设计原理和使用方法。最好熟悉一门Go web开发框架（例如go-zero）。开发过程中主要使用Go语言，演示DEMO会涉及少量的Vue、TypeScirpt前端（可选）。
适配任务清单
|
生态 |
生态细类 |
是否需要验证 |
验证逻辑说明 |
是否需要适配 |
适配场景说明 |
|
昇腾生态 |
指令 |
否 |
使用昇腾处理器运行应用。 |
否 |
使用昇腾指令实现适配逻辑。 |
|
CANN |
否 |
应用功能依赖于CANN运行。 |
否 |
使用CANN实现适配逻辑。 |
|
|
MindSpore |
否 |
应用功能依赖于MindSpore运行。 |
否 |
使用MindSpore实现适配逻辑。 |
|
|
鲲鹏生态 |
指令 |
是 |
使用鲲鹏处理器运行应用。 |
否 |
使用鲲鹏指令实现适配逻辑。 |
|
Euler |
是 |
使用Euler系统运行应用。 |
否 |
使用Euler系统调用实现适配逻辑。 |
|
|
数据库生态 |
GaussDB |
是 |
使用GaussDB功能。 |
是 |
使用GaussDB的驱动和SQL实现适配逻辑。 |
|
GaussDB(DWS) |
否 |
使用GaussDB（DWS）功能。 |
否 |
使用GaussDB(DWS)的驱动和SQL实现适配逻辑。 |
|
|
存储生态 |
OBS |
否 |
使用OBS功能。 |
否 |
基于OBS API访问实现适配逻辑。 |
|
鸿蒙生态 |
HarmonyOS |
否 |
使用HarmonyOS系统运行应用。 |
否 |
使用HarmonyOS系统调用实现适配逻辑。 |
3 工作量评估
|
任务 |
人/天 |
|
完成GaussDB数据库适配功能开发 |
2 |
|
完成DEMO设计和功能验证 |
1 |
|
基于CCE容器完成环境搭建和DEMO验证 |
2 |
|
输出开发资料和博客 |
1 |
|
总计 |
6人天 |
4 任务分解
4.1 完成GaussDB数据库适配功能开发
1. 使用 go zero （或者其它框架）创建，对外的 api 和对内部的 rpc 微服务。
2. 创建一个用于检测GaussDB健康检查的服务，和一个用户的服务，其中用户服务需要支持GaussDB作为后端存储实现用户服务的CURD。
3. GaussDB的健康检查服务为gauss-rpc和gauss-api，用户服务为user-api和user-rpc。
4. 启动Consul，然后分别zai rpc 和 api 中的配置文件中添加配置，分别启动 api 和 rpc 服务后，在Consul Services中可以看到 gauss-rpc 服务和 user-rpc 服务已经被注册和发现了。
参考：
go zero使用Consul：https://github.com/zeromicro/zero-contrib/tree/main/zrpc/registry/consul
go zero使用Consul作为注册中心： https://blog.csdn.net/qq_27229113/article/details/128816344
4.2 完成GaussDB演示DEMO设计
参考下面的用例图：
4.3 DEMO开发、部署和验证
根据DEMO设计，完成演示功能开发和部署。要求使用ECS或者CCE容器（Euler镜像）进行部署。
4.4 在华为云开发者论坛输出博客
访问华为云开发者论坛（参考：https://bbs.huaweicloud.cn/blogs）发表博客，介绍完成这些任务的过程和心得。内容包括不限于如下内容：
·开源for Huawei的背景
·开源软件的功能介绍
·开发适配过程及碰到和解决的问题
·DEMO设计、开发、部署过程
·代码推送开源社区及互动过程
博客打上如下标签：
·开源（必选）
·开发者（必选）
·GaussDB数据库（可选）
·云数据库 GaussDB（可选）
· 鲲鹏（可选）
·昇腾（可选）
·鸿蒙（可选）
·对象存储 OBS（可选）
4.5 代码推送上游社区
将代码合并到Consul官网主干代码；更新Consul官网资料，包括版本说明、开发指南等。
4 验收材料
|
验收细则 |
评分说明 |
是否为验收必选项 |
结果（通过/不通过） |
开发者举证 |
|
功能开发：完成与华为三大根技术生态（鲲鹏云、昇腾云、鸿蒙）适配的功能开发和验证。 |
完成GaussDB数据库适配功能开发。举证提供PR链接。 |
是 |
||
|
代码质量：适配华为三大根技术生态的代码质量经过工具检测达标 |
推送给开源社区的代码符合开源社区关于代码风格、功能、自动化测试等要求。 |
是 |
||
|
提供相关文档，比如部署文档、使用文档、配置文档等 |
根据社区要求，完善相关的开发指南和部署指导 |
否 |
||
|
合入到开源项目主仓：代码推送上游社区 |
代码合并到当前主干分支。举证提供代码仓库链接。 |
是 |
||
|
Deomo设计&开发：完成功能演示Demo的开发 |
举证提供DEMO仓库地址和DEMO开发提交记录。 |
是 |
||
|
Demo部署&验证：完成功能演示DEMO基于华为云鲲鹏环境的部署和功能验证 |
提供DEMO部署验证结果的关键截图进行举证。提供DEMO运行环境和资源的规格清单。 |
是 |
||
|
发布博客：发布博客介绍适配心得。 |
提供博客的地址。 |
是 |
||
|
制作单机版无高危开源镜像。 |
上架云商店。 |
否 |
||
|
单机版镜像上架时支持模板部署。 |
否 |
|||
|
制作集群版无高危开源镜像 |
上架云商店。 |
否 |
||
|
集群版镜像上架时支持模板部署 |
否 |
5 参考资料
1. 开源for Huawei介绍、环境搭建、示例项目、开发和部署指南：
https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview
2. 完成任务过程中，碰到问题可以在这里查询或者提问：
https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/issues
- 点赞
- 收藏
- 关注作者
评论（0）