apache/openserverless-runtime-go

Apache OpenWhisk GO Runtime 镜像文档

1. 镜像概述和主要用途

1.1 概述

本镜像为 Apache OpenServerless（孵化中）项目官方提供的 Apache OpenWhisk GO 运行时环境，用于在 OpenWhisk 无服务器平台上部署和执行 Go 语言编写的函数。它封装了 Go 运行时环境及 OpenWhisk 函数执行框架，确保 Go 函数与 OpenWhisk 平台的无缝集成。

1.2 主要用途

• 作为 OpenWhisk 平台的后端运行时，接收并执行 Go 语言函数
• 处理事件驱动型请求（如 HTTP 事件、消息队列事件等）
• 支持 Go 函数的生命周期管理（初始化、执行、销毁）

2. 核心功能和特性

2.1 核心功能

• OpenWhisk 兼容性：完全兼容 Apache OpenWhisk 平台的函数调用协议，支持同步/异步函数执行
• Go 语言支持：内置 Go 运行时环境，支持主流 Go 版本（如 Go 1.18+），可直接运行编译后的 Go 函数二进制文件或源码
• 事件处理：原生支持 OpenWhisk 事件格式，可解析 HTTP 请求、CloudEvent 等事件类型

2.2 特性

• 轻量级设计：基于精简基础镜像，减少资源占用，适合无服务器场景
• 快速启动：优化函数初始化流程，缩短冷启动时间
• 可配置性：通过环境变量自定义函数执行参数（超时、内存限制等）
• 日志集成：支持 OpenWhisk 日志收集机制，函数输出日志可被平台捕获

3. 使用场景和适用范围

3.1 使用场景

• 事件驱动型微服务：响应 HTTP、消息队列（如 Kafka、RabbitMQ）等事件触发的任务
• API 后端：作为 OpenWhisk API Gateway 的后端，处理 REST API 请求
• 定时任务：通过 OpenWhisk Alarm 触发器执行周期性 Go 函数（如数据备份、报表生成）
• 轻量级数据处理：处理小规模数据转换、过滤或聚合任务

3.2 适用范围

• 需要在 OpenWhisk 平台运行 Go 语言函数的开发者和企业
• 事件驱动架构下的无服务器应用开发
• 对函数启动速度和资源效率有较高要求的场景

4. 使用方法和配置说明

4.1 环境要求

• Docker 19.03+ 或兼容的容器运行时
• Apache OpenWhisk 平台 1.0+（作为函数执行宿主）

4.2 镜像获取

官方镜像可通过 Docker Hub 获取（假设镜像名称为 apache/openwhisk-runtime-go，具体以项目发布为准）：

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

4.3 配置参数说明

镜像通过环境变量进行配置，关键参数如下：

4.4 部署示例

4.4.1 直接使用 Docker 运行

适用于本地测试 Go 函数执行（需提前准备编译好的 Go 函数二进制文件，放置于 /action 目录）：

bash
docker run -d \
  --name openwhisk-go-runtime \
  -p 8080:8080 \
  -v /path/to/your/go/function:/action \  # 挂载本地 Go 函数目录
  -e ACTION_NAME=Handle \                 # 函数入口名称
  -e LOG_LEVEL=debug \                    # 调试日志级别
  -e EXECUTION_TIMEOUT=60000 \            # 超时 60 秒
  apache/openwhisk-runtime-go:latest

说明：容器启动后，可通过 http://localhost:8080/run 发送 POST 请求触发函数执行，请求体需符合 OpenWhisk 事件格式（如 {"value": {"key": "value"}}）。

4.4.2 集成 OpenWhisk 平台部署

在 OpenWhisk 平台上部署 Go 函数时，需指定本运行时镜像。通过 wsk 命令行工具创建动作：

bash
wsk action create my-go-action /path/to/function.go \
  --docker apache/openwhisk-runtime-go:latest \  # 指定运行时镜像
  --param key value \                            # 函数参数
  --timeout 60000                                # 超时时间（毫秒）

触发函数执行：

bash
wsk action invoke my-go-action --result

4.4.3 Docker Compose 配置

适用于本地模拟 OpenWhisk 环境，与其他服务（如 Kafka 事件源）联动：

yaml
version: '3.8'
services:
  openwhisk-go-runtime:
    image: apache/openwhisk-runtime-go:latest
    ports:
      - "8080:8080"
    volumes:
      - ./my-go-function:/action  # 挂载本地 Go 函数目录
    environment:
      - ACTION_NAME=ProcessEvent
      - LOG_LEVEL=info
      - EXECUTION_TIMEOUT=45000
    networks:
      - openwhisk-network

  # 可选：添加 Kafka 事件源（示例）
  kafka:
    image: confluentinc/cp-kafka:7.3.0
    ports:
      - "9092:9092"
    environment:
      - KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092
      - KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR=1
    networks:
      - openwhisk-network

networks:
  openwhisk-network:
    driver: bridge

启动服务：

bash
docker-compose up -d

5. 注意事项

• 本地测试时，Go 函数需编译为 Linux 平台二进制文件（如 GOOS=linux GOARCH=amd64 go build -o /action/exec）
• 生产环境中建议通过 OpenWhisk 平台管理函数，而非直接使用 docker run
• 镜像版本需与 OpenWhisk 平台版本匹配，避免兼容性问题
• 敏感配置（如 API 密钥）建议通过 OpenWhisk 动作参数或平台密钥管理机制注入，而非硬编码环境变量