cancan-microstack 0.0.1__py3-none-any.whl

cancan_microstack/assets/scripts/README.md

@@ -0,0 +1,195 @@
+# Scripts 目录
+
+本目录包含项目的所有管理脚本，按功能分类组织。
+
+## 目录结构
+
+```
+scripts/
+├── docker/           # Docker Compose 相关脚本
+├── podman/           # Podman Compose 相关脚本
+├── dev/              # 开发环境相关脚本
+└── utils/            # 工具类脚本
+```
+
+## Docker 脚本 (`docker/`)
+
+Docker Compose 环境的服务管理脚本。
+
+### 完整环境管理
+- `start_all.sh` - 一键启动 controllersrv 和所有 Docker Compose 服务
+- `stop_all.sh` - 一键停止所有服务（包括 controllersrv 和 Docker Compose）
+
+### controllersrv 管理
+- `start.sh` - 启动 controllersrv（宿主机运行）
+- `stop.sh` - 停止 controllersrv
+- `restart.sh` - 重启 controllersrv
+
+### Docker Compose 集群管理
+- `start_compose.sh` - 启动 Docker Compose 集群（infrasrv, opsbffsrv, besrv）
+- `stop_compose.sh` - 停止 Docker Compose 集群
+- `restart_compose.sh` - 重启 Docker Compose 集群
+
+### 使用示例
+
+```bash
+# 开发环境快速启动
+./scripts/docker/start_all.sh
+
+# 重启单个服务
+docker-compose restart infrasrv
+
+# 查看日志
+docker-compose logs -f infrasrv
+
+# 停止所有服务
+./scripts/docker/stop_all.sh
+```
+
+## Podman 脚本 (`podman/`)
+
+Podman Compose 环境的服务管理脚本（功能与 Docker 脚本对应）。
+
+### 完整环境管理
+- `start_all_podman.sh` - 一键启动 controllersrv 和所有 Podman Compose 服务
+- `stop_all_podman.sh` - 一键停止所有服务
+
+### controllersrv 管理
+- `start_podman.sh` - 启动 controllersrv（Podman 环境）
+
+### Podman Compose 集群管理
+- `start_compose_podman.sh` - 启动 Podman Compose 集群
+- `stop_compose_podman.sh` - 停止 Podman Compose 集群
+- `restart_compose_podman.sh` - 重启 Podman Compose 集群
+
+### 使用示例
+
+```bash
+# 开发环境快速启动
+./scripts/podman/start_all_podman.sh
+
+# 重启单个服务
+podman-compose restart infrasrv
+
+# 查看日志
+podman-compose logs -f infrasrv
+
+# 停止所有服务
+./scripts/podman/stop_all_podman.sh
+```
+
+## 开发环境脚本 (`dev/`)
+
+本地开发环境的特殊脚本。
+
+### Out Pod 开发模式
+- `start_dev_out_pod.sh` - 启动 Out Pod 开发环境（仅 PostgreSQL + Redis）
+- `stop_dev_out_pod.sh` - 停止 Out Pod 开发环境
+
+Out Pod 模式适用于：
+- 需要在 IDE 中调试 Python 代码
+- 需要频繁修改代码并快速测试
+- 不需要完整的容器化环境
+
+### 使用示例
+
+```bash
+# 1. 启动基础设施（PostgreSQL + Redis）
+./scripts/dev/start_dev_out_pod.sh
+
+# 2. 在宿主机运行服务
+export NE_CONFIG=dev_out_pod
+python cmd/infrasrv/run.py
+
+# 3. 停止基础设施
+./scripts/dev/stop_dev_out_pod.sh
+```
+
+## 工具脚本 (`utils/`)
+
+通用工具类脚本。
+
+- `check_env.sh` - 检查当前容器引擎环境（Docker 或 Podman）
+
+### 使用示例
+
+```bash
+# 检查环境
+./scripts/utils/check_env.sh
+# 输出: Using Docker Compose (version 2)
+# 或: Using podman-compose
+```
+
+## 环境模式说明
+
+项目支持 3 种环境模式（通过 `NE_CONFIG` 环境变量控制）：
+
+### 1. `dev_in_pod` - 容器内开发
+- 所有服务运行在 Docker/Podman 容器中
+- 代码通过 volume 挂载实现热更新
+- 适合完整的容器化开发和测试
+- **使用脚本**: `docker/start_all.sh` 或 `podman/start_all_podman.sh`
+
+```bash
+export NE_CONFIG=dev_in_pod
+./scripts/docker/start_all.sh
+```
+
+### 2. `dev_out_pod` - 容器外开发
+- 只运行 PostgreSQL 和 Redis 容器
+- 业务服务在宿主机运行
+- 适合需要 IDE 调试的场景
+- **使用脚本**: `dev/start_dev_out_pod.sh`
+
+```bash
+export NE_CONFIG=dev_out_pod
+./scripts/dev/start_dev_out_pod.sh
+python cmd/infrasrv/run.py
+```
+
+### 3. `prod` - 生产环境
+- 完整的生产配置
+- 所有服务容器化部署
+- **使用脚本**: `docker/start_all.sh`（配置不同）
+
+```bash
+export NE_CONFIG=prod
+./scripts/docker/start_all.sh
+```
+
+## 脚本执行权限
+
+所有脚本默认已设置执行权限：
+
+```bash
+chmod +x scripts/**/*.sh
+```
+
+## 故障排查
+
+### Docker/Podman 检测失败
+运行环境检测脚本：
+```bash
+./scripts/utils/check_env.sh
+```
+
+### 服务启动失败
+查看详细日志：
+```bash
+docker-compose logs -f <service_name>
+# 或
+podman-compose logs -f <service_name>
+```
+
+### controllersrv 无法连接
+确认 controllersrv 已启动：
+```bash
+curl http://localhost:22100/internal/health
+```
+
+## 相关文档
+
+- [快速开始指南](../docs/guides/QUICK_START.md)
+- [Docker Compose 使用指南](../docs/guides/DOCKER_COMPOSE_USAGE.md)
+- [Podman 快速上手](../docs/guides/PODMAN_QUICKSTART.md)
+- [服务注册说明](../docs/guides/SERVICE_REGISTRY_README.md)

