openwhisk/example

Apache OpenWhisk Docker镜像文档

1. 镜像概述

Apache OpenWhisk是一款开源分布式Serverless计算平台，可响应事件触发执行函数（function），并自动管理底层基础设施、服务器资源及弹性扩展。本Docker镜像是Apache OpenWhisk的示例镜像，特别包含了基于C语言编写的客户端（原生代码），用于演示原生代码函数在OpenWhisk平台上的运行能力。

2. 核心功能与特性

2.1 Serverless事件驱动执行

• 基于事件驱动模型，支持响应各类事件（如HTTP请求、消息队列消息等）触发函数执行。
• 无需关心底层服务器管理，专注于函数逻辑开发。

2.2 原生C代码支持

• 集成C语言客户端，支持运行原生编译的C代码函数，适用于高性能计算场景。
• 提供C语言函数与OpenWhisk平台的交互能力，包括事件接收、结果返回等。

2.3 Docker容器化部署

• 基于Docker容器封装，支持跨环境一致部署，简化依赖管理。
• 作为OpenWhisk运行时（runtime）的示例镜像，可快速集成至OpenWhisk集群。

2.4 自动弹性扩展

• 内置资源弹性调度能力，根据事件流量自动扩展函数实例数量，无流量时自动缩容，优化资源利用率。

2.5 分布式架构支持

• 支持分布式部署，可在多节点集群中运行，保障高可用性和负载均衡。

3. 使用场景与适用范围

3.1 原生C代码函数开发

• 适用于需运行C语言原生函数的开发者，验证C代码在Serverless环境中的兼容性。

3.2 高性能Serverless应用

• 针对计算密集型任务（如数据处理、算法运算等），利用C语言原生性能优势构建高性能Serverless应用。

3.3 OpenWhisk运行时示例

• 作为OpenWhisk runtime的参考示例，帮助开发者理解如何为OpenWhisk扩展原生代码运行时。

3.4 教学与实验环境

• 用于学习Serverless架构与原生代码集成，或作为OpenWhisk平台功能验证的实验环境。

4. 使用方法与配置说明

4.1 前提条件

• 已安装Docker Engine（20.10+推荐）。
• 若需集群部署，需配置Docker Compose或Kubernetes环境。

4.2 获取镜像

该镜像为Apache OpenWhisk runtime项目的构建产物，源码及构建信息可参考GitHub仓库：
https://github.com/apache/openwhisk-runtime-docker

可通过Docker Hub拉取镜像（具体标签以仓库最新版本为准）：

bash
docker pull apache/openwhisk-runtime-docker:c  # 示例标签，实际请替换为最新版本

4.3 Docker快速启动（docker run）

以下为运行示例，需根据实际环境调整参数：

bash
docker run -d \
  --name openwhisk-c-example \
  -p 8080:8080 \  # 映射端口（若需外部访问）
  -e OPENWHISK_API_HOST="http://openwhisk-controller:8080" \  # OpenWhisk控制器API地址
  -e OPENWHISK_AUTH="23bc46b1-71f6-4ed5-8c54-816aa4f8c502:123zO3xZCLrMN6v2BKK1dXYFpXlPkccOFqm12CdAsMgRU4VrNZ9lyGVCGuMDGIwP" \  # 平台认证密钥（示例值，需替换为实际密钥）
  -e FUNCTION_NAME="c-native-function" \  # 待执行的C函数名称
  apache/openwhisk-runtime-docker:c

4.4 Docker Compose部署示例

创建docker-compose.yml文件，配置如下（需配合OpenWhisk控制器、数据库等组件，此处为简化示例）：

yaml
version: '3'
services:
  openwhisk-c-example:
    image: apache/openwhisk-runtime-docker:c
    container_name: openwhisk-c-example
    ports:
      - "8080:8080"
    environment:
      - OPENWHISK_API_HOST=http://openwhisk-controller:8080
      - OPENWHISK_AUTH=23bc46b1-71f6-4ed5-8c54-816aa4f8c502:123zO3xZCLrMN6v2BKK1dXYFpXlPkccOFqm12CdAsMgRU4VrNZ9lyGVCGuMDGIwP
      - FUNCTION_NAME=c-native-function
    depends_on:
      - openwhisk-controller  # 依赖OpenWhisk控制器服务（需单独配置）

启动命令：

bash
docker-compose up -d

4.5 函数部署与执行

1. 编译C函数：将C代码编译为原生二进制（需确保与镜像内环境兼容，如使用musl等静态链接库避免依赖问题）。
2. 打包函数：将编译后的二进制文件及函数元数据（如function.json）打包为ZIP文件。
3. 通过C客户端部署：使用镜像内置的C客户端工具，调用OpenWhisk API部署函数：

   bash
   # 进入容器执行客户端命令（示例）
   docker exec -it openwhisk-c-example ./c-client deploy --function c-native-function --zip function.zip
   

4. 触发函数：通过HTTP请求或事件源触发函数执行：

   bash
   curl -X POST http://localhost:8080/api/v1/namespaces/_/actions/c-native-function -H "Authorization: Basic $(echo -n "23bc46b1-71f6-4ed5-8c54-816aa4f8c502:123zO3xZCLrMN6v2BKK1dXYFpXlPkccOFqm12CdAsMgRU4VrNZ9lyGVCGuMDGIwP" | base64)" -d '{"payload": "test"}'
   

5. 配置参数与环境变量

6. 免责声明

Docker Hub中标记为“OpenWhisk”的项目镜像可能包含开发阶段的中间产物及标记版本的便捷二进制文件，不应被视为官方发布的正式 artifacts。 正式发布版本请以Apache OpenWhisk官方网站及GitHub仓库的发布信息为准。

7. 参考资源

• 官方网站：[***]
• 项目Wiki：[***]
• 主仓库：https://github.com/apache/openwhisk
• 运行时源码仓库：https://github.com/apache/openwhisk-runtime-docker