Edge App Manager User Guide A6V12059211 2020-11-20 Smart Infrastructure
Edition notice Edition notice Technical specifications and availability subject to change without notice. This document may not be reproduced, disseminated to third parties or processed and its contents may not be used or disclosed without express permission. Noncompliance shall result in compensation for damages. All rights, including those resulting from a successful patent application and registration of a utility model or design patent, are reserved.
Cybersecurity disclaimer Cybersecurity disclaimer Siemens provides a portfolio of products, solutions, systems and services that includes security functions that support the secure operation of plants, systems, machines and networks. In the field of Building Technologies, this includes building automation and control, fire safety, security management as well as physical security systems.
Table of Contents 1 Edge App Manager User Guide .................................................................... 5 1.1 Overview..........................................................................................................5 1.2 Creating Edge app ..........................................................................................5 1.3 4 | 18 1.2.1 Adding app .......................................................................................6 1.2.
Edge App Manager User Guide Overview 1 1 Edge App Manager User Guide 1.1 Overview Edge App Manager is a service that allows you to develop, publish, and manage Edge apps. The Edge App Manager creates a configuration of an existing container. Within Asset Manager, installing an app will assign this configuration to a device. In particular this service offers: ● Creating an Edge app: Create a new Edge app, add an application version, and configure an Edge app.
1 Edge App Manager User Guide Creating Edge app 1.2.1 Adding app You have already set up an account for Edge App Manager. 1. Go to https://edge.bpcloudapps.siemens.com/ to open Edge App Manager. 2. Log in and verify the correct company is selected in your profile. 3. Click Create app and enter a Name for the app. It is recommended to enter a Description. A new Edge app is created. 1.2.
Edge App Manager User Guide Creating Edge app 1 1. Open the recently created app and click Add version. 2. Fill in the fields on the ensuing form appropriately. It is important to select the correct compatible gateway operating system version, for example, 4.10.0. 3. Click Create. You can either create a new version or a clone from an existing app version. The app version is created and the app state will switch to Development. The app is ready to integrate a new service. 1.2.
1 Edge App Manager User Guide Creating Edge app Entries in Settings section are optional. The red asterisk next to Services indicates that entries in Services section are mandatory. 3. In Settings section, you can define Allowed ports and Properties. You can also add one or multiple Tunnel for remote access to the app that is installed on the gateway. This enables remote engineering of the app: – – Enter Display name and Description. Enter URL, for example: http(s)://127.0.0.1:8085. 4.
Edge App Manager User Guide Creating Edge app – – 1 These volumes are created at the application level and mounted to a service. If the same volume is enabled for multiple services within an app, they all share the same volume. This was done by design, due to a working assumption that developer would have control over all services being included in an Edge app and that there would be no concern if services of an app would share the same volume. On enabled volume, valid target MUST be provided. 7.
1 Edge App Manager User Guide Creating Edge app 1.2.4 Uploading OSS license files OSS license files ensure that Edge applications are aligned with clearance policy. One or multiple files can be uploaded and assigned to application versions. OSS license files must have file extension .md or .txt. Minimum file size is 1 Byte, maximum is 10 MB. Add OSS license file 1. Select an app. 2. Click on Manage OSS licenses. 3. Go to Add new file and select the OSS license file. Drag and drop is also possible. 4.
Edge App Manager User Guide 1 Creating Edge app Reference Edge app project is cloned on the local PC. A clone can be created from https://code.siemens.com/horizon/HEdge/reference-edge-app. Windows terminal app is installed. The following installation is recommended: https://conemu.github.io/ SSH in maintenance page of Edge gateway is enabled. Edge gateway is connected to local PC via ethernet connection 169.254.169.254. 1. Open an app. 2.
1 Edge App Manager User Guide Creating distribution The state of your app will change to Test. 4. Click Update again. The state of your app will change to Released. 5. Click twice on the back button to get back to the initial screen. 6. Check the overview page for the current state of your app. The state Released is displayed. 1.3 Creating distribution A distribution defines a product domain and the required subscription to access it, e.g., Sinteso, Cerberus, SSP.
Edge App Manager User Guide Creating distribution 1 1. Click Create distribution below the Edge apps section if there is no distribution yet. Otherwise open an existing distribution. 2. Fill in the fields on the ensuing form appropriately. 3. Confirm with Create. The distribution is created. 1.3.2 Configuring distribution A distribution is created. 1. Open the distribution and click Add version. A default app will automatically be installed. You can not uninstall a default app. 2.
1 Edge App Manager User Guide Managing life-cycle 6. Enter Version. 7. Click Save. The distribution is configured. 8. Check the overview page for the current state of your distribution. The state Released is displayed. 1.4 Managing life-cycle Edge apps and distributions go through several states until they are released/shared.
Edge App Manager User Guide 1 Sharing Edge apps ● ● Released Discontinued Configurations are possible in Development state only. The developer has to ensure a correct configuration prior to release. Roles and responsibilities within the Edge app/distribution life-cycle In Edge App Manager there are three roles. Each role is bound to a certain profile of rights: State Developer Release-Manager x x Development Test x Preview x Released x Discontinued x Tester x 1.
1 Edge App Manager User Guide Sharing Edge apps 1.5.1 Publishing app DEV ORG1 publishes an app to the app catalogue. App is in state Released. 1. Select an app and open the context menu. 2. Click on Publish. 3. Confirm with Publish. App will be visible in app catalogue once approved by the Governance Organization Administrator. 1.5.2 Approving app The ADMIN (Governance Organization Administrator) checks the quality of the app. Once approved, the app is visible to all other EDS organizations.
Edge App Manager User Guide Sharing Edge apps 1.5.3 1 Requesting app DEV ORG2 requests an app from the app catalogue. Once approved, DEV ORG2 can include the app from DEV ORG1 in their distributions. DEV ORG2 cannot modify the requested app from DEV ORG1. The App catalogue only displays approved apps. Access is granted to released app versions only. 1. Go to App catalogue tab. 2. In Published apps, select an app and open the context menu. 3. Click on Request.
Issued by Siemens Switzerland Ltd Smart Infrastructure Global Headquarters Theilerstrasse 1a CH-6300 Zug +41 58 724 2424 www.siemens.com/buildingtechnologies © Siemens Switzerland Ltd, 2020 Technical specifications and availability subject to change without notice.
