Insights Hub Java SDK – 私有云(LPC)案例配置与使用

2024-03-11T12:09:37.000-0400
Developer Tools Applications

摘要

Java SDK – 私有云(LPC)案例配置与使用


详细信息

一、准备

Demo 基于 mindsphere-java-sdk-examples,使用者可以访问 Insights Hub 开源仓库下载。

关于 Java SDK 的介绍请参考:Insights Hub Java SDK

1.1 本地环境搭建

  1. Java 8 或更高版本 JDK;
  2. App Credentials
    • 在本地运行此 Demo 需要设置环境变量;
    • 如果 Demo 在 Insights Hub 注册为 "Self-Hosted" 类型,则环境变量在应用实际运行的环境中需要提前配置好;
    • 如果 Demo 在 Cloud Foundry (CF) 中运行,环境变量也需要配置(针对 LPC 环境不适用)。

1.1.1 环境变量介绍

Application Credentials

变量名称说明
MDSP_OS_VM_APP_VERSIONDeveloper Cockpit 上注册的 App 版本
MDSP_OS_VM_APP_NAMEDeveloper Cockpit 上注册的 App 名字
MDSP_KEY_STORE_CLIENT_IDApp Credentials Client ID
MDSP_KEY_STORE_CLIENT_SECRETApp Credentials Client Secret
MDSP_HOST_TENANTApp 实际所运行在的 Tenant 名字
MDSP_USER_TENANTApp 被用户从其所属租户访问的 Tenant 名字
HOST_BASEDOMAIN基域名。AWS 区域为 mindsphere.io;其它环境(包括私有云)需自行配置
HOST_ENVIRONMENT主机名。AWS 区域为 eu1;其它环境(包括私有云)请自行配置
  • App Credentials 可满足 SDK Token 相关功能。
  • 更多关于 Token 介绍请参考:Token Handling

1.1.2 SDK 下载

SDK 下载链接:Siemens Industry Online Support (SIOS) Portal。从 Java SDK 官网进去同样也可找到下载链接。

找到最新版的下载即可(私有云使用的 SDK 和 AWS 公有云是一样的)

二、在 Insights Hub 部署、注册应用

2.1 在本地私有云(LPC)中部署 Demo

2.1.1 下载 Demo 应用

Clone 应用

git clone https://github.com/mindsphere/mindsphere-java-sdk-examples.git

或者直接从链接中下载压缩包,然后本地解压。

2.1.2 安装依赖

  1. 下载 SDK。参考上述 SDK 下载步骤(本例使用的版本为:mindsphere-java-sdk_2.5.3);
  2. 进入项目所在目录:/mindsphere-java-sdk_2.5.3/com/siemens/mindsphere/
  3. 复制各目录下面的 .jar 文件(版本选择最新,或者根据自己需求选择)到 Demo 项目中,然后在 Demo 项目的 build.gradle 中配置依赖。


2.1.3 编译项目

进入项目根目录

执行:gradlew clean build,然后在 build/libs/ 可找到编译后的文件。

2.2 部署应用

客户需要自行在 LPC 环境中部署编译过后的应用。

2.3 在 Developer Cockpit 注册应用

填写应用信息

  1. 进入 Developer Cockpit,点击创建新应用;
  2. 根据应用部署的类型选择对应的 Infrastructure。
  3. 输入应用的展示名字和内部名字。内部名字需要唯一;
  4. 输入版本号。版本号格式:Major.Minor.Patch
  5. 上传图片(可选);
  6. 输入 Component 名字;
  7. 添加 Endpoint。此案例设置为 /**
  8. 修改 CSP 配置。由于 Demo 部署在 AWS 的 MDSP 上,CSP 请参考如下:
    default-src 'self' static.eu1.mindsphere.io nbgmsdev-javapubsubui-nbgmsdev.eu1.mindsphere.io fonts.googleapis.com fonts.gstatic.com; style-src * 'unsafe-inline'; script-src 'self' 'unsafe-inline' static.eu1.mindsphere.io cdnjs.cloudflare.com code.jquery.com; img-src * data:;
  9. 最后点击保存。

添加 Role 和 Scope

切换到 Authorization Management 并创建 scope

签发 App Credentials

  • 点击 App Credentials,然后为当前应用签发 App Credentials。






注册 App 并分配给用户

  1. 回到 Developer Cockpit Dashboard;
  2. 点击进入当前 App;
  3. 点击右上角“注册”,勾选分配当前 App 给当前用户。

设置环境变量

由于是在本地私有云部署,客户在启动 App 时需要提前设置以下环境变量:
MDSP_OS_VM_APP_NAME, MDSP_OS_VM_APP_VERSION, MDSP_KEY_STORE_CLIENT_ID, MDSP_KEY_STORE_CLIENT_SECRET, MDSP_HOST_TENANT, MDSP_USER_TENANT.

下面为在 Eclipse 中设置好的环境变量参考:
MDSP_KEY_STORE_CLIENT_ID=suppdev-kevintestapp-v1.0.0;MDSP_HOST_TENANT=suppdev;MDSP_KEY_STORE_CLIENT_SECRET=hwibPA7RjKTeLl6dYQu;MDSP_USER_TENANT=suppdev;MDSP_OS_VM_APP_VERSION=v1.0.0;HOST_BASEDOMAIN=mindsphere-in.cn;HOST_ENVIRONMENT=pvt-rancher1.cn1-int;MDSP_OS_VM_APP_NAME=kevintestapp

访问应用

登录 Insights Hub,在 Launchpad 上找到创建的应用,点击访问。

进入界面后可以看到 Swagger 的界面。本 Demo 通过 Swagger UI 的形式来演示。

接着可以选择需要调用的 API,点击展开,然后点击 Try it out 即可。

知识库文章 ID# KB000130337_ZH_CN

内容

摘要详细信息

关联组件

Developer Tools - Other