Skip to content

Commit f15ebfb

Browse files
docs: Added 0.8.X -> 0.9.X migration guide (#1805)
* initial version * heading * Added section about migrations * Suggestions * added more specificity * deps * Update docs/migration/Version_0.8.x_0.9.x.md Co-authored-by: Lars Geyer-Blaumeiser <lars.blaumeiser@cofinity-x.com> --------- Co-authored-by: Lars Geyer-Blaumeiser <lars.blaumeiser@cofinity-x.com>
1 parent 0a9ae50 commit f15ebfb

File tree

2 files changed

+68
-6
lines changed

2 files changed

+68
-6
lines changed

DEPENDENCIES

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -570,7 +570,7 @@ maven/mavencentral/org.eclipse.jetty/jetty-util/11.0.24, EPL-2.0 OR Apache-2.0,
570570
maven/mavencentral/org.eclipse.jetty/jetty-webapp/11.0.24, EPL-2.0 OR Apache-2.0, approved, rt.jetty
571571
maven/mavencentral/org.eclipse.jetty/jetty-xml/11.0.24, EPL-2.0 OR Apache-2.0, approved, rt.jetty
572572
maven/mavencentral/org.eclipse.parsson/parsson/1.1.7, EPL-2.0, approved, ee4j.parsson
573-
maven/mavencentral/org.flywaydb/flyway-core/11.3.2, , restricted, clearlydefined
573+
maven/mavencentral/org.flywaydb/flyway-core/11.3.2, Apache-2.0, approved, clearlydefined
574574
maven/mavencentral/org.flywaydb/flyway-database-postgresql/11.3.2, , restricted, clearlydefined
575575
maven/mavencentral/org.glassfish.hk2.external/aopalliance-repackaged/3.0.6, EPL-2.0 OR GPL-2.0-only with Classpath-exception-2.0, approved, ee4j.glassfish
576576
maven/mavencentral/org.glassfish.hk2/hk2-api/3.0.6, EPL-2.0 OR GPL-2.0-only with Classpath-exception-2.0, approved, ee4j.glassfish
@@ -660,7 +660,7 @@ maven/mavencentral/org.yaml/snakeyaml/2.4, Apache-2.0, approved, #19469
660660
maven/mavencentral/software.amazon.awssdk/annotations/2.29.50, Apache-2.0, approved, #17015
661661
maven/mavencentral/software.amazon.awssdk/annotations/2.30.21, Apache-2.0, approved, #19166
662662
maven/mavencentral/software.amazon.awssdk/apache-client/2.29.50, Apache-2.0, approved, #17627
663-
maven/mavencentral/software.amazon.awssdk/apache-client/2.30.21, , restricted, clearlydefined
663+
maven/mavencentral/software.amazon.awssdk/apache-client/2.30.21, Apache-2.0, approved, clearlydefined
664664
maven/mavencentral/software.amazon.awssdk/arns/2.29.50, Apache-2.0, approved, #16994
665665
maven/mavencentral/software.amazon.awssdk/arns/2.30.21, , restricted, clearlydefined
666666
maven/mavencentral/software.amazon.awssdk/auth/2.29.50, Apache-2.0, approved, #17626
@@ -672,17 +672,17 @@ maven/mavencentral/software.amazon.awssdk/aws-query-protocol/2.30.21, Apache-2.0
672672
maven/mavencentral/software.amazon.awssdk/aws-xml-protocol/2.29.50, Apache-2.0, approved, #17004
673673
maven/mavencentral/software.amazon.awssdk/aws-xml-protocol/2.30.21, , restricted, clearlydefined
674674
maven/mavencentral/software.amazon.awssdk/checksums-spi/2.29.50, Apache-2.0, approved, #17010
675-
maven/mavencentral/software.amazon.awssdk/checksums-spi/2.30.21, , restricted, clearlydefined
675+
maven/mavencentral/software.amazon.awssdk/checksums-spi/2.30.21, Apache-2.0, approved, clearlydefined
676676
maven/mavencentral/software.amazon.awssdk/checksums/2.29.50, Apache-2.0, approved, #17003
677677
maven/mavencentral/software.amazon.awssdk/checksums/2.30.21, , restricted, clearlydefined
678678
maven/mavencentral/software.amazon.awssdk/crt-core/2.29.50, Apache-2.0, approved, #17002
679679
maven/mavencentral/software.amazon.awssdk/crt-core/2.30.21, , restricted, clearlydefined
680680
maven/mavencentral/software.amazon.awssdk/endpoints-spi/2.29.50, Apache-2.0, approved, #16996
681681
maven/mavencentral/software.amazon.awssdk/endpoints-spi/2.30.21, , restricted, clearlydefined
682682
maven/mavencentral/software.amazon.awssdk/http-auth-aws-eventstream/2.29.50, Apache-2.0, approved, #16995
683-
maven/mavencentral/software.amazon.awssdk/http-auth-aws-eventstream/2.30.21, , restricted, clearlydefined
683+
maven/mavencentral/software.amazon.awssdk/http-auth-aws-eventstream/2.30.21, Apache-2.0, approved, clearlydefined
684684
maven/mavencentral/software.amazon.awssdk/http-auth-aws/2.29.50, Apache-2.0, approved, #17001
685-
maven/mavencentral/software.amazon.awssdk/http-auth-aws/2.30.21, , restricted, clearlydefined
685+
maven/mavencentral/software.amazon.awssdk/http-auth-aws/2.30.21, Apache-2.0, approved, clearlydefined
686686
maven/mavencentral/software.amazon.awssdk/http-auth-spi/2.29.50, Apache-2.0, approved, #17005
687687
maven/mavencentral/software.amazon.awssdk/http-auth-spi/2.30.21, , restricted, clearlydefined
688688
maven/mavencentral/software.amazon.awssdk/http-auth/2.29.50, Apache-2.0, approved, #16998
@@ -717,5 +717,5 @@ maven/mavencentral/software.amazon.awssdk/sts/2.29.50, Apache-2.0, approved, #17
717717
maven/mavencentral/software.amazon.awssdk/third-party-jackson-core/2.29.50, Apache-2.0, approved, #17008
718718
maven/mavencentral/software.amazon.awssdk/third-party-jackson-core/2.30.21, , restricted, clearlydefined
719719
maven/mavencentral/software.amazon.awssdk/utils/2.29.50, Apache-2.0, approved, #17625
720-
maven/mavencentral/software.amazon.awssdk/utils/2.30.21, , restricted, clearlydefined
720+
maven/mavencentral/software.amazon.awssdk/utils/2.30.21, Apache-2.0, approved, clearlydefined
721721
maven/mavencentral/software.amazon.eventstream/eventstream/1.0.1, Apache-2.0, approved, clearlydefined
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Migration Guide `0.8.x -> 0.9.x`
2+
3+
This document outlines the necessary changes for migrating your tractusx-edc installation from version 0.8.0 to 0.9.0.
4+
It also outlines some points that adopters and operators should pay close attention to when migrating from one version
5+
to another.
6+
7+
This document is not a comprehensive feature list.
8+
9+
<!-- TOC -->
10+
* [Migration Guide `0.8.x -> 0.9.x`](#migration-guide-08x---09x)
11+
* [1. Strict Policy Definition Validation](#1-strict-policy-definition-validation)
12+
* [2. Removal of Azure based distributions](#2-removal-of-azure-based-distributions)
13+
* [3. Updated and Deprecated BPNL Group operators](#3-updated-and-deprecated-bpnl-group-operators)
14+
* [4. Store Migrations](#4-store-migrations)
15+
<!-- TOC -->
16+
17+
## 1. Strict Policy Definition Validation
18+
19+
A new feature was added with upstream EDC 0.11.0 that requires the connector to perform a deeper validation of a
20+
policy definition during its creation/update. This feature prevents any new policy definition of having:
21+
22+
- an action, within a rule, that doesn't bound to any evaluation scope
23+
- a constraint, within a rule, that its leftOperand is not bound to any evaluation scope or any evaluation function.
24+
25+
On simpler terms, it prevents the creation of any policy definition which will evaluate nothing.
26+
27+
This feature is enabled by default in the distributed tractusx-edc helm charts. In order to disable the feature or
28+
if you don't use the distributed helm chart, and you want to enable this feature, it can be toggled via configuration
29+
or environment variable using the following config:
30+
31+
`edc.policy.validation.enabled=true|false`
32+
33+
## 2. Removal of Azure based distributions
34+
35+
As they were previously marked for deprecation, the azure vault based distributions were effectively removed and WILL
36+
NOT
37+
be distributed any longer. Be aware this has nothing to do with the cloud related extensions we support, such as Azure
38+
blob or AWS S3 provisioners and dataplanes. Those are still included as part of the base tractusx-edc distribution.ß
39+
40+
If you installation relied on any tractusx-edc `azure-vault` distribution (either docker image or helm chart), please
41+
also be aware that you will no longer find a distribution for this or future releases.
42+
43+
## 3. Updated and Deprecated BPNL Group operators
44+
45+
Special attention is necessary towards policy definitions that contain BPNL group constrains using either the `eq` or
46+
`neq` operators. These have been deprecated in favor of the `isAllOf`, `isAnyOf` and `isNoneOf` operators which are the
47+
proper operators for sets.
48+
49+
Additionally, the behavior of the `isAllOf` operator has been fixed since it previously failed validation for BPNLs
50+
that were assigned to 3 distinct groups, 2 of which were the same as listed in the policy constrain.
51+
The `isAllOf` now checks if a certain BPNL is assigned to all the groups allowed in the policy definition.
52+
53+
The `IN` operator was also fixed, since it evaluated the same as the faulty `isAllOf` operator.
54+
It now performs the same as the `isAnyOf` operator.
55+
56+
## 4. Store Migrations
57+
58+
For connector operators who maintain specific flyway migration files, please be aware of new migrations added
59+
in these PRs:
60+
61+
- https://github.com/eclipse-tractusx/tractusx-edc/pull/1706
62+
- https://github.com/eclipse-tractusx/tractusx-edc/pull/1713

0 commit comments

Comments
 (0)