seatable/seatable-python-runner

SeaTable Python Pipeline Runner 镜像文档

1. 镜像概述和主要用途

SeaTable Python Pipeline Runner 镜像是 SeaTable Python Pipeline 组件之一，与 Scheduler、Starter 镜像共同构成完整的 Python 任务执行框架。该镜像专注于安全执行 Python 脚本，并在 SeaTable 系统环境中完成输出结果的检索与交付，是实现 SeaTable 平台自定义 Python 任务自动化的核心执行节点。

2. 核心功能和特性

核心功能

• Python 代码安全执行：提供隔离的运行环境，确保用户自定义 Python 脚本在受控条件下执行，避免对系统造成风险。
• 输出结果处理：自动捕获脚本执行过程中的输出（如日志、返回值），并按 SeaTable 系统要求的格式进行封装和交付。
• 与 Pipeline 调度集成：接收来自 Scheduler 和 Starter 镜像的任务指令，协同完成任务触发、执行、结果反馈的全流程。

关键特性

• 环境隔离：通过容器化机制实现任务执行环境与主机系统的隔离，降低安全风险。
• 兼容性：支持标准 Python 语法及常用第三方库（具体依赖需参考 SeaTable 官方兼容性列表）。
• 轻量高效：优化镜像体积，减少资源占用，确保任务快速启动和执行。

3. 使用场景和适用范围

适用场景

• SeaTable 数据自动化处理：需通过 Python 脚本对 SeaTable 表格数据进行清洗、转换、计算等自定义处理的场景。
• 定时/触发式任务执行：配合 Scheduler 实现定时任务（如每日数据汇总），或通过 Starter 响应事件触发任务（如表单提交后自动处理）。
• 第三方系统集成：通过 Python 脚本对接外部 API 或服务，实现 SeaTable 与其他系统的数据互通（如同步数据至 CRM、生成报表并推送至邮件等）。

适用范围

• 用户群体：SeaTable 管理员或具备一定技术能力的用户，需配置 Python Pipeline 功能时使用。
• 部署环境：需与 SeaTable 服务端部署在同一网络环境中，且已正确配置 Docker 及 Docker Compose。

4. 使用方法和配置说明

4.1 前置条件

• 已部署 SeaTable 服务端，且版本支持 Python Pipeline 功能。
• 已获取 SeaTable 管理员界面生成的 Pipeline 认证令牌（PIPELINE_TOKEN）。
• 本地环境已安装 Docker 和 Docker Compose。

4.2 Docker Compose 部署示例

该镜像需与 Scheduler、Starter 镜像配合使用，推荐通过 docker-compose.yml 统一管理。典型配置示例如下：

yaml
version: '3.8'

services:
  # Scheduler：负责任务调度与触发
  seatable-pipeline-scheduler:
    image: docker.xuanyuan.run/seatable/python-pipeline-scheduler:latest
    restart: always
    environment:
      - SEATABLE_SERVER_URL=https://your-seatable-domain.com  # 替换为实际 SeaTable 服务地址
      - PIPELINE_TOKEN=your_pipeline_token_here  # 替换为管理员界面获取的令牌
      - LOG_LEVEL=info  # 日志级别：debug/info/warn/error
    volumes:
      - scheduler-data:/data

  # Starter：接收调度指令并启动 Runner 任务
  seatable-pipeline-starter:
    image: docker.xuanyuan.run/seatable/python-pipeline-starter:latest
    restart: always
    depends_on:
      - seatable-pipeline-scheduler
    environment:
      - SEATABLE_SERVER_URL=https://your-seatable-domain.com
      - PIPELINE_TOKEN=your_pipeline_token_here
      - LOG_LEVEL=info
    volumes:
      - starter-data:/data

  # Runner：执行 Python 脚本并处理输出（当前镜像）
  seatable-pipeline-runner:
    image: docker.xuanyuan.run/seatable/python-pipeline-runner:latest
    restart: always
    depends_on:
      - seatable-pipeline-starter
    environment:
      - SEATABLE_SERVER_URL=https://your-seatable-domain.com
      - PIPELINE_TOKEN=your_pipeline_token_here
      - LOG_LEVEL=info
      - EXECUTION_TIMEOUT=300  # 脚本执行超时时间（秒），默认 300
    volumes:
      - runner-data:/data  # 存储任务执行日志及临时文件

volumes:
  scheduler-data:
  starter-data:
  runner-data:

4.3 关键配置参数说明

环境变量

4.4 启动与维护

启动服务

将上述 docker-compose.yml 保存至本地，执行以下命令启动服务：

bash
docker-compose up -d

查看日志

通过以下命令查看 Runner 镜像的执行日志：

bash
docker-compose logs -f seatable-pipeline-runner

停止/重启服务

bash
# 停止服务
docker-compose down

# 重启服务（配置更新后需执行）
docker-compose down && docker-compose up -d

5. 注意事项

• 依赖管理：脚本中如需使用第三方 Python 库，需通过 SeaTable 界面的「Python 依赖配置」功能提前声明，Runner 会自动安装指定依赖。
• 安全限制：为避免风险，Runner 对脚本执行权限进行限制（如禁止访问宿主机文件系统、网络隔离等），具体限制规则请参考 SeaTable 官方文档。
• 版本兼容性：确保 Runner 镜像版本与 SeaTable 服务端版本匹配，避免因版本差异导致功能异常（推荐使用 latest 标签或与服务端一致的版本号）。
• 详细配置参考：更多高级配置（如资源限制、自定义网络）请查阅 SeaTable 官方文档：[***]。