1、操作场景

使用ModuleSDK开发插件应用，并以进程方式跑在服务器上。

2、代码解析

代码解析样例：

• 数据处理代码解析
• 工业子系统接入代码解析
• 协议转换代码解析
• OT数采代码解析

3、注册节点

注册节点，请参照注册边缘节点。

4、设备建模&发放

请参照设备建模&发放。

5、项目打包

将集成ModuleSDK进行项目打包。

根据您的需求进行相关代码的开发，并将项目打包，以编辑器IDEA为例：

1.选中项目->右键open Module setting

2.Artifacts->单击+号>JAR->From modules with dependencies->模块选择monitor-app,选择monitorapp的Main入口类,注意MANIFEST.MF位置选择模块根目录->单击apply。

3.单击上方build选项->选择build Artifacts->monitor-app:jar->build

4.打包完成得到monitor-app.jar文件。(如遇到错误(Invalid signature file digest for Manifest main attributes)请使用压缩文件进入metf目录删除.rsa和.mf文件)

6、制作插件包

1.插件包制作。

a.插件包格式要求如下：

插件包仅支持.tar.gz 、.tar或者 .zip格式。

插件包结构如下：

app.zip

├── ****.jar //可执行jar文件,必须

├── start.sh //启动脚本 必须文件 当前不提供参数方式启动

└── stop.sh //停止脚本 非必须

b.构建插件包。

以monitor-app为例，在项目打包后得到monitor-app.jar

在monitor-app.jar文件的同目录下创建start.sh,内容如下:

将monitor-app.jar和start.sh一起压缩得到monitor-app.zip。

注意：

1. 插件包升级时，会删除运行目录的所有文件，注意持久化文件的存储。插件包的运行路径为{installer_dir}/IoTEdge/downloaded-job/run/{moduleId}/{appVersion}/。
2. 当前插件包的大小限制为最大500M。
3. 程序内对于文件的访问使用相对目录访问（因为程序的安装目录是不确定的）。
4. 程序不允许包含后台运行的程序，可以包含多级进程，所有程序均为sh的子进程。
5. 进程压缩包命名规范：英文字母或者数字或者“_”,”.” ，长度不超过64，不允许出现空格。

说明：

1. 插件包为一层压缩结构，即插件包的压缩包解压之后直接为sh脚本所在目录的结构形式，不能多一层目录。
2. sh脚本为必须脚本，启动时默认调用该脚本进行启动，当前支持root用户以及非root用户（固定为1000用户,非root需要确定是否能够成功依赖系统库）启动，用户可以在start.sh脚本中自由修改自己的启动方式以及环境变量的修改等。
3. sh为非必须的脚本，但是用户如果需要优雅停止的话，需要在改脚本中书写自己进程的停止方式（文件监控、接口调用等）。如果没有该脚本的话，默认对进程组先发送SIGTERM信号，如果进程组对该信号没有处理，达到最大等待时间则发送SIGKILL信号强制停止。整个停止的最大周期为10s。

2.插件包上传。

a.开通对象存储服务OBS。

进程包上传方式需要开通对象存储服务OBS，请参考对象存储服务 OBS_快速入门。

b.上传进程包。

上传方式，请参照对象存储服务(OBS)。

注意：

请设置桶策略为【公开读】，如未设置请前往“OBS首页 > 单击桶ID > 访问权限控制 > 桶策略中设置”。

7、添加应用

以安装包部署方式为例，将应用程序打包成安装包文件，并上传到 对象存储服务(OBS)。

1.在IoT边缘单击创建应用，进入软件部署配置、运行配置，并确认发布。

2.在左侧导航栏，单击“应用管理”，选择“应用名称”进入页面，查看应用为“已发布”状态。

8、部署应用

在边缘节点安装成功后可部署边缘应用。

操作步骤

1.访问IoT边缘，单击“立即使用”进入IoT边缘控制台。

2.选择左侧导航栏“IoT边缘 > 边缘节点”进入页面。

3.选择您的边缘节点，单击“节点名称”进入节点详情页。

4.在左侧导航栏选择“应用模块 > 模块管理”页签，单击“部署应用”。

图1 部署边缘应用

5.根据页面提示填写参数信息后，单击“确认”。

图2 部署应用

6.弹出“操作成功”对话框，再单击“确认”返回部署边缘应用列表。

图3 确认

7.单击“刷新”，当应用的实例状态由“部署中”转为“运行中”表示部署成功。

只有应用版本是多部署的时候，且运行配置的网络类型是端口映射后，可在部署应用时，或应用后添加端口映射。

运行配置，请参考端点和部署配置。

注意：

• 标准版默认部署sys_edge_hub和sys_edge_agent，高级版默认部署sys_edge_hub。
• 标准版和轻量版默认部署$edge_omagent,在注册节点过程中可选择是否自动部署。
• 只有已发布的应用版本允许被部署。
• 如果应用添加时配置了支持多模块部署 同一个节点下是允许部署多次的。
• 应用支持的架构和边缘节点架构相同才能够部署成功。
• 如果应用需要AI加速卡，边缘节点没有AI加速卡将部署失败。
• 部署应用模块支持升级操作，可选择高版本也可选择低版本，目前只有Agent应用升级失败会回退到原版本。