Skip to content

Latest commit

 

History

History
157 lines (109 loc) · 7.32 KB

Installation.md

File metadata and controls

157 lines (109 loc) · 7.32 KB
Raw

Installation

Build application

Download Repository

Download or clone the repository source code to your workstation.
Github Clone Section

  • Trough terminal:
git clone https://github.com/industrial-edge/pingpong-csharp.git
  • Trough VSCode:
    CTRL+↑ SHIFT+P or F1 to open VSCode's command pallette and type git clone:

VS Code Git Clone command

Build docker image

  • Navigate into src and find the file named Dockerfile.example. The Dockerfile.example is an example Dockerfile that can be used to build the docker image(s) of the service(s) that runs in this application example. If you choose to use these, rename them to Dockerfile before proceeding
  • Open a console in the root folder (where the docker-compose file is)
  • Use the docker compose build (replaces the older docker-compose build) command to build the docker image of the service which is specified in the docker-compose.yml file.
  • These Docker images can now be used to build your app with the Industrial Edge App Publisher
  • docker images can be used to check for the images

Configuring Databus

For the PingPong application the databus must provide two topics to publish and subscribe to.

  • Open the Industrial Edge Management web interface
  • Go to "Data Connections" > Databus
  • Select the corresponding Industrial Edge Device
  • Create a new user with username and password and give the user publish and subscribe permission
  • Create two topics for the PingPong application
  • Deploy the databus configuration and wait for the job to be finished successfully

Databus

Create configuration for the application

The following parameter must be configured for the PingPong application:

  • "MQTT_USER": username of the databus user
  • "MQTT_PASSWORD": password of the databus user
  • "MQTT_IP": name of the databus service name - serve as DNS resolution (ie_databus / ie-databus (> V1.0))
  • "TOPIC_1": databus topic to which the application subscribes to
  • "TOPIC_2": databus topic to which the application publishes to

The configuration file has to be named mqtt-config.json.

Below two ways are described to create the configuration file.

Configuration via fixed config file (UseCase 1)

Here a fixed configuration file is created, that can not be modified during the installation of the application. It has to be structured like the following example:

{
    "MQTT_USER":"edge",
    "MQTT_PASSWORD":"edge",
    "MQTT_IP":"ie-databus",
    "TOPIC_1":"topic1",
    "TOPIC_2":"topic1"
}

This repository already provides that configuration file here. In this example, the application will authenticate to the databus with the username edge and password edge. It will subscribe to topic1 and will publish to topic2.

Configuration via app Configuration Service (UseCase 2)

Here the system app IE Configuration Service is used to create an UI for the configuration of the application. The UI is based on a JSON Forms file, that is integrated as a configuration template via the Publisher. By using this configuration during the installation, the user can fill out the parameter individual.

First the system app IE Configuration Service must be installed on the IEM.

ConfigurationService

Then a JSON Forms file must be created, consisting of an UI schema and a data schema. Please see this getting started to learn more about JSON Forms. The file should look like this:

This repository already provides that JSON Forms configuration file here.

Upload the application to the Industrial Edge Management

Please refer to Uploading App to IEM on how to upload the app to the IEM. In the Industrial Edge App Publisher, use the docker-compose.yml file of this application example when building the docker image.

Configuring and deploying the application to a Industrial Edge Device

An application can provide several configurations, that can be selected during installation. If no configuration is used (e.g. if the application is deployed as a standalone application), the application will use the corresponding environmental variables specified in the docker-compose.yml file.

Create a fixed configuration via file upload (UseCase 1)

  • Open the Industrial Edge Management web interface
  • Go to "Applications" > "My Projects"
  • Open the PingPong application
  • Click on "Configurations" > "Add Configuration"
  • Enter a name and description
  • Enter ./cfg-data as host path
  • Enter a template name and description
  • Browse for the mqtt-config.json file created here
  • Click "Add"

ConfigViaFile

Create a custom UI configuration (UseCase 2)

  • Open the Industrial Edge App Publisher
  • Open the PingPong application
  • Click on "Configurations" > "Add Configuration"
  • Enter a name and description
  • Enter ./cfg-data as host path
  • Enter a template name and description
  • Browse for the mqtt-config.json file created here
  • Activate "Json Schema"
  • Click "Add"

ConfigViaUi

Installing the application to an Industrial Edge Device

  • Open the Industrial Edge Management web interface
  • Go to "Applications" > "My Projects"
  • Open the PingPong application
  • Click on the install button on the right of the version you want to deploy
  • Under "Schema Configurations" select the above created UI configuration and fill the parameter

Config1

OR

  • Under "Other Configurations" select the above created file configuration

Config2

  • Select the corresponing Industrial Edge Device
  • Click "Install Now" and wait for the job to be finished successfully

When the PingPong application is deployed and running on the Industrial Edge Device, it can be tested using the Simatic Flow Creator.