Managed Runtime Administration

Managed Runtime 可以轻松管理与 PWA Kit 网店关联的组织、项目、环境和捆绑包。本指南描述在基于 Web 的 Runtime Admin 工具中可能执行的不断增长的管理任务列表。（本指南中描述的所有管理任务以及更多任务也可以使用 Managed Runtime API 完成。）

在继续之前，请确保您有权访问 Managed Runtime 和 Runtime Admin。如要配置 Managed Runtime，请联系 Success Manager。对于 Runtime Admin，请联系 Commerce Cloud 管理员并要求他们使用 Account Manager 将以下任一角色添加到您的帐户：Managed Runtime User（托管运行时用户）或 Managed Runtime Admin（托管运行时管理员）。

Important

项目

项目可帮助您管理组织内的多个环境。每个 PWA Kit 项目都需要 Managed Runtime 中的相应项目，用于在 Salesforce 的公共云基础架构上部署和托管网店代码。

创建项目

在 Runtime Admin 中创建项目：

登录 Runtime Admin。
点击新建项目。
输入项目的名称。
点击创建项目。

首次创建项目时，在部署必要的云基础架构之前，您的网站无法在 Web 上访问。此部署过程最多可能需要 40 分钟。

Note

在 Runtime Admin 中查找项目

本指南中其余管理任务的说明均假设您从 Runtime Admin 中的项目概览页面开始。

要查找现有项目并打开其概览页面：

登录 Runtime Admin。
如有必要，从组织菜单（左上角）中选择一个组织。
点击项目名称。（要查看项目，您必须被分配前面描述的项目角色之一。）

相关截图

要在项目之间快速切换，请使用页面顶部的项目菜单。

查看和编辑项目设置

您可以在“项目设置”页面执行以下任务：

查找项目 ID 并确保它与 PWA Kit 配置匹配。
编辑项目 ID。
查看和编辑项目的名称和 URL。
删除项目。
管理部署通知。（见下一节。）

要访问“项目设置”页面：

转到项目的“概述”页面。
点击左侧导航中的“项目设置”。

要编辑设置，请点击编辑，进行编辑，然后点击更新。要放弃您的编辑，请点击取消。

要删除项目，请点击删除，输入项目名称进行确认，然后点击是，删除。要保留项目，请点击否，保留。

部署通知

您可以选择在发生以下任何部署事件时通过电子邮件收到通知：

开始部署
成功部署
部署失败

添加通知

要添加通知：

转到项目的“概述”页面。
点击左侧导航中的项目设置。
点击添加通知。
选择要通知的一个或多个环境。
选择一个或多个部署事件。
输入所有通知收件人的电子邮件地址。
点击添加通知。

相关截图

编辑通知

要编辑通知：

转到项目的“概述”页面。
点击左侧导航中的项目设置。
点击通知旁边的**…**按钮。
点击编辑。
更改任何通知设置。
点击更新通知。

相关截图

移除通知

要移除通知：

转到项目的“概述”页面。
点击左侧导航中的项目设置。
点击通知旁边的**…**按钮。
点击删除。
点击是，移除。

相关截图

环境

环境用于将您的生产环境 (Production) 网店与为其他目的（例如开发或测试）部署的网店分开。要了解有关环境和其他相关概念的更多信息，请参阅 Managed Runtime 概述。

创建环境

在 Runtime Admin 中创建环境：

转到项目的“概述”页面。
点击新建环境
输入环境的名称。
选择要部署到 Salesforce 公有云基础架构的区域。
如果环境是生产环境：
- 将其标记为生产。如果您已达到生产环境 (Production) 的限度，请联系支持部门。有关详细信息，请参阅生产环境。
- 添加一个或多个站点 ID 以与环境相关联。
选择要连接到环境的 Commerce Cloud 实例。
单击**“完成设置”**。

新环境的默认区域是美国东部（弗吉尼亚北部），因为它最靠近通常与开发和测试环境相关联的 On-Demand Sandbox。
如果您之前创建了环境，则可以“编辑环境设置”以将其连接到 Commerce Cloud 实例和一个或多个站点 ID。
提供给生产环境或非生产环境的资源没有区别。所有环境都会自动扩展，以相同的方式处理流量。有关详细信息，请参阅生产环境。

Note

支持的区域

所有受支持的区域都有一个用于故障转移的配对备份区域。你负责确保应用程序在选定的主区域和备份区域中正确运行：

