tsuru/planb

PlanB 镜像文档

镜像概述

PlanB是一个基于Redis的HTTP和WebSocket代理服务，其设计灵感来源于Hipache。该镜像的核心目标是在使用Redis作为后端存储时与Hipache实现完全兼容，采用与Hipache相同的Redis键存储格式，从而确保从Hipache到PlanB的迁移过程无缝进行，仅需替换Hipache的可执行文件即可完成迁移。

核心功能与特性

• 多协议支持：同时提供HTTP和WebSocket协议代理能力
• Redis集成：以Redis作为配置存储和状态管理的后端
• Hipache兼容性：完全兼容Hipache的Redis数据格式，支持现有Hipache配置直接复用
• 无缝迁移：从Hipache迁移至PlanB无需修改Redis中的配置数据，仅需替换代理服务

使用场景与适用范围

• 需要HTTP和WebSocket协议代理的分布式系统环境
• 已部署Hipache并希望进行服务升级或替换的场景
• 依赖Redis进行动态配置管理的代理服务需求
• 要求代理服务具备配置兼容性和迁移便捷性的应用场景

使用方法与配置说明

基本部署

PlanB的运行依赖Redis服务，基本部署需指定Redis连接信息：

bash
docker run -d \
  --name planb-proxy \
  -p 80:80 \
  -e REDIS_HOST=redis-server \
  -e REDIS_PORT=6379 \
  planb:latest

Docker Compose配置

以下是PlanB与Redis的组合部署示例：

yaml
version: '3'
services:
  planb:
    image: planb:latest
    ports:
      - "80:80"
      - "443:443"  # 如启用HTTPS
    environment:
      - REDIS_HOST=redis
      - REDIS_PORT=6379
      # 可选：REDIS_PASSWORD=your_redis_password
    depends_on:
      - redis

  redis:
    image: redis:alpine
    volumes:
      - redis-data:/data
    ports:
      - "6379:6379"

volumes:
  redis-data:

配置说明

PlanB的所有配置均通过Redis存储，与Hipache使用完全相同的数据结构，主要配置键包括：

• frontend:<domain>: 存储前端域名配置
• backend:<domain>: 存储后端服务列表

配置方法与Hipache完全一致，可直接参考Hipache的Redis配置文档进行配置管理。

迁移指南

从Hipache迁移至PlanB的步骤：

1. 停止当前Hipache服务
2. 使用PlanB镜像启动新服务，确保连接到相同的Redis实例
3. 验证代理服务正常运行

由于采用相同的Redis数据格式，现有Hipache配置将自动被PlanB识别和应用，无需额外修改配置数据。