Skip to content

Deprecated_2. Step (Configuration)

Jump to bottom
Igor Petrov edited this page May 7, 2024 · 1 revision

To access the Mobility Data Space in a convenient way you have to install and configure the MDS Version of the Eclipse Dataspace Connector.

We strongly recommend that you use docker-images and start the connector deployment via docker-compose.

Expected audience of this tutorial: We assume, the reader of this tutorial to be familiar with software development and software deployment in corporate infrastructures. Thus, no introduction is given to setup the basics like Java, Docker, etc. Please also take measures to secure the Connector (change default passwords etc.)

MDS Test environment

  1. Clone or download the version 4.2.1 of the MDS EDC connector

  2. Check the settings. Open the docker-compose.yaml file.

Ensure that Clearing House, Broker and DAPS environment variables are pointing to the test environment:

    EDC_OAUTH_TOKEN_URL: https://daps.test.mobility-dataspace.eu/token
    EDC_OAUTH_PROVIDER_JWKS_URL: https://daps.test.mobility-dataspace.eu/jwks.json
    EDC_BROKER_BASE_URL: https://broker.test.mobility-dataspace.eu
    EDC_CLEARINGHOUSE_LOG_URL: https://clearing.test.mobility-dataspace.eu/messages/log

Ensure that Broker extension is switched off:

    BROKER_CLIENT_EXTENSION_ENABLED: false
    CLEARINGHOUSE_CLIENT_EXTENSION_ENABLED: true

Open the .env file. Ensure the EDC Image you are using is edc-ce-mds:[release version].

  1. Adjust the Connector metadata.
  # Connector Technical Name
  MY_EDC_NAME_KEBAB_CASE: "example-connector"

  # Connector Localized Name / Title
  MY_EDC_TITLE: "EDC Connector"

  # Connector Description Text
  MY_EDC_DESCRIPTION: "Community Edition EDC Connector by sovity"

  # Connector Curator
  # The company using the EDC Connector, configuring data offers, etc.
  MY_EDC_CURATOR_URL: "https://yourcompany.de"
  MY_EDC_CURATOR_NAME: "Your Company GmbH"

  # Connector Maintainer
  # The company hosting the EDC Connector
  MY_EDC_MAINTAINER_URL: "https://example.com"
  MY_EDC_MAINTAINER_NAME: "Example GmbH"

  # Connector Domain
  MY_EDC_FQDN: "connector.com"

  # Connector Base URL
  MY_EDC_IDS_BASE_URL: "http://connector.com:11003"

  # Connector Catalog URLs
  EDC_UI_CATALOG_URLS= http://connector.com:11003/api/v1/ids/data

Please be aware, that three last attributes are aligned with each other and with the domain in your certificate.

  1. Use your certificate. For this you need a jks certificate and a SKI:AKI combination
  • Make sure you're on Linux or on a bash console (e.g. WSL or Git Bash) and have openssl and keytool installed
  • Navigate in the console to the docs/getting-started/secrets directory
  • Run the script ./generate_ski_aki.sh [filepath].p12 [password] and substitute [filepath] to the p12 certificate filepath and [password] to the certificate password (default: password). Please be aware that you are using the p12 certificate issued for the MDS test environment.
  • The jks file will be generated in the same folder as your p12 file and the SKI/AKI combination is printed out in the console.
  • Copy the SKI:AKI combination to the variable EDC_OAUTH_CLIENT_ID and add it also as EDC_PARTICIPANT_ID in the .env file.
  • If you want to rename or to move the jks keystore file, adjust variable EDC_KEYSTORE in the docker-compose file to use the correct path (relative to docs/getting-started/secrets) and the correct file name.
  1. Start EDC via docker.
  • Login into GitHub Container Registry (GHCR): $ docker login ghcr.io You can also login using a GitHub token: echo [token] | docker login ghcr.io -u [username] --password-stdin
  • Fetch latest images via $ docker compose pull in the docker-compose file folder
  • Start via $ docker compose up
  • Open the MDS EDC Frontend (in case of a local deployment by default under http://localhost:11000/dashboard)

1

Congratulations! You are now running the MDS version of the EDC connector. Please check the MDS Test Environment Broker. Your connector shall be visible at the broker.

For further information (a.o. our Postman collection) see our Q&A section.

MDS Productive environment

Change following environment variables in the docker-compose.yaml file.

    EDC_OAUTH_TOKEN_URL: https://daps.mobility-dataspace.eu/token
    EDC_OAUTH_PROVIDER_JWKS_URL: https://daps.mobility-dataspace.eu/jwks.json
    EDC_BROKER_BASE_URL: https://broker.mobility-dataspace.eu
    EDC_CLEARINGHOUSE_LOG_URL: https://clearing.mobility-dataspace.eu/messages/log

Now they are pointing to the MDS productive environment. Then follow the steps described above. Be aware that you are using the p12 certificate issued for the MDS productive environment.

Please do not use the MDS Productive Environment Broker for test purposes!

Clone this wiki locally