Skip to main content

升级 ArcGIS Notebook Server

升级 ArcGIS Notebook Server 可为组织提供软件的最新功能和改进功能，同时保留您的用户的现有 notebook。 如果您要升级 ArcGIS Enterprise 部署，则必须将 ArcGIS Notebook Server 升级到相同版本。

ArcGIS Notebook Server 安装包可检测计算机上是否已安装先前版本的 ArcGIS Notebook Server。 如果已安装，它可以升级该软件。

您必须从 Esri 安装新的容器镜像，从而为您的用户提供合适的 notebook 运行时。 上一版本的 notebook 运行时将保留在站点中，用户仍可以使用这些运行时运行 notebook。 但是，如果您的用户想要使用最新版本的新功能，则他们必须更新其 notebook 运行时。

注:

如果任何 notebook 正在使用自定义运行时，则必须在 Windows Notebook Server 上重新构建和重新注册自定义运行时，并更新相关 notebook 项目的运行时设置。

注:

Notebook 运行时将遵循 ArcGIS Enterprise 生命周期予以停用。 Notebook 运行时将与关联的 ArcGIS Enterprise 版本同时停用。 Notebook 不应使用已停用运行时，并且应更新为受支持的运行时。

升级 ArcGIS Enterprise 门户还将更新站点库中提供的示例 notebook。

系统支持多机 ArcGIS Notebook Server 站点。 如果您具有单机站点并希望在升级后将 ArcGIS Notebook Server 站点扩展为多机站点，则在升级后，请按照步骤将附加计算机加入站点。

ArcGIS Notebook Server 的升级过程为就地升级，无需卸载并重新安装软件。 站点将在升级过程中关闭，在升级完成之前，用户无法进行访问或运行 notebook。

请按照以下步骤升级 ArcGIS Notebook Server。

准备升级

升级之前，请查看以下信息。

  • 可以在升级之前访问 My Esri 中的所有必需文件，包括最新的容器镜像。

  • 要使 ArcGIS Notebook Server 正常运行，其版本必须与联合的门户版本一致。

  • 如果您的 Notebook Server 当前处于只读模式，请在开始升级过程前关闭此模式。

  • 为 ArcGIS Notebook Server 安装容器引擎。

  • 升级 ArcGIS Enterprise 部署。

  • 升级任何其他服务器，包括 ArcGIS Notebook Server。

  • 请勿卸载现有 ArcGIS Notebook Server。 ArcGIS Notebook Server 安装程序和命令行安装程序专用于检测是否已安装 ArcGIS Notebook Server 组件并对其进行升级。

  • 在升级过程中的任何时间点，请勿从门户取消联合 ArcGIS Notebook Server 站点，或取消将其指定为门户的 Notebook Server。 将严重影响门户托管的现有 notebook。

  • 可以使用安装程序或命令行安装程序升级 ArcGIS Notebook Server。 选择其中一种方法进行升级。

  • 在升级之前，清除在 ArcGIS Notebook Server 计算机上使用的所有 Web 浏览器的缓存。

移动工作空间目录

对于工作空间目录位于 Notebook Server 安装目录的 Linux 上的单机 ArcGIS Notebook Server 部署，此过程为必需项。

注:

如果工作空间目录已位于 Notebook Server 安装目录之外，则无需执行此步骤。

  1. 以管理员身份登录 ArcGIS Enterprise 门户，然后打开 ArcGIS Notebook Server Manager。

  2. 单击设置选项卡。

  3. 单击目录。

  4. 确定 arcgisworkspace 目录的当前路径是否位于 ArcGIS Notebook Server 安装目录内。

    <installdir>/arcgis/notebook/directories/arcgisworkspace

    如果 arcgisworkspace 目录位于 ArcGIS Notebook Server 安装目录内，则您必须将工作空间目录移至安装目录外部的位置，然后才能进行升级。

    如果 arcgisworkspace 目录不在 ArcGIS Notebook Server 安装目录内，则无需执行本部分中的剩余步骤。

  5. 针对 arcgisworkspace 目录单击编辑。

  6. 将现有目录路径值替换为位于安装目录外部的 arcgisworkspace 目录的新路径。

    <installdir>/arcgis/arcgisnotebookserver/directories/arcgisworkspace

  7. 单击保存。

  8. 手动将先前 arcgisworkspace 目录内的所有内容复制到新 arcgisworkspace 目录。

