Apache OpenWhisk Package Cloudant 使用教程

解卿靓Fletcher

于 2024-09-02 10:00:37 发布

阅读量344

点赞数 5

本文链接：https://blog.csdn.net/gitblog_00137/article/details/141811945

版权

Apache OpenWhisk Package Cloudant 使用教程

openwhisk-package-cloudantApache OpenWhisk Package Cloudant: 这是一个用于在 Apache OpenWhisk（一个开源的云函数平台）上部署 Cloudant（一个基于 CouchDB 的 NoSQL 数据库）的包。它允许开发者使用 OpenWhisk 编写基于 Cloudant 的云函数。适合熟悉 Apache OpenWhisk 和 Cloudant 的开发者，特点是提供了方便的部署和集成功能。项目地址:https://gitcode.com/gh_mirrors/ope/openwhisk-package-cloudant

Apache OpenWhisk 是一个无服务器计算平台，而 openwhisk-package-cloudant 是一个针对该平台的扩展包，旨在简化与 Cloudant 数据库的集成过程。本教程将引导您了解此开源项目的目录结构、启动文件以及配置文件的关键细节，以便您能够高效地在 OpenWhisk 中使用 Cloudant 服务。

1. 项目目录结构及介绍

本项目遵循了典型的 Node.js 库结构，并结合了 OpenWhisk 的包规范：

├── LICENSE
├── README.md            - 项目说明和快速入门指南。
├── package.json         - Node.js 项目配置文件，定义依赖项和脚本命令。
├── actions              - 存放所有行动（Actions）的目录。
│   ├── cloudantCreate.js - 创建数据库的操作。
│   ├── ...
├── tests                - 测试代码存放目录。
│   └── ...
├── lib                  - 核心逻辑或辅助函数库。
│   └── ...
└── .npmignore           - 指定哪些文件不应该被 npm 包含发布。

目录简介:

actions: 包含了一系列预定义的动作（函数），这些动作可以直接在OpenWhisk中调用来执行与Cloudant相关的任务，如创建数据库、读写数据等。
tests: 用于存放对各动作进行单元测试的代码，确保功能的可靠性和稳定性。
lib: 内部使用的库文件，提供共享的功能或封装复杂的操作逻辑。

2. 项目启动文件介绍

由于OpenWhisk的运行模型是基于事件触发的动作，而非传统的“启动”概念，这里的“启动文件”更多指的是入口动作或者部署脚本。在本项目中，并没有一个单一的“启动文件”，而是通过配置和定义在 package.json 中的 OpenWhisk 部署脚本来管理。

在实际部署过程中，您通常会利用 wskdeploy 工具，其配置由 manifest.yml 文件指定，来部署整个包及其包含的动作到OpenWhisk环境中。manifest.yml 可以看作是部署的“启动”配置文件。

3. 项目的配置文件介绍

主要的配置并不直接体现在单个文件中，而是通过环境变量或在部署时通过参数传递给特定动作。然而，对于本地开发或自定义行为，可能需要修改或添加环境变量来指向您的Cloudant服务实例。

环境变量设置通常在部署阶段完成，比如通过 manifest.yml 文件中的参数配置或直接在 OpenWhisk CLI 上使用时指定。常见的环境变量包括 Cloudant 服务的URL、用户名、密码等，确保在部署前正确配置这些值至关重要。

示例配置（非直接文件形式）

在部署时，通过 manifest.yml 或直接调用时设置：

parameters:
  - name: CLOUDANT_URL
    type: string
    description: The URL of the Cloudant service.
  - name: CLOUDANT_USERNAME
    type: string
    description: The username for the Cloudant service.
  - name: CLOUDANT_PASSWORD
    type: string
    description: The password for the Cloudant service.

随后，在 OpenWhisk 中部署时，需提供这些参数的实际值。

以上就是关于 apache/openwhisk-package-cloudant 开源项目的基本介绍，涵盖目录结构、非传统意义上的“启动文件”，以及配置管理方式。这为开发者提供了集成 Cloudant 数据库于 OpenWhisk 平台的初步指引。