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

Separated introduction section of MXD tutorial #95

Merged
Merged
50 changes: 50 additions & 0 deletions mxd/1_MXD_Introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 1 Introduction

With the Minimum Tractus-X Dataspace, IT departments can set up their own little data space to perform a data exchange between two parties (Bob and Alice in our example). The MXD can be used as a sandbox for testing.
jkbquabeck marked this conversation as resolved.
Show resolved Hide resolved
jkbquabeck marked this conversation as resolved.
Show resolved Hide resolved

For whom is that relevant?
jkbquabeck marked this conversation as resolved.
Show resolved Hide resolved
This tutorial is designed for companies that want to perform data exchange in a "real" Catena-X data space infrastructure.
jkbquabeck marked this conversation as resolved.
Show resolved Hide resolved

Who should execute the tutorial?
jkbquabeck marked this conversation as resolved.
Show resolved Hide resolved
IT-Employees with the following skills and previous experience:
jkbquabeck marked this conversation as resolved.
Show resolved Hide resolved

- Beginner level docker and kubernetes
- Beginner level terraform
- Basic linux system commands

## 1.1 Components & Architecture

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

- 2 EDC Connectors (Called Bob and Alice)
- 1 Managed Identity Wallet
jkbquabeck marked this conversation as resolved.
Show resolved Hide resolved
- 1 Keycloak instance
- 1 Postgres data base

## 1.2 Prerequisites

In order to run the Minimum Tractus-X Dataspace "MXD" on your local machine, please make sure the following
jkbquabeck marked this conversation as resolved.
Show resolved Hide resolved
preconditions are met.

- Have a local Kubernetes runtime ready. We've tested this setup with [KinD](https://kind.sigs.k8s.io/), but other
runtimes such as [Minikube](https://minikube.sigs.k8s.io/docs/start/) may work as well, we just haven't tested them. All following instructions will assume KinD.
- Install [Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli).
- a POSIX-compliant shell, e.g. `bash` or `zsh` unless stated otherwise
- basic knowledge about Helm and Kubernetes
- [Optional] a cli tool to easily print logs of a K8S deployment, such as [`stern`](https://github.com/stern/stern)
- [Optional] a graphical tool to inspect your Kubernetes environment, such as [Lens](https://k8slens.dev/).
Not mandatory of course, but all screenshots in this doc are created off of Lens.
- [Optional] a graphical tool to inspect Postgres databases, such as [PgAdmin](https://www.pgadmin.org/). Screenshots in
this guide are created off of PgAdmin.
- [Optional] a graphical tool to send REST requests, such as [Postman](https://www.postman.com/). This sample will
include Postman collections that can be imported.

## 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
- Source URL: [https://github.com/eclipse-tractusx/tutorial-resources](https://github.com/eclipse-tractusx/tutorial-resources)