openfn/ws-worker

OpenFn/ws-worker 镜像文档

镜像概述

OpenFn/ws-worker 是一个 WebSocket Worker 镜像，主要功能是为 OpenFn/Lightning（v0.10 及更高版本）与 Runtime Engine 提供 WebSocket 通信接口。它作为两者之间的轻量级中间层，负责消息传输及数据结构转换，确保 Lightning 与 Runtime Engine 之间的高效协作。

核心功能与特性

1. WebSocket 接口桥接

• 建立 OpenFn/Lightning 与 Runtime Engine 之间的 WebSocket 连接，实现双向实时通信。

2. 消息传输

• 高效传输两者间的业务消息，保障数据交互的实时性与可靠性。

3. 数据结构转换

• 将 Lightning 的数据结构转换为 Runtime Engine 可直接处理的运行时友好格式，降低系统间数据交互复杂度。

4. 部署灵活性

• 支持根据实际负载需求进行容器扩缩容，适配自定义 OpenFn 部署场景下的资源动态调整。

使用场景与适用范围

• 适用场景：用户自行管理 OpenFn 部署环境时，需通过该 Worker 实现 Lightning 与 Runtime Engine 的通信协同。
• 核心价值：作为 OpenFn 生态的关键组件，确保自定义部署环境中工作流执行的顺畅性，支持根据业务负载灵活调整资源配置。

使用方法与配置说明

基本部署

使用以下命令启动 OpenFn/ws-worker 容器：

bash
docker run OpenFn/ws-worker

扩缩容配置

对于自定义 OpenFn 部署，需根据实际业务需求调整该 Worker 容器的数量：

• 扩容：当工作负载增加时，增加容器实例以提升消息处理能力。
• 缩容：当负载降低时，减少容器实例以节省资源。

注：具体扩缩容策略需结合部署平台（如 Kubernetes、Docker Compose 等）的资源管理工具实现，确保与 OpenFn/Lightning 及 Runtime Engine 的资源配置匹配。

环境要求

• 需与 OpenFn/Lightning v0.10 及更高版本兼容。
• 确保网络环境允许 WebSocket 通信（默认 WebSocket 端口需开放）。