跳到主要内容

平台版

1、概述​

1.1 简介​

HAP 平台版（Application Platform Core）将 HAP 能力完全复刻给合作伙伴，允许客户和合作伙伴在指定的计算平台上部署实施 HAP 私有部署版本，并同时实现多租户经营能力。概括来说，客户或伙伴拥有了一整套可以提供公共云服务的 APaaS 产品能力。伙伴可以通过OEM方式独立经营（结合预制垂直应用），也可以将其与自己的自有产品能力整合提供给终端客户。

1.2 名词解释​

名词描述
授权
即对“组织”开通平台相关功能
授权指标指被定义为平台的可独立售卖的功能项、功能集合或可计量的功能项，授权指标项由 HAP 系统提供，品牌方不可新增、删除、变更授权指标信息
版本HAP 平台本身是一个完整产品，伙伴可以通过组合平台提供的授权指标项，定义不同的产品版本。平台默认初始化时，提供标准版、专业版、旗舰版3个版本，品牌方可以编辑和新增版本，不可删除版本
增购指标指销售、运营人员对平台注册的组织进行授权，授权的产品版本不能满足平台用户时，可在版本的基础之上再额外增购“授权指标”的增购指标项

2、平台架构​

2.1 产品架构​

  • 系统设置：平台基础配置及授权信息。平台部署完成后，通过系统设置中的“授权”菜单项，输入平台密钥进行授权；之后通过其他配置项完成平台初始化（配置项详细下方“3.1系统配置”说明）

  • 主数据：平台基础主数据服务，包含：组织、授权指标、产品版本、平台用户等基础数据

  • APaaS运营：基于平台能力自建的初始应用，用于平台基础运营，品牌方的销售、运营人员可通过此应用对平台组织进行授权流程化管理

2.2 部署架构​

平台版将采用 HAP 私有部署版的专业集群部署架构模式，基于Kubernetes来进行服务编排，动态实例伸缩，保证系统性能的同时充分利用服务器资源。以下是部署架构图：

最低服务器配置如下（并发300，可用率 99%）：

用途配置操作系统部署服务数量
负载与转发
微服务应用
带宽: 100Mbps, 按使用流量
8C/32G/40G系统盘/100G数据盘		Debian 10+Nginx
HAP 微服务		3
缓存带宽: 100Mbps, 按使用流量
4C/16G/40G系统盘/100G数据盘		Debian 10+Redis1
中间件带宽: 100Mbps, 按使用流量
8C/32G/40G系统盘/200G数据盘		Debian 10+Kafka、Elasticsearch、mingdaoyun-file3
数据库带宽: 100Mbps, 按使用流量
8C/32G/40G系统盘/200G数据盘(SSD)		Debian 10+MySQL、MongoDB3
负载均衡器云服务-平台访问入口1
对象存储云服务，存储包规格: 1TB-如：阿里云OSS1

推荐服务器配置如下（并发1000+，可用率 99.9%）：

用途配置操作系统部署服务数量
负载与转发
带宽: 100Mbps, 按使用流量
4C/8G/100G系统盘/200G数据盘		Debian 10+Nginx2
微服务应用带宽: 100Mbps, 按使用流量
32C/64G/100G系统盘/300G数据盘		Debian 10+HAP 微服务3
缓存带宽: 100Mbps, 按使用流量
16C/32G/100G系统盘/200G数据盘		Debian 10+Redis2
消息队列带宽: 100Mbps, 按使用流量
16C/32G/100G系统盘/500G数据盘		Debian 10+Kafka3
全文检索带宽: 100Mbps, 按使用流量
16C/32G/100G系统盘/500G数据盘		Debian 10+Elasticsearch3
文件存储负载带宽: 100Mbps, 按使用流量
16C/32G/100G系统盘/500G数据盘		Debian 10+mingdaoyun-file3
关系型数据库带宽: 100Mbps, 按使用流量
16C/32G/100G系统盘/500G数据盘(SSD)		Debian 10+MySQL2
非关系型数据库带宽: 100Mbps, 按使用流量
32C/64G/100G系统盘/500G数据盘(SSD)		Debian 10+MongoDB3
负载均衡器云服务-平台访问入口1
对象存储云服务，存储包规格: 1TB-如：阿里云OSS1

3、平台功能说明​

3.1 系统配置​

