Apache OpenWhisk 开发者工具使用技术文档

1. 安装指南

Apache OpenWhisk 开发者工具为开发者提供了本地开发、测试和运行 OpenWhisk 应用的工具。以下为安装步骤：

1.1 系统要求

• Docker
• Maven
• Node.js

1.2 安装步骤

1. 安装 Docker：请根据您的操作系统，从 Docker 官网下载并安装 Docker。

2. 安装 Maven：通过包管理工具（如 apt-get 或 yum）安装 Maven。

   sudo apt-get install maven
   

3. 安装 Node.js：通过包管理工具安装 Node.js。

   sudo apt-get install nodejs
   

2. 项目的使用说明

以下为各子项目的使用说明：

2.1 docker-compose

使用 docker-compose 进行本地测试，适用于对 OpenWhisk 核心开发的贡献。

• 克隆仓库到本地。

  git clone https://github.com/apache/openwhisk-devtools.git
  cd openwhisk-devtools/docker-compose
  

• 启动 OpenWhisk。

  ./start.sh
  

2.2 java-action-archetype

使用此原型生成 Java Action 模板项目。

• 克隆仓库到本地。

  git clone https://github.com/apache/openwhisk-devtools.git
  cd openwhisk-devtools/java-action-archetype
  

• 使用 Maven 生成模板项目。

  mvn archetype:generate -DgroupId=com.example -DartifactId=my-whisk-action -Dversion=1.0-SNAPSHOT
  

2.3 node-local

在本地使用 Node.js 测试单个 OpenWhisk 函数。

• 克隆仓库到本地。

  git clone https://github.com/apache/openwhisk-devtools.git
  cd openwhisk-devtools/node-local
  

• 运行测试。

  npm test
  

2.4 maven-java

测试 OpenWhisk Java Actions。

• 克隆仓库到本地。

  git clone https://github.com/apache/openwhisk-devtools.git
  cd openwhisk-devtools/maven-java
  

• 构建项目。

  mvn clean package
  

2.5 knative-build

包含 Knative Build 模板以及修改后的 OpenWhisk Action 运行时，用于构建和部署 Knative 兼容的应用程序。

• 克隆仓库到本地。

  git clone https://github.com/apache/openwhisk-devtools.git
  cd openwhisk-devtools/knative-build
  

• 按照项目 README.md 文档进行构建和部署。

2.6 actionloop-starter-kit

包含一个使用 ActionLoop 代理构建新运行时的入门套件。

• 克隆仓库到本地。

  git clone https://github.com/apache/openwhisk-devtools.git
  cd openwhisk-devtools/actionloop-starter-kit
  

• 按照项目 README.md 文档进行构建。

3. 项目API使用文档

本项目主要提供开发者工具，不直接包含 API。具体 API 使用请参考 Apache OpenWhisk 官方文档。

4. 项目安装方式

项目安装方式已在上述“安装指南”中说明。请参考相关章节进行安装。