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.

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(release preparation): prepare changelog for release 24.12 #38

Merged
merged 21 commits into from
Dec 3, 2024

Conversation

ther3sa
Copy link
Contributor

@ther3sa ther3sa commented Nov 18, 2024

Description

PR to collaboratively work on the Changelog for R24.12

  • Changed components
  • Unchanged/untetsted components
  • incompatible
  • known knowns
  • runtimes

[24.12] - 2024-12-02

Implemented features can be found here

Updated

Component Helm Chart (s) App-/KIT Version (s)
BPDM KIT n/a 7.0.0
Circularity KIT n/a 1.3.0
DCM Kit n/a 1.2.0
Digital Twin Registry digital-twin-registry: 0.6.2 0.6.2
Discovery Finder discoveryfinder: 0.4.2 0.5.2
Discovery Service (BPN Finder) bpndiscovery: 0.4.2 0.5.2
Eclipse Data Space Connector (Tractus-X EDC) 0.8.0 0.8.0
Golden Record Business Partner Number (BPN) Service bpdm: 5.2.0 6.2.0
Identity and Access Management (IAM) centralidp: 4.0.0
sharedidp: 4.0.0
keycloak: 25.0.6
Industry Core KIT n/a 1.3.0
Knowledge Agents remoting-agent: 1.14.24
provisioning-agent: 1.14.24
conforming-agent: 1.14.24
matchmaking-agent: 1.14.24
remoting-agent: 1.14.24
provisioning-agent: 1.14.24
conforming-agent: 1.14.24
matchmaking-agent: 1.14.24
(Knowledge) Agents KIT n/a 1.2.0
Policy Hub policy-hub: 1.2.0 1.2.0
Portal portal: 2.3.0 registration: 2.1.0
frontend: 2.3.0
backend: 2.3.0
assets: 2.3.0
Self Description (SD) Factory sdfactory: 2.1.22 v2.1.14
Semantic Hub semantic-hub: 0.4.2 0.5.2
SSI Authority & Schema Registry ssi-asr: 1.1.0 1.1.0
SSI Credential Issuer ssi-credential-issuer: 1.2.0 1.2.0
Traceability KIT n/a 6.0.0

Known Knowns

  • All not listed products and KITs have not been updated and are based on the release 24.08
    • These products were not part of the e2e testing phase
    • And are not tested with the current EDC version 0.8.0
  • BPN DID Resolution Service (BDRS) is unchanged but was part of the testing phase
  • PURIS is unchanged but regression tests were executed
  • Knowledge Agents was updated to version 0.8.0 but only tested with the EDC release candidate 0.8.0-RC4
  • This Tractus-X release does not include a Managed Identity Wallet (MIW). The development team decided on a temporary bridging solution, based on a commercial application, to test and ship Release 24.08. Without implementing this interim solution, participants will not be able to fully utilize this Tractus-X release in consequence.
  • For E2E Testing, the 2.1.1 of the SSI DIM Middle Layer was used - this component is FOSS but the currently used wallet (see previous item) is not.
  • Security concern about exposed technical users when subscribing BPDM services over the Portal -> see according issue
  • BPNL Group Validation for a Policy does not allow a Collection as a rightOperand -> see Issue
  • EDR token refresh implementation is inconsistent and deviates from the documentation -> see Issue
  • Consumer-Asset with the same ID as a Provider-Asset Cannot Be Deleted After Contract Negotiation -> see Issue
  • Termination of pull transfer process from consumer side does not succeed -> see Issue
  • Fatal error while resume PULL transfer process -> see Issue

Runtime

The release has been tested

Note: Tractus-X EDC has been tested on both Postgresql versions: 15.x and 16.x

Using helm with central helm registry

You can search all released helm charts with the following commands:

helm repo add tractusx-dev https://eclipse-tractusx.github.io/charts/dev
helm repo update tractusx-dev
helm search repo tractusx-dev --versions

For installation details, please see the referenced Repositories / Releases.

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

@ther3sa ther3sa self-assigned this Nov 18, 2024
@ther3sa ther3sa added the documentation Improvements or additions to documentation label Nov 18, 2024
@ther3sa
Copy link
Contributor Author

ther3sa commented Nov 18, 2024

@ds-hzimmer could you check if the Kubernetes version is correct and add the PostgreSQL version.
Thank you for your support!

@ther3sa
Copy link
Contributor Author

ther3sa commented Nov 18, 2024

@lgblaumeiser Is this still correct, or has the Tractus-X EDC already been tested on another Postgresql version?
Thank you for your help!

Note: Tractus-X EDC has been tested on both Postgresql versions: 15.x and 16.x

@ds-hzimmer
Copy link

@ds-hzimmer could you check if the Kubernetes version is correct and add the PostgreSQL version. Thank you for your support!

The INT environment (Azure cx-int-aks) is running on Kubernetes 1.28.9

@ds-hzimmer
Copy link

ds-hzimmer commented Nov 20, 2024

SD Factory should be moved to updated table.
It has been updated to App version 2.1.14 during test phase and deployed to INT environment, in order to account for vulnerability issues, incorporate Trufflehog, etc. https://github.com/eclipse-tractusx/sd-factory/releases/tag/v2.1.14

