Skip to content

Commit

Permalink
docs: IDS cleanup and replace with DSP
Browse files Browse the repository at this point in the history
  • Loading branch information
majadlymhmd committed Sep 6, 2023
1 parent be8fcd6 commit 0f42a52
Show file tree
Hide file tree
Showing 12 changed files with 21 additions and 24 deletions.
2 changes: 1 addition & 1 deletion basic/basic-03-configuration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ web.http.management.path=/management
```

_**Caution**: If you do not provide this configuration, it leads to the problem that the authentication mechanism is
also applied to EVERY request in the _default_ context of Jetty, which includes the IDS communication between two
also applied to EVERY request in the _default_ context of Jetty, which includes the DSP communication between two
connectors._

---
Expand Down
10 changes: 5 additions & 5 deletions transfer/transfer-01-file-transfer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ more sophisticated storage locations, like a database or a cloud storage.
This is quite a big step up from the previous sample, where we ran only one connector. Those are the concrete tasks:

* Creating an additional connector, so that in the end we have two connectors, a consumer and a provider
* Providing communication between provider and consumer using IDS multipart messages
* Providing communication between provider and consumer using DSP multipart messages
* Utilizing the management API to interact with the connector system
* Performing a contract negotiation between provider and consumer
* Performing a file transfer
Expand Down Expand Up @@ -120,7 +120,7 @@ implementation(libs.edc.auth.tokenbased)
```

Three of these dependencies are new and have not been used in the previous samples:
1. `data-protocols:ids`: contains all IDS modules and therefore enables IDS Multipart communication with other connectors
1. `data-protocols:dsp`: contains all DSP modules and therefore enables DSP Multipart communication with other connectors
2. `extensions:iam:iam-mock`: provides a no-op identity provider, which does not require certificates and performs no checks
3. `extensions:api:auth-tokenbased`: adds authentication for management API endpoints

