v5.0.0

[v5.0.0] - 2024-12-17

Overview

This release introduces some quality of life changes and moves the catalog crawler into the AP repository.

Detailed Changes

Major

• The Catalog Crawler has been moved to the AP repository
• Removed MDS theme and MDS specific flags in the UI

Minor

• Uptime Kuma is no longer mandatory and the status dashboard can be disabled
• Added Owning Organization in Admin Connector Overview (#355)
• Added a button to change the password in the user settings (PR #397)
• Removed link to frontend URL in all-connectors-view for authority- and operator admins (PR #398)

Patch

• Changed Client ID generation for Connectors & Central Components (#327)

Deployment Migration Notes

• The Crawler image name and version changed due to the crawler being moved into the AP repository and versions being aligned

  • Previously: ghcr.io/sovity/catalog-crawler-ce
  • Now: ghcr.io/sovity/authority-portal-crawler

• Portal Backend

  • Following variables are now optional and can be removed from the configuration if not used:
    • authority-portal.kuma.metrics-url
    • authority-portal.kuma.api-key
    • authority-portal.deployment.environments.test.data-catalog.kuma-name
    • authority-portal.deployment.environments.test.daps.kuma-name
    • authority-portal.deployment.environments.test.logging-house.kuma-name

• Portal Frontend

  • New mandatory variables:

    # Enables or disables the status uptime dashboard
    AUTHORITY_PORTAL_FRONTEND_ENABLE_DASHBOARD: true
    # Direct URL to the UPDATE_PASSWORD required action in Keycloak
    AUTHORITY_PORTAL_FRONTEND_UPDATE_PASSWORD_URL: https://[KC_FQDN]/realms/authority-portal/protocol/openid-connect/auth?response_type=code&client_id=oauth2-proxy&scope=openid&kc_action=UPDATE_PASSWORD&redirect_uri=[AP_FQDN_URL_ENCODED]%2Foauth2%2Fcallback

  • Removed variables:
    • AUTHORITY_PORTAL_FRONTEND_IFRAME_URL
  • The MDS theme is no longer available, so configurations using mds-open-source will revert to the default sovity theme

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:5.0.0
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:5.0.0
• Catalog Crawler CE: ghcr.io/sovity/authority-portal-crawler:5.0.0
• sovity EDC CE: v10.5.1

v4.1.4

[v4.1.4] - 2024-12-13

Overview

MDS Release to catch up with EDC CE

Patch

• Bumped EDC-CE version

Known issues

Deployment Migration Notes

• Deploy a Catalog Crawler with version 10.5.0. Previous versions are not compatible with this release.

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:4.1.4
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:4.1.4
• Catalog Crawler CE: ghcr.io/sovity/catalog-crawler-ce:10.5.0
• Sovity EDC CE: v10.5.0

v4.1.3

[v4.1.3] - 2024-12-09

Overview

This release addresses several issues and adds minor improvements to the Portal.

Detailed Changes

Patch

• Fixed an issue wherein a user registration could fail due to a mismatch of the internal database and the Keycloak database (PR #387)
• Fixed the user not being redirected to the correct URL after login (#324)
• Fixed an issue wherein it was possible to bypass the CaaS request limit in an organization (PR #384)
• Fixed an issue where entries in the connector overview would randomly switch places (PR #386)
• Fixed an issue wherein buttons in a confirmation modal would randomly switch places under certain circumstances (#304)
• Fixed final step not showing when registering a central component (#305)
• Fixed "My Organization" page not updating when switching between environments (#255)
• Fixed website title not updating in some scenarios (#237)
• The page now updates when activating/deactivating a user (#287)
• Added documentation for roles and rights (#334)
• Fixed an issue wherein a service provider could not delete their account if they provided a connector to another participant

Deployment Migration Notes

• Deploy a Catalog Crawler with version 10.4.4. Previous versions are not compatible with this release.

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:4.1.3
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:4.1.3
• Catalog Crawler CE: ghcr.io/sovity/catalog-crawler-ce:10.4.4
• sovity EDC CE: v10.4.4

v4.1.2

[v4.1.2] - 2024-09-26

Overview

MDS 2.2 Hotfix

Detailed Changes

Patch

• Docs describe how to locally self-generate X.509 certificates (#192)
• Fixed configuration not applying properly after a version upgrade (#322)

Known issues

• Users are not redirected to the correct URL after login (#324)

Deployment Migration Notes

No special migration steps required

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:4.1.2
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:4.1.2
• Catalog Crawler CE: ghcr.io/sovity/catalog-crawler-ce:10.4.1
• Sovity EDC CE: v10.4.1

v4.1.1

[v4.1.1] - 2024-09-18

Overview

Quality of Life improvements

Detailed Changes

Patch

• Adjusted the table header on the Organization overview page (#286)
• Adjusted data source availability naming in the CSV report (#283)
  • LIVE -> Available
  • ON_REQUEST -> On Request
• Changed the error message on user/organization invite failures to be more descriptive (#290)
• Fixed UI issues after deleting the last user of an organization (#289)

Deployment Migration Notes

No special migration steps required

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:4.1.1
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:4.1.1
• Catalog Crawler CE: ghcr.io/sovity/catalog-crawler-ce:10.4.0
• Sovity EDC CE: v10.4.0

v2.3.1

[v2.3.1] - 2024-09-06

Overview

Hotfix release for MDS 2.1

Patch

• Dashboard now displays component uptimes correctly

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:2.3.1
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:2.3.1
• Broker Server: 4.2.0

v4.1.0

[v4.1.0] - 2024-09-04

Overview

Quality of Life improvements

Detailed Changes

Minor

• Added auto refresh for pages with connectors every 30 seconds

Deployment Migration Notes

No special migration steps required

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:4.1.0
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:4.1.0
• Catalog Crawler CE: ghcr.io/sovity/catalog-crawler-ce:10.3.0
• Sovity EDC CE: https://github.com/sovity/edc-ce/releases/tag/v10.3.0

v4.0.0

[v4.0.0] - 2024-08-20

Overview

This release introduces support for UI branding configuration, adds improvements to the process of registering connectors for service providers and fixes several minor issues.
Check the deployment migration notes to ensure that you configured everything correctly.

Detailed Changes

Major

• The portal now supports multiple theme configurations

Minor

• Catalog
  • Added copyable contact email and subject fields in the data offer detail dialog
  • Organization filter is no longer split into ID and name
  • Connector filter is no longer split into ID and endpoint
  • Removed dataspace filter when only one dataspace is configured
• Service provider
  • Service providers can now provide connectors using a Connector JWKS URL instead of a certificate (#272)
  • The configuration summary after registering a connector now shows the value for EDC_OAUTH_CLIENT_ID
• Added a message on the CaaS request page to inform the user in case the feature is not configured

Patch

• Fixed user not being redirected to the correct URL after login (#280)
• Fixed the close button on the self-hosted/CaaS connector choice page (#258)
• Fixed Dashboard showing uptimes of over 100% (#262)
• Organization list: Data offer and connector counts now show the correct numbers according to the active environment (#255)
• Fixed provider organization ID not showing up on CaaS connectors (#206)
  • Keep in mind that sovity needs to be registered in the portal for the ID to show up.
  • Already registered connectors will be updated automatically, this process can take up to 24 hours
• Fixed the close button on the self-hosted/CaaS connector choice page (#258)
• Adjusted connector status naming for more consistency (#270)
  • RUNNING (CaaS) -> ONLINE
  • STOPPED (CaaS) -> OFFLINE
  • DEAD -> OFFLINE
• Breadcrumbs now show "Catalogue" properly when using the MDS theme
• Removed requirement for an environment with ID test

Deployment Migration Notes

Read the deployment migration notes carefully if you want to retain the portal's current behavior.
If you configure the optional variables incorrectly, you might end up with an inconsistent configuration.

Backend

Environment variable changes:

• Renamed variables:
  • authority-portal.caas.sovity.limit-per-mdsid to authority-portal.caas.sovity.limit-per-organization
• New optional configuration variables - the values assigned here are the ones you should use to retain the current behavior:

  • # Organization ID configuration (example: prefix: MDS & length: 4 would generate Ids in the format MDSL1234XX)
    # The 'L' stands for 'Legal' and is added automatically after the prefix - the last 2 characters are the checksum
    authority-portal.organization.id.prefix: "MDS"
    authority-portal.organization.id.length: "4"

• New mandatory configuration variables:

  • # Enables the client to connect to the CaaS service. If you weren't provided credentials for the feature by sovity, set this to false
    quarkus.oidc-client.sovity.client-enabled: true

Frontend

Environment variable changes:

• New mandantory configuration variables - the values assigned here are the ones you should use to retain the current behavior:

  • # UI Branding profile
    AUTHORITY_PORTAL_FRONTEND_ACTIVE_PROFILE: mds-open-source
    # Short Dataspace name, used in some explanatory texts
    AUTHORITY_PORTAL_FRONTEND_DATASPACE_SHORT_NAME: MDS
    # Portal name displayed in various texts
    AUTHORITY_PORTAL_FRONTEND_PORTAL_DISPLAY_NAME: "MDS Portal"

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:4.0.0
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:4.0.0
• Catalog Crawler CE: ghcr.io/sovity/catalog-crawler-ce:10.2.0
• Sovity EDC CE: 10.2.0

v3.1.0

[v3.1.0] - 2024-07-24

Overview

MDS 2.2 release

Detailed Changes

Minor

• Data offers now have their own URLs and are sharable
• Complex policy support for the catalog browser

Patch

• Fixed some styling issues in the Data Catalog #238
• Fixed deployment environment not syncing in URLs for the catalog
• Fixed keycloak not redirecting to the correct page after login.

Deployment Migration Notes

No special migration steps required.

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:3.1.0
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:3.1.0
• Catalog Crawler CE: ghcr.io/sovity/catalog-crawler-ce:10.0.0
• Sovity EDC CE: 10.0.0

v3.0.0

[v3.0.0] - 2024-07-15

Overview

MDS 2.2 intermediate release

Detailed Changes

Major

• The Data Catalog (formerly known as Broker) is now integrated into the Authority Portal and can be accessed via the sidebar.

  Detailed Description

  What’s New?

  Seamless Integration: Now, you can use both the Authority Portal and Data Catalog from the same place. This means you won’t be navigated away from the Authority Portal when you want to use the Data Catalog, like before.

  Why This Matters?

  • Improved User Experience: Enjoy a smoother, more intuitive journey with our integrated solution.
  • Exclusive Access: The Data Catalog is now exclusively available to your Data Space members, enhancing the value of their membership and ensuring your users get the most out of your services. Access to the Data Catalog requires registered membership to your Data Space.

Minor

• Changed Broker to Catalog crawler on the dashboard and in the system stability report
• Data offer amounts now differentiate "On Request" Data Offers

Patch

• Input fields containing only whitespaces are now properly validated and an appropriate error message is shown #193
• Component uptime now displays up to '30+ days' #211
• Relaxed zipcode validation to allow less than 5 characters #224

Deployment Migration Notes

• All brokers can be undeployed including their databases.
• Keycloak
  • Keycloak IAM must be updated to version 24.0.4. Follow the Keycloak upgrade guide for more information.
• Portal Backend
  • Following environment variables have been added and must be configured for each environment

    • # Time after which offline data offers are hidden from the Data Catalog
      authority-portal.deployment.environments.{environmentId}.data-catalog.hide-offline-data-offers-after: 15m
      
      # Default page size for the Data Catalog
      authority-portal.deployment.environments.{environmentId}.data-catalog.catalog-page-page-size: 10
      
      # Kuma name for the catalog crawler
      authority-portal.deployment.environments.{environmentId}.data-catalog.kuma-name: broker  
      
      # Environment Connector-Dataspace association
      # Allows certain connectors to be associated as partnered data spaces
      # Required: Default Dataspace name
      authority-portal.deployment.environments.test.data-catalog.dataspace-names.default: MDS
      # Optional: Additional connectors to be given a dataspace name
      authority-portal.deployment.environments.test.data-catalog.dataspace-names.connectorIds."MDSL1234XX.C1234XX": Mobilithek

  • Following environment variables have been removed and can be removed from the configuration

    • # the broker has been removed, as the catalog is now a part of the authority portal
      authority-portal.deployment.environments.{environmentId}.broker.url: ...
      authority-portal.deployment.environments.{environmentId}.broker.admin-api-key: ... 
      authority-portal.deployment.environments.{environmentId}.broker.api-key: ...
      authority-portal.deployment.environments.{environmentId}.broker.kuma-name: ...

• The Broker as a stand-alone deployment unit has been removed in favor of the Catalog Crawler.
  • Any broker's database is not required anymore and can be undeployed.
  • A Catalog Crawler must be deployed for each environment to fill the catalog with live data.
  • Just like the broker, the Catalog Crawler is a modified EDC connector. As such, it can only fetch the catalogs from connectors registered in the same DAPS environment.
  • There is a dedicated Catalog Crawler Productive Deployment Guide
  • Running Uptime Kuma instances must be reconfigured to track the status of the catalog crawler instead of the Broker.
  • While the Catalog Crawler is similar to the broker, please note, that many environment variables have been renamed or removed. It is recommended to do a fresh deployment using the deployment guide.

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:3.0.0
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:3.0.0
• Catalog Crawler CE: ghcr.io/sovity/catalog-crawler-ce:9.0.0
• Sovity EDC CE: 9.0.0