更新配置存储位置

对于配置存储位于 Notebook Server 安装目录的 ArcGIS Notebook Server Linux 部署，此过程为必需项。 有关详细信息，请参阅指定配置存储位置。

注:

如果站点使用基于云的配置存储，或者配置存储已位于 Notebook Server 安装目录之外，则不必执行此步骤。

  1. 以管理员身份登录 ArcGIS Enterprise 门户，然后打开 ArcGIS Notebook Server Manager。

  2. 单击设置选项卡。

  3. 单击配置存储。

  4. 检查配置存储是否位于 Notebook Server 安装目录下。

    示例目录：/installation_directory/arcgis/notebookserver/usr/config-store。

  5. 如果配置存储位于 Notebook Server 安装目录下，请通过执行以下步骤将配置移动到外部位置：

    1. 将路径更新到新位置。

      示例目录：/installation_directory/arcgisnotebookserver/usr/config-store。

    2. 单击是移动当前配置。

    3. 单击保存。

更新服务器目录

对于服务器目录位于 Notebook Server 安装目录的 ArcGIS Notebook Server Linux 部署，此过程为必需项。

注:

如果服务器目录已位于 Notebook Server 安装目录之外，则无需执行此步骤。

  1. 以管理员身份登录 ArcGIS Enterprise 门户，然后打开 ArcGIS Notebook Server Manager。

  2. 单击设置选项卡。

  3. 单击目录。

  4. 检查安装目录下是否有 arcgisoutput、arcgisjobs 和 arcgissystem 目录。

    /installation_directory/arcgis/notebookserver/usr/directories

  5. 如果它们位于安装目录下，请对每个目录执行以下步骤。

    1. 单击编辑。

    2. 将路径更新到新位置。

      示例目录：/installation_directory/arcgisnotebookserver/usr/directories/<server directory>。

    3. 单击保存。

更新日志目录

对于日志目录位于 Notebook Server 安装目录的 ArcGIS Notebook Server Linux 部署，此过程为必需项。

注:

如果日志目录已位于 Notebook Server 安装目录之外，则无需执行此步骤。

  1. 以管理员身份登录 ArcGIS Enterprise 门户，然后打开 ArcGIS Notebook Server Manager。

  2. 单击设置选项卡。

  3. 单击日志。

  4. 检查日志目录是否在安装目录下。

    /installation_directory/arcgis/notebookserver/usr/directories

  5. 如果其在安装目录下，请执行以下步骤将其移动到外部位置。

    1. 将路径更新到新位置。

      示例目录：/installation_directory/arcgisnotebookserver/logs。

    2. 单击保存。

    3. 手动将所有内容从旧日志目录复制到新位置。

备份部署

在升级之前，建议对部署进行备份。

有关详细信息，请参阅备份和恢复 ArcGIS Notebook Server。

升级容器引擎

请将容器引擎升级到受支持的版本。

注:

在多机 Notebook Server 站点上，在每台计算机上执行此步骤。

使用安装程序升级

注:

使用安装文件升级 ArcGIS Notebook Server。 升级安装程序后，必须使用配置向导或升级站点实用程序来升级 ArcGIS Notebook Server 站点。

如果您拥有多机站点，请针对一台计算机执行步骤 1 到 3，然后针对站点中的每台计算机重复这些步骤。

ArcGIS Notebook Server 专用于检测并升级现有的 ArcGIS Notebook Server 组件安装。