cancan_microstack/assets/scripts/docker/build_images.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+
+# Docker Compose 构建脚本
+# 用于构建 Docker 镜像（利用缓存，增量构建）
+# "如果有，就不build，没有的image才build（或 download）" -> Docker build 的默认行为利用缓存
+# 用法: ./build_images.sh [service_name]
+
+# 设置脚本错误时退出
+set -e
+
+# 获取脚本所在目录的绝对路径
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+PROJECT_ROOT="$(cd "$SCRIPT_DIR/../.." && pwd)"
+
+echo "========================================="
+echo "构建 Docker 镜像 (增量/缓存)"
+echo "========================================="
+echo "项目目录: $PROJECT_ROOT"
+echo "当前时间: $(date '+%Y-%m-%d %H:%M:%S')"
+echo ""
+
+# 切换到项目根目录
+cd "$PROJECT_ROOT"
+
+# 检查 Docker 是否运行
+if ! docker info > /dev/null 2>&1; then
+    echo "❌ Docker 未运行"
+    exit 1
+fi
+
+SERVICE_NAME="$1"
+
+if [ -n "$SERVICE_NAME" ]; then
+    echo "正在构建服务镜像: $SERVICE_NAME"
+    echo ""
+    docker-compose build "$SERVICE_NAME"
+else
+    echo "正在构建所有服务镜像..."
+    echo ""
+    docker-compose build
+fi
+
+echo ""
+echo "✅ 构建完成"

