竹云IDaaS•开放平台

应用同步云桥

云桥
最后更新时间: 1/22/2024, 6:45:10 PM

# 概述

应用同步类型云桥是IDaaS云桥中的一种，用于建立竹云IDaaS与企业内部应用之间的连接通道，实现IDaaS与企业内部应用之间的数据同步。

本章节指导您在IDaaS平台部署及使用应用同步云桥Agent，提供应用同步云桥安装包的更新记录，以便您根据项目实际需求选择合适版本。下文以操作系统CentOS Linux release 8.0.1905部署应用同步云桥Agent为例。

# 前提条件

  • 拥有IDaaS企业中心平台的管理员权限。
  • 拥有内网服务器操作权限。
  • 服务器已安装OpenJDK 17及以上版本。

# 部署前准备

# 软件包

请提前准备如下所示软件包。

软件包名称 说明 下载链接
cloudAgent-appProvision-{版本号}.zip 应用同步云桥安装包 点此下载 (opens new window)
cloudAgent-appProvision-{版本号}.zip.sha256 应用同步云桥安装包的SHA256校验文件，用于校验应用同步云桥安装包的完整性。 点此下载 (opens new window)
cloudAgent-appProvision-adConnector-{版本号}.zip AD连接器及配置文件软件包(推荐AD使用) 点此下载 (opens new window)
cloudAgent-appProvision-adConnector-{版本号}.zip.sha256 AD连接器及配置文件软件包的SHA256校验文件，用于校验AD连接器及配置文件软件包的完整性。(推荐AD使用) 点此下载 (opens new window)
cloudAgent-appProvision-ldapConnector-{版本号}.zip LDAP连接器及配置文件软件包 点此下载 (opens new window)
cloudAgent-appProvision-ldapConnector-{版本号}.zip.sha256 LDAP连接器及配置文件软件包的SHA256校验文件，用于校验LDAP连接器及配置文件软件包的完整性。 点此下载 (opens new window)
cloudAgent-appProvision-fanruan-bi_report-Connector-{版本号}.zip 帆软连接器及配置文件软件包 点此下载 (opens new window)
cloudAgent-appProvision-fanruan-bi_report-Connector-{版本号}.zip.sha256 帆软连接器及配置文件软件包的SHA256校验文件，用于校验帆软连接器及配置文件软件包的完整性。 点此下载 (opens new window)
cloudAgent-appProvision-eventCallback-Connector-{版本号}.zip 事件回调连接器及配置文件软件包 点此下载 (opens new window)
cloudAgent-appProvision-eventCallback-Connector-{版本号}.zip.sha256 事件回调连接器及配置文件软件包的SHA256校验文件，用于校验事件回调连接器及配置文件软件包的完整性。 点此下载 (opens new window)

应用同步云桥安装包解压后的文件如下：

名称 说明
agent.sh 开机自启动云桥Agent的文件。
cloudAgent-appProvision.jar 应用同步云桥Agent的部署包。
cloudBridge.sh 手动启动云桥Agent的文件。
config 应用同步连接器配置文件的存放目录。
application.yml 应用同步云桥Agent的配置文件。
log 云桥Agent日志（agent.log）的存放目录。
connector 应用同步云桥连接器jar包的存放目录。

# 部署应用同步云桥

  1. 登录IDaaS企业中心平台，在上方导航栏选择 “设置 > 云桥配置“ ，单击 ”添加云桥Agent“ ，设置名称并选择应用同步类型云桥。

    • 云桥Agent添加完成后，系统会自动生成ClientID和ClientSecret，请妥善保管。
    • 如不慎忘记ClientSecret，单击目标Agent的 “重置密钥” 即可重新生成。重置后，原密钥将会失效，请谨慎操作。
    • 支持查看云桥连接日志及服务日志。
    • 支持为云桥Agent配置IP，配置为部署云桥Agent的服务器的出口IP，配置后只允许该IP连接IDaaS云服务，以确保服务安全性。
    • 支持删除目标Agent，请谨慎操作。

  2. 上传获取的应用同步云桥的所有软件包至目标服务器，执行如下命令校验云桥安装包、LDAP连接器以及帆软连接器软件包的完整性，当回显信息显示OK，表示完整性校验成功。

    sha256sum -c cloudAgent-appProvision-{版本号}.zip.sha256
sha256sum -c cloudAgent-appProvision-ldapConnector-{版本号}.zip.sha256
sha256sum -c cloudAgent-appProvision-fanruan-bi_report-Connector-{版本号}.zip.sha256
    1
    2
    3

  3. 执行以下命令解压应用同步云桥安装包，其中存放地址必须唯一，否则会导致安装出错。

    unzip -od {文件解压后的存放地址} cloudAgent-appProvision-{版本号}.zip
    1

  4. 进入文件解压后的目录，配置application.yml文件。

    ###UTF-8格式YAML配置标识头,勿删除###
server:
 # 云桥启动端口
  port: 9081

