Skip to content

Commit

Permalink
Merge pull request #474 from stephanbcbauer/main
Browse files Browse the repository at this point in the history
doc(tutorials): adapt architecture view
  • Loading branch information
stephanbcbauer authored Nov 7, 2023
2 parents 697167a + e2de295 commit 9d0a907
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 110 deletions.
2 changes: 1 addition & 1 deletion docs/tutorials/e2e/boost/provideData.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ curl --location 'http://localhost/bob/management/v2/policydefinitions' \
}'
```

## Request catalog
## Request Bob's catalog

Now that Bob created an access policy, Alice can once again try to access Bob's asset.

Expand Down
144 changes: 35 additions & 109 deletions docs/tutorials/e2e/inform/architecture.md
Original file line number Diff line number Diff line change
@@ -1,149 +1,75 @@
---
title: Understand the architecture
title: Understand the overarching architecture
sidebar_position: 2
---

If you are interested more in buying services, please get in contact with a operating company.
This section is for the makerr, which are intereste in deploying the services in their own it landscape.

## Where does the journey begin? / It Starts all with the BPN
:::info

The first thing you need is a BPN because this is used within the Network to identify yourself against another paricipant. This tells the network in a trusted mannor who are you. [How to get your BPN?](https://eclipse-tractusx.github.io)
One of the first operating companies is [Cofinity-X](https://cofinity-x.com/).

[//]: # (Felix: Für das Tutorial gilt das vermutlich nicht. Das Konzept der BPN ist wichtig, aber das lokale deployment sollte ohne funktionieren - wir "mocken" oder deaktivieren ja den DAPS/SSI, oder?)
:::

[//]: # (Felix: Als Erklärung, was eine BPN ist und wofür wir die brauchen - Access Policies im EDC - reicht das noch nicht aus, oder?)
This section contains more information than is currently implemented in the MXD. However, it is intended to provide a general overview of the Catena-X architecture. However, not all components are listed here.

The next component to share data to another participant is the [Eclipse Data Space Connector](https://eclipse-tractusx.github.io) (EDC). With that component you are always in control of your data and it enables to be data sovereign. You are using the BPN's to also make sure, that you know who to share your data with. This must also be configured into your EDC.
## The journey starts

[//]: # (Felix: Wenn wir von "No preliminary knowledge" ausgehen, brauchen wir auch hier noch 1-2 Sätze, was der EDC macht - P2P Datenaustausch, Control & Data Plane)
The first thing you need is a BPN (Business Partner Number) because this is used within the network to identify yourself against other participants. This tells the network in a trusted manner who you are.

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

[//]: # (Felix: Noch wurde im Rahmen des Tutorials ja nichts gemacht. Ich würde vielleicht sowas sagen wie "In principle, an EDC and an Identity - das ist es ja was die BPN wiedergibt - are enough to share data in the Catena-X data space. However, for an interoperable and scalable data space we also need technologies for data description/semantic as well as data discovery and access)

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

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.

[//]: # (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?)

## Now the question is how can you find the Assets,the Data? / Wanna find Data? Digital Twin Registry is your Service of Choice

The answer to that question is the so called digital twin registry. This is a service which enables the participants to ask the question, where is the information to for example some part and some specific data belonging to that part.
To enable this, the Data Offers of a Catena-X participants shall be registered in their respective [Digital Twin Registry](https://eclipse-tractusx.github.io). There fore each participant with a registry can provide the functionality to tell a data requestor where the data can be found.

## How to elaborate,"vergrößern" value along the Data Chain? / Build Value with the Network

The [Item Relationship Service](https://eclipse-tractusx.github.io) (IRS) is one tool which can be used, to very easy access distributed linked Data within the Network. To enable Business Logic along the Data Chain. If you want to be the rocket within the network, the IRS is your Service to use!

[//]: # (Felix: Fehlen hier nicht noch der EDC Discovery Service und die beiden Registry Discovery Services für ein vollständiges Bild? Ich habe im Kopf, dass wir einmal alle Komponenten erklären, mit denen ein adopter interagieren muss - da fehlt dann noch das registrieren von EDCs, der Registry und eine Erklärung der Rolle des Backends)

[//]: # (Felix: @Johannes: Hast du dir schon überlegt, wie/wo wir den IRS plazieren wollen? Eher als "Advanced Concept" unter Chapter 4, oder als "Basic Concept" in Chapter 3? )

@Jens

```mermaid
C4Context
title System Context diagram for Catena-X Environment
Boundary(b0, "Catena-X Environment") {
Person(customerCXAssociation, "Catena-X Association", "Association
for certification and standardization of Catena-X")
Person(customerTX, "Tractus-X", "Open-Source Community that
maintains FOSS Components compliant to Catena-X Standards")
:::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

:::

Enterprise_Boundary(b1, "Catena-X Partner Consumer") {
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

Enterprise_Boundary(b2, "Catena-X SaaS Provider (optional)")
{
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.

System(SystemBAAaaS, "Business Application aaS")
:::note

System(SystemEDCAaaS, "EDCaaS")
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**.

}
:::

System(SystemEDCA, "EDC")
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.

System(SystemBAA, "Business Application")
:::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.

Enterprise_Boundary(b3, "Catena-X Partner Provider") {
Enterprise_Boundary(b4, "Catena-X SaaS Provider (optional)")
{
System(SystemBABaaS, "Asset Administration Shell Registry / Digital Twin Registry as a Service")
System(SystemEDCBaaS, "Asset Administration Shell Server or Repository as a Service")
}
System(SystemEDCB, "EDC")
System(SystemDTR, "Asset Administration Shell Registry / Digital Twin Registry")
System(SystemAAS, "Asset Administration Shell Server or Repository")
System(SystemDS, "Any Source System for Data")
}
Enterprise_Boundary(b5, "Catena-X Operating company") {
System(SystemPortal, "Portal")
System(SystemBPDM, "BPDM")
System(SystemDAPS, "DAPS")
}
}
## 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.

BiRel(SystemEDCA, SystemEDCB, "Uses")
:::

BiRel(SystemBAA, SystemDTR, "Uses")
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.

BiRel(SystemBAA, SystemEDCA, "Uses")
With that you are able to speak Catena-X.

BiRel(SystemBAA, SystemAAS, "Uses")
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?

BiRel(SystemAAS, SystemDS, "Uses")
## What else is needed

BiRel(SystemPortal, SystemBPDM, "get BPN")
:::danger

Rel(SystemPortal, SystemEDCA, "configure BPN")
I think we want to describe the architecture a little bit more. Isn't there a predefined description?

```
:::

- highlevel Architecture chart - building block view
- EDC
- BPN
- AAS & Aspectmodelle (Digital Twins)
- Registry
- (IRS)
## The different components

- Architecture principles in Scope of the Journey or Catena-X
- Data Sovereignty
- Interoperability
![cx_architecture](@site/static/img/architecture.drawio.svg)

## Notice

Expand Down
4 changes: 4 additions & 0 deletions static/img/architecture.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9d0a907

Please sign in to comment.