系统设置是平台基础配置管理和授权管理功能模块。提供了通用、应用、登录、资源、协作套件、集成、安全、管理员、日志、品牌、授权等配置管理项。 注：未描述部分可直接参考【系统配置】页面描述。

3.1.1 管理员​

如上图所示，【管理员】模块是用于配置可查看和管理【系统配置】页面的人员配置页，配置人员仅可添加当前用户所属组织的人员。默认管理员是平台安装注册的初始用户（正常不建议管理员数量过多，以免发生误操作事件；当管理员发生调岗或离职交接时，可通过此模块交接给新管理员）。

3.1.2 品牌​

如上图所示，HAP 伙伴可通过【品牌】模块配置平台的品牌信息，品牌信息主要体现在平台的【登录/注册】页。配置人员可以配置平台的品牌名称、logo、登录/注册页背景图等信息。

3.1.3 授权​

如上图所示，HAP 伙伴安装部署平台版完成之后，首先需要输入“平台授权密钥”（密钥通过 HAP 销售顾问申领），授权成功后【授权】页面呈现平台的授权信息；当密钥即将过期或需要对平台授权进行升级时，需重新申领密钥。

点击页面“更新密钥”按钮，输入最新授权密钥授权成功后，平台最新授权即时生效。

授权信息说明：

授权项描述
密钥到期时间平台可有效使用的截止时间
升级服务到期时间平台提供升级服务的截止时间
内部用户配置平台所有组织下有效成员账户可使用额度
外部用户配额平台所有组织下有效外部用户的可使用额度

3.1.4 平台内组织及用户事件推送​

如上图所示，支持向配置的地址推送平台内组织、用户相关事件，在创建组织、组织名称变更、新用户注册、用户账号注销、用户入职/离职组织时将触发推送。

参数说明：

参数名类型说明
typeint事件类型，100+为组织相关事件；200+为用户相关事件。
100：创建组织；
101：组织信息变更；
102：新用户注册；
201：用户信息变更（包括：组织下管理员角色变更、用户信息修改、加入组织、账号恢复）；
202：用户离职
accountIdstring账户Id
projectIdstring组织Id
extraDatasstring额外注册组织信息（JSON结构字符串），仅创建组织时有值
ipstring操作IP
sourcestring注册追踪代码，区分用户注册来源渠道
timedatetime操作时间

事件格式示例：

{
    "type": 1,
    "accountId": "string",
    "projectId": "string",
    "extraDatas": "string",
    "ip": "string",
    "source": "string",
    "time": "2024-01-01 00:00:00"
}

3.2 APaaS运营​

APaaS运营是伙伴安装部署“ HAP 私有部署平台版”完成后，基于 HAP 平台提供给伙伴销售、运营人员的默认应用。伙伴可基于“APaaS运营”应用自定义版本，通过“授权工单”模块对平台用户进行授权，开通平台相应功能。

3.2.1 业务主流程图​

如图所示，“APaaS运营”应用提供了一套标准的平台运营管理体系，平台用户注册完成后（默认注册创建的组织为“免费版”，免费版与 HAP 官方免费版功能一致），伙伴销售人员可通过“授权工单”模块为平台用户申请授权，工单创建后，再由平台运营人员进行审批，审批完成后即完成授权。

3.2.2 应用功能说明​

3.2.2.1 应用数据初始化​

平台安装部署完成后，进入“APaaS运营”应用，需执行以下数据初始化步骤：

1、配置对接主数据服务相关的API信息

如上图所示，打开应用下“管理—>API”工作表，修改工作表中两条行记录的“地址”字段配置信息

A：配置CRM服务（即主数据服务）域名信息

B：配置服务Token信息

注：以上两个信息请从平台安装部署人员处获取（若由 HAP 实施团队部署，初始化时会提供此项初始化操作）

2、同步平台授权指标、版本、组织信息

以上信息同步时，请按照顺序进行操作，同步方式有两种：

A：通过“管理—>数据同步”页面下按钮同步

如上图所示，打开页面后，依次点击页面左侧的同步授权指标、同步版本、同步组织按钮。

B：通过工作流手动同步

如上图所示，按照图上标注数字的顺序，依次进入工作流，点击工作流详情中头部右上角的“立即执行”按钮即可。

3、添加应用角色“销售”、“运营”成员

数据同步完成后，初始化平台运营角色成员，伙伴可根据公司成员结构，邀请公司成员注册平台账号，并将成员加入到平台管理组织中，然后将成员添加到“APaaS运营”应用的对应角色下。

