Skip to main content

配置笔记本服务

Notebook 服务提供了一个基于 Web 的 Python Notebook 界面,用于地理空间数据分析。 通过 Notebooks,您可以执行分析、自动化工作流,并立即在地理环境中可视化数据和分析结果。

Notebook 是将代码、实时可视化和地图以及数据工具进行结合的环境。 在 notebook 编辑器中,您可以在同一个位置写入、归档和运行 Python 代码。

Notebook 服务包括以下 Esri Python 资源:

  • ArcGIS API for Python:允许您将动态地图和地理空间数据工具合并到 notebook 中。

  • ArcPy:允许在组织中编写 Python 脚本

许可:

此功能在两种许可级别下可用:

  • ArcGIS Notebook Services 许可随附在 ArcGIS Enterprise on Kubernetes 许可中。 此许可允许组织成员使用 ArcGIS Notebook Python 3 Standard 运行时创作 notebook,并使用计划任务、webhook 和 web 工具自动化 notebook 工作流。

  • ArcGIS Notebook Services Advanced 许可作为高级功能提供,允许访问 ArcGIS Notebook Python 3 Advanced 运行时,并提供超出 ArcGIS Notebook Services 许可范围的附加 ArcPy 功能。

注:

为了支持 notebook 服务,任何外部反向代理或负载均衡器必须能够将 WebSocket 流量传递到后端目标,并设置相应要求,确保活动会话保持打开状态,且空闲会话至少保持打开状态 10 分钟。

配置笔记本服务

下列配置步骤可能需要您更改在组织中部署 ArcGIS Enterprise on Kubernetes 的方式;继续下一步骤前请仔细查看下列说明。

启用笔记本服务

要启用笔记本服务,您必须配置一个笔记本工作空间,并在 ArcGIS Enterprise Manager 中启用该功能。

注:

在启用笔记本服务之前,请确保您的管理员已分配足够的资源配额和 worker 节点来支持此高级功能。

  1. 在 ArcGIS Enterprise Manager 中,点击侧边栏的功能按钮。

    功能页面随即显示。

  2. 打开笔记本服务切换按钮。

    此时会弹出配置工作空间对话框,提示您指定所需的值。 工作空间将用于存储组织成员的笔记本相关文件。

  3. 提供所需信息:

    1. 对于卷类型,选择动态或静态,以指定如何为工作空间提供持久卷。 如果 PVC 应绑定到现有 PV,请使用静态。 如果新 PV 应通过指定存储类进行配置,请使用动态。 有关详细信息,请参阅动态配置和静态配置的注意事项。

      注:

      此工作空间的 PV 必须为 FileSystem 类型,且可支持 ReadWriteMany (RWX) 访问模式。 在配置笔记本工作空间之前,确保您为该工作空间分配的 PV 支持 RWX 访问模式。 此外,为了支持 PV,可能需要在您的 Kubernetes 集群中安装支持驱动程序。

    2. 提供卷名称文本。

      如果选择静态,必须提供卷名称。

    3. 对于存储类名称,指定您自己的存储类名称,或者如果已设置存储类,请为卷指定存储类名称。

      注:

      对于动态配置,存储类名称为必填项;对于静态配置,则为可选项。

      注:

      如果绑定到尚未定义存储类的现有 PV,将存储类名称留空。 如果在集群中配置了默认存储类,DefaultStorageClass 许可控制器会添加默认存储类并阻止 PVC 进行绑定。 在此情况下,管理员应将存储类规范添加至 PV 或移除默认存储类配置。

    4. 对于大小 (GiB),定义 PV 的大小。

      最小大小为 100 GiB。 当使用静态绑定时,该值必须与现有 PV 的大小相匹配。 如果值高于现有 PV 的大小,PVC 不会与 PV 绑定在一起。

      注:

      只能为您的组织配置一个笔记本工作空间。 它的存储大小限制为创建时指定的值。 确保选择足够的工作空间大小,可满足当前和未来的需求。

    5. 单击保存。

    系统将向您显示提示消息,指示启用过程可能要花费一些时间。

    注:

    如果笔记本工作空间未能成功创建,或者您需要使用不同的存储类名称重新创建工作空间,则可以使用 删除(工作空间)操作来删除工作空间。

    随即提交启用笔记本服务的请求。 此过程会验证先决条件并激活支持资源。 笔记本自动化服务将自动启动。

如果功能启用失败,请重复上述步骤,确保工作空间已正确配置,笔记本服务许可有效并可用,并且系统服务已启动。 查看日志,确定此功能的要求。

或者,您可以部署 DaemonSet,预加载笔记本服务影像。 这样可以有助于提高首次打开笔记本的速度。 笔记本的初始加载时间将在 1 分钟后超时。 有关详细信息,请参阅 ArcGIS Enterprise on Kubernetes GitHub 资料档案库。

笔记本服务现已配置完成。 您可以开始在组织中使用笔记本。 查看如何创建笔记本并将其发布为 Web 工具。

此外,还可以查看如何调整笔记本服务功能的设置。

笔记本服务设置

启用笔记本服务后,可以查看和编辑相关设置,如适用运行时的支持资源、WebSocket 大小、每个笔记本项的最大快照数等。

