数据建模引擎运行SDK自定义配置
MongoDB配置
如果您已在数据建模引擎运行SDK资源规划中规划了MongoDB的资源/云服务,并希望使用xDM-F的“系统版本”功能,可参考如下说明进行配置。
配置参数 |
是否必选 |
参数说明 |
示例 |
---|---|---|---|
mongodb.init |
否 |
设置是否开启MongoDB。
|
true |
MONGODB_URI |
仅当“mongodb.init”为“true”时,此配置参数必选。 |
MongoDB的连接串。 |
mongodb://rwuser:admin@127.0.0.1:8635/test?authSource=admin |
MONGODB_DATABASE |
仅当“mongodb.init”为“true”时,此配置参数必选。 |
MongoDB的库名。 |
test |
Elasticsearch配置
如果您已在数据建模引擎运行SDK资源规划中规划了Elasticsearch的资源/云服务,并希望使用xDM-F的“搜索服务管理”功能,可参考如下说明进行配置。
配置参数 |
是否必选 |
参数说明 |
示例 |
---|---|---|---|
ES_URL |
是 |
Elasticsearch的连接串。 |
127.0.0.1:9200 |
ES_PORT |
是 |
Elasticsearch的端口号。 |
9200 |
ES_USERNAME |
是 |
Elasticsearch的用户名。 |
admin |
ES_PASSWORD |
是 |
Elasticsearch的密码。 |
admin |
ES_SCHEMA |
是 |
Elasticsearch的类型。 |
http |
Kafka配置
如果您已在数据建模引擎运行SDK资源规划中规划了Kafka的资源/云服务,并希望使用xDM-F的“同步至LinkX-F”功能,可参考如下说明进行配置。
配置参数 |
是否必选 |
参数说明 |
示例 |
---|---|---|---|
kafka.init |
否 |
设置是否开启Kafka。
|
true |
KAFKA_BOOTSTRAP_SERVERS |
仅当“kafka.init”为“true”时,此配置参数必选。 |
Kafka的连接地址。 |
127.0.0.1:9094 |
OBS配置
如果您已在数据建模引擎运行SDK资源规划中规划了OBS服务,并希望将应用运行态的所有文件都存储至OBS,可参考如下说明进行配置。
配置参数 |
是否必选 |
参数说明 |
示例 |
---|---|---|---|
OBS_END_POINT |
是 |
承载OBS服务的服务器域名或IP地址。 |
https://obs.cn-north-4.myhuaweicloud.com |
BUCKET_NAME |
是 |
OBS服务的桶名。 |
test |
单点登录配置
如果您希望通过单点登录的方式访问应用运行态,可参考如下说明进行配置。xDM-F的SDK部署模式当前支持如下两种单点登录方式,请根据实际的数据建模引擎运行SDK资源规划进行配置。
- IAM服务的单点登录
此方式的单点登录依赖于华为云IAM服务,请确认已规划对应资源。
配置参数
是否必选
参数说明
示例
ssf.sysmgr.sessionfilter.loginUrl
是
IAM服务的单点登录地址。
格式为:
https://{IAM_LOGIN_ENDPOINT}/authui/login.action?service={ssf.login.cas.serviceUrl}
https://auth.huaweicloud.com/authui/login.action?service=http://127.0.0.1:8003/rdm_123456_app/services/v1/cas/login
ssf.sysmgr.sessionfilter.ignorePattern
是
忽略会话校验的URL格式。
/v1/cas/login;/v1/health;/wopi/files/\d{18};/wopi/files/\d{18}/contents;/v1/oauth2/login
ssf.login.loginSuccessRedirectUrl
是
登录应用运行态后的默认主页。
格式为:
http://{数据建模引擎运行SDK部署服务器的IP地址}:{数据建模引擎运行SDK部署服务器的端口号}/rdm_{应用ID}_app/services/index.html
http://127.0.0.1:8003/rdm_123456_app/services/index.html
ssf.login.cas.serviceUrl
是
应用运行态的单点登录地址。
格式为:
http://{数据建模引擎运行SDK部署服务器的IP地址}:{数据建模引擎运行SDK部署服务器的端口号}/rdm_{应用ID}_app/services/v1/cas/login
http://127.0.0.1:8003/rdm_123456_app/services/v1/cas/login
ssf.login.logoutUri
是
IAM服务的单点登出地址。
格式为:
https://{IAM_LOGIN_ENDPOINT}/authui/logout
https://auth.huaweicloud.com/authui/logout
ssf.login.cas.validateUrl
是
IAM验签地址。
格式为:
https://{IAM_LOGIN_ENDPOINT}/authui/serviceValidate
https://auth.huaweicloud.com/authui/serviceValidate
IAM_LOGIN_ENDPOINT
是
承载IAM服务的服务器域名或IP地址。
https://auth.huaweicloud.com
LOGIN_URL
是
IAM服务的单点登录地址。
格式为:
https://{IAM_LOGIN_ENDPOINT}/authui/login.action
https://auth.huaweicloud.com/authui/login.action
LOGOUT_URL
是
应用运行态的单点登出地址。
格式为:
https://{IAM_LOGIN_ENDPOINT}/authui/logout
https://auth.huaweicloud.com/authui/logout
XDM_SDK_DEPLOY_ENABLE
是
表示当前部署方式是否为SDK部署。
- true:是SDK部署方式,默认为true。
- false:不是SDK部署方式。
true
ssf.sysmgr.sessionfilter.enabled
否
设置是否开启会话认证。
- true:开启会话认证,默认为true。
- false:关闭会话认证。
true
- 本地环境的单点登录
配置此方式的单点登录之前,您需要先在数据建模引擎运行SDK资源规划的数据库资源中创建一个schema,其schema名称格式为{应用运行态的schema名称}_ssf;然后在schema中执行如下命令,更新配置信息。
set global log_bin_trust_function_creators=true;
配置参数
是否必选
参数说明
示例
XDM_LOGIN_TYPE
是
应用运行态的登录类型,配置为“LOCAL”。
LOCAL
ssf.sysmgr.sessionfilter.loginUrl
是
本地环境的单点登录地址。
LOCAL
ssf.sysmgr.sessionfilter.ignorePattern
是
设置忽略请求格式。
/getIndexUrl;/v1/health;/v1/login/login;/v1/login/logout;/v1/login/verifycode;/v1/firstlogin/users;/v1/firstlogin/userpasswords:PUT;/static/**;/index.html;/HuaweiLog.ico;/HuaweiLog.png
ssf.login.logoutUri
是
本地环境的单点登出地址。
格式为:
https://{数据建模引擎运行SDK部署服务器的IP地址}:{数据建模引擎运行SDK部署服务器的端口号}/rdm_{应用ID}_app/services/index.html
http://127.0.0.1:8003/rdm_123456_app/services/index.html
OPEN_IAM_TOKEN_VALIDATION
是
设置是否开启Token认证。
- true:开启Token认证。开启后,您还需要进行Token配置。
- false:关闭Token认证,默认为FALSE。
FALSE
RUNTIME_ENV_TYPE
是
设置应用运行态的运行环境,配置为“IES”。
IES
SSF_RDS_TYPE
否
本地环境单点登录的数据库类型,默认为“mariadb”。
请根据实际的数据建模引擎运行SDK资源规划进行设置。
- 如果是MySQL类型数据库,设置为“mariadb”。
- 如果是PostgreSQL类型数据库,设置为“postgresql”。
mariadb
SSF_DRIVER
否
本地环境单点登录的数据库驱动,默认为“org.mariadb.jdbc.Driver”。请根据实际的数据建模引擎运行SDK资源规划进行设置。
- 如果是MySQL类型数据库,设置为“org.mariadb.jdbc.Driver”。
- 如果是PostgreSQL类型数据库,设置为“org.postgresql.Driver”。
org.mariadb.jdbc.Driver
XDM_SDK_DEPLOY_ENABLE
是
表示当前部署方式是否为SDK部署。
- true:是SDK部署方式,默认为true。
- false:不是SDK部署方式。
true
ssf.sysmgr.sessionfilter.enabled
否
设置是否开启会话认证。
- true:开启会话认证,默认为true。
- false:关闭会话认证。
true
Token配置
如果您希望可以通过Token认证调用应用运行态的全量数据服务API,可参考如下说明进行配置。
配置参数 |
是否必选 |
参数说明 |
示例 |
---|---|---|---|
OPEN_IAM_TOKEN_VALIDATION |
否 |
设置是否开启Token认证。
|
false |
IAM_END_POINT |
是 |
承载IAM服务验证Token的服务器域名或IP地址。 |
https://iam.cn-north-4.myhuaweicloud.com |
DEW(KMS)配置
如果您已在数据建模引擎运行SDK资源规划中规划了DEW服务,并希望对数据模型的属性进行“值加密”,可参考如下说明进行配置。
配置参数 |
是否必选 |
参数说明 |
示例 |
---|---|---|---|
KMS_END_POINT |
是 |
承载DEW服务的服务器域名或IP地址。 |
https://kms.cn-north-4.myhuaweicloud.com |
KMS_KEY_ID |
是 |
DEW服务的密钥ID。 |
123456 |
AOM配置
如果您已在数据建模引擎运行SDK资源规划中规划了AOM服务,并希望使用xDM-F的“系统日志”功能,可参考如下说明进行配置。
配置参数 |
是否必选 |
参数说明 |
示例 |
---|---|---|---|
AOM_END_POINT |
是 |
承载AOM服务的服务器域名或IP地址。 |
https://aom.cn-north-4.myhuaweicloud.com |
AOM_CLUSTER_ID |
是 |
AOM的集群ID。 |
123456 |
APIG配置
如果您已在数据建模引擎运行SDK资源规划中规划了APIG服务,并希望通过APIG对应用运行态的全量数据服务API进行统一监控、管理、配置、流控等,可参考如下说明进行配置。
配置参数 |
是否必选 |
参数说明 |
示例 |
---|---|---|---|
APIG_HOST |
是 |
承载APIG服务的服务器域名或IP地址。 |
https://apig.cn-north-4.myhuaweicloud.com |
APIG_INSTANCE_ID |
是 |
APIG的实例ID。 |
123456 |
APIG_DEFAULT_GROUP_HOST |
是 |
APIG服务默认组的IP地址。 |
http://127.0.0.1/ |
APIG_DEFAULT_GROUP_ID |
是 |
APIG服务默认组的ID。 |
123456 |
APIG_ENDPOINT |
是 |
承载APIG服务终端的服务器域名或IP地址。 |
https://2c3cffb0f7174591a37f40bf5415546e.apic.cn-north-4.myhuaweicloud.com |
特性开关配置
您可以通过如下配置说明,自主控制是否开启/关闭某个xDM-F的功能。
配置参数 |
是否必选 |
参数说明 |
示例 |
---|---|---|---|
OPEN_SECOND_LEVEL_CACHE |
否 |
设置是否开启二级缓存功能。
关于二级缓存的介绍请参见数据建模引擎支持哪些层级的缓存?。 |
false |
THIRD_LEVEL_REDIS_CLOSED |
否 |
设置是否开启三级缓存功能。
关于三级缓存的介绍请参见数据建模引擎支持哪些层级的缓存?。 |
true |
DYNAMIC_DATASOURCE_ENABLED |
否 |
设置是否开启多数据源功能。
|
false |
License配置
数据建模引擎运行SDK的运行由License进行授权控制。当您已完成“通用SDK”基础版数据建模引擎的购买并获取License文件之后,可参考如下配置说明绑定License。
如果您当前暂未申请License,且获取的SDK包处于免费使用期,可跳过此配置。
配置参数 |
是否必选 |
参数说明 |
示例 |
---|---|---|---|
xdm.license.licenseFile |
否 |
License文件的绝对路径。 |
/root/deploytest/test.dat |
xdm.license.deployType |
是 |
数据建模引擎运行SDK部署位置。
|
HostMachine |
WSF配置
数据建模引擎运行SDK的运行时默认启用Huawei WSF安全校验,包括参数校验、文件上传校验等。您可以通过如下配置说明,自定义配置WSF校验规则。
- 如果您希望精细化管理安全校验,开启dme-WSF组件后,您可以通过自定义配置参数校验、文件上传校验、多文件上传解释器、CSRF防护过滤器、WSF参数校验文件路径、WSF文件上传配置信息路径等参数实现。
- 为了避免文件上传校验异常,开启/关闭WSF的文件上传校验时,须同时开启/关闭WSF的多文件上传解释器。即,“dme.wsf.upload.check.enable”和“dme.wsf.multipart.check.enable”同时配置为“true”或“false”。
- 如需自定义参数校验规则,请遵循WSF组件规则定义对应的XML配置信息。
- 如果您想使用其他安全防护资源进行安全校验,需要关闭WSF安全校验时,请同时关闭dme-WSF组件和WSF组件。即,“dme.wsf.enable”和“devspore.security.wsf.enable”均配置为“false”。关闭WSF安全校验后,数据建模引擎运行SDK上的数据将不再受保护,请谨慎操作。
配置参数 |
是否必选 |
参数说明 |
示例 |
---|---|---|---|
dme.wsf.enable |
否 |
dme-WSF组件是iDME基于WSF封装的组件。 如果不配置或配置为true,则开启dme-WSF组件;如果配置为false,则关闭dme-WSF组件。 |
true |
devspore.security.wsf.enable |
否 |
WSF自带组件。 如果不配置或配置为true,则开启WSF自带组件;如果配置为false,则关闭WSF组件。 |
true |
dme.wsf.param.check.enable |
否 |
WSF的参数校验。 如果不配置或配置为true,则开启参数校验;如果配置为false,则关闭参数校验。 仅当“dme.wsf.enable”为“true”时,此配置参数才有效。 |
true |
dme.wsf.param.config.path |
否 |
自定义WSF参数校验规则的文件夹路径。 如果不配置,默认读取当前SDK类路径下“validate”文件夹中的配置。 仅当“dme.wsf.param.check.enable”为“true”时,此配置参数才有效。 |
/root/deploytest/validate |
dme.wsf.upload.check.enable |
否 |
WSF的文件上传校验。 如果不配置或配置为true,则开启文件上传校验;如果配置为false,则关闭文件上传校验。 仅当“dme.wsf.enable”为“true”时,此配置参数才有效。 |
true |
dme.wsf.multipart.check.enable |
否 |
WSF的多文件上传解释器。 如果不配置或配置为true,则开启多文件上传解释器;如果配置为false,则关闭多文件上传解释器。 仅当“dme.wsf.enable”为“true”时,此配置参数才有效。 |
true |
dme.wsf.upload.config.path |
否 |
自定义WSF文件上传校验规则的文件路径。 如果不配置,默认使用iDME配置文件路径。 仅当“dme.wsf.upload.check.enable”为“true”时,此配置参数才有效。 |
/root/deploytest/CustomUploadFileConfig.properties |
dme.wsf.csrf.check.enable |
否 |
CSRF防护过滤器。 如果不配置或配置为true,则开启CSRF防护过滤器;如果配置为false,则关闭CSRF防护过滤器。 仅当“dme.wsf.enable”为“true”时,此配置参数才有效。 |
true |
日志配置
数据建模引擎运行SDK集成了WSF框架和SSF框架,默认打印日志的等级为INFO,您可以通过如下参数说明修改打印日志的等级。
配置参数 |
是否必选 |
参数说明 |
示例 |
---|---|---|---|
WSF_LOG_LEVEL |
否 |
用于设置打印WSF框架日志的日志等级。如果未设置此配置参数,则默认打印INFO日志。
|
INFO |
SSF_LOG_LEVEL |
否 |
用于设置打印SSF框架日志的日志等级。如果未设置此配置参数,则默认打印INFO日志。
|
INFO |
流程引擎流程SDK配置
数据建模引擎运行SDK和流程引擎流程SDK是独立部署的两个微服务,服务之间可以通过jwt-token认证并进行通信交互。如果您需要开启两个微服务之间的联动,使用流程引擎流程SDK,您需要先在数据建模引擎运行SDK的启动配置文件中添加如下配置。
配置参数 |
是否必选 |
参数说明 |
示例 |
---|---|---|---|
JWT_WORKFLOW_PRIVATEKEY |
是 |
xDM-F和流程引擎通信时,jwt-token认证鉴权所使用的加密私钥。 如何获取jwt-token认证鉴权所使用的加密私钥,请参见如何生成jwt-token?。 |
private_key |
JWT_WORKFLOW_PUBLICKEY |
是 |
xDM-F和流程引擎通信时,jwt-token认证鉴权所使用的加密公钥。 如何获取jwt-token认证鉴权所使用的加密公钥,请参见如何生成jwt-token?。 |
public_key |
WORKFLOW_URL |
是 |
流程引擎服务主页的URL。 URL格式: http://{流程引擎流程SDK部署服务器的IP地址}:{流程引擎流程SDK部署服务器的端口号}/{流程引擎流程SDK文根}/index.html |
http://127.0.0.1:60001/workflowDesign/index.html |
DATA_SYNC_SWITCH |
是 |
设置是否开启xDM-F和流程引擎间的数据同步。 如需使用流程引擎,此配置参数必须设置为true。
|
true |