Skip to content

Commit

Permalink
Merge pull request eclipse-tractusx#8 from jkbquabeck/benedikt/connect
Browse files Browse the repository at this point in the history
docs: Update Connect & deployComponents Chapter
  • Loading branch information
jkbquabeck authored Jun 24, 2024
2 parents 94bece3 + f78cb4a commit ba0b0f3
Show file tree
Hide file tree
Showing 3 changed files with 595 additions and 262 deletions.
59 changes: 37 additions & 22 deletions docs/tutorials/e2e/connect/connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,44 +3,59 @@ title: "Chapter 2: Connect"
sidebar_position: 4
---

The `Connect Chapter` describes step by step how you have to setup your local enviroment of your own data space including a kubernetes cluster, services, networking and security. On this stack you will deploy the components that you need for data provisioning and data consumption. Along with that you will deploy all the components that simulate the core service provider in our data space. You will use the technology of Umbrella Helm Charts to configure and deploy your environment.
The `Connect Chapter` describes step by step **how to setup your local environment** of your own data space including a kubernetes cluster, services, networking and security.

:::info

Make sure that you have understood and carried out all the steps in the `Prerequisites chapter` before you start deploying the components.

:::

On this stack you will **deploy the components** that you need for data provisioning and data consumption (decentral components). Along with that you will deploy all the components that simulate the core service provider in our data space (central components).

You will use the technology of **Umbrella Helm Charts** to configure and deploy your environment. The Umbrella Helm Chart will contain the components shown in the following table.

|Quantity|Component|Function|Version|Type|GitHub-Link|
|---|---|---|---|---|---|
|1|Portal|The Portal is designed to work with the IAM.|1.8.1|Central Component|[Link](https://github.com/eclipse-tractusx/portal)|
|1|Central IdP|The Identity Provider (IdP) authenticates users and provides identity information to service providers, enabling secure access to applications and services.|2.1.0|Central Component||
|1|Shared IdP|An Identity Provider (IdP) authenticates users and provides identity information to service providers, enabling secure access to applications and services.|2.1.0|Central Component||
|1|Discovery Finder|The Discovery Finder is used to find endpoints of BPN Discoveries for a specific type, e.g. "oen".|0.2.2|Central Component|[Link](https://github.com/eclipse-tractusx/sldt-discovery-finder)|
|1|BPN Discovery|The BPN Discovery is used to lookup for a specific type/key-combination to a Business Partner Number (BPN). For example looking for a combination "oen / oen-133" will lead to "BPNLXYZ123".|0.2.2|Central Component|[Link](https://github.com/eclipse-tractusx/sldt-bpn-discovery)|
|1|SD Factory|Self-Description Factory (SD-Factory) component is responsible for the creation of Self Descriptions.|2.1.19|Central Component|[Link](https://github.com/eclipse-tractusx/sd-factory)|
|1|Managed Identity Wallet|The Managed Identity Wallets (MIW) service implements the Self-Sovereign-Identity (SSI) using did:web.|0.4.0|Central Component|[Link](https://github.com/eclipse-tractusx/managed-identity-wallet)|
|1|Semantic Hub|The Semantic Hub in Catena-X is a central element for supporting semantic interoperability within the network.|0.2.2|Central Component|[Link](https://github.com/eclipse-tractusx/sldt-semantic-hub)|
|3|Eclipse Dataspace Connector|The Eclipse Dataspace Connector enables secure and controlled data sharing and usage within dataspaces, creating interoperability and trust between different organisations.|0.5.3|Decentral Component|[Link](https://github.com/eclipse-tractusx/tractusx-edc)|
|3|Vault|A vault is used for the secure storage, management and access control of sensitive data such as secrets, tokens, passwords and encryption keys.|0.20.0|Decentral Component||
|1|Digital Twin Registry (DTR)|Digital twins can be registered in the Digital Twin Registry so that they can be found by other participants.|0.4.5|Decentral Component|[Link](https://github.com/eclipse-tractusx/sldt-digital-twin-registry)|
|1|Simple Data Backend|The Simple Databackend simulates a backend, i.e. a place where the digital twins are stored.|0.1.0|Decentral Component||

:::info

This tutorial is

- designed for developers who want to get their hands dirty, for companies that want to perform data exchange in actual Catena-X data space infrastructure and generally for curious minds who want to explore dataspaces.
- a preconfigured closed environment in one Kubernetes cluster, where the different services located in docker containers communicate within their joint Kubenets cluster, generated by minikube.

:::

:::warning

This tutorial is [not]

- a production environment
- designed to work across different locations

Required knowledge and skills:

- Beginner level docker and kubernetes
- Begninner level Minikube
- Beginner level Helm Charts
- Basic understanding of network and web based communication
- Basic linux system commands

## Components & Architecture

By performing this tutorial a data space will be set up including the following components:

- starting with 2 Tractus-X EDC Connectors (Called Bob and Alice). The EDC is the key component to exchanging data within data spaces.
- 1 Managed Identity Wallet. The Managed Identity Wallet (MIW) service is a central component storing technical identities. Connectors can request the identity, including properties, in order to take decisions if a contract-offer will be made, a contract agreement will be negotiated, or a data-exchange will be processed.
- 1 Keycloak instance. Keycloak is used for Identity and Access Management of technical users.
- 1 Postgres data base. A data base building the foundation for the MXD setup.
- It will be extende by a thrid Tractus-X EDC Connector (called Judy) to allow applying different policies
:::

It further in a second step will be extended the configuration by bringing up a portal We now will start with teh next section deploy to bring up the Kubernetes clsuer with minkube and the frist Umbrella Helm Charts.
We now will start with the next section `Deploying the Components` where you will deploy the components listed in the table.

## Notice

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2023 sovity GmbH
- SPDX-FileCopyrightText: 2023 SAP SE
- SPDX-FileCopyrightText: 2023 msg systems AG
- SPDX-FileCopyrightText: 2024 sovity GmbH
- SPDX-FileCopyrightText: 2024 SAP SE
- SPDX-FileCopyrightText: 2024 msg systems AG
- Source URL: [https://github.com/eclipse-tractusx/eclipse-tractusx.github.io](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io)
Loading

0 comments on commit ba0b0f3

Please sign in to comment.