Skip to content

Commit 2319efe

Browse files
authored
Merge b75a48a into 3ed597e
2 parents 3ed597e + b75a48a commit 2319efe

File tree

2 files changed

+61
-5
lines changed

2 files changed

+61
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ recipes.
2020
<!-- param::isNotitle::true:: -->
2121

2222
- [Overview](#overview)
23+
- [Release Information](#release-information)
2324
- [Components](#components)
2425
- [Description of flows in a data space](#description-of-flows-in-a-data-space)
2526
- [Onboarding of an organization in the data space](#onboarding-of-an-organization-in-the-data-space)
@@ -46,7 +47,6 @@ recipes.
4647
</details>
4748

4849

49-
5050
## Overview
5151

5252
The FIWARE Data Space Connector is an integrated suite of components every organization participating
@@ -78,7 +78,12 @@ containing all the sub-charts and their dependencies for deployment via Helm.
7878
Thus, being provided as Helm chart, the FIWARE Data Space Connector can be deployed on
7979
[Kubernetes](https://kubernetes.io/) environments.
8080

81+
## Release Information
82+
83+
The FIWARE Data Space Connector uses a continious integration flow, where every merge to the main-branch triggers a new release. Versioning follows [Semantic Versioning 2.0.0](https://semver.org/lang/de/), therefor only major changes will contain breaking changes.
84+
Important releases will be listed below, with additional information linked:
8185

86+
* [8.x.x](doc/release-notes/8-x.md) - Update the FIWARE Data Space Connector from 7.x.x to 8.x.x
8287

8388
## Components
8489

@@ -363,10 +368,6 @@ They will spin up the [Local Data Space](./doc/deployment-integration/local-depl
363368
the [test-scenarios](./it/src/test/resources/it/mvds_basic.feature) against it.
364369

365370

366-
367-
368-
369-
370371
## Additional documentation and resources
371372

372373
### Marketplace Integration

doc/release-notes/8-x.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Release 8.x.x
2+
3+
Version 8.x.x of the Data Space Connector contains a number of new features and improvements. They will be listed below, together with required actions for migration.
4+
5+
## Marketplace Integration
6+
7+
In order to provide a frontend for the marketplace functionality, the BAE Marketplace(https://github.com/FIWARE-TMForum/Business-API-Ecosystem) was integrated into the Data Space Connector. See [Marketplace Integration](../MARKETPLACE_INTEGRATION.md) for more details.
8+
9+
## Keycloak Update to 26.3.2
10+
11+
Keycloak has some fundamental changes in the configuration of Verifiable Credentials Issuance and in its support of the OID4VCI protocol. Increased support is still a major work-item in Keycloak, thus more changes will come soon.
12+
13+
14+
:warning: Required action:
15+
16+
The configuration of the realm needs to be updated to the new format of keyclaok. See [attributes](https://github.com/FIWARE-TMForum/Business-API-Ecosystem), [client-scopes](https://github.com/FIWARE/data-space-connector/blob/main/k3s/consumer.yaml#L352) and [clients](https://github.com/FIWARE/data-space-connector/blob/main/k3s/consumer.yaml#L667) section of the consumer-example config as an example
17+
18+
## TMForum API update
19+
20+
To better support Marketplace integration and contract negotiation, the TMForum API was updated to 1.3.6.
21+
22+
If the TMForum API was not used before, nothing has to be done.
23+
24+
:warning: Required action:
25+
If the connector instance already contains data from TMForum <1.0.0, a data migration needs to be executed: https://github.com/FIWARE/tmforum-api/tree/main/data-migrator
26+
27+
## Local Deployment
28+
29+
In order to better support demo-scenarios integrating end-users and frontends, the local deployment now contains an additional proxy to provide access to the services. See https://github.com/FIWARE/data-space-connector/blob/main/doc/deployment-integration/local-deployment/LOCAL.MD#local-deployment and https://github.com/FIWARE/data-space-connector/blob/main/doc/MARKETPLACE_INTEGRATION.md#demo-usage for more details.
30+
31+
## ODRL-PAP
32+
33+
The ODRL-PAP was updated to 1.0.2, in order to better support the accessibility of policies(e.g. query-by-id - see [ODRL-PAP API](https://github.com/wistefan/odrl-pap/blob/main/api/odrl.yaml)). It also requires policies to contain a "odrl:uid" now, to be compliant with the odrl-spec.
34+
35+
:warning: Required actions:
36+
37+
Update all policies to include a "odrl:uid"(see [spec](https://www.w3.org/TR/odrl-model/#policy))
38+
39+
## Verifier & Credentials-Config-Service update for EUDI-Wallet compatibility
40+
41+
In order to be compliant with the current EUDI-Wallet(https://github.com/eu-digital-identity-wallet), the Verifier has various updates in its OID4VP support:
42+
43+
* presentationDefinition: following the OID4VP spec, the specification of "presentationDefinition" is now supported. See [registration in the provider.yaml](https://github.com/FIWARE/data-space-connector/blob/main/k3s/provider.yaml#L148-L189) as an example
44+
* jwtInclusion: in order to reduce the size of created JWT-Tokens and flexibility in their structure, the inclusion of VC Claims into the JWT can now be configured. See [Credential-Config-Service API](https://github.com/FIWARE/credentials-config-service/blob/main/api/credentials-config-service.yaml#L225-L253)
45+
* requestMode: To improve integration with applications and OID4VP compliance, the verifier now supports(in addition to "urlEncoded") the request modes "byValue" and "byReference". See [VCVerifier](https://github.com/FIWARE/VCVerifier?tab=readme-ov-file#request-modes) for more details.
46+
* request signing: The verifier now supports signing request objects sent to the wallet. See [Verifier Configuration](https://github.com/FIWARE/VCVerifier?tab=readme-ov-file#configuration) - "verifier.clientIdentification"
47+
* horizontal scaling: in order to support horizontal scaling, the a Key for signing the JWT's can be provided to the instances. See [Verifier Configuration](https://github.com/FIWARE/VCVerifier?tab=readme-ov-file#configuration) - "verifier.keyAlgorithm", "verifier.generateKey" and "verifier.keyPath"
48+
49+
Required actions:
50+
* update Verifier configuration - see [provider.yaml - vcverifier](https://github.com/FIWARE/data-space-connector/blob/main/k3s/provider.yaml#L239-L247) as example
51+
* update Credentials-Configuration - see [provider.yaml - credentials-config-service](https://github.com/FIWARE/data-space-connector/blob/main/k3s/provider.yaml#L148-L225) as example
52+
53+
## Wallet Integration
54+
55+
For various Use-Cases, the integration of EUDI Wallet - compatible End-User Wallets is required. The new version of the Data Space Connector contains a local runnable example, demonstrating the integration with the current [Reference Implementation](https://github.com/eu-digital-identity-wallet/eudi-app-android-wallet-ui). See [Marketplace integration - The Wallet](https://github.com/FIWARE/data-space-connector/blob/main/doc/MARKETPLACE_INTEGRATION.md) for more.

0 commit comments

Comments
 (0)