3.2.2.2 组织管理​

组织管理提供了平台所有的“组织”信息，包含了所有组织的基础信息和授权信息。平台的组织信息是通过“工作流”自动同步的，默认同步频率为1小时同步一次当天的增量组织信息。组织管理中主要包含以下功能：

1、同步组织信息

由于组织信息是通过工作流同步到“组织”工作表中的，且组织中存在部分计时、计量的信息，因此暂时无法做到数据实时更新，此时可通过组织详情头部的“同步数据”按钮来同步最新的组织信息。（建议在使用时，形成“同步数据”的操作习惯）

2、停用组织

停用组织是一个关停组织的操作，请谨慎该操作。组织停用后，主要影响包含：

A：被停用的组织“购买产品版本”会更新为：免费版

B：被停用的组织下，所有的“增购指标”都将更改为“无效”状态

3、取消授权

取消授权是对“组织的增购指标”进行取消操作（即取消增购指标后，该组织下的该项增购指标将失效）。此操作适用于组织增购指标授权错误后，可进行反悔操作。

3.2.2.3 产品管理​

产品管理包含了授权指标和版本，其中，授权指标是由 HAP 平台提供的基础功能项或功能集合，授权指标信息不可新增、编辑、删除（如果产品迭代过程中有新增项，运营人员可通过“【授权指标】数据同步”工作流进行同步）；伙伴可通过【版本】模块自行定义版本（版本即授权指标的集合），版本信息可编辑（包含版本中的授权指标，可增、删、改），但不可删除，平台初始化默认提供标准版、专业版、旗舰版。

3.2.2.3.1 版本​

1、版本列表

2、新增版本

版本工作表字段说明：

字段描述
版本编码
版本的唯一标识，创建版本后不可修改
分类该字段为预留字段，伙伴可根据自身需要定义分类类型。例如可针对特殊客户的要求，单独定义产品版本，然后打上“定制产品”的分类标签
状态当状态为“停售”时，授权工单模块则不能选择停售的版本
是否默认版本默认版本有且只能有一个，是指平台组织创建完成时，产品的默认试用版本，试用时长可自行编辑
授权指标—>用量上限当版本中的授权指标为“计量”型指标时，运营人员可定义版本下指标的用量上限，上限值可输入“大于0的整数型”或“不限”，其他均为非法字符。（“不限”顾名思义就只是该指标项用量不限制）
3.2.2.3.2 授权指标​

授权指标工作表中的数据，除“状态”字段信息可编辑，其他字段信息均为只读。当平台功能升级（增加授权指标时），需要用户手动进行同步（管理—>数据同步，点击“同步授权指标”），或者等待定时工作流“【授权指标】数据同步”自动同步。

授权指标工作表字段说明：

字段描述
指标编码
只读字段
计费性质用于区分授权指标是否为“计量”型指标
状态状态为“无效”时，定义版本时，不可勾选无效的指标
分类HAP 提供的默认分类字段，包含：基础能力、高级、整合、增值服务；一般“整合”是指跟第三方平台的集成；“增值服务”是用于计量的指标。
3.2.2.4 授权管理​

授权管理是以“授权工单”通过审批通过后的方式，对组织进行功能的授权，授权类型包含以下几种：

A：新购

“新购”顾名思义是指第一次购买的客户(即组织)

B：续约

指组织到期后，继续续约（可更换版本和增购指标等）

C：增购

基于已购买的产品服务，再次额外增购其他授权指标（审批通过后，指标累增）

D：升级

一般是升级产品版本（同时也可增购指标）

E：充值

充值组织余额，用于平台短信消费、购买平台服务等

授权工单工作表字段说明：

字段描述
审批状态
默认包含：草案、审批通过、审批不通过三种状态，用户默认长卷的工单授权状态均为“草案”状态，工单创建完成后，工作流通知应用运营人员，需要运营人员审批之后，进而更新审批状态
授权状态默认状态为正常，当审批结束后，授权状态为异常，说明授权失败，失败原因在“授权异常描述”字段中体现，此时需要检查工单中的授权指标项的“用量上限”指标是否异常，或者检查主数据服务是否正常运行。
增购指标增购指标只能添加“增值服务”行指标，需要填写指标对应的“用量上限”仅支持大于0的整数型
3.2.2.5 运营看板​