cancan_microstack/assets/scripts/docker/force_rebuild_images.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+# Docker Compose 强制重建脚本
+# 用于强制重新构建 Docker 镜像（不使用缓存）
+# "把之前的干掉，然后在重新 build"
+# 用法: ./force_rebuild_images.sh [service_name]
+
+# 设置脚本错误时退出
+set -e
+
+# 获取脚本所在目录的绝对路径
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+PROJECT_ROOT="$(cd "$SCRIPT_DIR/../.." && pwd)"
+
+echo "========================================="
+echo "强制重建 Docker 镜像 (无缓存)"
+echo "========================================="
+echo "项目目录: $PROJECT_ROOT"
+echo "当前时间: $(date '+%Y-%m-%d %H:%M:%S')"
+echo ""
+
+# 切换到项目根目录
+cd "$PROJECT_ROOT"
+
+SERVICE_NAME="$1"
+
+if [ -n "$SERVICE_NAME" ]; then
+    echo "正在强制重建服务镜像: $SERVICE_NAME"
+    echo ""
+    docker-compose build --no-cache "$SERVICE_NAME"
+else
+    echo "正在强制重建所有服务镜像..."
+    echo ""
+    docker-compose build --no-cache
+fi
+
+echo ""
+echo "✅ 强制构建完成"

cancan_microstack/assets/scripts/docker/rebuild_all.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+# 一键重建所有服务脚本
+# 包括重启 controllersrv 和重建 Docker Compose 集群
+
+# 设置脚本错误时退出
+set -e
+
+# 获取脚本所在目录的绝对路径
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+echo "========================================="
+echo "一键重建所有服务"
+echo "========================================="
+echo "当前时间: $(date '+%Y-%m-%d %H:%M:%S')"
+echo ""
+
+# 步骤 1: 重启 controllersrv
+echo "步骤 1: 重启 controllersrv (宿主机)..."
+"$SCRIPT_DIR/restart.sh"
+
+echo ""
+echo "等待 2 秒..."
+sleep 2
+
+# 步骤 2: 重建 Docker Compose 集群
+echo ""
+echo "步骤 2: 重建 Docker Compose 集群..."
+"$SCRIPT_DIR/rebuild_compose.sh"
+
+echo ""
+echo "========================================="
+echo "✅ 所有服务重建完成"
+echo "========================================="

cancan_microstack/assets/scripts/docker/rebuild_compose.sh

@@ -0,0 +1,61 @@
+#!/bin/bash
+
+# Docker Compose 重建脚本
+# 用于重建并重启 Docker Compose 集群或单个服务
+# 用法: ./rebuild_compose.sh [service_name]
+
+# 设置脚本错误时退出
+set -e
+
+# 获取脚本所在目录的绝对路径
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+PROJECT_ROOT="$(cd "$SCRIPT_DIR/../.." && pwd)"
+
+echo "========================================="
+echo "重建 Docker Compose 集群"
+echo "========================================="
+echo "项目目录: $PROJECT_ROOT"
+echo "当前时间: $(date '+%Y-%m-%d %H:%M:%S')"
+echo ""
+
+# 切换到项目根目录
+cd "$PROJECT_ROOT"
+
+# 检查 Docker 是否运行
+if ! docker info > /dev/null 2>&1; then
+    echo "❌ Docker 未运行，请先启动 Docker Desktop"
+    exit 1
+fi
+
+# 检查 docker-compose.yml 是否存在
+if [ ! -f "docker-compose.yml" ]; then
+    echo "❌ 未找到 docker-compose.yml 文件"
+    exit 1
+fi
+
+SERVICE_NAME="$1"
+
+if [ -n "$SERVICE_NAME" ]; then
+    echo "正在重建服务: $SERVICE_NAME"
+    echo ""
+    docker-compose up -d --build "$SERVICE_NAME"
+else
+    echo "正在重建所有服务..."
+    echo ""
+    docker-compose up -d --build
+fi
+
+# 等待服务启动
+echo ""
+echo "等待服务启动..."
+sleep 5
+
+# 检查服务状态
+echo ""
+echo "========================================="
+echo "服务状态检查"
+echo "========================================="
+docker-compose ps
+
+echo ""
+echo "✅ Docker Compose 重建完成"

cancan_microstack/assets/scripts/docker/restart.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# controllersrv 重启脚本
+# 用于重启宿主机上运行的 controllersrv 服务
+
+# 设置脚本错误时退出
+set -e
+
+# 获取脚本所在目录的绝对路径
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+echo "========================================="
+echo "重启 controllersrv"
+echo "========================================="
+echo "当前时间: $(date '+%Y-%m-%d %H:%M:%S')"
+echo ""
+
+# 先停止服务
+echo "步骤 1: 停止 controllersrv..."
+"$SCRIPT_DIR/stop.sh" || true
+
+# 等待 2 秒
+echo ""
+echo "等待 2 秒..."
+sleep 2
+
+# 再启动服务
+echo ""
+echo "步骤 2: 启动 controllersrv..."
+"$SCRIPT_DIR/start.sh"
+
+echo ""
+echo "========================================="
+echo "✅ controllersrv 重启完成"
+echo "========================================="

