Skip to content

Commit 4716b5f

Browse files
committed
update documentation for v0.1.3
Signed-off-by: Dominik Pinsel <[email protected]>
1 parent 1c39e8d commit 4716b5f

File tree

3 files changed

+67
-11
lines changed

3 files changed

+67
-11
lines changed

CHANGELOG.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
### Added
1111

1212
- New Postman collection for developers `/docs/development/postman`
13-
- New XSUAA Authenticator Extension ([Readme](/edc-extensions/xsuaa-authenticator/README.md))
13+
- New EDC Image with HashiCorp Vault and InMemory Storage
14+
- (Experimental) Simplified deployment of the EDC in `/charts/tractusx-connector`
1415

15-
### Updated
16+
### Changed
1617

1718
- Set EDC version to `0.0.1-20221006-SNAPSHOT`
1819
- Business Partner Number Extension no longer supports the 'IN' constraint operator
1920
- HashiCorp Vault Extension now allows sub directories for secrets
21+
- Update package structure/namespace from `net.catenax` to `org.eclipse.tractusx`
2022

21-
### Changed
23+
### Fixed
2224

23-
- Update package structure/namespace from `net.catenax` to `org.eclipse.tractusx`
25+
- S3 Data Transfer
2426

2527
## [0.1.2] - 2022-09-30
2628

docs/migration/Version_0.1.2_0.1.3.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Migration Version 0.1.2 to 0.1.3
2+
3+
This document contains a list of breaking changes that are introduced in version 0.1.3.
4+
5+
## OAuth2 Extension
6+
7+
As the images now use the official OAuth2 Extension, the audience settings need to the updated.
8+
9+
**Add the following settings**
10+
- EDC_OAUTH_PROVIDER_AUDIENCE
11+
- EDC_OAUTH_ENDPOINT_AUDIENCE
12+
13+
**Remove the following setting**
14+
- EDC_IDS_ENDPOINT_AUDIENCE
15+
16+
Example
17+
```
18+
EDC_OAUTH_PROVIDER_AUDIENCE: idsc:IDS_CONNECTORS_ALL
19+
EDC_OAUTH_ENDPOINT_AUDIENCE: http://plato-edc-controlplane:8282/api/v1/ids/data
20+
```

docs/release-notes/Version 0.1.3.md

+41-7
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,26 @@
22

33
30.11.2022
44

5-
# 1. Product EDC
5+
## 0. Summary
66

7-
## 1.1 Business Partner Extension
7+
1. Container Images
8+
- New Image: HashiCorp Vault & In Memory Store
9+
2. Extensions
10+
- Business Partner Extension
11+
- HashiCorp Vault Extension
12+
- OAuth2 Extension
13+
3. Bug Fixes
14+
- S3 Data Transfer
15+
16+
# 1. Container Images
17+
18+
## 1.1 New Image: HashiCorp Vault & In Memory Store
19+
20+
The EDC now releases a fourth image with a combination of HashiCorp Vault and In Memory Store extensions.
21+
22+
# 2. Extensions
23+
24+
## 2.1 Business Partner Extension
825

926
**Removed support for Constraint with multiple BPNs**
1027
The possibility to use multiple Business Partner Numbers inside of a single constraint has been removed. It looks like
@@ -48,10 +65,27 @@ Hence, this kind of policy is no longer supported!
4865

4966
The BPN extension will now always decline BPN policies with 'IN' operators, when asked by the EDC to enforce it.
5067

51-
## 1.2 OAuth2 Extension
68+
## 2.2 HashiCorp Vault Extension
69+
70+
It is now possible to arrange HashiCorp Vault secrets in sub-directories.
71+
72+
For example by storing the DAPS secrets in their own `/daps` directory:
73+
74+
```
75+
EDC_OAUTH_PRIVATE_KEY_ALIAS: daps/my-plato-daps-key
76+
EDC_OAUTH_PUBLIC_KEY_ALIAS: daps/my-plato-daps-crt
77+
```
78+
79+
## 2.3 OAuth2 Extension
80+
81+
The EDC Oauth2 Extension has now the possibility to add the audience to the claim. As the official OAuth2 Extension was
82+
added to the control plane again most of the functionality of the CX Oauth2 Extension was removed.
83+
84+
> **Breaking Change** The official OAuth2 Extension uses different settings then the EDC OAuth Extension. Please
85+
> consolidate the [Migration Documentation](../migration/Version_0.1.2_0.1.3.md).
86+
87+
# 3. Bug Fixes
5288

53-
**Add official EDC OAuth2 Extension**
54-
The EDC Oauth2 Extension has now the possibility to add the audience to the claim. So this extension is now again part
55-
of the Control plane and most of the functionality of the CX Oauth2 Extension was removed.
89+
## 3.1 S3 Data Transfer
5690

57-
TODO Write about config change
91+
Version 0.1.2 had some issues with the S3 data transfer. This version fixes them.

0 commit comments

Comments
 (0)