apache/openserverless-runtime-python

Apache OpenWhisk Python 运行时镜像文档

1. 镜像概述

镜像名称：apache/openwhisk-runtime-python
项目来源：Apache OpenServerless（孵化中）项目
主要用途：提供基于 Python 的运行时环境，用于执行 Apache OpenWhisk 无服务器平台上的 Python 函数（Action），支持事件驱动、弹性扩展的无服务器应用开发。

2. 核心功能与特性

• 多 Python 版本支持：兼容 Python 3.7+ 主流版本，满足不同应用的语言版本需求。
• 轻量级运行时：精简镜像体积，降低资源占用，优化容器启动效率。
• 快速冷启动：针对无服务器场景优化启动流程，缩短冷启动时间，提升函数响应速度。
• 依赖管理：支持通过 requirements.txt 声明函数依赖，自动安装第三方库。
• OpenWhisk 原生集成：无缝对接 OpenWhisk 平台的触发器（Trigger）、规则（Rule）及 API 网关，支持事件驱动执行。
• 标准化输入输出：遵循 OpenWhisk 函数输入输出格式（JSON 结构），便于跨语言函数协作。
• 日志与监控：集成标准输出日志，支持对接 OpenWhisk 平台监控工具，便于问题排查与性能分析。

3. 使用场景与适用范围

3.1 典型使用场景

• 事件驱动处理：如消息队列（Kafka、RabbitMQ）消息处理、文件上传触发的业务逻辑（如图片压缩、格式转换）。
• API 后端服务：作为 OpenWhisk API 网关的后端处理函数，提供轻量级 API 服务（如数据查询、用户认证）。
• 定时任务：通过 OpenWhisk 定时触发器（Cron Trigger）执行周期性任务（如数据备份、报表生成）。
• 数据处理：执行数据清洗、格式转换、简单计算等轻量级数据处理任务。
• 微服务组件：作为分布式系统中的独立功能单元，与其他运行时（如 Node.js、Java）函数协同工作。

3.2 适用范围

• 适合需要弹性扩展、低运维成本的业务场景。
• 适用于短期执行的轻量级任务（执行时间通常在秒级，符合无服务器函数最佳实践）。
• 推荐用于开发、测试及生产环境的无服务器应用原型验证与部署。

4. 使用方法与配置说明

4.1 前提条件

• 已安装 Docker 19.03+ 或 Docker Compose 2.0+。
• 已熟悉 OpenWhisk 函数开发规范（如函数入口、输入输出格式）。

4.2 镜像拉取

通过 Docker Hub 拉取最新版本镜像：

bash
docker pull apache/openwhisk-runtime-python:latest

（如需指定 Python 版本，可使用标签如 3.9，例如 apache/openwhisk-runtime-python:3.9）

4.3 函数代码准备

4.3.1 函数代码结构

函数代码需遵循 OpenWhisk Python 函数规范，典型目录结构如下：

my-action/
├── main.py          # 函数入口文件
└── requirements.txt # 依赖声明文件（可选）

4.3.2 示例函数代码

main.py（函数入口为 main 函数，接收 args 参数并返回 JSON 结果）：

python
def main(args):
    # 从输入参数中获取 "name"，默认值为 "World"
    name = args.get("name", "World")
    return {"message": f"Hello, {name}!"}

requirements.txt（如需依赖第三方库，例如 requests）：

txt
requests==2.31.0

4.4 环境变量配置

运行时支持通过环境变量自定义函数行为，常用配置如下：

4.5 运行函数（Docker 命令）

通过 docker run 启动容器，挂载函数代码目录并执行函数：

bash
docker run -it --rm \
  -v $(pwd)/my-action:/action \  # 挂载本地函数代码到容器内 /action 目录
  -e OW_ACTION_NAME=hello-world \ # 设置函数名称
  -e LOG_LEVEL=DEBUG \            # 开启 DEBUG 日志
  apache/openwhisk-runtime-python:latest \
  python -m openwhisk.action /action/main.py  # 执行函数入口

函数输入输出

• 输入：通过标准输入传递 JSON 格式参数，例如：

  bash
  echo '{"name": "OpenWhisk"}' | docker run -i --rm -v $(pwd)/my-action:/action apache/openwhisk-runtime-python:latest python -m openwhisk.action /action/main.py
  

• 输出：函数返回结果通过标准输出打印，例如上述命令输出：

  json
  {"message": "Hello, OpenWhisk!"}
  

4.6 Docker Compose 配置示例

通过 docker-compose.yml 定义服务，便于集成到多容器应用中：

yaml
version: "3.8"
services:
  openwhisk-python-action:
    image: apache/openwhisk-runtime-python:latest
    volumes:
      - ./my-action:/action  # 挂载函数代码
    environment:
      - OW_ACTION_NAME=hello-world
      - LOG_LEVEL=INFO
      - PYTHONPATH=/action  # 确保函数模块可被导入
    command: python -m openwhisk.action /action/main.py  # 执行函数

启动服务：

bash
docker-compose up

4.7 日志查看

函数运行日志通过容器标准输出打印，可通过 docker logs 查看（需指定容器 ID 或名称）：

bash
# 启动时记录容器名称（--name 参数）
docker run --name openwhisk-python-action ... 

# 查看日志
docker logs openwhisk-python-action

5. 注意事项

• 函数代码需确保无持久化状态依赖，无服务器函数应设计为“无状态”。
• 大依赖包（如 pandas）可能增加镜像体积和冷启动时间，建议精简依赖。
• 生产环境中建议通过 OpenWhisk 平台部署，而非直接使用 Docker 命令（平台提供弹性调度、触发器管理等能力）。