Easy to build and run EDC components

This project provides an easy to build and run of Control-Plane and Data-Plane with a simple backend data service.

Inventory

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. The backend data service is just for creating and retrieving some dummy string values via API-Calls.

Controlplane

• edc-controlplane-memory

Data-Plane

• edc-dataplane

Backend data service

• backend-data-service

Self signed certificates for only development purpose can be found here

• certs

API-Wrapper (pre-build docker image from catenax-at-home)

• api-wrapper

Omejdn (pre-build docker image for DAPS from Fraunhofer)

• omejdn

EDC-Callback-Service to receive the EndPointDataReference with token

• edc-callback-service

Prerequisites

EDC artifacts

Since the EDC does not yet publish artifacts to a maven repository, which this project relies on, it needs to be built upfront to be used:

git submodule update --init
cd edc && ./gradlew publishToMavenLocal -x test -Pskip.signing=true

Build

Build EDC-Controlplane-Memory

cd edc-controlplane-memory && ./gradlew clean build

Build EDC-Controlplane-Memory with DAPS (Omejdn)

cd edc-controlplane-memory-daps && ./gradlew clean build

Build EDC-Dataplane

cd edc-dataplane && ./gradlew clean build

Build Backend-Data-Service

cd backend-data-service && ./gradlew clean build

Build EDC-Callback-Service

cd edc-callback-service && ./gradlew clean build

Run

This project contains multiple modules as docker-compose files which can be run separately or in combination within the same docker-network.

• dc-provider-bds.yml: Provider EDC with a dummy backend-data-service.
• dc-provider-daps.yml: Provider EDC with DAPS (Omejdn) integration.
• dc-consumer.yml: Consumer EDC.
• dc-consumer-daps.yml: Consumer EDC with DAPS (Omejdn) integration.
• dc-daps.yml: Pre-build DAPS (Omejdn) server.
• dc-api-wrapper.yml: Pre-build API-Wrapper.
• dc-edc-callback-service.yml: A simple Callback-Service to receive the EndpointReference from EDC.

To run each of them separately or in combination please use the following command:

Run single component:

docker-compose -f <docker-compose-file-name> up --build

Run multiple components in same docker network:

docker-compose -f <docker-compose-file-name> ... -f <docker-compose-file-name> up --build 

To run a Provider-EDC and Consumer-EDC using DAPS and API-Wrapper:

docker-compose -f dc-provider-bds-daps.yml -f dc-consumer-daps.yml -f dc-daps.yml -f dc-api-wrapper.yml up --build

To run a Provider-EDC and Consumer-EDC using DAPS without API-Wrapper and using edc-callback-service to receive EndpointReference:

docker-compose -f dc-provider-bds-daps.yml -f dc-consumer-daps.yml -f dc-daps.yml -f dc-edc-callback-service.yml up --build

Please check also consumer_cp_configuration.properties to use edc-callback-service:
# when you use the edc-callback-service without API-Wrapper
edc.receiver.http.endpoint=http://edc-callback-service:8080/callback/endpoint-data-reference

Test

With the Postman Collection "edc-base-dev_API-Calls.postmann_collection.json" you can test the whole setup including API-Wrapper.

With the Postman Collection "edc-base-dev_API-Calls_without_API-Wrapper" you can test the whole setup without using the API-Wrapper. Please consider the Information in API Names and adjust the calls accordingly.

Known Issues

The following SF4J Error can be ignored:

java.lang.AbstractMethodError: Receiver class org.eclipse.dataspaceconnector.boot.monitor.MonitorProvider does not define or inherit an implementation of the resolved method 'abstract java.lang.String getRequestedApiVersion()' of interface org.slf4j.spi.SLF4JServiceProvider.