CNCF Containerd适配OBS开源开发任务
1 背景介绍
开源for Huawei（参考：https://developer.huaweicloud.cn/programs/opensource/contributing/）通过和公司、高校、社区的开发者合作，完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发，帮助繁荣Huawei的基础生态，同时让开源软件能够更加简单、高效的运行于华为云上。
开始之前，开发者可以下载 开源for Huawei Wiki（参考：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview） 了解详细的开发步骤，技术准备，以及开发过程需要的各种资源。
2 需求分析
2.1 开源软件基本情况
1. Containerd 是一个高性能的容器运行时，用于管理容器的生命周期。它专注于为上层容器引擎（如 Docker 和 Kubernetes）提供基础设施，包括镜像传输、存储、网络、日志等核心功能。它简洁、高效，已经成为云原生生态中不可或缺的一部分。
主要功能：
容器生命周期管理 ：负责创建和启动容器，配置容器的资源限制、网络设置等。监控容器的运行状态，能够暂停、恢复和停止容器。在容器退出时，进行适当的清理工作，回收资源。
镜像管理 ：支持OCI镜像和Docker镜像。提高镜像的推送、拉取、存储和管理功能。支持多种镜像传输协议和存储后端（如文件系统、S3等）。
快照管理：使用 snapshotter 机制管理容器文件系统快照，实现写时复制（Copy-on-Write）。支持多种快照后端（如 OverlayFS、Btrfs、ZFS、Devmapper）。
网络管理：支持与 CNI（容器网络接口）集成，提供容器网络管理功能。能够配置容器的网络命名空间和网络堆栈。
多平台支持：提供对多种操作系统和硬件架构的支持，如 Linux、Windows 以及 ARM 架构。
插件化设计：containerd 采用模块化设计，允许开发者为其编写插件，扩展其功能。
· 所属社区：Cloud Native Computing Foundation (CNCF) 社区 。
· License：Apache License 2.0。
· 源代码地址：https://github.com/containerd/containerd。
· 官网主页：https://containerd.io/。
· 主要开发语言：Go。
· 用户使用情况：与 Kubernetes 等流行容器编排系统深度集成，提供高效稳定的容器运行环境，提升集群性能。被各大云服务平台用于构建容器化基础设施，实现高效管理和调度容器，提高资源利用率并降低成本。许多企业在内部应用容器化部署中选择 Containerd，提高部署效率、可移植性及便于管理维护，在金融、电信、电商等行业应用较多。部分开发者在本地开发和测试环境中使用 Containerd 提供的命令行工具和 API 操作管理容器。
· 主要商业价值：
▪ 高效和稳定的容器运行时：containerd 提供了高效的容器管理方式，成为了 Docker 和 Kubernetes 的默认运行时。
▪ 云 原生的核心组件 ：随着容器技术在企业中的广泛应用，containerd 成为云原生架构的基石。
▪ 灵活的容器基础设施：containerd 的模块化设计和对不同存储、网络、快照等后端的支持，使企业可以根据自己的需求自定义容器运行环境。
▪ 企业级应用场景：containerd 的高性能和简洁性使其适合在企业级环境中进行大规模部署。
2. 项目数据：Fork 3.4K, Star 17.3K, Contributor 332，最近一次提交：2024-10-09 star历史（https://star-history.com/）：
2.2 任务目的和范围
本任务的主要目的是让Containerd支持华为云 OBS服务，拓展华为云OBS服务的影响力，方便Containerd的用户使用华为云服务时能够顺利对接OBS服务。同时，该任务也可以为一线的项目迁移时候的改造适配打下基础，方便用户在云上做方案选型的时候，可以选择华为云OBS服务，缩短开发周期，保证项目迁移进度，降低开发上云成本。
能力要求
完成该任务需要具备Go开发经验，熟悉Containerd的设计架构与使用。最好能够熟悉华为云OBS相关生态。能够部署搭建Containerd环境，演示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适配功能开发 |
1 |
|
完成DEMO设计和代码开发 |
1 |
|
基于CCE容器完成环境搭建和DEMO部署、验证 |
1 |
|
输出开发资料和博客 |
1 |
|
代码推送上游社区和更新社区资料 |
1 |
|
总计 |
5人天 |
3.2 完成OBS服务适配功能开发
• containerd 通过插件架构实现功能扩展，其中存储快照（snapshotter）是负责管理容器镜像层（Layer）的插件。OBS 作为后端存储需要自定义开发 snapshotter 插件，用于将容器镜像层存储到 OBS 中。
• Snapshotter：负责管理镜像的快照。将为 OBS 开发一个自定义的 snapshotter 插件。使用 Go 编写一个新的 snapshotter 插件，该插件需要实现 containerd 提供的接口，并使用华为云 OBS 的 SDK 进行对象存储交互。
• 实现 Snapshotter 的接口，例如Prepare, Commit, Remove等函数。每个函数需要对接华为云 OBS 的 API 来进行对象存储操作。具体来说，存储容器镜像层时，将数据上传到 OBS；删除容器镜像层时，从 OBS 删除相关数据。
• 注册插件在你的插件中需要调用 containerd 的插件注册机制，将你的 snapshotter 插件注册到 containerd，这样它可以识别并使用你自定义的 OBS 插件。
参考：
华为云OBS Go SDK：https://support.huaweicloud.cn/sdk-go-devg-obs/obs_33_0001.html
Containerd中的Snapshot：https://xie.infoq.cn/article/cefa758a7989cfc7885a7fb04
3.3 完成华为云OBS演示DEMO设计
参考下面的用例图：
DEMO的简单部署图如下：
3.4 DEMO开发、部署和验证
根据DEMO设计，完成演示功能开发和部署。要求使用CCE容器（Euler镜像）进行部署。
DEMO验证:
启动 Containerd 后使用 ctr 工具来查件插件是否正确加载，如果 obs 插件状态为 ok， 表示加载成功。
通过 ctr 拉取容器镜像，观察镜像层是否正确上传到 OBS 存储中，在华为云 OBS 控制台检查相应的桶中是否有镜像层（Layer）的对象文件。
运行基于该镜像的容器，验证从 OBS 下载镜像层并启动容器，如果容器启动成功，表明镜像层能够从 OBS 成功下载并运行。
检查 containerd 的日志文件，日志中应显示 OBS 插件与华为云 OBS 成功通信的记录，如对象上传、下载等操作的成功执行等。
为了简化用户开发，提供了一个项目脚手架。开发者可以在脚手架基础上，完成DEMO功能开发。可以参考： https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/blob/main/README.md 提供的指导，可以帮助您在华为云开通资源、编译DEMO和基于DEMO做增量代码开发。
3.5 在华为云开发者论坛输出博客
访问华为云开发者论坛（参考：https://bbs.huaweicloud.cn/blogs）发表博客，介绍完成这些任务的过程和心得。内容包括不限于如下内容：
·开源for Huawei的背景
·开源软件的功能介绍
·开发适配过程及碰到和解决的问题
·DEMO设计、开发、部署过程
·代码推送开源社区及互动过程
博客打上如下标签：
·开源（必选）
·开发者（必选）
·GaussDB数据库（可选）
·云数据库 GaussDB（可选）
· 鲲鹏（可选）
·昇腾（可选）
·鸿蒙（可选）
·对象存储 OBS（可选）
3.6 代码推送上游社区
将代码合并到Containerd官网主干代码；更新Containerd官网资料，包括版本说明、开发指南等。
4 验收材料
|
验收细则 |
评分说明 |
是否为验收必选项 |
结果（通过/不通过） |
开发者举证 |
|
功能开发：完成与华为三大根技术生态（鲲鹏云、昇腾云、鸿蒙）适配的功能开发 |
完成华为云OBS适配功能开发。举证提供PR链接。 |
是 |
|
|
|
代码质量：适配华为三大根技术生态的代码质量经过工具检测达标 |
推送给开源社区的代码符合开源社区关于代码风格、功能、自动化测试等要求。 |
是 |
|
|
|
提供相关文档，比如部署文档、使用文档、配置文档等 |
根据社区要求，完善相关的开发指南和部署指导 |
否 |
|
|
|
合入到开源项目主仓：代码推送上游社区 |
代码合并到当前主干分支。举证提供代码仓库链接。 |
是 |
|
|
|
Deomo设计&开发：完成功能演示Demo的开发 |
举证提供DEMO仓库地址和DEMO开发提交记录。 |
是 |
|
|
|
Demo部署&验证：完成功能演示DEMO基于华为云鲲鹏环境的部署和功能验证 |
提供DEMO部署验证结果的关键截图进行举证。提供DEMO运行环境和资源的规格清单。 |
是 |
|
|
|
发布博客：发布博客介绍适配心得。 |
提供博客的地址。 |
是 |
|
|
|
制作单机版无高危开源镜像。 |
上架云商店。 |
否 |
|
|
|
单机版镜像上架时支持模板部署。 |
|
否 |
|
|
|
制作集群版无高危开源镜像 |
上架云商店。 |
否 |
|
|
|
集群版镜像上架时支持模板部署 |
|
否 |
|
|
5 参考资料
1. 开源for Huawei介绍、环境搭建、示例项目、开发和部署指南：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview
- 点赞
- 收藏
- 关注作者
评论（0）