TiDB适配OBS开源验证任务
1 背景介绍
开源for Huawei（参考：https://developer.huaweicloud.com/programs/opensource/contributing/） 通过和公司、高校、社区的开发者合作，完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发，帮助繁荣Huawei的基础生态，同时让开源软件能够更加简单、高效的运行于华为云上。
开始之前，开发者可以下载 开源for Huawei Wiki（参考：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview） 了解详细的开发步骤，技术准备，以及开发过程需要的各种资源。
2 需求分析
2.1 开源软件基本情况
1. TiDB是PingCAP公司自主设计研发的开源的分布式关系型数据库, 支持在线事务处理和在线分析处理(HTAP),具有水平扩容、高可用性、实时HTAP、云原生等特性。
- 所属社区: 个人/公司
- License: Apache-2.0 license。
- 源代码地址: https://github.com/pingcap/tidb。
- 官网主页：https://cn.pingcap.com/。
- 主要开发语言: Go。
- 用户使用情况：TiDB已经拥有3000多家企业用户，包括国内外各个行业的头部企业，尤其在金融行业、国有大行、保险等领域有广泛应用。适用于海量数据OLTP,实时HTAP,多数据中心多活场景。
2.项目数据：Fork 5.8K, Star 37K, Contributor 877，最近一次提交：2024-11-12
star历史（https://star-history.com/）：
2.2 任务目的和范围
本任务的主要目的是让TiDB支持华为云OBS服务，TiDB的备份数据存储到华为云OBS上，拓展OBS服务的影响力。方便TiDB的用户使用华为云服务时能够顺利对接OBS服务。
- 能力要求
完成该任务需要具备扎实GO语言开发经验，熟悉TiDB的设计原理和使用方法。最好能够熟悉华为云OBS相关生态。
- 适配任务清单
|
生态 |
生态细类 |
是否需要验证 |
验证逻辑说明 |
是否需要适配 |
适配场景说明 |
|
昇腾生态 |
指令 |
否 |
使用昇腾处理器运行应用。 |
否 |
使用昇腾指令实现适配逻辑。 |
|
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 工作量评估
|
任务 |
人/天 |
|
基于华为云ECS完成TiDB安装部署 |
1 |
|
完成OBS适配功能开发 |
0 |
|
完成DEMO设计和验证 |
1 |
|
输出开发资料和博客 |
2 |
|
代码推送上游社区和更新社区资料 |
1 |
|
总计 |
5人天 |
4 任务分解
4.1 完成OBS适配功能开发
- 不需要代码开发，只需执行命令，参考下面备份存储文档
方案：tiup br backup full -c=0 -u pd-service:2379 --storage 's3://bucket-name/prefix'
在备份时通过上面的命令设置存储后端
TiDB快速上手指南：https://docs.pingcap.com/zh/tidb/stable/quick-start-with-tidb
4.2 完成华为云OBS演示DEMO设计
1.执行完备份数据命令将TiDB数据备份到OBS
2.DEMO中实现一个REST接口：
查询备份结果接口（查询TiDB中数据是否成功备份到OBS）
参考下面的用例图：
DEMO的简单部署图如下：
4.3 DEMO开发、部署和验证
根据DEMO设计，完成演示功能开发和部署。要求使用CCE容器（Euler镜像）进行部署。
DEMO验证:
部署完成TiDB后，执行备份TiDB数据命令能将TiDB数据备份到OBS，请求查询备份结果接口，能返回备份成功的结果。如下DEMO验证页面填上数据备份接口和查询备份结果接口得到成功。
4.4 在华为云开发者论坛输出博客
访问华为云开发者论坛（参考：https://bbs.huaweicloud.com/blogs）发表博客，介绍完成这些任务的过程和心得。
内容包括不限于如下内容：
- 开源for Huawei的背景
- 开源软件的功能介绍
- 开发适配过程及碰到和解决的问题
- DEMO设计、开发、部署过程
- 代码推送开源社区及互动过程
博客打上如下标签：
- 开源（必选）
- 开发者（必选）
- GaussDB数据库（可选）
- 云数据库 GaussDB（可选）
- 鲲鹏（可选）
- 昇腾（可选）
- 鸿蒙（可选）
- 对象存储 OBS（可选）
4.5 代码推送上游社区
将代码合并到TiDB官网主干代码；更新TiDB官网资料，包括版本说明、开发指南等。
5 验收材料
|
验收细则 |
评分说明 |
是否为验收必选项 |
结果（通过/不通过） |
开发者举证 |
|
功能开发：完成与华为三大根技术生态（鲲鹏云、昇腾云、鸿蒙）适配的功能开发 |
完成华为云OBS服务适配功能开发。 |
是 |
|
|
|
代码质量：适配华为三大根技术生态的代码质量经过工具检测达标 |
推送给开源社区的代码符合开源社区关于代码风格、功能、自动化测试等要求。 |
是 |
|
|
|
提供相关文档，比如部署文档、使用文档、配置文档等 |
根据社区要求，完善相关的开发指南和部署指导 |
否 |
|
|
|
合入到开源项目主仓：代码推送上游社区 |
代码合并到当前主干分支。举证提供代码仓库链接。 |
是 |
|
|
|
Deomo设计&开发：完成功能演示Demo的开发 |
举证提供DEMO仓库地址和DEMO开发提交记录。 |
是 |
|
|
|
Demo部署&验证：完成功能演示DEMO基于华为云鲲鹏环境的部署和功能验证 |
提供DEMO部署验证结果的关键截图进行举证。提供DEMO运行环境和资源的规格清单。 |
是 |
|
|
|
发布博客：发布博客介绍适配心得。 |
提供博客的地址。 |
是 |
|
|
|
制作单机版无高危开源镜像。 |
上架云商店。 |
否 |
|
|
|
单机版镜像上架时支持模板部署。 |
|
否 |
|
|
|
制作集群版无高危开源镜像 |
上架云商店。 |
否 |
|
|
|
集群版镜像上架时支持模板部署 |
|
否 |
|
|
6 参考资料
1.开源for Huawei介绍、环境搭建、示例项目、开发和部署指南：
https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview
2.完成任务过程中，碰到问题可以在这里查询或者提问：
https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/issues
3.Spring Data JPA适配GaussDB开源验证任务心得：
https://bbs.huaweicloud.com/blogs/438331
- 点赞
- 收藏
- 关注作者
评论（0）