agent:
   # This is the connection address of the agent
   # exp: wss://domain/api/v1/ws
   # 云桥服务地址，domain为在IDaaS的租户域名xx.bccastle.com
   # 示例：wss://domain/api/v1/ws
   serverAddress:
   # This is the client ID of the agent
   # exp: 7jve68NwihfnjsD8SJToWxTU5Wg8hkl1
   # 云桥ClientID，在IDaaS创建的云桥的ClientID
   # 示例：7jve68NwihfnjsD8SJToWxTU5Wg8hkl1
   agentId:
   # This is the client secret of the agent
   # exp: LdfwryojYHLMaeNGVdr9fSh1iwyDCL0QuBx2wewrjxT5UOhUQVpAqwerfgj8pLNV1
   # 云桥ClientSecret，在IDaaS创建的云桥的ClientSecret
   # 示例：LdfwryojYHLMaeNGVdr9fSh1iwyDCL0QuBx2wewrjxT5UOhUQVpAqwerfgj8pLNV1
   agentSecret:

# This is the Agent log level control configuration
logging:
  level:
    com.oneaccess.cloudbridge: INFO
  file:
    # The value of the attribute must have a unit, which can be KB or MB
    # 单个日志文件大小。默认值10MB，最大值10MB
    # default: 10MB
    # max-size: 10MB
    # The maximum number of days that log files are to be archived
    # 日志最长保留时间。默认值7天，最大值7天
    # default: 7 DAYS
    # max-history: 7
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35

  5. 返回应用同步连接器安装包的存放目录，执行以下命令解压安装包。

    unzip -od {文件解压后的存放地址} cloudAgent-appProvision-{连接器类型}-{版本号}.zip
    1

  6. 执行以下命令将解压后的应用同步连接器（jar文件）复制到云桥connector目录下。

    cp {连接器名称}.jar {云桥connector目录地址}
    1

  7. 执行以下命令将解压后应用同步连接器配置文件（yml文件）复制到云桥config目录下。

    cp {连接器名称}.yml {云桥config目录地址}
    1

  8. 编辑应用同步连接器配置文件的内容并修改文件名为{应用Id}.yml，应用Id即IDaaS企业中心的 “资源 > 应用 > 应用信息 > 通用信息” 页面的AppId。

  9. 配置文件完成后，在云桥安装包解压后的目录下执行以下命令启动云桥，当提示Starting Agent Success表示云桥启动成功，若启动失败请查看云桥启动日志agent.log，并排查配置文件内容。

    ./cloudBridge.sh start
    1

  10. （可选）如果需要开机自启动云桥，请在云桥安装包解压后的目录下执行以下命令，当提示The Agent service installed successfully, need to reboot will take effect表示启动成功。

./agent install
1

  1. （可选）如果需要取消云桥开机自启动，请在云桥安装包解压后的目录下执行以下命令，当提示uninstall Agent Success表示取消云桥开机自启动成功。

    ./agent uninstall
    1

  2. 您可以通过目录中的log/agent.log文件获取日志信息。

# 使用应用同步云桥

以下描述以AD应用为例：

  1. 登录IDaaS企业中心平台，在上方导航栏选择 “资源 > 应用“ ，开启应用的 “同步集成” 开关并配置为LDAP。

  2. 进入 “同步集成 > 通用配置” 页面，将连接方式设置为 “通过云桥Agent连接” ，选择可用的应用同步云桥，其余配置请参考通过LDAP协议同步数据。

# 更新日志

本模块展示应用同步云桥Agent安装包的更新记录。

软件包名称 版本 更新说明
cloudAgent-appProvision-{版本号}.zip V23.10.1.0 JDK版本升级到JDK 17
cloudAgent-appProvision-{版本号}.zip V23.5.1.0 增加客户端连接信息和日志备份
cloudAgent-appProvision-{版本号}.zip V23.4.1.0 新增AD连接器
cloudAgent-appProvision-{版本号}.zip.sha256 V23.4.1.0 新增AD连接器
cloudAgent-appProvision-adConnector-Connector-{版本号}.zip V23.4.1.0 新增AD连接器
cloudAgent-appProvision-adConnector-Connector-{版本号}.zip.sha256 V23.4.1.0 新增AD连接器
cloudAgent-appProvision-{版本号}.zip V23.3.1.0 1.完善了同步日志信息
2.优化了配置文件模板说明
3.补充了传递连接器所需相关属性的逻辑
cloudAgent-appProvision-{版本号}.zip.sha256 V23.3.1.0 同步更新版本号，内容无变动
cloudAgent-appProvision-eventCallback-Connector-{版本号}.zip V23.3.1.0 新增事件回调
cloudAgent-appProvision-eventCallback-Connector-{版本号}.zip.sha256 V23.3.1.0 新增事件回调
全部 V22.11.1.0 1.优化了一些已知bug
2.优化WebSocket的连接
全部 V22.9.1.0 首次发布应用同步云桥

自定义用户中心Web端页面