switchyeti/yeti-web

YETI 镜像文档

镜像概述和主要用途

YETI是一个用于Yeti Switch的管理界面，提供了对交换机系统的配置、监控和管理功能。本镜像主要用于开发环境搭建，帮助开发者快速部署和配置YETI管理系统，支持多数据库配置及功能扩展。

核心功能和特性

• 基于Ruby 2.6环境，需配合bundler使用
• 支持PostgreSQL 13数据库，包含多种扩展组件
• 多数据库配置支持（主数据库"yeti"和CDR数据库）
• 灵活的迁移控制，支持迁移过程中的暂停与继续
• 可通过Docker快速部署PostgreSQL开发环境

使用场景和适用范围

适用于需要搭建Yeti Switch管理界面开发环境的开发者，支持本地开发、测试及功能扩展。需具备基本的Ruby和PostgreSQL使用经验。

详细使用方法和配置说明

开发环境准备

Ruby环境

需使用Ruby 2.6版本并安装bundler：

sh
# 安装Ruby 2.6及bundler
gem install bundler -v 2.6.x

PostgreSQL配置

推荐使用PostgreSQL 13版本，以下是Debian系统安装步骤：

1. 添加软件源和GPG密钥：

sh
curl http://pkg.yeti-switch.org/key.gpg | sudo apt-key add -
curl https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
sudo add-apt-repository "deb http://pkg.yeti-switch.org/debian/buster unstable main"
sudo add-apt-repository "deb http://deb.debian.org/debian buster main buster non-free"
sudo add-apt-repository "deb http://apt.postgresql.org/pub/repos/apt/ buster-pgdg main"

2. 安装PostgreSQL及扩展：

sh
sudo apt-get install postgresql-13 postgresql-contrib-13 postgresql-13-prefix postgresql-13-pgq3 postgresql-13-pgq-ext postgresql-13-yeti postgresql-13-pllua
sudo apt-get install -t buster-pgdg libpq-dev

3. 安装Yeti PostgreSQL扩展： 需编译或从.deb包安装postgresql-13-yeti扩展，源码地址：https://github.com/yeti-switch/yeti-pg-ext

Yeti-web应用准备

1. 克隆仓库并安装依赖：

sh
# 克隆仓库
git clone https://github.com/yeti-switch/yeti-web.git
cd yeti-web

# 安装依赖
bundle install

2. 配置数据库连接： 创建config/database.yml文件，可参考示例config/database.yml.development。该项目使用两个数据库：主数据库"yeti"和CDR数据库"cdr"。

3. 配置应用参数： 创建config/yeti_web.yml文件，参考示例config/yeti_web.yml.development。如需为某些模型禁用paper_trail版本控制，可在配置文件中通过versioning_disable_for_models数组指定。

4. 配置权限策略： 创建config/policy_roles.yml文件（参考config/policy_roles.yml.distr），或通过修改config/yeti_web.yml禁用策略功能：

yaml
role_policy:
  when_no_config: allow
  when_no_policy_class: allow

5. 初始化开发数据库：

sh
RAILS_ENV=development bundle exec rake db:create db:schema:load db:migrate db:seed

6. 启动Rails服务器：

sh
bundle exec rails s

访问http://localhost:3000/，使用默认账号登录：

• 用户名：admin
• 密码：***

7. 准备测试数据库：

sh
RAILS_ENV=test bundle exec rake db:drop db:create db:schema:load db:migrate db:seed

注意：测试数据库需要种子数据，尤其是PGQ种子

8. 运行测试：

sh
bundle exec rspec

数据库迁移

迁移暂停控制

如需在连续迁移过程中暂停，可在迁移文件中添加stop_step方法：

ruby
# 示例：/db/migrate/20171105085529_one.rb
def change
  # 执行迁移操作
end

def stop_step
  true
end

添加后，后续迁移将停止。如需继续迁移，再次运行rake db:migrate。

如需忽略暂停继续迁移，可使用环境变量：

sh
IGNORE_STOPS=true bundle exec rake db:migrate

插入数据到Yeti数据库的迁移

bash
# 准备测试数据库
RAILS_ENV=test bundle exec rake db:create db:schema:load db:seed

# 创建迁移文件（位于db/migrations目录）
RAILS_ENV=test bundle exec rake db:migrate

# 导出数据到种子文件
# SCHEMA_NAME: 插入数据的表所在 schema
# YETI_TEST_DB_NAME: 本地Yeti测试数据库名
pg_dump --column-inserts --data-only --schema=SCHEMA_NAME --file=db/seeds/main/SCHEMA_NAME.sql YETI_TEST_DB_NAME

使用Docker Postgres进行开发

安装Docker

参考Ubuntu安装指南：Install Docker on Ubuntu 18.10

构建PostgreSQL镜像

在yeti-web项目目录下执行：

sh
sudo docker build -t yeti_postgres -f ci/pg13.Dockerfile .

启动PostgreSQL容器

映射端口3010并使用卷"yetiPgData"持久化数据：

sh
sudo docker run -p 3010:5432 --volume yetiPgData:/var/lib/postgresql yeti_postgres

配置数据库连接

更新config/database.yml：

yaml
username: postgres
password:
port: 3010

初始化数据库

按照开发环境准备中的数据库初始化步骤执行（db:create, db:schema:load等）。