Glasskube项目开发与贡献指南：从入门到精通

Glasskube项目开发与贡献指南：从入门到精通

glasskube 🧊 The next generation Package Manager for Kubernetes 📦 Featuring a GUI and a CLI. Glasskube packages are dependency aware, GitOps ready and can get automatic updates via a central public package repository. 项目地址: https://gitcode.com/gh_mirrors/gl/glasskube

项目概述

Glasskube是一个基于Kubernetes的包管理工具，采用Go语言开发。它提供了CLI工具和Web界面，帮助开发者在Kubernetes环境中更高效地管理软件包。项目包含两个核心组件：glasskube CLI和package-operator，前者是用户交互界面，后者是运行在Kubernetes集群中的控制器。

开发环境准备

基础工具链

1. Go语言环境：项目要求Go 1.22版本，建议使用gvm或官方安装包管理Go版本
2. GNU Make：项目构建系统依赖GNU Make，不支持其他make实现
3. Kubernetes工具：
   • kubectl：Kubernetes命令行工具
   • minikube：本地Kubernetes集群（推荐开发环境）
4. Docker：容器运行时环境

环境初始化

# 克隆项目
git clone git@github.com:<your-username>/glasskube.git
cd glasskube

# 初始化依赖
make setup  # 安装CRD、依赖项和webhook配置

开发工作流

代码修改与构建

1. 创建特性分支：

   git switch main
   git switch -c feature-name
   

2. 开发与构建：

   • CLI构建：make（输出在dist目录）
   • 创建别名方便测试：

     alias gk-dev="/path/to/glasskube/binary"
     

3. Operator开发：

   • 本地运行：make run
   • 构建Docker镜像：make docker-build
   • 部署到集群：make deploy

Web界面开发

1. 安装前端依赖：

   make web
   

2. 启动开发服务器：

   go run cmd/glasskube/main.go serve
   

测试策略

单元测试

make test  # 运行所有单元测试并生成覆盖率报告

集成测试

1. 本地集群测试：

   • 使用minikube创建测试集群
   • 部署修改后的operator进行验证

2. 手动验证步骤：

   • 测试CLI命令功能
   • 验证Web界面交互
   • 检查operator日志是否有错误

代码质量检查

make lint      # 静态代码分析
make lint-fix  # 自动修复部分问题

提交规范

Glasskube采用Conventional Commits规范，提交消息和PR标题需符合以下格式：

<type>[scope]: <description>

常用类型说明：

• fix：修复bug
• feat：新增功能
• docs：文档更新
• build：构建系统修改
• perf：性能优化
• refactor：代码重构

示例：

feat(cli): 添加package list命令
fix(operator): 修复资源清理逻辑

高级开发技巧

自定义包仓库

开发新功能时可能需要自定义包仓库：

1. 克隆官方packages仓库
2. 本地启动文件服务器：

   caddy file-server --root . --listen :9684
   

3. 添加本地仓库：

   glasskube repo add local http://localhost:9684
   

Webhook开发

添加新的验证webhook的步骤：

1. 使用kubebuilder生成脚手架：

   kubebuilder create webhook --group packages --version v1alpha1 --kind PackageRepository --programmatic-validation
   

2. 将生成的文件整合到项目结构中
3. 实现验证逻辑
4. 更新cert-manager配置

最佳实践

1. 单一任务原则：每个PR只解决一个问题
2. 及时沟通：遇到困难及时在社区寻求帮助
3. 充分测试：本地验证通过后再提交PR
4. 保持同步：定期从上游仓库拉取变更
5. 小步提交：保持每个变更集小而专注

通过遵循这些指南，开发者可以高效地为Glasskube项目做出贡献，同时确保代码质量和项目一致性。无论是修复bug、添加新功能还是改进文档，每个贡献都是推动项目发展的重要力量。

glasskube 🧊 The next generation Package Manager for Kubernetes 📦 Featuring a GUI and a CLI. Glasskube packages are dependency aware, GitOps ready and can get automatic updates via a central public package repository. 项目地址: https://gitcode.com/gh_mirrors/gl/glasskube