多租户 SaaS 应用(CAP) · 2 · 基础实现(1/4)

项目

内容

官方仓库

SAP-samples/btp-cap-multitenant-saas

业务场景

把 CAP 应用改造成多租户 SaaS:租户订阅、数据隔离、按租户配置

技术栈

CAP(Node.js/Java)、mtxs、SaaS Registry、XSUAA、Cloud Foundry / Kyma

对应课程

CLD200、KYM400、BTP200

对应路径

第 2 条、第 7 条

为什么值得做:多租户是 SaaS 产品的分水岭。本案例实现了用一个应用服务众多客户所需的租户开通、隔离与升级机制。

动手要点:

  • 理解 SaaS Registry 与租户感知应用之间的关系。

  • 研读 mta.yaml 与租户部署描述文件——大部分复杂度都集中在这里。

本页内容抓取自官方仓库 SAP-samples/btp-cap-multitenant-saas,共收录 8 篇官方文档(README 与 docs)。原仓库内容版权归 SAP SE,遵循其许可证。

基础版本简介

  • Kyma ✅

  • Cloud Foundry ✅

示例应用的基础版本(Basic Version)为你提供在 SAP Business Technology Platform(SAP BTP)上构建软件即服务(SaaS)应用所需的核心要素。

  • 基础版本简介

      1. 分步操作

      1. 版本功能

      1. 实现结果

无论是在 SAP BTP, Kyma 还是 Cloud Foundry 环境中,你都可以用自有 Pay-as-you-Go(PAYG)或 CPEA 账户的 Free (Tier) 服务计划搭建基础版本。请查看下面的架构图,了解我们在 Cloud Foundry 与 Kyma 两种场景中分别用到的基础版本组件:

提示 - 示例应用也可以部署到 Trial 账户,但我们强烈建议使用上述账户类型之一。

Cloud Foundry

Cloud Foundry 环境中基础版本的组件架构图

Kyma

Kyma 环境中基础版本的组件架构图

如你所见,两种架构看起来非常相似,只是在基于 Kubernetes 的架构中,Cloud Foundry 运行时使用的部分服务被 Kyma 原生组件替代。

例如 Credential Store 或 Autoscaler Service,在 Kyma 中改用 Kubernetes Secrets 或 Horizontal Pod Autoscalers 实现。同样,为 Kubernetes 爱好者准备了更详细的示意图,其中包含部分用到的 Kyma 组件与原生 Kubernetes 组件:

包含 Kyma 与原生 Kubernetes 组件的基础版本详细架构图

1. 分步操作

要部署 SaaS 应用的基础版本,并进一步了解 Cloud Foundry、Kyma Runtime 与 Kubernetes,请按下面的步骤操作。

我们的分步指南大多同时覆盖两种运行时,但下表标出的少数章节是与运行时相关的。请务必查看各分步教程的引言,确认说明是否仅针对某个特定运行时。

1 - 快速开始

先理解仓库结构 ➜(点击此处)

为部署准备提供方子账户 ➜(点击此处)

2 - 构建与部署

把 SaaS 应用构建并部署到 Cloud Foundry ➜(点击此处)(仅限 Cloud Foundry)

构建并推送应用的容器镜像 ➜(点击此处)(仅限 Kyma)

使用 Helm 把 SaaS 应用部署到 Kyma ➜(点击此处)(仅限 Kyma)

3 - 测试应用

部署完成后订阅消费方子账户 ➜(点击此处)

通过向 SaaS API 推送数据提供示例内容 ➜(点击此处)

探索应用并端到端测试各项功能 ➜(点击此处)

4 - 深入探索

更深入地探索应用组件 ➜(点击此处)

了解用到的 Kyma 资源与 Helm chart ➜(点击此处)(仅限 Kyma)

5 - 取消部署应用

了解如何取消订阅消费方租户 ➜(点击此处)

取消部署 SaaS 应用 ➜(点击此处)

2. 版本功能

示例应用的基础版本提供了基于 CAP 的多租户 SaaS 应用的基本实现,包含以下特性:

  • 一个 SAP HANA Cloud 数据库模型,用于存储所有租户的应用或 API 数据,另有一个由所有租户共享的数据模型。

  • 一个 CAP OData 服务,为应用层提供 OData v4 服务,包含注解(Service Engine)。

  • 一个 Fiori Elements 应用,基于多种注解与扩展示例构建(UI Component)。

  • 一个 CAP API 服务,为所有租户提供接口,用于接收来自 SAP S/4HANA 等解决方案的数据(SaaS API)。

  • 一个 Service Broker,允许租户创建 service broker 实例以访问应用的 API(API Broker)。

此外,应用的基础版本还提供了 SAP BTP 服务的示例集成与使用场景,包括

  • 企业应用基础特性,例如

    • Alert Notification Service,在应用崩溃或租户开通期间出现错误等问题时通知你。

    • Autoscaling 特性,在 SaaS 租户负载增加时对 SaaS 应用组件进行扩缩容。

    • HTML5 Application Repository,存储并提供静态应用内容,让应用更具韧性。

  • SaaS 使用所需的重要组件,例如

    • SAP HANA Cloud,让你能在同一数据库上使用强大的容器概念实现租户隔离。

    • Service Manager,负责处理与租户数据库容器之间的安全通信。

    • Application Router,是支撑 SaaS 应用多租户特性的关键支柱之一。

  • Authorization & Trust Management 服务实例,包括

    • application 计划,处理所有租户基于 XSUAA 的应用认证与授权。

    • broker 计划,负责所有租户基于 XSUAA 的 API 访问安全需求。

由于整套配置涉及许多不同的服务与组件,本教程只详细讲解那些并非一目了然的要素。如果你想了解更多,我们强烈建议查阅 SAP Help 或相关组件文档(例如 npm 包)。

3. 实现结果

完成本分步教程后,你将得到一个运行在自有 Cloud Foundry 环境或 Kyma Cluster 中的示例 SaaS 应用,它可以:

  • 为你的租户提供用户界面,用于

    • 管理该租户的 SaaS 应用用户。

    • 创建项目,并把用户作为成员分配到不同项目。

    • 设置评估(assessment),用于分析产品可持续性指标。

  • 为所有租户提供基于 SAP HANA Cloud HDI (*) 容器的数据隔离。

  • 可由同一全局账户下的子账户(消费方)订阅。

  • 在订阅过程中创建 service broker 实例,用于注册 service broker。

  • 允许你的租户通过多租户 API 端点读取和更新数据。

  • 让租户用通过 API 上传的数据预填其评估。

(*) HDI - HANA Deployment Infrastructure

下面的截图可以让你对基础版本应用有个初步印象(点击可放大)。

Main Menu

Project List

Main Menu

Project List

Project Details

Project Assessments

Project Details

Project Assessments

Project Members

Add Project Member

Project Members

Add Project Member

User List

User Details

User List

User Details

Assessment List

Assessment Details

Assessment List

Assessment Details

Circularity Metrics

Circularity Charts

Circularity Metrics

Circularity Charts

Sales Splits

Prefill Sales Splits

Sales Splits

Prefill Sales Splits

Material Splits

Modify Material Splits

Material Splits

Modify Material Splits

Material Splits

Material Splits

理解仓库结构

  • Kyma ✅

  • Cloud Foundry ✅

本部分教程将简要说明 code 目录的结构,让你能自如地浏览所提供的 GitHub 仓库。如果你面向的是 Cloud Foundry 部署,请忽略与 Kubernetes 相关的产物,例如 Dockerfile,它们对你的部署并非必需。

提示 - 本章不会涉及 deploy 文件夹中的文件,这些文件会在各环境专属的子文件夹中进一步说明。

  • 理解仓库结构

      1. 概览

      1. API 服务

      1. 应用

      1. API Broker

      1. 租户数据模型

      1. 共享数据模型

      1. 应用路由器

      1. 注解文件

      1. 业务应用服务

      1. 测试对象

另外,请查看我们的探索组件章节(点击此处),其中更详细地介绍了各种 SaaS 应用组件及其任务(点击此处)。现在,我们先看一个简要概览,然后再深入各个子目录。

1. 概览

GitHub 仓库的 code 目录由多个子目录组成,其中包括 API(Service)Broker、API 服务,以及不同的应用层,例如用户界面、后端业务应用服务层,还有部署在租户专属数据库容器与共享数据库容器中的数据模型。此外,你还能找到 Helm Chart(Kyma 部署所需)、支持本地测试的内容,甚至是扩展 SaaS 应用的示例。

api - 基于 CAP 的 API 服务
app - SAP Fiori Elements UI 与 App Deployer
broker - API Service Broker
db - 租户数据模型
db-com - 共享数据模型
router - 应用路由器
srv - 基于 CAP 的 SaaS 服务
test - 单元测试、API 测试与示例数据

.env.sample - 本地测试用环境变量
package.json - CDS 构建配置与本地测试依赖

2. API 服务

api 目录包含基于 CAP 的 API 服务的实现,SaaS 消费方可以用它把数据上传到自己的租户数据库容器,或在其中维护数据。更多细节见本教程的其他部分(点击此处)。

提示 - 使用 Kyma 时,API 服务的容器镜像通过 Cloud Native Buildpacks 构建,因此该目录不含单独的 Dockerfile。构建过程的更多细节见教程的其他部分(点击此处)!

srv - CAP 应用文件夹

.cdsrc.json - 生产使用的 CDS 配置
api-service.cds - 基于 CAP 的 API 服务定义
api-service.js - 基于 CAP 的 API 服务处理程序
server.js - 用于健康检查端点的自定义 server.js

.cdsrc.json - 本地与混合测试用 CDS 配置

3. 应用

除了 html5-deployer 目录(其中包含 HTML5 Application Deployer,详情见此处),app 目录还包含所有 SAP Fiori Elements 模块,它们基于 OData 后端服务的注解动态生成 UI。在 UI 构建过程中,四个 UI 模块会被打包成 zip 并复制到 html5-deployer 目录下的 resources 文件夹。该文件夹在首次构建时创建。

提示 - 在 Cloud Foundry 中,生产部署并不需要 HTML5 Apps Deployer,但它仍可用于从本地开发环境进行的部署。

提示 - 使用 Kyma 时,HTML5 Apps Deployer 的容器镜像基于 SAP 维护的现有 Docker Image 构建,并在相应的 Dockerfile 中引用。构建过程的更多细节见教程的其他部分(点击此处)。

html5-deployer - HTML5 Application Deployer

.dockerignore - docker 构建时忽略 package.json
Dockerfile - 基于 sapse/html5-app-deployer 的 Docker 镜像
package.json - 仅本地测试需要

ui-admin-projects - 用于项目管理的管理界面

webapp - UI5 应用资源

ext - Fiori Elements 扩展
i18n - 翻译文件
utils - 可复用代码
Component.js - 组件代码
index.html - 用于独立运行
manifest.json - SAPUI5 manifest 文件