笔记本服务功能包括三个主要选项卡,您可以在其中查看或编辑设置:概览、属性和运行时。

  • 概览 - 确定笔记本自动化服务的状态,正在运行的笔记本部署数量,以及分配给专用笔记本工作空间的存储类。

  • 属性 - 管理交互式和自动化笔记本部署的限制。

  • 运行时 - 查看和编辑可用的笔记本服务运行时设置。

查看和编辑属性

可以在 ArcGIS Enterprise Manager 中查看和编辑以下属性:

  • WebSocket 大小 (MB) - 可以使用 WebSocket 协议在服务器与客户端浏览器之间传递的数据包的最大大小(以兆字节为单位)。 使用 WebSocket 帮助与客户端进行高效、安全的双向通信。 此属性的默认值为 16 MB。 如果 notebook 需要将特别大的数据传递到服务器站点,则可能需要增大此限值。

  • 空闲笔记本阈值(分钟)- 此属性用于控制关闭空闲笔记本的时间。 将自动关闭已打开但在此时间段(以分钟为单位)内处于非活动状态的 notebook。 Notebook 的内核已停止。 默认值为 720 分钟。

  • 空部署阈值 - 此属性用于设置笔记本部署在未运行任何活动笔记本的情况下,可以保持打开状态的时间(以分钟为单位)。 达到此值后,部署将自动关闭。 默认设置为 60 分钟。 与空闲 notebook 阈值类似,您可能需要减小此值以节省资源。

  • 每个笔记本项目的最大快照数 - 此属性限制一个笔记本项目允许的快照数。 默认值为 5。

要查看和编辑属性,请完成以下步骤:

  1. 以管理员身份登录到 ArcGIS Enterprise Manager。

  2. 单击功能页面。

  3. 在笔记本服务卡片上,单击设置。

  4. 单击属性页面。

    如果更改任何设置值,则保存按钮将变为可用。

  5. 单击保存,保存编辑内容。

查看和编辑运行时

您可以在 ArcGIS Enterprise Manager 中执行以下运行时管理任务:

  • 查看可用的运行时。

  • 复制系统创建的运行时以创建用户创建的运行时。 每个运行时都可以单独配置,这使得不同类型的任务可以使用具有不同设置的运行时。

  • 查看和编辑每个运行时部署的可用系统资源。 如果有多个用户同时创作笔记本,您可以监控使用情况并根据需要调整这些设置。

  • 控制可以在其中计划运行时 pod 的节点。 当某些任务需要仅在集群中的某些节点上可用的资源(如 GPU)时,Pod 部署位置控制非常有用。

要查看或编辑运行时,请完成以下步骤:

  1. 以管理员身份登录到 ArcGIS Enterprise Manager。

  2. 单击功能页面。

  3. 在笔记本服务卡片上,单击设置。

  4. 单击运行时页面可查看可用运行时的列表。

  5. 要创建新的运行时,请单击要复制的系统创建的运行时旁边的复制。

  6. 单击要查看或编辑的运行时的名称。

  7. 要查看或编辑每个运行时部署可以访问的资源,请完成以下步骤:

    1. 单击运行时设置。

    2. 查看或编辑 CPU 请求和 CPU 限制。

    3. 查看或编辑内存请求、内存限制、最大交换内存和共享内存。

    4. 使用启用 GPU 切换按钮和 GPU 单元值可查看或编辑运行时对 GPU 资源的访问。 GPU 单元表示每个节点的 GPU 数量。

      注:

      必须配置 Kubernetes 集群以启用 GPU 资源。 有关详细信息,请参阅配置支持 GPU 的节点。

    5. 单击保存以保留编辑内容。

  8. 要查看或编辑运行时的 pod 部署位置设置,请完成以下步骤:

    1. 单击 Pod 部署位置。

    2. 查看或编辑节点亲和性和容忍度。

      如果正在为支持 GPU 的笔记本服务配置节点亲和性,请使用以下值:

      • 类型 - 必选

      • 键 - 指定用于标注 GPU 节点的键,例如 notebook。

      • 运算符 - In

      • 值 - 指定用于标注 GPU 节点的值,例如 NotebooksGPUNode。

      如果正在为支持 GPU 的笔记本服务配置容忍度,请使用以下值:

      • 效果 - 不执行

      • 键 - nvidia.com/gpu

      • 运算符 - Exists

    3. 如果配置新的节点亲和性或容忍度,请单击添加。

    4. 单击保存以保留编辑内容。

  9. 若要查看运行时中包含的库,请单击清单。

升级用户创建的笔记本运行时

如果您已从之前版本升级过 ArcGIS Enterprise,可以通过以下步骤在 ArcGIS Enterprise Manager 中升级用户创建的运行时:

  1. 以管理员身份登录到 ArcGIS Enterprise Manager。

  2. 单击功能页面。

  3. 在笔记本服务卡片上,单击设置。

  4. 单击运行时页面可查看可用运行时的列表。

  5. 在用户创建部分,为您想要升级的运行时点击升级运行时。

  6. 单击升级。

您的运行时现在已升级至最新版本。