# upload-app-to-industrial-edge-management

**Repository Path**: gitwbbin/upload-app-to-industrial-edge-management

## Basic Information

- **Project Name**: upload-app-to-industrial-edge-management
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-07
- **Last Updated**: 2025-01-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# App uploading to the Industrial Edge Management

How to upload an application to the Industrial Edge Management

- [App uploading to IEM](#app-uploading-to-iem)
  - [Description](#description)
    - [Overview](#overview)
    - [General task](#general-task)
  - [Requirements](#requirements)
    - [Used components](#used-components)
    - [Further requirements](#further-requirements)
  - [Uploading an Application to the IEM](#uploading-an-application-to-the-iem)
    - [Creating a project and application in IEM](#creating-a-project-and-application-in-iem)
    - [Publishing the application to the IEM](#publishing-the-application-to-the-iem)
  - [Documentation](#documentation)
  - [Contribution](#contribution)
  - [Licence and Legal Information](#licence-and-legal-information)

## Description

### Overview

This document describes the steps to upload an application to an Industrial Edge Management.

### General task

Create a new project and application in the IEM and upload a dockerized application using the IE Publisher.

## Requirements

### Used components

- Industrial Edge App Publisher V1.0.8
- Docker Engine 18.09.6
- Docker Compose V2.4

### Further requirements

- Access to an Industrial Edge Management System.
- A dockerized application with a `docker-compose.yml` file.
- The docker images of the `docker-compose.yml` file are successfully build or pulled and are available in the local docker registry. Use `docker-compose build` in the directory containing the `docker-compose.yml` file to build the docker images needed by the application.
- The docker engine of the development system is accessible to the IE Publisher.

## Uploading an Application to the IEM

To upload the application, a project with an application has to be created in the IEM first. After that, a dockerized application can be uploaded using the IE Publisher.

### Creating a project and application in IEM

In the IEM Webinterface:

- Navigate to the "Applications" -> "My Projects" tab
- Click on "Create Project"
- Enter a project name and description
- Click on the "+" button to add a new company
- Enter name, adddress, country, state, city, zip-code, website, phone number and email and click "add"
- Click "Next" to create a new application which will be added to the project
- Enter name, repository name, website and description of the app. The repository name must be unique for the IEM.
- Click on "Create"

![Create new project and app in IEM](doc/graphics/create-project-and-app-iem.gif)

Now a project containing one application is created. You can now start the IE Publisher to upload the application.

### Publishing the application to the IEM

First, the publisher has to connect to a docker engine and a IEM:

- Click on "+ Docker Engine" and enter the IP and Port on which the docker socket is running. Make sure the docker engine is accessible to the IE Publisher. This docker engine must include all docker images specified in the `docker-compose.yml` file of the application
- Click on "Go Online" to connect the publisher with the IEM
- Enter the Management URL, click "Connect" and log in with your credentials. 

![Connect Publisher with docker engine and IEM](doc/graphics/publisher-connect-docker-iem.gif)

If you are logged in successfully, you will see your newly created application in the "My Projects" Section.

- Click on the application to start the process of adding a new version for uploading
- Click on "Add New Version", set the docker compose version according to your `docker-compose.yml` file, e.g `2.4`
- Select the docker compose version according to your `docker-compose.yml` file
- Click on "Import YAML" and select the `docker-compose.yml` off the application in your file system
- The warning `Build (sevices >> <servicename> ) is not supported` can be ignored 
- Click on "Review" and "Validate and Create" and choose a version label, e.g `0.0.1`
- Enter the version of the application and click on "create"
- Upload the app to the IEM by clicking on "Start Upload" and wait for the upload to finish successfully

![Upload App to IEM](doc/graphics/upload-app-iem.gif)

The application is now uploaded to the IEM and can be configured and deployed to a IE Device.

## Documentation

- You can find further documentation and help in the following links
  - [Industrial Edge Hub](https://iehub.eu1.edge.siemens.cloud/#/documentation)
  - [Industrial Edge Forum](https://www.siemens.com/industrial-edge-forum)
  - [Industrial Edge landing page](https://new.siemens.com/global/en/products/automation/topic-areas/industrial-edge/simatic-edge.html)
  
## Contribution

Thanks for your interest in contributing. Anybody is free to report bugs, unclear documenation, and other problems regarding this repository in the Issues section or, even better, is free to propose any changes to this repository using Merge Requests.

## Licence and Legal Information

Please read the [Legal information](LICENSE.md).