package.json - 构建过程需要
ui5-deploy.yaml - 构建过程需要
xs-app.json - HTML5 App Repository 路由

ui-admin-users - 用于用户管理的管理界面
ui-public-assessments - 用于评估管理的界面
ui-public-flp - 用于沙盒启动台的界面
ui-public-projects - 用于查看项目详情的界面

launchpad.html - 沙盒启动台

ui-public-flp UI 模块包含一个沙盒启动台(Sandbox Launchpad)。Application Router 的 welcomeFile 属性会路由到存放在 HTML5 Application Repository 中的这个模块。

4. API Broker

broker 目录包含 API Service Broker 的实现。在基于 Kyma 的场景中,catalog.json 文件内容(定义 Service Broker 提供的服务计划所需)被纳入 Helm Chart,因为所需细节只有在部署到你的 Kyma 集群后才可用。

提示 - 使用 Kyma 时,API Service Broker 的容器镜像通过 Cloud Native Buildpacks 构建,因此该目录不含单独的 Dockerfile。构建过程的更多细节见教程的其他部分!

catalog.json - 包含所提供的服务计划细节
package.json - Node.js 依赖与启动脚本
start.js - API Service Broker 的自定义启动脚本
(从环境变量读取凭据)

5. 租户数据模型

db 目录包含租户数据模型的定义。每个 SaaS 租户在订阅时,该模型都会部署到一个独立、隔离的 SAP HANA Cloud HDI(HANA Deployment Infrastructure)数据库容器中。除基于 CDS 的数据模型外,该目录还包含用于访问共享 HDI 数据库容器的 SAP HANA 原生对象(例如 hdbgrants 或 synonyms)。你可以在探索组件章节(点击此处)了解更多。

重要 - 如果租户数据模型发生变更,请务必在开始部署到 Cloud Foundry 或构建 SaaS 后端服务的新 Docker 镜像之前运行 cds build --production。

提示 - 由于租户数据模型属于 SaaS 后端服务的一部分,并在运行时部署到新的租户数据库容器,因此无需为这个组件单独构建部署用 Docker 镜像。数据模型定义以 .tgz 文件形式存放在后端服务中,而 mtxs 部署服务(点击此处)支持自动部署到新的数据库容器。

重要 - 根据 cds watch 或 cds build 使用的 CDS 配置,租户数据模型会包含或排除示例数据。使用 sqlite 进行本地测试时,应用数据(例如 Products)与主数据表(例如 Currencies 或 Countries)以及示例值都属于租户数据模型的一部分。而面向 SAP HANA Cloud 的生产构建会排除应用数据示例值,以防覆盖已有内容。



cfg - 共享数据模型访问的配置
hana - 生产构建的数据模型扩展
(添加对共享数据库表的引用)

sqlite - 本地测试的数据模型扩展
(在本地模拟共享数据库表)

csv - 模拟共享表的示例数据

src - SAP HANA 原生数据库对象

functions - 示例 SAP HANA 函数
procedures - 示例 SAP HANA 存储过程
roles - 示例 SAP HANA 模式角色
synonyms - SYS 与共享容器的同义词

data-models.cds - CAP 租户数据模型
data-types.cds - CAP 数据模型类型
undeploy.json - 取消部署配置

6. 共享数据模型

db-com 目录包含共享数据模型的定义,所有隔离的租户数据库容器都可以访问它。它用于存放所有消费方租户都需要的共享数据。在部署 SaaS 示例应用时,共享数据模型必须单独部署到一个专用的 SAP HANA Cloud HDI 数据库容器中。

提示 - 使用 Kyma 时,把共享数据模型部署到专用数据库容器的容器镜像通过 Cloud Native Buildpacks 构建,因此该目录不含单独的 Dockerfile。构建过程的更多细节见教程的其他部分(点击此处)!

csv - 共享数据模型的示例内容

src - SAP HANA 原生数据库对象

*_ACCESS.hdbrole - 供租户容器访问的角色

data-model.cds - 共享 CAP 数据模型
undeploy.json - 取消部署配置

7. 应用路由器

router 目录包含 SaaS 示例应用所需的 Application Router 全部文件。在这个场景中,只需要 xs-app.json 文件与一个健康检查。

提示 - Application Router 的 Docker 镜像构建过程使用官方 sapse/approuter Docker 镜像。构建过程的更多细节见教程的其他部分(点击此处)!

.dockerignore - docker 构建时忽略 package.json
Dockerfile - 用于 Kyma 部署、基于 sapse/approuter 的 Docker 镜像
index.js - 用于健康检查与 cookie 处理的自定义 index.js
package.json - 本地测试与 Cloud Foundry 部署需要
xs-app.json - 生产使用的路由定义

8. 注解文件

srv 目录中的 annotations 文件夹包含生成示例应用 Fiori Elements UI 所需的全部服务注解。这些注解既定义了 OData 服务的能力,也设定了 SAP Fiori Elements 用户界面的布局。

提示 - 与对 SaaS 后端服务的任何其他改动一样,如果注解文件发生变更,请务必在构建新 Docker 镜像之前运行 cds build --production!

admin - 管理服务注解
public - 用户服务注解

capabilities.cds - 服务能力注解
fieldControls.cds - 服务字段控制注解
layouts_*.cds - Fiori Elements 布局注解

labels.cds - 标签注解
valueHelp.cds - 值帮助注解

提示 - 是的,如你在其他教程中所见,这些注解文件也可以放在 UI 模块中。如果你更习惯把注解与实际 UI 组件放在一起,可以随意调整位置。

9. 业务应用服务

srv 目录的其余部分包含业务应用(即核心 SaaS 后端服务)的实现。这既包括供 Fiori Elements UI 使用的 OData 服务(admin-service.js/cds 与 user-service.js/cds),也包括在订阅新消费方租户时执行的自动化逻辑(provisioning.js)。相应的订阅服务端点通过 CAP mtxs 暴露(更多细节点击此处)。

开通自动化

许多租户开通步骤已通过平台 API 与 SAP BTP 服务实现自动化。请从 provisioning.js 文件入手,再深入各类工具,例如 kyma-utils.js,它通过调用 Kyma API Server 为新订阅方创建 API Rules。

开通自动化是代码中唯一包含 SAP BTP, Kyma 与 Cloud Foundry 两种运行时专属代码的部分。这些代码位于 utils/kyma-utils.js 与 cf-utils.js 辅助文件中,也出现在其他一些返回运行时专属类实例的模块中,示例如下。

utils/automator

export default (process.env.VCAP_APPLICATION ? CloudFoundry : Kyma)

提示 - SaaS 后端服务的 Docker 镜像通过 Cloud Native Buildpacks 构建,因此该目录不含单独的 Dockerfile。构建过程的更多细节见教程的其他部分(点击此处)!

srv - CAP 应用文件夹

annotations - 见单独章节
i18n - 语言/翻译文件
utils - 工具(主要用于自动化)

alertNotification.js - Alert Notification 工具
automator.js - 租户开通自动化
cf-utils.js - Cloud Foundry 运行时工具
cis-central.js - Cloud Management Service 工具
destination.js - Destination Service 工具
kyma-utils.js - Kyma 运行时工具
service-manager.js - Service Manager 工具
token-utils.js - Token 处理工具
user-management.js - 用户管理工具

.cdsrc.json - 生产使用的 CDS 配置
admin-service.cds - CAP 管理服务定义
admin-service.js - CAP 管理服务处理程序
annotations.cds - 注解 CDS 文件引用
provisioning.js - 租户预配处理程序
public-service.cds - CAP 用户服务定义
public-service.js - CAP 用户服务处理程序
server.js - 健康检查端点与自定义预配逻辑

.cdsrc.json - 本地与混合测试用 CDS 配置

10. 测试对象

test 目录包含用于本地开发与测试的示例数据,以及示例单元测试。

提示 - 这些文件不应包含在生产部署中,也不属于 production 构建配置。

data - 租户数据模型的示例数据
(用于本地测试的示例数据)

http - 用于测试的示例 HTTP 请求

api* - 用于 API 测试的 HTTP 请求
tenantUpgrade.http - 用于租户升级的 HTTP 请求


index.cds - 供参考的 CDS 文件
test.js - 示例单元测试

故障排除

  • Kyma ✅

  • Cloud Foundry ✅

在基础版本的这一节中,你可以找到可能有助于解决错误或问题的故障排除信息。本节内容会在未来持续完善。

  • 故障排除

      1. 部署问题

      1. Service Broker 问题

1. 部署问题

下面列出了部署可能失败的最常见原因。

1.1. 部署解决方案之前,请确保已为提供方子账户分配所有必需的权益!如果缺少某项权益,部署过程中就会遇到错误。所需权益见任务的准备提供方子账户章节(点击此处)。

1.2. 如果部署日志显示与 SAP HANA Cloud 或 HDI 容器部署相关的错误,请确保你的 SAP HANA Cloud 实例处于运行状态。使用 Free (Tier) 服务计划(例如 hana-free)时,HANA Cloud 每天会自动停止。在 SAP HANA Cloud Central 中重新启动后,请稍等几分钟再尝试新的部署。

1.3. 如果部署日志显示与 service broker 相关的错误,请确保已执行所需的 npx 脚本,为你的 service broker 生成自定义 catalog.json 文件与 broker 凭据。请务必把哈希后的凭据放到 mtaext 文件的正确位置!

  SBF_BROKER_CREDENTIALS_HASH:  >
  {
    "broker-user": "<paste your hash credentials here>"
  }

1.4. 如果部署因服务计划相关问题而失败,你很可能是在向 SAP BTP Trial 子账户部署。默认的基础版本部署描述文件包含例如 Credential Store 的 free 服务计划,而该计划在 Trial 账户中不可用。请使用相应的 MTA 扩展描述文件(trial.mtaext)进行 Trial 部署,以使用正确的服务计划(见下方片段)。

ID: susaas.trial
extends: susaas

resources:
  - name: susaas-alert-notification
    parameters:
      service-plan: standard
  - name: susaas-credstore
    parameters:
      service-plan: trial

1.5 如果你使用 SAP Business Application Studio,并因 npm registry 问题遇到部署错误,请查看这个 issue。

2. Service Broker 问题

2.1. 在删除消费方子账户之前,请确保已注销所有 Service Broker。如果你在尝试删除租户子账户时遇到下面的错误,原因很可能是租户子账户中仍有已注册的 Service Broker。

重要 - 如果相应子账户中仍注册有 Service Broker,请不要使用子账户强制删除选项!

删除子账户时因仍有 Service Broker 注册而报错的提示

要解决该问题,你需要在终端中借助 BTP CLI 运行命令。

btp list services/broker --subaccount <subaccountId-of-your-tenant-subaccount>

BTP CLI 列出子账户中已注册的 Service Broker

然后运行下面的命令,从你的 Service Broker 注销:

