Skip to content

Commit

Permalink
chore: prepare release (#249)
Browse files Browse the repository at this point in the history
  • Loading branch information
richardtreier authored Jul 24, 2024
1 parent 199e816 commit a2b6364
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 35 deletions.
40 changes: 31 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,8 @@ please see [changelog_updates.md](docs/dev/changelog_updates.md).

#### Minor

- Added unique URLs to data offers that enable direct navigation
- Added a button in the data offer detail view to copy the data offer URL
- Now showing complex policies in the catalog browser

#### Patch

- Fix Catalog UI after Broker intergration [#238](https://github.com/sovity/authority-portal/issues/238)
- Fix deployment environment not syncing in URLs for the catalog
- Fix keycloak not redirecting to the correct page after login.

### Known issues

### Deployment Migration Notes
Expand All @@ -34,6 +26,36 @@ please see [changelog_updates.md](docs/dev/changelog_updates.md).
- Catalog Crawler CE: `ghcr.io/sovity/catalog-crawler-ce:{{ CE VERSION }}`
- Sovity EDC CE: {{ CE Release Link }}

## [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](https://github.com/sovity/authority-portal/issues/238)
- Fixed deployment environment not syncing in URLs for the catalog
- Fixed keycloak not redirecting to the correct page after login.

### Known issues

### Deployment Migration Notes

#### 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`](https://github.com/sovity/edc-ce/releases/tag/v10.0.0)

## [v3.0.0] - 2024-07-15

### Overview
Expand Down Expand Up @@ -98,7 +120,7 @@ MDS 2.2 intermediate release
- 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](https://github.com/sovity/edc-ce/blob/v9.0.0/docs/deployment-guide/goals/catalog-crawler-production/README.md)
- There is a dedicated [Catalog Crawler Productive Deployment Guide](https://github.com/sovity/edc-ce/blob/v10.0.0/docs/deployment-guide/goals/catalog-crawler-production/README.md)
- 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.
Expand Down
2 changes: 1 addition & 1 deletion authority-portal-backend/gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ java = "17"
kotlin = "1.9.22"
npmVersion = "8.15.0"

sovity-edcCe = "0.0.1-SNAPSHOT"
sovity-edcCe = "10.0.0"

quarkus = "3.9.2"
quarkus-keycloakAdminClientReactive = "3.6.6"
Expand Down
26 changes: 1 addition & 25 deletions docs/deployment-guide/goals/production/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,31 +292,7 @@ AUTHORITY_PORTAL_FRONTEND_SUPPORT_URL: https://support.mobility-dataspace.eu # S
- Each deployment environment requires a Data Catalog Crawler.
- A Data Catalog Crawler is based on the EDC Connector and crawls the catalogs of all connectors in the dataspace.
- You will need an SKI/AKI client ID to register the crawler. Please refer to the [EDC documentation](https://github.com/sovity/edc-ce/tree/main/docs/getting-started#faq) on how to generate one.
- Pre-configured configuration values for the crawler can be found in the [edc-extensions/launcher/.env.catalog-crawler](https://github.com/sovity/edc-ce/blob/main/launchers/.env.catalog-crawler) for the appropriate version.
- As specified in the crawler's deployment guide, following environment variables must be configured manually:
- ```yaml
# Required: Fully Qualified Domain Name
MY_EDC_FQDN: "crawler.test.example.com"
# Required: Authority Portal Environment ID
CRAWLER_ENVIRONMENT_ID: test
# Required: Authority Portal Postgresql DB Access
CRAWLER_DB_JDBC_URL: jdbc:postgresql://authority-portal:5432/portal
CRAWLER_DB_JDBC_USER: portal
CRAWLER_DB_JDBC_PASSWORD: portal
# Required: DAPS credentials
EDC_OAUTH_TOKEN_URL: 'https://daps.test.mobility-dataspace.eu/token'
EDC_OAUTH_PROVIDER_JWKS_URL: 'https://daps.test.mobility-dataspace.eu/jwks.json'
EDC_OAUTH_CLIENT_ID: '_your SKI/AKI_'
EDC_KEYSTORE: '_your keystore file_' # Needs to be available as file in the running container
EDC_KEYSTORE_PASSWORD: '_your keystore password_'
EDC_OAUTH_CERTIFICATE_ALIAS: 1
EDC_OAUTH_PRIVATE_KEY_ALIAS: 1
```
- The DAPS needs to contain the claim `referringConnector=MY_EDC_PARTICIPANT_ID` where `MY_EDC_PARTICIPANT_ID` is the value of same named configuration variable (default: 'broker').
- For help with the deployment and configuration of a crawler, see its [productive deployment guide](https://github.com/sovity/edc-ce/blob/main/docs/deployment-guide/goals/catalog-crawler-production/README.md)
- See the [Catalog Crawler Productive Deployment Guide](https://github.com/sovity/edc-ce/blob/v10.0.0/docs/deployment-guide/goals/catalog-crawler-production/README.md)

## Initial Setup

Expand Down

0 comments on commit a2b6364

Please sign in to comment.