Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "BaSyx / Documentation / Components / Registry / Features"
| Line 1: | Line 1: | ||
| − | + | = AAS Registry Features = | |
| + | The AAS Registry Components supports a multitude of features with a great range of configuration options: | ||
| + | == Storage Backend == | ||
* [[BaSyx_/_Documentation_/_Components_/_Registry_/_Features_/_Storage_Backend | Storage Backend]] | * [[BaSyx_/_Documentation_/_Components_/_Registry_/_Features_/_Storage_Backend | Storage Backend]] | ||
Revision as of 03:15, 28 November 2022
Contents
AAS Registry Features
The AAS Registry Components supports a multitude of features with a great range of configuration options:
Storage Backend
MQTT Eventing
Eventing via MQTT can be enabled in the property file as well. This will publish events for every action to a separately specified server:
registry.events=MQTT
Together with SQL, the values InMemory and MongoDB are also allowed. By default, this configuration file is assumed to be located at "/usr/share/config/registry.properties" within the container. Thus, another configuration file can be set by mounting a local configuration file into the container during startup. As an example, a local folder containing the configuration files can be mounted using:
docker run --name=registry -p 8082:4000 -v C:/tmp:/usr/share/config eclipsebasyx/aas-registry:1.2.0
In this example, the registry.properties file is located in C:/tmp/.
Authorization is disabled by default. Basic authorization can be configured in the registry.properties:
registry.authorization=Enabled registry.authorization=Disabled
The TaggedDirectory is disabled by default. It can be configured in the registry.properties:
registry.taggedDirectory=Enabled registry.taggedDirectory=Disabled
Tagged Directory
[Disclaimer: In development branch]
A tagged directory is an implementation of the registry that allows to associate AAS with tags. When in use, AAS can be retrieved based on tags.Disclaimer: Currently only works with an InMemory backend. Persistent backends (SQL and MondoDB), as well as combination with Authorization, or MQTT is yet to be supported.
Authorized AAS Registry
As stated above in context configuration there are some properties stated related to JWT based Authorization. This Authorization mechanism makes authorized access to the AAS Registry. Read and write authorization is enabled. In order to read from the registry or write to the registry there is a need of authorization token.
Example demonstrating above scenario is here Authorized AAS Registry.
Eventing with MQTT
Additionally, to the registry.properties file, you need to edit the mqtt.properties file in order to connect to the right MQTT broker. The MQTT configuration file can be found in the same folder as the backend configuration. It allows you to add credentials and a Quality of Service level (default: 1) besides the mandatory server address.
Information about what events will be published can be found in the eventing extension.