Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(tutorials): publish the e2e adopter journey tutorial #472

Merged
merged 66 commits into from
Nov 28, 2023
Merged
Changes from 1 commit
Commits
Show all changes
66 commits
Select commit Hold shift + click to select a range
a439280
Initial commit to provide the inital tutorials structure
stephanbcbauer Oct 25, 2023
fd22612
Merge pull request #443 from stephanbcbauer/feat/tutorials
stephanbcbauer Oct 25, 2023
ca97ed2
CleanUp tutorials section
stephanbcbauer Oct 25, 2023
4e17163
Provide initial content and structure
stephanbcbauer Oct 25, 2023
a7a4401
Merge pull request #444 from stephanbcbauer/feat/tutorials
stephanbcbauer Oct 25, 2023
f0c9dc8
Merge branch 'eclipse-tractusx:main' into main
stephanbcbauer Oct 26, 2023
067adda
Merge pull request #447 from stephanbcbauer/main
stephanbcbauer Oct 26, 2023
30f2971
Adapt initial structure and content
stephanbcbauer Oct 30, 2023
35b729b
Merge pull request #459 from stephanbcbauer/main
stephanbcbauer Oct 30, 2023
599123b
Added Terraform
JohannesARENA2036 Oct 31, 2023
c47768e
correct typo
MoritzDieckmann Oct 31, 2023
ada6a65
Added commands in shellskrips and a few notes
JohannesARENA2036 Oct 31, 2023
1cd2ac8
Merge branch 'eclipse-tractusx:main' into main
stephanbcbauer Nov 2, 2023
811a321
Added backend integration chapter
gerbigf Nov 2, 2023
249072d
Added generic tutorial description
gerbigf Nov 2, 2023
17bd345
Merge pull request #467 from gerbigf/feat/tutorialIntro
stephanbcbauer Nov 2, 2023
4a0a7de
Merge pull request #466 from gerbigf/feat-onboardingMaterial
stephanbcbauer Nov 2, 2023
74c5243
Merge branch 'eclipse-tractusx:main' into main
stephanbcbauer Nov 2, 2023
733e2c6
initial draft for consume data including request catalog
MoritzDieckmann Nov 6, 2023
02d411e
CleanUp tutorial
stephanbcbauer Nov 7, 2023
16192b7
Merge remote-tracking branch 'eclipse-tractusx/feat/tutorials' into main
stephanbcbauer Nov 7, 2023
697167a
Merge pull request #471 from stephanbcbauer/main
stephanbcbauer Nov 7, 2023
bba55a4
Merge branch 'feat/tutorials' into patch-1
stephanbcbauer Nov 7, 2023
abf1553
Merge branch 'feat/tutorials' into tutorial-moritz
stephanbcbauer Nov 7, 2023
e2de295
Adapt the tutorials documentation
stephanbcbauer Nov 7, 2023
9d0a907
Merge pull request #474 from stephanbcbauer/main
stephanbcbauer Nov 7, 2023
3d6aa68
Typo solved
vialkoje Nov 8, 2023
0c28d5a
Update prerequisites.md
JohannesARENA2036 Nov 8, 2023
be1051e
first draft of the complete consume data part
MoritzDieckmann Nov 8, 2023
047a3da
Update prerequisites.md
JohannesARENA2036 Nov 9, 2023
4e39516
Update prerequisites.md
JohannesARENA2036 Nov 9, 2023
20471d6
Solve issues related to markdown linter
stephanbcbauer Nov 9, 2023
0591274
Merge branch 'feat/tutorials' into patch-1
stephanbcbauer Nov 9, 2023
e20c6f3
Merge pull request #461 from JohannesARENA2036/patch-1
stephanbcbauer Nov 9, 2023
9b24f6a
fix typo
MoritzDieckmann Nov 9, 2023
76ba103
Merge pull request #462 from MoritzDieckmann/tutorial-moritz
stephanbcbauer Nov 9, 2023
9ea9cb0
Update prerequisites.md
JohannesARENA2036 Nov 9, 2023
d4eca56
Corrected introduction part and fixed some types. rephrased data sove…
vialkoje Nov 10, 2023
fb215d1
extended drawing with Discovery elements
vialkoje Nov 11, 2023
9412994
Added the Administration shell components as first draft for discussion
vialkoje Nov 11, 2023
f119ab5
Update prerequisites.md
JohannesARENA2036 Nov 14, 2023
3f0a61b
doc(tutorials): adjustments of chapter3 consume data after review
MoritzDieckmann Nov 16, 2023
46ffad0
doc(tutorials): adjustments of chapter 1 get an Overview after review
MoritzDieckmann Nov 16, 2023
254c369
Merge pull request #498 from MoritzDieckmann/E2E-adopter-Journey-Tuto…
stephanbcbauer Nov 16, 2023
0b86ed9
Merge pull request #497 from MoritzDieckmann/feat/tutorials
stephanbcbauer Nov 16, 2023
80facc6
Merge pull request #490 from JohannesARENA2036/patch-1
stephanbcbauer Nov 16, 2023
793c085
doc(tutorials): Adjustments of chapter 3 provide data after review
MoritzDieckmann Nov 18, 2023
dd9ca07
doc(tutorials): Adjustments of chapter 3 / Restricting users from acc…
MoritzDieckmann Nov 20, 2023
498fe7e
adapt documentation after review
stephanbcbauer Nov 20, 2023
7b73e6f
fix markdownlinter issues
stephanbcbauer Nov 20, 2023
7abba95
Merge pull request #503 from MoritzDieckmann/E2E-Tutorials-Chapter3-P…
stephanbcbauer Nov 20, 2023
757a51f
Merge pull request #504 from MoritzDieckmann/E2E-Tutorial-Chapter3-Re…
stephanbcbauer Nov 20, 2023
d132a31
doc(tutorials): Minor adjustments on chapter3/Consume Data
MoritzDieckmann Nov 20, 2023
efcc217
Merge pull request #505 from MoritzDieckmann/E2E-Tutorial-Consume-Data
stephanbcbauer Nov 20, 2023
4292d5a
adapt provideData after review
stephanbcbauer Nov 20, 2023
e545ad5
solve markdown linter issue
stephanbcbauer Nov 20, 2023
9d98bbf
adapt restrictData after review
stephanbcbauer Nov 20, 2023
ecd37f1
fix typos and adapt documentation after review
stephanbcbauer Nov 20, 2023
d79f01e
solve bash command issue
stephanbcbauer Nov 20, 2023
2e7df24
Merge pull request #476 from vialkoje/patch-1
stephanbcbauer Nov 23, 2023
cdc266b
Adapt changes on architecture for Jens
stephanbcbauer Nov 23, 2023
e058fee
Add newblog entry for tutorials
stephanbcbauer Nov 24, 2023
6aa5c55
Adaptation after review
stephanbcbauer Nov 24, 2023
ca7584c
Add changelog to e2e tutorial
stephanbcbauer Nov 28, 2023
1a9711c
Delete company names
stephanbcbauer Nov 28, 2023
0493a90
Delete unused querySpec properties
stephanbcbauer Nov 28, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Adapt changes on architecture for Jens
stephanbcbauer authored Nov 23, 2023
commit cdc266bf5b993ced189b27f5ec8b27bcd16a6804
41 changes: 15 additions & 26 deletions docs/tutorials/e2e/inform/architecture.md
Original file line number Diff line number Diff line change
@@ -19,13 +19,21 @@ 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 within the [onboarding process](https://catena-x.net/en/catena-x-introduce-implement/onboarding).
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

@@ -51,7 +59,7 @@ This is realized with [Asset Administration Shell](https://eclipse-tractusx.gith

With that you are able to speak Catena-X.

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.
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.

To tackle these concerns the Industry-Standard for Digital Twins, the [Asset Administration Shell](https://industrialdigitaltwin.org) is referenced.
@@ -62,37 +70,18 @@ To tackle these concerns the Industry-Standard for Digital Twins, the [Asset Adm

"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.

"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
"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

"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.

:::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.

:::


## What else is needed

Managed Identity Wallet - the Managed Identity wallet provides a service where you can store your credentials for any Catena-X services in a safe place, when you do not want to implement your own wallet.

Keycloak - is the place, where ...
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.

:::danger

I think we want to describe the architecture a little bit more. Isn't there a predefined description?

:::
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

:::info

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.

:::

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

## Notice