要使用安装程序进行升级，请完成以下步骤：

  1. 在提取 ArcGIS Notebook Server 的位置上运行 ./Setup，然后按照提示完成升级。

    必须以安装了现有 ArcGIS Notebook Server 的用户账户运行安装程序。 在安装过程中，安装程序将识别现有安装，并提示您确认升级。 输入选项 y 以继续安装。

    这将卸载先前版本的 ArcGIS Notebook Server 并安装 ArcGIS Notebook Server 的升级版本。

  2. 升级实用程序完成后，请重新授权 ArcGIS Notebook Server 软件。 请使用软件授权向导完成授权。

  3. 可以使用升级安装结束时列出的 URL 打开配置向导，然后按照屏幕上的说明来升级站点。

  4. 对于多机站点，请针对站点中的每台计算机执行步骤 1 到 3。

通过命令行升级

要通过命令行升级，请完成以下步骤：

  1. 要开始升级，请使用下例所示的参数从提取 ArcGIS Notebook Server 的位置运行 ./Setup，然后按照提示完成升级。

    这将卸载先前版本的 ArcGIS Notebook Server 并安装 ArcGIS Notebook Server 的升级版本。

    <untar directory>/Setup -l yes -m silent

  2. 升级实用程序完成后，请重新授权 ArcGIS Notebook Server 软件。 要静默授权 ArcGIS Notebook Server，请使用以下语法运行软件授权：

    <ArcGIS Notebook Server install directory>/tools/authorizeSoftware

    运行以下命令以查看所有授权选项：

    <ArcGIS Notebook Server install directory>/tools/authorizeSoftware --help

    注:

    有关在离线环境中授权 ArcGIS Notebook Server 安装的信息，请参阅以下在离线环境中授权部分。

  3. 可以使用 upgradesite 命令行实用程序升级站点。

    此实用程序具有两个参数：

    • -s - 当包含于命令行中时，将提示实用程序运行升级。 如果不使用 -s 则升级不会运行。 这可以作为安全保证以确保在您准备就绪时运行升级。

    • -h - 显示工具的帮助。 如果命令不使用 -s 时运行，帮助也会显示。

    默认情况下，upgradesite 实用程序可在 ${HOME}/arcgis/notebookserver/tools/upgradesiteutility/upgradesite.sh 位置找到。

    升级之前，查看本主题开头的准备信息。 当您准备就绪以进行升级时，在要升级的计算机上打开命令终端。 浏览到实用程序所在的目录然后运行以下命令：

    > ./upgradesite.sh -s

    实用程序将显示进程报告并在完成升级时停止。

  4. 对于多机站点，请针对站点中的每台计算机执行步骤 1 到 3，然后继续执行下一部分中的步骤。

静默授权

升级实用程序完成后，必须重新授权 ArcGIS Notebook Server 软件。

要静默授权 ArcGIS Notebook Server，请使用以下语法运行软件授权：

<ArcGIS Notebook Server install directory>/tools/authorizeSoftware

运行以下命令以查看所有授权选项：

<ArcGIS Notebook Server install directory>/tools/authorizeSoftware --help

在离线环境中授权

您可以在离线环境中使用配置 (.prvc) 文件对 ArcGIS Notebook Server 进行授权。 在此过程中将生成文件，供您发送至 Esri 以完成过程。

  1. ArcGIS Notebook Server 升级完成后，在提示符处运行以下命令：

    <ArcGIS Notebook Server installation directory>/tools/authorizeSoftware -f <full path to the .prvc file> -o <full path to authorization file output>

  2. 创建输出信息文件后，请执行以下其中一项操作：

    • 浏览至 Esri 自助服务站点。 按照屏幕中的指示上传授权信息文件并下载 .ecp 授权文件。

    • 以电子邮件形式将授权信息文件发送到 authorize@esri.com。 Esri 将以电子邮件形式返回 .ecp 授权文件。

  3. 通过以上任何一种方式获得 .ecp 授权文件后，请再次运行 authorizeSoftware 脚本以对其进行处理，然后完成服务器授权过程：

    <ArcGIS Notebook Server installation directory>/tools/authorizeSoftware -f <full path to the .ecp file>

