NSQ适配GaussDB开源开发任务
背景介绍
开源for Huawei(参考:https://developer.huaweicloud.com/programs/opensource/contributing/) 通过和公司、高校、社区的开发者合作,完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发,帮助繁荣Huawei的基础生态,同时让开源软件能够更加简单、高效的运行于华为云上。
开始之前,开发者可以下载 开源for Huawei Wiki(参考:https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview) 了解详细的开发步骤,技术准备,以及开发过程需要的各种资源。
1 需求分析
1.1 项目影响力
NSQ是一个实时的分布式消息处理平台,去中心化且无单点故障的拓扑结构,具有高可用、高可靠和高性能的特点。NSQ在异步处理、应用解耦、流量削峰等方面具有广泛的应用。
项目数据:Fork 2.9k,Star 24.9k,Contributors 130+,最近一次提交:2024-05-12
主要开发语言:
• GO 83.3%
• JavaScript 6.5%
维护者:NSQ数据团队
源代码仓库:https://github.com/nsqio/nsq
star历史(https://star-history.com/):
1.2 任务目的和范围
本任务的主要目的是让NSQ支持华为云 GuassDB数据库,拓展GuassDB数据库的影响力,让NSQ的用户使用华为云服务时能够顺利对接GuassDB数据库。同时,该任务也可以方便用户在云上做方案选型的时候,可以选择华为云GuassDB数据库。NSQ是一个开源的实时分布式内存消息队列,由Go语言编写,旨在大规模地处理每天数以十亿计级别的消息。
- 适配任务清单
生态 |
生态细类 |
是否需要验证 |
验证逻辑说明 |
是否需要适配 |
适配场景说明 |
昇腾生态 |
指令 |
否 |
使用昇腾处理器运行应用。 |
否 |
使用昇腾指令实现适配逻辑。 |
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系统调用实现适配逻辑 |
2 工作量评估和任务分解
2.1 工作量评估
任务 |
人/天 |
基于华为云ECS完成 NSQ安装和部署 |
1 |
完成GaussDB适配功能开发 |
5 |
完成DEMO设计和验证 |
2 |
输出开发资料和博客 |
1 |
代码推送上游社区和更新社区资料 |
1 |
总计 |
10人天 |
2.2 基于华为云ECS完成NSQ安装和部署
华为云部署参考:
NSQ系统架构图:
参考:
代码仓库:https://github.com/nsqio/nsq
2.3 完成GuassDB数据库适配功能开发
参考现有NSQ的架构,完成两个功能点的分析和适配工作。
- NSQ可以读取GaussDB数据库内的数据,存储到生产者端。
- NSQ通过消费者写入数据到GaussDB数据库内。
参考:
学习参考:https://zhuanlan.zhihu.com/p/665893174
官方文档:https://nsq.io/overview/design.html
2.4 完成DEMO设计和验证
- NSQ读取GaussDB的数据并且存储到生产者端,在nsqadmin启动后,通过端口:4171页面浏览topic、channel相关信息,查询成功并返回预期的查询结果。
- NSQ通过消费者把数据写入GaussDB,查询成功并返回预期的查询结果。
2.5 在华为云开发者论坛输出博客
访问华为云开发者论坛(参考:https://bbs.huaweicloud.com/blogs)发表博客,介绍完成这些任务的过程和心得。
内容包括不限于如下内容:
- 开源for Huawei的背景
- 开源软件的功能介绍
- 开发适配过程及碰到和解决的问题
- DEMO设计、开发、部署过程
- 代码推送开源社区及互动过程
博客打上如下标签:
- 开源(必选)
- 开发者(必选)
- GaussDB数据库(可选)
- 云数据库 GaussDB(可选)
- 鲲鹏(可选)
- 昇腾(可选)
- 鸿蒙(可选)
- 对象存储 OBS(可选)
2.6 代码推送上游社区
将代码合并到NSQ官网主干代码,更新NSQ官网资料,包括版本说明、开发指南等。
3 验收材料
验收细则 |
评分说明 |
是否为验收必选项 |
结果(通过/不通过) |
开发者举证 |
功能开发:完成与华为三大根技术生态(鲲鹏云、昇腾云、鸿蒙)适配的功能开发 |
完成GaussDB数据库适配功能开发。举证提供PR链接。 |
是 |
|
|
代码质量:适配华为三大根技术生态的代码质量经过工具检测达标 |
推送给开源社区的代码符合开源社区关于代码风格、功能、自动化测试等要求。 |
是 |
|
|
提供相关文档,比如部署文档、使用文档、配置文档等 |
根据社区要求,完善相关的开发指南和部署指导 |
否 |
|
|
合入到开源项目主仓:代码推送上游社区 |
代码合并到当前主干分支。举证提供代码仓库链接。 |
是 |
|
|
Deomo设计&开发:完成功能演示Demo的开发 |
举证提供DEMO仓库地址和DEMO开发提交记录。 |
是 |
|
|
Demo部署&验证:完成功能演示DEMO基于华为云鲲鹏环境的部署和功能验证 |
提供DEMO部署验证结果的关键截图进行举证。提供DEMO运行环境和资源的规格清单。 |
是 |
|
|
发布博客:发布博客介绍适配心得。 |
提供博客的地址。 |
是 |
|
|
制作单机版无高危开源镜像。 |
上架云商店。 |
否 |
|
|
单机版镜像上架时支持模板部署。 |
|
否 |
|
|
制作集群版无高危开源镜像 |
上架云商店。 |
否 |
|
|
集群版镜像上架时支持模板部署 |
|
否 |
|
|
4 参考资料
- 开源for Huawei介绍、环境搭建、示例项目、开发和部署指南:https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview
- NSQ 开源软件 For Huawei 临时代码仓库参考:https://github.com/nsqio/nsq
- 点赞
- 收藏
- 关注作者
评论(0)