Functionality tested within Portal regression tests (onboarding self description step, connectors, etc.).
But no explicit E2E test run performed by product team.

@ther3sa ther3sa requested a review from jSchuetz88 November 20, 2024 16:39
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
Copy link

@evegufy evegufy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The known knowns from the previous release should be checked if they apply still to this release.

I know the following is still relevant:

  • This Tractus-X release does not include a Managed Identity Wallet (MIW). The development team decided on a temporary bridging solution, based on a commercial application, to test and ship Release 24.08. Without implementing this interim solution, participants will not be able to fully utilize this Tractus-X release in consequence.

As well as the following updated note:

  • For E2E Testing, the 2.1.1 of the SSI DIM Middle Layer was used - this component is FOSS but the currently used wallet (see previous item) is not.

@nicoprow the following should be removed, right?

  • BPDM has some Known Knowns regarding Portal integration listed in detail here

The following is still relevant (was heavily discussed in the last months):

  • Security concern about exposed technical users when subscribing BPDM services over the Portal

but the link to the according sig-release issue could be added sig-release#987

Just as a note, the following are solved by now:

  • BPDM standard configuration not compatible with Portal's Central-IDP configuration
  • Portal's Partner Network page does not currently show business partner member data due to an authorization issue
  • Currently not possible to add company's site and address business partners over the Portal due to authorization issue

@ther3sa
Copy link
Contributor Author

ther3sa commented Nov 28, 2024

The known knowns from the previous release should be checked if they apply still to this release.

I know the following is still relevant:

  • This Tractus-X release does not include a Managed Identity Wallet (MIW). The development team decided on a temporary bridging solution, based on a commercial application, to test and ship Release 24.08. Without implementing this interim solution, participants will not be able to fully utilize this Tractus-X release in consequence.

As well as the following updated note:

  • For E2E Testing, the 2.1.1 of the SSI DIM Middle Layer was used - this component is FOSS but the currently used wallet (see previous item) is not.

@nicoprow the following should be removed, right?

  • BPDM has some Known Knowns regarding Portal integration listed in detail here

The following is still relevant (was heavily discussed in the last months):

  • Security concern about exposed technical users when subscribing BPDM services over the Portal

but the link to the according sig-release issue could be added sig-release#987

Just as a note, the following are solved by now:

  • BPDM standard configuration not compatible with Portal's Central-IDP configuration
  • Portal's Partner Network page does not currently show business partner member data due to an authorization issue
  • Currently not possible to add company's site and address business partners over the Portal due to authorization issue

Thank you @evegufy

@ther3sa ther3sa requested a review from nicoprow November 28, 2024 09:14
@lgblaumeiser
Copy link

@lgblaumeiser Is this still correct, or has the Tractus-X EDC already been tested on another Postgresql version? Thank you for your help!

Note: Tractus-X EDC has been tested on both Postgresql versions: 15.x and 16.x

Hi @ther3sa, the released helm chart refers to Postgresql 15.2.1. But internal testing of EDC is done using version 16.4. So I can confirm 16.4. As I would assume, that during end-to-end testing people used 15.2.1 as indicated by the helm charts, I would fo that far that we can expect this statement to be valid

@ther3sa
Copy link
Contributor Author

ther3sa commented Nov 28, 2024

@lgblaumeiser Is this still correct, or has the Tractus-X EDC already been tested on another Postgresql version? Thank you for your help!

Note: Tractus-X EDC has been tested on both Postgresql versions: 15.x and 16.x

Hi @ther3sa, the released helm chart refers to Postgresql 15.2.1. But internal testing of EDC is done using version 16.4. So I can confirm 16.4. As I would assume, that during end-to-end testing people used 15.2.1 as indicated by the helm charts, I would fo that far that we can expect this statement to be valid

okay thank you :)

@nicoprow
Copy link

The known knowns from the previous release should be checked if they apply still to this release.

I know the following is still relevant:

* This Tractus-X release does not include a Managed Identity Wallet (MIW). The development team decided on a temporary bridging solution, based on a commercial application, to test and ship Release 24.08. Without implementing this interim solution, participants will not be able to fully utilize this Tractus-X release in consequence.

As well as the following updated note:

