Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Added 0.8.X -> 0.9.X migration guide #1805

Merged
merged 7 commits into from
Feb 18, 2025
Merged

docs: Added 0.8.X -> 0.9.X migration guide #1805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
aea50ba
initial version
rafaelmag110 Feb 14, 2025
70dbf0f
heading
rafaelmag110 Feb 14, 2025
d53734f
Added section about migrations
rafaelmag110 Feb 17, 2025
eb79bf5
Suggestions
rafaelmag110 Feb 17, 2025
5b1d62f
added more specificity
rafaelmag110 Feb 18, 2025
d9ae523
deps
rafaelmag110 Feb 18, 2025
5813035
Update docs/migration/Version_0.8.x_0.9.x.md
rafaelmag110 Feb 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions DEPENDENCIES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -570,7 +570,7 @@ maven/mavencentral/org.eclipse.jetty/jetty-util/11.0.24, EPL-2.0 OR Apache-2.0,
maven/mavencentral/org.eclipse.jetty/jetty-webapp/11.0.24, EPL-2.0 OR Apache-2.0, approved, rt.jetty
maven/mavencentral/org.eclipse.jetty/jetty-xml/11.0.24, EPL-2.0 OR Apache-2.0, approved, rt.jetty
maven/mavencentral/org.eclipse.parsson/parsson/1.1.7, EPL-2.0, approved, ee4j.parsson
maven/mavencentral/org.flywaydb/flyway-core/11.3.2, , restricted, clearlydefined
maven/mavencentral/org.flywaydb/flyway-core/11.3.2, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.flywaydb/flyway-database-postgresql/11.3.2, , restricted, clearlydefined
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
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
Expand Down Expand Up @@ -660,7 +660,7 @@ maven/mavencentral/org.yaml/snakeyaml/2.4, Apache-2.0, approved, #19469
maven/mavencentral/software.amazon.awssdk/annotations/2.29.50, Apache-2.0, approved, #17015
maven/mavencentral/software.amazon.awssdk/annotations/2.30.21, Apache-2.0, approved, #19166
maven/mavencentral/software.amazon.awssdk/apache-client/2.29.50, Apache-2.0, approved, #17627
maven/mavencentral/software.amazon.awssdk/apache-client/2.30.21, , restricted, clearlydefined
maven/mavencentral/software.amazon.awssdk/apache-client/2.30.21, Apache-2.0, approved, clearlydefined
maven/mavencentral/software.amazon.awssdk/arns/2.29.50, Apache-2.0, approved, #16994
maven/mavencentral/software.amazon.awssdk/arns/2.30.21, , restricted, clearlydefined
maven/mavencentral/software.amazon.awssdk/auth/2.29.50, Apache-2.0, approved, #17626
Expand All @@ -672,17 +672,17 @@ maven/mavencentral/software.amazon.awssdk/aws-query-protocol/2.30.21, Apache-2.0
maven/mavencentral/software.amazon.awssdk/aws-xml-protocol/2.29.50, Apache-2.0, approved, #17004
maven/mavencentral/software.amazon.awssdk/aws-xml-protocol/2.30.21, , restricted, clearlydefined
maven/mavencentral/software.amazon.awssdk/checksums-spi/2.29.50, Apache-2.0, approved, #17010
maven/mavencentral/software.amazon.awssdk/checksums-spi/2.30.21, , restricted, clearlydefined
maven/mavencentral/software.amazon.awssdk/checksums-spi/2.30.21, Apache-2.0, approved, clearlydefined
maven/mavencentral/software.amazon.awssdk/checksums/2.29.50, Apache-2.0, approved, #17003
maven/mavencentral/software.amazon.awssdk/checksums/2.30.21, , restricted, clearlydefined
maven/mavencentral/software.amazon.awssdk/crt-core/2.29.50, Apache-2.0, approved, #17002
maven/mavencentral/software.amazon.awssdk/crt-core/2.30.21, , restricted, clearlydefined
maven/mavencentral/software.amazon.awssdk/endpoints-spi/2.29.50, Apache-2.0, approved, #16996
maven/mavencentral/software.amazon.awssdk/endpoints-spi/2.30.21, , restricted, clearlydefined
maven/mavencentral/software.amazon.awssdk/http-auth-aws-eventstream/2.29.50, Apache-2.0, approved, #16995
maven/mavencentral/software.amazon.awssdk/http-auth-aws-eventstream/2.30.21, , restricted, clearlydefined
maven/mavencentral/software.amazon.awssdk/http-auth-aws-eventstream/2.30.21, Apache-2.0, approved, clearlydefined
maven/mavencentral/software.amazon.awssdk/http-auth-aws/2.29.50, Apache-2.0, approved, #17001
maven/mavencentral/software.amazon.awssdk/http-auth-aws/2.30.21, , restricted, clearlydefined
maven/mavencentral/software.amazon.awssdk/http-auth-aws/2.30.21, Apache-2.0, approved, clearlydefined
maven/mavencentral/software.amazon.awssdk/http-auth-spi/2.29.50, Apache-2.0, approved, #17005
maven/mavencentral/software.amazon.awssdk/http-auth-spi/2.30.21, , restricted, clearlydefined
maven/mavencentral/software.amazon.awssdk/http-auth/2.29.50, Apache-2.0, approved, #16998
Expand Down Expand Up @@ -717,5 +717,5 @@ maven/mavencentral/software.amazon.awssdk/sts/2.29.50, Apache-2.0, approved, #17
maven/mavencentral/software.amazon.awssdk/third-party-jackson-core/2.29.50, Apache-2.0, approved, #17008
maven/mavencentral/software.amazon.awssdk/third-party-jackson-core/2.30.21, , restricted, clearlydefined
maven/mavencentral/software.amazon.awssdk/utils/2.29.50, Apache-2.0, approved, #17625
maven/mavencentral/software.amazon.awssdk/utils/2.30.21, , restricted, clearlydefined
maven/mavencentral/software.amazon.awssdk/utils/2.30.21, Apache-2.0, approved, clearlydefined
maven/mavencentral/software.amazon.eventstream/eventstream/1.0.1, Apache-2.0, approved, clearlydefined
62 changes: 62 additions & 0 deletions docs/migration/Version_0.8.x_0.9.x.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Migration Guide `0.8.x -> 0.9.x`

