CoreDNS适配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. CoreDNS 是一款开源的 DNS 服务器软件。它具有高度可扩展、性能优越等特点，通过插件机制可满足不同需求，在容器化环境尤其是 Kubernetes 中广泛应用。
主要功能：
DNS解析：支持标准的 DNS 解析操作，能够解析常见的记录类型如 A、AAAA、CNAME、MX 等。
插件架构：CoreDNS 的功能通过插件实现，用户可以根据需要启用或禁用不同的插件。这种插件化架构允许灵活组合功能，例如缓存、负载均衡、服务发现等。
服务发现：特别适合 Kubernetes 环境，CoreDNS 可以作为 Kubernetes 默认的 DNS 服务器，提供服务发现功能，自动解析集群中的服务名称并提供负载均衡。
缓存：可以缓存 DNS 查询结果，以减少查询外部 DNS 服务器的频率，从而提升性能。
负载均衡：在多个 DNS 查询结果之间均匀分配请求负载，提升系统的整体可用性和效率。
反向代理：通过代理请求到上游 DNS 服务器，CoreDNS 充当递归 DNS 服务器，适用于私有网络和复杂的 DNS 解析场景。
集成其它系统：CoreDNS 可以通过插件与外部系统集成，如 etcd、Kubernetes、Consul 等，实现动态服务发现和配置管理。
• 所属社区：Cloud Native Computing Foundation (CNCF) 社区 。
• License：Apache License 2.0。
• 源代码地址：https://github.com/coredns/coredns。
• 官网主页：https://coredns.io/。
• 主要开发语言：Go。
• 用户使用情况：CoreDNS 在用户中得到广泛应用。许多企业和组织利用它为内部网络提供高效的域名解析服务，其可扩展性通过插件满足了复杂网络环境的需求。在容器化场景尤其是 Kubernetes 中，CoreDNS 作为默认的 DNS 服务，确保容器之间及容器与外部的通信顺畅。同时，开源社区的活跃也为用户提供了技术支持和持续的改进，使得 CoreDNS 成为众多用户在 DNS 服务方面的可靠选择。
• 主要商业价值：
▪ 降低成本：作为开源项目，企业使用 CoreDNS 无需支付高昂的商业许可费用，大大降低了在 DNS 服务器软件方面的投入成本。
▪ 提升服务质量与效率：在处理大量的 DNS 请求时，CoreDNS 能够快速响应，保证较低的延迟和较高的吞吐量。CoreDNS 的插件架构允许企业根据自身的特定需求定制功能。
▪ 便于管理与维护：使用名为 Caddyfile 的配置文件格式，简单易懂，易于编写和维护。这使得企业的运维人员可以更快速地进行配置和管理，降低了学习成本和管理难度。
▪ 业务拓展与创新：对于企业开展的一些新业务，如物联网、边缘计算等，CoreDNS 的高性能、多协议支持和灵活的插件架构能够为这些业务提供稳定的 DNS 服务，帮助企业快速拓展业务领域。
2. 项目数据：Fork 2.1K, Star 12.3K, Contributor 332，最近一次提交：2024-10-12 star历史（https://star-history.com/）：
2.2 任务目的和范围
本任务的主要目的是让CoreDNS支持华为云 OBS服务，拓展华为云OBS服务的影响力，方便CoreDNS的用户使用华为云服务时能够顺利对接OBS服务。同时，该任务也可以为一线的项目迁移时候的改造适配打下基础，方便用户在云上做方案选型的时候，可以选择华为云OBS服务，缩短开发周期，保证项目迁移进度，降低开发上云成本。
能力要求
完成该任务需要具备Go开发经验，熟悉CoreDNS的设计架构与使用。最好能够熟悉华为云OBS相关生态。能够部署搭建CoreDNS环境，演示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 工作量评估和任务分解
3.1 工作量评估
|
任务 |
人/天 |
|
完成华为云OBS适配功能开发 |
2 |
|
完成DEMO设计和代码开发 |
1 |
|
基于CCE容器完成环境搭建和DEMO部署、验证 |
1 |
|
输出开发资料和博客 |
1 |
|
代码推送上游社区和更新社区资料 |
2 |
|
总计 |
7人天 |
3.2 完成OBS服务适配功能开发
• 适配 CoreDNS 与华为云 OBS（对象存储服务），可以通过自定义插件的方式来实现。
• 基于CoreDNS的仓库源码，我们可以将自定义的OBS插件放到https://github.com/coredns/coredns/tree/master/plugin plugin目录下，每个 CoreDNS 插件必须实现 plugin.Handler 接口，这个接口包含一个方法 ServeDNS，用于处理 DNS 请求。
• 为了让插件能够与 OBS 进行交互，需要初始化 OBS SDK 并创建相关实例。
• CoreDNS 通过 plugin.cfg 文件注册插件。将 obs 插件注册到 CoreDNS 插件链中。现在这个插件将被 CoreDNS 在启动时加载并使用。
• 要确保 CoreDNS 加载你创建的插件，还需要在启动文件中导入该插件。
• 当所有插件逻辑和注册工作完成后，重新编译 CoreDNS，生成一个新的 coredns 可执行文件，已经包含了你的 obs 插件。
• 配置 CoreDNS Corefile，启动 CoreDNS 来测试插件是否正常工作。在启动之后，发送 DNS 查询来测试 obs 插件的响应，使用 dig 或 nslookup 测试 DNS 查询。
• 可以在https://github.com/coredns/coredns/tree/master/test test目录下通过模拟 DNS 请求和 OBS API 响应，可以对插件的功能编写相关测试文件。
参考：
可能涉及到的OBS SDK API如下表：
|
API名称 |
描述说明 |
|
ListBuckets |
列出所有存储桶 |
|
ListObjects |
列出存储桶中的对象 |
|
GetObject |
获取某个对象的内容 |
|
GetObjectMetadata |
获取对象元数据 |
|
PutObject |
上传对象到存储桶 |
|
DeleteObject |
删除存储桶中的对象 |
|
CreateBucket |
创建存储桶 |
|
DeleteBucket |
删除存储桶 |
华为云OBS Go SDK：https://support.huaweicloud.com/sdk-go-devg-obs/obs_33_0001.html
CoreDNS插件实现原理: https://zyy.rs/post/coredns-plugin-system-implementation/
CoreDNS插件编写: https://andblog.cn/3236
3.3 完成华为云OBS演示DEMO设计
参考下面的用例图：
DEMO的简单部署图如下：
3.4 DEMO开发、部署和验证
根据DEMO设计，完成演示功能开发和部署。要求使用CCE容器（Euler镜像）进行部署。
DEMO验证:
管理前端需要与后端服务进行交互，发送与 DNS 解析相关的请求。后端服务将会利用 CoreDNS 的自定义 OBS 插件处理这些请求，并返回解析结果。
后端服务需要配置来和 CoreDNS OBS 插件通信。后端服务会接收来自前端的请求，然后利用 CoreDNS 提供的 DNS 解析服务。
如果域名（如 bucket.obs.local）被 CoreDNS OBS 插件成功解析，并返回正确的 IP 地址或相关的 OBS 信息，说明插件工作正常。
编写相关集成测试，通过前端页面验证的方式，可以直观地验证 CoreDNS OBS 插件的工作情况。同时，后端也可以通过日志记录的方式监控 DNS 请求和解析的状态，确保插件能够与 OBS 正常交互。
为了简化用户开发，提供了一个项目脚手架。开发者可以在脚手架基础上，完成DEMO功能开发。可以参考： https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/blob/main/README.md 提供的指导，可以帮助您在华为云开通资源、编译DEMO和基于DEMO做增量代码开发。
3.5 在华为云开发者论坛输出博客
访问华为云开发者论坛（参考：https://bbs.huaweicloud.com/blogs）发表博客，介绍完成这些任务的过程和心得。内容包括不限于如下内容：
·开源for Huawei的背景
·开源软件的功能介绍
·开发适配过程及碰到和解决的问题
·DEMO设计、开发、部署过程
·代码推送开源社区及互动过程
博客打上如下标签：
·开源（必选）
·开发者（必选）
·GaussDB数据库（可选）
·云数据库 GaussDB（可选）
· 鲲鹏（可选）
·昇腾（可选）
·鸿蒙（可选）
·对象存储 OBS（可选）
3.6 代码推送上游社区
将代码合并到CoreDNS官网主干代码；更新CoreDNS官网资料，包括版本说明、开发指南等。
4 验收材料
|
验收细则 |
评分说明 |
是否为验收必选项 |
结果（通过/不通过） |
开发者举证 |
|
功能开发：完成与华为三大根技术生态（鲲鹏云、昇腾云、鸿蒙）适配的功能开发 |
完成华为云OBS适配功能开发。举证提供PR链接。 |
是 |
||
|
代码质量：适配华为三大根技术生态的代码质量经过工具检测达标 |
推送给开源社区的代码符合开源社区关于代码风格、功能、自动化测试等要求。 |
是 |
||
|
提供相关文档，比如部署文档、使用文档、配置文档等 |
根据社区要求，完善相关的开发指南和部署指导 |
否 |
||
|
合入到开源项目主仓：代码推送上游社区 |
代码合并到当前主干分支。举证提供代码仓库链接。 |
是 |
||
|
Deomo设计&开发：完成功能演示Demo的开发 |
举证提供DEMO仓库地址和DEMO开发提交记录。 |
是 |
||
|
Demo部署&验证：完成功能演示DEMO基于华为云鲲鹏环境的部署和功能验证 |
提供DEMO部署验证结果的关键截图进行举证。提供DEMO运行环境和资源的规格清单。 |
是 |
||
|
发布博客：发布博客介绍适配心得。 |
提供博客的地址。 |
是 |
||
|
制作单机版无高危开源镜像。 |
上架云商店。 |
否 |
||
|
单机版镜像上架时支持模板部署。 |
否 |
|||
|
制作集群版无高危开源镜像 |
上架云商店。 |
否 |
||
|
集群版镜像上架时支持模板部署 |
否 |
5 参考资料
1. 开源for Huawei介绍、环境搭建、示例项目、开发和部署指南：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview
- 点赞
- 收藏
- 关注作者
评论（0）