Educates培训平台本地开发环境搭建指南

前言

Educates是一款基于Kubernetes的开源培训平台，专为技术教育场景设计。本文将详细介绍如何在本地环境中搭建Educates的开发环境，包括Kubernetes集群配置、Docker镜像仓库管理、平台镜像构建以及相关工具的编译等关键步骤。

环境准备

本地Kubernetes集群搭建

Educates平台开发需要依赖Kubernetes环境，推荐使用Kind（Kubernetes in Docker）创建本地集群。Educates提供了专用命令简化这一过程：

educates create-cluster --cluster-only

此命令会：

1. 创建本地Kind集群
2. 配置必要的网络和存储
3. 跳过Educates服务的自动安装（适合开发场景）

集群删除命令：

educates delete-cluster

本地Docker镜像仓库

Educates开发过程中会构建大量容器镜像，本地仓库可显著提升开发效率。Educates自动创建的本地仓库位于localhost:5001。

常用管理命令：

• 清理未引用镜像层：

educates local registry prune

• 删除并重建仓库：

educates local registry delete
educates local registry deploy

开发配置

安装配置文件

开发前需创建配置文件developer-testing/educates-installer-values.yaml，内容至少包含：

clusterInfrastructure:
  provider: kind

clusterIngress:
  domain: 192.168.1.1.nip.io

其中domain应替换为开发主机的实际IP地址。

密钥同步

若配置需要额外密钥，可通过以下命令同步：

educates local secrets sync

平台构建与部署

核心镜像构建

构建Educates核心组件镜像：

make push-core-images

支持单独构建的组件：

• 会话管理器：make push-session-manager
• 密钥管理器：make push-secrets-manager
• 培训门户：make push-training-portal

完整部署

直接部署方式：

make deploy-platform

测试安装包方式：

make push-all-images
make push-installer-bundle
make deploy-platform-bundle

清理部署

make delete-platform
# 或
make delete-platform-bundle

工作坊镜像构建

除基础镜像外，Educates支持多种语言环境：

make push-all-images  # 构建全部工作坊镜像

支持单独构建的环境：

• JDK 8/11/17/21环境
• Conda环境
• 基础环境

CLI工具开发

构建Educates命令行工具：

make build-client-programs

生成的CLI位于client-programs/bin目录，命名格式为educates-<系统>-<架构>。

开发测试时指定版本：

./client-programs/bin/educates-linux-amd64 create-cluster --version=latest

存储空间管理

长期开发会产生大量缓存，清理命令：

make prune-all  # 全面清理Docker和构建缓存

注意：此命令不会清理Kubernetes节点上的containerd缓存，极端情况下可能需要重建集群。

文档本地预览

文档开发时可本地构建预览：

make build-project-docs
make open-project-docs

最佳实践建议

1. 存储配置：建议为Docker分配至少100GB存储空间
2. 版本控制：开发时CLI版本标记为develop
3. 增量构建：优先使用单独组件构建命令提高效率
4. 环境隔离：不同功能开发建议使用独立集群

通过以上步骤，开发者可以建立完整的Educates本地开发环境，进行平台功能开发和测试。