背景介绍

开源for Huawei（参考：https://developer.huaweicloud.com/programs/opensource/contributing/）  通过和公司、高校、社区的开发者合作，完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发，帮助繁荣Huawei的基础生态，同时让开源软件能够更加简单、高效的运行于华为云上。

开始之前，开发者可以下载 开源for Huawei Wiki（参考：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview） 了解详细的开发步骤，技术准备，以及开发过程需要的各种资源。

1 需求分析

1.1 项目影响力

Steampipe 使用 SQL 查询语言，这是一个广泛理解和使用的标准，使得即使不是编程专家的用户也能轻松上手。它通过插件系统连接到不同的云服务提供商，如AWS、Google Cloud、Azure等，将原本分散在各个平台的资源信息转化为统一的数据库模型。这种设计极大地提高了灵活性和可扩展性，你可以根据需要添加或更新支持的服务。

该项目采用 Go 语言编写，这确保了其轻量级和高效率。此外，Steampipe 还能够与流行的工具（例如Helm, Terraform, Grafana）无缝对接，进一步增强了它的实用性。

项目数据：Fork 270，Star 6.9k，Contributors 45+，最近一次提交：2024-10-05

主要开发语言：

• Go 58.3%

• TypeScript 18.2%

维护者：Turbot数据团队

官网：https://steampipe.io 

源代码仓库：https://github.com/turbot/steampipe 

star历史（https://star-history.com/）：

1.2 任务目的和范围

本任务的主要目的是让Steampipe支持华为云 GuassDB数据库，拓展GuassDB数据库的影响力，让Steampipe的用户使用华为云服务时能够顺利对接GuassDB数据库。Steampipe轻松地将API数据转换为数据库表，实现高效的数据查询和分析。

• 适配任务清单

2 工作量评估和任务分解

2.1 工作量评估

2.2 基于华为云ECS完成Steampipe安装和部署

华为云部署参考:

Steampipe系统架构图：

下载安装包：可以从Steampipe的官方网站下载适合你操作系统的安装包。

参考：

代码仓库：https://github.com/turbot/steampipe

官方网站下载：https://steampipe.io/downloads

2.3 完成GuassDB数据库适配功能开发

参考现有Steampipe的架构，完成2个功能点的分析和适配工作。

• Steampipe可以使用标准SQL语句查询GaussDB数据库内的数据。
• 自定义插件可以使用Go语言编写，并遵循Steampipe的插件开发规范，实现对GuassDB数据库数据的读取功能和写入功能。

数据库适配参考：

https://github.com/turbot/steampipe/blob/develop/pkg/steampipeconfig/postgres_notification.go

2.4 完成DEMO设计和验证

• 在Steampipe CLI 界面创建一条标准SQL语句向GaussDB发起查询请求，查询成功并返回预期的查询结果。
• 使用Go语言中编写插件代码来实现数据的读取和写入到GaussDB，查询成功并返回预期的查询结果。

2.5 在华为云开发者论坛输出博客

访问华为云开发者论坛（参考：https://bbs.huaweicloud.com/blogs）发表博客，介绍完成这些任务的过程和心得。

内容包括不限于如下内容：

• 开源for Huawei的背景
• 开源软件的功能介绍
• 开发适配过程及碰到和解决的问题
• DEMO设计、开发、部署过程
• 代码推送开源社区及互动过程

博客打上如下标签：

• 开源（必选）
• 开发者（必选）
• GaussDB数据库（可选）
• 云数据库 GaussDB（可选）
• 鲲鹏（可选）
• 昇腾（可选）
• 鸿蒙（可选）
• 对象存储 OBS（可选）

2.6 代码推送上游社区

将代码合并到Steampipe官网主干代码，更新Steampipe官网资料，包括版本说明、开发指南等。

3 验收材料

4 参考资料

• 开源for Huawei介绍、环境搭建、示例项目、开发和部署指南：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview
• Steampipe 开源软件 For Huawei 临时代码仓库参考：https://github.com/turbot/steampipe