thedxw/transition

Transition 镜像文档

镜像概述

Transition是一个基于Rails框架的应用程序，主要用于管理网站向GOV.UK的过渡流程。其核心功能是生成和处理映射数据，这些数据将与https://github.com/alphagov/bouncer%E6%9C%8D%E5%8A%A1%E9%85%8D%E5%90%88%E4%BD%BF%E7%94%A8%EF%BC%8C%E4%BB%A5%E5%AE%9E%E7%8E%B0%E7%BD%91%E7%AB%99%E8%BF%87%E6%B8%A1%E8%BF%87%E7%A8%8B%E4%B8%AD%E7%9A%84%E8%AF%B7%E6%B1%82%E8%B7%AF%E7%94%B1%E5%92%8C%E7%AE%A1%E7%90%86%E3%80%82

核心功能和特性

• 网站过渡流程管理：提供网站迁移至GOV.UK的全流程管理能力
• 映射数据处理：生成和维护与Bouncer服务兼容的映射数据
• 后台任务处理：支持通过Sidekiq处理异步后台任务
• 样式指南：内置样式文档，规范应用的UI设计和自定义样式

依赖项

• Redis：用于缓存和Sidekiq后台任务队列
• PostgreSQL 9.3+：数据库服务，需支持物化视图（materialized views，PostgreSQL 9.3及以上版本引入）

使用方法

数据库设置

sh
bundle exec rake db:setup

数据库种子数据

使用FactoryBot生成初始测试数据：

sh
bundle exec rake db:seed

运行应用

启动Web应用

sh
script/rails s

运行Sidekiq（开发环境）

处理后台任务：

sh
bundle exec sidekiq -C config/sidekiq.yml

样式指南访问

应用内置样式指南，可通过访问/style路径查看，文档包含：

• Bootstrap使用规范
• 应用自定义样式与默认样式的差异
• 填补样式缺口所需的自定义样式说明

部署说明

部署平台

该服务托管在dxw的容器平台Dalmatian上。

镜像构建流程

1. 将代码合并到develop分支（用于staging环境）或master分支（用于生产环境）
2. 推送代码后，DockerHub将自动构建新的Docker镜像

Dalmatian平台部署

镜像构建完成后，部署流程交由Dalmatian平台处理。应用的基础设施配置通过独立的私有GitHub仓库https://github.com/dxw/ukri-transition-dalmatian-config%E7%AE%A1%E7%90%86%EF%BC%8C%E4%BD%BF%E7%94%A8Terraform%E8%BF%9B%E8%A1%8C provisioning，包含Bouncer服务的配置。

手动部署步骤（包含停机时间）

1. 在AWS中选择dxw-dalmatian-1角色
2. 访问ECS服务
3. 选择目标集群（注意：集群为共享资源）
4. 点击"Tasks"
5. 搜索"transition"
6. 选择目标环境中运行的所有应用任务
7. 点击"stop"
8. 容器将自动重启并拉取新版本镜像

访问控制台

在生产环境中访问Rails控制台或运行rake任务的步骤：

1. 在AWS中选择dxw-dalmatian-1角色
2. 访问Systems Manager服务
3. 选择"Session Manager"
4. 点击"Start session"
5. 选择目标环境的运行节点
6. 会话启动后，输入sudo su
7. 输入docker ps
8. 从应用容器中复制目标容器ID（注意：此处运行有其他容器）
9. 输入docker exec -ti <container-id> /bin/bash
10. 加载环境变量：eval $(AWS_ENV_PATH=/ukri-transition-0-staging/$SSM_PATH_SUFFIX/ AWS_REGION=eu-west-2 ./aws-env)
11. 正常运行rails c（Rails控制台）或rake命令