主要区域	备份区域
`us-east-1` - 美国东部（弗吉尼亚北部）	`us-east-2` - 美国东部（俄亥俄）
`us-east-2` - 美国东部（俄亥俄）	`us-east-1` - 美国东部（弗吉尼亚北部）
`us-west-1` - 美国西部（加利福尼亚北部）	`us-west-2` - 美国西部（俄勒冈）
`us-west-2` - 美国西部（俄勒冈）	`us-west-1` - 美国西部（加利福尼亚北部）
`ca-central-1` - 加拿大（Central）	`us-east-2` - 美国东部（俄亥俄）
`sa-east-1` - 南美洲（圣保罗）	`us-east-1` - 美国东部（弗吉尼亚北部）
`ap-south-1` - 亚太地区（孟买）	`ap-south-2` - 亚太地区（海得拉巴）
`ap-south-2` - 亚太地区（海得拉巴）	`ap-south-1` - 亚太地区（孟买）
`ap-southeast-1` - 亚太地区（新加坡）	`ap-northeast-2` - 亚太地区（首尔）
`ap-southeast-2` - 亚太地区（悉尼）	`ap-southeast-1` - 亚太地区（新加坡）
`ap-southeast-3` - 亚太地区（雅加达）	`ap-southeast-1` - 亚太地区（新加坡）
`ap-northeast-2` - 亚太地区（首尔）	`ap-southeast-1` - 亚太地区（新加坡）
`ap-northeast-1` - 亚太地区（东京）	`ap-northeast-3` - 亚太地区（大阪）
`ap-northeast-3` - 亚太地区（大阪）	`ap-northeast-1` - 亚太地区（东京）
`eu-west-1` - 欧洲（爱尔兰）	`eu-west-3` - 欧洲（巴黎）
`eu-west-2` - 欧洲（伦敦）	`eu-west-1` - 欧洲（爱尔兰）
`eu-west-3` - 欧洲（巴黎）	`eu-central-1` - 欧洲（法兰克福）
`eu-central-1` - 欧洲（法兰克福）	`eu-west-3` - 欧洲（巴黎）
`eu-central-2` - 欧盟（苏黎世）	`eu-central-1` - 欧洲（法兰克福）
`eu-south-1` - 欧盟（米兰）	`eu-central-1` - 欧洲（法兰克福）
`me-central-1` - 中东（阿联酋）	`eu-west-2` - 欧洲（伦敦）
`il-central-1` - 以色列（特拉维夫）	`eu-west-2` - 欧洲（伦敦）

部署捆绑包

对于使用 PWA Kit 和 Managed Runtime 的任何站点，您一次只能指定一个捆绑包为每个环境部署。

转到项目的“概述”页面。
点击要部署到的环境名称。例如：生产环境 (Production)。
在标题捆绑包下，点击要部署的捆绑包旁边的部署按钮。
点击确认部署。
等待部署完成。

成功完成部署后，捆绑包出现在标题已部署捆绑包下方。（如果是第一次部署到新环境，完成该过程最多可能需要一个小时。）

编辑环境设置

通过环境设置页面可以在一个地方执行多项管理任务，包括：

重命名环境或环境 ID。
更改部署区域。
启用或禁用服务器端 Cookie。请参阅使用 Cookies 进行个性化设置。
启用或禁用源映射。
允许具有特定 IP 地址或受信任的访问控制标头的流量访问环境。请参阅访问控制标头。
为环境配置代理。有关更多信息，请参阅代理请求。
将环境标记为生产。
添加、编辑或删除与环境关联的站点 ID。
添加或编辑环境与 Commerce Cloud 实例的连接。
删除环境。

要访问环境设置页面：

转到项目的概述页面
点击要编辑其设置的环境的名称。
点击左侧导航中的环境设置。

要进行编辑，请点击常规设置或高级设置旁边的编辑按钮。进行编辑后，点击更新以保存更改或点击取消以放弃更改。

清除环境的 CDN 缓存

可以在内容交付网络（CDN）中清除环境的部分或全部缓存内容。清除 CDN 缓存有助于确保购物者看到您网站上最新、最准确的内容版本。

projects_target_invalidation_create 使用 API 清除所有缓存的内容、特定的 URL 或目录。

无法在运行时管理中清除 CDN 缓存。但是，当您重新部署捆绑包时，这将清除关联环境的所有缓存内容。

