Skip to content

Commit 377f5e6

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

File tree

3 files changed

+47
-7
lines changed

3 files changed

+47
-7
lines changed

CHANGELOG.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ 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+
- (Experimental) Simplified deployment of the EDC in `/charts/tractusx-connector`
1414

1515
### Updated
1616

@@ -20,7 +20,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2020

2121
### Changed
2222

23-
- Update package structure/namespace from `net.catenax` to `org.eclipse.tractusx`
23+
- Update package structure/namespace from `net.catenax` to `org.eclipse.tractusx`
24+
25+
### Fixed
26+
27+
- S3 Data Transfer
2428

2529
## [0.1.2] - 2022-09-30
2630

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

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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+
6+
## OAuth2 Extension
7+
8+
The audience settings need to the updated.
9+
10+
**Add the following settings**
11+
- EDC_OAUTH_PROVIDER_AUDIENCE
12+
- EDC_OAUTH_ENDPOINT_AUDIENCE
13+
14+
**Remove the following settings**
15+
- EDC_IDS_ENDPOINT_AUDIENCE
16+
17+
Example
18+
```
19+
EDC_OAUTH_PROVIDER_AUDIENCE: idsc:IDS_CONNECTORS_ALL
20+
EDC_OAUTH_ENDPOINT_AUDIENCE: http://plato-edc-controlplane:8282/api/v1/ids/data
21+
```

docs/release-notes/Version 0.1.3.md

+20-5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
# 1. Product EDC
66

7+
## 1.1 S3 Data Transfer
8+
9+
Version 0.1.2 had some issues with the S3 data transfer. This version fixes them.
10+
711
## 1.1 Business Partner Extension
812

913
**Removed support for Constraint with multiple BPNs**
@@ -48,10 +52,21 @@ Hence, this kind of policy is no longer supported!
4852

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

51-
## 1.2 OAuth2 Extension
55+
## 1.2 HashiCorp Vault Extension
56+
57+
It is now possible to arrange HashiCorp Vault secrets in sub-directories.
58+
59+
For example by storing the DAPS secrets in their own `/daps` directory:
60+
61+
```
62+
EDC_OAUTH_PRIVATE_KEY_ALIAS: daps/my-plato-daps-key
63+
EDC_OAUTH_PUBLIC_KEY_ALIAS: daps/my-plato-daps-crt
64+
```
65+
66+
## 1.3 OAuth2 Extension
5267

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.
68+
The EDC Oauth2 Extension has now the possibility to add the audience to the claim. As the official OAuth2 Extension was
69+
added to the control plane again most of the functionality of the CX Oauth2 Extension was removed.
5670

57-
TODO Write about config change
71+
> **Breaking Change** The official OAuth2 Extension uses different settings then the EDC OAuth Extension. Please
72+
> consolidate the [Migration Documentation](../migration/Version_0.1.2_0.1.3.md).

0 commit comments

Comments
 (0)