跳到主要内容

以下是翻译后的内容:

📦 EventStream 运行时

OpenHands EventStream 运行时是实现 AI 代理操作安全灵活执行的核心组件。 它使用 Docker 创建一个沙盒环境,可以安全地运行任意代码而不会危及主机系统。

为什么我们需要沙盒运行时?​

OpenHands 需要在安全、隔离的环境中执行任意代码,原因如下:

  1. 安全性:执行不受信任的代码可能会给主机系统带来重大风险。沙盒环境可以防止恶意代码访问或修改主机系统的资源
  2. 一致性:沙盒环境确保代码执行在不同机器和设置下保持一致,消除"在我的机器上可以工作"的问题
  3. 资源控制:沙盒允许更好地控制资源分配和使用,防止失控进程影响主机系统
  4. 隔离:不同的项目或用户可以在隔离的环境中工作,而不会相互干扰或影响主机系统
  5. 可重现性:沙盒环境使重现错误和问题变得更容易,因为执行环境是一致和可控的

运行时如何工作?​

OpenHands 运行时系统使用 Docker 容器实现的客户端-服务器架构。以下是它的工作原理概述:

  1. 用户输入:用户提供自定义基础 Docker 镜像
  2. 镜像构建:OpenHands 基于用户提供的镜像构建新的 Docker 镜像("OH 运行时镜像")。这个新镜像包含 OpenHands 特定的代码,主要是"运行时客户端"
  3. 容器启动:当 OpenHands 启动时,它使用 OH 运行时镜像启动一个 Docker 容器
  4. Action 执行服务器初始化:Action 执行服务器在容器内初始化一个 ActionExecutor,设置必要的组件,如 bash shell,并加载任何指定的插件
  5. 通信:OpenHands 后端(openhands/runtime/impl/eventstream/eventstream_runtime.py)通过 RESTful API 与 Action 执行服务器通信,发送 Action 并接收 Observation
  6. Action 执行:运行时客户端从后端接收 Action,在沙盒环境中执行它们,并将 Observation 发送回去
  7. Observation 返回:Action 执行服务器将执行结果作为 Observation 发送回 OpenHands 后端

客户端的作用:

  • 它充当 OpenHands 后端和沙盒环境之间的中介
  • 它在容器内安全地执行各种类型的 Action(shell 命令、文件操作、Python 代码等)
  • 它管理沙盒环境的状态,包括当前工作目录和加载的插件
  • 它格式化 Observation 并将其返回给后端,确保处理结果的接口一致

OpenHands 如何构建和维护 OH 运行时镜像​

OpenHands 构建和管理运行时镜像的方法确保了在为生产和开发环境创建和维护 Docker 镜像时的效率、一致性和灵活性。

如果你对更多细节感兴趣,可以查看相关代码。

镜像标签系统​

OpenHands 为其运行时镜像使用三标签系统,以平衡可重现性和灵活性。 标签可以是以下 2 种格式之一:

  • 版本标签: oh_v{openhands_version}_{base_image} (例如: oh_v0.9.9_nikolaik_s_python-nodejs_t_python3.12-nodejs22)
  • 锁定标签: oh_v{openhands_version}_{16_digit_lock_hash} (例如: oh_v0.9.9_1234567890abcdef)
  • 源码标签: oh_v{openhands_version}_{16_digit_lock_hash}_{16_digit_source_hash} (例如: oh_v0.9.9_1234567890abcdef_1234567890abcdef)

源码标签 - 最具体​

这是源目录的目录哈希的 MD5 的前 16 位数字。这为 openhands 源码提供了一个哈希值。

锁定标签​

这个哈希由以下内容的 MD5 的前 16 位数字构建:

  • 构建镜像所基于的基础镜像的名称(例如: nikolaik/python-nodejs:python3.12-nodejs22)
  • 镜像中包含的 pyproject.toml 的内容
  • 镜像中包含的 poetry.lock 的内容

这实际上为 Openhands 的依赖项提供了一个独立于源代码的哈希值。

版本标签 - 最通用​

这个标签是 openhands 版本和基础镜像名称的串联(转换以适应标签标准)。

构建过程​

在生成镜像时...

  • 无需重建:OpenHands 首先检查是否存在具有相同最具体源码标签的镜像。如果存在这样的镜像, 则不执行构建 - 使用现有镜像。
  • 最快重建:OpenHands 接下来检查是否存在具有通用锁定标签的镜像。如果存在这样的镜像, OpenHands 会基于它构建一个新镜像,绕过所有安装步骤(如 poetry install 和 apt-get),除了最后一个复制当前源代码的操作。新镜像仅使用源码标签。
  • 还行的重建:如果源码和锁定标签都不存在,将基于版本标签镜像构建镜像。 在版本标签镜像中,大多数依赖项应该已经安装,从而节省时间。
  • 最慢重建:如果三个标签都不存在,则基于基础镜像构建全新的镜像 (这是一个较慢的操作)。这个新镜像使用源码、锁定和版本标签。

这种标记方法允许 OpenHands 高效地管理开发和生产环境。

  1. 相同的源代码和 Dockerfile 总是产生相同的镜像(通过基于哈希的标签)
  2. 当发生小的更改时,系统可以快速重建镜像(通过利用最近兼容的镜像)
  3. 锁定标签(例如: runtime:oh_v0.9.3_1234567890abcdef)总是指向特定基础镜像、依赖项和 OpenHands 版本组合的最新构建

运行时插件系统​

OpenHands 运行时支持一个插件系统,允许扩展功能和自定义运行时环境。插件在运行时客户端启动时初始化。

如果你想实现自己的插件,可以查看这里的 Jupyter 插件示例。

关于插件系统的更多细节仍在建设中 - 欢迎贡献!

插件系统的关键方面:

  1. 插件定义:插件被定义为继承自基础 Plugin 类的 Python 类
  2. 插件注册:可用的插件在 ALL_PLUGINS 字典中注册
  3. 插件规范:插件与 Agent.sandbox_plugins: list[PluginRequirement] 相关联。用户可以在初始化运行时时指定要加载的插件
  4. 初始化:插件在运行时客户端启动时异步初始化
  5. 使用:运行时客户端可以使用初始化的插件来扩展其功能(例如,用于运行 IPython 单元格的 JupyterPlugin)