对每台运行 ArcGIS Notebook Server 的计算机重复此工作流。

升级后的步骤

在使用已升级并重新授权的 ArcGIS Notebook Server 站点之前，您必须运行安装后配置实用程序，以将新 Docker 容器镜像添加到站点。 您还必须替换注册到站点的 ArcGIS Web Adaptor 实例以匹配新版本。

运行安装后实用程序

要运行安装后实用程序，请完成以下步骤：

  1. 使用 ArcGIS Notebook Server 安装账户打开终端。

  2. 将工作目录更改为 ArcGIS Notebook Server 工具文件夹。

    默认情况下，路径为 ${HOME}/arcgis/notebookserver/tools/postInstallUtility。

  3. 或者，通过运行以下命令参阅实用程序的帮助：

    ./PostInstallUtility.sh -h

  4. ArcGIS Notebook Server 要求在计算机上安装容器引擎。 要确定计算机上的容器引擎是否处于活动状态，请运行以下命令：

    ./PostInstallUtility.sh -d

    1. 如果不符合 Docker 安装要求，请立即安装。

  5. 从 My Esri 下载您的设置所需的运行时镜像：

    • ArcGIS Notebook Server Python 容器镜像 (Standard)

    • ArcGIS Notebook Server Python 容器镜像 (Advanced)

      注:

      仅当您具有 ArcGIS Notebook Server Advanced 许可时，才需要 Advanced 运行时。

  6. 通过指定文件路径安装一个或多个运行时镜像。

    注:

    镜像应压缩为 .tar.gz 格式。

    注:

    确保您的计算机至少有 75 GB 的可用磁盘空间。

    注:

    如果您拥有 Advanced 许可，确保同时安装这两个容器镜像，因为您的用户可能仍需要使用 Standard 运行时。

    运行以下命令：

    ./PostInstallUtility.sh -l <path of .tar.gz Docker image>

注:

不会自动移除旧镜像。 您必须在删除先前的运行环境镜像前，将每个 notebook 的运行环境手动更新至新版本。

替换 ArcGIS Web Adaptor 实例

要替换 ArcGIS Web Adaptor 实例，请完成以下步骤：

  1. 从站点取消注册之前的 ArcGIS Web Adaptor 实例并卸载。

    1. 登录 ArcGIS Notebook Server Administrator Directory。

    2. 浏览至系统 > Web Adaptor > 已注册计算机。

    3. 单击取消注册 Web Adaptor。

  2. 安装一个 ArcGIS Web Adaptor 新实例，并将其与 ArcGIS Notebook Server 一起配置。

    部署升级完成后，您可以使用最新版本中的功能。

ArcGIS Notebook Server 站点现在即可托管 ArcGIS Notebooks。

更新现有 notebook 和 Web 工具的运行时

此过程必须由每个 notebook 作者执行，以将他们的 notebook 和 notebook Web 工具升级为使用最新的 notebook 运行时。

  1. 按照更改 notebook 运行时中的步骤，将每个 notebook 项目的运行时更新为最新的 notebook 运行时。

  2. 如果 notebook 发布为 Web 工具，请在更新 notebook 运行时后覆盖 Web 工具。

  3. 如果任何 notebook 正在运行自定义运行时，请更新自定义运行时并更新关联 notebook 项目的运行时设置。

移除先前的 notebook 运行时

（可选）您可以移除先前版本的 ArcGIS Notebook Server 运行时镜像以释放磁盘空间。

注意：

