多租户 SaaS 应用(CAP) · 4 · 专家主题(3/3)
项目 |
内容 |
|---|---|
官方仓库 |
|
业务场景 |
把 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,共收录 5 篇官方文档(README 与 docs)。原仓库内容版权归 SAP SE,遵循其许可证。
消费方 IdP 的集成
Kyma ✅
Cloud Foundry ✅
在专家特性的这一部分,你将学习如何集成消费方 IdP(身份提供方),例如 Azure Active Directory。由于我们在 SaaS 示例场景中并未专门搭建专用的消费方 IdP,本章只简要介绍几种可行方案。
消费方 IdP 的集成
简介
提供方驱动的集成
2a. 中心 SAP IAS 租户
2b. 消费方 SAP IAS 租户
消费方驱动的集成
3a. 与 SAP IAS 集成
3b. 与 SAP XSUAA 集成
更多信息
提示 - 如果你尝试自行搭建这样的场景,我们非常欢迎你反馈意见、想法以及遇到的问题。
1. 简介
在只有少量用户的 SaaS 场景中,应用内用户管理(In-App User Management)是一种非常便捷的访问管理方案。不过,当使用你的 SaaS 应用的用户数量不断增加,或者处于 B2B 场景时,情况就会发生变化。
你的大多数 SaaS 消费方(尤其是 B2B 场景)都有自己的用户基础,由各自的身份提供方(如 Azure Active Directory)管理。继续使用应用内用户管理会带来大量重复维护工作。因此,你的 SaaS 消费方很可能会要求提供把其自有身份提供方与你的 SaaS 解决方案集成的选项。
下面我们将讨论实现这种集成的几种不同思路。这些场景也体现在下面的架构图中。
Kyma
Cloud Foundry
重要 - 所有方案都需要修改应用逻辑中的代码,因为当前的实现依赖应用内用户管理在 SAP IAS 中创建用户,以及(或)在 SAP XSUAA 中创建影子用户。
2. 提供方驱动的集成
提供方驱动的集成(这是本示例中的叫法,并非官方术语)的前提是:消费方希望把自己的身份提供方与 SaaS 提供方自有的 SAP IAS 租户配合使用。当消费方没有 SAP BTP 全局账户,或不愿承担额外的维护工作时,这种方式很有用。
重要 - 提供方驱动的集成方案会使现有的应用内用户管理失效。请务必理解集成消费方 IdP 的影响,并相应调整应用逻辑!
2a. 中心 SAP IAS 租户
一种便捷的集成模式是在由提供方管理的中心 SAP IAS 租户中使用所谓的企业身份提供方(Corporate Identity Provider)。企业身份提供方让你可以把消费方的身份提供方(如 Azure Active Directory)与 SAP IAS 集成。这样,你就可以把所有或选定的认证请求联合到消费方的身份提供方。
由于 SaaS 用户将不再通过应用内用户管理维护,角色分配需要通过组映射(Group Mapping)来完成。这意味着,消费方使用自己的 IdP 完成认证后,请求会经过 SAP IAS(充当代理),并自动在 SAP XSUAA 中被创建为影子用户。如果配置正确,你会在 SAML 元数据中找到所需的组分配。这些组分配由你的 SaaS 消费方在其自己的 IdP 中完成。这些组需要映射到 SAP XSUAA 角色集合。对于 Azure Active Directory 的组(使用 GUID),效果大致如下。
除了应用内用户管理之外,你还可以在 SaaS 应用内部为消费方提供一种选项,让他们维护 SAP XSUAA 角色集合与其 Active Directory 组之间的组映射。此外,你还需要考虑把成员(Member)用户正确分配到项目的逻辑。由于用户不再在 SaaS 应用内部维护,你可以把项目分配作为附加属性放入 SAML 断言中传递。另一种做法是仍然在单独的表中维护分配关系,并让管理员从所有可用的 SAP XSUAA 影子用户中进行选择。
提示 - 当用户使用消费方 IdP 和中心的 SAP IAS 租户(充当代理)完成认证时,系统会自动在 SAP XSUAA 中创建一个影子用户。
考虑到可能需要修改代码,这是把用户管理与角色分配外包给消费方及其现有身份提供方的第一种方案。
在 SAP IAS 中设置企业身份提供方的详细分步指南见 Tutorial Navigator(点击此处)。有关 SAP BTP 与 Microsoft Azure Active Directory 集成的更多细节,见 Microsoft 官方文档(点击此处)。
下面是一些截图,展示了相应的设置过程和组映射示例。请注意,下面的设置经过大幅简化,例如在生产场景中,声明(claims)的配置方式会有所不同。
2b. 消费方 SAP IAS 租户
与使用中心 SAP IAS 租户来管理所有消费方的用户与企业身份提供方类似,你也可以为每个消费方分别创建独立的 SAP IAS 租户。对于那些不愿把用户存放在 SaaS 提供方管理的中心 SAP IAS 租户中的消费方,这是另一种选择。
与中心 SAP IAS 实例相比,你可以让 SaaS 消费方访问其专属的 SAP IAS 租户,从而让 SaaS 消费方自行管理企业身份提供方、组和用户。为相应的消费方 SAP BTP 子账户做设置时,请在建立 SAP XSUAA 与 SAP IAS 之间的信任关系时选择该消费方专属的 SAP IAS 租户。
重要 - 额外的 SAP IAS 租户需要付费,你需要把这项费用转嫁给你的 SaaS 消费方!
申请到额外的消费方专属 SAP IAS 租户后,所需的实现步骤与「中心 SAP IAS 租户」相似;该场景同样需要修改代码,因为所提供的应用内用户管理已无法使用。
3. 消费方驱动的集成
消费方驱动的集成(同样只是本示例中的叫法,并非官方术语)的前提是:消费方希望使用自己的 SAP IAS 租户,或者更愿意把自己的身份提供方直接与 SAP XSUAA 集成。
重要 - 与提供方驱动的集成方案一样,消费方驱动的集成方案也会使现有的应用内用户管理失效。请务必理解集成消费方 IdP 的影响,并相应调整应用逻辑!
3a. 与 SAP IAS 集成
集成消费方自有的 SAP IAS 租户(由消费方自行申请)与「中心 SAP IAS 租户」相似。主要区别在于:你的 SaaS 消费方不再使用由你(SaaS 提供方)管理的中心 SAP IAS 租户,而是使用自己的 SAP IAS 租户(绑定到其各自的 SAP CRM 客户号)。
当某个 SAP IAS 租户映射到另一个 SAP CRM 客户号时,它不会出现在你各子账户的 Establish Trust 下拉列表中。因此,你需要手动建立信任关系,并通过相应的 SAML 元数据交换来集成消费方自有的 SAP IAS 实例。其余步骤保持不变——例如创建企业身份提供方、在 SAP XSUAA 中设置组映射,以及重新考虑用户与项目的分配关系。
3b. 与 SAP XSUAA 集成
重要 - 不应把 SAP XSUAA 与消费方 IdP 的直接集成作为首选方案。如果可能,请使用(中心或消费方的)SAP Identity Authentication Service 租户充当代理。
「与 SAP IAS 集成」的一种变体是完全跳过 SAP IAS,把 SAP XSUAA 的认证请求直接联合到消费方的身份提供方。为此,你需要在消费方子账户与消费方身份提供方(如 Azure Active Directory)之间建立 SAML 信任关系。虽然不再需要配置 SAP IAS 租户和企业身份提供方,但你仍然需要建立组映射,并同样重新考虑成员用户与项目的分配关系。
请查看下面的博客文章(点击此处),了解如何把身份提供方(此处为 Azure Active Directory)直接与 SAP XSUAA 集成的详细说明。
下面的截图展示了相应的信任设置,以及 SAP XSUAA 与消费方 IdP(此处为 Azure Active Directory)之间的组映射示例。更多截图也可参考「中心 SAP IAS 租户」,因为大部分流程步骤都是相似的。
4. 更多信息
请通过以下链接了解上述主题的更多信息:
本地与混合开发
Kyma ✅
Cloud Foundry ✅
在专家特性的这一部分,你将学习如何使用 CAP 的本地开发与混合开发特性。这些特性可以简化开发流程,让你无论在启用还是未启用多租户的本地环境中都能实现新功能。
本地与混合开发
本地开发
在本地运行多租户应用(susaas-srv)
1.1. 以本地多租户模式启动应用
1.2. 为应用开通新的 SaaS 租户
1.3. 检查应用
在本地运行前端应用(susaas)
2.1. 使用 cds serve 进行本地测试
2.2. 使用 HTML5 Repo Mock 进行本地测试
在本地运行 API 端点
3.1. 在本地启动 API
3.2. 在本地从 API 读取数据
3.4. 在本地通过 API 插入回收材料
混合开发
前提条件
以混合模式运行多租户应用(susaas-srv)
1.1. 登录到提供方子账户的环境
1.2. 准备混合测试环境
1.3. 使用 hybrid 配置以混合模式启动多租户应用
以混合模式运行前端应用
2.1. 从 Approuter 读取环境变量(susaas)
2.2. 以混合模式运行前端应用
2.3. 启动 UI 应用
以混合模式运行多租户 API(susaas-api-srv)
3.1. 获取多租户 API 的环境变量
3.2. 以混合模式启动 API
3.3. 在混合模式下测试 API
本地开发
本地开发环境(LDE)是指在笔记本电脑/台式机上运行应用与服务的方式。软件开发人员借助本地开发来测试自己的开发成果、验证新增功能并调试应用。
提示:本文档同时适用于应用的基础版本与高级版本。
1. 在本地运行多租户应用(susaas-srv)
借助 SAP Cloud Application Programming Model(CAP)最新的 MTX 包版本(@sap/cds-mtxs),开发者可以像此处所述那样,以本地模式运行应用。
1.1. 以本地多租户模式启动应用
在 code 目录中运行下面的命令,即可在本地启动后端应用。这会在你的本地设备上启动带多租户支持的应用。系统会初始化一个初始 t0 租户,其中包含由 CAP 管理的技术数据。t0 租户并不是真正的 SaaS 应用租户。
## Run in ./code ##
npm run srv:mtx
如果一切正常,你应该会看到如下输出。
[cds] - connect to db > sqlite { url: '../db.sqlite' }
[cds] - using auth strategy: {
kind: 'basic-auth',
impl: '../node_modules/@sap/cds/lib/auth/basic-auth.js'
}
[cds] - serving cds.xt.SaasProvisioningService { path: '/-/cds/saas-provisioning' }
[cds] - serving cds.xt.DeploymentService { path: '/-/cds/deployment' }
[cds] - serving cds.xt.ModelProviderService { path: '/-/cds/model-provider' }
[cds] - serving cds.xt.ExtensibilityService { path: '/-/cds/extensibility' }
[cds] - serving cds.xt.JobsService { path: '/-/cds/jobs' }
[cds] - serving AdminService { path: '/catalog/AdminService', impl: 'srv/admin-service' }
[cds] - serving PublicService { path: '/catalog/PublicService', impl: 'srv/public-service' }
[cds|t0] - loaded model from 1 file(s):
../node_modules/@sap/cds-mtxs/db/t0.cds
[cds] - server listening on { url: 'http://localhost:4004' }
[cds] - launched at 9/27/2023, 5:35:52 PM, version: 7.1.1, in: 979.997ms
[cds] - [ terminate with ^C ]
1.2. 为应用开通新的 SaaS 租户
现在应用已启动并运行,下一步是为应用添加一个新的 SaaS 租户,从而为该租户生成一个新的 SQLITE 实例。
新建一个终端窗口,运行下面的命令为租户 t1 开通。
## Run in ./code ##
cds subscribe t1 --to http://localhost:4004 -u alice
你应该会看到如下输出。
Subscribing { tenant: 't1' } to { url: 'http://localhost:4004' }
Subscription succeeded.
请注意,用户 alice 已在你的 .cdsrc.json 文件中定义为租户 t1 的成员,并具有 Admin、cds.Subscriber 和 cds.ExtensionDeveloper 角色,如下所示。因此我们能够使用用户 alice 的凭据进行订阅,因为该用户拥有订阅租户的权限。
...
"[local-with-mtx]": {
"kind": "basic",
"users": {
"alice": {
"tenant": "t1",
"roles": [
"Admin",
"cds.Subscriber",
"cds.ExtensionDeveloper"
]
},
...
更多信息请参阅官方文档。
1.3. 检查应用
现在应用后端已在运行,我们可以直接访问 http://localhost:4004。
例如,点击 Projects 实体后会弹出要求输入凭据的对话框。你可以再次输入 alice 作为用户名,因为它是我们租户 t1 的示例用户。密码字段留空,然后按 Enter。
你应该会在浏览器中看到返回的项目数据,如下所示。
2. 在本地运行前端应用(susaas)
对开发者来说,本地前端开发同样至关重要,因为开发者总希望先在本机试用,然后再部署到真实环境。按照本节操作,你将能够在本地运行前端应用并进行本地开发。
本地测试可以很简单,只需调用 cds serve(它被封装在一些 npm 脚本后面);但如果你想按生产环境的方式测试,可以使用所谓的 HTML5 Repo Mock。该工具可以模拟你 SAP BTP 账户中使用的 SAP HTML5 Application Repository。
2.1. 使用 cds serve 进行本地测试
如果要在不使用 HTML5 Repo Mock 的情况下进行本地测试,只需按上一步所述,以启用多租户或未启用多租户的方式启动应用即可。相应的 npm 脚本会触发 cds serve 命令。
启用多租户
## Run in ./code ##
npm run srv:mtx
提示 - 这种情况下,在浏览器中打开应用之前请不要忘记订阅 t1 租户。这会在你的 code 目录下创建一个新的 SQLite 数据库文件 db-t1.sqlite。
cds subscribe t1 --to http://localhost:4004 -u alice
未启用多租户
提示 - 如果尚未执行,请不要忘记在运行下面的命令之前把数据模型部署到 SQLite 数据库。
## Run in ./code ## npm run db:deploy这会在 code 目录下的 db.sqlite 文件中创建所需的 SQLite 对象。使用多租户时,这一步会在新租户开通时自动完成。
## Run in ./code ##
npm run srv:watch
打开浏览器并访问 http://localhost:4004。你会看到一个指向 launchpad.html 的链接,该页面是一个Web 应用,提供模拟的 Fiori Launchpad,用于打开并测试所提供的全部 SAPUI5 应用。此外,如果需要测试,你还会找到指向各独立 SAPUI5 应用的链接。
点击独立应用的链接,或 Fiori Launchpad 中相应的磁贴,会弹出对话框要求输入用户名和密码。按上一步的说明,使用 alice 作为用户名,密码字段留空。之后你就可以浏览应用、通过修改后端注解来调整 UI,并测试你的开发成果。
2.2. 使用 HTML5 Repo Mock 进行本地测试
与 cds serve 测试方式相比,使用 HTML5 Repo Mock 需要多几个步骤。不过,这种方式更接近 SAP BTP 环境中的实际运行情况。要使用 HTML5 Repo Mock,你需要把 code 目录下的 .env.sample 文件重命名或复制为 .env 文件(如果尚未完成)。.env 文件包含在本地运行 HTML5 Repo Mock 所需的一些环境变量。
# Application Router
TENANT_HOST_PATTERN='^(.*).localhost'
EXTERNAL_REVERSE_PROXY=true
destinations='[{"name": "susaas-srv-api","url":"http://localhost:4004/","forwardAuthToken": true,"strictSSL": false}]'
# Mock Repo
MOCK_DIR=../app
AR_DIR=../router
在启动 HTML5 Repo Mock 之前,请确保 SaaS 后端已启动(npm run srv:watch)。然后运行下面的命令,在本地启动前端应用(使用 HTML5 Repo Mock):
## Run in ./code ##
npm run mock:watch
命令执行完成后,访问 http://localhost:5000。你应该会看到如下应用界面。
点击任意内容,会弹出对话框要求输入用户名和密码。按上一步的说明,使用 alice 作为用户名,密码字段留空。之后你就可以浏览应用、通过修改后端注解来调整 UI,并测试你的开发成果。
3. 在本地运行 API 端点
除了前端和后端,我们还有一个多租户 API 端点,你可能也想在本地测试它。请注意,在本地模式下,你的改动不会反映到前端或后端应用,因为 SQLite 数据并不共享。但你仍然可以检查 API:相关数据是否已正确插入、处理程序是否正常运行等等。
3.1. 在本地启动 API
在你的根目录中运行下面的命令。
启用多租户
提示 - 这种情况下,在测试 API 之前请务必使用 cds subscribe 命令订阅一个租户。如果尚未完成,请先运行后端服务并订阅一个租户!
npm run srv:mtx cds subscribe t1 --to http://localhost:4004 -u alice这样可以确保在 code 目录中为相应订阅方创建 SQLite 数据库文件(名为 db-t1.sqlite)。
## Run in ./code ##
npm run api:mtx
未启用多租户
提示 - 如果尚未执行,请不要忘记在运行下面的命令之前把数据模型部署到 SQLite 数据库。
## Run in ./code ## npm run db:deploy这会在 code 目录下的 db.sqlite 文件中创建所需的 SQLite 对象。
## Run in ./code ##
npm run api:watch
你应该会看到 API 已在本地运行,如下所示。
[cds] - connect using bindings from: { registry: '~/.cds-services.json' }
[cds] - connect to db > sqlite { url: '../db.sqlite' }
[cds] - using auth strategy: {
kind: 'basic-auth',
impl: '../node_modules/@sap/cds/lib/auth/basic-auth.js'
}
[cds] - serving ApiService { path: '/rest/api', impl: 'srv/api-service' }
[cds] - server listening on { url: 'http://localhost:4005' }
[cds] - launched at 9/27/2023, 5:49:06 PM, version: 7.1.1, in: 4.474s
[cds] - [ terminate with ^C ]
3.2. 在本地从 API 读取数据
你可以在终端中使用下面的请求读取当前的产品数据。
提示 - 你实际使用的端口可能不同(例如 4004)。请检查 npm run api:watch 命令的输出。
curl http://localhost:4005/rest/api/Products -u "system-user"
Enter host password for user 'system-user': # <- Just hit "Enter"
{"ID":"HT-1000","typeCode":"PR","category":"Notebooks","supplierId":"0100000046",...}
3.3. 在本地向 API 插入产品
你可以在终端中使用下面的请求插入产品。
curl --location --request POST 'http://localhost:4005/rest/api/bulkUpsertProducts' \
-u 'system-user' \
--header 'Content-Type: application/json' \
--data-raw '
{
"products" : [
{"ID": "HT-1000-1","eolProductDesign": 43,"traditionalSalesShare": 82,"repairSalesShare": 8,"resellSalesShare": 10},
{"ID": "HT-1001-2","eolProductDesign": 38,"traditionalSalesShare": 97,"repairSalesShare": 3,"resellSalesShare": 0}
]
}'
Enter host password for user 'system-user': # <- Just hit "Enter"
Records successfully updated!
3.4. 在本地通过 API 插入回收材料
你可以在终端中使用下面的请求插入回收材料。
curl --location --request POST 'http://localhost:4005/rest/api/bulkUpsertRecyclingMaterials' \
--user 'system-user' \
--header 'Content-Type: application/json' \
--data-raw '{
"recyclingMaterials" : [
{"product_ID":"HT-1000","material":"MT10000001","materialName":"Aluminium","weightShare":14,"recycleShare":23},
{"product_ID":"HT-1000","material":"MT20000008","materialName":"Plastic","weightShare":34,"recycleShare":30}
]
}'
欢迎自行修改这些请求,并尝试调用你的 API 提供的其他端点。
混合开发
重要 - 我们目前正在分析影响 SAP Business Application Studio 中混合开发与测试的问题。由此带来的不便,我们深表歉意,并感谢你的耐心。如果你也遇到类似问题,请放心,我们正在尽快解决。在此期间,你可以尝试在 Visual Studio Code 中进行本文建议的混合开发。感谢你的理解。
使用本地数据库和 mock 可以轻松测试你的 CAP 应用。但到了一定阶段,你终究会希望用真实的云服务进行测试。当然,你随时可以把应用部署到云端。
借助混合测试能力,你可以留在本地开发环境中,避免云部署漫长的周转时间,并且可以有选择地决定要使用云端的哪些服务。
简单来说,你的应用仍然运行在笔记本电脑上,但会使用 SAP HANA Cloud 或 XSUAA 之类的 SAP BTP 服务。
前提条件
要开始混合开发,你至少需要把多租户应用部署到 SAP BTP Kyma 集群或 Cloud Foundry 运行时一次,并且你的多租户应用应至少有一个已订阅的租户。
1. 以混合模式运行多租户应用(susaas-srv)
本节将介绍如何以混合模式运行 susaas-srv 模块。这意味着应用运行时在你的笔记本电脑上,而所有其他后端服务都使用你 SAP BTP 账户中的实例。
1.1. 登录到提供方子账户的环境
Kyma
如果你使用 SAP BTP Kyma 运行时,请使用 kubectl 把上下文设置为 Kyma 集群中的正确命名空间,因为所有后端服务都创建在那里。
kubectl config set-context --current --namespace=<KymaNamespace>
示例
kubectl config set-context --current --namespace=default
你可以运行下面的命令来复查上下文是否设置正确:
kubectl config get-contexts
CURRENT NAME CLUSTER AUTHINFO NAMESPACE
docker-desktop docker-desktop docker-desktop
* shoot--kyma--a1b2c3 shoot--kyma--a1b2c3 shoot--kyma--a1b2c3 default
Cloud Foundry
运行下面的命令,并请务必登录到正确的 Cloud Foundry 空间,因为所有后端服务都创建在那里。
## Run in ./code ##
cf login
请确保指向正确的 Cloud Foundry 组织和空间。
1.2. 准备混合测试环境
Kyma
在 Kyma 场景中进行混合测试时,你需要把有效的服务绑定(Service Binding)信息保存到 srv/.cdsrc-private.json 文件中。为此,请在 code 目录中运行下面的命令。
重要 - 请把 <ReleaseName> 占位符替换为你部署的 Kyma Release 名称(例如 susaas 或 susaas-prod)。仅在你之前已安装 alert-notification 时才绑定它。
## Run in ./code ##
cds bind -2 <ReleaseName>-srv-destination,<ReleaseName>-srv-xsuaa --on k8s --for hybrid --output-file srv/.cdsrc-private.json
cds bind hana -2 <ReleaseName>-srv-hana --kind hana --on k8s --for hybrid --output-file srv/.cdsrc-private.json
cds bind saas-registry -2 <ReleaseName>-srv-saas-registry --kind saas-registry --on k8s --for hybrid --output-file srv/.cdsrc-private.json
cds bind sm-admin -2 <ReleaseName>-srv-sm-admin --kind service-manager --on k8s --for hybrid --output-file srv/.cdsrc-private.json
cds bind sm-container -2 <ReleaseName>-srv-sm-container --kind service-manager --on k8s --for hybrid --output-file srv/.cdsrc-private.json
cds bind alert-notification -2 <ReleaseName>-srv-alert-notification --kind alert-notification --on k8s --for hybrid --output-file srv/.cdsrc-private.json
这会在你的 srv 文件夹中创建一个新的 .cdsrc-private.json 文件,其中包含全部绑定信息。以混合模式运行应用时,这些绑定会被动态解析。
Cloud Foundry
在 code 目录中运行下面的命令,在 Cloud Foundry 中创建可用于混合测试的服务密钥。
重要 - 请把 <SpaceName> 占位符替换为你的 Cloud Foundry 空间名称。
## Run in ./code ##
cf csk <SpaceName>-susaas-uaa <SpaceName>-susaas-uaa-key
cf csk <SpaceName>-susaas-registry <SpaceName>-susaas-registry-key
cf csk <SpaceName>-susaas-destination <SpaceName>-susaas-destination-key
cf csk <SpaceName>-susaas-service-manager <SpaceName>-susaas-service-manager-key
cf csk <SpaceName>-susaas-com-hdi-container <SpaceName>-susaas-com-hdi-container-key
cf csk <SpaceName>-susaas-alert-notification <SpaceName>-susaas-alert-notification-key
cf csk <SpaceName>-susaas-service-manager-admin <SpaceName>-susaas-service-manager-admin-key
所有服务密钥创建成功后,请把它们添加到存储在 srv/.cdsrc-private.json 中的混合测试配置(profile)里。为此,请在 code 目录中运行下面的命令。
重要 - 请把 <SpaceName> 占位符替换为你的 Cloud Foundry 空间名称。
## Run in ./code ##
cds bind -2 <SpaceName>-susaas-destination,<SpaceName>-susaas-uaa --for hybrid --output-file srv/.cdsrc-private.json
cds bind hana -2 <SpaceName>-susaas-com-hdi-container --kind hana --for hybrid --output-file srv/.cdsrc-private.json
cds bind saas-registry -2 <SpaceName>-susaas-registry --kind saas-registry --for hybrid --output-file srv/.cdsrc-private.json
cds bind sm-container -2 <SpaceName>-susaas-service-manager --kind service-manager --for hybrid --output-file srv/.cdsrc-private.json
cds bind sm-admin -2 <SpaceName>-susaas-service-manager-admin --kind service-manager --for hybrid --output-file srv/.cdsrc-private.json
cds bind alert-notification -2 <SpaceName>-susaas-alert-notification --kind alert-notification --for hybrid --output-file srv/.cdsrc-private.json
这会在你的 srv 文件夹中创建一个新的 .cdsrc-private.json 文件,其中包含全部绑定信息。以混合模式运行应用时,这些绑定会被动态解析。
至此完成,你可以继续后面的步骤,以混合模式启动你的服务了。
1.3. 使用 hybrid 配置以混合模式启动多租户应用
现在你已经下载了环境变量,运行下面的命令以混合模式启动应用。
## Run in ./code ##
npm run srv:hybrid
执行该命令后,应用应已启动并运行,但日志看起来会有所不同。因为应用现在以 production 配置运行,日志会按 SAP BTP Application Logging 服务的格式输出。
提示 - 请注意,你的服务现在使用的是 SAP BTP Cloud Foundry 运行时中的后端服务,例如 XSUAA 或 SAP HANA Cloud。
2. 以混合模式运行前端应用
本节将让前端应用连接到 SAP BTP Cloud Foundry 空间中的后端服务(如 XSUAA 或 Destination 服务)来运行。对前端应用进行混合测试时,你仍会使用 HTML5 Repo Mock。这种情况下无法使用 cds serve(或相应的 npm 脚本)进行简化测试,因为需要一个 SAP Approuter 实例。
2.1. 从 Approuter 读取环境变量(susaas)
Kyma
在 Kyma 场景中进行混合测试时,你需要把有效的服务绑定信息保存到 router/.cdsrc-private.json 文件中。为此,请在 code 目录中运行下面的命令。
重要 - 请把 <ReleaseName> 占位符替换为你部署的 Kyma Release 名称(例如 susaas 或 susaas-prod)。
## Run in ./code ##
cds bind -2 <ReleaseName>-router-destination,<ReleaseName>-router-xsuaa --on k8s --for hybrid --output-file router/.cdsrc-private.json
cds bind html5-apps-repo -2 <ReleaseName>-router-html5-apps-repo --kind html5-apps-repo --on k8s --for hybrid --output-file router/.cdsrc-private.json
这会在你的 router 文件夹中创建一个新的 .cdsrc-private.json 文件,其中包含全部绑定信息。以混合模式运行 Application Router 时,这些绑定会被动态解析。
至此完成,你可以继续后面的步骤,以混合模式启动路由器了。
Cloud Foundry
在 code 目录中运行下面的命令,在 Cloud Foundry 中创建可用于混合测试的服务密钥。
重要 - 请把 <SpaceName> 占位符替换为你的 Cloud Foundry 空间名称。
## Run in ./code ##
cf csk <SpaceName>-susaas-uaa <SpaceName>-susaas-uaa-key
cf csk <SpaceName>-susaas-destination <SpaceName>-susaas-destination-key
cf csk <SpaceName>-susaas-html5-repo-runtime <SpaceName>-susaas-html5-repo-runtime-key
所有服务密钥创建成功后,请把它们添加到存储在 router/.cdsrc-private.json 中的混合测试配置里。为此,请在 code 目录中运行下面的命令。
重要 - 请把 <SpaceName> 占位符替换为你的 Cloud Foundry 空间名称。
## Run in ./code ##
cds bind -2 <SpaceName>-susaas-destination,<SpaceName>-susaas-uaa --for hybrid --output-file router/.cdsrc-private.json
cds bind html5-apps-repo -2 <SpaceName>-susaas-html5-repo-runtime --kind html5-apps-repo --for hybrid --output-file router/.cdsrc-private.json
这会在你的 router 文件夹中创建一个新的 .cdsrc-private.json 文件,其中包含全部绑定信息。以混合模式运行 Application Router 时,这些绑定会被动态解析。
至此完成,你可以继续后面的步骤,以混合模式启动路由器了。
2.2. 以混合模式运行前端应用
进入 code 目录,运行下面的命令以 hybrid 模式启动 Application Router。
## Run in ./code ##
npm run router:hybrid
你应该会看到应用已启动并运行,且 Application Router 正在 localhost:5000 上监听。
2.3. 启动 UI 应用
进入你的消费方子账户,获取其子域名(例如从子账户概览页面获取)。通过访问 yourconsumersubdomain.localhost:5000 来启动应用。
例如,如果你的消费方子域名为 consumer-123xyz,则应访问的端点是 consumer-123xyz.localhost:5000。
你应该会看到应用已启动并运行,如下所示。
3. 以混合模式运行多租户 API(susaas-api-srv)
在以混合模式运行 SaaS API 之前,请确保终止仍在运行的本地 SaaS 后端实例。
3.1. 获取多租户 API 的环境变量
Kyma
在 Kyma 场景中进行混合测试时,你需要把有效的服务绑定信息保存到 api/.cdsrc-private.json 文件中。为此,请在 code 目录中运行下面的命令。
重要 - 请把 <ReleaseName> 占位符替换为你部署的 Kyma Release 名称(例如 susaas 或 susaas-prod)。
## Run in ./code ##
cds bind -2 <ReleaseName>-api-xsuaa-api --on k8s --for hybrid --output-file api/.cdsrc-private.json
cds bind sm-container -2 <ReleaseName>-api-sm-container --kind service-manager --on k8s --for hybrid --output-file api/.cdsrc-private.json
这会在你的 api 文件夹中创建一个新的 .cdsrc-private.json 文件,其中包含全部绑定信息。以混合模式运行 API 服务时,这些绑定会被动态解析。
至此完成,你可以继续后面的步骤,以混合模式启动 API 了。
Cloud Foundry
在 code 目录中运行下面的命令,在 Cloud Foundry 中创建可用于混合测试的服务密钥。
重要 - 请把 <SpaceName> 占位符替换为你的 Cloud Foundry 空间名称。
## Run in ./code ##
cf csk <SpaceName>-susaas-api-uaa <SpaceName>-susaas-api-uaa-key
cf csk <SpaceName>-susaas-service-manager <SpaceName>-susaas-service-manager-key
所有服务密钥创建成功后,请把它们添加到存储在 api/.cdsrc-private.json 中的混合测试配置里。为此,请在 code 目录中运行下面的命令。
重要 - 请把 <SpaceName> 占位符替换为你的 Cloud Foundry 空间名称。
## Run in ./code ##
cds bind -2 <SpaceName>-susaas-api-uaa --for hybrid --output-file api/.cdsrc-private.json
cds bind sm-container -2 <SpaceName>-susaas-service-manager --kind service-manager --for hybrid --output-file api/.cdsrc-private.json
这会在你的 api 文件夹中创建一个新的 .cdsrc-private.json 文件,其中包含全部绑定信息。以混合模式运行 API 服务时,这些绑定会被动态解析。
至此完成,你可以继续后面的步骤,以混合模式启动 API 了。
3.2. 以混合模式启动 API
运行下面的命令以混合模式启动 API。
## Run in ./code ##
npm run api:hybrid
3.3. 在混合模式下测试 API
在以混合模式测试 API 之前,请进入你已有的消费方子账户。确保该消费方子账户已有一个 Sustainable SaaS API 服务实例,并已存在服务绑定。如果还没有,请把两者都创建出来。
选择该服务实例并打开服务绑定的凭据。复制这些凭据,用它们填充下面 http file 中的占位符,然后就可以开始了。
提示 - 你也可以先复制该 http 文件,并把它重命名为 api-test-hybrid-private.http。这样可以确保你的凭据不会被提交到 GitHub。
你可以使用 http file,逐个发送请求。
管理租户数据库容器
Kyma ✅
Cloud Foundry ✅
在专家特性的这一部分,你将学习如何访问和管理租户数据库容器。在本示例场景中,你将使用一个被授予底层数据库模式管理权限(如 CREATE ANY、SELECT、EXECUTE 或 DROP 等 SQL 权限)的用户来访问相应的租户数据库容器。
管理租户数据库容器
简介
前提条件
获取数据库容器凭据
访问租户数据库容器
更多信息
另请查看 Andrew Lunde 撰写的博客文章,它列在更多信息部分(点击此处)。文章提供了更多细节,以及与由所谓的 SAP Service Manager 管理的容器交互的不同思路。
1. 简介
本文演示的方法说明如何使用所谓的技术性 Runtime 用户访问租户数据库容器。该用户拥有与底层数据库模式交互的广泛权限,因此本文介绍的访问方式只应在非常特殊的情况下使用!这个技术用户能够修改租户容器中的任何数据,并能通过普通 SQL 命令创建和删除模式对象。
提示 - 如果你想调整分配给 Runtime 用户的这个默认访问角色的权限,请阅读下面的 SAP Help 文档(点击此处)。请记住,这同时也会限制 Service Manager 在访问租户数据库容器时所使用的 Runtime 用户的权限。
在生产环境中,任何开发者都不应拿到本分步指南中使用的凭据。要做到这一点,可以不向生产子账户中的开发者分配 Space Developer、Supporter 或 Manager 之类的 Cloud Foundry 角色。取而代之,应使用数量非常有限的具名数据库用户,并配合数据库模式提供的专用支撑角色。
请仅在出于学习目的时使用这种方法,例如在开发环境中,或在非常特殊的情况下由专职管理员操作——该管理员需能够访问 Service Manager 实例的服务绑定信息!
2. 前提条件
你需要在部署 SaaS 应用的 Cloud Foundry 空间中拥有 Developer 角色。
你需要能够访问 Subscription Management Dashboard,它可简化租户 ID 的识别。
3. 获取数据库容器凭据
3.1. 使用绑定到多租户应用的 SaaS Registry 服务,确定相应消费方租户的租户 ID(此处为 thebestrun)。
提示 - 请确保你的 SAP BTP 子账户用户具有访问 SaaS Registry 的 Subscription Management Dashboard 所需的角色。如有必要,创建并分配一个包含所需角色的新角色集合。相关角色可在官方文档中找到。
3.2. 通过检查标签并与你在 Subscription Management Dashboard 中确定的租户 ID 比对,在 SaaS Service Manager 中定位相关的租户数据库容器实例。
3.3. 打开已有的 Service Binding,读取你要访问的租户数据库容器的凭据。请记下 host、port、user 和 password 属性。
提示 - 可以看到 user 属性以 RT 结尾,代表 RunTime 用户。hdi_user 属性以 DT 结尾,即所谓的 DesignTime 用户。
3.4. 切换到 SAP HANA Database Explorer,添加租户数据库容器连接。你可以从 SAP HANA Cloud Tools 打开 SAP HANA Database Explorer。
提示 - 打开 Database Explorer 时可能会要求登录。为此请使用 DBADMIN 或其他非技术性数据库用户。
4. 访问租户数据库容器
4.1. 点击 + 图标添加新的数据库连接。选择实例类型 SAP HANA Database。
4.2. 把步骤 3.3 中的服务绑定凭据填入相应字段。按截图所示启用基于 SSL 的通信。点击 OK,把租户容器/模式添加到 SAP HANA Database Explorer。
4.3. 容器出现在可用连接列表后,请切换到 Tables 区域。要查看租户数据库容器/模式的表,请点击值帮助图标。
提示 - 目前你只能看到 Runtime 用户(_RT 用户)自己的模式中的表,而该模式为空。请记住,数据库容器本质上就是一组数据库模式的集合。
4.4. 选择两个名称随机生成、可用的模式,即共享数据库容器模式和租户数据库容器模式。点击 Select 关闭值帮助。
提示 - 你可以取消勾选 RT(Runtime)用户自己的模式。
4.5. 现在你应该可以访问 bestrun 租户的共享数据库容器/模式与租户数据库容器/模式中的所有表。你可以使用 SQL 命令或可用的用户界面选项来查看表内容、插入/删除/修改记录,或创建和删除模式对象。
5. 更多信息
请通过以下链接了解上述主题的更多信息:
使用 Microsoft Graph 发送电子邮件
Kyma ✅
Cloud Foundry ✅
本教程将介绍如何使用 Microsoft Graph API 和 Exchange Online 从 SaaS 应用发送电子邮件。这在需要从应用内部向用户发送自动化消息的场景中很有用。这只是使用主流 Microsoft 服务以编程方式发送电子邮件的一种方式。你也可以考虑为 SMTP 服务器配置一个目标(destination),或使用 AWS Simple Email Service(SES)、SendGrid 等其他提供方提供的类似服务。
使用 Microsoft Graph 发送电子邮件
简介
前提条件
创建共享邮箱
创建应用注册
测试示例应用
资源所有者密码流
更多信息
重要 - 下面的示例方法使用的应用级 Graph API 权限非常强大。在生产环境中,应在设置完成后立即限制该权限,以防止应用开发者滥用。否则,任何持有相应凭据的人都能以任意 Active Directory 用户的身份发送电子邮件!请按照 Microsoft 官方文档(点击此处)设置相应的限制。
1. 简介
大多数 SaaS 应用都需要通过电子邮件或其他消息渠道与用户互动。因此,如今作为 SaaS 提供方,你有多种方式在自己的环境中搭建这样的电子邮件服务集成。由于 Microsoft Office 365 与 Exchange Online 是市场上最流行的产品之一,我们将展示如何用它们直接在应用内部用几行代码发送电子邮件。
虽然 SAP BTP 提供定义 MAIL 类型目标(destination)的选项,但在尝试用 IMAP、POP 或 SMTP 连接现代邮件服务器时,你很可能会遇到认证问题。让我们看看许多企业都在使用的 Microsoft Exchange Online 的例子。
2021 年 9 月,Microsoft 发布了以下声明:「[…] 自 2022 年 10 月 1 日起,我们将开始在 Exchange Online 中禁用 Outlook、EWS、RPS、POP、IMAP 和 EAS 协议的基本认证。未被使用的 SMTP Auth 也将被禁用。[…] 我们强烈建议客户尽可能不再对 SMTP AUTH 使用基本认证。其他发送认证邮件的方式包括使用替代协议,例如 Microsoft Graph API。」(详情请见此处)
因此,在 Exchange Online 中已无法再使用带基本认证的 IMAP 或 POP 协议。此外,SMTP Auth 默认被禁用,必须为组织或特定邮箱显式启用(见此)。最后但同样重要的是,如果某个认证策略已禁用基本认证,那么客户端连 SMTP Auth 协议也无法再使用!
鉴于这些与安全相关的限制,Microsoft 建议改用 Microsoft Graph API 等替代协议,这也是下面的专家特性教程要介绍的内容。
2. 前提条件
Microsoft Azure
要创建一个可用于通过 Microsoft Graph 发送电子邮件的应用注册,你需要一个有效的 Microsoft Azure 账户,其中包含 Microsoft Entra ID(原 Azure Active Directory)。你可以在此处注册免费的 Microsoft Azure 账户。
提示 - 出于测试目的,使用免费的 Azure 账户即可,不需要付费的 Azure 订阅。
Exchange Online
你可以使用共享邮箱或普通用户的收件箱发送电子邮件。两种场景下,你都需要至少一个包含 Exchange Online 访问权限的有效许可证(例如 Office 365 F3)。创建 Microsoft Azure 账户后,在此处登录 Microsoft 365 管理中心。你可以在这里购买和查看已授权的产品,例如 Office 365 F3 订阅。
提示 - 出于测试目的,请检查你是否有资格获得免费的 Microsoft Teams Exploratory 许可证。该许可证同样包含所需的 Exchange Online 访问权限。
3. 创建共享邮箱
在你的 Microsoft 365 账户已分配有效许可证(含 Exchange Online 功能)之后,可以切换到 Exchange 管理中心(https://admin.exchange.microsoft.com/)创建新的共享邮箱。有关共享邮箱的更多信息与限制,见 Microsoft 官方文档(点击此处)。
在下面的示例中,我们创建了两个共享邮箱。一个用于应用发送的自动化消息,不应接收任何回复邮件(donotreply@susaas.com)。另一个是我们 SaaS 应用的联络邮箱(info@susaas.com),可由一个或多个委托用户访问。这个联络邮箱也可以接收邮件。
提示 - 本例中,susaas.com 已作为自定义域在相应管理中心的设置中注册。在测试场景中,你也可以直接使用账户默认分配的 *.onmicrosoft.com 域。
Exchange 管理中心提供了许多选项,本教程无法一一覆盖,例如我们在 DoNotReply 邮箱中使用的规则——它会自动删除到达该邮箱的所有邮件。欢迎自行探索 Exchange Online 的更多选项。
DoNotReply 邮箱只用于在 SaaS 应用内部发送邮件,因此不需要任何委托访问权限;而常规联络邮箱则需要委托访问。你可以添加多个负责维护该联络邮箱的用户。
每个委托用户都需要分配包含 Exchange Online 访问权限的有效许可证(例如 Office 365 F3)。如果该用户未出现在 Exchange 管理中心的可用用户列表中,请回到 Microsoft 365 管理中心(https://admin.microsoft.com/),选择该用户,并切换到 Mail 选项卡。几分钟内应该就能完成 Exchange Online 用途的初始化。
重要 - 每个共享邮箱都会在你的 Microsoft 365 管理中心生成一个新用户。该用户不应用于登录,其密码也不得修改!此外,你无需为共享邮箱用户分配任何许可证。
4. 创建应用注册
你可以使用标准的 Microsoft Entra ID(原 Azure Active Directory)应用注册通过 Microsoft Graph API 发送电子邮件。应用注册让你可以针对特定范围(例如使用 Microsoft Graph)从 Microsoft Entra ID(原 Azure Active Directory)获取访问令牌。每个应用注册都可以定义已授权的范围/权限。创建这样一个应用注册的过程非常简单。
4.1. 打开 Azure 门户,进入你的 Microsoft Entra ID(原 Azure Active Directory)实例。
4.2. 切换到 App registrations,点击 New registration。
4.3. 自定义一个名称,选择 Single Tenant 模式,然后点击 Register。
4.4. 应用注册创建完成,页面会跳转到概览页。
提示 - 请记下 Application (client) ID 和 Directory (tenant) ID。在示例应用中做认证时会用到这两个值。
4.5. 切换到 API permissions,点击 Add a permission。
4.6. 从可用 API 中选择 Microsoft Graph,点击 Application permissions,搜索 Mail.Send 权限。选中它并点击 Add permissions。
4.7. 这是一个非常强大的权限,因为它设置在应用级别,允许你以目录中任意用户的身份发送电子邮件。因此,必须为该权限授予管理员同意(admin consent)。
重要 - 请查看 Microsoft 官方文档,了解如何把应用的访问权限限制到特定邮箱!
4.8. 如下面截图所示,你可以从 API 权限列表中移除 User.Read 权限及其管理员同意。
4.9. 切换到 Certificates & secrets 区域,创建新的 Client Secret。请复制该密钥值,因为离开页面后你将无法再次查看。
5. 测试示例应用
5.1. 进入本专家特性主题的 ./code 目录,其中包含用于测试你配置的示例应用。把 index.js 和 package.json 文件复制到本地设备上——这样可以确保你不会把任何密钥推送到 GitHub。
5.2. 打开终端窗口,切换到复制这些文件的目录。在该目录中运行 npm install 命令,安装所需的依赖。
5.3. 打开 index.js 文件,更新以下代码段。
5.3.1. 根据前面步骤创建的密钥,以及应用注册概览页中的应用信息,更新凭据。
const credential = new ClientSecretCredential(
'<<a22bd-...-a1f071e>>', // Directory (tenant) ID
'<<9b79b-...-1f1c55d>>', // Application (client) ID
'<<ZYM8Q~...~SUscdn2>>' // Application Secret
);
5.3.2. 为测试邮件的收件人填入有效的电子邮件地址。
const sendMail = {
message: {
subject: 'Meet for lunch?',
body: {
contentType: 'Text',
content: 'The new cafeteria is open!'
},
toRecipients: [{
emailAddress: {
address: '<<mail.address@of.recipient>>' // Recipient's e-mail address
}
}]
},
saveToSentItems: 'false'
};
5.3.3. 填入你在本教程开头创建的共享邮箱的电子邮件地址。
client.api('/users/<<mail.address@of.mailbox>>/sendMail') // Shared mailbox e-mail address
.header("Content-type", "application/json")
.post(sendMail, (err, res, rawResponse) => {
console.log(res);
console.log(rawResponse);
console.log(err);
});
5.4. 保存 index.js 文件,并在终端中运行 npm run start。如果看到如下结果,说明邮件发送成功。
5.5. 检查收件人邮箱的收件箱,邮件应该已经到达。
5.7. 现在你可以把上述代码集成到应用中,例如在 Business Application Service 中新增一个辅助类。
重要 - 请务必把凭据值安全地存储在 SAP Credential Store 中,并定期轮换!此外,你还可以考虑改进安全设置,改用 X.509 证书而不是客户端凭据(Client Credentials)来获取访问令牌。
6. 资源所有者密码流
尽管 Microsoft 不推荐使用下面这种替代方法(见此),我们仍在这里简单提一下。除了把客户端凭据流(Client Credentials Flow)与应用级权限结合使用之外,你也可以使用资源所有者密码流(Resource Owner Password Flow),并配合委派权限(Delegate permissions)。
这种方法的缺点在于:应用注册必须配置为允许公共客户端(Public Client)访问,而且你需要在 SAP Credential Store 中保存某个目录用户的密码。如前所述,Microsoft 不推荐这种方法,只有在因故无法使用客户端凭据流(配合邮箱限制)时才应使用。
const { UsernamePasswordCredential } = require("@azure/identity");
const credential = new UsernamePasswordCredential(
'<<a22bd-...-a1f071e>>', // Directory (tenant) ID
'<<9b79b-...-1f1c55d>>', // Application (client) ID
'<<sample.user@azure.directory>>' // Username
'<<password-of-sample-user>>' // Password
);
在这种情况下,如果你想把共享邮箱用作邮件发件人,需要把该用户添加为该邮箱的委托用户。否则,你只能像下面这样以该用户的身份发送邮件。
client.api('/users/<<mail.address@sample.user>>/sendMail') // User e-mail address
.header("Content-type", "application/json")
.post(sendMail, (err, res, rawResponse) => {
console.log(res);
console.log(rawResponse);
console.log(err);
});
7. 更多信息
请通过以下链接了解上述主题的更多信息:
更新租户数据库容器
Kyma ✅
Cloud Foundry ✅
在专家特性的这一部分,你将学习如何通过 API 调用把数据模型变更分发到你的租户数据库容器。
更新租户数据库容器
前提条件
简介
为 CDS 模型添加字段
使用新增的列构建并部署应用
为 XSUAA 实例创建并显示服务密钥
用相应值填充 HTTP 测试文件并分发变更
6.1. 把服务密钥中的值填入 HTTP 测试文件
6.3. 把 SaaS 后端服务 Url 填入 HTTP 测试文件
6.3. 把消费方子账户的租户 ID 填入 HTTP 测试文件
为租户发送数据库升级请求
7.1. 发送令牌请求
7.2. 升级租户模式
访问租户容器查看变更
1. 前提条件
你已完成本教程的基础版本或高级版本。
你已在 SAP BTP 提供方子账户上拥有一个已部署且正在运行的多租户应用。
你已有一个消费方子账户对你的多租户 SaaS 应用的订阅。
2. 简介
在使用多租户应用的过程中,当你的应用已有活跃订阅的消费方子账户时,你很可能在某个时刻需要更新 CDS 模型。
作为开发者,当你在 CDS 模型中新增或删除字段后,部署之后这些变更不会自动反映到租户的 HDI 容器中。你需要向多租户 CAP 应用发送请求,把最新变更重新部署到租户的 HDI 容器——这就是本节要介绍的内容。
3. 为 CDS 模型添加字段
在本地环境中打开你的 Users 实体,如下所示添加一个 dummy 列。
context susaas.db {
...
@assert.unique : {email : [email]}
entity Users : cuid, managed {
@Core.Computed:true
fullName : String;
firstName : String;
lastName : String;
email : String;
shadowId : UUID;
iasLocation: String;
dummy : String; // new added column
// associations
role : Association to Roles;
}
...
4. 使用新增的列构建并部署应用
在相应的 deploy 目录中构建、(Kyma 场景下)推送并部署你的最新改动。
Kyma
提示 - 下面的命令只是示例。请替换容器镜像前缀;如果你的当前部署包含集中用户管理或 API Management 集成,还需补充相应的 yaml 文件。
## Run in ./code ##
make build
make pack IMAGE_PREFIX=sap-demo
make push-all IMAGE_PREFIX=sap-demo
helm upgrade susaas gen/chart -n mtenant
Cloud Foundry
提示 - 下面的命令只是示例。如果你当前的部署基于基础版本,请修改相应的 mtaext 文件名。
## Run in ./deploy/cf ##
mbt build -e mtaext/free-advanced-private.mtaext
cf deploy mta_archives/susaas-0.0.1.mtar
5. 为 XSUAA 实例创建并显示服务密钥
根据你的部署环境运行下面的命令,获取后续步骤所需的客户端凭据(Client Credentials)。
Kyma
提示 - 请把
占位符替换为你的 Kyma Release 名称,例如 susaas 或 susaas-prod。
kubectl get secret <ReleaseName>-srv-xsuaa -o jsonpath='{.data.clientid}' | base64 --decode | awk '{print "Client-Id: "$1}'
kubectl get secret <ReleaseName>-srv-xsuaa -o jsonpath='{.data.clientsecret}' | base64 --decode | awk '{print "Client-Secret: "$1}'
kubectl get secret <ReleaseName>-srv-xsuaa -o jsonpath='{.data.url}' | base64 --decode | awk '{print "XSUAA-Url: "$1}'
Cloud Foundry
提示 - 请把
占位符替换为你的 Cloud Foundry 空间名称,例如 dev 或 prod。
cf create-service-key <CfSpace>-susaas-uaa susaas-uaa-key
cf service-key <CfSpace>-susaas-uaa susaas-uaa-key
6. 用相应值填充 HTTP 测试文件并分发变更
所需凭据都已创建,现在你可以开始填充变量,并使用 code/test/http 目录中的 tenantUpgrade.http 文件发送请求。
重要 - 你可能想先复制该文件并把文件名改为 tenantUpgrade-private.http,以确保改动不会被误提交到 GitHub。
6.1. 把服务密钥中的值填入 HTTP 测试文件
如下所示,用服务密钥中的凭据替换 HTTP 文件中的占位符。
6.3. 把 SaaS 后端服务 Url 填入 HTTP 测试文件
从 SAP BTP Cockpit 或 Kyma Dashboard 复制 SaaS 后端服务的 Url,填入 http 文件中相应的占位符。
Kyma
Cloud Foundry
6.3. 把消费方子账户的租户 ID 填入 HTTP 测试文件
进入消费方子账户概览页。然后把 Tenant Id 填入 HTTP 文件中相应的占位符。
7. 为租户发送数据库升级请求
租户数据库模型升级所需的全部信息都已填好,我们可以开始发送请求了。
7.1. 发送令牌请求
打开 HTTP 测试文件,如下所示点击发送请求。
##########################################
# Get SAP XSUAA token
##########################################
# @name getXsuaaToken
POST {{xsuaaUrl}}/oauth/token
Accept: application/json
Content-Type: application/x-www-form-urlencoded
Authorization: Basic {{xsuaaClientId}}:{{xsuaaClientSecret}}
?client_id={{xsuaaClientId}}
&client_secret={{xsuaaClientSecret}}
&grant_type=client_credentials
提示 - 如果无法从上面的请求中获取令牌,请仔细检查 HTTP 测试文件中的凭据是否填写正确。
7.2. 升级租户模式
获取令牌后,应向多租户应用发送下面的请求。该请求会部署你的数据库模型的最新版本,其中包含第 1 步中添加的 dummy 列。
################################################
# Call CAP endpoint (BTP) For DB Model Upgrade
################################################
@access_token = {{getXsuaaToken.response.body.$.access_token}}
# @name upgradeTenantDBModel
POST {{srvUrl}}/-/cds/deployment/upgrade
Authorization: Bearer {{access_token}}
Content-type: application/json
{ "tenant": "{{tenantId}}" }
提示 - 请注意,这只会为请求中指定的租户部署新变更。 如果要为多个租户升级租户数据库模型,请把这些租户 ID 也一并通过请求发送。
8. 访问租户容器查看变更
最后一步是按此处所述访问租户容器。你应该会看到 dummy 列已添加到 Users 表中。


















































