This document outlines the necessary changes for migrating your tractusx-edc installation from version 0.8.0 to 0.9.0.
It also outlines some points that adopters and operators should pay close attention to when migrating from one version
to another.

This document is not a comprehensive feature list.

<!-- TOC -->
* [Migration Guide `0.8.x -> 0.9.x`](#migration-guide-08x---09x)
* [1. Strict Policy Definition Validation](#1-strict-policy-definition-validation)
* [2. Removal of Azure based distributions](#2-removal-of-azure-based-distributions)
* [3. Updated and Deprecated BPNL Group operators](#3-updated-and-deprecated-bpnl-group-operators)
* [4. Store Migrations](#4-store-migrations)
<!-- TOC -->

## 1. Strict Policy Definition Validation

A new feature was added with upstream EDC 0.11.0 that requires the connector to perform a deeper validation of a
policy definition during its creation/update. This feature prevents any new policy definition of having:

- an action, within a rule, that doesn't bound to any evaluation scope
- a constraint, within a rule, that its leftOperand is not bound to any evaluation scope or any evaluation function.

On simpler terms, it prevents the creation of any policy definition which will evaluate nothing.

This feature is enabled by default in the distributed tractusx-edc helm charts. In order to disable the feature or
if you don't use the distributed helm chart, and you want to enable this feature, it can be toggled via configuration
or environment variable using the following config:

`edc.policy.validation.enabled=true|false`

## 2. Removal of Azure based distributions

As they were previously marked for deprecation, the azure vault based distributions were effectively removed and WILL
NOT
be distributed any longer. Be aware this has nothing to do with the cloud related extensions we support, such as Azure
blob or AWS S3 provisioners and dataplanes. Those are still included as part of the base tractusx-edc distribution.ß

If you installation relied on any tractusx-edc `azure-vault` distribution (either docker image or helm chart), please
also be aware that you will no longer find a distribution for this or future releases.

## 3. Updated and Deprecated BPNL Group operators

Special attention is necessary towards policy definitions that contain BPNL group constrains using either the `eq` or
`neq` operators. These have been deprecated in favor of the `isAllOf`, `isAnyOf` and `isNoneOf` operators which are the
proper operators for sets.

Additionally, the behavior of the `isAllOf` operator has been fixed since it previously failed validation for BPNLs
that were assigned to 3 distinct groups, 2 of which were the same as listed in the policy constrain.
The `isAllOf` now checks if a certain BPNL is assigned to all the groups allowed in the policy definition.

The `IN` operator was also fixed, since it evaluated the same as the faulty `isAllOf` operator.
It now performs the same as the `isAnyOf` operator.

## 4. Store Migrations

For connector operators who maintain specific flyway migration files, please be aware of new migrations added
in these PRs:

- https://github.com/eclipse-tractusx/tractusx-edc/pull/1706
- https://github.com/eclipse-tractusx/tractusx-edc/pull/1713
Loading