Skip to content

Commit

Permalink
Merge branch 'eclipse-tractusx:feat/tutorials' into feat/tutorials
Browse files Browse the repository at this point in the history
  • Loading branch information
stephanbcbauer authored Nov 23, 2023
2 parents df05976 + cdc266b commit 29c1d4f
Show file tree
Hide file tree
Showing 3 changed files with 979 additions and 27 deletions.
53 changes: 30 additions & 23 deletions docs/tutorials/e2e/inform/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Understand the overarching architecture
sidebar_position: 2
---

If you are interested more in buying services, please get in contact with a operating company.
If you are interested more in buying services, please get in contact with an operating company.

:::info

Expand All @@ -19,61 +19,68 @@ The first thing you need is a BPN (Business Partner Number) because this is used

:::info

Even if the BPN is already configured and used in the MXD setup, its just a dummy. In the real world you will receive your BPN via the self description phase within your account in the portal. // ToDo Link to the onboarding guide
Even if the BPN is already configured and used in the MXD setup, its just a dummy. In the real world you will receive your BPN via the onboarding / regirstraion process [onboarding process](https://catena-x.net/en/catena-x-introduce-implement/onboarding).

:::

The BPN is also used to restrict the access and usage of your provided assets. This is done via policies. Some example policies are also part of this tutorial
The BPN is also used to restrict the access and usage of your provided data assets. This is done via policies. Some example policies are also part of this tutorial.

One of the key components of the Catena-X architecture is the [Eclipse Data Space Connector](https://github.com/eclipse-tractusx/tractusx-edc) (EDC). This component is used to exchange data between participants. The EDC is also used to register data offers and to discover data offers from other participants. With the EDC you are always in control of your data.
A data asset is the metadata for the data that is intended to be provided or consumed. This data asset is the element in the ecosystem for which policies are defined to build a contract offer which can be agreed and consumed by a consumer.

One of the key components of the Catena-X architecture is the [Eclipse Data Space Connector](https://github.com/eclipse-tractusx/tractusx-edc) (EDC) as one implementation of the [Dataspace Protocol](https://docs.internationaldataspaces.org/dataspace-protocol/). This component is used to exchange data between participants. This includes:

- Publish data offers and to discover data offers from other participants.
- Negotiate data offers and come to an agreement on how to data is allowed to be used (Usage Policies)
- Transfer data based on a previously negotiated agreement.

With the EDC you are always in control of your data.

:::note

Control of your data means, that you can decide who can access your data and who can not. This is done via policies. And is called **data sovereignty**.
Control of your data means on the one hand, that you can decide who can access your data and who can not. On the other hand you can decide under which constraints the data may be used by the data consumer after providing access. This is achieved via policies and sovereign deployment of data provisioning (in Catena-X you have the opportunity to freely decide where and by whom the data is stored and offered). This is called **data sovereignty**.

:::

In our setup we already configured two EDCs. **Àlice** and **Bob** and also the related databases (to persist the assets, policies aso.) are ready to use.
In our setup we already configured two EDCs. **Alice** and **Bob** and also the related databases (to persist the assets, policies aso.) are ready to use.

:::info

Registering an EDC is part of the onboarding process and is done in the portal. In our setup the EDCs are already registered and technical users are already created in the KeyCloak instance.

:::

Now the minimal Setup for data exchange is in place. Now you are able to provide and exchange data.
The minimal Setup for data exchange is in place. Now you are able to provide and exchange data.

## What language does Catena-X speak? / Asset Administration Shell with Aspect Models define the language in Catena-X

:::danger

no idea what to write here. I think the goal for this page is to describe the different components and which one are already used in the MXD and which once are planned to be used in the future.
Since Catena-X is more than just a data exchange the next level of key to success is to exchange data in a structured and defined way. This helps to speak the same language to leverage business value of data.

:::

Since Catena-X is more than just a data exchange the next level of ... is to exchange data in a structured and defined way. This helps to speak the same language, same syntax to enhance business value ... .
(Same language == greater value)
This is realized with [Asset Administration Shell](https://eclipse-tractusx.github.io) (Digital Twins) and Aspect models. The AAS is the vehicle to transport the semantic, which is modeled in Aspect Models.

With that you are able to speak Catena-X.

comments Felix: Ist das nicht eher BAMM? AAS beschäftigt sich ja mit dem strukturierten Auffinden und Zugreifen von Daten. Die "Sprache" von Catena-X wären dann die semantischen Modelle?
When it comes to data exchange, it as an utmost concern to be able to find the desired data on the one hand and to understand the structure and meaning of the data on the other hand.
Finding and understanding data is a typical challenge, if you want to provide or consume data to or from an audience you are not in direct contact in advance.

## What else is needed
To tackle these concerns the Industry-Standard for Digital Twins, the [Asset Administration Shell](https://industrialdigitaltwin.org) is referenced.

:::danger
"Discovery finder" is used to identify which services are available to search for dedicated characteristics of a digital twin (e.g. Serialnumber discovery, Product type discovery,...)

I think we want to describe the architecture a little bit more. Isn't there a predefined description?
"Discovery service" maintains a catalog of all entries that can be looked up and may be operated by any operating company. All twins that want to be able to be found within that search have to register/be registered in the corresponding service with its logical ID (and a reference to the Digital Twin registry).

:::
"Digital Twin registry" is used to lookup the logical ID of the desired Twin and stores the endpoint address to access the Server that stores the Digital Twin Data - the AAS-Server.

## The different components
"AAS-Server" is used to provide the API for the desired data - which are implemented as `Submodels` or also called "Digital twin aspects", that can either implement a dedicated persistence and gather copies of information in the desired quality or by access the corresponding business systems directly. These Submodels are semantically described (structure and meaning) by semantic models which are centrally managed in the

:::info
"Semantic Hub" which stores all semantic models that may be described in a Semantic Aspect Meta Model (SAMM) compliant format to be able to inform about requirements for an API providing that kind of data or validate information that is transferred via AAS-API.

In the following picture, the most important elements of Catena-X architecture for the MXD are depicted. This architecture will be expanded in future versions of the MXD.
## What else is needed

:::
Managed Identity Wallet (MIW) - the Managed Identity wallet provides a service where you can store your Verifiable Credentials (VC) for any Catena-X services in a safe place. This is only an intermediate step before self hosted wallets are supported and organizations have the choice to either use a managed service or store their VCs in their own wallets.

Keycloak is used to manage access to central components, e.g. the MIW and some of the discovery services with typical OAuth Client Credentials flow.

## The different components

![cx_architecture](@site/static/img/architecture.drawio.svg)

Expand Down
Loading

0 comments on commit 29c1d4f

Please sign in to comment.