cancan_microstack/assets/scripts/docker/restart_compose.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# Docker Compose 重启脚本
+# 用于重启整个 Docker Compose 集群
+
+# 设置脚本错误时退出
+set -e
+
+# 获取脚本所在目录的绝对路径
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+echo "========================================="
+echo "重启 Docker Compose 集群"
+echo "========================================="
+echo "当前时间: $(date '+%Y-%m-%d %H:%M:%S')"
+echo ""
+
+# 先停止服务
+echo "步骤 1: 停止 Docker Compose 集群..."
+"$SCRIPT_DIR/stop_compose.sh"
+
+# 等待 3 秒
+echo ""
+echo "等待 3 秒..."
+sleep 3
+
+# 再启动服务
+echo ""
+echo "步骤 2: 启动 Docker Compose 集群..."
+"$SCRIPT_DIR/start_compose.sh"
+
+echo ""
+echo "========================================="
+echo "✅ Docker Compose 集群重启完成"
+echo "========================================="

cancan_microstack/assets/scripts/docker/start.sh

@@ -0,0 +1,78 @@
+#!/bin/bash
+
+# controllersrv 启动脚本
+# 用于在宿主机上启动 controllersrv 服务
+
+# 设置脚本错误时退出
+set -e
+
+# 获取脚本所在目录的绝对路径
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+PROJECT_ROOT="$(cd "$SCRIPT_DIR/../.." && pwd)"
+
+echo "========================================="
+echo "启动 controllersrv"
+echo "========================================="
+echo "项目目录: $PROJECT_ROOT"
+echo "当前时间: $(date '+%Y-%m-%d %H:%M:%S')"
+echo ""
+
+# 检查 Python 环境
+if ! command -v python3 &> /dev/null; then
+    echo "错误: 未找到 Python3，请先安装 Python 3.11+"
+    exit 1
+fi
+
+# 切换到项目根目录
+cd "$PROJECT_ROOT"
+
+# 检查并激活虚拟环境
+if [ -d "venv" ]; then
+    echo "使用虚拟环境: $PROJECT_ROOT/venv"
+    source venv/bin/activate
+    PYTHON_CMD="python"
+else
+    echo "警告: 未找到虚拟环境，使用系统 Python"
+    PYTHON_CMD="python3"
+fi
+
+# 设置环境变量（统一 PYTHONPATH 配置：src 和 cmd）
+export NE_CONFIG=prod
+export PYTHONPATH="$PROJECT_ROOT/src:$PROJECT_ROOT/src/libs:$PROJECT_ROOT/cmd:$PYTHONPATH"
+
+# 检查依赖是否安装
+if [ ! -d "venv" ]; then
+    echo "提示: 未找到虚拟环境，建议先运行 'python3 -m venv venv' 创建虚拟环境"
+    echo "然后运行 'source venv/bin/activate && pip install -r requirements.txt' 安装依赖"
+fi
+
+# 启动 controllersrv
+echo "正在启动 controllersrv (端口: 22100)..."
+echo ""
+
+mkdir -p logs/
+
+# 后台启动服务（日志由应用本身的 logging 模块处理）
+$PYTHON_CMD cmd/controllersrv/run.py &
+
+# 保存 PID
+CONTROLLER_PID=$!
+echo $CONTROLLER_PID > /tmp/controllersrv.pid
+
+echo "✅ controllersrv 已启动"
+echo "   PID: $CONTROLLER_PID"
+echo "   日志目录: server_log_data/"
+echo "   访问地址: http://localhost:22100"
+echo ""
+echo "查看日志: tail -f server_log_data/controllersrv-*.log"
+echo "停止服务: ./cmd/controllersrv/stop.sh"
+echo ""
+
+# 等待 2 秒检查进程是否还在运行
+sleep 2
+if ps -p $CONTROLLER_PID > /dev/null; then
+    echo "✅ controllersrv 运行正常"
+else
+    echo "❌ controllersrv 启动失败，请检查日志"
+    exit 1
+fi