CDN 缓存的废止会暂时导致废止后首次访问站点的购物者的性能降低。

Note

环境变量

参阅环境变量。

访问控制标头

访问控制标头允许您限制对环境的访问，以便只允许来自内容交付网络 (CDN) 或开发团队的受信任流量。限制访问对于确保机器人不会绕过 CDN 外围安全设置以及确保搜索爬虫不会索引来自错误域或环境的内容非常重要。

如果还设置了“允许的 IP 地址”，则允许具有有效 IP 地址或访问控制标头的请求通过。

使用

使用高级环境设置或 projects_target_access_control_header_create API 设置访问控制标头。

仅当 x-sfdc-access-control 请求标头存在且具有有效值时，才允许传入请求。

限制条件

标头值由所选的字符集组成。每个标头值：

必须至少为 9 个字符
最多可包含 128 个字符
可以是字母数字字符和 - 和 _ 字符的组合

轮换访问控制标头

您负责确保安全地存储访问控制标头值，并且仅与受信任的个人共享。我们强烈建议定期轮换访问控制标头。

要轮换访问控制标头，请执行以下操作：

使用高级环境设置或 projects_target_access_control_header_create API 将访问控制标头值添加到 Managed Runtime 环境。
等待环境重新部署成功完成。使用如下命令验证对具有新标头值的环境的请求是否成功：

1curl https://myproject-mytarget.mobify-storefront.com/ -H "x-sfdc-access-control: 123456789" -o /dev/null

更新 CDN 或浏览器以发送包含更新值的 x-sfdc-access-control 请求标头。
测试流量是否按预期被允许通过。
使用高级环境设置或 projects_target_access_control_header_create API 删除原始访问控制标头值。

另请参阅

配置环境

重定向

重定向允许您将请求从请求的 URL 转发到不同的 URL。重定向有助于避免因网店更改而导致的用户体验中断。例如，考虑春季的季节性活动页面。当春季活动结束并替换为夏季活动时，您可以从春季 URL 重定向到夏季 URL。

重定向是一项强大的功能，可能会对您的网店产生重大的安全后果，包括重定向到恶意 URL 或资源。在为用户分配角色以授予他们重定向访问权限时，请务必小心。

创建重定向

在生产环境 (Production) 中创建重定向之前，我们建议您先在准备环境 (Staging) 中创建它。

Tip

您还可以使用 projects_target_redirect_create API 端点创建一个或多个重定向。

要使用 Runtime Admin 创建重定向，请执行以下作：

转到项目的“概述”页面。
点击要在其中创建重定向的环境的名称。
点击左侧导航中的 URL 重定向。
点击创建重定向。
在重定向自字段中，输入相对 URL 路径。例如，要从 URL www.example.com/winter重定向访客，请输入 /winter。
在重定向到字段中，输入相对 URL 路径。
如果需要，启用查询参数和通配符路径的转发。（稍后会详细介绍转发设置。）
从重定向类型下拉菜单中，选择基于 HTTP 状态代码的重定向类型。（稍后会详细介绍状态码。）
点击创建重定向。

让我们更详细地考察创建重定向的选项。

路径

您在重定向来源字段中输入的值必须始终是相对路径。重定向目标字段可以是相对路径或完整 URL。例如，假设我们要将访客从 www.example.com/spring 重定向到 www.example.com/summer。重定向来源字段必须是 /spring。重定向目标字段可以是 /summer 或 www.example.com/summer。

通配符