Expand All @@ -136,7 +136,7 @@ implementation(project(":transfer:transfer-01-file-transfer:transfer-file-local"
We also need to adjust the provider's `config.properties`. The property `edc.samples.transfer.01.asset.path` should
point to an existing file in our local environment, as this is the file that will be transferred. We also configure a
separate API context for the management API, like we learned in previous chapter. Then we add the property
`edc.dsp.callback.address`, which should point to our provider connector's IDS address. This is used as the callback
`edc.dsp.callback.address`, which should point to our provider connector's DSP address. This is used as the callback
address during the contract negotiation. Since the DSP API is running on a different port (default is `8282`), we set
the webhook address to `http://localhost:8282/protocol` accordingly.

Expand All @@ -149,8 +149,8 @@ We configure the consumer's API ports in `consumer/config.properties`, so that i
provider. In the config file, we also need to configure the API key authentication, as we're going to use
endpoints from the EDC's management API in this sample and integrated the extension for token-based API
authentication. Therefore, we add the property `edc.api.auth.key` and set it to e.g. `password`. And last, we also need
to configure the consumer's webhook address. We expose the IDS API endpoints on a different port and path than other
endpoints, so the property `edc.dsp.callback.address` is adjusted to match the IDS API port.
to configure the consumer's webhook address. We expose the DSP API endpoints on a different port and path than other
endpoints, so the property `edc.dsp.callback.address` is adjusted to match the DSP API port.

The consumer connector also needs the `status-checker` extension for marking the transfer as completed on the consumer
side.
Expand Down
2 changes: 1 addition & 1 deletion transfer/transfer-04-open-telemetry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ which has to be stored in the root folder of this sample as well. The only addit
WEB_HTTP_PATH: /api
WEB_HTTP_MANAGEMENT_PORT: 8182
WEB_HTTP_MANAGEMENT_PATH: /management
IDS_WEBHOOK_ADDRESS: http://consumer:8181
DSP_WEBHOOK_ADDRESS: http://consumer:8181
volumes:
- ../:/samples
ports:
Expand Down
4 changes: 2 additions & 2 deletions transfer/transfer-04-open-telemetry/contractoffer.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@
},
"asset": {
"properties": {
"ids:byteSize": null,
"dsp:byteSize": null,
"asset:prop:id": "test-document",
"ids:fileName": null
"dsp:fileName": null
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions transfer/transfer-04-open-telemetry/docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ services:
WEB_HTTP_PATH: /api
WEB_HTTP_MANAGEMENT_PORT: 9192
WEB_HTTP_MANAGEMENT_PATH: /management
WEB_HTTP_IDS_PORT: 9292
WEB_HTTP_IDS_PATH: /protocol
IDS_WEBHOOK_ADDRESS: http://consumer:9292
WEB_HTTP_DSP_PORT: 9292
WEB_HTTP_DSP_PATH: /protocol
DSP_WEBHOOK_ADDRESS: http://consumer:9292
EDC_API_AUTH_KEY: password
volumes:
- ../:/samples
Expand All @@ -37,7 +37,7 @@ services:
WEB_HTTP_PATH: /api
WEB_HTTP_MANAGEMENT_PORT: 8182
WEB_HTTP_MANAGEMENT_PATH: /management
IDS_WEBHOOK_ADDRESS: http://provider:8282
DSP_WEBHOOK_ADDRESS: http://provider:8282
EDC_SAMPLES_TRANSFER_01_ASSET_PATH: /samples/transfer-04-open-telemetry/input-file.txt
volumes:
- ../:/samples
Expand Down
4 changes: 2 additions & 2 deletions transfer/transfer-06-consumer-pull-http/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ java -Dedc.keystore=transfer/transfer-06-consumer-pull-http/certs/cert.pfx -Dedc
```

Assuming you didn't change the ports in config files, the consumer will listen on the
ports `29191`, `29192` (management API) and `29292` (IDS API) and the provider will listen on the
ports `12181`, `19182` (management API) and `19282` (IDS API).
ports `29191`, `29192` (management API) and `29292` (DSP API) and the provider will listen on the
ports `12181`, `19182` (management API) and `19282` (DSP API).

# Run the sample

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
edc.participant.id=consumer
edc.ids.id=urn:connector:consumer
edc.dsp.id=urn:connector:consumer
edc.dsp.callback.address=http://localhost:29194/protocol
web.http.port=29191
web.http.path=/api
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
edc.participant.id=provider
edc.ids.id=urn:connector:provider
edc.dsp.id=urn:connector:provider
edc.dsp.callback.address=http://localhost:19194/protocol
web.http.port=19191
web.http.path=/api
Expand Down
4 changes: 2 additions & 2 deletions transfer/transfer-07-provider-push-http/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ java -Dedc.keystore=transfer/transfer-07-provider-push-http/certs/cert.pfx -Dedc
```

Assuming you didn't change the ports in config files, the consumer will listen on the
ports `29191`, `29193` (management API) and `29194` (IDS API) and the provider will listen on the
ports `19191`, `19193` (management API) and `19194` (IDS API).
ports `29191`, `29193` (management API) and `29194` (DSP API) and the provider will listen on the
ports `19191`, `19193` (management API) and `19194` (DSP API).

# Run the sample

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ plugins {

repositories {
mavenCentral()
maven {
url = uri("https://maven.iais.fraunhofer.de/artifactory/eis-ids-public/")
}
}

dependencies {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
edc.ids.id=urn:connector:consumer
edc.dsp.id=urn:connector:consumer
edc.participant.id=consumer
edc.dsp.callback.address=http://localhost:29194/protocol
web.http.port=29191
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
edc.ids.id=urn:connector:provider
edc.dsp.id=urn:connector:provider
edc.participant.id=provider
edc.dsp.callback.address=http://localhost:19194/protocol
web.http.port=19191
Expand Down

0 comments on commit 0f42a52

Please sign in to comment.