Skip to content
Merged
Changes from all commits
Commits
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
98 changes: 40 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,93 +1,75 @@
# Tractus-X EDC (Eclipse Dataspace Connector)
# Construct-X EDC

[![Contributors][contributors-shield]][contributors-url]
[![Stargazers][stars-shield]][stars-url]
[![Apache 2.0 License][license-shield]][license-url]

[![Latest Release][release-shield]][release-url]
[![Latest Snapshot][snapshot-shield]]()
[Construct-X](https://www.construct-x.org/) specific Eclipse Dataspace Connector distributions and extensions, based on the [Eclipse Tractus-X EDC](https://github.com/eclipse-tractusx/tractusx-edc).

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=eclipse-tractusx_tractusx-edc&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=eclipse-tractusx_tractusx-edc)
## Overview

Container images and deployments of the Eclipse Dataspace Components for the Tractus-X project.
The Construct-X EDC extends the Eclipse Tractus-X EDC with
Construct-X specific policies, extensions and configurations.

Please also refer to:
This repository provides:
- Construct-X specific EDC extensions
- Control-Plane and Data-Plane distributions
- Helm charts and docker compose
- Local development and testing environments

- [Our docs](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/docs)
- [Our Releases](https://github.com/eclipse-tractusx/tractusx-edc/releases)
- [Eclipse Dataspace Components](https://github.com/eclipse-edc/Connector)
- [Report Bug / Request Feature](https://github.com/eclipse-tractusx/tractusx-edc/issues)
## Inventory

## About The Project
The Construct-X EDC is split into a Control Plane and a Data Plane.

The project provides pre-built control- and data-plane [docker](https://www.docker.com/) images
and [helm](https://helm.sh/) charts of
the [Eclipse DataSpaceConnector Project](https://github.com/eclipse-edc/Connector).
The Control Plane is responsible for resource management,
contract negotiation and transfer orchestration.

## Inventory
The Data Plane handles the actual transfer of data streams.

The eclipse data space connector is split up into Control-Plane and Data-Plane, whereas the Control-Plane functions as
administration layer and has responsibility of resource management, contract negotiation and administer data transfer.
The Data-Plane does the heavy lifting of transferring and receiving data streams.
### Control Plane distributions

Control-Plane distribution:

- [edc-controlplane-postgresql-hashicorp-vault](edc-controlplane/edc-controlplane-postgresql-hashicorp-vault) with
dependency onto
- [edc-controlplane-postgresql-hashicorp-vault](edc-controlplane/edc-controlplane-construct-x/con-x-controlplane-postgresql-hashicorp-vault) with
dependencies on
- [Hashicorp Vault](https://www.vaultproject.io/)
- [PostgreSQL 8.2 or newer](https://www.postgresql.org/)
- [edc-runtime-memory](edc-controlplane/edc-runtime-memory)

Data-Plane distribution:
### Data Plane distributions

- [edc-dataplane-hashicorp-vault](edc-dataplane/edc-dataplane-hashicorp-vault) with dependency onto
- [edc-dataplane-hashicorp-vault](edc-dataplane/edc-dataplane-construct-x/con-x-dataplane-postgresql-hashicorp-vault) with dependencies on
- [Hashicorp Vault](https://www.vaultproject.io/)
Comment thread
rgalan-dev marked this conversation as resolved.

For testing/development purposes:
## Upstream References

- [edc-runtime-memory](edc-controlplane/edc-runtime-memory)

## Getting Started
- [Eclipse Tractus-X EDC](https://github.com/eclipse-tractusx/tractusx-edc)
- [Eclipse Dataspace Components](https://github.com/eclipse-edc/Connector)

### Build
## Construct-X Extensions

Build Tractus-X EDC together with its Container Images
Construct-X adds custom integrations and runtime extensions
on top of the Eclipse Tractus-X EDC.

```shell
./gradlew dockerize
```
This includes:
- Construct-X specific policy extensions
- Custom credential handling
- Wallet integration support
- Local testbed environments

## Known Incompatibilities
## Getting Started

- Hashicorp Vault 1.18.1 is not compatible with the EDC due to a bug in the vault concerning path handling
- [Internal Issue](https://github.com/eclipse-tractusx/tractusx-edc/issues/1772)
- [Hashicorp Vault Issue](https://github.com/hashicorp/vault/issues/29357)
The local testbed provides a lightweight environment for local Construct-X EDC development and integration testing.
It is the recommended starting point for developers getting started with the Construct-X EDC.

- [Construct-X Local Testbed](https://github.com/project-construct-x/constructx-edc/blob/develop/edc-controlplane/edc-controlplane-construct-x/local/README.md)

## Contributing
See [CONTRIBUTING](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/CONTRIBUTING.md).
See [CONTRIBUTING](https://github.com/project-construct-x/constructx-edc/blob/develop/CONTRIBUTING.md).

## License

Distributed under the Apache 2.0 License.
See [LICENSE](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) for more information.
See [LICENSE](https://github.com/project-construct-x/constructx-edc/blob/develop/LICENSE) for more information.

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[contributors-shield]: https://img.shields.io/github/contributors/eclipse-tractusx/tractusx-edc.svg?style=for-the-badge

[contributors-url]: https://github.com/eclipse-tractusx/tractusx-edc/graphs/contributors

[stars-shield]: https://img.shields.io/github/stars/eclipse-tractusx/tractusx-edc.svg?style=for-the-badge

[stars-url]: https://github.com/eclipse-tractusx/tractusx-edc/stargazers

[license-shield]: https://img.shields.io/github/license/eclipse-tractusx/tractusx-edc.svg?style=for-the-badge

[license-url]: https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE

[release-shield]: https://img.shields.io/github/v/release/eclipse-tractusx/tractusx-edc.svg?style=for-the-badge

[release-url]: https://github.com/eclipse-tractusx/tractusx-edc/releases

[snapshot-shield]: https://img.shields.io/badge/dynamic/regex?url=https%3A%2F%2Fraw.githubusercontent.com%2Feclipse-tractusx%2Ftractusx-edc%2Frefs%2Fheads%2Fgh-pages%2Fmisc%2Flatest-versioned-snapshot.txt&search=.*&style=for-the-badge&label=Latest-Snapshot
[license-shield]: https://img.shields.io/github/license/project-construct-x/constructx-edc.svg?style=for-the-badge
[license-url]: https://github.com/project-construct-x/constructx-edc/blob/develop/LICENSE
Loading