VMware Tanzu Labs Educates 培训平台：工作坊模板使用指南

什么是Educates工作坊模板

Educates培训平台提供了一套标准化的工作坊模板，帮助开发者快速创建技术培训内容。这套模板专为本地Educates环境设计，同时具备足够的灵活性，可以适应各种部署场景。模板采用模块化设计，包含预定义的文件结构和配置，让培训内容创建者能够专注于教学内容本身，而不必从头搭建框架。

创建工作坊的基本流程

使用Educates命令行工具创建工作坊非常简单，只需执行以下命令：

educates new-workshop lab-new-workshop

这个命令会在指定路径下生成工作坊的基础结构。工作坊名称需要符合Kubernetes对象命名规范（RFC 1035标准），但建议长度不超过25个字符，因为Educates系统会在不同场景下添加前缀或后缀。

渲染器选择

Educates提供两种内容渲染器：

1. Hugo渲染器（默认）：基于流行的静态网站生成器Hugo，提供更丰富的功能和更好的性能
2. Classic渲染器（已弃用）：旧版渲染器，未来将被移除

建议所有新工作坊都使用Hugo渲染器：

educates new-workshop lab-new-workshop --template hugo

自定义工作坊配置

创建工作坊时，可以通过命令行参数自定义关键信息：

• --title：工作坊简短标题
• --description：详细描述
• --image：指定基础镜像，可选值包括：
  • jdk8-environment:*
  • jdk11-environment:*
  • jdk17-environment:*
  • jdk21-environment:*
  • conda-environment:*

工作坊文件结构解析

生成的工作坊包含以下核心目录和文件：

• resources/workshop.yaml：主配置文件
• /workshop：教学内容目录
• /exercises：练习内容目录
• README.md：说明文档

自定义基础镜像

虽然Educates提供了多种标准基础镜像，但在某些特殊场景下可能需要自定义镜像。配置方式如下：

spec:
  workshop:
    image: custom-environment:latest
    files:
    - image:
        url: $(image_repository)/{name}-files:$(workshop_version)
      includePaths:
      - /workshop/**
      - /exercises/**
      - /README.md

构建和推送自定义镜像的命令：

docker build -t localhost:5001/{name}-image:latest .

注意：除非必要，否则不建议使用自定义镜像。Educates的扩展包机制通常能满足大多数定制需求，而且能确保与平台版本的兼容性。

最佳实践建议

1. 命名规范：保持工作坊名称简短且有意义
2. 版本控制：使用语义化版本控制工作坊内容
3. 内容组织：合理划分理论内容和实践练习
4. 依赖管理：优先使用扩展包而非自定义镜像
5. 测试验证：在发布前充分测试工作坊内容

工作坊发布流程

当工作坊开发完成后，可以将其发布供他人使用。Educates提供了完整的发布工作流，包括：

1. 内容打包为OCI镜像
2. 生成部署所需的Kubernetes资源文件
3. 创建版本发布

通过遵循这些指南，您可以高效地创建专业级的技术培训内容，充分利用Educates平台提供的各项功能，为学员提供优质的学习体验。