robocupssl/ubuntu-vnc

虚拟小型联赛锦标赛模拟环境配置

镜像概述和主要用途

本镜像提供虚拟小型联赛（Small Size League）锦标赛的完整模拟环境配置，包含多个场地及所有必要组件。通过Docker容器化方案，实现团队远程访问、比赛监控、代码提交和环境持久化，适用于联赛组织、团队开发及比赛运行场景。

核心功能和特性

• 集中化服务器管理：每个场地使用单台高性能根服务器
• 浏览器访问机制：团队通过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%92%8C%E6%A8%A1%E6%8B%9F%E9%85%8D%E7%BD%AE

使用场景和适用范围

• 虚拟小型联赛锦标赛的组织与运行
• 团队远程开发和代码提交
• 比赛过程监控与裁判管理
• 多场地并行模拟环境搭建

详细使用方法和配置说明

所需软件

以下软件需在所有主流操作系统上可用：

• 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]

访问方式

通过浏览器访问场地，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 docker.xuanyuan.run/guacamole/guacamole /opt/guacamole/bin/initdb.sh --postgres > init/postgres/01_initdb.sql