您可以将星号字符 (*) 添加到重定向来源的末尾以指示通配符。通配符匹配 URL 中的任何（0 个或多个）字符。例如，来自 /a/* 的重定向将匹配 /a/、/a/b 和 /a/b/c。

只能在重定向来源 URL 的末尾使用通配符。

标准重定向首先由 Managed Runtime 处理，然后是带有通配符的重定向。

HTTP 状态码

大多数重定向使用永久 301 状态代码，但也可以选择临时 302。如果不确定要使用哪个 HTTP 状态码，请通过 MOZ.com 咨询此状态码解释器。

转发查询参数

有些请求包含您也希望包含在重定向请求中的查询字符串参数。例如，相对路径 /spring-landing-page 可以附加用于分析跟踪的查询字符串，如 /spring-landing-page?gclid=123。

要启用查询参数转发，请转到表单的转发部分并选择查询参数。否则，来自源 URL 的查询字符串参数不会包含在重定向 URL 中。

当重定向来源和重定向目标都具有查询字符串并且启用了转发时会发生什么情况？在这种情况下，重定向 URL 包括两个查询字符串的组合。来自重定向目标 URL 的查询参数附加到请求中的查询字符串。例如，假设您的应用程序接收到相对路径 /spring?year=2019 的请求。如果您选择重定向 /spring 到 /summer?year=2020，则启用转发时，重定向 URL 是 /summer?year=2019&year=2020。

转发通配符路径

您可以在重定向目标 URL 中自动包含重定向来源 URL 的通配符部分之后的任何路径。例如：如果 /a/* 匹配重定向来源 URL 中的 /a/b/c，并且重定向目标 URL 是 /z/，则重定向 URL 是 /z/b/c。

要启用通配符路径转发，请转到表单的转发部分并选择通配符路径。

复制重定向

我们建议您始终在准备环境 (Staging) 中创建重定向，并在测试后将其复制到生产环境 (Production) 中。

Tip

您可以使用复制重定向功能将所有重定向从一个环境复制到另一个环境。

您还可以使用 projects_target_redirect_clone_create API 端点克隆重定向。

要使用 Runtime Admin 克隆重定向，请执行以下作：

转到项目的“概述”页面。
点击包含要复制的重定向的环境名称。
点击左侧导航中的 URL 重定向。
点击复制重定向。将出现复制重定向表单。当前环境列在源环境（源）下。
在目标环境下，选择要将重定向复制到的环境（目标）。
点击复制 n 重定向。（其中 n 是要复制的重定向数。）

复制重定向时，您将目标环境中的所有重定向替换为源环境中的所有重定向。

Warning

编辑重定向

您还可以使用 projects_target_redirect_partial_update API 端点编辑重定向。

要使用 Runtime Admin 编辑现有重定向的设置，请执行以下作：

转到项目的“概述”页面。
点击包含要编辑的重定向的环境名称。
点击左侧导航中的 URL 重定向。
点击重定向旁边的省略号按钮 (…)。
点击编辑。
更新设置。
点击更新重定向。

删除重定向

您还可以使用 projects_target_redirect_destroy API 端点删除重定向。

要使用 Runtime Admin 删除重定向，请执行以下作：

转到项目的“概述”页面。
点击包含要删除的重定向的环境名称。
点击左侧导航中的 URL 重定向。
点击重定向旁边的省略号按钮 (…)。
点击删除。
点击是，删除重定向。

重定向疑难解答

如果重定向未按预期工作，请尝试以下疑难解答步骤：

清除浏览器缓存，因为重定向已缓存。
确认您正在查看正确环境的设置。
编辑重定向并验证在重定向来源和重定向目标字段中输入了正确的值。

重定向的技术限制

重定向具有以下技术限制：

每个环境最多可以有 10,000 个重定向。
每个环境都有自己的重定向组。您有责任使用复制使它们保持同步。
重定向功能支持从一条路径到另一条路径的简单重定向。对于带有条件的复杂重定向，请使用 ssr.js 中的 Express.js’ redirects support。
使用 Runtime Admin 工具或 Managed Runtime API 创建的重定向不在本地开发环境中运行。
PWA Kit 应用程序中的页面转换不会触发重定向；它们只能由 HTTP 请求触发。
要在网店环境中加载重定向，请使用托管端点 /mobify/redirect/$path。

用户

以下是管理用户的方法。

添加用户

要将用户添加到项目：

转到项目的“概述”页面。
点击左侧导航中的用户和权限。
点击新建用户。
输入用户的电子邮件地址。（确保用户是您组织的一部分，并且在 Account Manager 中具有以下任一角色：Managed Runtime User（托管运行时用户）或 Managed Runtime Admin（托管运行时管理员）。
选择角色。
点击添加用户。

相关截图

更改用户角色

更改用户角色：

转到项目的“概述”页面。
点击左侧导航中的用户和权限。
点击用户名旁边的**…**按钮。
点击编辑。
选择角色。
点击出现的弹出菜单。
选择新角色。
点击保存。

相关截图

有关与每个角色关联的用户能力列表，请参阅 Managed Runtime 概述。

移除用户

从项目中移除用户：

转到项目的“概述”页面。
点击左侧导航中的用户和权限。
点击用户名旁边的**…**按钮。
点击删除。
点击是，移除用户。

相关截图