Configuration process¶
| configuration step | details | stakeholder |
|---|---|---|
| Step 1 | New application gets published to Insights Hub | App developer |
| Step 2 | Application gets configured in the Insights Hub | Operator in Insights Hub |
| Step 3 | Application gets installed and started by app management on an Edgebox | Application runtime |
Step 1 - App publish (metaconfig.json)¶
The IndApp artifact must include a metaconfig.json file. In this file, the application must declare its requirements for accessing datasources (section: "requiredDatasource") and/or available datasources provided by the application (section: "providedDatasource") The metaconfig.json file is useful for:
- matching needs & availabilities
- configuring application dependencies
- providing optional help for manual configuration
- defining routing information via providedDatasource (TCP-Port and ContainerID), which is used by the Edgebox to address a listening parameter-service API
Define the data contract
The format of data provided by an application is defined by the datasource type. The provider application shall provide details about the type of datasource for consumer application developers. This can be accomplished by sharing schema files or additional interfaces.
SINUMERIK Edge system applications will share their datasource type definitions in the Developer Environment under /services/datasourceConfig/datasources/\<datasource type>
Step 2 - App configuration in Insights Hub¶
The operator installs provider and consumer applications onto a SINUMERIK Edgebox. To connect these applications, he defines a unique datasource id for the provider application, and uses this datasource id with the consumer application.
Hint: The operator is also able to connect datasources with different datasource types. In that case, he must be sure that the data handled by both applications is compatible.
Attention: Some parts of the configuration file are restricted; for example, the services' address definitions in the provided datasource. An attempt to configure restricted sections will lead to configuration errors, and as such, they are hidden from view in the Insights Hub.
Step 3 - App installation and runtime on the Edgebox (appconfig.json)¶
When the application starts, the metaconfig will be modified for runtime by the app management. It will appear as an appconfig.json file in the respective app's container. This is the application's final configuration.
Any questions left?
Except where otherwise noted, content on this site is licensed under the The Siemens Inner Source License - 1.1.