From 4d1200ab207d3b9bd59e4385272aef4e381ca3ac Mon Sep 17 00:00:00 2001 From: Evelyn Gurschler Date: Mon, 7 Oct 2024 17:40:40 +0200 Subject: [PATCH] build(2.3.0-alpha.2): bump version and update docs --- CHANGELOG.md | 14 +++-- charts/localdev/Chart.yaml | 2 +- charts/localdev/README.md | 53 +++++++++---------- charts/portal/Chart.yaml | 4 +- charts/portal/README.md | 30 +++++------ charts/portal/README.md.gotmpl | 4 +- charts/portal/values.yaml | 4 +- .../argocd-app-templates/appsetup-int.yaml | 2 +- 8 files changed, 58 insertions(+), 55 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a1e035c2..98d823fd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,17 +2,23 @@ New features, fixed bugs, known defects and other noteworthy changes to each release of the Catena-X Portal helm chart. -## Unreleased +## 2.3.0-alpha.2 ### Change -* frontend environment variables - * added client id value for BPDM +* changed to new container images + * portal-frontend: v2.3.0-alpha.2 + * portal-backend: v2.3.0-alpha.2 +* portal-frontend [#438](https://github.com/eclipse-tractusx/portal/pull/438) + * added client ID value for BPDM * moved clearinghouseConnectDisabled from backend to global - * exported additional environment variables for frontend + * enabled additional environment variables * CLEARINGHOUSE_CONNECT_DISABLED * CLIENT_ID_REGISTRATION * CLIENT_ID_BPDM +* portal-backend: + * added DIM user roles to service account settings [#435](https://github.com/eclipse-tractusx/portal/pull/435) + * adjusted configuration for enabled startSharingStateAsReady from BPDM side [#445](https://github.com/eclipse-tractusx/portal/pull/445) ## 2.3.0-alpha.1 diff --git a/charts/localdev/Chart.yaml b/charts/localdev/Chart.yaml index 8de50e6f..2894bb69 100644 --- a/charts/localdev/Chart.yaml +++ b/charts/localdev/Chart.yaml @@ -33,7 +33,7 @@ dependencies: - condition: portal.enabled name: portal repository: file://../portal - version: 2.3.0-alpha.1 + version: 2.3.0-alpha.2 - condition: centralidp.enabled name: centralidp repository: https://eclipse-tractusx.github.io/charts/dev diff --git a/charts/localdev/README.md b/charts/localdev/README.md index ed3a0da2..691cb92e 100644 --- a/charts/localdev/README.md +++ b/charts/localdev/README.md @@ -10,33 +10,30 @@ This chart also sets up an additional [postgresql](https://artifacthub.io/packag For detailed information about the default configuration values, please have a look at the [Values table](#values) and/or [Values file](./values.yaml). -- [Setup of CX Portal \& IAM for local development](#setup-of-cx-portal--iam-for-local-development) - - [Usage](#usage) - - [Cluster Setup](#cluster-setup) - - [Cluster Setup Linux and Mac](#cluster-setup-linux-and-mac) - - [Cluster Setup Windows](#cluster-setup-windows) - - [Minikube](#minikube) - - [Docker Desktop integrated Kubernetes](#docker-desktop-integrated-kubernetes) - - [Network Setup](#network-setup) - - [Minikube Addons](#minikube-addons) - - [Docker Desktop integrated Kubernetes Ingress Controller](#docker-desktop-integrated-kubernetes-ingress-controller) - - [Network Setup on Linux and Mac](#network-setup-on-linux-and-mac) - - [Additional Network Setup for Mac](#additional-network-setup-for-mac) - - [Network Setup on Windows/wsl2 with NTLM-proxy](#network-setup-on-windowswsl2-with-ntlm-proxy) - - [px-proxy](#px-proxy) - - [DNS-resolution in Windows](#dns-resolution-in-windows) - - [DNS-resolution in wsl2](#dns-resolution-in-wsl2) - - [Proxy-setup in wsl2](#proxy-setup-in-wsl2) - - [Install](#install) - - [Use released chart](#use-released-chart) - - [Use local repository](#use-local-repository) - - [Perform first login](#perform-first-login) - - [Database Access](#database-access) - - [Keycloak Admin Console](#keycloak-admin-console) - - [Uninstall](#uninstall) - - [Prepare self-signed TLS setup (Optional)](#prepare-self-signed-tls-setup-optional) - - [Requirements](#requirements) - - [Values](#values) +- [Usage](#usage) +- [Cluster setup](#cluster-setup) + - [Linux and Mac](#cluster-setup-linux-and-mac) + - [Cluster Setup Windows](#cluster-setup-windows) + - [Minikube](#minikube) + - [Docker Desktop integrated Kubernetes](#docker-desktop-integrated-kubernetes) +- [Network Setup](#network-setup) + - [Minikube Addons](#minikube-addons) + - [Docker Desktop integrated Kubernetes Ingress Controller](#docker-desktop-integrated-kubernetes-ingress-controller) + - [Linux and Mac](#network-setup-on-linux-and-mac) + - [Additional Network Setup for Mac](#additional-network-setup-for-mac) + - [Windows/wsl2 with NTLM-proxy](#network-setup-on-windowswsl2-with-ntlm-proxy) + - [px-proxy](#px-proxy) + - [DNS-resolution in Windows](#dns-resolution-in-windows) + - [DNS-resolution in wsl2](#dns-resolution-in-wsl2) + - [Proxy-setup in wsl2](#proxy-setup-in-wsl2) +- [Install](#install) + - [Use released chart](#use-released-chart) + - [Use local repository](#use-local-repository) +- [Perform first login](#perform-first-login) +- [Database Access](#database-access) +- [Keycloak Admin Console](#keycloak-admin-console) +- [Uninstall](#uninstall) +- [Prepare self-signed TLS setup (Optional)](#prepare-self-signed-tls-setup-optional) ## Usage @@ -567,7 +564,7 @@ See [cert-manager self-signed](https://cert-manager.io/docs/configuration/selfsi | Repository | Name | Version | |------------|------|---------| -| file://../portal | portal | 2.2.0-RC3 | +| file://../portal | portal | 2.3.0-alpha.2 | | https://charts.bitnami.com/bitnami | postgresportal(postgresql) | 12.12.x | | https://eclipse-tractusx.github.io/charts/dev | centralidp | 3.0.0 | | https://eclipse-tractusx.github.io/charts/dev | sharedidp | 3.0.0 | diff --git a/charts/portal/Chart.yaml b/charts/portal/Chart.yaml index 6acbc71c..0ab122a3 100644 --- a/charts/portal/Chart.yaml +++ b/charts/portal/Chart.yaml @@ -20,8 +20,8 @@ apiVersion: v2 name: portal type: application -version: 2.3.0-alpha.1 -appVersion: 2.3.0-alpha.1 +version: 2.3.0-alpha.2 +appVersion: 2.3.0-alpha.2 description: Helm chart for Catena-X Portal home: https://github.com/eclipse-tractusx/portal sources: diff --git a/charts/portal/README.md b/charts/portal/README.md index 99f94057..769f719f 100644 --- a/charts/portal/README.md +++ b/charts/portal/README.md @@ -1,13 +1,13 @@ # Helm chart for Catena-X Portal -![Version: 2.3.0-alpha.1](https://img.shields.io/badge/Version-2.3.0--alpha.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.3.0-alpha.1](https://img.shields.io/badge/AppVersion-2.3.0--alpha.1-informational?style=flat-square) +![Version: 2.3.0-alpha.2](https://img.shields.io/badge/Version-2.3.0--alpha.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.3.0-alpha.2](https://img.shields.io/badge/AppVersion-2.3.0--alpha.2-informational?style=flat-square) This helm chart installs the Portal application which consists of -* [portal-frontend (v2.3.0-alpha.1)](https://github.com/eclipse-tractusx/portal-frontend/tree/v2.3.0-alpha.1), +* [portal-frontend (v2.3.0-alpha.2)](https://github.com/eclipse-tractusx/portal-frontend/tree/v2.3.0-alpha.2), * [portal-frontend-registration (v2.1.0-alpha.1)](https://github.com/eclipse-tractusx/portal-frontend-registration/tree/v2.1.0-alpha.1), * [portal-assets (v2.2.0)](https://github.com/eclipse-tractusx/portal-assets/tree/v2.2.0) and -* [portal-backend (v2.3.0-alpha.1)](https://github.com/eclipse-tractusx/portal-backend/tree/v2.3.0-alpha.1). +* [portal-backend (v2.3.0-alpha.2)](https://github.com/eclipse-tractusx/portal-backend/tree/v2.3.0-alpha.2). The Portal is designed to work with the [IAM](https://github.com/eclipse-tractusx/portal-iam). This version is compatible with the 3.0.1 version of the IAM instances: @@ -45,7 +45,7 @@ To use the helm chart as a dependency: dependencies: - name: portal repository: https://eclipse-tractusx.github.io/charts/dev - version: 2.3.0-alpha.1 + version: 2.3.0-alpha.2 ``` ## Requirements @@ -60,7 +60,7 @@ dependencies: |-----|------|---------|-------------| | portalAddress | string | `"https://portal.example.org"` | Provide portal base address. | | portalBackendAddress | string | `"https://portal-backend.example.org"` | Provide portal-backend base address. | -| centralidp | object | `{"address":"https://centralidp.example.org","clients":{"issuerComponent":"Cl24-CX-SSI-CredentialIssuer","miw":"Cl5-CX-Custodian","portal":"Cl2-CX-Portal","registration":"Cl1-CX-Registration","semantic":"Cl3-CX-Semantic","technicalRolesManagement":"technical_roles_management"},"realm":"CX-Central"}` | Provide details about centralidp (CX IAM) Keycloak instance. | +| centralidp | object | `{"address":"https://centralidp.example.org","clients":{"bpdm":"Cl7-CX-BPDM","issuerComponent":"Cl24-CX-SSI-CredentialIssuer","miw":"Cl5-CX-Custodian","portal":"Cl2-CX-Portal","registration":"Cl1-CX-Registration","semantic":"Cl3-CX-Semantic","technicalRolesManagement":"technical_roles_management"},"realm":"CX-Central"}` | Provide details about centralidp (CX IAM) Keycloak instance. | | centralidp.address | string | `"https://centralidp.example.org"` | Provide centralidp base address, without trailing '/auth'. | | sharedidpAddress | string | `"https://sharedidp.example.org"` | Provide sharedidp address (CX IAM), without trailing '/auth'. | | semanticsAddress | string | `"https://semantics.example.org"` | Provide semantics base address. | @@ -88,7 +88,7 @@ dependencies: | frontend.ingress.hosts[0] | object | `{"host":"","paths":[{"backend":{"port":8080,"service":"portal"},"path":"/(.*)","pathType":"Prefix"},{"backend":{"port":8080,"service":"registration"},"path":"/registration/(.*)","pathType":"Prefix"},{"backend":{"port":8080,"service":"assets"},"path":"/((assets|documentation)/.*)","pathType":"Prefix"}]}` | Provide default path for the ingress record. | | frontend.portal.name | string | `"portal"` | | | frontend.portal.image.name | string | `"docker.io/tractusx/portal-frontend"` | | -| frontend.portal.image.portaltag | string | `"v2.3.0-alpha.1"` | | +| frontend.portal.image.portaltag | string | `"v2.3.0-alpha.2"` | | | frontend.portal.image.pullPolicy | string | `"IfNotPresent"` | | | frontend.portal.image.pullSecrets | list | `[]` | Pull secrets for private docker registry | | frontend.portal.resources | object | `{"limits":{"cpu":"75m","memory":"125M"},"requests":{"cpu":"25m","memory":"125M"}}` | We recommend to review the default resource limits as this should a conscious choice. | @@ -149,7 +149,7 @@ dependencies: | backend.healthChecks.readyness.path | string | `"/ready"` | | | backend.registration.name | string | `"registration-service"` | | | backend.registration.image.name | string | `"docker.io/tractusx/portal-registration-service"` | | -| backend.registration.image.registrationservicetag | string | `"v2.3.0-alpha.1"` | | +| backend.registration.image.registrationservicetag | string | `"v2.3.0-alpha.2"` | | | backend.registration.image.pullPolicy | string | `"IfNotPresent"` | | | backend.registration.image.pullSecrets | list | `[]` | Pull secrets for private docker registry | | backend.registration.resources | object | `{"limits":{"cpu":"225m","memory":"400M"},"requests":{"cpu":"75m","memory":"400M"}}` | We recommend to review the default resource limits as this should a conscious choice. | @@ -176,7 +176,7 @@ dependencies: | backend.registration.submitDocumentTypeIds.type0 | string | `"COMMERCIAL_REGISTER_EXTRACT"` | | | backend.administration.name | string | `"administration-service"` | | | backend.administration.image.name | string | `"docker.io/tractusx/portal-administration-service"` | | -| backend.administration.image.administrationservicetag | string | `"v2.3.0-alpha.1"` | | +| backend.administration.image.administrationservicetag | string | `"v2.3.0-alpha.2"` | | | backend.administration.image.pullPolicy | string | `"IfNotPresent"` | | | backend.administration.image.pullSecrets | list | `[]` | Pull secrets for private docker registry | | backend.administration.resources | object | `{"limits":{"cpu":"225m","memory":"500M"},"requests":{"cpu":"75m","memory":"500M"}}` | We recommend to review the default resource limits as this should a conscious choice. | @@ -241,7 +241,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 | `"docker.io/tractusx/portal-marketplace-app-service"` | | -| backend.appmarketplace.image.appmarketplaceservicetag | string | `"v2.3.0-alpha.1"` | | +| backend.appmarketplace.image.appmarketplaceservicetag | string | `"v2.3.0-alpha.2"` | | | backend.appmarketplace.image.pullPolicy | string | `"IfNotPresent"` | | | backend.appmarketplace.image.pullSecrets | list | `[]` | Pull secrets for private docker registry | | backend.appmarketplace.resources | object | `{"limits":{"cpu":"225m","memory":"400M"},"requests":{"cpu":"75m","memory":"400M"}}` | We recommend to review the default resource limits as this should a conscious choice. | @@ -324,7 +324,7 @@ dependencies: | backend.appmarketplace.companyAdminRoles.role0 | string | `"Company Admin"` | | | backend.portalmigrations.name | string | `"portal-migrations"` | | | backend.portalmigrations.image.name | string | `"docker.io/tractusx/portal-portal-migrations"` | | -| backend.portalmigrations.image.portalmigrationstag | string | `"v2.3.0-alpha.1"` | | +| backend.portalmigrations.image.portalmigrationstag | string | `"v2.3.0-alpha.2"` | | | backend.portalmigrations.image.pullPolicy | string | `"IfNotPresent"` | | | backend.portalmigrations.image.pullSecrets | list | `[]` | Pull secrets for private docker registry | | backend.portalmigrations.resources | object | `{"limits":{"cpu":"75m","memory":"350M"},"requests":{"cpu":"25m","memory":"350M"}}` | We recommend to review the default resource limits as this should a conscious choice. | @@ -335,7 +335,7 @@ dependencies: | backend.portalmigrations.logging.default | string | `"Information"` | | | backend.portalmaintenance.name | string | `"portal-maintenance"` | | | backend.portalmaintenance.image.name | string | `"docker.io/tractusx/portal-maintenance-service"` | | -| backend.portalmaintenance.image.portalmaintenancetag | string | `"v2.3.0-alpha.1"` | | +| backend.portalmaintenance.image.portalmaintenancetag | string | `"v2.3.0-alpha.2"` | | | backend.portalmaintenance.image.pullPolicy | string | `"IfNotPresent"` | | | backend.portalmaintenance.image.pullSecrets | list | `[]` | Pull secrets for private docker registry | | backend.portalmaintenance.resources | object | `{"limits":{"cpu":"75m","memory":"200M"},"requests":{"cpu":"25m","memory":"200M"}}` | We recommend to review the default resource limits as this should a conscious choice. | @@ -344,7 +344,7 @@ dependencies: | backend.portalmaintenance.logging.default | string | `"Information"` | | | backend.notification.name | string | `"notification-service"` | | | backend.notification.image.name | string | `"docker.io/tractusx/portal-notification-service"` | | -| backend.notification.image.notificationservicetag | string | `"v2.3.0-alpha.1"` | | +| backend.notification.image.notificationservicetag | string | `"v2.3.0-alpha.2"` | | | backend.notification.image.pullPolicy | string | `"IfNotPresent"` | | | backend.notification.image.pullSecrets | list | `[]` | Pull secrets for private docker registry | | backend.notification.resources | object | `{"limits":{"cpu":"225m","memory":"200M"},"requests":{"cpu":"75m","memory":"200M"}}` | We recommend to review the default resource limits as this should a conscious choice. | @@ -354,7 +354,7 @@ dependencies: | backend.notification.logging.default | string | `"Information"` | | | backend.services.name | string | `"services-service"` | | | backend.services.image.name | string | `"docker.io/tractusx/portal-services-service"` | | -| backend.services.image.servicesservicetag | string | `"v2.3.0-alpha.1"` | | +| backend.services.image.servicesservicetag | string | `"v2.3.0-alpha.2"` | | | backend.services.image.pullPolicy | string | `"IfNotPresent"` | | | backend.services.image.pullSecrets | list | `[]` | Pull secrets for private docker registry | | backend.services.resources | object | `{"limits":{"cpu":"225m","memory":"400M"},"requests":{"cpu":"75m","memory":"400M"}}` | We recommend to review the default resource limits as this should a conscious choice. | @@ -399,14 +399,14 @@ dependencies: | backend.services.companyAdminRoles.role0 | string | `"Company Admin"` | | | backend.provisioningmigrations.name | string | `"provisioning-migrations"` | | | backend.provisioningmigrations.image.name | string | `"docker.io/tractusx/portal-provisioning-migrations"` | | -| backend.provisioningmigrations.image.provisioningmigrationstag | string | `"v2.3.0-alpha.1"` | | +| backend.provisioningmigrations.image.provisioningmigrationstag | string | `"v2.3.0-alpha.2"` | | | backend.provisioningmigrations.image.pullPolicy | string | `"IfNotPresent"` | | | backend.provisioningmigrations.image.pullSecrets | list | `[]` | Pull secrets for private docker registry | | backend.provisioningmigrations.resources | object | `{"limits":{"cpu":"75m","memory":"200M"},"requests":{"cpu":"25m","memory":"200M"}}` | We recommend to review the default resource limits as this should a conscious choice. | | backend.provisioningmigrations.logging.default | string | `"Information"` | | | backend.processesworker.name | string | `"processes-worker"` | | | backend.processesworker.image.name | string | `"docker.io/tractusx/portal-processes-worker"` | | -| backend.processesworker.image.processesworkertag | string | `"v2.3.0-alpha.1"` | | +| backend.processesworker.image.processesworkertag | string | `"v2.3.0-alpha.2"` | | | backend.processesworker.image.pullPolicy | string | `"IfNotPresent"` | | | backend.processesworker.image.pullSecrets | list | `[]` | Pull secrets for private docker registry | | backend.processesworker.resources | object | `{"limits":{"cpu":"225m","memory":"600M"},"requests":{"cpu":"75m","memory":"600M"}}` | We recommend to review the default resource limits as this should a conscious choice. | diff --git a/charts/portal/README.md.gotmpl b/charts/portal/README.md.gotmpl index 83df01e6..af7d9eb2 100644 --- a/charts/portal/README.md.gotmpl +++ b/charts/portal/README.md.gotmpl @@ -4,10 +4,10 @@ This helm chart installs the Portal application which consists of -* [portal-frontend (v2.3.0-alpha.1)](https://github.com/eclipse-tractusx/portal-frontend/tree/v2.3.0-alpha.1), +* [portal-frontend (v2.3.0-alpha.2)](https://github.com/eclipse-tractusx/portal-frontend/tree/v2.3.0-alpha.2), * [portal-frontend-registration (v2.1.0-alpha.1)](https://github.com/eclipse-tractusx/portal-frontend-registration/tree/v2.1.0-alpha.1), * [portal-assets (v2.2.0)](https://github.com/eclipse-tractusx/portal-assets/tree/v2.2.0) and -* [portal-backend (v2.3.0-alpha.1)](https://github.com/eclipse-tractusx/portal-backend/tree/v2.3.0-alpha.1). +* [portal-backend (v2.3.0-alpha.2)](https://github.com/eclipse-tractusx/portal-backend/tree/v2.3.0-alpha.2). The Portal is designed to work with the [IAM](https://github.com/eclipse-tractusx/portal-iam). This version is compatible with the 3.0.1 version of the IAM instances: diff --git a/charts/portal/values.yaml b/charts/portal/values.yaml index 4e82be03..ce03e2bf 100644 --- a/charts/portal/values.yaml +++ b/charts/portal/values.yaml @@ -146,7 +146,7 @@ frontend: name: "registration" image: name: "docker.io/tractusx/portal-frontend-registration" - registrationtag: 083f84a97d28cf7c9cd108a89c4ecf55f316d5f4 + registrationtag: v2.1.0-alpha.1 pullPolicy: "IfNotPresent" # -- Pull secrets for private docker registry pullSecrets: [] @@ -162,7 +162,7 @@ frontend: name: "assets" image: name: "docker.io/tractusx/portal-assets" - assetstag: 306d8544a1f26c5c2ba0df55dda1b29c182f784c + assetstag: v2.2.0 pullPolicy: "IfNotPresent" # -- Pull secrets for private docker registry pullSecrets: [] diff --git a/environments/argocd-app-templates/appsetup-int.yaml b/environments/argocd-app-templates/appsetup-int.yaml index 077535d0..9d97c8b4 100644 --- a/environments/argocd-app-templates/appsetup-int.yaml +++ b/environments/argocd-app-templates/appsetup-int.yaml @@ -28,7 +28,7 @@ spec: source: path: charts/portal repoURL: 'https://github.com/eclipse-tractusx/portal.git' - targetRevision: portal-2.3.0-alpha.1 + targetRevision: portal-2.3.0-alpha.2 plugin: env: - name: AVP_SECRET