Esri arcgis-notebook-server-singlemachine-upgrade.template.json Amazon Web Services (AWS) CloudFormation 模板可以升级您通过使用 CloudFormation 部署单机 ArcGIS Notebook Server 站点中描述的模板创建的 ArcGIS Notebook Server 10.9 或 10.9.1 站点。
arcgis-notebook-server-singlemachine-upgrade.template.json 模板可升级单机 Linux Amazon Elastic Compute Cloud (EC2) 实例上的以下软件:
- ArcGIS Notebook Server
- ArcGIS Web Adaptor
先决条件
先决条件可以按照您必须获取的项目(例如文件和帐户)以及在运行 CloudFormation 模板之前必须执行的任务来进行分组。
必需项目
运行此模板之前,您需要以下内容:
- 具有待升级部署的访问权限的 Amazon Web Services 帐户。
- ArcGIS Notebook Server 许可文件(.ecp 或 .prvc)。
- SSL 证书文件或证书(.pfx 格式)及对应密码。 证书必须来自证书颁发机构。
- 您使用 Esri Amazon Web Services CloudFormation 模板 arcgis-notebook-server-singlemachine.template.json 创建的现有单机 ArcGIS Notebook Server 站点。
- 升级 CloudFormation 模板,arcgis-notebook-server-singlemachine-upgrade.template.json。
注:
要升级您的部署,请运行此升级 CloudFormation 模板,此操作将创建一个新的 CloudFormation 堆栈。 请勿使用此模板升级现有 10.9 或 10.9.1 版本部署的 CloudFormation 堆栈。
必需任务
运行此模板之前,请完成以下任务:
- 在 AWS 帐户中准备部署的 Amazon Simple Storage Service (S3) 存储段。 启动堆栈时,您将指定模板中的存储段名称。
- 创建存储段或使用现有 S3 存储段。 您必须是存储段的所有者。
- 将 ArcGIS 软件授权文件上传到存储段。
- 将 SSL 证书文件上传到部署存储段。
- 在 AWS Secrets Manager 中配置密码(此为可选项,但建议选择)。
您可以在 AWS Secrets Manager 中配置帐户的密码,例如站点管理员用户名和 Windows arcgis 用户密码。 将为您提供密钥的 Amazon 资源名称 (ARN)。 启动堆栈时,在模板参数中使用 ARN 代替密码。 如果您不使用 AWS Secrets Manager 存储密码,则必须在启动堆栈时在模板参数中键入纯文本密码。
注:
当您在 AWS Secrets Manager 中创建一个密钥 ARN 以用于与 Esri CloudFormation 模板配合使用的密码时,必须使用其他密钥类型作为密钥类型,然后使用纯文本选项。 有关创建用于密码的 Amazon 资源名称的详细信息,请参阅 AWS CloudFormation 和 ArcGIS。
提示:
默认情况下,如果堆栈创建失败,CloudFormation 将删除部分创建的资源。 这十分有用,因为此操作从帐户中移除了无法使用的部署,但是可能使故障排除变得困难。 要在失败状态下保留堆栈,请在启动堆栈之前禁用失败时回滚 CloudFormation 堆栈创建选项。 有关详细信息,请参阅 AWS 帮助中的设置 AWS CloudFormation 选项。
参数
下表包含此模板中使用的参数以及每个参数的说明。
ArcGIS Notebook Server Configuration
参数名称 | 是否为必需项? | 参数说明 |
---|---|---|
ArcGIS Notebook Server EC2 实例 ID | 必填 | 选择现有 ArcGIS Notebook Server 站点中的 EC2 实例的 ID。 如果您使用 Esri CloudFormation 模板或 Cloud Builder 创建了现有站点,则可以在 AWS Management Console 中现有 CloudFormation 堆栈的资源部分中找到实例 ID。 资源的逻辑 ID 为 ArcGISNotebookServerEC2Instance。 |
Deployment Bucket Name | 必填 | 为包含软件许可文件和 SSL 证书的 Amazon S3 存储段提供名称。 此存储段必须已经存在,并且包含您的部署的许可文件和 SSL 证书。 您必须是存储段的所有者,并且该存储段必须位于与部署相同的 AWS 帐户内。 |
License File Name | 必填 | 提供 ArcGIS Notebook Server 授权文件对象密钥名称。 在启动此堆栈之前,您必须将许可文件(.ecp 或 .prvc 文件)上传到部署存储段。 您可以通过浏览到 Amazon S3 控制台中部署存储段中的文件来获取文件对象密钥名称。 示例包括 notebook.prvc 或 resources/licenses/server/notebook.prvc。 许可文件名称区分大小写。 确保名称和大小写输入正确。 |
License Level | 必填 | 选择 ArcGIS Notebook Server 许可级别。 选项如下:
|
Site Administrator User Name | 必填 | 提供现有 ArcGIS Notebook Server 站点的主站点管理员的用户名。 |
Site Administrator User Password | 必填 | 提供现有 ArcGIS Notebook Server 站点主站点管理员的密码。 您可以输入纯文本密码或 AWS Secrets Manager 中您的密钥 ID 的 ARN。 |
Site Domain Name | 必填 | 提供现有 ArcGIS Notebook Server 站点的完全限定域名。 |
Web Adaptor Name | 必填 | 提供现有 ArcGIS Notebook Server 站点的 Notebook Server Web Adaptor 名称。 |
SSL Certificate File Name | 必填 | 提供来自证书颁发机构的 SSL 证书(.pfx 文件)。 使用与创建现有部署时使用的证书相同(或更新的)SSL 证书。 在启动此堆栈之前,您必须将证书上传到部署存储段。 您可以通过浏览到 AWS S3 控制台中部署存储段中的文件(例如 domainname.pfx 或 resources/sslcerts/domainname.pfx)来获取文件对象密钥名称。 |
SSL 证书密码 | 必填 | 提供 SSL 证书的密码。 您可以输入纯文本密码或 AWS Secrets Manager 中您的密钥 ID 的 ARN。 有关创建用于密码的 Amazon 资源名称的信息,请参阅 AWS CloudFormation 和 ArcGIS。 |
输出
当您的堆栈成功创建后,可以在 AWS Management Console 中的 CloudFormation 堆栈的输出选项卡看到以下输出参数。
输出名称 | 输出描述 |
---|---|
ServerAdminDirURL | ArcGIS Server 管理员目录 URL。 |
ServerServicesURL | |
DeploymentLogsURL | 这是 Amazon CloudWatch 日志的 URL,其中存储了所有部署日志。 如果部署失败,您可以参考这些日志以进行故障排除。 |
注意事项
创建包含 ArcGIS 部署的 CloudFormation 堆栈后,需要考虑以下几项重要内容:
- 成功创建堆栈后(换言之,堆栈状态为 CREATE_COMPLETE),意味着 ArcGIS Notebook Server 站点已成功升级。 您可以登录 ArcGIS Notebook Server Admin 目录以进行验证。
- 如果 CloudFormation 堆栈未能成功创建(换言之,堆栈状态为 CREATE_FAILED),您可以按照以下“疑难解答”部分链接到的页面中提到的方法进行故障排除。 查明错误的根本原因并采取必要的措施后,您可以删除失败的堆栈并创建一个新堆栈以升级现有 ArcGIS Notebook Server 站点。
疑难解答
如果您在创建此 CloudFormation 堆栈时发现任何故障,请参阅 AWS 上的 ArcGIS 部署疑难解答。