xflows/clowdflows-backend

Mothra (ClowdFlows Backend) Docker 镜像文档

镜像概述

Mothra 是 ClowdFlows 平台的后端服务器，基于 Python 和 Django 框架构建。本 Docker 镜像封装了 Mothra 的运行环境及所有依赖，旨在简化 ClowdFlows 后端的部署、配置与运行流程，为数据科学和工作流管理提供强大的后端 API 支持。

核心功能和特性

• 工作流管理：支持配置和启用多种工作流包，灵活扩展后端处理能力。
• 数据库管理：内置 Django ORM，支持数据库同步、迁移及初始数据导入。
• 开发调试支持：支持标准运行模式及带有调试器的增强运行模式（runserver_plus）。
• 环境隔离：基于 Python 虚拟环境构建，确保依赖的独立性与系统稳定性。

使用场景和适用范围

• ClowdFlows 平台部署：作为 ClowdFlows 前端界面的后端 API 服务器。
• 本地开发与测试：为开发者提供开箱即用的后端环境，快速启动工作流引擎。
• 私有化部署：适用于企业内网环境下的数据科学工作流平台搭建。

详细的使用方法和配置说明

1. 配置文件说明

在启动容器前，需要配置 Django 本地设置。建议将本地的 local_settings.py 挂载到容器内：

• 启用工作流包：在 local_settings.py 中的 INSTALLED_APPS_WORKFLOWS_SUB 元组内取消注释所需的工作流包。
• 数据库配置：在配置文件中指定数据库连接信息，或通过环境变量注入。

2. 初始化数据库

首次启动或更新镜像后，需执行数据库迁移和初始化操作。可通过进入容器执行以下命令：

bash
# 同步并迁移数据库（跳过创建超级用户的交互提示）
python manage.py migrate --noinput

# 创建超级管理员用户
python manage.py createsuperuser

# 导入初始工作流包
python manage.py import_all

Docker 部署示例

使用 Docker Run 部署

bash
docker run -d \
  --name mothra-backend \
  -p 8000:8000 \
  -v $(pwd)/local_settings.py:/app/mothra/local_settings.py \
  -e DATABASE_URL="postgres://user:password@db_host:5432/mothra" \
  -e SECRET_KEY="your-secret-key" \
  mothra/clowdflows-backend:latest

使用 Docker Compose 部署

推荐使用 Docker Compose 结合 PostgreSQL 数据库进行完整部署：

yaml
version: '3.8'

services:
  db:
    image: postgres:13
    environment:
      POSTGRES_DB: mothra
      POSTGRES_USER: mothra_user
      POSTGRES_PASSWORD: secure_password
    volumes:
      - postgres_data:/var/lib/postgresql/data

  mothra:
    image: mothra/clowdflows-backend:latest
    container_name: mothra-backend
    ports:
      - "8000:8000"
    environment:
      - DATABASE_URL=postgres://mothra_user:secure_password@db:5432/mothra
      - SECRET_KEY=your-super-secret-key
      - DEBUG=True
    volumes:
      - ./local_settings.py:/app/mothra/local_settings.py
    depends_on:
      - db
    command: >
      sh -c "python manage.py migrate --noinput &&
             python manage.py import_all &&
             python manage.py runserver 0.0.0.0:8000"

volumes:
  postgres_data:

运行与调试

• 标准运行：容器默认启动 python manage.py runserver 0.0.0.0:8000。
• 调试模式：若需使用调试器，可将启动命令修改为 python manage.py runserver_plus 0.0.0.0:8000。
• 访问服务：启动完成后，通过浏览器或 API 客户端访问 http://127.0.0.1:8000。