多租户 SaaS 应用(CAP) · 2 · 基础实现(2/4)
项目 |
内容 |
|---|---|
官方仓库 |
|
业务场景 |
把 CAP 应用改造成多租户 SaaS:租户订阅、数据隔离、按租户配置 |
技术栈 |
CAP(Node.js/Java)、mtxs、SaaS Registry、XSUAA、Cloud Foundry / Kyma |
对应课程 |
|
对应路径 |
第 2 条、第 7 条 |
为什么值得做:多租户是 SaaS 产品的分水岭。 本案例实现了租户开通、数据隔离与升级机制, 用一个应用即可服务众多客户。
动手要点:
理解 SaaS Registry 与租户感知应用之间的关系。
研读
mta.yaml与租户部署描述文件——大部分复杂度都集中在这里。
本页内容抓取自官方仓库 SAP-samples/btp-cap-multitenant-saas,共收录 8 篇官方文档(README 与 docs)。原仓库内容版权归 SAP SE,遵循其许可证。
把数据推送到 SaaS API
Kyma ✅
Cloud Foundry ✅
SaaS 示例应用内置了一个 SaaS API,订阅方可以通过它把数据推送到自己的租户数据库容器,或修改现有数据。本部分教程将介绍如何以 SaaS 租户的身份连接这个 API 端点,并推送一些示例数据。
把数据推送到 SaaS API
SaaS API 访问
更多信息
在基础版本中,我们会保持简洁,说明如何使用 GitHub 仓库中提供的 HTTP 示例文件与 SaaS API 交互。你也可以借助 Postman 或 Insomnia 等工具执行类似请求。
1. SaaS API 访问
下面展示的是租户数据模型中的数据表,订阅方可以通过 SaaS API 维护这些表。除产品主数据外,SaaS 订阅方还可以通过该 API 处理事务性数据,从而预填其可持续性(Sustainability)评估。
产品(Products)、销售订单(Sales Orders)以及回收数据等主要实体都可以通过该 API 维护。如你所见,这里还提供了一些用于批量插入、更新和 upsert 的示例端点(通过 SAP HANA 存储过程或 CAP 原生 Upsert 特性实现)。
要以订阅方身份连接 SaaS API,请确保已按 Subscribe a Consumer Subaccount(点击此处)中的步骤操作。你需要为订阅方子账户中的 API Broker 服务实例创建的服务绑定凭据。如果尚未创建该服务绑定,请先返回并完成创建。
1.1. 首先切换到 /code/test/http 目录。在这里你可以找到示例 API 调用,通过多租户 SaaS API 把示例数据推送到租户数据库容器。本示例中,我们会把 Product 示例数据(apiProducts.http)推送到 SaaS API,数据将存储在对应的租户数据库容器中。请确保已安装所需的插件(例如 VS Code 插件),以便在 HTTP 文件中执行请求。
1.2. 在执行 HTTPS 调用之前,我们需要在同一目录 /code/test/http 下创建 .env 文件,并在其中提供租户特定的客户端凭据。
重要 - 请确保不要将这些信息提交到 GitHub!保存前请删除凭据,或将 HTTP 文件重命名为 -private.http(例如 apiProducts-private.http),这类文件会被 .gitignore 排除。
该文件的内容如下:
xsuaaHostname=<<uaa.url in service key>>
btpXsuaaClient='<<uaa.clientid in service key>>'
btpXsuaaSecret='<<uaa.clientsecret in service key>>'
apiEndpointBtp=<<apiUrl (!not uaa.apiUrl!) - field from Service Binding>>
提示 - xsuaaHostname 等于 uaa.url 参数。apiEndpointBtp 等于 apiUrl 参数。
1.3. 根据租户子账户的客户端凭据更新相关参数后,你就可以请求 OAuth 令牌来访问 SaaS API。执行下面的请求,它会返回一个 Bearer 访问令牌,可用于后续的 API 调用。该令牌让 CAP 框架能够唯一标识某个租户,并将其连接到正确的租户数据库容器。
重要 - 如果遇到 Unauthorized 错误,请尝试对客户端 ID 和密钥进行 URL 编码(可用各种 Web 工具或 npm 包),然后重新获取令牌!
# @name getXsuaaToken
POST {{$dotenv xsuaaHostname}}/oauth/token
Accept: application/json
Content-Type: application/x-www-form-urlencoded
client_id={{$dotenv btpXsuaaClient}}
&client_secret={{$dotenv btpXsuaaSecret}}
&grant_type=client_credentials
1.4. 获取访问令牌后,执行下面的请求,以当前订阅方租户的身份把示例产品上传到 SaaS API。相应的产品数据会存储在租户数据库容器中,可用于在该租户的 SaaS 示例应用实例中创建新的评估。所需的访问令牌取自上一个 OAuth 请求的结果。
提示 - 在高级特性中你会了解到,示例 EPM 模型提供了相同的数据值,并且订阅方的本地部署解决方案(如 SAP S/4HANA)也可以调用相同的 SaaS API 端点来推送这些示例产品数据。
@access_token = {{getXsuaaToken.response.body.$.access_token}}
# @name uploadProductsBtp
POST {{$dotenv apiEndpointBtp}}/rest/api/bulkUpsertProducts
Authorization: Bearer {{access_token}}
Content-type: application/json
{
"products" : [
{"ID":"HT-1000","typeCode":"PR","category":"Notebooks","supplierId":"0100000046","taxTarifCode":1,"measureUnit":"EA","weightMeasure":4.2,"weightUnit":"KG","price":956,"text":"Notebook Basic 15","language_code":"E","currency_code":"EUR"},
{"ID":"HT-1001","typeCode":"PR","category":"Notebooks","supplierId":"0100000047","taxTarifCode":1,"measureUnit":"EA","weightMeasure":4.5,"weightUnit":"KG","price":1249,"text":"Notebook Basic 17","language_code":"E","currency_code":"EUR"},
{"ID":"HT-1002","typeCode":"PR","category":"Notebooks","supplierId":"0100000048","taxTarifCode":1,"measureUnit":"EA","weightMeasure":4.2,"weightUnit":"KG","price":1570,"text":"Notebook Basic 18","language_code":"E","currency_code":"USD"},
{"ID":"HT-1003","typeCode":"PR","category":"Notebooks","supplierId":"0100000049","taxTarifCode":1,"measureUnit":"EA","weightMeasure":4.2,"weightUnit":"KG","price":1650,"text":"Notebook Basic 19","language_code":"E","currency_code":"EUR"},
{"ID":"HT-1055","typeCode":"PR","category":"Multifunction Printers","supplierId":"0100000069","taxTarifCode":1,"measureUnit":"EA","weightMeasure":6.3,"weightUnit":"KG","price":99,"text":"Multi Print","language_code":"E","currency_code":"EUR"},
{"ID":"HT-1056","typeCode":"PR","category":"Multifunction Printers","supplierId":"0100000070","taxTarifCode":1,"measureUnit":"EA","weightMeasure":4.3,"weightUnit":"KG","price":119,"text":"Multi Color","language_code":"E","currency_code":"JPY"},
{"ID":"HT-1060","typeCode":"PR","category":"Mice","supplierId":"0100000071","taxTarifCode":1,"measureUnit":"EA","weightMeasure":0.09,"weightUnit":"KG","price":9,"text":"Cordless Mouse","language_code":"E","currency_code":"EUR"},
{"ID":"HT-1063","typeCode":"PR","category":"Keyboards","supplierId":"0100000074","taxTarifCode":1,"measureUnit":"EA","weightMeasure":2.1,"weightUnit":"KG","price":14,"text":"Ergonomic Keyboard","language_code":"E","currency_code":"BRL"},
{"ID":"HT-1120","typeCode":"PR","category":"Keyboards","supplierId":"0100000065","taxTarifCode":1,"measureUnit":"EA","weightMeasure":1,"weightUnit":"KG","price":29,"text":"Cordless Bluetooth Keyboard","language_code":"0","currency_code":"EUR"}
]
}
1.5. 使用下面的请求,为租户数据库容器中已存储的产品数据补充更多细节。该请求会更新现有产品记录,加入销售拆分(sales split)明细和额外的可持续性信息。
提示 - 你可能会问,为什么这些额外细节没有包含在最初的产品数据请求中?原因是这些高级产品信息并不属于 EPM 模型,只是为了说明一个潜在的可持续性用例而添加的。因此,它必须通过手工上传或在 SaaS 应用本身中维护。
# @name uploadProductsExtendedBtp
POST {{$dotenv apiEndpointBtp}}/rest/api/bulkUpsertProducts
Authorization: Bearer {{access_token}}
Content-type: application/json
{
"products" : [
{"ID": "HT-1000","eolProductDesign": 43,"traditionalSalesShare": 82,"repairSalesShare": 8,"resellSalesShare": 10},
{"ID": "HT-1001","eolProductDesign": 38,"traditionalSalesShare": 97,"repairSalesShare": 3,"resellSalesShare": 0},
{"ID": "HT-1002","eolProductDesign": 35,"traditionalSalesShare": 87,"repairSalesShare": 5,"resellSalesShare": 8},
{"ID": "HT-1003","eolProductDesign": 42,"traditionalSalesShare": 74,"repairSalesShare": 20,"resellSalesShare": 6},
{"ID": "HT-1055","eolProductDesign": 56,"traditionalSalesShare": 98,"repairSalesShare": 1,"resellSalesShare": 1},
{"ID": "HT-1056","eolProductDesign": 49,"traditionalSalesShare": 95,"repairSalesShare": 3,"resellSalesShare": 2},
{"ID": "HT-1060","eolProductDesign": 25,"traditionalSalesShare": 99,"repairSalesShare": 0,"resellSalesShare": 1},
{"ID": "HT-1063","eolProductDesign": 34,"traditionalSalesShare": 97,"repairSalesShare": 1,"resellSalesShare": 2},
{"ID": "HT-1120","eolProductDesign": 28,"traditionalSalesShare": 95,"repairSalesShare": 2.5,"resellSalesShare": 2.5}
]
}
1.6. 如果你想继续上传 CSV 测试文件中提供的相同示例数据(点击此处),可以使用其余的 HTTP 文件。只需在 HTTP 文件的开头提供租户子账户特定的客户端凭据,即可把示例内容推送到各自的订阅方租户。别忘了把文件重命名为 -private.http,以免被提交到 Git。
1.7. 推送完 HTTP 文件中的全部数据后,你就可以继续本教程的下一部分,端到端测试 SaaS 示例应用。你可以为上传的产品创建评估,甚至预填销售订单、材料和回收示例值。下面是基于产品 HT-1000 所提供数据创建的一个示例评估。
1.8. 接下来可以继续本教程的下一部分,从订阅方视角端到端地测试 SaaS 示例应用。
2. 更多信息
请通过以下链接进一步了解上述主题:
测试应用
Kyma ✅
Cloud Foundry ✅
本部分教程(你已订阅该应用)将指导你从消费方视角测试 SaaS 示例应用。
测试应用
打开应用
创建新项目
创建评估
评估摘要
预填功能的使用
创建成员用户
添加项目成员
更多信息
请确保使用分配了 Susaas Administrator 角色的租户用户来执行本章的步骤。本章还会介绍如何创建另一个具有普通 Susaas Member 角色的租户用户。
1. 打开应用
转到你的租户子账户,点击 Instances and Subscriptions。使用你在 Subscribe a Tenant Subaccount 中创建的租户管理员用户登录。
提示 - 如果已登录该应用,可以用无痕模式打开应用,以其他用户身份登录。
登录后,你应该会看到如下所示的首页。
2. 创建新项目
2.1. 在首页上选择 Manage Projects。
2.2. 在 Manage Projects 页面点击 Create。
2.3. 填写必填的 Project details,然后点击 Create。
3. 创建评估
3.1. 要创建评估,切换到 Assessments 标签页,然后点击 Create 按钮。
3.2. 从值帮助中选择一个产品,然后点击 Continue。项目会自动预填。
提示 - 如果在值帮助中看不到产品,请确认你已完成教程中的 Push data to the SaaS API 部分(点击此处)!
3.3. 输入必填的说明,然后点击 Create。
3.4. 切换到 Circularity Metrics 标签页,然后点击 Edit 添加循环性数值。
3.5. 为所选产品添加如下示例循环性数值,然后点击 Save。
3.6. 切换到 Sales Splits 标签页,然后点击 Edit 添加销售拆分数值。
3.7. 添加如下示例销售拆分数值,然后点击 Save。
3.8. 切换到 Material Splits 标签页,然后点击 Edit 添加材料拆分数值。
3.9. 添加如下示例材料拆分数值,然后点击 Save。
评估摘要
材料拆分
销售拆分
循环性指标
预填功能的使用
不妨试试每个评估标签页中都有的 Prefill 按钮。如果你已在本教程的 Push data to the SaaS API 部分(点击此处)提供了相应的示例数据,预填功能会用这些数值填充表格。
4. 创建成员用户
4.1. 转到应用首页,点击 Manage Users。
4.2. 点击如下图所示的 Create 按钮。
4.3. 按下图填写必填值。
提示 - 在基础版本中,下面给出的电子邮件地址应已存在于 SAP ID Service 中。
4.4. 查看已创建的用户。
5. 添加项目成员
5.1. 转到应用首页,点击 Manage Projects。
5.2. 选择你在开始时创建的 My Test Project。
5.3 点击 Members 区域,然后点击如下图所示的 Edit 按钮。
5.4. 从值帮助中选择一个用户,然后点击 Save。
6. 更多信息
请通过以下链接进一步了解上述主题:
目前暂无更多信息!
了解应用组件
Kyma ✅
Cloud Foundry ✅
部署示例应用后,你的 SAP BTP 提供方子账户的 Cloud Foundry 环境或 Kyma 集群中将提供以下组件。
了解应用组件
Application Router
UI 组件
业务应用服务
API 服务
API 服务代理
租户数据库容器
共享数据库容器
更多信息
本部分教程将深入介绍各个组件,帮助你积累关于服务代理或多租户等主题的专家知识。下面的截图展示了使用你自己的 Pay-as-you-Go(PAYG)或 CPEA 账户中免费(层级)服务计划的基础版本架构。
Kyma
Cloud Foundry
1. Application Router
重要 - 更多细节请参阅多租户 Readme 文档!
Application Router 是 SAP BTP 上大多数应用的单一入口点。它可用于提供静态内容、验证用户、重写 URL,以及在传递用户和租户信息的同时把请求转发或代理到其他微服务。
目前,每个多租户应用都必须部署自己的 Application Router,由它验证并路由所有租户对该 SaaS 应用的请求。Application Router 能够从 URL 中确定租户标识符,然后把认证请求转发到相关身份(xsuaa)区域的 User Account and Authentication(UAA)服务。
此外,Application Router 还会把流量路由到存储在 HTML5 Application Repository 中的各个 UI 组件。
2. UI 组件
该示例应用的用户界面使用 SAP Fiori Elements 开发。SAP Fiori Elements 应用得益于模板和元数据驱动的方式。SAP Fiori Elements 为常见应用用例提供 UI 模式设计和预定义页面布局(floorplan)。应用开发者可以使用 SAP Fiori Elements,基于 OData 服务和注解创建无需 JavaScript UI 编码的 SAP Fiori 应用。
生成的 Fiori Elements 组件使用集中提供的预定义视图和控制器,这意味着无需应用专属的视图实例。SAPUI5 会解释底层 OData 服务的元数据和注解,并在启动时为 SAP Fiori 应用使用相应的视图。同时,SAP Fiori Elements 应用也可以只做最少的编码扩展。
要深入了解 SAP Fiori Elements,请查看优秀的 SAP Fiori elements for OData V4 Feature Showcase 以及更多信息部分提供的链接。
3. 业务应用服务
重要 - 更多细节请参阅辅助类文档!
SaaS 示例应用的服务层使用 SAP Cloud Application Programming(CAP) 框架开发。它为 UI 模块提供 OData 服务,并借助 SAP HANA Cloud 数据库内置多租户支持。此外,它还提供租户开通所需的订阅回调。OData 服务和自定义处理程序的定义很直接,大部分有趣的代码片段位于 code/srv/utils 目录,其中提供了用于自动化订阅需求或用户管理的函数和类。业务应用服务还包含 SAP Fiori Elements 自动渲染合适 UI 所需的注解。
4. API 服务
重要 - 在教程的下一部分可以了解更多关于如何使用 SaaS API 的信息(点击此处)!
对于希望把数据推送到其数据库容器实例的消费方,我们开发了一个基于 CAP 的 API 端点。租户可以使用该 API 把数据推送到自己的 SAP HANA HDI 数据库容器,用于计算和分析。该 API 可通过客户端凭据访问,这些凭据通过我们自定义 SaaS API 服务代理的服务实例提供给消费方租户。
下面可以看到 SaaS API 的可用实体,例如产品详情和销售订单。
除了用于维护实体的默认 CRUD 方法外,还提供了示例操作,允许对主要应用实体进行批量上传(UPSERT、DELETE 和 INSERT)。最后,你还可以找到一个很好的 OData 操作示例,它使用 SAP HANA 存储过程来 UPSERT 销售订单。
5. API 服务代理
重要 - 更多细节请参阅服务代理文档!
服务代理负责管理在 SAP BTP 环境中运行的某个服务实现的服务实例。这些服务实例随后可以绑定到需要该服务实现所提供功能的应用。为此,服务代理还可以用于在服务实例与希望使用这些服务功能的应用之间创建和管理绑定。
在本应用场景中,我们为 SaaS 订阅方创建了一个 API 作为支撑服务(backing service)。因此,服务代理负责在订阅方子账户中创建 SaaS API 服务实例。借助这些服务实例,订阅方可以创建所谓的服务绑定,从而获得与 SaaS API 交互的客户端凭据。创建服务实例和相应的服务绑定都由 API 服务代理处理。
6. 租户数据库容器
应用提供了一个示例数据模型,支持灵活使用 SAP Fiori Elements,包括草稿(Draft)支持等特性。该数据模型会在新的消费方租户订阅时部署到独立的 SAP HANA HDI 数据库容器中。你无需关心这一过程,它由 SAP Service Manager 实例(container 计划)自动处理。请查看更多信息部分,了解由 SAP Service Manager 管理的 HDI 容器的更多内容。使用 SAP HANA Deployment Infrastructure(HDI)及关联容器,可以安全隔离所有租户相关数据。
由于 CAP 是 SAP Fiori Elements 的优秀支撑服务,可提供所需的 OData 服务和注解,因此数据模型结构也必须符合易于使用的用户界面要求。此外,基于租户的 SaaS API 需求由专用数据表来满足,租户可以通过 SaaS API 维护这些表。通过把这些表与启用草稿的应用表解耦,消费方既可以决定把内容预填到评估中,也可以灵活地通过手工数据录入搭建自己的场景。
下面可以看到订阅时部署到租户数据库容器中的表概览。
提示 - Roles 表仅用于本地开发场景。如果应用运行在 SAP BTP 中,角色会自动从 SAP XSUAA 获取,无需单独存储。
7. 共享数据库容器
重要 - 更多细节请参阅共享容器文档!
为了在消费方租户之间共享数据,我们为示例场景设置了共享数据库容器。这使你作为提供方可以在一处维护中央主数据等内容,并同时为所有消费方租户更新。该概念建立在 HDI 数据库容器的跨容器访问能力之上。
8. 更多信息
请通过以下链接进一步了解上述主题:
深入解析辅助类
Kyma ✅
Cloud Foundry ✅
本部分教程将介绍业务应用服务中实现的各种辅助类。这些类主要支持租户订阅流程的自动化,同时包含应用内用户管理的逻辑。
深入解析辅助类
概览
Automator(tenant-automator.js)
云管理辅助类(cloud-management-service.js)
Service Manager 辅助类(service-manager.js)
令牌辅助类(token-helper.js)
目标辅助类(destination.js)
Credential Store 辅助类(credential-store.js)
用户管理辅助类(user-management.js)
告警通知辅助类(alert-notification.js)
Kyma 工具类(kyma-helper.js)
Cloud Foundry 工具类(cloud-foundry.js)
1. 概览
下表列出了 Sustainable SaaS 业务应用服务使用的所有辅助类:
工具类 |
源代码 |
说明 |
|---|---|---|
Automator |
与运行时相关的辅助类,用于在租户(取消)订阅时自动创建和删除产物 |
|
Cloud-Management-Helper |
与 Cloud Management Service(central 计划)交互的辅助类 |
|
Service-Manager-Helper |
与 Service Manager 子账户(admin 计划)交互的辅助类 |
|
Token-Helper |
从相关 OAuth2 服务器获取令牌的辅助类 |
|
Destination-Helper |
与 SAP Destination Service 交互的辅助模块 |
|
Credential-Store-Helper |
在使用 Cloud Foundry 时与 SAP Credential Store 交互的辅助模块 |
|
User-Management-Helper |
与 SAP Identity Authentication 和 XSUAA 交互的用户与角色管理辅助类 |
|
Alert-Notification-Helper |
与 SAP Alert Notification 服务交互的辅助类 |
|
Kyma-Utils |
与 SAP Kyma Runtime API 交互的辅助模块(例如创建 Kyma API Rule) |
|
Cloud-Foundry-Utils |
与 Cloud Foundry API 交互的辅助模块(例如创建 Cloud Foundry 路由) |
2. Automator(tenant-automator.js)
租户 Automator 模块自动完成 SAP BTP 中租户的预配与取消预配。它确保所需的服务实例、绑定、目标(destination)和 Cloud Foundry(CF)路由被高效地创建和清理。
该模块同时支持 Cloud Foundry 与 Kyma 环境。工作流执行采用基于步骤的方式,并内置回滚机制,以处理失败并避免资源闲置。
由于自动化流程中有少数步骤与运行时相关,该模块会返回不同的 JavaScript 类,这些类覆盖并扩展了 TenantAutomator 基类。大多数自动化步骤对 Kyma 和 Cloud Foundry 运行时 是一致的,可由基类实现处理;与运行时相关的类则负责特定配置,例如设置 API Rule(在 Kyma 中)或路由(在 Cloud Foundry 中)。
Automator 负责以下任务:
订阅时借助 destination.js 在消费方子账户中创建目标。
取消订阅时借助 destination.js 从消费方子账户删除目标。
在提供方子账户中创建 Cloud Management 服务实例及绑定 cloud-management-service.js
从提供方子账户中删除 Cloud Management 服务实例及绑定 cloud-management-service.js
借助 cloud-management-service.js 在消费方子账户中创建 Service Manager 服务实例及绑定。
借助 cloud-management-service.js 从消费方子账户中删除 Service Manager 服务实例及绑定。
订阅时借助 service-manager.js 在消费方子账户中注册服务代理。
取消订阅时借助 service-manager.js 从消费方子账户中注销服务代理。
Kyma
订阅时借助 kyma-helper.js 为相应消费方子账户创建新的 API Rule。
取消订阅时借助 kyma-helper.js 为相应子账户删除现有 API Rule。
Cloud Foundry
订阅时借助 cloud-foundry.js 为相应消费方子账户创建新路由。
取消订阅时借助 cloud-foundry.js 为相应子账户删除现有路由。
当租户订阅 Sustainable SaaS 应用时,
将在提供方子账户中创建新的 Cloud Management Service 实例(central 计划)。
使用该 Cloud Management Service 实例,在消费方子账户中创建新的 Service Manager 实例。
由第 2 步创建的 Service Manager 实例,在消费方子账户中注册 API 服务代理。
在消费方子账户中创建名为 *_S4HANA_CLOUD 的示例目标。
第 2 步创建的 Service Manager 实例将从消费方子账户中删除。
第 1 步创建的 Cloud Management Service 实例将从提供方子账户中删除。
Kyma
将为新的消费方子账户创建新的 API Rule。
Cloud Foundry
将为新的消费方子账户创建新的 Cloud Foundry 路由(使用自定义域名时不需要)。
当租户取消订阅 Sustainable SaaS 应用时,
将在提供方子账户中创建新的 Cloud Management Service 实例(central 计划)。
使用该 Cloud Management Service 实例,在消费方子账户中创建新的 Service Manager 实例。
由第 2 步创建的 Service Manager 实例,从消费方子账户中注销 API 服务代理。
从消费方子账户中删除 _S4HANA_CLOUD 目标。
从消费方子账户中删除第 2 步创建的 Service Manager 实例。
第 1 步创建的 Cloud Management Service 实例将从提供方子账户中再次删除。
Kyma
触发取消订阅的消费方子账户的 API Rule 将被移除。
Cloud Foundry
触发取消订阅的消费方子账户的 Cloud Foundry 路由将被移除(使用自定义域名时不需要)。
下面是该流程的概览图:
sequenceDiagram
participant T as Tenant
participant P as Provider Subaccount
participant C as Consumer Subaccount
%% Subscription Process
rect rgb(230, 245, 255)
Note over T,C: Tenant Subscription Process
T->>P: Subscribe to Sustainable SaaS app
P->>P: 1. Create Cloud Management Service instance (central plan)
P->>C: 2. Create Service Manager instance
C->>C: 3. Register API Service Broker
C->>C: 4. Create *_S4HANA_CLOUD destination
alt Kyma Environment
C->>C: Create API Rule
else Cloud Foundry Environment
C->>C: Create Cloud Foundry Route (if no custom domain)
end
C->>C: 5. Delete Service Manager instance
P->>P: 6. Delete Cloud Management Service instance
end
%% Unsubscription Process
rect rgb(125, 220, 241)
Note over T,C: Tenant Unsubscription Process
T->>P: Unsubscribe from Sustainable SaaS app
P->>P: 1. Create Cloud Management Service instance (central plan)
P->>C: 2. Create Service Manager instance
C->>C: 3. Unregister API Service Broker
C->>C: 4. Delete *_S4HANA_CLOUD destination
C->>C: 5. Delete Service Manager instance
P->>P: 6. Delete Cloud Management Service instance
end
3. 云管理辅助类(cloud-management-service.js)
SAP BTP Cloud Management Service 让 SAP BTP 管理员可以通过 API 处理管理任务。
在 Sustainable SaaS 应用场景中,我们使用 SAP BTP Cloud Management Service 在消费方子账户中创建和删除 Service Manager 实例。为此,Cloud Management 辅助类包含在运行时于提供方子账户中创建和删除新的 Cloud Management Service 实例(central 计划)的函数。使用 central 计划至关重要,因为该计划允许跨子账户执行管理操作。
只有计划为 "central"、授权类型为 clientCredentials 的 Cloud Management Service 实例,才能在其他子账户中创建服务实例(如本例中的 Service Manager 实例)。这种特殊类型的 Cloud Management Service 实例(授权类型为 clientCredentials)无法在部署时创建,而必须在运行时使用计划为 subaccount-admin 的专用 Service Manager 实例来创建和删除。
流程
提供方子账户中的 Service Manager(subaccount admin 计划) 在提供方子账户中创建 Cloud Management Service(central 计划) 在消费方子账户中创建 Service Manager(subaccount admin 计划) 注册 API 服务代理(在消费方子账户中)
提示 - Kyma 中由 SAP BTP Service Operator 使用的默认 Service Manager 实例(计划 service-operator-access)不能用于创建此类实例!
4. Service Manager 辅助类(service-manager.js)
Service Manager 是服务代理和平台的中央注册表。它跟踪服务实例的创建,并允许在不同平台实例之间共享服务与服务实例。Service Manager 让应用可以使用多个平台的服务和服务实例。
Service Manager 辅助类模块用于在 Sustainable SaaS 应用场景中通过Service Manager 服务实例(由 Cloud Management Service(central 计划)在消费方子账户中创建)来(取消)注册自定义 API 服务代理。
5. 令牌辅助类(token-helper.js)
令牌辅助类模块用于通过客户端凭据流程从 OAuth2 服务器获取令牌。
6. 目标辅助类(destination.js)
目标辅助类用于在任意给定子账户中获取、创建和删除目标(destination)。
7. Credential Store 辅助类(credential-store.js)
Credential Store 辅助类模块用于在提供方子账户中与 SAP Credential Store 服务交互,属于基于 Cloud Foundry 的场景的一部分。在 Kyma 场景中则改用 Kubernetes Secret。
8. 用户管理辅助类(user-management.js)
用户管理辅助类模块用于处理 SAP IAS 和 XSUAA 中的用户与角色分配。对于该用例,需要允许 SaaS 消费方进行应用内用户管理。
需求
租户管理员应能在不访问 SAP BTP 消费方子账户的情况下创建用户。
租户管理员应能在不访问 SAP BTP 消费方子账户的情况下为用户分配角色集合。
租户管理员应能在不访问 SAP BTP 消费方子账户的情况下删除用户。
用户的创建流程是怎样的?
在 SAP IAS 中创建用户(仅在启用 IAS 时!)。
在 SAP BTP 消费方子账户中创建 XSUAA 影子用户。
为影子用户分配所选角色,用于授权。
用户的删除流程是怎样的?
从租户子账户中删除用户。
从 SAP IAS 中删除用户(仅在启用 IAS 时!)。
为提供该功能,用户管理辅助类会与 SAP IAS API 以及 XSUAA API 交互。
9. 告警通知辅助类(alert-notification.js)
告警通知辅助类用于与 SAP BTP Alert Notification 服务交互。在本示例中,提供的函数允许你向事件接收方发送通用通知。
10. Kyma 工具类(kyma-helper.js)
Kyma 工具类在订阅期间用于在 Kyma 集群中创建新的 API Rule。如果订阅过程中提供了自定义值,这些 API Rule 会为每个订阅方对外提供专用主机,例如 customer.c-a1b2c3.kyma.ondemand.com。如果订阅不需要自定义域名,则使用包含消费方子账户子域名的默认主机模式,例如 customer-379a13f-susaas-router-susaas.c-a1b2c3.kyma.ondemand.com。
提示 - 如果使用自定义域名,结果中会包含你的自定义域名,而不是 c-a1b2c3.kyma.ondemand.com。
11. Cloud Foundry 工具类(cloud-foundry.js)
Cloud Foundry 工具类在订阅期间用于创建新的 Cloud Foundry 路由。这些路由为每个订阅方对外提供专用主机,例如 customer-379a13f-susaas-router-susaas.cfapps.eu10.hana.ondemand.com。目前无法使用订阅过程中定义的自定义域名或专用主机名。要满足该需求,必须使用 SAP Custom Domain Service。如需了解更多,请查看相应的专家特性。
提示 - 如果使用自定义域名,结果中会包含你的自定义域名,而不是 cfapps.eu10.hana.ondemand.com*。
深入解析多租户
Kyma ✅
Cloud Foundry ✅
本部分教程将介绍多租户的不同方面,以及 SaaS 应用如何处理租户。
深入解析多租户
Application Router
1.1. Application Router 与身份区域
1.2. Application Router 与多租户认证
授权与信任管理服务
2.1. 授权与信任管理服务 - shared tenant-mode
2.2. 授权与信任管理服务 - application 计划
更多信息
1. Application Router
Application Router 是 SAP BTP 上大多数应用的单一入口点。它用于提供静态内容、验证用户、重写 URL,以及在传递用户信息的同时把请求转发或代理到其他微服务。此外,Application Router 还负责多租户应用中不同租户的识别与认证。因此,在多租户方面它是最重要的拼图之一。
1.1. Application Router 与身份区域
每个多租户应用都必须部署自己的 Application Router,由它处理所有租户对该应用的请求。Application Router 可以从 URL 子域名中确定租户标识符,然后把认证请求转发到 User Account and Authentication(UAA)服务及相关身份区域。每个身份区域都可以通过子域名标识符唯一标识。身份区域是 UAA 所管理实体周围的逻辑边界。
区域中的这些实体包括并定义了例如:
用户
组映射
身份提供商(IDP)及访问权限
这使每个租户子账户都能独立处理用户和认证流程,例如使用自定义 IDP。由于对 Application Router 的每个请求都会被转发到正确的身份区域,因此可以实现非常灵活的认证方式。要深入了解身份区域,请参阅 Cloud Foundry 官方文档(点击此处)。
1.2. Application Router 与多租户认证
在多租户应用中认证请求时会发生以下步骤。要了解 tenant-mode shared 和 application 服务计划等前提条件,请阅读下面的小节,其中提供了更多细节。
Application Router 必须确定 UAA 的租户特定子域名,该子域名又决定了用于认证的身份区域。这一确定过程由名为 TENANT_HOST_PATTERN 的环境变量完成。TENANT_HOST_PATTERN 是一个包含正则表达式的字符串,其中带有捕获组。传入请求的主机会与该正则表达式匹配,第一个捕获组的值即被推导为租户子域名。
如果你有多个指向同一应用的路由,例如 tenant1.<application domain> 和 tenant2.<application domain>,那么相应的 TENANT_HOST_PATTERN 可以是 ^(.*).<application domain>,从而捕获 tenant1 和 tenant2。下面的示意图也展示了这种基于 URL、通过处理消费方特定认证需求来识别租户的方式。结合下面描述的步骤,你应对 SAP BTP 中多租户的实现方式有较清晰的理解。
Application Router 使用上面介绍的
TENANT_HOST_PATTERN方法从 URL 推导身份区域标识符。每个消费方子账户都映射到一个唯一的身份区域,以及与该身份区域关联的唯一子域名。Application Router 调用租户感知的 XSUAA 服务,由它负责业务用户的认证。
XSUAA 读取租户,并从租户特定的身份区域中获取消费方特定的身份提供商(IdP)。
XSUAA 把认证委托给配置的 IdP,并创建一个 JSON Web Token(JWT),其中包含租户、当前用户以及用户的授权范围。
随后 JWT 被发送回 Application Router,再从这里传递到应用。
为了读取和存储租户特定数据,多租户应用需要知道租户 ID。
为了获取租户 ID,多租户应用会从给定的 JWT 中读取租户、用户和范围。
租户信息包含在 identityZone 用户属性中。
获取用户 identityZone 的示例 Java 代码
UserInfo userInfo = SecurityContext.getUserInfo();
String identityZone = userInfo.getIdentityZone();
提示 - 只有已订阅该多租户应用的消费方子账户才能通过该流程认证。虽然授权与信任管理服务的 shared 服务计划听起来容易引起误解,但它只会为已订阅的租户签发令牌。
2. 授权与信任管理服务
2.2. 授权与信任管理服务 - application 计划
服务计划 application 要求在应用部署到的每个租户(SAP BTP 子账户)中,xsappname(在 xs-security.json 或 mta.yaml 文件中指定)都必须唯一。这意味着一个应用可以同时部署在多个 SAP BTP 子账户中,但不能在同一子账户中部署两次(除非修改 xsappname)。第二次部署时会收到错误消息。
提示 - 在示例应用中,xsappname 会与当前 Cloud Foundry 空间和组织、或 Kyma 命名空间和集群动态组合,因此你可以按需把应用多次部署到同一环境中。添加这些唯一标识符,可以让所有感兴趣的开发者把示例应用部署到各自的环境中。
写入环境凭据部分的 xsappname 会加上后缀,格式为 <xsappname>!t<tenant index>。租户索引是 UAA 在内部维护的连续编号,不同子账户的编号各不相同。
在多租户场景中,实际应用实例只存在于提供方子账户,而范围、角色模板和角色集合等与 XSUAA 相关的对象会在订阅过程中被复制。所有消费方子账户中的范围都具有相同格式 <xsappname>!t<tenant index>.<scope>,例如 dev-susaas!t134415.Admin。
3. 更多信息
请通过以下链接进一步了解上述主题:
深入解析服务代理
Kyma ✅
Cloud Foundry ✅
本部分教程将详细说明 SaaS API 支撑服务的实现,以及配套的服务代理,因为这两个组件协同工作,共同提供多租户 SaaS API。
深入解析服务代理
什么是服务代理?
OSB API 标准
平台如何与服务代理交互?
3.1. 目录管理的实现,或者说“服务代理有哪些计划?”
3.2. 服务实例创建(预配)的实现
3.3. 服务绑定创建的实现 - 绑定请求
3.4. 服务绑定删除的实现
3.5. 服务实例删除的实现
3.6. 注册服务代理
什么是 @sap/sbf?
SAP BTP 中的示例多租户 SaaS API(支撑服务)
5.1. 请求 1
订阅 Sustainable SaaS 应用之前的目录
订阅 Sustainable SaaS 应用之后的目录
5.2. 请求 2
5.3. 请求 3
5.4. 请求 4
5.5. 请求 5
更多学习内容
1. 什么是服务代理?
先说最基础的:什么是服务代理?要回答这个问题,我们先从“为什么需要服务代理?”开始,再深入细节。
设想这样一个场景:你有一个服务运行在本地服务器或任意其他地方,它对你如此重要,以至于没有它就无法继续开发。想象类似下面这样的东西:
const express = require('express')
const app = express()
const port = 3000
app.post('/super-hard-calculation', async (req, res) => {
let result = await doSuperComplexStuff(req);
res.send(result)
})
app.listen(port, () => {
console.log(`Example app listening on port ${port}`)
})
由于该计算对你的业务极其关键,你计划从已经部署到 SAP BTP 的多个应用中使用它。因此,你希望像使用 SAP BTP 上已有的其他支撑服务(例如 XSUAA、application autoscaler 等)那样,以灵活的方式创建或删除实例,并与运行在 SAP BTP 上的应用绑定或解绑——但如何做到这一点呢?
情况就是这样。
假设 SAP BTP 与你的服务之间还没有任何连接。由于所有服务管理操作都由 SAP BTP 触发,真正的挑战在于:如何让我们的服务获知应用的生命周期事件,例如创建实例、删除实例、新建绑定等等。
好吧,既然知道了需要解决的问题,如果能为 SAP BTP 这类平台制定一个标准,用标准化的格式发送请求,让世界上所有支撑服务都可以实现以处理这些生命周期事件,岂不是很好?这样每个支撑服务都可以在自己的应用中实现这些标准,从而与任何平台协同工作。
好消息是:确实有这样的标准!它叫做 Open Service Broker API。
那么,Open Service Broker API 或简称 OSBAPI 究竟是什么?我们来看官方定义。
“Open Service Broker API 项目让独立软件供应商、SaaS 提供商和开发者能够轻松地为运行在 Cloud Foundry 和 Kubernetes 等云原生平台上的工作负载提供支撑服务。该规范已被众多平台和数千家服务提供商采纳,它描述了一组简单的 API 端点,可用于预配、访问和管理服务产品。”
现在我们知道了存在这样的标准,接下来仔细看看这些标准具体包含什么。
2. OSB API 标准
为简单起见,我们只介绍这些标准的以下部分:
关于这些标准的更多信息,请访问官方 OSB API 仓库
那么总结一下,**什么是服务代理?**这个问题的答案是什么?
答案: 任何实现了 OSBAPI 标准的应用都是服务代理!
3. 平台如何与服务代理交互?
本节将介绍 SAP BTP 这样的平台如何与服务代理交互。
3.1. 目录管理的实现,或者说“服务代理有哪些计划?”
用非常简单的话说,目录管理请求是平台向服务代理提出的第一个问题: “嗨,服务代理,你有哪些服务实例和计划?”
基本上,这是一个发往端点 /v2/catalog 的 GET 请求。
因此,我们示例中非常原始的实现大致如下:
请注意,这段代码仅用于帮助理解,无法端到端运行。
const express = require('express')
const app = express()
const port = 3000
/* Broker Endpoints */
app.get('/v2/catalog'), async(req,res) => {
res.send(200,{
id:"dummy123", // ID of service instance, have might be any unique id
name:"Super Complex Calculation Service", // Name of of service
description:"This service does a super complex calculation which is very important for our business", // Description
bindable:true, // Tells if the service is bindable, then the platform keeps this information
plans:[{id:1,name:"Super Plan"},{id:2,name:"Normal Plan"}] // Plans of the service
})
}
/* End of Broker Endpoints */
app.post('/super-hard-calculation', async(req, res) => {
let result = await doSuperComplexStuff(req);
res.send(result)
})
app.listen(port, () => {
console.log(`Example app listening on port ${port}`)
})
作为响应,服务代理会向请求的平台返回以下信息:
它提供一个名为 Super Complex Calculation Service 的服务
该服务可绑定,因此允许绑定请求
它有两个服务计划——Super Plan 和 Normal Plan
3.2. 服务实例创建(预配)的实现
大多数情况下,在第一步看到的目录请求之后,平台会发送第二个请求来创建服务实例。在 OSBAPI 标准中,这称为预配(provisioning)。
这次是发往端点 /v2/service_instances/:instance_id 的 PUT 请求。
假设平台(如 SAP BTP)发送的请求体如下:
{
service_id: "dummy123" // Our service ID
plan_id: 1 // Super plan ID
parameters : {...} // Parameters for the service instance to be created. Example: xs-security.json file content for XSUAA
}
我们再为预配添加一个简单的示例实现:
const express = require('express')
const app = express()
const port = 3000
/* Broker Endpoints */
// Step 1) Catalog Request
app.get('/v2/catalog', async(req,res) => {
res.send(200,{
id:"dummy123", // ID of service instance, have might be any unique id
name:"Super Complex Calculation Service", // Name of of service
description:"This service does a super complex calculation which is very important for our business", // Description
bindable:true, // Tells if the service is bindable, then the platform keeps this information
plans:[{id:1,name:"Super Plan"},{id:2,name:"Normal Plan"}] // Plans of the service
})
}
)
// Step 2) Provisioning request (Create a service Instance)
app.put('/v2/service_instances/:instance_id', async(req,res) => {
let instanceId = req.params.instance_id;
let serviceMetadata = await createNewResourcesForNewInstance(instanceId);
res.send(201, serviceMetadata);
})
/* End of Broker Endpoints */
app.post('/super-hard-calculation', async(req, res) => {
let result = await doSuperComplexStuff(req);
res.send(result)
})
app.listen(port, () => {
console.log(`Example app listening on port ${port}`)
})
既然你已经了解了服务实例创建的实现,接下来就是下一步:创建绑定。
3.3. 服务绑定创建的实现 - 绑定请求
服务实例创建之后,大多数情况下下一个到达的请求就是创建服务绑定。
它同样是发往端点 /v2/service_instances/:instance_id/service_bindings/:binding_id 的 PUT 请求。
const express = require('express')
const app = express()
const port = 3000
/* Broker Endpoints */
// Step 1) Catalog Request
app.get('/v2/catalog', async(req,res) => {
res.send(200,{
id:"dummy123", // ID of service instance, have might be any unique id
name:"Super Complex Calculation Service", // Name of of service
description:"This service does a super complex calculation which is very important for our business", // Description
bindable:true, // Tells if the service is bindable, then the platform keeps this information
plans:[{id:1,name:"Super Plan"},{id:2,name:"Normal Plan"}] // Plans of the service
})
})
// Step 2) Provisioning request (Create a service Instance)
app.put('/v2/service_instances/:instance_id', async(req,res) => {
let instanceId = req.params.instance_id;
let serviceMetadata = await createNewResourcesForNewInstance(instanceId);
res.send(201,serviceMetadata);
})
// Step 3) Create Service Binding
app.put('/v2/service_instances/:instance_id/service_bindings/:binding_id', async(req,res) => {
let instanceId = req.params.instance_id;
let bindingId = req.params.binding_id;
let serviceBinding = await createNewServiceBinding(instanceId,bindingId);
res.send(201,serviceBinding);
})
/* End of Broker Endpoints */
app.post('/super-hard-calculation', async(req, res) => {
let result = await doSuperComplexStuff(req);
res.send(result)
})
app.listen(port, () => {
console.log(`Example app listening on port ${port}`)
})
3.4. 服务绑定删除的实现
服务代理处理的另一种操作请求是删除服务绑定。
不出所料,该请求是发往 /v2/service_instances/:instance_id/service_bindings/:binding_id 的 DELETE 请求。
我们把它也加入这个简单的实现:
const express = require('express')
const app = express()
const port = 3000
/* Broker Endpoints */
// Step 1) Catalog Request
app.get('/v2/catalog', async(req,res) => {
res.send(200,{
id:"dummy123", // ID of service instance, have might be any unique id
name:"Super Complex Calculation Service", // Name of of service
description:"This service does a super complex calculation which is very important for our business", // Description
bindable:true, // Tells if the service is bindable, then the platform keeps this information
plans:[{id:1,name:"Super Plan"},{id:2,name:"Normal Plan"}] // Plans of the service
})
})
// Step 2) Provisioning request (Create a service Instance)
app.put('/v2/service_instances/:instance_id', async(req,res) => {
let instanceId = req.params.instance_id;
let serviceMetadata = await createNewResourcesForNewInstance(instanceId);
res.send(201,serviceMetadata);
})
// Step 3) Create Service Binding
app.put('/v2/service_instances/:instance_id/service_bindings/:binding_id', async(req,res) => {
let instanceId = req.params.instance_id;
let bindingId = req.params.binding_id;
let serviceBinding = await createNewServiceBinding(instanceId,bindingId);
res.send(201,serviceBinding);
})
// Step 4) Delete Service Binding
app.delete('/v2/service_instances/:instance_id/service_bindings/:binding_id', async(req,res) => {
let instanceId = req.params.instance_id;
let bindingId = req.params.binding_id;
let serviceBinding = await deleteInvalidateServiceBinding(instanceId,bindingId);
res.send(200,{});
})
/* End of Broker Endpoints */
app.post('/super-hard-calculation', async(req, res) => {
let result = await doSuperComplexStuff(req);
res.send(result)
})
app.listen(port, () => {
console.log(`Example app listening on port ${port}`)
})
3.5. 服务实例删除的实现
接下来你需要在服务代理中处理的操作是删除服务实例。
该请求是另一个发往 /v2/service_instances/:instance_id 的 DELETE 请求。
const express = require('express')
const app = express()
const port = 3000
/* Broker Endpoints */
// Step 1) Catalog Request
app.get('/v2/catalog', async(req,res) => {
res.send(200,{
id:"dummy123", // ID of service instance, have might be any unique id
name:"Super Complex Calculation Service", // Name of of service
description:"This service does a super complex calculation which is very important for our business", // Description
bindable:true, // Tells if the service is bindable, then the platform keeps this information
plans:[{id:1,name:"Super Plan"},{id:2,name:"Normal Plan"}] // Plans of the service
})
})
// Step 2) Provisioning request (Create a service Instance)
app.put('/v2/service_instances/:instance_id', async(req,res) => {
let instanceId = req.params.instance_id;
let serviceMetadata = await createNewResourcesForNewInstance(instanceId);
res.send(201,serviceMetadata);
})
// Step 3) Create Service Binding
app.put('/v2/service_instances/:instance_id/service_bindings/:binding_id', async(req,res) => {
let instanceId = req.params.instance_id;
let bindingId = req.params.binding_id;
let serviceBinding = await createNewServiceBinding(instanceId,bindingId);
res.send(201,serviceMetadata);
})
// Step 4) Delete Service Binding
app.delete('/v2/service_instances/:instance_id/service_bindings/:binding_id', async(req,res) => {
let instanceId = req.params.instance_id;
let bindingId = req.params.binding_id;
let serviceBinding = await deleteInvalidateServiceBinding(instanceId,bindingId);
res.send(200,{});
})
// Step 5) Delete Service Instance
app.delete('/v2/service_instances/:instance_id', async(req,res) => {
let instanceId = req.params.instance_id;
let serviceBinding = await deleteServiceInstance(instanceId,bindingId);
res.send(200,{});
})
/* End of Broker Endpoints */
app.post('/super-hard-calculation', async(req, res) => {
let result = await doSuperComplexStuff(req);
res.send(result)
})
app.listen(port, () => {
console.log(`Example app listening on port ${port}`)
})
3.6. 注册服务代理
到目前为止我们完成的所有简单实现都位于支撑服务一侧。但要能与服务代理交互,你必须告诉平台去与服务代理通信。
这称为向服务代理注册。
例如在 SAP BTP 中,可以使用下面的 BTP CLI 命令从消费方子账户注册服务代理:
btp register services/broker --name NAME --url URL --user USER --password PASSWORD --subaccount SUBACCOUNTID
更多细节请查看官方文档。
4. 什么是 @sap/sbf?
前面几节介绍了什么是服务代理,以及它的用途。
现在我们设想类似下面的场景。
假设你有三个不同的支撑服务,希望从 SAP BTP 中使用它们。你必须分别到这三个支撑服务中实现 OSBAPI 标准,而且相应代码在各个支撑服务中可能非常相似。此外,你还需要为每个服务实现凭据。如果你有 10 个业务服务,这个实现工作量就要乘以 10。
于是问题来了:我们能否避免为所有支撑服务分别实现 OSBAPI 的工作? 答案是:可以!
服务代理框架(Service Broker Framework,@sap/sbf) 是一个实现了 Open Service Broker API 的 Node.js 框架。它可以在 SAP Business Technology Platform 中使用,也可以作为 SAP HANA XS Advanced 模型的一部分在本地使用。因此,当你按官方文档所述部署这个 npm 模块后,就拥有一个开箱即用、实现了 OSBAPI 的服务代理。
更多信息请参阅 @sap/sbf 的官方文档。
5. SAP BTP 中的示例多租户 SaaS API(支撑服务)
在了解了服务代理的理论背景之后,你将会了解到我们如何使用服务代理方案实现示例应用的多租户 API。在深入所有细节之前,我们先回顾一下流程。
如上图所示,
我们的支撑服务是 Sustainable SaaS API,托管在提供方子账户中。
Sustainable SaaS API Broker 是该支撑服务的服务代理。
一个使用 broker 计划的 XSUAA 服务实例已绑定到 Service Broker 和 Backing Service。
为了更好理解,我们简要梳理一下图中的流程。
5.1. 请求 1
该请求表示从消费方子账户注册服务代理,以便之后可以创建服务实例。完成这一步后,你的支撑服务就会出现在消费方子账户内的 SAP BTP 服务目录中。
在示例应用中,当租户订阅该多租户业务应用时,这个请求会由多租户业务应用自动发送。
我们来看看它是什么样子。
订阅 Sustainable SaaS 应用之前的目录
如你所见,在订阅过程之前,目录中只有 Sustainable SaaS 多租户业务应用。这是因为该多租户业务应用会在订阅期间自动注册 Sustainable SaaS API 服务代理。
订阅 Sustainable SaaS 应用之后的目录
可以看到,订阅之后 Sustainable SaaS API 已经出现并可用。
5.2. 请求 2
该请求由 SAP BTP 发送给服务代理,用于在创建服务之前查看你的服务提供哪些计划,例如 default 计划、premium 计划等。下面是 SAP BTP 发往 Sustainable SaaS API Broker 的请求 2 的截图。响应基本上就是相应 catalog.json 文件中配置的 trial、default 和 premium。
5.3. 请求 3
该请求会创建服务实例,并在你的 @sap/sbf 模块上触发预配事件。你应相应地处理该请求。例如,如果你提供数据库服务,可能需要在触发该请求时创建新的数据库实例。请参见下文,了解 SAP BTP 如何向 Sustainable SaaS API 服务代理发送服务创建请求。
5.4. 请求 4
当平台需要创建对你的服务实例有效的凭据,和/或将服务实例绑定到应用时,就会发送该请求。由于服务代理使用了 @sap/sbf 和 XSUAA broker 计划,在我们的场景中这会自动处理。每当有绑定请求到达,它首先会到达 Sustainable SaaS API 服务代理的 @sap/sbf 实例,然后该实例会使用 broker 计划实例与 XSUAA 通信,为发送绑定请求的特定子账户自动创建凭据。由于我们也把同一个 XSUAA 实例绑定到了支撑服务(API),这些凭据将是有效的。
5.5. 请求 5
拿到凭据后,租户就可以从其子账户、其 SAP S/4HANA 系统或任何其他第三方系统调用支撑服务 Sustainable SaaS API。由于 JWT 令牌包含子账户 ID,我们基于 CAP 的 API 会识别传入的租户,并借助 SAP Service Manager 的 container 计划把数据直接上传到正确的租户数据库容器。使用如下服务绑定凭据,即可调用 Sustainable SaaS API(可通过 apiUrl 访问)。该 API 本身是一个基于 CAP 的 OData API。
6. 更多学习内容
共享数据库容器
Kyma ✅
Cloud Foundry ✅
为了在消费方租户之间共享数据,我们为示例场景设置了共享数据库容器。这使你作为提供方可以在一处维护主数据等内容,并同时为所有消费方租户更新。
共享数据库容器
部署定义
Kyma Helm Chart
Cloud Foundry 部署描述符
租户数据库容器
注意事项
更多信息
该概念建立在 SAP HANA Cloud HDI 数据库容器的跨容器访问能力之上。在本示例场景中,共享数据库容器用于在各租户数据库容器之间共享一个示例表与主数据。
1. 部署定义
根据你选择的运行时,共享数据库容器会在 Kyma Helm Chart 或 Cloud Foundry 部署描述符中以不同方式设置。
Kyma Helm Chart
共享数据所需的 HDI 容器定义在 Umbrella Chart 的 values.yaml 文件(点击此处)中,并在把 SaaS 应用部署到提供方子账户期间创建。
提示 - 对于租户数据库容器实例,SAP Service Manager(container 计划)会负责整个容器生命周期。因此无需在 values.yaml 文件中为这些容器指定额外的 HDI 资源。
# SAP HANA Cloud HDI Container
# Required for shared data model deployment
com_hdi_container:
serviceOfferingName: hana
servicePlanName: hdi-shared
要把内容(例如表和视图)部署到共享数据库容器,还需要一个额外组件,它会生成一个 Kubernetes Job,负责部署共享数据库产物。
# Shared Database Container Deployer Job
# Deploys the shared data model to a database container
hana_deployer:
image:
# Provide your HDI Container Deployer Docker Image repository
repository: <<namespace>>/susaas-db-com
tag: latest
bindings:
hana:
serviceInstanceName: com-hdi-container
resources:
limits:
cpu: 500m
memory: 1G
requests:
cpu: 500m
memory: 1G
为了允许从租户特定的数据库容器访问共享数据库容器,需要把它作为绑定添加到 SaaS 后端服务组件。这是一个前提条件,因为新租户数据库容器与共享数据库容器之间的所需依赖关系必须在每个新消费方租户订阅时解析。
# Backend Service Workload
srv:
port: 8080
bindings:
xsuaa:
serviceInstanceName: xsuaa
sm-container: # <-- Tenant database containers
serviceInstanceName: sm-container
hana: # <-- Shared database container
serviceInstanceName: com-hdi-container
你可能从 Cloud Foundry 部署中已经了解,在 Kyma 中同样需要为这种跨容器访问场景定义所谓的 Service Replacement。相应的环境变量定义在下面的 values.yaml 文件(点击此处)中。
env:
SERVICE_REPLACEMENTS: '[{ "key" : "com-hdi-container", "service" : "hana" }]'
负责把数据模型部署到租户数据库容器的 mtxs 工具,在使用服务替换时会依赖所谓的 VCAP_SERVICES 环境变量。因此还需要另一项关键特性配置,让 CAP 在 Kyma 环境中模拟该环境变量。可以通过为 cds_features 环境变量设置以下 JSON 值来启用相应特性。
env:
cds_features: '{ "emulate_vcap_services" : true }'
提示 - 在本场景中,在 package.json 中启用该 CAP 特性不会按预期生效。
Cloud Foundry 部署描述符
共享数据库容器所需的 HDI 容器定义在 mta.yaml 文件中,并在把 SaaS 应用部署到提供方子账户期间创建。
提示 - 对于租户数据库容器,SAP Service Manager(container 计划)会负责容器生命周期。因此无需在 mta.yaml 文件中为这些租户容器指定任何资源。
# ----------------- COMMON DB HDI CONAINER -------------------
- name: susaas-com-hdi-container
# ------------------------------------------------------------
type: com.sap.xs.hdi-container
parameters:
service-name: ${space}-susaas-com-hdi-container
properties:
com-container-name: '${service-name}'
要把内容(例如表和视图)部署到共享数据库容器,还需要一个额外的模块定义,它会生成一个 Node.js 应用,负责部署共享数据库产物。
# --------------------- COMMON DB MODULE ---------------------
- name: susaas-db-com
# ------------------------------------------------------------
type: hdb
path: ../../code/gen/db-com
parameters:
app-name: susaas-db-com-${space}
memory: 256MB
disk-quota: 1024MB
requires:
- name: susaas-com-hdi-container
为了允许从租户数据库容器访问共享数据库容器,需要把它作为依赖项添加到 SaaS 服务模块。这是一个前提条件,因为新租户数据库容器与共享数据库容器之间的所需依赖关系必须在每个新消费方租户订阅时解析。由于订阅由 SaaS Service 模块处理,因此必须以所谓的 Service Replacement 形式提供该绑定。
# --------------------- SERVER MODULE ------------------------
- name: susaas-srv
# ------------------------------------------------------------
type: nodejs
path: ../../code/gen/srv
parameters:
app-name: susaas-srv-${space}
memory: 256MB
disk-quota: 1024MB
command: node ./node_modules/@sap/cds/bin/cds-serve
requires:
- name: susaas-uaa
- name: susaas-com-hdi-container
group: SERVICE_REPLACEMENTS
properties:
key: com-hdi-container
service: '~{com-container-name}'
2. 租户数据库容器
跨容器访问的概念基于容器之间的受信任关系。不过,要让共享数据库容器可从租户特定的数据库容器访问,还需要满足一些前提条件。
重要 - 跨容器访问的概念非常强大,但并非轻而易举。请参阅 SAP Help 中的官方文档以了解更多(点击此处)。
/code/db-com/data-model.cds
context susaas.common {
entity Shared : cuid {
value : String;
}
}
首先,你需要为租户容器的技术用户分配共享数据库容器中定义的专用访问角色。因此,在共享数据库容器中定义了角色 COM_EXTERNAL_ACCESS,它对名为 SUSAAS_COMMON_SHARED 的共享示例表提供 READ 访问(见上面的定义)。对于访问方租户数据库容器的所谓 Object Owner(s),则需要一个类似的角色 COM_EXTERNAL_ACCESS#,它包含相同的权限,并带有 grant option。
/code/db-com/src/COM_EXTERNAL_ACCESS.hdbrole
{
"role": {
"name": "COM_EXTERNAL_ACCESS",
"object_privileges": [
{
"name":"SUSAAS_COMMON_SHARED",
"type":"TABLE",
"privileges":[ "SELECT" ],
"privileges_with_grant_option":[]
}
]
}
}
现在可以在租户数据库容器中使用这些角色,需要通过所谓的 .hdbgrants 文件把它们分配给 Object Owner(s) 和 Application User(s)。该文件会在新租户数据库容器开始部署之前被处理。
它确保创建新租户数据库容器期间(以及运行时访问期间)使用的技术用户拥有访问共享数据库容器所需的权限。
提示 - 这里你可以再次看到服务替换的 key 名称(com-hdi-container)。这使部署器能够动态识别正确的服务。
db/cfg/COM.hdbgrants
{
"com-hdi-container": {
"object_owner": {
"container_roles": [
"COM_EXTERNAL_ACCESS#"
]
},
"application_user": {
"container_roles": [
"COM_EXTERNAL_ACCESS"
]
}
}
}
在确保新租户数据库容器的技术用户已被分配访问共享数据库容器所需的角色之后,你需要为共享目标对象(例如表或视图)定义所谓的同义词(synonym)。因此需要两个文件:所谓的 .hdbsynonymconfig 文件和 .hdbsynonym 文件。
提示 - 这里同样可以看到服务替换的 key 名称(com-hdi-container)。这使部署器能够动态识别正确的服务并推导出正确的 schema 名称。
/code/db/cfg/COM.hdbsynonymconfig
{
"SUSAAS_COMMON_SHARED": {
"target": {
"object": "SUSAAS_COMMON_SHARED",
"schema.configure": "com-hdi-container/schema"
}
}
}
/code/db/src/COM.hdbsynonym
{
"SUSAAS_COMMON_SHARED": {}
}
hdbsynonym 文件用于定义你的同义词数据库对象,而 hdbsynonymconfig 文件会在新租户数据库容器预配之前被处理,并向 Node.js 部署器提供配置信息。在本例中,部署器会从容器服务详情中动态读取共享数据库容器的 schema 名称。
由于共享数据库容器没有定义固定的 schema 名称,该 schema 名称会在部署 SaaS 应用时自动生成。因此,对于租户数据库容器中所需的引用,我们需要从容器服务绑定详情中动态读取 schema 名称。可以把它看作某种动态替换,而不是提供一个唯一的 schema 名称——后者可能类似 ABC123XYZ987DEF456UVW...。
现在可以在 CDS 模型定义或其他原生 SAP HANA 数据库对象(如视图或计算视图)中使用这些同义词。在 CDS 中使用时,请务必添加 @cds.persistence.exists 注解,以防止 CDS 编译器为已存在的同义词创建新的数据库产物。
/code/db/hana/data-model.cds
context susaas.common {
@cds.persistence.exists
entity Shared : cuid {
value : String;
}
}
重要 - 跨容器访问仅在 SAP HANA Cloud 场景中有效。因此,在本地测试时,会通过移除 @cds.persistence.exists 注解并提供一些示例数据来模拟相应的共享表。
/code/db/sqlite/data-model.cds
context susaas.common {
entity Shared : cuid {
value : String;
}
}
3. 注意事项
请记住,对于数据库容器备份,跨容器访问需求会带来一些额外的复杂性。如果你导出了一个租户数据库容器并计划再次导入,那么首先需要确保新目标数据库容器(你计划把备份导入其中)的技术用户已分配正确的共享数据库容器角色(参见上面的 hdbgrants 详情),然后再应用备份。
提示 - 在这种情况下 hdbgrants 文件不会被应用,你需要使用共享数据库容器的 HDI Container API 手动分配角色(点击此处)。
4. 更多信息
请通过以下链接进一步了解上述主题:
Helm Chart 与 Kyma 资源
Kyma ✅
Cloud Foundry ❌
下一章将聚焦各应用组件(例如 Application Router 中的多租户)的功能视角,而本章将深入探讨用于部署示例场景的资源和技术。为方便阅读并保持更好的结构,本章分为三个部分。
Helm Chart 与 Kyma 资源
Helm Chart
资源概览
模板细节
关于 Helm 以及各种 Kyma 和 Kubernetes 资源,可以写上好些书,但本章的主要目的并非如此。我们希望就示例应用相关的这些重要主题为你提供初步介绍。虽然网上有大量文档详细覆盖本章涉及的各个主题,但我们认为结合具体用例的上下文会让你理解得更好。一旦掌握了基础,并了解了不同 Helm 特性以及 Kyma 和 Kubernetes 资源能带来哪些好处,再深入学习官方文档并按自身需求调整就会容易得多。
下面我们从示例场景所用部署技术的基础开始,这项技术叫做 Helm。
1. Helm Chart
重要 - 更多细节请参阅 Helm Chart 文档!
大多数 SAP BTP 开发者熟悉使用多目标应用部署描述符(mta.yaml)进行 Cloud Foundry 部署,而在 Kyma/Kubernetes 中情况有所不同。与其他 Kubernetes 环境一样,Kyma 使用各种 yaml 文件把不同的应用资源(如 Deployment、Network Policy、Horizontal Pod Autoscaler 等)部署到集群。
为支持和简化这一部署流程及 yaml 文件的创建,我们在项目中使用 Helm,它可以简化并基于模板生成这些清单。Helm 是事实上的行业标准,所谓的 Helm Chart(可使用 CAP 标准特性生成)简化了可重复模式的定义,并允许使用集中定义的变量和智能模板化方法。这减少了为每个 Kubernetes 资源手工创建几十个 yaml 文件的开销。
此外,Helm 让你只需一条命令即可部署包含多个组件(在我们的场景中定义在所谓的 Helm Subchart 中)的整个应用,升级和取消部署同样如此。因此,如果你是 Helm 新手,一定要查看提供的文档,先获得初步认识。
更多细节请参阅 Helm Chart 文档!
2. 资源概览
重要 - 更多细节请参阅资源概览文档!
SAP BTP Kyma Runtime 允许开发者使用各种原生 Kubernetes 资源,同时也向可用工具集中添加了若干自定义 Kyma 对象(如 API Rule)。此外,我们的 SaaS 示例应用还依赖若干所谓的 Istio 资源,用于在 Kyma 集群中搭建所谓的服务网格。请查看链接的文档,了解我们的场景中使用了哪些资源。其中的介绍将帮助你理解所有这些资源与运行在 Kyma 集群中的示例应用工作负载之间的关系。
下面的可视化展示了 SaaS 应用使用的一系列资源,并简要总结了它们在示例用例上下文中的能力。
更多细节请参阅资源概览文档!
3. 模板细节
重要 - 更多细节请参阅模板细节文档!
在你积累了一些 Helm 经验,并了解了示例项目中使用的各种 Kyma 和 Kubernetes 对象之后,欢迎跟我们一起做一次小小的深入探索。我们不遗余力地提供了详尽的概览,说明本示例项目中最相关 Helm 模板的用途。虽然各 Helm Subchart(如 Authorization Policy 或 Service Binding)中的大多数模板都非常相似,但有些模板(或者说其生成的 Kubernetes 资源)承担着非常特殊的职责。
因此,欢迎跟随我们了解选定的 Helm 模板,从而更好地理解把示例应用部署到 Kyma 集群之后底层究竟发生了什么。
更多细节请参阅模板细节文档!













