在移除先前版本之前，确保所有现有 notebook 已更新为使用最新版本的 ArcGIS Notebook Server 运行时镜像。

  1. 以管理员身份启动命令提示符。

  2. 输入以下命令以查看当前镜像的列表，并记录您要移除的先前版本的镜像 ID。

    docker images -a

  3. 输入以下命令以移除先前的运行时版本。

    docker image rm <IMAGE ID>

Windows Server 2022 和 Windows Server 2025 支持 Windows 容器上的 ArcGIS Notebook Server。

注:

如果之前在 Windows Server 2019 上安装了 ArcGIS Notebook Server，则必须先升级操作系统，才能在 Windows 容器上升级到 ArcGIS Notebook Server。 或者，可以在 Windows Server 2022 或 Windows Server 2025 上执行 ArcGIS Notebook Server 的全新安装，并将其配置为 ArcGIS Enterprise 部署的 Notebook Server 服务器。

注:

如果您的 Notebook Server 当前处于只读模式，请在开始升级过程前关闭此模式。

备份部署

在升级之前，建议对部署进行备份。

有关详细信息，请参阅备份和恢复 ArcGIS Notebook Server。

升级在支持的 Windows OS 上安装的 ArcGIS Notebook Server

要在 Windows Server 2022 或 Windows Server 2025 上升级 ArcGIS Notebook Server，请完成以下步骤：

  1. 升级 ArcGIS Enterprise 部署。

  2. 如果从 11.3 或更低版本升级，请使用 ArcGIS Notebook Server 示例数据卸载程序或命令行卸载 ArcGIS Notebook Server 示例数据。

    要从命令行卸载，请运行以下命令：

    msiexec /x {3A9E12F6-7D4B-4DA2-BA2C-C9D0E900CF94} /qb

  3. 使用安装程序或命令行升级 ArcGIS Notebook Server。

  4. 从站点取消注册之前的 ArcGIS Web Adaptor 实例。

  5. 卸载 ArcGIS Web Adaptor。

  6. 安装一个 ArcGIS Web Adaptor 新实例，然后使用 ArcGIS Notebook Server 进行配置。

    注:

    确保保留同一 Web Adaptor 实例名称。

  7. 升级容器引擎。

  8. 安装最新的 ArcGIS Notebook Server Windows 容器镜像。

  9. 确保每个 notebook 作者都将其现有 notebook 项目和 Web 工具的运行时更新为最新的 ArcGIS Notebook Server 运行时。

    有关详细信息，请参阅更改 notebook 运行时部分。

    如果 notebook 发布为 Web 工具，必须在更新 notebook 运行时后覆盖 Web 工具。

    注:

    如果任何 notebook 正在运行自定义运行时，则必须在 Windows Notebook Server 上重新构建和重新注册自定义运行时，并更新相关 notebook 项目的运行时设置。

    更新在运行时中配置的内存和 CPU 使用率设置。

  10. （可选）移除先前版本的 ArcGIS Notebook Server 运行时镜像以释放磁盘空间。

    注意：

    确保所有现有 notebook 已更新为使用最新版本的 ArcGIS Notebook Server 运行时镜像。

    1. 列出镜像。

    docker images -a

    1. 记下与先前版本的 ArcGIS Notebook Server 运行时镜像对应的 IMAGE ID。

    2. 移除该镜像。

    docker image rm <IMAGE ID>

在 Windows Server 2022 上升级 ArcGIS Notebook Server，并从 Linux 容器迁移到 Windows 容器