btp unregister services/broker --name <nameofyourbroker> --url <brokerurl> --user broker-user --password <brokerpassword>  --subaccount <subaccountId>

2.2. 如果你已经在提供方子账户中移除/卸载/取消部署了 Service Broker 应用,那么你将无法删除消费方子账户中遗留的 Service Broker 注册。这种情况下,请先重新部署解决方案(包含 Service Broker 应用),再按 2.1 所述手动注销 Service Broker。

准备提供方子账户

  • Kyma ✅

  • Cloud Foundry ✅

在本章中,你将学习如何通过分配所需权益并搭建基础组件,为部署 SaaS 示例解决方案准备好 SAP BTP 提供方子账户。这包括一个 SAP HANA Cloud 实例,你需要在部署前将其共享给你的 Cloud Foundry 环境或 Kyma Cluster。

  • 准备提供方子账户

      1. 提供方子账户的前提条件

      1. 提供方子账户的权益

      1. SAP HANA Cloud 前提条件

      1. 免费与试用服务计划的限制

      1. 更多信息

1. 提供方子账户的前提条件

如前所述,你可以在任意 SAP BTP 环境中,使用自有 Pay-as-you-Go(PAYG)或 CPEA 账户的 Free (Tier) 服务计划搭建示例应用的基础版本。关于如何设置 PAYG 账户(允许你使用所有 Free Tier 服务计划)的教程,见 Tutorial Navigator。

提示 - 虽然在 Trial 账户中也可以搭建,但我们强烈建议在 PAYG 或 CPEA 账户中使用 free tier 服务计划。这样你将来可以切换为付费服务计划。如果你决定使用 Trial 环境,请务必选择 us10 区域,以便使用 SAP HANA Cloud。

请确保满足以下前提条件:

Cloud Foundry(仅此场景)

  • 在 Free Tier 场景中,请使用 free 服务计划创建你的 SAP BTP Cloud Foundry 环境(如果看不到,请在 Entitlements 中分配!)。

    重要 - 请务必使用 free 计划(而不是 Standard 计划)创建你的 SAP BTP Cloud Foundry 运行时。
    重要 - 请确保你的 Organization 与 Space 名称不含空格、特殊字符("-" 除外)或大写字母! 提示 - 在 Trial 环境中,正确的权益(MEMORY 服务计划)会自动分配到你的默认子账户。

Kyma(仅此场景)

  • 在 Free Tier 场景中,请使用 free 服务计划设置 SAP BTP Kyma Runtime(如果看不到,请在 Entitlements 中分配!)。

    提示 - 如需帮助,请遵循 SAP Tutorial Navigator 中的官方文档(点击此处)。 提示 - 在 Trial 环境中,你必须为子账户分配 trial 服务计划。

通用(Kyma 与 Cloud Foundry)

  • 使用 SAP HANA Cloud Tools(tools 服务计划)搭建一个 SAP HANA Cloud 实例(hana-free 服务计划)。

    提示 - 在 Trial 环境中,你必须为子账户分配 hana 服务计划。
    提示 - 查看下面这篇博客,了解使用 HANA Tools 搭建 SAP HANA Cloud 实例的更多细节(点击此处)。

重要 - 在 PAYG 或 CPEA 场景中,请务必选择正确的免费服务计划,因为付费服务计划会在你的账户中产生费用!

使用 hana-free 等部分 SAP BTP 服务计划时,请查看下文提到的限制。此外请注意,hana-free 服务计划并非在所有 SAP BTP 区域都可用。你可以在 SAP Discovery Center 中查看可用性(点击此处)。

2. 提供方子账户的权益

应用在提供方子账户中需要以下 SAP BTP 权益集合:

Kyma

服务 / 订阅

Free Tier / (Trial) 计划

Destination Service

Lite

SAP Alert Notification service for SAP BTP

Free / (Trial: Lite)

SAP Application Logging Service

Lite

SAP Authorization and Trust Management Service

Broker
Application

SAP BTP, Kyma Runtime

Free / (Trial: Trial)

SAP Cloud Management Service for SAP BTP

Central

SAP HTML5 Application Repository Service for SAP BTP

App-host
App-runtime

SAP Software-as-a-Service Provisioning service

Application

SAP HANA Cloud

hana-free (Trial: hana)
tools

SAP HANA Schemas & HDI Containers

hdi-shared

SAP Service Manager

Container
Subaccount-Admin

Cloud Foundry

提示 - 本用例 1GB 的 Cloud Foundry 运行时即可满足需求。

服务 / 订阅

Free (Tier) / (Trial) 计划

Application Autoscaler

Standard

Destination Service

Lite

SAP Alert Notification service for SAP BTP

Free / (Trial: Lite)

SAP Application Logging Service

Lite

SAP Authorization and Trust Management Service

Broker
Application

SAP BTP, Cloud Foundry Runtime

Free / (Trial: MEMORY)

SAP Cloud Management Service for SAP BTP

Central

SAP Credential Store

Free / (Trial: Trial)

SAP HTML5 Application Repository Service for SAP BTP

App-host
App-runtime

SAP SaaS Provisioning Service

Application

SAP HANA Cloud

hana-free / (Trial: hana)
tools

SAP HANA Schemas & HDI Containers

hdi-shared

SAP Service Manager

Container
Subaccount-Admin

如果你需要帮助为提供方子账户分配权益,可以在此处找到相关信息。

3. SAP HANA Cloud 前提条件

提示 - 想总体了解 SAP HANA Cloud,请查看下面的学习路径(点击此处)。

如果尚未创建,请在提供方子账户中创建一个 SAP HANA Cloud 实例,或者共享同一 SAP BTP 区域(例如 eu10)内其他子账户中已有的 SAP HANA Cloud。任何与你的 Cloud Foundry 环境或 Kyma Cluster 处于同一区域的 SAP HANA Cloud 实例,都可以启用后在提供方子账户中使用。

创建 SAP HANA Cloud 实例后,请使用 Instance Mapping 功能把它与你的 Cloud Foundry 环境或 Kyma Cluster 映射起来。你既可以把 SAP HANA Cloud 实例映射到 Kyma Cluster 中的所有命名空间,也可以提供专用的命名空间名称。Cloud Foundry 同理,你可以把 SAP HANA Cloud 实例映射到整个 Organization 或某个特定 Space。

Kyma(仅此场景)

关于如何把 SAP HANA Cloud 实例共享给 Kyma Cluster 的更多信息,见下面这篇博客(点击此处)。

重要 - 请务必为此使用新的 SAP HANA Cloud Tools 服务(服务计划 tools)!SAP HANA Cloud Central UI 中不提供面向 Kyma 的实例映射功能。

在 Kyma 中通过 SAP HANA Cloud Tools 映射 SAP HANA Cloud 实例

Cloud Foundry(仅此场景)

关于如何把 SAP HANA Cloud 实例共享给 Cloud Foundry 环境的更多信息,见下面的 SAP Help 文档(点击此处)。SAP HANA Cloud Tools 也提供类似功能,同样可以用它把已有的 SAP HANA Cloud 实例映射到你的 Cloud Foundry 环境。

在 Cloud Foundry 中通过 SAP HANA Cloud Tools 映射 SAP HANA Cloud 实例

4. 免费与试用服务计划的限制

使用 free 类 SAP BTP 服务计划(例如 Kyma 的 trial 或 SAP HANA Cloud 的 hana-free)时,请注意以下限制:

Kyma(仅此场景)

  • 在 trial、PAYG 与 CPEA 账户中,你的免费 Kyma Cluster 都有较为严格的资源限制。部署示例应用前,请确保还有足够的剩余资源。更多细节见 Discovery Center(点击此处了解)。

  • SAP BTP Kyma 的 trial 服务计划仅可使用 14 天(点击此处)。超过该期限后,你需要重新搭建 SAP BTP Kyma Cluster。使用 free tier 服务计划的 CPEA 或 PAYG 账户没有这一限制。因此我们强烈建议使用 PAYG 或 CPEA 账户并配合 free tier 服务计划。

Cloud Foundry(仅此场景)

  • trial 环境中的所有 Cloud Foundry 工作负载每天都会被停止,以减少资源消耗。使用 SaaS 场景之前,请检查(必要时重新启动)你的应用。

通用(Kyma 与 Cloud Foundry)

  • 免费 SAP HANA Cloud 实例每天都会被停止,以减少资源消耗。使用 SaaS 场景之前,请检查(必要时重新启动)你的 SAP HANA Cloud 实例。此外,你有 30 天时间重新启动实例,否则实例会被删除。

5. 更多信息

请通过下面的链接了解上述主题的更多信息:

Cloud Foundry - 构建并部署 SaaS 应用

  • Kyma ❌

  • Cloud Foundry ✅

重要 - 本部分教程仅适用于 Cloud Foundry 部署!

在把示例应用部署到你的 Cloud Foundry 环境之前,你需要构建项目,并完成一些出于安全考虑所必需的基本步骤。 部署完成后,请确保所需的凭据值已存储在部署期间创建的 SAP Credential Store 中。

  • Cloud Foundry - 构建并部署 SaaS 应用

      1. 为部署准备 SaaS 应用

      1. 设置 Credential Store

      1. 故障排除

      1. 更多信息

1. 为部署准备 SaaS 应用

我们先来准备代码库。在开始构建并部署到提供方子账户之前,你需要在代码库中做一些自定义调整。

1.1. (Fork 并)克隆本仓库,切换到 deploy 目录,在那里可以找到一个名为 cf 的文件夹,其中包含 Cloud Foundry 部署所需的全部对象。

git clone https://github.com/SAP-samples/btp-cap-multitenant-saas
cd deploy/cf

1.2. 在 config 目录中的 Alert Notification 服务配置文件 alert-notif.json 里,提供一个接收通知的邮箱地址。

提示 - 你也可以创建一个 alert-notif-private.json 文件,或重命名现有文件,这样你的详细信息就不会被提交到 GitHub。这种情况下,请务必相应调整 mta.yaml 文件,或在 mtaext 文件中添加相应引用(见后续步骤)。

在 Alert Notification 服务配置文件中填写接收通知的邮箱地址

1.3. 请在 deploy/cf 目录下运行以下 npm 脚本,为你的 service broker 实例创建唯一的 catalog ID 与凭据。

npx --yes -p @sap/sbf hash-broker-password -b
npx --yes -p @sap/sbf gen-catalog-ids ../../code/broker/catalog.json

1.4. 完成上一步后请注意,你的唯一 ID 已被写入 /code/broker/catalog.json,并且你应该会看到与下面截图类似的输出。请妥善保存明文密码以备后用,并复制下面高亮显示的哈希后凭据。

重要 - 请务必把哈希后凭据与明文密码保存在安全的地方,生产场景中尤其如此。你本人以及其他 SAP BTP 平台管理员应能随时访问!本场景中对应的用户是 broker-user。

