robocupssl/ubuntu-vnc-java

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

镜像概述和主要用途

本镜像提供虚拟小型联赛（Small Size League）的完整模拟环境配置，包含多个场地及所有必要组件。通过该环境，团队可通过浏览器访问虚拟桌面进行比赛准备与参与，同时支持多团队协作、比赛状态监控及模拟配置管理。

核心功能和特性

• 单服务器多场地：每场地使用一台高性能根服务器
• 浏览器访问：团队通过Guacamole浏览器访问VNC会话（虚拟桌面）
• 访问控制：团队拥有自身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%E5%92%8C%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

使用场景和适用范围

适用于虚拟小型联赛（SSL）的组织与参与，特别适合：

• 需要远程协作的联赛团队
• 需确保比赛环境一致性和公正性的赛事组织方
• 需自定义运行环境的参赛队伍
• 联赛模拟、测试和训练场景

环境要求

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

• Docker 和 Docker-Compose
• Bash
• Python 3

详细使用方法和配置说明

团队准备工作

1. 软件兼容性：确保团队软件可在Ubuntu 20.04上运行，且无需root权限。如需GPU或其他特殊需求，需向技术委员会确认可行性。

2. 自定义镜像（如需要额外库）：

   • 基于src/ubuntu-vnc创建自定义Docker镜像
   • 可参考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]

访问方式

通过浏览器访问场地，URL为https://localhost（或自定义根域名）。

本地CA安装（本地运行时）

shell
# 详细步骤见脚本内容
./caddy/install_local_CA.sh

凭据位置

所有生成的凭据保存在./config/passwords。

使用注意事项

• 文件复制：在Guacamole中按Ctrl + Shift + Alt打开菜单，可在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