* For E2E Testing, the [2.1.1](https://github.com/SAP/ssi-dim-middle-layer/releases/tag/v2.1.1) of the [SSI DIM Middle Layer](https://github.com/SAP/ssi-dim-middle-layer) was used - this component is FOSS but the currently used wallet (see previous item) is not.

@nicoprow the following should be removed, right?

* BPDM has some Known Knowns regarding Portal integration listed in detail [here](https://github.com/eclipse-tractusx/bpdm/blob/release/6.1.x/docs/architecture/11_Risks_And_Technical_Debts.md)

The following is still relevant (was heavily discussed in the last months):

* Security concern about exposed technical users when subscribing BPDM services over the Portal

but the link to the according sig-release issue could be added sig-release#987

Just as a note, the following are solved by now:

* BPDM standard configuration not compatible with Portal's Central-IDP configuration

* Portal's Partner Network page does not currently show business partner member data due to an authorization issue

* Currently not possible to add company's site and address business partners over the Portal due to authorization issue

@evegufy

Right, the only Known-knowns are the exposed service accounts. The updated documentation of BPDM takes that into account: https://github.com/eclipse-tractusx/bpdm/blob/release/6.2.x/docs/architecture/11_Risks_And_Technical_Debts.md#exposed-technical-users-on-portal

So I would also only keep the point you wrote: "Security concern about exposed technical users when subscribing BPDM services over the Portal"

@ther3sa ther3sa marked this pull request as ready for review November 29, 2024 12:36
@evegufy evegufy changed the title add initial table for added, updated, unchanged docs: add initial table for added, updated, unchanged Nov 29, 2024
@ther3sa ther3sa requested a review from a team December 2, 2024 07:54
@ther3sa
Copy link
Contributor Author

ther3sa commented Dec 2, 2024

Sanity Check

Found 11 releases
Extracting tables for release: 24.12
Release consists of 67 lines

Processing table 'Updated'
Checking LINKS for KIT: BPDM KIT
Checking LINKS for KIT: Circularity KIT
Checking LINKS for KIT: DCM Kit
Checking LINKS for FOSS Component: Digital Twin Registry
Checking CHART for FOSS Component: Digital Twin Registry
 ERROR: Chart version of FOSS Chart digital-twin-registry has version 0.6.2 while version 0.6.3 is available in tractusx-dev
Checking LINKS for FOSS Component: Discovery Finder
Checking CHART for FOSS Component: Discovery Finder
Checking LINKS for FOSS Component: Discovery Service (BPN Finder)
Checking CHART for FOSS Component: Discovery Service (BPN Finder)
Checking LINKS for FOSS Component: Eclipse Data Space Connector (Tractus-X EDC)
Checking CHART for FOSS Component: Eclipse Data Space Connector (Tractus-X EDC)
 ERROR: Could not retrieve latest Helm chart or app version for [0.8.0](https.
 ERROR: Chart version of FOSS Chart [0.8.0](https has version 0.8.0 while version None is available in tractusx-dev
 ERROR: App version of FOSS Chart [0.8.0](https (app Eclipse Data Space Connector (Tractus-X EDC)) has app version 0.8.0 while version None is set in Chart available in tractusx-dev
Checking LINKS for FOSS Component: Golden Record Business Partner Number (BPN) Service
Checking CHART for FOSS Component: Golden Record Business Partner Number (BPN) Service
Checking LINKS for FOSS Component: Identity and Access Management (IAM)
 ERROR: Release version '25.0.6' and link version 'https://www.keycloak.org/docs/latest/release_notes/index.html#keycloak-25-0-0' of FOSS APP Identity and Access Management (IAM) do not match
Checking CHART for FOSS Component: Identity and Access Management (IAM)
Checking LINKS for KIT: Industry Core KIT
Checking LINKS for FOSS Component: Knowledge Agents
 ERROR: Release version '1.14.24' and link version 'https://github.com/eclipse-tractusx/knowledge-agents/releases/tag/matchmaking-agent-1.14.24-SNAPSHOT' of FOSS Chart remoting-agent do not match
 ERROR: Release of FOSS APP Knowledge Agents has invalid link 'https://github.com/eclipse-tractusx/knowledge-agents/releases/tag/v1.14.24'
Checking CHART for FOSS Component: Knowledge Agents
 ERROR: Chart version of FOSS Chart remoting-agent has version 1.14.24 while version 1.13.22 is available in tractusx-dev
 ERROR: App version of FOSS Chart remoting-agent (app Knowledge Agents) has app version 1.14.24 while version 1.13.22 is set in Chart available in tractusx-dev
Checking LINKS for KIT: (Knowledge) Agents KIT
Checking LINKS for FOSS Component: Policy Hub
Checking CHART for FOSS Component: Policy Hub
Checking LINKS for FOSS Component: Portal
Checking CHART for FOSS Component: Portal
 ERROR: App version of FOSS Chart portal (app Portal) has app version 2.1.0 while version 2.3.0 is set in Chart available in tractusx-dev
Checking LINKS for FOSS Component: Self Description (SD) Factory
Checking CHART for FOSS Component: Self Description (SD) Factory
Checking LINKS for FOSS Component: Semantic Hub
Checking CHART for FOSS Component: Semantic Hub
Checking LINKS for FOSS Component: SSI Authority & Schema Registry
Checking CHART for FOSS Component: SSI Authority & Schema Registry
Checking LINKS for FOSS Component: SSI Credential Issuer
Checking CHART for FOSS Component: SSI Credential Issuer
Checking LINKS for KIT: Traceability KIT

@ther3sa ther3sa requested a review from almadigabor December 3, 2024 09:27
Copy link
Member

@stephanbcbauer stephanbcbauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@stephanbcbauer stephanbcbauer merged commit a048f4d into eclipse-tractusx:main Dec 3, 2024
1 check passed
@stephanbcbauer stephanbcbauer changed the title docs: add initial table for added, updated, unchanged docs(release preparation): prepare changelog for release 24.12 Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants