Skip to content

development.md

Latest commit

 

History

History
68 lines (47 loc) · 3.62 KB

development.md

File metadata and controls

68 lines (47 loc) · 3.62 KB

🏭 Environments

🌐 Overview

The runtime is provided in two different environments, depending on your use case and setup preferences.

💻 DevContainer

The DevContainer provides all required components pre-installed and ready to use. The runtime itself must still be started manually from the source code. This setup is ideal for development, testing, or debugging individual components.

🚀 DevContainer Quickstart

Get started with the runtime in just a few steps:

  1. Checkout the main branch of the repository.
  2. Open the project in a DevContainer (requires the DevContainer Extension for VS Code).
  3. Start the runtime by running __main__.py or pressing F5 in VS Code.

This setup allows you to quickly launch the development environment and start experimenting with the runtime.

💡 Tips & Common Pitfalls:

  • Docker must be installed and running on your system.
  • The DevContainer extension for VS Code must be installed.
  • Make sure all required components are installed in the DevContainer.
  • If the runtime fails to start, check that the environment variables (e.g., RUNTIME_CONFIGURATION_FILE) are set correctly.
  • Use the VS Code terminal inside the DevContainer to ensure correct paths and dependencies.
  • For database or server connection issues, verify that the ports match the URLs in your configuration file.

🚢 Container Setup

This environment provides all required components pre-installed and ready to use. You only need to start the runtime manually from the source code to get the system up and running.

Once the runtime is started, the following services are available:

Service URL Notes
Grafana http://localhost:8076/ Dashboard access
user: admin
password: fluid40
Runtime Server http://localhost:3088/docs Accessible after runtime is running
Asset Connector http://localhost:8078/docs Documentation interface
InfluxDB http://localhost:8079/ Database endpoint
AAS Env Server http://localhost:8077/ AAS environment server

🔧 Custom Components

You can use your own components in the runtime, such as a custom AAS Server or a different Asset Administration Shell. Simply modify the default configuration file or provide an alternative one (see Configuration).

Environment Default Configuration File
DevContainer /configuration/DevContainerEnv.json
Demonstrator /_Demonstrator/configuration/DemonstratorEnv.json

To use a different configuration file, set the environment variable:

RUNTIME_CONFIGURATION_FILE