Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "BaSyx / Introductory Examples / Java / Step 1a"

(Step 2: Setting up the Eclipse BaSyx infrastructure)
(Blanked the page)
 
Line 1: Line 1:
= Step 2: Setting up the Eclipse BaSyx infrastructure =
 
  
This step consists of the setting up of the initial Eclipse BaSyx infrastructure, which is illustrated below. It consists of two mandatory containers – an AAS server and an AAS registry component. Both containers will be deployed on a server. This example will use the pre-configured components from dockerhub, which keep all data in memory. Therefore, all changes will be lost when the servers are stopped. To prevent this a different backend must be configured that stores data for example in a database. The necessary steps for this are documented [[BaSyx_/_Documentation_/_Components_/_AAS_Server | here (BaSyx AAS Server Component)]] and [[BaSyx_/_Documentation_/_Components_/_Registry | here (BaSyx Registry Component)]].
 
 
 
 
{|style="text-align: center; width: 100%"
 
|[[File:BaSyx.Example.Java.Step1.NucleusArch.png|center|1024px]]
 
|}
 
 
 
 
== Setting up of the registry component ==
 
 
The Registry is a central component to the Asset Administration Shell (AAS) infrastructure for looking up available AAS and their contained submodels. Hence, it is realized as a separate component that can also be containerized. Currently, there exists a single Registry component that can be configured to utilize different types of backends.
 
 
The registry image is made available via [https://hub.docker.com/repository/docker/eclipsebasyx/aas-registry Docker Hub] and can be pulled by:
 
 
docker pull eclipsebasyx/aas-registry:1.0.1
 
 
To easily start the registry component, you can use the following command:
 
 
docker run --name=registry -p 8082:4000 eclipsebasyx/aas-registry:1.0.1
 
 
Now the endpoint for registering and looking up AAS will be:
 
 
http://localhost:8082/registry/api/v1/registry
 
 
And the container can be stopped, started and removed using its name (see --name):
 
 
docker stop registry
 
docker start registry
 
docker rm registry
 
 
 
 
== Setting up of the AAS server component ==
 
 
The AAS server component provides an empty AAS server that can be used to host several AAS and Submodels.
 
For its API see [[BaSyx_/_Documentation_/_API_/_AssetAdministrationShell | Aggregator API]]. Additionally, there's a video illustrating the configuration and usage in  5 minutes: [https://www.youtube.com/watch?v=nGRNg0sj1oY YouTube]. The AAS Server image is made available via [https://hub.docker.com/r/eclipsebasyx/aas-server Docker Hub] and can be pulled by:
 
 
docker pull eclipsebasyx/aas-server:0.1.0-PREVIEW
 
 
To easily start the AAS server component, you can use the following command:
 
 
docker run --name=aas -p 8081:4001 eclipsebasyx/aas-server:0.1.0-PREVIEW
 
 
Now the endpoint for accessing the server with its AAS is
 
 
http://localhost:8081/aasServer/shells/
 
 
And the container can be stopped, started and removed using its name (see --name):
 
 
docker stop aas
 
docker start aas
 
docker rm aas
 
 
 
Whoohoo! You have setup a working BaSyx infrastructure. Now, in the next steps, we are going to populate it.
 

Latest revision as of 05:50, 13 April 2021

Back to the top