Build

Take a look at the more detailed instructions to deploy the Dataspace Connector.

If you want to set up the Dataspace Connector yourself, follow the instructions below. If you encounter any problems, please have a look at the FAQ.

Clone the project: git clone https://github.com/International-Data-Spaces-Association/DataspaceConnector.git

For configurations, please have a look at this section first.

In the following, the deployment with Maven, Docker, and Kubernetes will be explained.

Maven

If you want to build and run locally, ensure that at least Java 17 is installed. Then, follow these steps:

  1. Execute cd DataspaceConnector and mvn clean package.
  2. The connector can be started by running the Spring Boot Application. Therefore, navigate to /target and run java -jar dataspaceconnector-{VERSION}.jar.

If everything worked fine, the connector is available at https://localhost:8080/ and its API can be accessed at https://localhost:8080/api.

The OpenApi documentation can be viewed at https://localhost:8080/api/docs. The .json representation is available at https://localhost:8080/v3/api-docs. The .yaml file can be downloaded at https://localhost:8080/v3/api-docs.yaml.

By default, the Dataspace Connector is running with an H2 database that is non persistent. See how to change that here. The database can be accessed via https://localhost:8080/database.

Note: After successfully building the project, the Javadocs as a static website can be found at /target/apidocs. Open the index.html in a browser of your choice.

The connector provides several endpoints for resource database handling and IDS messaging. Details on how to interact with them can be found here.

  • Connector and Usage Control provide information about the running connector and settings for contract negotiation and policy enforcement behaviour.
  • Messages provides endpoints for requesting artifact (data) and descriptions (metadata) from an external connector, and negotiate contracts. On top of that, endpoints for sending IDS multipart messages to e.g. the IDS Metadata Broker are provided.
  • All other sections provide endpoints for metadata and data management and entity relations (POST, PUT, GET, and DELETE).

Next to the endpoint implemented by the connector, an endpoint for handling incoming IDS messages at /api/ids/data is provided by the IDS Messaging Services. This endpoint is the one listening to incoming IDS messages.

Profiles

The pom.xml provides three Maven profiles: no-documentation, no-tests, and release. The first one skips the Javadocs generation, the second one skips the execution of tests. The release profile shows all warnings and errors. To run a profile, please have a look at this guide.

Plugins

Plugin Command Description
Jacoco mvn jacoco:report With this, a full software report is generated.
Checkstyle mvn checkstyle:check With this, a code style check is executed.
Spotbugs mvn spotbug:check With this, a SpotBugs check is executed.
Statistics mvn verify site With this, project statistics are generated.
License mvn license:format With this, a license header is added to all projects files.

Tests

Tests will be executed automatically when running Maven commands package, verify, install, site, or deploy. To run tests manually, execute the following commands in the root directory of the project:

  • Run all tests: mvn test
  • Run specific test class: mvn test -Dtest=[full class name]
  • Run a specific test case (single method): mvn test -Dtest=[full class name]#[method name]

Docker

If you want to deploy in Docker and build the Maven project with the Dockerfile, follow these steps:

Option 1: Build and run Docker image

  1. Navigate to DataspaceConnector. To build the image, run docker build -t <IMAGE_NAME:TAG> . (e.g. docker build -t dataspaceconnector .).
  2. For running your image as a container, follow these instructions: docker run --publish 8080:8080 --detach --name dsc-container <IMAGE_NAME:TAG>

Option 2: Using Docker Compose

  1. The docker-compose.yml sets up the connector application and a PostgreSQL database. If necessary, make your changes in the connector.env and postgres.env. Please find more details about setting up different databases here.
  2. For starting the application, run docker-compose up. Have a look at the docker-compose.yaml and make your own configurations if necessary.

Note: Environment variables will overwrite the Spring Boot settings.

If you want to create a custom Docker setup, note that we provide Docker images. These can be found here. The GitHub Container Registry (GHCR) allows to download Docker images without credentials. You will find an image for each release tag with the corresponding version. In addition, an image of the main branch is automatically provided as soon as changes are identified.

Kubernetes

For a deployment with Kubernetes, have a look at this documentation.