robocupssl/ubuntu-vnc-go

虚拟小型联赛（SSL）模拟环境配置

镜像概述和主要用途

本镜像提供虚拟小型联赛（Small Size League）的完整模拟环境配置，包含多个比赛场地及所有必要组件。它允许参赛团队通过浏览器访问专用虚拟桌面环境，支持比赛监控、自定义依赖管理及持久化存储，适用于RoboCup SSL虚拟联赛的组织、开发和比赛运行。

核心功能和特性

• 多场地管理：单台高性能服务器支持多个独立比赛场地
• 浏览器访问：团队通过Guacamole浏览器访问专用VNC会话（虚拟桌面）
• 透明监管：所有团队可查看所有VNC会话，确保比赛期间无违规操作
• 自定义镜像支持：团队可提交包含额外依赖的自定义Docker镜像
• 持久化存储：家目录通过Docker卷备份，确保代码在容器重启/重建后保留
• 比赛监控工具：浏览器中通过ssl-vision-client查看场地，ssl-status-board显示比赛状态
• 权限控制：ssl-game-controller受密码保护，仅裁判团队和管理员在比赛期间可访问
• 模拟管理：集成https://github.com/RoboCup-SSL/ssl-simulation-controller%EF%BC%8C%E6%94%AF%E6%8C%81%E6%89%8B%E5%8A%A8%E7%90%83/%E6%9C%BA%E5%99%A8%E4%BA%BA%E6%94%BE%E7%BD%AE%E5%8F%8A%E6%A8%A1%E6%8B%9F%E9%85%8D%E7%BD%AE

使用场景和适用范围

• RoboCup SSL虚拟联赛的组织与运行
• 参赛团队开发、测试机器人控制软件
• 联赛技术委员会管理比赛环境和团队访问权限
• 多团队同时进行训练或比赛的场景

详细使用方法和配置说明

环境要求

需安装以下软件（支持主流操作系统）：

• Docker 和 Docker-Compose
• Bash
• Python 3

团队准备工作

1. 软件兼容性：确保团队软件可在Ubuntu 20.04上运行，且无需root权限；如需GPU或特殊需求，需向技术委员会确认
2. 自定义镜像：
   • 如需额外库用于运行/构建软件，基于src/ubuntu-vnc创建自定义镜像，可参考src/ubuntu-vnc-java模板
   • 通过Pull Request提交新镜像
3. 文件传输：可本地构建软件后仅复制二进制文件到容器
4. 容器集成：
   • 在docker-compose-teams.yaml中添加新服务（以tigers或erforce服务为模板）
   • 在config/teams中添加团队名称（小写，无特殊字符）

环境设置步骤

1. 配置修改（远程服务器使用时）：

   • 修改./config/root_domain设置根域名
   • 修改./config/field_name设置场地名称（本地运行可使用默认值）

2. 初始化密钥：

   shell
   ./config/docker/init.sh
   

   此脚本将生成密码和SSH密钥并保存到指定位置

3. 生成Caddyfile：

   shell
   ./config/caddy/generate_caddyfile.py
   

4. 启动场地容器：

   shell
   # 前台启动并显示日志（Ctrl+C停止）
   docker-compose up
   # 或后台运行
   docker-compose up -d
   

5. 配置Guacamole和Caddy：

   shell
   # 设置Guacamole（VNC服务器）并生成团队密码
   ./config/guacamole/update_guacamole.py
   # 转换密码为Caddy格式（用于game-controller）
   ./config/caddy/update_caddy_passwords.sh
   # 使用新密码重新生成Caddyfile
   ./config/caddy/generate_caddyfile.py
   # 重载Caddy web服务器配置
   ./config/caddy/update_caddy_config.sh
   

6. 启动团队容器：

   shell
   # 启动指定团队容器或所有团队容器
   docker-compose -f docker-compose-teams.yaml up [team-container]
   

访问方式

• 浏览器访问：通过https://localhost或自定义根域名访问场地
• 本地CA安装（本地运行时）：

  shell
  # 详细步骤见脚本说明
  ./caddy/install_local_CA.sh
  

• 凭证位置：所有生成的凭证保存在./config/passwords

使用注意事项

• 文件复制：在Guacamole中按Ctrl + Shift + Alt打开菜单，可在VNC会话与本地间复制文件
• 拖放文件：直接将文件拖放到浏览器标签页，可复制到VNC会话的家目录
• 数据持久化：家目录由卷备份，所有家目录文件在容器重建后保留
• 文本粘贴：在终端中使用Shift+Insert粘贴文本

关闭和清理

停止并删除特定场地的所有容器、网络和卷：

shell
docker-compose down -v

AWS部署

通过Terraform部署到AWS：

shell
cd terraform
terraform init
terraform apply

注意：部署前需熟悉AWS和Terraform

更新说明

数据库初始化脚本已预生成，若Guacamole版本变更，需重新生成：

shell
docker run --rm guacamole/guacamole /opt/guacamole/bin/initdb.sh --postgres > init/postgres/01_initdb.sql