多租户 SaaS 应用(CAP) · 4 · 专家主题(1/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,共收录 6 篇官方文档(README 与 docs)。原仓库内容版权归 SAP SE,遵循其许可证。
使用 @sap/approuter 为 SAP BTP 多租户应用实现基于 Redis 的外部会话管理
简介
@sap/approuter npm 模块是多租户应用在 SAP Business Technology Platform(BTP)上的入口。作为多租户应用不可缺少的组件,@sap/approuter 充当 OAuth2 客户端并负责会话管理。默认情况下它把会话存放在内存中,因此应用重启后会话可能丢失,这种表现尤其令人困扰。本文档介绍如何用 Redis 实现外部会话管理来突破这一限制,确保会话持久无感,并提升可扩展性。
为什么要用 Redis 做外部会话管理?
在 SAP BTP Cloud Foundry 环境中部署应用时,应用实例可能因更新、扩容或维护而重启。由于 @sap/approuter 默认把会话存放在内存中,这会导致会话丢失。使用 Redis 的外部会话管理可以解决该问题:
会话持久性: Redis 支持把会话数据存放到外部,即使在应用重启期间也不会丢失会话。
水平可扩展性: 会话持久化让 @sap/approuter 可以水平扩展。
前提条件
在开始实施之前,请确保满足以下前提条件:
已在 SAP BTP Cloud Foundry 运行时上部署多租户应用。
已添加 Redis Hyperscaler Option 权限(entitlement)。
实施步骤
1. 创建 Redis 实例
使用 Cloud Foundry 命令行接口(CF CLI)创建 Redis 服务实例。把 <instance-name> 替换为你为 Redis 实例准备的名称:
cf create-service redis-cache free <instance-name>
2. 在 @sap/approuter 上配置 Redis 选项
使用 Cloud Foundry 命令行接口(CF CLI)设置 approuter 的环境变量。把 <instance-name> 替换为你为 Redis 实例准备的名称,把 <session-secret> 替换为你准备的密钥。该密钥用于生成会话 cookie,请生成一个至少 64 个字符的唯一字符串。
有关这些参数的详细信息,请参见 npm 文档。
cf set-env <your-approuter> EXT_SESSION_MGT '{
"instanceName": "<instance-name>",
"storageType": "redis",
"sessionSecret": "<session-secret>",
"defaultRetryTimeout": 10000,
"backOffMultiplier": 10
}'
3. 创建服务绑定
把新建的 Redis 实例绑定到 @sap/approuter 应用:
cf bind-service <your-approuter> <instance-name>
设置环境变量并完成绑定之后,需要重新暂存(restage)应用,改动才会生效。
cf restage <your-approuter>
4. 测试
完成上述步骤后,可以用下面的方法测试改动:
打开你的多租户应用。
在应用打开的状态下重启 approuter,并等待它重新启动完成。
approuter 恢复运行后,继续在应用中操作。
此时你可以继续使用应用,因为会话已经存放在 Redis 中,而不再位于内存。
设置 SAP Cloud Transport Management
Kyma ❌
Cloud Foundry ✅
提示 - 本专家功能仍需重构,部分截图与步骤可能已经过时。
在专家功能(Expert Features)的这一部分,你将学习如何设置 SAP Cloud Transport Management 服务,把你的 SaaS 解决方案持续部署到 Test 或 Production 环境等更多的 SAP BTP 子账户。
设置 SAP Cloud Transport Management
简介
设置 SAP Cloud Transport Management
分配用户角色与权限
配置 TMS 传输景观
创建传输目标
使用传输景观向导
连接 CI/CD 管道
Cloud Transport Management 的导入队列
更多信息
1. 简介
当你的应用版本有了以完整归档形式存在的发布候选版本后,你会希望把它推送到 Test 或 Production 子账户。你可以在管道中全自动完成——最好基于持续集成最佳实践或管道模板;如果你希望对生产环境等环节有更多控制,也可以使用标准化的、企业级变更管理流程——即借助我们基于云的 SAP Cloud Transport Management 服务。 要跟随本文档的这一部分操作,你必须添加 SAP Cloud Transport Management 权限,具体说明见此处。
在专家功能接下来的部分,我们将展示如何把 SAP CI/CD 服务与 SAP Cloud Transport Management 服务结合起来,兼取两者之长。
我们可以区分出——
一个开发景观,基于持续集成原则,用于通过自动化管道验证单个开发者的改动,以及
一个交付景观,基于严格的传输管理规则(例如策略、计划与角色),用于验证发布候选版本,向生产环境的推进通常需要人工确认)
前提条件 - 请确保你有三个子账户(Dev、Test、Prod),才能完整执行传输与发布。除 Dev 子账户之外,请创建 Test 与 Prod 子账户,并为它们分配足够的配额来部署应用。作为替代方案,你也可以在同一个子账户中使用三个不同的 Cloud Foundry 空间(Space)来测试。生产场景下建议使用相互独立的子账户。
提示 - 这些子账户不一定位于同一区域。不过,如果你决定使用同一区域,就可以在多个子账户之间共享 SAP HANA Cloud 等特定服务。
2. 设置 SAP Cloud Transport Management
在把两个服务结合起来之前,我们需要先设置好 SAP Cloud Transport Management。下面介绍所需步骤。
2.1. 要订阅 SAP Cloud Transport Management,请在你的 SAP BTP Cockpit 中打开子账户。
2.2. 进入 Services > Service Marketplace。
2.3. 搜索 Cloud Transport Management。
2.4. 选择 Cloud Transport Management 磁贴,选择 (Actions) 并点击 Create。
2.5. 在随后的对话框中,选择 free 计划并点击 Create。
3. 分配用户角色与权限
订阅成功后,你需要配置用户对该订阅的访问权限。你需要为 Cloud Transport Management 的不同角色准备不同的角色集合,并基于应用模板把角色分配给这些角色集合。随后,再把角色集合分配给用户或用户组。
3.1. 为你的 Cloud Transport Management 订阅创建两个角色集合。
TMS Import Operator
TMS Admin
3.2. 要创建新的角色集合,请在子账户中选择 Security > Role Collections。
3.3. 点击 +。
3.4. 为新角色集合输入名称 TMS Import Operator,然后点击 Create。
3.5. 重复前面的步骤,创建 TMS Admin 角色集合。
3.6. 新的角色集合会加入列表。
3.7. 在子账户中选择 Services > Instances and Subscriptions。
3.8. 在 Subscriptions 选项卡中,找到 Cloud Transport Management 行,选择 ... (Actions) 与 Manage Roles。
3.9. 这里会显示默认的角色模板。
3.10. 把 Cloud Transport Management 的角色分配给你刚创建的角色集合。
ImportOperator > TMS Import Operator
Administrator > TMS Admin
3.11. 把新的角色集合(TMS Import Operator 与 TMS Admin)分配给你自己的用户。
4. 配置 TMS 传输景观
在用 SAP Cloud Transport Management 于不同子账户之间传输云应用或应用内容之前,必须先为传输配置好景观。
设置该景观需要执行以下步骤:
创建传输目标
使用传输景观向导
请按下面的步骤配置传输景观。
创建传输目标
在 SAP Cloud Transport Management 中,传输目标(transport destination)用于指定部署过程的目标端点。
4.1. 进入你订阅了 SAP Cloud Transport Management 的子账户。
4.2. 创建两个目标(destination),分别指向 Test 与 Prod 子账户。
重要 - 请确保你在目标中提供的用户是目标子账户 Cloud Foundry 空间中的 Space Developer。
目标 |
URL |
认证方式 |
用户名/密码 |
|---|---|---|---|
TMS-TEST |
https://deploy-service.cfapps.< default-domain >/slprot/< org-test >/< space-test >/slp |
Basic Authentication |
技术用户的用户名与密码 |
TMS-PROD |
https://deploy-service.cfapps.< default-domain >/slprot/< org-prod >/< space-prod >/slp |
Basic Authentication |
技术用户的用户名与密码 |
在下面的截图中,TEST 与 PROD 子账户位于不同区域。只要所需服务在该区域可用,这就是可行的。
提示 - 除了 Basic Authentication,也可以使用 OAuth2Password 认证。更多细节见此处
使用传输景观向导
你可以用传输景观向导为简单的传输景观配置传输节点与传输路由。
4.3. 打开你的 SAP Cloud Transport Management 订阅。
4.4. 启动 Landscape Wizard。
4.5. 选择 Two-Node Landscape (Test and Prod),然后进入下一步。
提示 - 之所以选两个节点,是因为 Dev 子账户属于开发景观,由 CI 负责交付。
4.6. 填写节点详情:
节点 |
名称 |
允许上传 |
转发模式 |
内容类型 |
目标 |
|---|---|---|---|---|---|
Node 1 |
TEST |
true |
Auto |
Multi-Target App |
TMS-TEST |
Node 2 |
PROD |
false |
Auto |
Multi-Target App |
TMS-PROD |
4.7. 为传输路由取名:route_test_prod
4.8. 成功完成该步骤后,你会在 Landscape Visualization 中找到刚定义的节点。
5. 连接 CI/CD 管道
请按下面的步骤把 CI/CD 管道连接到 Cloud Transport Management。
5.1. 首先,创建一个新的 Cloud Transport Management 服务实例,服务计划为 standard。
5.2. 创建一个新的服务密钥,命名为 tms-service-key。
5.3. 查看该服务密钥的凭据并复制其中的 JSON。
5.4. 打开 SAP CI/CD 服务,进入 Credentials 选项卡,为 SAP TMS 创建凭据。
5.5. 点击 +,新建一个凭据值。
5.6. 为凭据值指定名称,例如 "tms"。
5.7. 把 Type 选择为 Service Key。
5.8. 粘贴上一步复制的 JSON,然后创建该凭据值。
5.9. 调整 .pipeline > config.yml 文件,在管道中激活 Upload to TMS。
5.10. 要把构建产物上传到 SAP Cloud Transport Management,请在 Release 阶段添加以下参数。
tmsUpload: true
5.11. 把 steps 段中的以下代码片段注释掉。
tmsUpload:
nodeName: 'TEST'
credentialsId: 'tms'
customDescription: 'TMS Upload'
提示 - nodeName 是 SAP Cloud Transport Management 中定义的 TEST 节点,credentialsId 是 SAP CI/CD 服务凭据库中定义的凭据名称。
5.12. 把管道改动推送到 GitHub。
git add .
git commit -m "Pipeline upload to TMS"
git push
5.13. GitHub 中的改动将触发一次 SAP CI/CD 服务的运行。
6. Cloud Transport Management 的导入队列
当管道完成了所有环节(Build > Test > Deploy to Dev > Upload TMS)后,你可以在 SAP Cloud Transport Management 的 TEST 节点队列中找到构建结果。
6.1. 打开 Cloud Transport Management,切换到 Transport Nodes 并选择 TEST 节点。
6.2. 你会在队列中看到一条名为 TMS Upload 的条目,它就是 SAP CI/CD 服务创建的 mtar 归档。
6.3. 在导入这个传输请求之前,你需要为该阶段提供正确的 MTA Extension Descriptor 文件。为此,请点击屏幕右上角的以下图标。
6.4. 在弹出的窗口中,点击 Add 上传新的 MTA Extension Descriptor(mtaext)文件。
6.5. 点击 Browse 上传当前阶段对应的 mtaext 文件。你可以随意修改描述。点击 Submit new descriptor 完成上传。
重要 - 请确保选择正确的 mtaext 文件,其中包含经过哈希处理的 API Service Broker 凭据(例如 free-tier-private.mtaext)。
6.6. 你会在可用的 MTA Extension Descriptor 列表中看到上传的 mtaext 文件。点击详情图标再次确认你选的是正确的 mtaext 文件。
6.7. 再次检查内容,确认你选的是包含当前阶段经过哈希处理的 API Service Broker 凭据的正确 mtaext 文件。如果确认无误,就可以关闭弹窗并返回节点概览页面。
6.8. 先检查这个传输请求的内容详情,再把改动导入 TEST 节点。
6.9. 选中该传输请求条目,然后按 Import Selected。
6.10. 在批准之后,SAP TMS 会向 TEST 子账户执行部署,并把 mtar 文件转发到 PROD 节点。
6.11. 部署运行期间,你可以查看该传输条目的日志。
提示 - 如果部署过程中出现问题,可以在这个日志中找到失败的详细信息。
6.12. 导入完成后,你会看到应用已部署到你的 TEST 子账户。
6.13. 同样地,你可以从 PROD 节点队列把应用导入到 PROD 子账户。
重要 - 不要忘记也为生产环境提供正确的 mtaext 文件!
到此为止,你已经成功配置了 SAP Cloud Transport Management 服务,并实现了与 SAP CI/CD 服务的集成。这样你就可以用 SAP CI/CD 把项目构建并部署到 Dev 子账户,再用 SAP Cloud Transport Management 这条便捷的传输通道把应用送到 Test 与 Prod 子账户。
7. 更多信息
请使用以下链接查找上述主题的更多信息:
自定义域(Custom Domain)的使用
Kyma ❌
Cloud Foundry ✅
在本任务的这一部分,你将学习如何为 SaaS 应用消费方配置自定义域。自定义域的使用涉及面很广,我们只能覆盖若干示例场景。取决于你作为 SaaS 提供方的需求以及客户的要求,复杂度可能很快上升!
自定义域的使用
简介
SSL 证书
域名的考量
SaaS 应用数量
Dev/Test/……/Production 阶段
多区域部署
基于短横线或点号区分(区域/阶段)
消费方域名
小结
Custom Domain Service
DNS 中的 CNAME 记录
自定义域路由映射
多区域智能路由
更多信息
因此,在专家功能的这一部分,你将学习如何从默认的 cfapps 域(例如 abc-7k7tmze3-susaas.cfapps.eu10...)出发,借助 Custom Domain 服务,先走到基于你自己的自定义域的 SaaS 域(例如 abc-7k7tmze3.susaas.sap-demo.com),再走到面向各消费方的自定义域(例如 abc.susaas.sap-demo.com)。
如果你想用自己拥有的自定义域搭建示例场景,请务必使用本专家功能 files 目录中提供的正确 MTA 扩展描述文件(点击此处)。搜索占位符 <YourDomain>,把它替换为你在 Custom Domain 服务中配置的通配域,如下图所示。
把该文件放到 /deploy/cf/mtaext 目录,并在文件名后加上 -private 后缀。然后按基础功能与高级功能中说明的方式继续构建与部署。
mbt build -e ./mtaext/free-basic-domain-private.mtaext
cf deploy mta_archives/susaas_0.0.1.mtar
1. 简介
我们在基础功能与高级功能中的 SaaS 应用,使用 SAP 在各区域提供的默认 cfapps 域,例如 cfapps.eu10.hana.ondemand.com。在示例场景中,最终得到的消费方子域大致如下:
测试环境:abc-8db8a40e-susaas-test.cfapps.eu10.hana.ondemand.com
生产环境:abc-7k7tmze3-susaas.cfapps.eu10.hana.ondemand.com
由于消费方专属的主机名是基于消费方子账户的子域(例如 abc-7k7tmze3)、应用标识,有时还包括景观(例如 dev 或 test)拼出来的,最终得到的全限定域名(FQDN)并不好看——消费方子账户的子域默认包含一个随机 ID。这个 ID 是在创建新的消费方子账户时保留推荐默认值而生成的。
重要 - 我们不建议在创建新的消费方子账户时修改自动生成的子域,因为子域在整个区域范围内是唯一的(会被占用)!这种做法在某些场景下也许可行,但例如在尝试为知名公司名创建子账户子域时会遇到问题,因为这些子域可能早已被占用!
不要这样做!
请改为这样做!
那么,怎样才能改进上面的设置,得到企业级方案——消费方子域完全灵活,并基于提供方拥有的自定义域(例如 susaas.com 或 susaas.sap-demo.com)?这正是你在专家功能这一部分将要学到的内容。
重要 - SAP Custom Domain 服务只能作为付费计划添加在 PAYG 或 CPEA 账户中。请先查看相应定价详情(点击此处),然后再在 SAP BTP 账户中添加并使用该服务。
2. SSL 证书
虽然服务名称读起来不太一样,但 Custom Domain 服务是按激活的 SSL 证书数量收费的。一张 SSL 证书可以为多个域或子域的流量提供保护。因此,在设置 Custom Domain 服务实例之前,请先用你惯用的搜索引擎了解一些 SSL 证书的背景知识。这可能会帮你省下一大笔钱!
在 SAP BTP 上做 SaaS 解决方案时,作为 SaaS 提供方,你应当尽量用最少数量的 SSL 证书满足自定义域的需求。尤其是多域证书或 SAN 证书,在很多场景下都很有用。
下面可以看到为单个或多个(通配)域签发的几类 SSL 证书示例。
单域 SSL 证书
为单个专用域或子域启用安全连接。
通配 SSL 证书
为某个专用域下任意数量的子域启用安全连接。它不为该域本身提供保护。
*.susaas.com
提示 - 仅支持同一层级的子域。要为下一层级的子域提供保护,需要一张新证书。例如 *.eu.susaas.com 就需要新的通配证书。
多域 SSL 证书
为多个专用域启用安全连接,也称为 SAN 证书。不能包含通配子域。
多域通配 SSL 证书
为任意数量的子域启用安全连接,也称为 SAN 通配证书。
*.susaas.com
*.eu.susaas.com
*.us.susaas.com
提示 - 请记住:通配证书只保护同一层级的所有子域,而不覆盖更低层级。例如 **.dev.eu.susaas.com 就需要*一张新证书。
更多多域 SSL 证书选项
多域证书中也可以组合多个子域与专用域。
susaas.com
*.susaas.com
*.eu.susaas.com
*.dev.eu.susaas.com
取决于你的需求,SSL 证书的费用可能很快上升:单域 SSL 证书是最便宜的选择,多域 SSL 证书最贵但功能最强。请务必弄清自己在开发、测试与生产景观中对自定义域的要求。此外,在不同区域提供解决方案时,你可能还需要更多子域与证书。
所以归根到底,需要你自己根据成本与预期投入来核算并决定方案。
3. 域名的考量
在 SaaS 场景中使用自定义域时,有几件事需要考虑。下面列出了其中最重要的几个方面。请务必根据自身需求选择正确的设置,因为后期调整可能导致现有消费方遇到意料之外的 URL 变更。另外请记住,下面的考量并不彼此独立。根据你的景观情况,你很可能会落到它们的某种组合上。
提示 - 对大多数场景而言,基于短横线的区分看上去更省钱,但请务必清楚它的副作用。尤其是消费方数量很多时,相比使用基于点号的区分,DNS 维护的工作量不容小觑。
SaaS 应用数量
所需证书数量取决于你想在景观中使用的 SaaS 应用数量。假设你的子账户中只有一个 SaaS 应用:
*.app.com
这样就只需要一张 SSL 通配证书。那如果有三个不同的 SaaS 应用呢?
*.123.app.com或*.123-app.com*.456.app.com或*.456-app.com*.789.app.com或*.789-app.com
这时你突然需要三张通配 SSL 证书,或者一张包含所有这些域的 SAN 证书。因此你需要考虑将来在提供方子账户中可能部署多少个应用,并决定如何在域这一层面区分它们。
提示 - 用短横线作为应用分隔符可能更省钱,但会增加你这边的工作量。这种情况下,一张 *.app.com 的证书就够了,但 DNS 侧的维护工作量会上升!此外(截至目前)只有当你为每个 SaaS 应用给消费方分配独立子账户时,这种做法才可行。
*-123.app.com
*-456.app.com
*-789.app.com
像 *-123.app.com 这样把所有消费方都指向 123 应用的通配 CNAME 是不可用的!在基于短横线区分的情况下,每个消费方都需要自己的 CNAME 记录。更多细节见下文。
Dev/Test/……/Production 阶段
取决于你的设置,景观中至少需要两个阶段:开发与生产。更好的做法是三层景观,额外包含一个测试阶段。不建议直接在生产环境中部署和修改应用。那么,从 SSL 证书的角度看这意味着什么?我们来看一个三阶段的场景。
当然,你可以为这些阶段使用不同的域或子域:
*.dev.susaas.com或*.dev-susaas.com(开发)*.test.susaas.com或*.test-susaas.com(测试)*.susaas.com(生产)
也就是说,需要三张通配 SSL 证书,或者一张包含这三个通配域的 SAN 证书。所以从 SSL 证书角度看,这种做法成本较高。更便宜的替代方案如下:
*-susaas-dev.cfapps.eu10.hana.ondemand.com(开发)
*-susaas-test.cfapps.eu10.hana.ondemand.com(测试)
*.susaas.com(生产)
可以看到,对于开发与测试阶段,你直接沿用默认的 *.cfapps 域即可,任何 SAP BTP 客户都可以免费使用。你唯一要做的事情是确保主机名中带有应用与景观标识。只有生产环境才使用漂亮的域名,这样最终只需要一张 *.susaas.com 的 SSL 通配证书。
两个阶段的示例设置
当然,如果你的某个客户想要一个测试账户,URL 对他们来说既不漂亮也不易理解。如果你希望做到这一点,而消费方又无法接受默认的 cfapps 域,可以考虑下面的设置:
*-susaas-dev.cfapps.eu10.hana.ondemand.com(开发)
*.test.susaas.com(测试)或 *.test-susaas.com(测试)
*.susaas.com(生产)
这样至少能为开发景观省下一张通配证书,最终只需要两张通配 SSL 证书。顺便说一句,下面的设置不可行也不推荐!
提示 - 下面示例中 xyz 代表一个客户
xyz.susaas.dev.cfapps.eu10.hana.ondemand.com
不可行,因为无法为默认的 cfapps 域创建更多通配子域,只有 SAP 才能创建额外子域。使用 cfapps 域时,你必须用短横线分隔消费方、阶段与应用。*xyz-dev.cfapps.eu10.hana.ondemand.com
不推荐,因为某个区域内的路由是唯一的!你将来可能还想在子账户中为多个应用创建路由。使用默认域时请始终包含应用分隔符,这样相同的消费方才能订阅同一提供方的多个应用。*xyz-susaas.cfapps.eu10.hana.ondemand.com
不推荐,因为某个区域内的路由是唯一的!这种情况下你将无法为多个阶段(dev、test)创建路由!使用默认域时请始终包含阶段分隔符!唯一的例外——当生产景观也使用默认 cfapps 域时,可以省略阶段分隔符。
所以,请想清楚!你的景观要使用几个阶段,其中哪些阶段用默认 cfapps 域、哪些用自定义域?不要忘记,每张通配 SSL 证书都会额外花钱。
提示 - 同样地,用短横线作为阶段分隔符可能更省钱,但会增加你这边的工作量。这种情况下,一张 *.susaas.com 的证书就够了,但 DNS 侧的维护工作量会上升!对于 dev 与 test 阶段,你需要手动创建所有 DNS CNAME 记录。此外,这种设置只适用于为每个阶段使用独立子账户的情况。
*-dev.susaas.com
*-test.susaas.com
*.susaas.com
像 *-dev.susaas.com 这样指向开发阶段的通配 CNAME 是不可用的!在基于短横线区分阶段的情况下,每个客户都需要自己的 CNAME 记录。更多细节见下文。
多区域部署
如果你决定在全球多个区域运行应用,就必须理解这会对自定义域的需求产生影响。虽然自定义域可以在同一区域(同一 SAP BTP 全球账户下)的子账户之间轻松共享,但不能跨区域共享(例如从 eu10 到 us20)。
假设你的应用要在三个不同区域运行:
*.eu10.susaas.com*.us10.susaas.com*.ap20.susaas.com
如果你想用点号分隔区域域,那就意味着这个场景需要三张通配证书。此外,SAP 会在每个区域分别对自定义域收费。
提示 - 再说一次,用短横线作为阶段分隔符可能更省钱,但会增加你这边的工作量。这种情况下,一张 *.susaas.com 的证书就够了,但 DNS 侧的维护工作量会上升!所有 CNAME 记录都必须手动维护。
*-eu10.susaas.com
*-us10.susaas.com
*-ap20.susaas.com
像 *-eu10.susaas.com 这样指向 eu10 景观的通配 CNAME 是不可用的!在基于短横线区分的情况下,每个消费方在每个景观中都需要自己的 CNAME 记录。更多细节见下文。
基于短横线或点号区分(区域/阶段)
消费方域名的格式极大地影响所需的 SSL 证书数量。为了节省 SSL 证书成本,用短横线而不是独立的(子)子域来分隔区域或景观通常很有用。请查看下面的示例,了解如何用短横线与单张通配证书替代子域,从而减少所需的通配证书数量。
重要 - 请记住,SSL 证书的成本与 Custom Domain 服务的成本是两件完全不同的事。一张通配证书也许足以覆盖你所有的区域,但你可能需要在各个区域购买多个 Custom Domain 服务实例。
3 张通配证书 |
1 张通配证书 |
|---|---|
<consumer>.susaas.com |
<consumer>.susaas.com |
*.susaas.com |
*.susaas.com |
3 张通配证书 |
1 张通配证书 |
|---|---|
<consumer>.eu.susaas.com |
<consumer>-eu.susaas.com |
*.eu.susaas.com |
*.susaas.com |
从提供方的角度看,用子域而不是短横线来分隔阶段或区域会降低维护工作量,但会增加所需通配 SSL 证书的成本。再给你一个示例。假设你把 SaaS 应用部署到 eu10 与 us20 区域,示例消费方 ABC 与 XYZ 在两个区域都订阅了该应用。
场景 1 - 用子域分隔区域
eu10 区域 - abc.eu10.susaas.com
eu10 区域 - xyz.eu10.susaas.com
us20 区域 - abc.us20.susaas.com
us20 区域 - xyz.us20.susaas.com
DNS 中的 CNAME 记录
*.eu10.susaas.com 解析到 api.cf.eu10.hana.ondemand.com
*.us20.susaas.com 解析到 api.cf.us20.hana.ondemand.com
设置简单,只需要两条指向不同区域的 CNAME 记录。略微贵一些,因为需要两张通配证书,但非常灵活,这两条 CNAME 就能覆盖两个区域内的所有消费方。
基于子域区分区域的示例设置
场景 2 - 用短横线分隔区域
eu10 区域 - abc-eu10.susaas.com
eu10 区域 - xyz-eu10.susaas.com
us20 区域 - abc-us20.susaas.com
us20 区域 - xyz-us20.susaas.com
DNS 中的 CNAME 记录
设置更复杂,需要同时针对区域与消费方的 CNAME 记录,把不同区域的消费方分别指向对应区域。更便宜,因为只需要一张通配 SSL 证书,但每个多区域消费方都会带来额外的工作量!
基于短横线区分区域的示例设置
场景 1 与场景 2 对比
在用短横线区分区域的场景中,你无法在 DNS 区域中使用通配 CNAME 记录,只能手动维护所有消费方的 CNAME。该过程可以用你所用 DNS 提供方的 API 自动化,但相比使用通配记录,工作量仍然更大。另一方面,你可以省下为每个区域额外购买 SSL 通配证书的费用。
重要 - 如果你还想为某个区域再加一个测试阶段,例如 abc-test-eu10.susaas.com 或 abc.test.eu10.susaas.com,那么两种场景中的 CNAME 数量都会翻倍。也就是说,你要么得为四张证书付费,要么得维护 8 条 CNAME 记录。
总而言之,这些设置选项并不简单,还取决于你愿意在维护 CNAME 记录上投入多少精力,以及愿意为通配 SSL 证书花多少钱。好了,准备好迎接最后的困惑与一点点精妙之处了吗?继续读专家场景!
专家场景 - 点号分隔
你还可以把区域子域方案(例如 eu10.susaas.com)与域根级别上的额外通配域(例如 susaas.com)结合起来。这对那些不希望域名中暴露区域、又期望在所有区域之间拥有单一入口的消费方尤其有用。
eu10 区域 - abc.eu10.susaas.com
解析到 abc.susaas.comus20 区域 - abc.us20.susaas.com
解析到 abc.susaas.com
用同一个域名(例如 abc.susaas.com)让消费方的租户在不同区域可用,可以让你作为 SaaS 提供方实现智能路由机制。你可以把来自美国的用户路由到 us20 区域,而把欧洲用户路由到 eu10 区域。这一切在最终用户毫无察觉的情况下发生。用户通过 abc.susaas.com 访问应用,智能路由在后台完成。当然,如果他们想访问某个特定区域,也随时可以调用该区域专属的 URL。
这种设置需要多花一些精力,因为要在 SAP BTP 侧为每个消费方创建两个所谓的路由映射(route mapping),同时你还需要定义一个智能路由方案,例如基于你选择的一家超大规模云厂商(Azure、AWS 等)。
基于子域区分区域的专家示例设置
专家场景 - 短横线分隔
在基于短横线的方案中,上述智能路由场景无需额外证书即可实现,因为无论如何你都只使用一张覆盖 *.susaas.com 的证书。
从工作量角度看,这种设置同样需要在 SAP BTP 侧为每个消费方创建两个路由映射,并且要在你的超大规模云厂商景观中定义智能路由方案。
eu10 区域 - abc-eu10.susaas.com
解析到 abc.susaas.comus20 区域 - abc-us20.susaas.com
解析到 abc.susaas.com
基于短横线区分区域的专家示例设置
消费方域名
使用消费方自己的域(例如 abc.com),让用户通过比如 susaas.abc.com 而不是 abc.susaas.com 访问你的 SaaS 应用,也是可行的,但不推荐。
如果你想实现这种设置,需要在提供方子账户中创建新的自定义域,例如 susaas.abc.com,并向消费方发送证书签名请求(CSR)。消费方需要用受信任的证书颁发机构为该 CSR 签名,然后发回给你!之后你就可以为消费方激活证书,并把它映射到其默认域。虽然技术上可行,但一旦向消费方提供这个选项,你迟早会遇到问题。
这些问题大概会从必需的证书轮换开始,因为证书有固定的有效期。一两个消费方你还能应付,但一百个消费方的工作量就非常可观了。你需要为每个消费方反复创建 CSR,并且必须确保及时上传新签发的证书!从成本角度也是同样,每张新证书都会在 SAP BTP 侧产生费用,而你需要把这笔费用转嫁给消费方。
遗憾的是,截至目前,消费方还无法把自己的自定义域(可能已注册在其他全球账户的 SAP BTP 子账户中)与作为 SaaS 提供方的你共享。这有安全方面的原因,而且短期内也看不到会提供解决方案。
小结
好了,哇,要消化的内容真不少。如果现在你脑中的问号比答案多,不必担心。自定义域本身就不是一个简单的主题。把刚读过的这一章再翻一遍,事情可能会清晰起来。如果仍有疑问,欢迎随时联系我们!那么现在,让我们继续学习如何在提供方子账户中设置 Custom Domain 服务实例。
4. Custom Domain Service
好,现在我们开始在提供方子账户中设置 Custom Domain 服务。请记住——Custom Domain Service 是纯付费服务。该服务没有 Free (Tier) 计划,也无法在 Trial 账户中使用。
重要 - 请根据你的 SAP BTP 账户类型(CPEA 或 PAYG),在 SAP Discovery Center 中查看最新的服务定价(点击此处)。
也欢迎查阅 SAP Help 官方文档(点击此处),其中也详细描述了下面的流程。
4.1. 要在 SAP BTP 提供方子账户中设置自定义域,请在 SAP BTP Cockpit 中添加相应的权限。请务必使用 standard (Application) 计划,因为 custom_domains 计划已弃用,未来不会再有更新。
4.2. 把权限添加到子账户后,请使用 standard 服务计划订阅 Custom Domain Service。
4.3. 订阅之后,你会在 SAP BTP 子账户的 Instances and Subscriptions 区域看到该订阅。使用之前,请务必创建并分配所需的角色集合。
4.4. 请确保为你的 SAP BTP 子账户管理员分配订阅 Custom Domain Service 成功后新增的角色集合。
4.5. 分配新的角色集合后,请在新的浏览器标签页中打开你刚创建的 Custom Domain Service 订阅。应用加载完成后,点击 Domains。
4.6. 在接下来的窗口中,你可以在当前区域(例如 eu10)预留你的自定义域。这样可以确保其他 SAP BTP 客户无法使用该域或相关子域。因此请点击 Add Reserved Domain。
4.7. 填写你想为 SaaS 应用使用的自定义域。既可以提供一个域(例如 susaas.com),也可以提供你自己选择的专用子域(例如 susaas.apps.com)。如果你提供的是一个域(例如 susaas.com),下一步仍然可以添加自定义子域(例如 eu10.susaas.com)。点击 Add。
重要 - 你应当是该域或子域的 DNS 所有者!
4.8. 切换到 Custom Domain 选项卡,点击 Create Custom Domain。
4.8. 选择 for your Subaccount's CF Organization,这样就可以为基于 Cloud Foundry 的应用设置自定义域。
4.9. 你会看到该自定义域是为哪个 Cloud Foundry 景观创建的。该自定义域只能在这个景观中使用。请点击 Next。
4.10. 选择你刚添加到 Reserved Domains 的域,然后点击 Next。
4.11. 如有需要,你可以在预留域下定义子域,例如 eu10.susaas.com。我们的示例中未做这一步。点击 Finish。
4.12. 回到 Custom Domain Service 主菜单,点击 TLS Configuration。在下面的页面中,请点击 Create TLS Configuration。
4.13. 为新的 TLS 配置指定名称,例如 susaas。点击 Next Step。
4.14. 客户端认证(mTLS)只能在配置创建完成并上传 CA 证书之后启用。现在请先点击 Next Step。
4.15. 点击 Finish 完成流程。
4.16. 你会看到新建的 TLS 配置,它当前还处于未使用状态,因为到目前为止我们还没有提供有效的 SSL 证书。
4.17. 回到 Custom Domain Service 主菜单,点击 Server Certificates。在下面的页面中,请点击 Create Server Certificate。
4.18. 选择 for your (wildcard) Custom Domains 选项。
4.19. 为新的服务器证书提供一个别名,例如 susaas。如有需要,可以修改密钥长度(Key Size)。点击 Next Step。
4.20. 选择你的区域,然后点击 Next Step。
4.21. 在 Subject Alternative Names 中,请选择你在前面几步创建的通配(子)域(例如 *.susaas.com),然后点击 Next Step。
提示 - 只有当你打算把这张证书同时用于通配子域与全限定域名(FQDN)时,才在这里选择 FQDN(例如 susaas.com)。
重要 - 如果你计划在同一区域使用 Dev、Test 等多个阶段,请先创建相应的通配自定义域(例如 *. dev.susaas.com),然后也把这些子域选为 Subject Alternative Names。这样你只需为一个 Custom Domain Service 实例付费,却可以使用多个通配子域。
4.22. 在 CommonName (CN) 中,使用你前面几步创建的通配(子)域(例如 *.susaas.com)。填写其余信息后点击 Finish。
提示 - 如果点击 Finish 时遇到错误,只填写必填字段(CN)后重试。
4.23. 你会看到服务器证书的别名已创建,并且已经生成了证书签名请求(CSR)。
4.24. 选中新建的别名,向下滚动并点击 Get Certificate Signing Request 按钮。
4.25. 在弹窗中复制完整的 CSR 内容,保存到本地设备的文件中,然后发送给你选用的 SSL 证书提供方。
4.26. 当你的证书由 SSL 证书提供方签名后,你会得到完整的证书链。该证书链包含已签名的服务器证书、一张或多张中间证书,以及一张根证书。
4.27. 点击 Upload full Certificate Chain。
4.28. 粘贴你从 SSL 证书提供方收到的证书链,然后点击 Next Step。
4.29. 如果证书链正确,你会看到证书详情的概览。确认一切正确后点击 Next Step,并确认上传证书。
提示 - 如果遇到错误信息,很可能是证书链不完整。请在设备上手动打开证书,检查完整证书链是否包含根证书、中间证书与你的服务器证书。
4.30. 证书上传成功后,你会看到 Server Certificate 的状态变为 inactive。
4.31. 要激活服务器证书,请在列表中选择该条目,并在相应的设置中点击 Activate。
4.32. 服务器证书激活后,就可以用于在 Cloud Foundry 环境中为应用设置自定义域。
重要 - 如前所述,你可以申请包含多个主题备用名称(SAN)的 SSL 证书。如果你把 *.abc.com 与 *.xyz.com,或 *.dev.abc.com 与 *.test.abc.com 等多个域纳入服务器证书,就可以把同一张证书用于所有这些域。
4.33. 现在虽然可以用自定义域在 Cloud Foundry 中设置路由,但这些路由还无法从公网访问。
4.34. 要让新的自定义域路由可以从公网访问,请继续阅读下一章,在你的 DNS 区域中创建所需的 CNAME 记录。
5. DNS 中的 CNAME 记录
在用配置好的自定义域访问 Cloud Foundry 应用之前,你需要在域的 DNS 设置中设置相应的 CNAME 记录。下面是一个多区域部署场景的示例,其中每个区域使用独立的子域。为此,在 sap-demo.com 域的 DNS 设置(这里是 Microsoft Azure DNS 区域)中又创建了两条通配 CNAME 记录。
提示 - 也请查阅 SAP Help 官方文档(点击此处),其中有关于设置所需 CNAME 记录的更多信息。
*.eu.susaas.sap-demo.com 解析到 api.cf.eu10.hana.ondemand.com
*.us.susaas.sap-demo.com 解析到 api.cf.us10.hana.ondemand.com
这些 CNAME 记录会让通过区域专属域访问其 SaaS 应用的消费方,根据其使用的 URL 被指向正确的 Cloud Foundry API 端点。随后 Cloud Foundry 会根据你在 SAP BTP 环境中定义的路由确保正确的路由。如果不在域的 DNS 中创建 CNAME 记录,你就无法从公网访问 Cloud Foundry 环境中的自定义域路由。
abc.eu.susaas.sap-demo.com 解析到 EU10 区域
xyz.us.susaas.sap-demo.com 解析到 US10 区域
附加信息
除了设置通配 CNAME 记录,你也可以为每个消费方设置专用的 CNAME 记录。当你使用基于短横线的区域区分方式时,这是必须的步骤。形如 *-eu.susaas.sap-demo.com 的带短横线的通配 CNAME 却无法使用!所以如果你决定用短横线来节省 SSL 证书,请务必正确设置 CNAME 记录。
abc-eu.susaas.sap-demo.com 解析到 api.cf.eu10.hana.ondemand.com
xyz-us.susaas.sap-demo.com 解析到 api.cf.us10.hana.ondemand.com
结论
一旦创建了指向你所在区域 Cloud Foundry API 端点的 CNAME 记录,消费方就可以用你在 SAP BTP 环境中为其指定的路由访问各自的租户。
好,到目前为止消费方已经可以通过 abc-7k7tmze3.susaas.com 访问其租户。但怎样才能让域名更好看一些,最终变成 abc.susaas.com?这正是所谓的路由映射(Route Mapping)功能的用武之地。
6. 自定义域路由映射
Custom Domain Route Mapping 功能允许你把现有的 SaaS 应用路由映射到基于可用自定义域的任意路由。在深入细节之前,我们先看几个示例:
生产路由映射
景观路由映射
区域路由映射
消费方域
如你所见,基于消费方子账户子域创建的默认主机名,可以替换为与你的任意自定义域组合而成的更合适的主机名。在使用该功能之前,请务必阅读下面的重要信息。
重要信息
使用路由映射时特别重要的一点是:原始主机名只能包含消费方子账户的子域。系统会检查是否存在具有相应子域的子账户。如果你把应用名或阶段包含在消费方的 SaaS URL 中(例如 xyz-7k7tmze3-susaas 或 xyz-7k7tmze3-dev),就无法使用路由映射功能!
示例 - 例如,如果消费方 xyz 的子账户子域是 xyz-7k7tmze3,那么你想映射的默认 SaaS 路由也必须是 xyz-7k7tmze3.(eu10.)susaas.com。只有这样才有可能映射到 xyz.(eu10.)susaas.com。因此,请确保在租户开通(provisioning)期间返回正确的默认路由。
路由映射功能只能在特殊情况下配合默认的 cfapps 域使用。由于无法为 cfapps 域创建子域,通常必须用短横线把阶段与应用名包含在主机名中(例如 xyz-7k7tmze3-susaas-dev.cfapps.hana....)。
这会导致无法使用路由映射功能,因为系统无法确定具有匹配子域的子账户!
示例 - 如果消费方 xyz 最终得到的 SaaS 域是 xyz-7k7tmze3-susaas-dev.cfapps.hana.ondemand.com,而消费方 xyz 的子账户子域是 xyz-7k7tmze3,那么就无法完成映射!
要让这种映射成为可能,唯一的方法是分别为每个应用、阶段与客户创建具有相应子账户子域的不同子账户(例如 xyz-7k7tmze3-susaas-dev),而这相当繁琐。
6.1. 首先确定你要为其创建路由映射的消费方租户的 Tenant ID。你可以在提供方子账户的 Subscription Management Dashboard 中找到该 ID。记下这个 ID 备用。
6.2. 要允许为消费方子账户做自定义域路由映射,首先需要在那个消费方子账户中启用 Cloud Foundry 环境。请在 SAP BTP Cockpit 中打开消费方子账户,然后点击 Enable Cloud Foundry。
6.3. 如有需要,调整默认设置,然后点击 Create。
6.4. 回到提供方子账户,从 Instances and Subscriptions 区域打开 Custom Domain Service。在菜单中点击 SaaS Routes。
6.5. 在下面的页面中,请点击 Create Custom Route。
6.6. 取消勾选 Continue with current subaccount's list of subscriptions 复选框,并填写你在前面几步记下的消费方 Tenant ID。点击 Next Step。
6.7. 选择你要为其设置路由映射的消费方子账户的 SaaS 订阅。点击 Next Step。
提示 - 如果出现的不是下面的页面而是错误信息,请确认你已在消费方子账户中启用 Cloud Foundry!
6.8. 不要修改基于消费方子账户子域的标准路由,点击 Next Step。
提示 - 在这个例子中,子账户子域是 ...subscriber-prod-uhm5gyoy。
6.9. 选择你想用于该路由映射的自定义域。点击 Next Step。
6.10. 定义路由映射的新主机名。现在你可以用合适的主机名替代基于 GUID 的子账户子域。点击 Finish 创建路由映射。
6.11. 要让映射在 Cloud Foundry 中生效,需要同步改动。请切换到主菜单并点击 Domains 磁贴。
6.12. 选择 Custom Domains 选项卡,点击 Cloud Foundry Sync。
6.13. 等待确认消息弹出。
6.14. 现在你应该可以用路由映射中指定的简化域访问消费方的 SaaS 实例了。
就是这样!你的消费方现在可以用合适的自定义域访问各自的 SaaS 租户了。
7. 多区域智能路由
作为本教程的收尾,我们简要介绍如何用 Azure Traffic Manager 搭建多区域智能路由方案。假设一个消费方 subscriber 在两个不同区域 eu10 与 eu20 中被创建。对这个消费方,需要如下智能路由逻辑。
不同区域中该消费方专属的 SaaS 应用租户应可通过区域专属域访问:
subscriber.eu10.sap-demo.com -> EU10
subscriber.eu20.sap-demo.com -> EU20
一个与区域无关的域应优先把用户路由到 eu10 区域,仅在故障转移时路由到 eu20 区域:
主(Primary)-> EU10
备(Secondary)-> EU20
在 eu10 区域的 Custom Domain Service 中,已为消费方 subscriber 定义了两个相应的路由映射。
在 eu20 区域的 Custom Domain Service 中,也为消费方 subscriber 定义了两个类似的路由映射。
在 Microsoft Azure 中,已定义了一个 Traffic Manager 配置文件,其中包含 eu10 与 eu20 两个端点。
该 Traffic Manager 配置采用了优先级路由(Priority routing),允许你为目标端点定义优先级。
eu10 区域的目标端点被赋予值 1,而 eu20 区域的值为 2。如有需要,你还可以添加更多端点。
该场景定义了三条 DNS 记录:两条通配 CNAME 记录分别用于访问区域专属的消费方域(*.eu10.susaas.sap-demo.com 与 .eu20.susaas.sap-demo.com),一条通配记录指向 Azure Traffic Manager(.susaas.sap-demo.com)。
提示 - 更具体的 CNAME 会先于通用 CNAME 被匹配。如果用户尝试打开 subscriber.eu10.susaas.sap-demo.com,*.eu10.susaas.sap-demo.com 这条 CNAME 会先于 *.susaas.sap-demo.com 匹配。
消费方 subscriber 的用户现在既可以用区域专属子域访问应用,也可以用与区域无关的子域访问。
消费方域
为让画面完整,下面是一张示例截图:默认的 SaaS 路由被映射到消费方的专用子域(例如 susaas.sap.com)。如相应章节所述,这种做法可行但不推荐。
8. 更多信息
请使用以下链接查找上述主题的更多信息:
部署到多个 SAP BTP 区域
Kyma ❌
Cloud Foundry ✅
专家功能的这一部分将面向计划把解决方案部署到多个 SAP BTP 区域的 SaaS 提供方给出高层概览,包括智能流量路由的选项。在多个 SAP BTP 区域提供 SaaS 应用有诸多好处,我们将在下面简要讨论。
简介
多区域场景
示例场景
自定义域
更多信息
本章刻意写得比较简短,欢迎在此处给我们反馈。多区域场景这个话题足以写成书,网上也有大量资料。因此我们乐于听取你的意见:在 SAP BTP 的多区域场景中,哪个主题对你特别重要。欢迎联系我们,我们会尽力完善文档。
1. 简介
SAP Business Technology Platform 允许你用同一个 SAP BTP 全球账户,把解决方案部署到 SAP 管理的数据中心以及四家不同的超大规模云厂商(AWS、Azure、Google、Alicloud)。这本身已是很大的优势,因为你不必与这些厂商分别签订企业合同,同时还能享受出色的区域可用性。有四家超大规模云厂商可选,你的 SAP BTP 解决方案可以部署在全球各地,从澳大利亚到亚洲、欧洲,再到北美甚至南美。
我们来总结一下把解决方案部署到多个 SAP BTP 区域的主要优势:
多区域部署让你可以在区域宕机或更新时建立故障转移方案
多区域部署为应用的区域用户提供更低的延迟
多区域部署有助于你在某个区域扩大本地用户群
多区域部署保证符合当地监管要求与隐私法
下面我们将给出一些在开始自己的场景之前应当考虑的想法与思路,并展示一个多区域部署的示例设置。
2. 多区域场景
在 Cloud Foundry 场景中把现有应用部署到另一个区域相当简单(创建子账户 > 分配权限 > 部署解决方案),但在全球多个区域提供解决方案之前,还有一些方面需要考虑。我们只简要提几点。
成本与收益
在多个区域托管解决方案会带来更高的成本。这不仅体现在平台或服务消费上,也体现在维护上。你应当深入核算投入能否在不久的将来带来成比例的回报。请考虑成本视角涵盖多个方面:部署到额外区域可能增加平台成本,但也能让应用在故障转移场景下更具韧性。违反你对自己客户承诺的 SLA,代价很可能高于潜在故障转移区域的额外平台成本。
多区域场景
多区域并不总是满足需求的最佳选择。请明确你的多区域场景以及可能更简单、更省钱的替代方案。对于应用更新,可以考虑使用蓝绿部署方案,而不是在更新期间把流量路由到次要区域。
在增设区域之前,请确保你完全理解应用各层现有的可扩展性与故障转移选项(例如使用 Autoscaler 服务,或在多个可用区中使用 SAP HANA Cloud)。此外,也可以考虑只在需要时开通额外区域,或者在不使用时停止昂贵的区域资源。
用户群位置
你应当把 SaaS 应用的第一个实例部署在离多数用户群最近的区域。这样可以降低应用用户的延迟。如果你预计初期用户主要在欧洲,就应选择欧洲区域。如果应用上线成功,并且你看到大量来自美国用户的流量,那么在美洲区域再启动一个应用实例可能是合理的。
监管要求
如果你的应用存储的数据受政府法规或数据隐私法约束,你可能必须固定在特定区域,以确保数据不离开该区域,或只能从该区域内访问。
超大规模云厂商亲和性
借助 SAP Private Link 等新服务,Azure、AWS 等超大规模云厂商与 SAP BTP 的服务产品比以往更加贴近。如果你熟悉 Amazon AWS 或 Microsoft Azure,选择这些景观中的区域可能更合理,这样就能利用你的知识与既有开发成果来增强 SAP BTP 解决方案。
各区域的服务供给
并非所有 SAP BTP 服务在每个区域、每家超大规模云厂商都可用。请确保你选择的区域提供(SaaS)应用所需的全部服务。如果没有,就需要切换到附近的其他区域或其他超大规模云厂商。服务可用性的详细信息见 SAP Discovery Center。
除了在多个区域提供应用的优势之外,也要注意这类设置带来的复杂性与挑战。下面的清单并不穷尽,但可以让你了解在实施过程中还应考虑哪些方面。
多个服务实例
在额外区域启动应用时,你需要复制所有需要的服务。这会带来额外成本与更高的维护工作量。请确保你清楚自己使用的服务与服务计划。例如,一个拥有 10,000 名应用用户的区域,可能比只有 1,000 名用户的区域需要更大的数据库层。尤其是 SAP HANA Cloud 或 Custom Domain Service 这类昂贵的服务,在多个区域使用会提高你的 TCO。
开发、测试与维护
多个区域会让整个 DevOps 循环的工作量上升。从应用开发、搭建合适的管道、编写与监控各区域的测试,到在不同地点维护应用各层,都是如此。
这包括备份、更新、热修复等。此外,用户管理、凭据轮换以及更多工作都会随着每增加一个区域而占用你的精力。请确保你有足够的知识与资源来为多个区域开发和进行管理。
每个区域的阶段
从部署角度看,把应用部署到不同区域甚至不同超大规模云厂商可能很简单,但细节决定成败。不同区域和/或超大规模云厂商可能使用不同的技术栈,因此不能假定在一个区域部署成功,就意味着在另一个区域也能可靠部署。
因此,你也应当为各个区域准备测试阶段,先把最新改动放在那里验证,再应用到生产景观。这当然又会增加所需服务的数量。你可以考虑在同一区域的多个子账户之间共享昂贵的资源。
持久化方面的考量
虽然多区域部署可用于支持故障转移场景,但请确保你的应用适合这类场景。SAP HANA Cloud 支持多个可用区(在某个区域内),但尚不支持多区域场景。如果你的应用依赖用户存放在某个特定区域的数据,这些用户大概会欢迎故障转移到其他区域,但如果他们的数据在另一个区域不可用,可能就会感到沮丧。
如果你对使用 AWS(例如 Aurora DB)或 Azure(例如 Cosmos DB)等超大规模云厂商的全球分布式持久化选项实现高可用模式感兴趣,可以看看以下博客:
虽然这些方案对独立的 CAP 应用是不错的选择,但 CAP 的 PostgreSQL 支持仍然有限,且主要靠社区驱动。尤其是在 CAP 场景的 SaaS 应用(需要用容器实现租户隔离)中,SAP HANA Cloud 才是首选数据库。
提示 - 请查看 SAP HANA Cloud 最新的路线图详情,了解多区域支持的最新动态。
智能路由方案
基于区域可用性、用户位置或延迟的智能路由方案,需要借助 Amazon AWS(Route 53)或 Microsoft Azure(Traffic Manager)等超大规模云厂商提供的额外服务。这类 DNS 路由服务不属于 SAP BTP 的服务组合,你需要向上述基础设施即服务提供方之一申请账户。
关于把应用部署扩展到更多区域时应注意的考量与方面,就先讲这么多。我们来看下面的示例架构,它展示了一个非常简化的多区域设置场景。
3. 示例场景
我们给出一个多区域 SaaS 应用设置与部署流程的示例场景。请查看下面的架构,了解这样一个简单设置的样貌。
上面的示例场景展示了把一个示例 SaaS 应用部署到 eu10 与 eu20 两个区域中的三个阶段(开发、测试、生产)。在强调前面讨论过的一些多区域方面之前,我们先看一下开发、测试与发布流程。
应用开发本身在位于 eu10 区域的中央 dev 子账户中完成。
结合 SAP CI/CD 服务与 SAP Cloud Transport Management,可以(部分)自动化 DevOps 流程。
第一步,最新改动总是先部署到目标区域 eu10 与 eu20 的 test 子账户。
在测试阶段,SaaS 提供方以及(如有需要)消费方可以测试最新改动。
如果测试成功,改动就可以传输到 eu10 与 eu20 区域的 production 子账户。
从服务角度看,可以看到大多数服务在每个阶段的子账户中都是重复部署的。例外是位于 dev 子账户中的 SAP CI/CD 与 SAP Cloud Transport Management 服务。另外有一个 SAP HANA Cloud 实例在 eu10 dev 与 eu10 test 两个子账户之间共享。
在这个示例场景中,每个阶段使用一个 SAP Identity Authentication Service 实例,而不是每个区域一个。
从持久化角度看,该场景只适合那些不依赖特定区域存储数据的消费方,或那些出于延迟或监管原因希望使用某个特定区域的消费方。
SAP BTP 中的示例设置
下面的截图展示了上述场景(SaaS 应用运行在两个不同区域 eu10 与 eu20)的示例目录与子账户结构。可以看到 Subscriber 在 eu10 区域有一个 Test 子账户,并在 eu10 与 eu20 区域各有 Production 子账户。开发工作则在中央的 eu10 子账户中进行。
子账户数量会随 SaaS 消费方数量增长,因此请务必把子账户妥善归入目录(按阶段、应用、区域、消费方等),并分配恰当的标签。补充上面的子账户结构——SAP Cloud Transport Management 中一个可能的景观可视化大致如下。
提示 - 当然,你也可以在自己的场景中加入更多节点(Pre-Prod、Performance 等),或者用 SAP CI/CD 服务或你自己的 Jenkins 服务器来管理向不同区域的部署。
4. 自定义域
尤其在多区域部署的情况下,理解 Custom Domain 服务非常重要。与其向消费方提供 SAP 默认的应用域(例如 subscriber-7k7tmze3-susaas.cfapps.eu10.hana.ondemand.com),你可以为他们提供 subscriber.eu10.susaas.com 甚至 subscriber.susaas.com 这样的简洁域名。
在故障转移场景中,使用自定义域同样至关重要。这类场景下,你通常会给消费方一个单一入口,例如 subscriber.susaas.com。从 subscriber.eu10.susaas.com 到 subscriber.eu20.susaas.com 的实际故障转移在后台完成,用户毫无察觉。
要正确理解 Custom Domain 服务以及如何搭建上述场景,请查阅专家功能中关于自定义域使用的相应章节。下面可以看到名为 subscriber 的消费方在两个区域(eu10 与 eu20)中的示例路由映射。
两个区域 Custom Domain 服务中这两组几乎等价的路由映射,再与超大规模云厂商提供的智能路由机制结合,例如 AWS(Route 53)或 Azure(Traffic Manager)。
这样,多区域的应用实例既可以用区域专属 URL(subscriber.eu10.susaas.com)访问,也可以用与区域无关的 URL(subscriber.susaas.com)访问。在后一种情况下,用户会根据可用性、延迟、地理距离或 SaaS 提供方定义的其他智能路由度量,被路由到两个区域之一。
下面是一个 Azure Traffic Manager 配置文件的示例截图,它基于可用性把流量路由到 eu10 或 eu20,其中 eu10 区域优先级最高。
下面的截图展示了这种智能路由功能的结果。同一个应用现在可以通过两个不同的 URL 访问——依据上面的 Traffic Manager 配置,一个与区域相关,一个与区域无关。
5. 更多信息
如果你想进一步了解多区域或高可用场景,建议从以下资料开始。
使用多个 SAP HANA Cloud 实例
Kyma ❌
Cloud Foundry ✅
在专家功能的这一部分,你将了解如何搭建这样一个场景:你不想在所有 SaaS 消费方之间共享同一个 SAP HANA Cloud 实例,而是为部分或全部客户使用独立的 SAP HANA Cloud 实例。例如,数据隐私法规方面的法律原因可能要求这样做。
重要 - 专家功能的这一部分是根据 SAP Community 中的一个问题补充的。由于我们的团队尚未对该方案做过充分测试,请务必对你的设置做端到端测试,包括 Service Manager 管理的容器完整生命周期——创建、更新、删除!
使用多个 SAP HANA Cloud 实例
设置步骤
更多细节
重要 - 下面的场景假设你的 SaaS 应用与消费方专属的 SAP HANA Cloud 实例运行在同一个 SAP BTP 区域和同一个 SAP BTP 全球账户中。SAP HANA Cloud 实例运行在其他 SAP BTP 区域的场景不受下面方案的支持。对于跨 SAP BTP 区域或跨 SAP BTP 全球账户的访问需求,请考虑在应用逻辑中使用 @sap/hdbext npm 包手动连接 SAP HANA Cloud 实例。你可以把每个消费方 SAP HANA Cloud 实例的凭据存放在 Secure Store 中,在应用逻辑建立连接时读取。
1. 设置步骤
自 1.1.0 版本起,@sap/cds-mtxs 包(点击此处)提供了一个选项,可以在订阅载荷(点击此处)中传入 database_id,用于定义新租户容器的目标数据库。
如果你相应地调整 mta.yaml 文件中的 saas-registry 配置,就可以在创建新订阅时提供 Cloud Foundry 空间中已有的 SAP HANA Cloud 数据库的 database_id。先从修改 mta.yaml 文件中 saas-registry 资源配置开始,如下所示。这样你就可以在新 SaaS 消费方租户的订阅过程中提供 databaseId 参数。
提示 - 你也可以在订阅过程中新建一个 SAP HANA Cloud 实例,并使用生成的 database_id,而不是为每个新客户预先手动创建 SAP HANA Cloud 实例(取决于你的用例)。
# --------------------- REGISTRY SERVICE ---------------------
- name: susaas-registry
# ------------------------------------------------------------
type: org.cloudfoundry.managed-service
requires:
- name: susaas-uaa
- name: susaas-srv-api
- name: susaas-approuter
parameters:
service: saas-registry
service-name: ${space}-susaas-registry
service-plan: application
config:
xsappname: ~{susaas-uaa/XSAPPNAME}
appName: ~{susaas-approuter/application}-${org}
displayName: Sustainable SaaS ${space}
description: Sustainable SaaS Application
category: SaaS Multitenant Apps
propagateParams: true
paramsSchema:
schemas:
subscription:
create:
parameters:
$schema: 'http://json-schema.org/draft-04/schema#'
additionalProperties: false
_show_form_view: true
type: 'object'
properties:
databaseId:
type: 'string'
title: 'SAP HANA Cloud Database ID'
description: 'Enter SAP HANA Cloud Database ID'
appUrls:
onSubscription: ~{susaas-srv-api/srv-url}/-/cds/saas-provisioning/tenant/{tenantId}
onSubscriptionAsync: false
onUnSubscriptionAsync: false
getDependencies: ~{susaas-srv-api/srv-url}/-/cds/saas-provisioning/dependencies
appPlans:
- name: default
description: Sustainable SaaS default plan
创建新订阅时弹出的窗口大致如下。在租户子账户中设置新订阅时,把目标 SAP HANA Cloud 数据库的 ID 粘贴到这里。
在订阅过程中,你可以读取 databaseId 参数,并按所需格式(如 CAP 变更日志所述——点击此处)把它加入订阅载荷。
service.on('UPDATE', 'tenant', async (req, next) => {
console.log("Subscription data:",JSON.stringify(req.data));
const Automator = require("./utils/automator");
if(req.data?.subscriptionParams?.databaseId){
let params = {
"_": {
"hdi": {
"create":{
"provisioning_parameters": {
"database_id" : req.data?.subscriptionParams?.databaseId
}
}
}
}
};
req.data = { ...req.data, ...params }
}
...
}
在部署改动之前,请确保在 package.json 或 cdsrc.json 文件的 requires 段中提供一个默认 database_id。下面是一个示例。技术租户 t0(包含由 CAP 管理的表与数据)需要这个默认值。此外,对于在订阅过程中未提供独立数据库 ID 的消费方租户,也会使用这个 SAP HANA Cloud 数据库。
"[production]": {
"multitenancy": true,
"toggles": true,
"extensibility": true,
"cds.xt.DeploymentService": {
"hdi": {
"create": {
"provisioning_parameters": { "database_id" : "e87a4be6-abcd-1234-efgh-73ff2df8e4f4" }
}
}
}
}
那么,怎样检查容器是否被部署到了你在订阅过程中提供的独立 SAP HANA Cloud 实例上?可以在 Service Manager 的绑定详情中查看。如下面的截图所示,Service Manager 当前管理三个容器。除技术容器 t0 之外,还有两个额外的 SaaS 租户容器。从详情中可以看到,租户容器根据订阅过程中提供的 database ID 参数,被部署到了不同的 SAP HANA Cloud 实例。
2. 更多细节
共享数据库容器
请注意,在这种场景中使用共享数据库容器会带来额外的复杂度。在我们的示例场景中,我们已从 mta.yaml 中完全移除了共享数据库容器,也移除了 CAP 数据模型(db 文件夹)中的相关引用。
为项目搭建 CI/CD
Kyma ❌
Cloud Foundry ✅
在专家功能的这一部分,你将学习如何搭建 SAP Continuous Integration and Delivery(CI/CD) 服务,用来处理所有与 DevOps 相关的任务,例如自动化测试、构建以及把代码改动部署出去,从而加快开发与交付周期。
为项目搭建 CI/CD
简介
设置 SAP CI/CD 服务
提供 SAP BTP 凭据
提供 GitHub 凭据
提供服务代理(Service Broker)目录与凭据
添加你的 GitHub 仓库
创建 GitHub Webhook
把 Webhook 详情添加到 GitHub
配置 CI/CD 作业
创建管道文件
提供更多配置细节
推送并测试
附加单元测试
增强管道
更多信息
1. 简介
在专家功能的接下来的部分,你将学习如何在 SAP BTP 环境中搭建一个 SAP CI/CD 服务实例。你会用一些额外文件来增强现有项目,从而实现把 SaaS 应用自动构建并部署到你选择的 Cloud Foundry 空间。
要理解持续集成与持续交付的基础知识,请先阅读官方的 SAP Help 文档(点击此处)。
接着了解最重要的概念,弄清作业(Job)与构建(Build)的区别,以及管道、阶段与步骤等概念,因为在专家功能的这一部分我们会一直使用这些词。官方 SAP Help 文档中有很好的解释(点击此处)
熟悉基础概念后,来看看我们接下来会使用的 SAP Cloud Application Programming Model 管道的细节。官方 SAP Help 文档(点击此处)非常详细地描述了该管道及其用到的各个阶段与步骤。
对基本术语与概念已经理解了吗?那就让我们给示例应用引入一些 DevOps 吧!
2. 设置 SAP CI/CD 服务
SAP CI/CD 服务为你提供 Project "Piper" 通用管道中一组精选的阶段与步骤。关于 Project "Piper" 的更多内容见“增强你的管道”一节。支持的步骤在持续增强,如果缺少某些功能,欢迎反馈。
2.1. 进入你的 SAP BTP 子账户。
2.2. 导航到 Service Marketplace。
2.3. 找到 Continuous Integration & Delivery 服务并订阅该应用。
2.4. 为你的用户分配新的角色集合 "CICD Service Administrator"。
3. 提供 SAP BTP 凭据
要部署到你的 Cloud Foundry 景观,SAP BTP CI/CD 服务需要一个相应 SAP BTP 用户账户的凭据,并且该用户在目标 Cloud Foundry 空间中具有 Space Developer 权限。
3.1. 在 SAP BTP Cockpit 中,点击 Instances and Subscriptions。
3.2. 找到你的 Continuous Integration & Delivery 订阅。
3.3. 点击 Go to Application。
3.4. 点击 Credentials 选项卡,添加你的 SAP BTP 凭据。
提示 - 部署过程中需要使用这些凭据。
3.5. 点击 +。
3.6. 输入你选择的名称。本示例中名称为 susaas-cf-credentials。
提示 - 如果你使用其他凭据名称,就需要相应调整 config.yml。
3.7. 把 Type 选择为 Basic Authentication。
3.8. 在 Username 中输入你的 SAP BTP 用户名或邮箱。
提示 - 生产场景下强烈建议在这里提供一个专用的技术用户,它可以很方便地添加到你的自定义 SAP IAS 租户中。测试场景下可以使用你自己的用户。请确保该用户在目标 Cloud Foundry 空间中具有 Space Developer 权限。
3.9. 在 Password 中使用你的 SAP BTP 密码。
3.10. 再次确认凭据无误,然后点击 Create。
4. 提供 GitHub 凭据
要部署代码的最新版本,SAP BTP CI/CD 服务需要访问你的 GitHub 仓库。相应凭据将在下面几步中配置。
4.1. 切回 Credentials 菜单,点击 +。
4.2. 输入你选择的凭据名称。本示例中名称为 git-credentials。
4.3. 把 Type 选择为 Basic Authentication。
4.4. 在 Username 中输入你的 GitHub 用户名或邮箱。
4.5. 在 Password 中使用在 GitHub 创建的个人访问令牌(personal access token)。
4.6. 再次确认凭据详情,然后点击 Create。
5. 提供服务代理目录与凭据
你不必把 Service Broker 的目录详情与哈希凭据推送到 GitHub,这些值会在部署应用期间由 SAP CI/CD 服务动态注入。因此,你需要把服务目录详情与哈希凭据以 Secret Text 凭据的形式保存在 SAP CI/CD 服务中。
5.1. 切换到 Credentials 菜单,点击 +。
5.2. 输入你选择的凭据名称。本示例中名称为 susaas-sb-credentials。
提示 - 如果你使用其他名称,就必须相应调整 config.yml 文件。
5.3. 在 Type 中选择 Secret Text。
5.4. 粘贴 Service Broker 的哈希凭据。
提示 - 这些凭据会在 CI/CD 管道的 config.yml 文件中作为 CloudFoundryDeploy 步骤的一部分被引用。
cloudFoundryDeploy:
...
mtaExtensionCredentials:
susaas-sb-credentials: susaas-sb-credentials
提示 - 这样你就可以在 mtaext 部署描述符扩展文件中用 <%= susaas-sb-credentials %> 格式复用该凭据,让 GitHub 仓库中不残留任何凭据值。
modules:
- name: susaas-api-sb
properties:
SBF_BROKER_CREDENTIALS_HASH: >
{
"broker-user": "<%= susaas-sb-credentials %>"
}
5.5. 点击 Create 完成配置。
5.6. 回到 Credentials 菜单,再次点击 +。
5.7. 为 Service Broker 目录详情输入你选择的凭据名称。本示例中名称为 susaas-sb-catalog。
提示 - 如果你使用其他名称,就必须相应调整 config.yml 文件。
5.8. 在 Type 中再次选择 Secret Text。
5.9. 粘贴 Service Broker 的服务目录 JSON 文件,其中包含相应的 GUID。
提示 - 这些详情会在 CI/CD 管道的 Build 阶段被获取,并作为 config.yml 文件的一部分注入相应的 broker 目录(见下文)。
service:
stages:
Build:
credentialVariables:
- name: "Catalog"
credentialId: "susaas-catalog"
runFirst:
command: echo "$Catalog" > ./code/broker/catalog-private.json
提示 - mtaext 部署描述符扩展文件会相应地引用这个 catalog-private.json 文件。这种做法可以让 GitHub 仓库中不残留任何环境专属细节。
mtaext.yaml
modules:
- name: susaas-api-sb
properties:
SBF_CATALOG_FILE: ./catalog-private.json
5.10. 点击 Create 完成配置。
6. 添加你的 GitHub 仓库
6.1. 在 CI/CD 服务中导航到 Repository 选项卡,点击 + 添加你的 GitHub 仓库。
6.2. 为仓库指定名称,例如 btp-cap-multitenant-saas。
6.3. 输入你**派生(fork)**的 GitHub 仓库的 Repository URL。
提示 - 如果你 fork 了这个示例项目,URL 形如 https://github.com/YourUser/btp-cap-multitenant-saas。使用本地 GitHub 仓库时,请确保已成功配置 Cloud Connector(详情点击此处)。
6.4. 选择你在前面步骤中创建的 GitHub 凭据(如果你按本教程操作,例如 susaas-git-credentials)。
6.5. 此时不要点击 Add,而是继续教程的下一步,为新的仓库配置添加 Webhook 凭据。
7. 创建 GitHub Webhook
在这一步,你将为新仓库创建 Webhook 配置。这样就能在 GitHub 中创建相应的 Webhook,让 GitHub 在仓库代码变化时通知你的 SAP BTP CI/CD 服务,并触发新的管道运行。
7.1. 在新仓库配置的 Webhook Event Receiver 区域,选择类型 GitHub,然后从 Webhook Credential 下拉列表中点击 Create Credentials。
7.2. 为新的 Webhook 配置输入你选择的名称,并添加有意义的描述。本示例中名称为 susaas-git-webhook。
7.3. 点击 Generate 生成新的 Secret 值!
7.4. 复制该 Secret 并存放在安全的地方,因为初次创建之后你将无法再次获取它。
7.5. 点击 Create,在 SAP BTP CI/CD 服务中创建 Webhook 配置。
7.6. 点击 Add 完成仓库设置流程。
8. 把 Webhook 详情添加到 GitHub
8.1. 在你的 GitHub 仓库(https://github.com/**YourUser**/btp-cap-multitenant-saas)中,进入 Settings 选项卡。
8.2. 在导航窗格中选择 Webhooks。
8.3. 选择 Add webhook。
8.4. 配置数据可以在新建的 SAP BTP CI/CD 服务仓库配置的 Webhook Data 区域找到。
8.5. 把该弹窗中的 Payload URL 复制粘贴到 GitHub,并把 Content type 选择为 application/json。
8.6. 填写 Webhook 的 Secret,即你前面复制并安全保存的那个值。
8.7. 把 content-type 设置为 application/json,然后点击 Add webhook。
9. 配置 CI/CD 作业
9.1. 在 SAP BTP CI/CD 服务的 Jobs 选项卡中,选择 + 创建新作业。
9.2. 在 Job Name 中为作业输入名称,例如 susaas(见下文)。
9.3. 在 Repository 下拉列表中选择已配置的 GitHub 仓库(见下文)。
9.4. 在 Branch 中输入 main(见下文)。
9.5. 在 Pipeline 中选择 SAP Cloud Application Programming Model(见下文)。
提示 - 你可以在官方 SAP Help 文档中找到该管道的各阶段与步骤(点击此处)。
9.6. 保持 BUILD RETENTION 部分的默认值(见下文)。
9.7. 在 STAGES 部分,从 Configuration Mode 下拉列表中选择 Source Repository(见下文)。
提示 - 除了在源代码仓库中定义管道,你也可以用作业编辑器在界面上配置管道步骤。
9.8. 选择 Create(见下文)。
10. 创建管道文件
由于我们配置的是基于 Source Repository 的管道,你必须在 GitHub 仓库中提供相应的管道细节。你可以使用本专家功能中提供的示例文件来完成。
10.1. 复制提供的 config.yml 文件(来自本专家功能的 files 目录)到新建的根目录 .pipeline(不要漏掉前面的点!),同时把提供的 Jenkinsfile 放到项目根目录。
10.2. 把本专家功能 files 目录中提供的 free-basic-cicd.mtaext 文件复制到 ./deploy/cf/mtaext 目录。
提示 - 如果使用 SAP BTP Trial,请改用 trial-basic-cicd.mtaext 文件。
提示 - 由于该文件不包含任何机密或环境专属细节,文件名不需要加 -private 后缀。
10.3. 更新 .pipeline 目录中的 config.yaml 文件,根据你自己的目标 Cloud Foundry 环境调整 cloudFoundryDeploy 步骤的值。下面是一个示例配置。
提示 - 这些细节最终也可以存放在相应的 SAP BTP CI/CD 凭据中,不过在这个场景下它们不算高度机密,因此会被推送到 GitHub。
apiEndpoint - 你所用 Cloud Foundry 区域的 API 端点
org - 目标 Cloud Foundry 组织
space - 目标 Cloud Foundry 空间
mtaExtensionDescriptor - 你粘贴 mtaext 文件的路径。
cloudFoundryDeploy:
cfCredentialsId: susaas-cf-credentials
apiEndpoint: 'https://api.cf.eu10.hana.ondemand.com'
org: 'sap-demo'
space: 'dev'
mtaDeployParameters: '-f --version-rule ALL'
mtaExtensionDescriptor: './deploy/cf/mtaext/free-basic-cicd.mtaext'
mtaExtensionCredentials:
susaas-sb-credentials: susaas-sb-credentials
11. 提供更多配置细节
为了让部署更加动态,并把环境专属细节与机密信息从 GitHub 仓库中移除,还需要通过 CI/CD 凭据向 CI/CD 管道注入两个额外的配置文件。
我们先来看 Alert Notification 配置,其中包含收件人邮箱地址或可能的密码与凭据,这些内容你可能不希望推送到 GitHub 仓库。
11.1. 新建一个类型为 Secret Text 的 Credential,命名为 susaas-anf-config(或你选择的其他名称)。
11.2. 粘贴你的 alert-notif-private.json 文件(位于 deploy/cf/config 目录)的值。
11.3. 相应的凭据细节会在 CI/CD 的 Release 阶段被动态读取并注入,并作为 mtaext 部署描述符扩展的一部分被引用。
config.yml
service:
stages:
Build:
# Reference CI/CD Credentials
credentialVariables:
- name: "AlertNotif"
credentialId: "susaas-alert-notif"
# Dynamically create config file during Release Stage
runFirst:
command: echo "$AlertNotif" > ./deploy/cf/config/alert-notif-private.json
mtaext
ID: susaas.freetier.cicd
extends: susaas
- name: susaas-alert-notification
# Reference dynamically generated config file
parameters:
path: ./config/alert-notif-private.json
对你的 Authorization & Trust Management Service(xsuaa)配置重复同样的过程。由于你的 xsuaa 配置(xs-security.json)包含应用专属的 cfapps 子域或你自己的自定义域,我们用一个 Credential 值来注入相应细节。
11.5. 新建一个类型为 Secret Text 的 Credential,命名为 susaas-xs-security(或你选择的其他名称)。
11.6. 粘贴你的 xs-security.json 文件(位于开发环境的 deploy/cf/config 目录)的值。
11.7. 相应的凭据细节会在 CI/CD 的 Release 阶段被动态注入,并作为 mtaext 部署描述符扩展的一部分被引用。
config.yml
service:
stages:
Build:
# Reference CI/CD Credentials
credentialVariables:
- name: "XsSecurity"
credentialId: "susaas-xs-security"
# Dynamically create config file during Release Stage
runFirst:
command: echo "$XsSecurity" > ./deploy/cf/config/xs-security.json
mtaext
ID: susaas.freetier.cicd
extends: susaas
- name: susaas-uaa
# Reference dynamically generated config file
parameters:
path: ./config/xs-security.json
用同样的方式,你几乎可以把任何类型的环境专属配置文件提供并注入到部署中。
12. 推送并测试
12.1. 打开终端,执行下面的命令把改动推送到你的 fork 仓库。
git add .
git commit -m "config.yml configured for deployment target"
git push
12.2. 如果一切顺利,这会触发第一个作业。
12.3. 回到你的 SAP CI/CD 服务。
12.4. 查看右侧是否已触发构建。
就是这样,你已经成功配置了管道。这套设置非常基础,但也足以让你了解如何起步,并且可以根据个人需求进一步增强与定制。
13. 附加单元测试
如果你想为管道添加额外的单元测试,可以在项目 package.json 中把它们定义为 npm 脚本。按下面的步骤操作,就能在管道中调用这些脚本。
13.1. 在 .pipeline/config.yml 文件中添加以下内容,以执行附加测试。
13.2. 在 Stages 配置中启用 Additional Unit Tests 阶段的 npm 脚本执行。
Additional Unit Tests:
npmExecuteScripts: true
13.3. 在步骤配置中,现在可以添加运行测试的 npm 脚本。
npmExecuteScripts:
runScripts:
- "test"
14. 增强你的管道
提供的管道只包含一些基础步骤,用于把 SaaS 应用构建并部署到你选择的 Cloud Foundry 空间。真实项目中的管道通常会包含多得多的阶段与步骤,例如自动化测试、与 SonarQube 或 SAP Cloud Transport Management 服务的集成,以及更多功能。
要增强管道,请从 SAP CI/CD 服务的官方 SAP Help 文档开始,其中描述了我们在示例中使用的 SAP Cloud Application Programming Model 管道所提供的各个阶段与步骤。SAP Help 文档能让你初步理解底层发生了什么。
当你对管道中的各个阶段与步骤比较熟悉之后,就可以深入官方的 Project "Piper" 文档。SAP 把大部分持续交付工具都实现在 Project "Piper" 中。Project "Piper" 的目标是大幅简化使用 SAP 技术在项目中搭建持续交付的工作。如果你对比 Project "Piper" 中 Build 阶段提供的步骤(点击此处),会在官方 SAP Help 文档中(点击此处)看到完全相同的步骤。
原因非常简单。SAP CI/CD 服务在底层同样使用 Project "Piper" 及其提供的各个阶段与步骤。因此,你也可以借助 Project "Piper" 文档查找 SAP CI/CD 服务以及 CAP 专属管道所用各阶段与步骤的更多细节。这对微调你的 CI/CD 管道非常有帮助!
如果你想进一步学习并成为 SAP CI/CD 方面的专家,请查看 Tutorial Navigator 中的以下教程(点击此处)。在那里你将学习如何搭建自己的基于 Docker 的 Jenkins 实例,并使用 UI5 Test Recorder 为基于 CAP 的项目创建 UIVeri5 系统测试。
最后但同样重要的是,请访问学习旅程 Efficient DevOps with SAP(点击此处,在这里你可以学到很多关于 SAP DevOps 的通用知识,也能发现更多在 CAP 应用场景中使用 SAP CI/CD 服务的示例。
15. 更多信息
请使用以下链接查找上述主题的更多信息:




















































































































