生成 broker 凭据后终端中输出的哈希凭据与明文密码

1.5. 为防止哈希后的凭据被提交到 GitHub,请先复制 free-basic.mtaext 或 trial-basic.mtaext 文件(取决于你的目标环境),并在文件名后加上 -private(例如 free-basic-private.mtaext)。

重要 - 以 *-private.mtaext 命名的文件会被 Git 忽略。

在文件列表中创建 private 后缀的 MTA 扩展描述文件

1.6. 把哈希后的凭据值粘贴到你刚创建的 private 部署描述文件 MTA Extension 中。如前所述,我们强烈建议为此使用 private 的 MTA 扩展描述文件,以免被误推到 Git。

把哈希后的 broker 凭据粘贴到 private MTA 扩展描述文件

提示 - 如果你为 Alert Notification 创建了私有配置文件(alert-notif-private.json),也请按下面的示例把它相应地包含到 mtaext 文件中!

resources:
 - name: susaas-alert-notification
   parameters: 
     service-plan: standard
     path: ./config/alert-notif-private.json

1.7. 从 deploy/cf 目录构建你的项目。请确保引用你的 MTA 扩展描述文件,可以在构建时引用,也可以在稍后部署时引用!

提示 - 如果你要把解决方案部署到试用环境,请务必使用针对试用场景的 mtaext 文件。

示例

$ mbt build -e ./mtaext/free-basic-private.mtaext
$ cf deploy mta_archives/susaas_0.0.1.mtar

1.8. 请运行下面的命令,把 SaaS 应用部署到你的提供方子账户。如果构建过程中尚未引用你的 MTA 扩展描述文件,请务必在这里引用!如果已在构建时引用,则可以跳过这个额外参数。

$ cf deploy mta_archives/<your_mtar_file> -e <path of your MTA Extension Descriptor file>

示例

$ cf deploy mta_archives/susaas_0.0.1.mtar -e ./mtaext/free-basic-private.mtaext

1.9. 部署 Alert Notification 服务实例后,你的收件箱中应该会收到一封邮件,要求你确认愿意接收来自 Alert Notification 的消息。请相应地确认该请求。

提示 - 如果你没有收到邮件,请确认已成功完成本章的步骤 1.2.。如果没有,请重复前面的步骤,或修改现有 Alert Notification 服务实例中的收件人。也请检查你的垃圾邮件文件夹。

Alert Notification 发送的确认邮件

1.10. 部署完成后,你基本就可以开始使用了。为支持创建路由、在消费方子账户中部署 API Service Broker 等自动化步骤,在设置第一个消费方子账户之前,请务必不要漏掉下一步。

2. 设置 Credential Store

在学习下一部分中如何订阅新租户之前,你需要在 Credential Store 中提供两个凭据。这两个凭据对自动化订阅流程的某些环节至关重要。

2.1. 在提供方子账户中,请进入 Instances and Subscriptions 菜单,点击你的 <SpaceName>-susaas-credstore 实例,或使用 Manage Instance 按钮。

在 Instances and Subscriptions 页面中点击 Credential Store 实例以打开实例管理页面

2.2. 在实例管理中,请切换到 Credential Store 菜单,然后点击 Create Namespace。

在 Credential Store 的实例管理页面中点击 Create Namespace 按钮创建命名空间

2.3. 命名空间需要与第一个凭据值一起创建。因此请选择凭据类型 Password,然后点击 Next。

创建命名空间时选择 Password 凭据类型

2.4. 在接下来的页面中,定义名为 susaas 的命名空间,并提供以下凭据值细节。

Name:btp-admin-user

Value & Username:

提供一个用于自动化用途的 SAP BTP 用户的邮箱地址(Username)与密码(Value)。请确保该用户在你的提供方子账户中具有 Subaccount Administrator 角色集合,并在相应的 Cloud Foundry Space 中具有 Space Developer 角色。用于测试目的时,你当前使用的用户就足够了。

提示 - 如果你不想为此使用个人/具名用户,我们建议使用自定义 IdP,并在其中定义一个技术用户。使用 P 或 S 用户执行技术任务是可行的,但 SAP 尤其不推荐在生产场景中这样做。

管理中为 btp-admin-user 凭据值填入管理员用户的邮箱地址与密码

2.5. 请按下文所述创建第二个 Password 凭据值。

Name:susaas-broker-credentials

Value & Username:

Value 请填入你的 API broker 用户的明文密码。在自动化过程中向任一消费方子账户注册 API broker 时,都需要这个密码。

提示 - 你已在“为部署准备 SaaS 应用”的步骤 1.4 中创建了该密码。
终端输出中显示的 broker 明文密码,请复制后妥善保存

Username 请使用 broker-user。

为 susaas-broker-credentials 凭据值填入 broker-user 作为用户名

3. 故障排除

故障排除请查看单独的故障排除章节(点击此处)。

4. 更多信息

请通过下面的链接了解上述主题的更多信息:

Kyma - 构建、打包并推送 Docker 镜像

  • Kyma ✅

  • Cloud Foundry ❌

重要 - 本部分教程仅适用于 Kyma 部署!

如你所知,Kubernetes(因此也包括 Kyma)的核心就是工作负载的容器化。我们的应用也不例外,因此在用 Helm 把 SaaS 示例应用部署到 Kyma Cluster 之前,你需要先构建并容器化各个组件(UI 模块、CAP 应用、Application Router 等):把它们打包成 Docker 镜像,并把该镜像推送到自选的镜像仓库,例如 DockerHub。这正是接下来这一章要讲的内容!

  • Kyma - 构建、打包并推送 Docker 镜像

      1. 前提条件

      1. 构建组件

      1. 创建 Docker 镜像

      1. 构建细节

      • API 服务(api)

      • 后端服务(srv)

      • 应用路由器(router)

      • API Service Broker(broker)

      • HTML5 Apps Deployer(app/html5-deployer)

      • HDI 容器部署器(db-com)

      1. 推送 Docker 镜像

      1. 更多信息

我们先简要看一下工具前提条件,它们是构建并推送容器化组件的必备条件。

如果你在教程接下来的步骤中遇到任何问题,欢迎查阅优秀的开发者教程《Deploy Your CAP Application on SAP BTP Kyma Runtime》。它描述了类似步骤,如果你在示例场景中卡住,它能提供非常详细的指导。

官方开发者教程链接(SAP Tutorials):https://developers.sap.com/tutorials/remote-service-deploy-with-mock-kyma.html

1. 前提条件

