From e6a193955511e9f54160bf4a876d81a1117ae184 Mon Sep 17 00:00:00 2001 From: Evelyn Gurschler Date: Wed, 6 Dec 2023 16:11:19 +0100 Subject: [PATCH] docs(v1.7.0): finalize changelog and readme --- CHANGELOG.md | 97 ++++++---------------------------- charts/portal/README.md | 46 ++++++++-------- charts/portal/README.md.gotmpl | 18 +++---- 3 files changed, 49 insertions(+), 112 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6ac359fa5..76ffb57a3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,96 +2,29 @@ New features, fixed bugs, known defects and other noteworthy changes to each release of the Catena-X Portal helm chart. -## 1.7.0-RC4 +## 1.7.0 ### Change * changed to new container images - * portal-assets: v1.7.0-RC4 - * portal-frontend: v1.7.0-RC4 - * portal-backend: v1.7.0-RC4 - * portal-frontend-registration: v1.5.3 - -### Bugfix - -* portal-backend: adjusted the application activation login link relevant for mailing - -### Technical Support - -- Trivy scan: changed to no failure on high findings, as it should only fail if there is an error/misconfiguration - -Please be aware that **this version is still in Release Candidate phase**: especially documentation is still WIP. - -## 1.7.0-RC3 - -### Change - -* changed to new container images - * portal-assets: v1.7.0-RC3 - * portal-frontend: v1.7.0-RC3 - * portal-backend: v1.7.0-RC3 - * portal-frontend-registration: v1.5.2 -* portal-backend: - * added delete and upload documentTypeIds config to appmarketplace - * adjusted parameter for mail templates -* set resource requests (based on recommendations from Goldilocks configured on consortia int env) - -### Bugfix - -* portal-backend: aligned uploadActiveAppDocumentTypeIds config - -### Technical Support - -* improved helm-test: added debug option at helm install and step to check nodes - -Please be aware that **this version is still in Release Candidate phase**: especially documentation is still WIP. - -## 1.7.0-RC2 - -### Change - -* changed to new container images - * portal-assets: v1.7.0-RC2 - * portal-frontend: v1.7.0-RC2 - * portal-backend: v1.7.0-RC2 - -Please be aware that **this version is still in Release Candidate phase**: especially documentation is still WIP. - -## 1.7.0-RC1 - -### Change - -* changed to new container images - * portal-assets: v1.7.0-RC1 - * portal-frontend: v1.7.0-RC1 - * portal-backend: v1.7.0-RC1 + * portal-assets: v1.7.0 + * portal-frontend: v1.7.0 + * portal-frontend-registration: v1.5.4 + * portal-backend: v1.7.0 * changed PostgreSQL version of the subchart by Bitnami from 14.5.0 to 15.4.0 (subchart version updated from 11.9.13 to 12.12.x) +* set resource requests (based on recommendations from Goldilocks configured on consortia int env) +* removed deprecated ingress annotation 'kubernetes.io/ingress.class' and changed to ingress.ClassName * portal-backend: - * enabled and/or extended config in particular for activeDocumentTypeIds in the app marketplace and for network2network (N2N) - -### Technical Support - -* disabled upgrade step in helm test: due to major postgres upgrade the step inevitability fails - -Please be aware that **this version is still in Release Candidate phase**: especially documentation is still WIP. - -## 1.7.0-alpha - -### Change - -* changed to new container images - * portal-assets: v1.6.1 - * portal-frontend: v1.7.0-alpha - * portal-frontend-registration: v1.5.1 - * portal-backend: v1.7.0-alpha -* remove deprecated ingress annotation 'kubernetes.io/ingress.class' and changed to ingress.ClassName - -* portal-backend: - * enabled and/or extended config in particular for network2network (N2N) and onboarding service provider (OSP) + * enabled and extended config in particular for network2network (N2N) and onboarding service provider (OSP) * updated bpdm api path * enabled config of DOTNET_ENVIRONMENT * enabled config of JWTBEAREROPTIONS_REQUIREHTTPSMETADATA * set database healthchecks in default values file + * enabled and/or extended config in particular for activeDocumentTypeIds in the app marketplace and for network2network (N2N) + * aligned uploadActiveAppDocumentTypeIds config + * added delete and upload documentTypeIds config to appmarketplace + * adjusted parameter for mail templates + * adjusted the application activation login link relevant for mailing ### Bugfix @@ -101,6 +34,10 @@ Please be aware that **this version is still in Release Candidate phase**: espec * updated k8s version and version to upgrade from for helm test workflow * updated Security.md +* disabled upgrade step in helm test: due to major postgres upgrade the step inevitability fails +* improved helm-test: added debug option at helm install and step to check nodes +* Trivy scan: changed to no failure on high findings, as it should only fail if there is an error/misconfiguration +* added pull request linting ## 1.6.0 diff --git a/charts/portal/README.md b/charts/portal/README.md index 2331a1208..c64ce6901 100644 --- a/charts/portal/README.md +++ b/charts/portal/README.md @@ -1,22 +1,22 @@ # Helm chart for Catena-X Portal -![Version: 1.7.0-RC4](https://img.shields.io/badge/Version-1.7.0--RC4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.7.0-RC4](https://img.shields.io/badge/AppVersion-1.7.0--RC4-informational?style=flat-square) +![Version: 1.7.0](https://img.shields.io/badge/Version-1.7.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.7.0](https://img.shields.io/badge/AppVersion-1.7.0-informational?style=flat-square) This helm chart installs the Catena-X Portal application which consists of -* [portal-frontend (v1.7.0-RC4)](https://github.com/eclipse-tractusx/portal-frontend/tree/v1.7.0-RC4), -* [portal-frontend-registration (v1.5.3)](https://github.com/eclipse-tractusx/portal-frontend-registration/tree/v1.5.3), -* [portal-assets (v1.7.0-RC4)](https://github.com/eclipse-tractusx/portal-assets/tree/v1.7.0-RC4) and -* [portal-backend (v1.7.0-RC4)](https://github.com/eclipse-tractusx/portal-backend/tree/v1.7.0-RC4). +* [portal-frontend (v1.7.0)](https://github.com/eclipse-tractusx/portal-frontend/tree/v1.7.0), +* [portal-frontend-registration (v1.5.4)](https://github.com/eclipse-tractusx/portal-frontend-registration/tree/v1.5.4), +* [portal-assets (v1.7.0)](https://github.com/eclipse-tractusx/portal-assets/tree/v1.7.0) and +* [portal-backend (v1.7.0)](https://github.com/eclipse-tractusx/portal-backend/tree/v1.7.0). The Catena-X Portal is designed to work with the [Catena-X IAM](https://github.com/eclipse-tractusx/portal-iam). -This version is compatible with the 2.0.0-alpha version of the IAM instances: -* [Central Keycloak Instance](https://github.com/eclipse-tractusx/portal-iam/blob/centralidp-2.0.0-alpha/charts/centralidp/README.md) -* [Shared Keycloak Instance](https://github.com/eclipse-tractusx/portal-iam/blob/sharedidp-2.0.0-alpha/charts/sharedidp/README.md) +This version is compatible with the 2.0.0 version of the IAM instances: +* [Central Keycloak Instance](https://github.com/eclipse-tractusx/portal-iam/blob/centralidp-2.0.0/charts/centralidp/README.md) +* [Shared Keycloak Instance](https://github.com/eclipse-tractusx/portal-iam/blob/sharedidp-2.0.0/charts/sharedidp/README.md) -For information on how to upgrade from previous versions please refer to [Version Upgrade](https://github.com/eclipse-tractusx/portal-assets/tree/v1.7.0-RC4/developer/Technical%20Documentation/Version%20Upgrade/portal-upgrade-details.md). +For information on how to upgrade from previous versions please refer to [Version Upgrade](https://github.com/eclipse-tractusx/portal-assets/tree/v1.7.0/developer/Technical%20Documentation/Version%20Upgrade/portal-upgrade-details.md). -For further information please refer to [Technical Documentation](https://github.com/eclipse-tractusx/portal-assets/tree/v1.7.0-RC4/developer/Technical%20Documentation). +For further information please refer to [Technical Documentation](https://github.com/eclipse-tractusx/portal-assets/tree/v1.7.0/developer/Technical%20Documentation). The referenced container images are for demonstration purposes only. @@ -41,7 +41,7 @@ To use the helm chart as a dependency: dependencies: - name: portal repository: https://eclipse-tractusx.github.io/charts/dev - version: 1.7.0-RC4 + version: 1.7.0 ``` ## Requirements @@ -77,15 +77,15 @@ dependencies: | frontend.ingress.hosts[0] | object | `{"host":"portal.example.org","paths":[{"backend":{"port":8080,"service":"portal"},"path":"/(.*)","pathType":"Prefix"},{"backend":{"port":8080,"service":"registration"},"path":"/registration/(.*)","pathType":"Prefix"},{"backend":{"port":8080,"service":"assets"},"path":"/((assetsORdocumentation)/.*)","pathType":"Prefix"}]}` | Provide default path for the ingress record. | | frontend.portal.name | string | `"portal"` | | | frontend.portal.image.name | string | `"tractusx/portal-frontend"` | | -| frontend.portal.image.portaltag | string | `"v1.7.0-RC4"` | | +| frontend.portal.image.portaltag | string | `"v1.7.0"` | | | frontend.portal.resources | object | `{"requests":{"cpu":"15m","memory":"105M"}}` | We recommend not to specify default resource limits and to leave this as a conscious choice for the user. If you do want to specify resource limits, uncomment the following lines and adjust them as necessary. | | frontend.registration.name | string | `"registration"` | | | frontend.registration.image.name | string | `"tractusx/portal-frontend-registration"` | | -| frontend.registration.image.registrationtag | string | `"v1.5.3"` | | +| frontend.registration.image.registrationtag | string | `"v1.5.4"` | | | frontend.registration.resources | object | `{"requests":{"cpu":"15m","memory":"105M"}}` | We recommend not to specify default resource limits and to leave this as a conscious choice for the user. If you do want to specify resource limits, uncomment the following lines and adjust them as necessary. | | frontend.assets.name | string | `"assets"` | | | frontend.assets.image.name | string | `"tractusx/portal-assets"` | | -| frontend.assets.image.assetstag | string | `"v1.7.0-RC4"` | | +| frontend.assets.image.assetstag | string | `"v1.7.0"` | | | frontend.assets.resources | object | `{"requests":{"cpu":"15m","memory":"105M"}}` | We recommend not to specify default resource limits and to leave this as a conscious choice for the user. If you do want to specify resource limits, uncomment the following lines and adjust them as necessary. | | frontend.assets.path | string | `"/assets"` | | | frontend.centralidpAuthPath | string | `"/auth"` | | @@ -143,7 +143,7 @@ dependencies: | backend.healthChecks.readyness.path | string | `"/ready"` | | | backend.registration.name | string | `"registration-service"` | | | backend.registration.image.name | string | `"tractusx/portal-registration-service"` | | -| backend.registration.image.registrationservicetag | string | `"v1.7.0-RC4"` | | +| backend.registration.image.registrationservicetag | string | `"v1.7.0"` | | | backend.registration.resources | object | `{"requests":{"cpu":"15m","memory":"385M"}}` | We recommend not to specify default resource limits and to leave this as a conscious choice for the user. If you do want to specify resource limits, uncomment the following lines and adjust them as necessary. | | backend.registration.logging.bpdmLibrary | string | `"Information"` | | | backend.registration.logging.registrationService | string | `"Information"` | | @@ -161,7 +161,7 @@ dependencies: | backend.registration.submitDocumentTypeIds.type0 | string | `"COMMERCIAL_REGISTER_EXTRACT"` | | | backend.administration.name | string | `"administration-service"` | | | backend.administration.image.name | string | `"tractusx/portal-administration-service"` | | -| backend.administration.image.administrationservicetag | string | `"v1.7.0-RC4"` | | +| backend.administration.image.administrationservicetag | string | `"v1.7.0"` | | | backend.administration.resources | object | `{"requests":{"cpu":"15m","memory":"385M"}}` | We recommend not to specify default resource limits and to leave this as a conscious choice for the user. If you do want to specify resource limits, uncomment the following lines and adjust them as necessary. | | backend.administration.logging.businessLogic | string | `"Information"` | | | backend.administration.logging.sdfactoryLibrary | string | `"Information"` | | @@ -216,7 +216,7 @@ dependencies: | backend.provisioning.sharedRealm.smtpServer.replyTo | string | `"smtp@example.org"` | Provide replyTo. | | backend.appmarketplace.name | string | `"marketplace-app-service"` | | | backend.appmarketplace.image.name | string | `"tractusx/portal-marketplace-app-service"` | | -| backend.appmarketplace.image.appmarketplaceservicetag | string | `"v1.7.0-RC4"` | | +| backend.appmarketplace.image.appmarketplaceservicetag | string | `"v1.7.0"` | | | backend.appmarketplace.resources | object | `{"requests":{"cpu":"15m","memory":"445M"}}` | We recommend not to specify default resource limits and to leave this as a conscious choice for the user. If you do want to specify resource limits, uncomment the following lines and adjust them as necessary. | | backend.appmarketplace.logging.default | string | `"Information"` | | | backend.appmarketplace.logging.offersLibrary | string | `"Information"` | | @@ -296,7 +296,7 @@ dependencies: | backend.appmarketplace.companyAdminRoles.role0 | string | `"Company Admin"` | | | backend.portalmigrations.name | string | `"portal-migrations"` | | | backend.portalmigrations.image.name | string | `"tractusx/portal-portal-migrations"` | | -| backend.portalmigrations.image.portalmigrationstag | string | `"v1.7.0-RC4"` | | +| backend.portalmigrations.image.portalmigrationstag | string | `"v1.7.0"` | | | backend.portalmigrations.resources | object | `{"requests":{"cpu":"15m","memory":"105M"}}` | We recommend not to specify default resource limits and to leave this as a conscious choice for the user. If you do want to specify resource limits, uncomment the following lines and adjust them as necessary. | | backend.portalmigrations.seeding.testDataEnvironments | string | `""` | | | backend.portalmigrations.seeding.testDataPaths | string | `"Seeder/Data"` | when changing the testDataPath the processIdentity needs to be adjusted as well, or it must be ensured that the identity is existing within the files under the new path | @@ -307,7 +307,7 @@ dependencies: | backend.portalmigrations.logging.default | string | `"Information"` | | | backend.portalmaintenance.name | string | `"portal-maintenance"` | | | backend.portalmaintenance.image.name | string | `"tractusx/portal-maintenance-service"` | | -| backend.portalmaintenance.image.portalmaintenancetag | string | `"v1.7.0-RC4"` | | +| backend.portalmaintenance.image.portalmaintenancetag | string | `"v1.7.0"` | | | backend.portalmaintenance.resources | object | `{"requests":{"cpu":"15m","memory":"105M"}}` | We recommend not to specify default resource limits and to leave this as a conscious choice for the user. If you do want to specify resource limits, uncomment the following lines and adjust them as necessary. | | backend.portalmaintenance.processIdentity.userEntityId | string | `"090c9121-7380-4bb0-bb10-fffd344f930a"` | | | backend.portalmaintenance.processIdentity.processUserId | string | `"d21d2e8a-fe35-483c-b2b8-4100ed7f0953"` | | @@ -316,14 +316,14 @@ dependencies: | backend.portalmaintenance.logging.default | string | `"Information"` | | | backend.notification.name | string | `"notification-service"` | | | backend.notification.image.name | string | `"tractusx/portal-notification-service"` | | -| backend.notification.image.notificationservicetag | string | `"v1.7.0-RC4"` | | +| backend.notification.image.notificationservicetag | string | `"v1.7.0"` | | | backend.notification.resources | object | `{"requests":{"cpu":"15m","memory":"300M"}}` | We recommend not to specify default resource limits and to leave this as a conscious choice for the user. If you do want to specify resource limits, uncomment the following lines and adjust them as necessary. | | backend.notification.healthChecks | object | `{"startup":{"tags":[{"name":"HEALTHCHECKS__0__TAGS__1","value":"portaldb"}]}}` | Keycloak Healthcheck to be enabled for startupProbe; once the centralidp Keycloak instance is available, enable healthcheck by uncommenting. | | backend.notification.swaggerEnabled | bool | `false` | | | backend.notification.logging.default | string | `"Information"` | | | backend.services.name | string | `"services-service"` | | | backend.services.image.name | string | `"tractusx/portal-services-service"` | | -| backend.services.image.servicesservicetag | string | `"v1.7.0-RC4"` | | +| backend.services.image.servicesservicetag | string | `"v1.7.0"` | | | backend.services.resources | object | `{"requests":{"cpu":"15m","memory":"445M"}}` | We recommend not to specify default resource limits and to leave this as a conscious choice for the user. If you do want to specify resource limits, uncomment the following lines and adjust them as necessary. | | backend.services.logging.default | string | `"Information"` | | | backend.services.logging.offersLibrary | string | `"Information"` | | @@ -362,12 +362,12 @@ dependencies: | backend.services.companyAdminRoles.role0 | string | `"Company Admin"` | | | backend.provisioningmigrations.name | string | `"provisioning-migrations"` | | | backend.provisioningmigrations.image.name | string | `"tractusx/portal-provisioning-migrations"` | | -| backend.provisioningmigrations.image.provisioningmigrationstag | string | `"v1.7.0-RC4"` | | +| backend.provisioningmigrations.image.provisioningmigrationstag | string | `"v1.7.0"` | | | backend.provisioningmigrations.resources | object | `{"requests":{"cpu":"15m","memory":"105M"}}` | We recommend not to specify default resource limits and to leave this as a conscious choice for the user. If you do want to specify resource limits, uncomment the following lines and adjust them as necessary. | | backend.provisioningmigrations.logging.default | string | `"Information"` | | | backend.processesworker.name | string | `"processes-worker"` | | | backend.processesworker.image.name | string | `"tractusx/portal-processes-worker"` | | -| backend.processesworker.image.processesworkertag | string | `"v1.7.0-RC4"` | | +| backend.processesworker.image.processesworkertag | string | `"v1.7.0"` | | | backend.processesworker.resources | object | `{"requests":{"cpu":"15m","memory":"105M"}}` | We recommend not to specify default resource limits and to leave this as a conscious choice for the user. If you do want to specify resource limits, uncomment the following lines and adjust them as necessary. | | backend.processesworker.logging.default | string | `"Information"` | | | backend.processesworker.logging.processesLibrary | string | `"Information"` | | diff --git a/charts/portal/README.md.gotmpl b/charts/portal/README.md.gotmpl index 1f3a587d1..788969e00 100644 --- a/charts/portal/README.md.gotmpl +++ b/charts/portal/README.md.gotmpl @@ -4,19 +4,19 @@ This helm chart installs the Catena-X Portal application which consists of -* [portal-frontend (v1.7.0-RC4)](https://github.com/eclipse-tractusx/portal-frontend/tree/v1.7.0-RC4), -* [portal-frontend-registration (v1.5.3)](https://github.com/eclipse-tractusx/portal-frontend-registration/tree/v1.5.3), -* [portal-assets (v1.7.0-RC4)](https://github.com/eclipse-tractusx/portal-assets/tree/v1.7.0-RC4) and -* [portal-backend (v1.7.0-RC4)](https://github.com/eclipse-tractusx/portal-backend/tree/v1.7.0-RC4). +* [portal-frontend (v1.7.0)](https://github.com/eclipse-tractusx/portal-frontend/tree/v1.7.0), +* [portal-frontend-registration (v1.5.4)](https://github.com/eclipse-tractusx/portal-frontend-registration/tree/v1.5.4), +* [portal-assets (v1.7.0)](https://github.com/eclipse-tractusx/portal-assets/tree/v1.7.0) and +* [portal-backend (v1.7.0)](https://github.com/eclipse-tractusx/portal-backend/tree/v1.7.0). The Catena-X Portal is designed to work with the [Catena-X IAM](https://github.com/eclipse-tractusx/portal-iam). -This version is compatible with the 2.0.0-alpha version of the IAM instances: -* [Central Keycloak Instance](https://github.com/eclipse-tractusx/portal-iam/blob/centralidp-2.0.0-alpha/charts/centralidp/README.md) -* [Shared Keycloak Instance](https://github.com/eclipse-tractusx/portal-iam/blob/sharedidp-2.0.0-alpha/charts/sharedidp/README.md) +This version is compatible with the 2.0.0 version of the IAM instances: +* [Central Keycloak Instance](https://github.com/eclipse-tractusx/portal-iam/blob/centralidp-2.0.0/charts/centralidp/README.md) +* [Shared Keycloak Instance](https://github.com/eclipse-tractusx/portal-iam/blob/sharedidp-2.0.0/charts/sharedidp/README.md) -For information on how to upgrade from previous versions please refer to [Version Upgrade](https://github.com/eclipse-tractusx/portal-assets/tree/v1.7.0-RC4/developer/Technical%20Documentation/Version%20Upgrade/portal-upgrade-details.md). +For information on how to upgrade from previous versions please refer to [Version Upgrade](https://github.com/eclipse-tractusx/portal-assets/tree/v1.7.0/developer/Technical%20Documentation/Version%20Upgrade/portal-upgrade-details.md). -For further information please refer to [Technical Documentation](https://github.com/eclipse-tractusx/portal-assets/tree/v1.7.0-RC4/developer/Technical%20Documentation). +For further information please refer to [Technical Documentation](https://github.com/eclipse-tractusx/portal-assets/tree/v1.7.0/developer/Technical%20Documentation). The referenced container images are for demonstration purposes only.