cancan_microstack/assets/scripts/docker/start_all.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+
+# 一键启动所有服务脚本
+# 包括 controllersrv 和 Docker Compose 集群
+
+# 设置脚本错误时退出
+set -e
+
+# 获取脚本所在目录的绝对路径
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+echo "========================================="
+echo "一键启动所有服务"
+echo "========================================="
+echo "当前时间: $(date '+%Y-%m-%d %H:%M:%S')"
+echo ""
+
+# 步骤 1: 启动 controllersrv
+echo "步骤 1: 启动 controllersrv (宿主机)..."
+"$SCRIPT_DIR/start.sh"
+
+echo ""
+echo "等待 5 秒，确保 controllersrv 完全启动..."
+sleep 5
+
+# 步骤 2: 启动 Docker Compose 集群
+echo ""
+echo "步骤 2: 启动 Docker Compose 集群..."
+"$SCRIPT_DIR/start_compose.sh"
+
+echo ""
+echo "========================================="
+echo "✅ 所有服务启动完成"
+echo "========================================="
+echo ""
+echo "服务访问地址："
+echo "  - controllersrv: http://localhost:22100"
+echo "  - infrasrv:      http://localhost:8080"
+echo "  - opsbffsrv:     http://localhost:8081"
+echo "  - besrv:         http://localhost:8082"
+echo ""
+echo "快捷命令："
+echo "  - 查看 controllersrv 日志: tail -f logs/controllersrv.log"
+echo "  - 查看 Docker 服务日志:    docker-compose logs -f [服务名]"
+echo "  - 停止所有服务:           ./cmd/controllersrv/stop_all.sh"
+echo ""

cancan_microstack/assets/scripts/docker/start_compose.sh

@@ -0,0 +1,66 @@
+#!/bin/bash
+
+# Docker Compose 启动脚本
+# 用于启动整个 Docker Compose 集群
+
+# 设置脚本错误时退出
+set -e
+
+# 获取脚本所在目录的绝对路径
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+PROJECT_ROOT="$(cd "$SCRIPT_DIR/../.." && pwd)"
+
+echo "========================================="
+echo "启动 Docker Compose 集群"
+echo "========================================="
+echo "项目目录: $PROJECT_ROOT"
+echo "当前时间: $(date '+%Y-%m-%d %H:%M:%S')"
+echo ""
+
+# 切换到项目根目录
+cd "$PROJECT_ROOT"
+
+# 检查 Docker 是否运行
+if ! docker info > /dev/null 2>&1; then
+    echo "❌ Docker 未运行，请先启动 Docker Desktop"
+    exit 1
+fi
+
+# 检查 docker-compose.yml 是否存在
+if [ ! -f "docker-compose.yml" ]; then
+    echo "❌ 未找到 docker-compose.yml 文件"
+    exit 1
+fi
+
+# 启动 Docker Compose
+echo "正在启动 Docker Compose 服务..."
+echo "包括: postgres, redis, infrasrv, opsbffsrv, besrv"
+echo ""
+
+docker-compose up -d
+
+# 等待服务启动
+echo ""
+echo "等待服务启动..."
+sleep 5
+
+# 检查服务状态
+echo ""
+echo "========================================="
+echo "服务状态检查"
+echo "========================================="
+docker-compose ps
+
+echo ""
+echo "✅ Docker Compose 集群启动完成"
+echo ""
+echo "服务访问地址："
+echo "  - infrasrv:    http://localhost:8080"
+echo "  - opsbffsrv:   http://localhost:8081"
+echo "  - besrv:       http://localhost:8082"
+echo "  - PostgreSQL:  localhost:5432 (如已暴露)"
+echo "  - Redis:       localhost:6379 (如已暴露)"
+echo ""
+echo "查看日志: docker-compose logs -f [服务名]"
+echo "停止服务: ./cmd/controllersrv/stop_compose.sh"
+echo "重启服务: ./cmd/controllersrv/restart_compose.sh"