要在 Windows Server 2022 上升级之前安装的 ArcGIS Notebook Server 并从 Linux 容器迁移到 Windows 容器，请完成以下步骤：

  1. 升级 ArcGIS Enterprise 部署。

  2. 如果从 11.3 或更低版本升级，请使用 ArcGIS Notebook Server 示例数据卸载程序或命令行卸载 ArcGIS Notebook Server 示例数据。

    要从命令行卸载，请运行以下命令：

    msiexec /x {3A9E12F6-7D4B-4DA2-BA2C-C9D0E900CF94} /qb

  3. 使用安装程序或命令行升级 ArcGIS Notebook Server。

  4. 从站点取消注册之前的 ArcGIS Web Adaptor 实例。

  5. 卸载 ArcGIS Web Adaptor。

  6. 安装一个 ArcGIS Web Adaptor 新实例，然后使用 ArcGIS Notebook Server 进行配置。

    注:

    确保保留同一 Web Adaptor 实例名称。

  7. 在 Notebook Server 重新启动后，如果管理员站点目录可访问，请以管理用户身份进行登录。

  8. 单击 Notebooks > 运行时。

  9. 运行恢复出厂运行时。

    这将更新 Esri notebook 运行时，以使用基于 Windows 容器的 notebook 运行时镜像。

  10. 卸载 Docker Desktop。

  11. 安装 Mirantis Container Runtime 或通过二进制文件安装 Docker Engine。

  12. 安装最新的 ArcGIS Notebook Server Windows 容器镜像。

    注:

    如果是多计算机站点，针对站点中的每台计算机重复步骤 3、10-12。

  13. 确保每个 notebook 作者都将其现有 notebook 项目和 Web 工具的运行时更新为最新的 ArcGIS Notebook Server 运行时。

    有关详细信息，请参阅更改 notebook 运行时部分。

    如果 notebook 发布为 Web 工具，必须在更新 notebook 运行时后覆盖 Web 工具。

    注:

    如果任何 notebook 正在使用自定义运行时，则必须在 Windows Notebook Server 上重新构建和重新注册自定义运行时，并更新相关 notebook 项目的运行时设置。

  14. 更新在运行时中配置的内存和 CPU 使用率设置。

将 Windows Server 2019 上使用 Linux 容器的 ArcGIS Notebook Server 升级为 Windows Server 2022 或 Windows Server 2025 上使用 Windows 容器的 ArcGIS Notebook Server

要将 Windows Server 2019 上且使用 Linux 容器的旧安装版本升级为在 Windows Server 2022 或 Windows Server 2025 上运行的 ArcGIS Enterprise（包含使用 Windows 容器的 ArcGIS Notebook Server），请完成以下步骤：

  1. 按照以下子步骤从 ArcGIS Enterprise 中移除 ArcGIS Notebook Server：

    1. 以组织管理员身份登录 ArcGIS Portal Directory 管理员位置。

      注:

      URL 为 https://webadaptorhost.domain.com/arcgis/portaladmin，其中 arcgis 是注册到门户的 Web Adaptor 的名称。

    2. 单击联合 > 服务器。

    3. 选择要解除联合的 Notebook Server。

    4. 单击解除联合。

  2. 升级 ArcGIS Enterprise 部署。

  3. 在新 Notebook Server 计算机中，安装必备软件。

  4. 安装 ArcGIS Notebook Server。

  5. 安装后配置 ArcGIS Notebook Server。

  6. 创建站点。

  7. 安装和配置 ArcGIS Web Adaptor。

  8. 如果是多计算机站点，针对每台计算机重复步骤 4 和 5，并将其他计算机加入站点。

  9. 使用门户配置 ArcGIS Notebook Server。

  10. 确保每个 notebook 作者都将其现有 notebook 项目和 Web 工具的运行时更新为最新的 ArcGIS Notebook Server 运行时。

    有关详细信息，请参阅更改 notebook 运行时部分。

    如果 notebook 发布为 Web 工具，必须在更新 notebook 运行时后覆盖 Web 工具。

    注:

    如果任何 notebook 正在使用自定义运行时，则必须在 Windows Notebook Server 上重新构建和重新注册自定义运行时，并更新相关 notebook 项目的运行时设置。

  11. 更新在运行时中配置的内存和 CPU 使用率设置。

配置离线部署

如果在无互联网接入或组织禁止互联网接入的环境中配置 ArcGIS Notebook Server，请参阅配置离线部署。