首先,你需要在设备上安装 Node.js。最新 LTS(长期支持)版本见此处。要完成接下来的步骤,你还需要在设备上安装以下工具。请根据你的系统环境遵循链接中的说明。

  • Docker(https://docs.docker.com/get-docker/)- 要在 Kyma 上跟随本教程操作,你需要一个能在本机处理容器镜像的应用,支持构建、推送、拉取与运行镜像等功能。

  • Pack CLI(https://buildpacks.io/docs/install-pack/)- 借助 Pack,你可以基于社区共同维护的基础镜像构建容器镜像,从而让镜像的维护与更新更加简单。

    安装快捷命令
    MacOS - brew install buildpacks/tap/pack
    Windows - choco install pack

  • 必须安装 Make。

    安装快捷命令
    MacOS - brew install make
    Windows - choco install make

重要 - 请务必遵守相应的许可协议,在企业环境中使用 Docker 时尤其如此!

继续之前,请确保能在命令行中成功执行以下命令。请新建一个命令行实例来测试这些命令,这样可以确认 Docker 与 Pack CLI 已加入环境变量。如果出现错误,请确认你已遵循所提供说明的全部步骤。

> docker
A self-sufficient runtime for containers
...
> pack
CLI for building apps using Cloud Native Buildpacks
...
> make
CLI for executing Makefiles
...

此外,请确保你能访问自选的容器镜像仓库(例如 DockerHub)。你可以使用下面的 Docker CLI 命令登录镜像仓库。关于登录要求,请查阅你所选镜像仓库提供方的文档。

提示 - 如果你还没有可用的镜像仓库,可以在 DockerHub 上创建一个新的(免费)账户(点击此处),或选择 AWS、Azure、GCP 等超大规模云厂商的镜像仓库。另外,你也可以使用 GitHub 存储和管理 Docker 镜像(了解更多)。

重要 - 请注意,DockerHub 等免费服务提供方只允许存储有限数量的私有 Docker 镜像。如果你的 Docker 容器包含敏感信息(本不应包含)或知识产权,请务必选择能为你的用途创建私有 Docker 镜像的服务计划或提供方!

> docker login
...
Login Succeeded

成功安装所需工具(Docker 与 Pack)并登录镜像仓库后,你就可以继续下一步了。

2. 构建组件

在把 SaaS 示例应用容器化为 Docker 镜像之前,我们先构建它的各个组件。

2.1. 使用下面的命令(Fork 并)把示例 GitHub 仓库克隆到你的开发环境。切换到 deploy/kyma 目录,其中包含 Kyma 部署所需的全部对象。

git clone https://github.com/SAP-samples/btp-cap-multitenant-saas
cd code

2.2. 使用 Makefile 执行一次初始构建

## Run in ./code ## 
make install
make build 

信息 - 这会构建你的 CAP 与 UI 应用。

你也可以分别构建各个应用。查看 Makefile 了解所有可用命令。

make cds-build ## runs cds build
make ui-build ## builds UI apps

就是这样!需要单独构建步骤的应用组件(CAP 与 UI5)已处理完毕,现在可以把它们容器化为容器镜像了。

3. 创建 Docker 镜像

在 Cloud Foundry 中,部署前并不要求先把应用组件容器化;而在 Kyma(即 Kubernetes)中,这一步需要你自己处理。这听起来很复杂,但我们已尽可能为你简化流程!

容器化是必需的,因为部署到集群时,Helm 会拉取示例应用各组件的 Docker 镜像。这涉及以下应用组件的 Docker 镜像:

  • API 服务(Pod)

  • API Service Broker(Pod)

  • 应用路由器(Pod)

  • 后端服务(Pod)

  • HTML5 Apps Deployer(Job)

  • HDI 容器部署器(Job)

以下步骤会把这些组件容器化为 Docker 镜像。为简化这一过程,我们依赖 SAP 标准 Docker 镜像或所谓的 Cloud Native Buildpacks。使用 Cloud Native Buildpacks 相比自行创建和维护 Dockerfile 能省下大量精力。你将始终使用 Cloud Native Buildpacks 项目提供的最新镜像,该项目也是 Cloud Native Computing Foundation 的一部分。如果你刚接触 Kubernetes 这类主题,我们强烈建议浏览这两个页面以了解更多!

重要 - 想了解更多关于各组件 Docker 镜像如何构建的内容,请阅读本章的下一部分。

3.1. 运行下面的命令(在 ./code 目录中执行),它将使用 SAP 标准 Docker 镜像与 Cloud Native Buildpacks 构建所有 Docker 镜像。

提示 - 如果你使用 DockerHub 作为镜像仓库,请把你的用户名(例如 johndoe)作为容器镜像前缀占位符填入。如果你使用 GitHub Container Registry,前缀形如 ghcr.io/<namespace>(例如 ghcr.io/johndoe)。所有生成的 Docker 镜像都会自动加上该前缀!

提示 - 在使用 ARM 芯片的设备(例如 Apple M1)上,涉及 Cloud Native Buildpacks 的构建过程可能需要数分钟。如果看起来像卡住了,请不要立即取消构建,稍等一段时间让进程继续(尤其是在生成 SBOM 时)!

## Run in ./code ## 
make pack IMAGE_PREFIX=<yourimageprefix>

你可以通过执行下面的命令检查镜像:

docker images | grep 'susaas'

REPOSITORY                            TAG       IMAGE ID       CREATED          SIZE
<yourimageprefix>/susaas-router            latest    86a62f1a4d93   2 hours ago    206MB
<yourimageprefix>/susaas-html5-deployer    latest    abd43b42d0f0   2 hours ago    152MB
<yourimageprefix>/susaas-broker            latest    86f9e9a2dfd3   45 years ago   326MB
<yourimageprefix>/susaas-api               latest    bec89f6ebee5   45 years ago   392MB
<yourimageprefix>/susaas-db-com            latest    ebe1bb0a9543   45 years ago   342MB
<yourimageprefix>/susaas-srv               latest    17396229554c   45 years ago   393MB

你也可以逐个容器化各个应用。

## Run in ./code ## 
make pack-srv IMAGE_PREFIX=<yourimageprefix> ## containerize only srv module
make pack-db-com IMAGE_PREFIX=<yourimageprefix> ## containerize only db-com deployer
make pack-api IMAGE_PREFIX=<yourimageprefix> ## containerize only db-com deployer
make pack-broker IMAGE_PREFIX=<yourimageprefix> ## containerize only service broker
make pack-router IMAGE_PREFIX=<yourimageprefix> ## containerize only approuter
make pack-html5-deployer IMAGE_PREFIX=<yourimageprefix> ## containerize only ui apps and deployer

4. 构建细节

如前所述,我们的示例应用使用不同的构建工具与方法创建所需的 Docker 镜像,分别是 Paketo 搭配 Cloud Native Buildpacks,以及官方的 SAP 标准 Docker 镜像。本部分教程将为你提供各组件 Docker 镜像构建过程的高层概览。乍看之下,为什么要用两种不同的方式来构建所需的 Docker 镜像可能会让人困惑,其实解释起来相当简单。

为 Kubernetes 工作负载编写 Dockerfile 并不总是容易,对刚接触这块的初学者尤其如此!而且 Dockerfile 的维护也很耗时。因此,只要我们能省去这份责任、改用厂商维护的 Docker 镜像(例如 SAP 提供的标准 Docker 镜像),就会优先采用。对于 SAP 没有提供标准 Docker 镜像的其余组件,或这样做没有意义的场景(例如自定义 Node.js 应用),我们则使用 Paketo 与 Cloud Native Buildpacks。

再次强烈建议你抽空休息一下,浏览 Maximilian Streifeneder 的优秀博客文章,它既讲解了 Paketo 主题,也分享了一些进一步分析所生成 Docker 镜像的小技巧!

社区博客文章链接(SAP Community,SAP 官方技术博客文章):https://community.sap.com/t5/technology-blogs-by-sap/surviving-and-thriving-with-the-sap-cloud-application-programming-model/ba-p/13570264

使用 Paketo 与 Cloud Native Buildpacks 创建的 Docker 镜像安全、高效、可用于生产,并自带大量特性,这些特性用 Dockerfile 很难提供,且需要更多手工投入。想了解 Cloud Native Buildpacks 提供的特性,请查看官方文档(点击此处)。想了解 Cloud Native Buildpacks 背后的基本概念(把源代码变成开箱即用的 Docker 镜像),请查看相应文档(点击此处)。

介绍就到这里。现在我们来看看,SaaS 示例应用的不同组件是如何分别用 Paketo 与 Cloud Native Buildpacks,或现有的 SAP 标准 Docker 镜像完成容器化的。

API 服务(api)

使用 Paketo 与 Cloud Native Buildpacks 构建

由于 API 服务基于 CAP 与 Node.js,首次构建或任何变更后,你都需要先运行 cds build --production。运行 CDS 构建(编译 CAP 后端、CAP API、租户数据模型与共享数据模型的 CDS 文件)之后,API 服务的 Docker 镜像便通过 Paketo 与 Cloud Native Buildpacks 构建。

这简化了容器化过程,让你无需为 Node.js 工作负载维护单独的 Dockerfile 就能构建 Docker 镜像。在构建过程中,Paketo 会把 gen/api 目录的内容放入 Node.js Docker 镜像的工作目录。该镜像基于最新且稳定的 Cloud Native Buildpacks。

使用 Paketo 构建 Docker 镜像的 make 命令(/code/Makefile)

make pack-api IMAGE_PREFIX=<yourimageprefix>

这个 make 命令在底层为你运行以下命令。

pack build $(IMAGE_PREFIX)/susaas-api --path gen/api \ 
--builder paketobuildpacks/builder-jammy-base \ 
--buildpack paketo-buildpacks/nodejs -e \
BP_LAUNCHPOINT=./node_modules/@sap/cds/bin/serve.js

提示 - paketobuildpacks/builder-jammy-base 提供一个基于 Ubuntu 的最小 Docker 镜像,并额外加入了少数软件包(即所谓的 “mixins”)(更多细节点击此处)。

后端服务(srv)

使用 Paketo 与 Cloud Native Buildpacks 构建

由于核心后端服务同样基于 CAP,首次构建或任何变更后,你都需要先运行 cds build --production。运行 CDS 构建(编译 CAP 后端、CAP API、租户数据模型与共享数据模型的 CDS 文件)之后,后端服务同样使用 Paketo 与 Cloud Native Buildpacks 创建 Docker 镜像。

这样做(与 API 服务相同)无需维护单独的 Dockerfile 就能构建 Docker 镜像。在构建过程中,Paketo 会取出 gen/srv 目录的内容,并放入 Node.js Docker 镜像的工作目录。同样,该镜像基于最新且稳定的 Cloud Native Buildpacks。

使用 Paketo 构建 Docker 镜像的 make 命令(/code/Makefile)

make pack-api IMAGE_PREFIX=<yourimageprefix>

这个 make 命令在底层为你运行以下命令。

pack build $(IMAGE_PREFIX)/susaas-srv --path gen/srv \ 
--builder paketobuildpacks/builder-jammy-base \ 
--buildpack paketo-buildpacks/nodejs -e \
BP_LAUNCHPOINT=./node_modules/@sap/cds/bin/serve.js

应用路由器(router)

使用 SAP 提供的标准 Docker 镜像构建

应用路由器的 Docker 镜像基于 SAP 的标准 sapse/approuter Docker 镜像,可在 Docker Hub 中找到(https://hub.docker.com/u/sapse)。由于这个官方 Docker 镜像由 SAP 优化并维护,因此无需使用 Cloud Native Buildpacks 来获得稳定、安全且最新的基础镜像。

因此,我们创建了一个极简的 Dockerfile,它使用 SAP 官方 Docker 镜像(sapse/approuter),只把我们的静态 Application Router 资源添加到该镜像的工作目录。在这个场景中,自定义 Dockerfile 的作用是把 router 目录的全部内容(package.json 除外,它属于 .dockerignore 文件)复制到生成的 Docker 镜像中。

提示 - package.json 文件仅用于目录中的本地测试。由于 SAP 维护的 Docker 镜像 sapse/approuter 已包含 package.json 文件,我们将复用这个 SAP 提供的 package.json 中的 start 脚本。

基于 sapse/approuter Docker 镜像的 Dockerfile(/code/router/Dockerfile)

# Image based on SAP provided sapse/approuter image
# Make sure to update the Docker Image version regularly
FROM sapse/approuter:x.x.x

# Create an app directory (in case not there yet)
RUN mkdir -p /app
# Grant default non-root user ("node") permissions
RUN chown node.node /app

# Set working directory for COPY and CMD command
WORKDIR /app

# Copy local directory where Dockerfile resides to Docker Image
# -> Includes the resources folder and the xs-app.json file
COPY . .
# Run npm start script to start the Application Router
CMD [ "npm", "start" ]

基于上述 Dockerfile 构建 Docker 镜像(/code/Makefile)

提示 - 下面的 make 命令会基于位于 /code/router 目录的 Dockerfile 构建 Docker 镜像,并将其标记为 sap-demo/susaas-router。如果你想单独运行这条命令,“sap-demo” 需要替换为步骤 3.1 中使用的同一前缀。

make pack-router IMAGE_PREFIX=<yourimageprefix>

这个 make 命令在底层为你运行以下命令。

docker build -t $(IMAGE_PREFIX)/susaas-router ./router

API Service Broker(broker)

使用 Paketo 与 Cloud Native Buildpacks 构建

对于 API Service Broker(实际上只是基于 @sap/sbf npm 模块的一个通用 Node.js 工作负载,详情点击此处),同样使用 Paketo 与 Cloud Native Buildpacks 构建所需的 Docker 镜像。

这样(与 API 服务和 SaaS 后端服务相同)无需维护单独的 Dockerfile 即可构建 Docker 镜像。在构建过程中,Paketo 会取出 broker 目录的内容,并放入 Node.js Docker 镜像的工作目录。该 Docker 镜像同样基于最新的 Cloud Native Buildpacks。

使用 Paketo 构建 Docker 镜像的 make 命令(./code/Makefile)

make pack-broker IMAGE_PREFIX=<yourimageprefix>

这个 make 命令在底层为你运行以下命令。

pack build $(IMAGE_PREFIX)/susaas-broker --path ./broker \ 
--builder paketobuildpacks/builder-jammy-base \ 
--buildpack paketo-buildpacks/nodejs -e \
BP_LAUNCHPOINT=./start.js

HTML5 Apps Deployer(app/html5-deployer)

使用 SAP 提供的标准 Docker 镜像构建

我们示例的 HTML5 Apps Deployer Docker 镜像(与应用路由器一样)基于 SAP 官方的 sapse/html5-app-deployer Docker 镜像,可在 Docker Hub 中找到(https://hub.docker.com/u/sapse)。HTML5 Apps Deployer 的用途其实相当简单。它基于一个 npm 包(详情点击此处),该包会取出我们打包成 zip 的 UI5 模块,并把它们部署到 HTML5 App Repository 服务中,该服务会绑定到相应的 Kyma 工作负载。

由于这个 Docker 镜像由 SAP 维护,因此无需使用 Cloud Native Buildpacks 来获得稳定、安全且最新的基础镜像。所以我们创建了一个基于 SAP 官方 Docker 镜像(sapse/html5-app-deployer)的 Dockerfile,只把我们自己的 resources 文件夹添加到生成的 Docker 镜像的工作目录。

resources 文件夹(位于 code/app/html5-deployer 目录中)包含打包成 zip 的 UI5 模块(你需要先用 npm run ui:apps 脚本构建它们——见此处)。如果你已按前面的教程步骤操作,相应的 zip 文件应该已经存在,因为相应命令会自动运行各 UI5 模块 package.json 文件中的 build 脚本。

触发单个 UI 模块构建的 make 命令(/code/Makefile)

make ui-admin-projects

构建 UI 模块并把 zip 复制到 html5 app deployer 的 npm 脚本(/code/app/ui-admin-projects/package.json)

"scripts": {
    "build:copy": "npm run build && npm run copy",
    "build": "ui5 build preload --clean-dest --config ui5-deploy.yaml --include-task=generateCachebusterInfo",
    "copy": "shx mkdir -p ../html5-deployer/resources/ && shx cp -rf ./dist/*.zip ../html5-deployer/resources/"
}

与应用路由器类似,位于 code/app/html5-deployer 文件夹中的 Dockerfile 会把 html5-deployer 目录的内容复制到生成的 Docker 镜像的工作目录,该镜像基于 SAP 维护的 sapse/html5-app-deployer 镜像。

提示 - package.json 文件仅用于 code/app/html5-deployer 目录中的本地测试。由于 Docker 基础镜像 sapse/html5-app-deployer 已包含相应的 package.json 文件,我们将复用这个 SAP 提供的 package.json 中的 start 脚本。

基于 sapse/html5-app-deployer Docker 镜像的 Dockerfile(/code/app/Dockerfile)

# Image based on SAP provided sapse/html5-app-deployer image
# Make sure to update the Docker Image version regularly
FROM sapse/html5-app-deployer:x.x.x

# Create the app directory (in case not there yet)
RUN mkdir -p /app
# Grant default non-root user ("node") permissions
RUN chown node.node /app

# Set the working directory for COPY and CMD command
WORKDIR /app

# Copy the directory where Dockerfile resides to the Docker Image
# -> Includes the resources directory with the zipped UI5 modules
COPY . .
# Run npm start script to start the Application Router
CMD [ "npm", "start" ]

基于上述 Dockerfile 构建 Docker 镜像(/code/Makefile)

make pack-html5-deployer IMAGE_PREFIX=<yourimageprefix>

这会在底层为你运行以下命令。

docker build -t $(IMAGE_PREFIX)/susaas-html5-deployer ./app

HDI 容器部署器(db-com)

使用 Paketo 与 Cloud Native Buildpacks 构建

由于共享数据库容器的数据模型同样基于 CAP,首次构建或任何变更后,你都需要先运行 cds build --production。租户专属数据模型会在订阅时自动部署到隔离的 HDI 容器,而共享数据模型则必须单独部署(到一个专用 HDI 容器)。因此,这个 Docker 镜像使用默认的 @sap/hdi-deploy npm 包(详情点击此处)。

运行 CDS 构建(编译 CAP 后端、CAP API、租户数据模型与共享数据模型的 CDS 文件)之后,所需的 Docker 镜像(包含共享数据模型的 HDI 部署器)通过 Paketo 与 Cloud Native Buildpacks 构建。这简化了构建过程,让我们无需维护单独的 Dockerfile 就能构建 Docker 镜像。在构建过程中,Paketo 会取出 gen/db-com 目录的内容,并放入 Node.js Docker 镜像的工作目录。该镜像基于最新的 Cloud Native Buildpacks。

使用 Paketo 构建 Docker 镜像的 make 命令(/code/Makefile)

make pack-db-com IMAGE_PREFIX=<yourimageprefix>

这会在底层为你运行以下命令

pack build $(IMAGE_PREFIX)/susaas-db-com --path ./gen/db-com --builder paketobuildpacks/builder-jammy-base --buildpack paketo-buildpacks/nodejs -e BP_LAUNCHPOINT=./node_modules/@sap/hdi-deploy/deploy.js

到这里,你应该已经清楚了解容器化 SaaS 应用组件所用的不同方法了。接下来我们继续看看如何把 Docker 镜像推送到镜像仓库。

5. 推送 Docker 镜像

为了让 Helm 在部署过程中能够拉取你的 Docker 镜像,你需要把它们推送到自选的镜像仓库。

提示 - 如果你使用的是非公开的 Docker 仓库,我们假定你知道如何处理所需的 secret 或访问码。这类场景下,你可能需要调整 Helm chart 的 values.yaml 文件。使用方式请查看官方 CAP 文档。

在所有 Docker 镜像都通过 Cloud Native Buildpacks 或 SAP 标准镜像构建完成后,你可以把它们推送到镜像仓库。为此,请确保在运行以下 npm 脚本前已成功登录你所选的仓库(docker login)。

提示 - 如果你使用 DockerHub 作为镜像仓库,请把你的用户名(例如 johndoe)作为容器镜像前缀占位符填入。如果你使用 GitHub Container Registry,前缀形如 ghcr.io/<namespace>(例如 ghcr.io/johndoe)。所有生成的 Docker 镜像都会自动加上该前缀!

## Run in ./code ## 
make push-all IMAGE_PREFIX=<ContainerImagePrefix>

# Example
make push-all IMAGE_PREFIX=sap-demo

除了一次性推送所有 Docker 镜像,你也可以运行组件专属的 make 命令来分别推送镜像。详情见 Makefile。

提示 - 如果你只更新了单个 Docker 镜像,这样做可以节省时间。

## Run in ./code ## 
make push-srv IMAGE_PREFIX=<ContainerImagePrefix> 

# Example
make push-srv IMAGE_PREFIX=sap-demo 

好了,就是这样!npm 脚本执行完成后,你的 Docker 镜像应该已位于镜像仓库中。你已成功容器化所有应用组件,可以开始把 SaaS 示例应用部署到 Kyma Cluster 了。让我们进入实际的部署环节!

6. 更多信息

请通过下面的链接了解上述主题的更多信息。

Kyma - 部署 SaaS 应用

  • Kyma ✅

  • Cloud Foundry ❌

重要 - 本部分教程仅适用于 Kyma 部署!

在把示例应用部署到 SAP BTP, Kyma Runtime 之前,请确保已完成上一个教程章节。你的 Docker 镜像必须已存在于镜像仓库中,这样 Helm 才能在接下来的部署过程中访问并拉取它们。

  • Kyma - 部署 SaaS 应用

      1. 简介

      1. 创建新的 Kyma 命名空间

      1. 准备 Helm 部署

      1. 部署到 Kyma Cluster

      1. 多次部署

重要 - 只要发布名称(Release Name)、Kyma 命名空间或 Kyma Cluster 中有一项不同,示例应用就可以多次部署。最后一种情况下,集群必须位于不同的 SAP BTP 子账户中(因为角色集合名称会冲突)。

如果你在教程接下来的步骤中遇到任何问题,欢迎查阅优秀的开发者教程《Deploy Your CAP Application on SAP BTP Kyma Runtime》。它描述了类似步骤,如果你在示例场景中卡住,它能提供非常详细的指导。

官方开发者教程链接(SAP Tutorials):https://developers.sap.com/tutorials/remote-service-deploy-with-mock-kyma.html

1. 简介

Sustainable SaaS 解决方案向 SAP BTP Kyma Cluster 的部署由 Helm 负责。想了解 Helm 的基本概念,请访问教程的相应章节(点击此处)。再重复一次,我也建议阅读并细品 Maximilian Streifeneder 关于 Kyma、Helm、Paketo 等主题的精彩博客文章!如果你是 Kubernetes、Docker 与 Kyma 世界的新手,它能给你很好的概览与入门!

社区博客文章链接(SAP Community,SAP 官方技术博客文章):https://community.sap.com/t5/technology-blogs-by-sap/surviving-and-thriving-with-the-sap-cloud-application-programming-model/ba-p/13570264

此外,如果你在教程接下来的步骤中遇到任何问题,欢迎查阅优秀的开发者教程《Deploy Your CAP Application on SAP BTP Kyma Runtime》。它描述了类似步骤,如果你在示例场景中卡住,它能提供非常详细的指导。

官方任务教程链接(SAP Mission):https://developers.sap.com/mission.btp-deploy-cap-kyma.html

在继续以下步骤之前,请确保已成功构建 Docker 镜像并推送到自选的镜像仓库(例如 Docker Hub 或 GitHub)。Helm 不会使用你本地的 Docker 镜像,而是从所提供的仓库拉取最新镜像并部署到 Kyma Cluster。

你的镜像仓库中应存在以下 Docker 镜像:

  • susaas-srv - 后端 CAP 服务

  • susaas-api - API CAP 服务

  • susaas-broker - API Service Broker

  • susaas-router - 应用路由器

  • susaas-db-com - 共享数据库部署器

  • susaas-html5-deployer - HTML5 Apps Deployer

下面是取自 Docker Hub 的示例截图。

Docker Hub 中列出示例应用的六个 Docker 镜像

部署期间,Helm 会基于所提供的 Helm 模板生成所需的 Kubernetes 资源(manifest 文件)(同样,欢迎查看我们的 Helm 简介),并把它们部署到你的 Kyma Cluster。这会创建各种不同的对象,例如 Deployment、Job,或 SAP BTP 服务实例与绑定。

提示 - 想进一步了解示例应用用到的各种 Kyma 与原生 Kubernetes 资源,请查看相应的深入探索章节(点击此处)!

Kubernetes Deployments

Kyma Dashboard 中示例应用的四个 Kubernetes Deployment

  • susaas-srv

  • susaas-api

  • susaas-broker

  • susaas-router

这些工作负载在部署后会持续运行在集群中,因为它们需要为外部流量保持可访问状态。它们还带有其他组件,例如 API Rule 或 Istio 相关配置,我们会在专门的 Kyma 教程中进一步说明(点击此处)。

Kubernetes Jobs

Kyma Dashboard 中列出的示例应用 Kubernetes 作业(Job)及其运行状态

  • susaas-hana-deployer

  • susaas-html5-apps-deployer

使用基于 Node.js 的 HDI 部署器部署共享数据模型,只在初始搭建或数据模型发生变更时才需要。静态 UI5 模块也是如此。因此每当执行 helm install 或 helm upgrade 时,这两个应用组件都会以 Job 形式运行。Job 成功完成后,会再次从集群中删除。

SAP BTP 服务实例/绑定

Helm 部署会创建一列工作负载所需的 SAP BTP 服务实例及相应的服务绑定。虽然这些服务实例也能在 SAP BTP Cockpit 中看到,但服务凭据只能从 Kyma Dashboard 获取和访问。

Kyma Dashboard 中由 Helm 创建的 SAP BTP 服务实例 Cloud Foundry 环境中对应的 SAP BTP 服务实例

提示 - SAP BTP 服务绑定会创建相应的 Kyma Secret,由你的 Kubernetes 工作负载(Pod、Job)使用,让你的应用能够与相应的 SAP BTP 服务实例通信,就像你在 Cloud Foundry 环境中熟悉的那样。@sap/xsenv 等 npm 包(见此处)原生支持 Kyma 与 Cloud Foundry 中的这类服务绑定。请查看 Max Streifeneder 的博客文章(点击此处),他也对这个概念做了很好的总结(搜索 “How does CAP know where to get the service binding information from?” 即可)。

2. 创建新的 Kyma 命名空间

使用 Helm,你可以把 SaaS 示例应用部署到 default 这个 Kyma 命名空间,也可以为它创建一个你自选的新命名空间。下面你将学习如何在 Kyma 中创建名为 susaas 的新命名空间。

2.1. 首先,请在开发环境中安装 kubectl 命令行工具。

提示 - Kubectl 让你可以从命令行与 Kyma Cluster 交互,就像你使用其他 Kubernetes 环境一样。点击此处了解 kubectl 的更多信息。Helm 在部署过程中会使用 kubectl 在集群中创建所需资源。

安装快捷命令
MacOS - brew install kubectl
Windows - choco install kubernetes-cli

想了解更多 kubectl 命令,请查看官方文档与 kubectl 速查表。学习使用 kubectl 是入门 Kubernetes 与 Kyma 时最重要的前提之一。命令语法很好理解,并且遵循一致的规则。所以不要害怕花点时间深入阅读所提供的文档。这很值得!

2.2. 在继续下一步之前,请确保能成功执行下面的命令。这可以证明 kubectl 已成功加入环境变量。如果出现错误,请在新的命令行实例中重试,并确认你已遵循 kubectl 安装说明的所有步骤。

kubectl version

Client Version: version.Info{Major:"1", Minor:"26", ...

2.3. 要连接 Kyma Cluster,你还需要安装另一个工具 kubelogin。请使用下面的快捷命令,或链接文档中的安装说明继续操作。

安装快捷命令
MacOS - brew install int128/kubelogin/kubelogin
Windows - choco install kubelogin

运行下面的命令检查安装是否成功。

kubelogin

kubelogin version v1.26.0 

2.4. 从 SAP BTP Cockpit 下载 Kyma Cluster 的所谓 kubeconfig 文件。你可以在 SAP BTP 子账户的 Overview 部分找到它。该文件包含 kubectl 连接 Kyma Cluster 所需的全部访问细节与凭据。

重要 - 不要把这个文件分享给任何人,也不要提交到你的 GitHub 仓库。

在 SAP BTP Cockpit 子账户概览中下载 kubeconfig

2.5. 下载 kubeconfig.yaml 文件后,请把它保存为名为 config 的文件(!不要带任何文件扩展名!),放在隐藏的 $HOME/.kube 目录中。Kubectl 会检查这个隐藏目录中是否存在名为 config 的可用配置文件。这大概是把集群访问细节提供给 kubectl 最方便的方式。

提示 - 在 Windows 中,该目录例如 C:\Users\\.kube

另外,你也可以通过环境变量 KUBECONFIG 配置配置文件的位置,或为任意 kubectl 命令添加 kubectl 参数 --kubeconfig(这显然有点繁琐)。

EXPORT KUBECONFIG=/sample/path/config

kubectl get pods --kubeconfig=/sample/path/config

提示 - 如果你需要管理多个 Kyma 或 Kubernetes 集群,请务必研究 kubectx 命令行工具(https://github.com/ahmetb/kubectx)!它能让你非常方便地在多个集群间切换上下文。

2.6. 运行下面的命令,检查 kubectl 能否使用相应配置文件成功连接集群。

提示 - 取决于你的环境,你可能需要借助 SAP Authenticator App 等工具设置双因素认证。

kubectl cluster-info

Kubernetes control plane is running at https://api.a1b2c3.kyma.ondemand.com

2.7. 下面的 kubectl 命令最终可以让你在 Kyma 集群中创建新的命名空间。想了解更多 kubectl 命令,请查看官方文档与 kubectl 速查表。

提示 - 这只是一个示例,供你参考。如果你愿意,也可以把示例应用部署到 Kyma 的 default 命名空间或任何其他命名空间!只需相应调整本文档中提供的示例命令即可。

kubectl create namespace mtenant

namespace/mtenant created

2.8. 使用下面的命令,为你的新命名空间启用 Istio Sidecar 注入。

提示 - Istio 是 Kubernetes 上最流行的 Service Mesh 之一,负责管理集群内部通信以及对工作负载的外部访问!我们强烈建议访问教程的相应部分,进一步了解 Istio Service Mesh。与 Cloud Foundry 场景中的能力相比,它的特性与可能性令人惊叹!

重要 - 如果你打算使用已有的命名空间,请确保已配置该标签,必要时用 kubectl 或 Kyma Dashboard 更新命名空间!

kubectl label namespace mtenant istio-injection=enabled

你可以用 kubectl 检查,也可以在 Kyma Dashboard 中确认相应标签是否已成功设置!

提示 - 这里你可以看到另一个 kubectl 命令 describe,它能提供比简单的 get 更多关于某个对象的信息,例如本例中的命名空间。

kubectl describe namespace mtenant

Name:         mtenant
Labels:       istio-injection=enabled
              kubernetes.io/metadata.name=mtenant

Kyma Dashboard 中命名空间已带有 istio-injection 标签

2.9. 要删除命名空间,只需执行下面的 kubectl 命令。你已经大致了解 kubectl 命令的结构了吗?很好!

重要 - 删除包含有活跃订阅方的 SaaS 应用的命名空间时,请极其谨慎。这可能导致非常严重的情况:XSUAA 等 SAP BTP 服务实例只能通过复杂的额外工作才能删除。在删除命名空间或卸载 Helm Release 之前,请始终确认没有活跃的订阅方!

kubectl delete namespace mtenant

namespace/mtenant deleted

很好,到这里你应该已经准备好新命名空间或默认的 Kyma 命名空间了。接下来我们为部署准备 SaaS 示例应用。

3. 准备 Helm 部署

我们先来准备 Helm 部署(即 Helm 安装)。你需要根据自己的 Kyma 环境,更新 Umbrella Chart 的 values.yaml 文件。这是几乎任何 Helm 安装都要执行的常规步骤,用于注入无法由应用/包厂商预先配置的环境相关信息。

3.1. 请在 values.yaml 文件中,根据自己的环境与所用镜像仓库,为以下参数提供取值。

global

  • imagePullSecret - 如需要,填入 Image Pull Secret 的名称。

    提示 - 该值需包含对你的镜像仓库可能需要的 Image Pull Secret 的引用。如果你使用免费的 Docker Hub 账户与公开 Docker 镜像,可以保持该属性不变(空对象)。否则,请务必创建一个包含 imagePullSecret 的 Kyma Secret,并在此处提供对该 Secret 的引用。

    更多细节见下面这篇博客(点击此处),或查看 SAP Tutorial Navigator 中的 Deploy Your CAP Application on SAP BTP Kyma Runtime 教程(点击此处)。我们的同事会为你提供详细指导!

  • domain - 你的 Kyma Cluster 默认或自定义域名。

    提示 - 该参数需要你的默认 Kyma 集群域名(例如 a1b2c3.kyma.ondemand.com)。要获取 Kyma Cluster 的默认域名,可以运行下面的 kubectl 命令:

    kubectl get configMaps/shoot-info -n kube-system -o jsonpath='{.data.domain}'

    它会返回类似 a1b2c3.kyma.ondemand.com 的结果。a1b2c3 是集群唯一字符串的占位符(即所谓的 shootName,下一步会用到)。

3.2. 这是一次性操作。放松一下,在 deploy/kyma 目录中运行下面的命令,检查 Helm 是否成功生成你的 Kubernetes 资源定义。

提示 - 如果出现错误,请检查是否漏掉了上述某个参数,或是否混入了错误(例如空格或特殊字符)。

## Run in ./code ## 
cds build --production
helm template susaas gen/chart -n mtenant

这会把生成的 yaml 文件打印到控制台。如有需要,你也可以运行下面的命令把结果保存到本地文件。

## Run in ./code ## 
helm template gen/chart -n mtenant >> mytemplate.yaml

打开生成的 mytemplate.yaml 文件。在继续下一章之前,请再确认生成的资源定义中能找到正确的 Docker 镜像仓库。

apiVersion: apps/v1
kind: Deployment
spec:
  template:
    spec:
      containers:
      - image: sap-demo/susaas-broker:latest
        name: broker

4. 部署到 Kyma Cluster

如果你想对所提供的示例应用做任何改动,这就是实际的操作方式。好了,现在你应该已准备好把示例应用(基于你自己的 Docker 镜像)部署到 Kyma Cluster 了。

4.1. 请在 ./code 目录中运行下面的命令,把 Sustainable SaaS 示例应用部署到你自选的命名空间。

提示 - 如果你想知道底层发生了什么,可以随意添加 --debug 参数以获得更详细的输出!

## Run in ./code ## 
helm install <ReleaseName> gen/chart  -n <Namespace>

# Example
helm install susaas gen/chart  -n mtenant

使用 helm upgrade 命令的另一种方式如下。它既可以升级 SaaS 示例应用的现有安装,也可以在相应命名空间中还没有安装时安装新版本。

## Run in ./deploy/kyma ## 
helm upgrade <ReleaseName> gen/chart --install -n <Namespace>

# Example
helm upgrade susaas gen/chart --install -n mtenant

4.2. 把 Helm Release 部署到 Kyma 集群需要几分钟时间。

4.3. 你可以利用这段时间切回 Kyma Dashboard,在那里监控安装/部署进度以及正在创建的相应对象。一旦看到以下四个 Pod 处于 Running 状态,就说明部署已成功完成。

小知识 - 在本教程中我们有点把 Deployment/Installation/Release 这几个术语混用了。

Kyma Dashboard 中四个处于 Running 状态的 Pod

4.4. 你也可以在 Kyma Dashboard 的 Apps 部分检查应用是否部署成功。这里可以看到所有 Helm Release。

Kyma Dashboard 的 Apps 部分列出已安装的 Helm Release 发布记录

4.5. 对于 Helm Release 的后续任何更新,你现在必须使用 helm upgrade 命令(前面已经提到过)。

## Run in ./deploy/kyma ## 
helm upgrade <ReleaseName> gen/chart -n <Namespace>

# Example
helm upgrade susaas gen/chart -n mtenant

4.6. 要取消部署/卸载 Helm Release,可以使用下面的命令。

重要 - 请务必先查看文档中相应的取消部署章节!卸载仍有订阅方的 SaaS 应用,可能导致服务实例配置损坏,而修复起来非常麻烦。

# Run anywhere # 
helm uninstall <ReleaseName> -n <Namespace>

# Example
helm uninstall susaas -n mtenant

重要!:本应用只能部署到一个命名空间中,且只能部署一次。

订阅租户子账户

  • Kyma ✅

  • Cloud Foundry ✅

在本部分教程中,你将学习如何订阅第一个租户子账户,以及如何为订阅方租户创建第一个管理员用户。

  • 订阅租户子账户

      1. 订阅 SaaS 应用

      1. API Service Broker 实例

      1. 初始化 SaaS 应用

      1. 改进选项

      1. 更多信息

1. 订阅 SaaS 应用

1.1. 为你的第一个 SaaS 租户创建一个新的子账户。请确保该租户子账户与提供方子账户位于同一区域。

重要 - 尤其在生产场景中,我们建议保留为新子账户自动生成的唯一 ID(例如 tenant-a16ef7),而不要把它改成 tenant。否则你可能会遇到子账户子域被占用的问题,因为子域在每个 SAP BTP 区域(例如 eu10)内必须唯一。订阅 SaaS 示例应用时,你可以设置合适的客户子域。

在 SAP BTP Cockpit 中创建新的租户子账户

重要 - 在新的租户子账户中,不必启用任何类型的运行时(例如 Kyma 或 Cloud Foundry)。 如果你有与 SaaS 解决方案无关的租户专属工作负载,可以在租户子账户中启用相应的运行时。否则,在租户子账户中启用运行时并不是在 SAP BTP 上消费 SaaS 解决方案的前提条件。

1.2. 在租户子账户中创建新的订阅。请进入 Instances and Subscriptions,然后点击 Create。

在 Instances and Subscriptions 中点击 Create 创建订阅

1.3. 从下拉列表中选择 Sustainable SaaS 服务。

提示 - 如果同一 SAP BTP 区域中存在多次部署(例如不同的 Cloud Foundry Space 或不同的 Kyma 命名空间),请通过检查 Service Id 的唯一格式来确认使用了正确的服务供品:Kyma 中为 <ReleaseName>-<Namespace>-<ShootName>,Cloud Foundry 中为 susaas-<Space>-<Organization>。

Kyma

在 Kyma 场景中选择 Sustainable SaaS 服务

Cloud Foundry

在 Cloud Foundry 场景中选择 Sustainable SaaS 服务

1.4. 选择你需要的计划(例如 default)。在本示例应用的 Kyma 版本中,点击 Next。在 Cloud Foundry 场景中,请忽略下一步。

1.5. 在 Kyma 场景中,你现在可以为订阅方租户定义自定义子域。使用该功能之前,请务必理解它的含义。如果留空,你的订阅方租户 URL 将按以下格式生成。

<SubaccountSubdomain>-<ReleaseName>-router-<Namespace>.<ShootName>.kyma.ondemand.com
例如,生成的租户 URL 形如:subscriber-c3b2a1-susaas-router-default.a1b2c3.kyma.ondemand.com

虽然这可能给你的订阅方带来冗长不便的 URL,但按此格式生成可以确保子域唯一。如果你决定提供自定义子域,生成的 URL 将采用以下格式(前提是你没有使用自定义域名)。

<CustomDomain>.<ShootName>.kyma.ondemand.com
例如,使用自定义域名时 URL 形如:subscriber.a1b2c3.kyma.ondemand.com

在本示例中,我们没有实现对所提供值唯一性的检查。请你自己负责确保不要把相同的自定义子域重复分配给多个订阅方!

1.6. 点击 Create,为你的订阅方租户创建订阅。

1.7. 等待订阅进入 Subscribed 状态,这可能需要几分钟。在后台,运行于 Cloud Foundry 环境或 Kyma Cluster 中的后端服务会为订阅方租户创建新的 HDI 数据库容器,并创建新的 Cloud Foundry Route 或 Kyma API Rule 来暴露订阅方子域。这可能比 Subscribed 状态所显示的还要多花几秒钟。

租户子账户中的订阅已处于 Subscribed 状态

2. API Service Broker 实例

从租户子账户订阅 SaaS 示例应用后,你还可以创建 API Service Broker 的新实例。在订阅/预配过程中,Service Broker 已自动注册到该租户子账户中。

2.1. 那么接下来,我们创建一个 API Service Broker 实例,它在预配过程中已注册到租户子账户。

2.2. 为此,请进入 Instances and Subscriptions 菜单,再次点击 Create。从列表中选择新的 Sustainable SaaS API 服务。

提示 - 如果同一 SAP BTP 区域中存在多次部署(例如不同的 Cloud Foundry Space 或 Kyma 命名空间),请通过检查 Service Id 格式来确认使用了正确的服务供品:Kyma 中为 <Release>-api-<Namespace>-<ShootName>,Cloud Foundry 中为 susaas-api-<Space>-<Organization>。

Kyma

在 Kyma 场景中选择 Sustainable SaaS API 服务

Cloud Foundry

在 Cloud Foundry 场景中选择 Sustainable SaaS API 服务

2.3. 选择你需要的服务计划,例如 default。用于测试时,可用功能没有区别。Runtime Environment 选择 Other,并为实例起个名字,例如 susaas-api。然后点击 Create。

创建 API Service Broker 实例时填写计划与名称

2.4. 实例创建完成后,你会在可用服务列表中看到它。

可用服务列表中显示已创建的 API 实例

2.5. 现在你可以创建新的服务绑定,供 SAP S/4HANA 等 API 客户端或与 SaaS API 交互的任何第三方工具使用。在本示例中,该绑定名为 default。

提示 - 点击服务绑定即可看到访问 API 所需的 Client Credentials。

为 API 实例创建名为 default 的服务绑定

2.6. 这里是一个 Client Credentials 示例,包含实际的 API 端点,以及外部访问 SaaS API 所必需的认证端点、Client ID 与 Client Secret。如你所见,Kyma 与 Cloud Foundry 的凭据结构非常相似。

重要 - Client ID 与 Secret 对每个订阅方租户都是唯一的,用这些凭据创建的 token 会被 CAP 用来识别与 API 交互的租户。

Kyma

Kyma 场景下 SaaS API 实例服务绑定中显示的客户端凭据(Client Credentials)

Cloud Foundry

Cloud Foundry 场景下 SaaS API 实例服务绑定中显示的客户端凭据(Client Credentials)

2.7. 请记住最后几步,因为在后续某个教程步骤中你还会用到这些 Client Credentials。

3. 初始化 SaaS 应用

SaaS 订阅成功并在租户子账户中创建了新的 API Service Broker 实例后,你(作为提供方)需要为租户的 SaaS 应用实例设置第一个管理员用户。

重要 - 由于 SaaS 应用提供应用内用户管理组件,所有普通租户用户都可以在应用内创建和管理。如果你从 SAP BTP Cockpit 手动创建用户并分配角色集合,这些用户不会出现在应用内用户管理中。

3.1. 为了让第一个租户管理员能访问 SaaS 实例,请临时把 Susaas Administrator 角色集合分配给你自己的用户,以便在租户子账户中完成开通流程。这是整个流程中唯一一次为了完成开通而在 SAP BTP Cockpit 中临时分配角色集合。

如果你在同一 SAP BTP 区域多次部署了 SaaS 示例应用,请确保选择了正确的角色集合。例如在 Kyma 中,括号内的格式为 <ReleaseName>-<Namespace>;在 Cloud Foundry 中则包含 Space 名称。

Kyma

在 Kyma 场景中为当前用户临时分配 Susaas Administrator 角色集合

Cloud Foundry

在 Cloud Foundry 场景中为当前用户临时分配 Susaas Administrator 角色集合

提示 - Susaas Administrator 角色允许用户在示例应用中创建新项目、把成员分配到项目,以及创建评估。此外,管理员还可以为租户的 SaaS 实例添加新用户。Susaas Member 角色集合允许项目成员在指定项目中创建新评估。Susaas Extension 角色集合允许订阅方租户的开发者使用标准 CAP SaaS 应用扩展功能来扩展 SaaS 应用。

应用内用户管理页面,可在此创建、查看租户内的用户

3.2. 在你(作为执行初始开通的提供方)被临时分配 Susaas Administrator 角色集合后,请回到 Instances and Subscriptions,并在无痕窗口中打开订阅,以便最新的 scope 生效。

在 Instances and Subscriptions 页面中点击打开已创建的 SaaS 应用订阅

3.3. 使用你的提供方管理员用户成功登录后,打开 Manage Users 磁贴。

应用启动台中的 Manage Users 磁贴

3.4. 点击 Create,为租户的 SaaS 应用实例添加新的租户管理员用户。这将是租户视角下 SaaS 应用的第一个真正的管理员用户。

在应用内用户管理中点击 Create 新建租户管理员

3.5. 提供第一位租户管理员的名、姓以及有效的邮箱地址。该邮箱地址必须对应一个已存在的 SAP ID Service 用户(例如有效的 S 用户或 P 用户)!

提示 - 要创建可用于此目的的新 SAP ID Service 账户,请遵循本教程。

填写租户管理员的姓名与邮箱地址

3.6. 使用选择字段分配所需的 Susaas Administrator 角色。点击 Create,即可在租户数据库容器中创建该用户,同时在租户子账户中触发自动化的用户创建与角色分配。

为新用户选择 Susaas Administrator 角色并点击 Create

3.7. 点击屏幕左上角的返回箭头,可以切回用户列表,你应该能看到刚创建的第一位租户管理员用户。至此,从提供方视角看,开通流程已完成。

用户列表中显示已创建的租户管理员用户

3.8. 回到 SAP BTP Cockpit,你可以在 Users 菜单中看到刚创建的租户管理员用户,并已分配相应的 Susaas Administrator 角色集合。请记住,不要在应用内用户管理之外创建、修改或删除任何用户或管理员!

SAP BTP Cockpit 的 Users 菜单中显示该租户管理员用户

3.9. 现在这位租户管理员用户可以登录 SaaS 应用的租户实例,并通过应用内用户管理创建更多租户成员或管理员。只需把租户专属订阅的 URL 提供给他们即可。

订阅详情页面中显示的租户专属应用访问 URL

3.10. 现在你可以借助 SAP BTP Cockpit 的功能,再次从自己的用户上移除 Susaas Administrator 角色集合。请记住,临时分配角色集合只是为了通过应用内用户管理完成第一位租户管理员用户的初始开通。

4. 改进选项

关于开通流程的自动化,前面步骤中的一些方面还可以进一步自动化:

  • 自动化整个租户子账户的开通

  • 进一步自动化整体订阅流程

  • 自动化第一位租户管理员的设置

这些方面(目前)尚未包含在示例应用中,但欢迎你通过 pull request 为该示例应用添加更多功能。

5. 更多信息

请通过下面的链接了解上述主题的更多信息: