From 645b2ed6b0954f0ba9b98dfa5b9fa9c19925b6dc Mon Sep 17 00:00:00 2001 From: Evelyn Gurschler Date: Mon, 12 Aug 2024 21:27:28 +0200 Subject: [PATCH] docs: add info about postgres subchart of portal which need to be downloaded due to change to filesystem --- charts/localdev/README.md | 18 +++++++++++++----- charts/localdev/README.md.gotmpl | 9 ++++++++- 2 files changed, 21 insertions(+), 6 deletions(-) diff --git a/charts/localdev/README.md b/charts/localdev/README.md index 8b8327ebf..f39c0af66 100644 --- a/charts/localdev/README.md +++ b/charts/localdev/README.md @@ -1,6 +1,6 @@ # Setup of CX Portal & IAM for local development -![Version: 0.6.0](https://img.shields.io/badge/Version-0.6.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) +![Version: 0.7.0](https://img.shields.io/badge/Version-0.7.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) This umbrella chart installs the helm charts of the [CX Portal](https://github.com/eclipse-tractusx/portal-cd/blob/portal-2.0.0/charts/portal/README.md) and of the [CX IAM](https://github.com/eclipse-tractusx/portal-iam) Keycloak instances ([centralidp](https://github.com/eclipse-tractusx/portal-iam/blob/centralidp-3.0.0/charts/centralidp/README.md) and [sharedidp](https://github.com/eclipse-tractusx/portal-iam/blob/sharedidp-3.0.0/charts/sharedidp/README.md)). @@ -154,7 +154,14 @@ Then change to the chart directory: ```bash cd charts/localdev/ ``` -Download the chart dependencies: + +Download the postgres dependency of the Portal helm chart: + +```bash +helm dependency update ../portal +``` + +Download the chart dependencies of the LocalDev umbrella helm chart: ```bash helm dependency update @@ -434,9 +441,9 @@ See [cert-manager self-signed](https://cert-manager.io/docs/configuration/selfsi | Repository | Name | Version | |------------|------|---------| +| file://../portal | portal | 2.2.0-RC1 | | 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 | portal | 2.0.0 | | https://eclipse-tractusx.github.io/charts/dev | sharedidp | 3.0.0 | | https://helm.runix.net | pgadmin4 | 1.17.x | @@ -465,6 +472,7 @@ See [cert-manager self-signed](https://cert-manager.io/docs/configuration/selfsi | portal.readinessProbes.initialDelaySeconds | int | `200` | | | portal.frontend.portal.requireHttpsUrlPattern | bool | `false` | | | portal.frontend.ingress.enabled | bool | `true` | | +| portal.frontend.ingress.className | string | `"nginx"` | | | portal.frontend.ingress.annotations."nginx.ingress.kubernetes.io/rewrite-target" | string | `"/$1"` | | | portal.frontend.ingress.annotations."nginx.ingress.kubernetes.io/use-regex" | string | `"true"` | | | portal.frontend.ingress.annotations."nginx.ingress.kubernetes.io/enable-cors" | string | `"true"` | | @@ -531,7 +539,6 @@ See [cert-manager self-signed](https://cert-manager.io/docs/configuration/selfsi | portal.backend.processesworker.dim.encryptionConfigs.index0.encryptionKey | string | `"6cbaf47ee30c778088e6faa44e2f0eed98beda86db06c7d2e37e32ab78e14b33"` | | | portal.backend.processesworker.issuerComponent.clientId | string | `"sa-cl2-04"` | | | portal.backend.processesworker.issuerComponent.clientSecret | string | `"c0gFPfWWUpeOr7MP6DIqdRPhUfaX4GRC"` | | -| portal.backend.processesworker.issuerComponent.encryptionConfigs.index0.encryptionKey | string | `"39ffab76f99ece1e4ac72f973d5c703737324a75c6445e84fa317a7833476a15"` | | | portal.backend.processesworker.bpnDidResolver.apiKey | string | `""` | ApiKey for management endpoint of the bpnDidResolver. Secret-key 'bpndidresolver-api-key'. | | portal.backend.processesworker.onboardingServiceProvider.encryptionConfigs.index0.cipherMode | string | `"CBC"` | | | portal.backend.processesworker.onboardingServiceProvider.encryptionConfigs.index0.paddingMode | string | `"PKCS7"` | | @@ -539,6 +546,7 @@ See [cert-manager self-signed](https://cert-manager.io/docs/configuration/selfsi | portal.backend.processesworker.onboardingServiceProvider.encryptionConfigs.index1.encryptionKey | string | `"8027152fe7a869c88acc86981760acd70ff1d660c2bd129eece94edef933caf7"` | | | portal.backend.processesworker.invitation.encryptionConfigs.index0.encryptionKey | string | `"d84fea29d6eac0fa51e36682b164e7d61693cd4202ed04306d2d9c5d46655e2c"` | | | portal.backend.processesworker.mailing.encryptionConfigs.index0.encryptionKey | string | `"d2e27d71b018cb36029184852f1baa3e26891be94718f77de4c7cc6c882fe317"` | | +| portal.backend.processesworker.clearinghouseConnectDisabled | bool | `false` | | | portal.backend.mailing.host | string | `"smtp.tx.test"` | | | portal.backend.mailing.port | string | `"587"` | | | portal.backend.mailing.user | string | `"smtp-user"` | | @@ -554,7 +562,7 @@ See [cert-manager self-signed](https://cert-manager.io/docs/configuration/selfsi | portal.backend.provisioning.sharedRealm.smtpServer.password | string | `""` | | | portal.backend.provisioning.sharedRealm.smtpServer.from | string | `"smtp@tx.test"` | | | portal.backend.provisioning.sharedRealm.smtpServer.replyTo | string | `"smtp@tx.test"` | | -| portal.backend.ingress | object | `{"annotations":{"nginx.ingress.kubernetes.io/cors-allow-origin":"http://localhost:3000, http://*.tx.test","nginx.ingress.kubernetes.io/enable-cors":"true","nginx.ingress.kubernetes.io/proxy-body-size":"8m","nginx.ingress.kubernetes.io/use-regex":"true"},"enabled":true,"hosts":[{"host":"portal-backend.tx.test","paths":[{"backend":{"port":8080,"service":"registration-service"},"path":"/api/registration","pathType":"Prefix"},{"backend":{"port":8080,"service":"administration-service"},"path":"/api/administration","pathType":"Prefix"},{"backend":{"port":8080,"service":"notification-service"},"path":"/api/notification","pathType":"Prefix"},{"backend":{"port":8080,"service":"provisioning-service"},"path":"/api/provisioning","pathType":"Prefix"},{"backend":{"port":8080,"service":"marketplace-app-service"},"path":"/api/apps","pathType":"Prefix"},{"backend":{"port":8080,"service":"services-service"},"path":"/api/services","pathType":"Prefix"}]}],"name":"portal-backend"}` | docs: http://portal-backend.tx.test/api/administration/swagger/index.html http://portal-backend.tx.test/api/registration/swagger/index.html http://portal-backend.tx.test/api/apps/swagger/index.html http://portal-backend.tx.test/api/services/swagger/index.html http://portal-backend.tx.test/api/notification/swagger/index.html | +| portal.backend.ingress | object | `{"annotations":{"nginx.ingress.kubernetes.io/cors-allow-origin":"http://localhost:3000, http://*.tx.test","nginx.ingress.kubernetes.io/enable-cors":"true","nginx.ingress.kubernetes.io/proxy-body-size":"8m","nginx.ingress.kubernetes.io/use-regex":"true"},"className":"nginx","enabled":true,"hosts":[{"host":"portal-backend.tx.test","paths":[{"backend":{"port":8080,"service":"registration-service"},"path":"/api/registration","pathType":"Prefix"},{"backend":{"port":8080,"service":"administration-service"},"path":"/api/administration","pathType":"Prefix"},{"backend":{"port":8080,"service":"notification-service"},"path":"/api/notification","pathType":"Prefix"},{"backend":{"port":8080,"service":"provisioning-service"},"path":"/api/provisioning","pathType":"Prefix"},{"backend":{"port":8080,"service":"marketplace-app-service"},"path":"/api/apps","pathType":"Prefix"},{"backend":{"port":8080,"service":"services-service"},"path":"/api/services","pathType":"Prefix"}]}],"name":"portal-backend"}` | docs: http://portal-backend.tx.test/api/administration/swagger/index.html http://portal-backend.tx.test/api/registration/swagger/index.html http://portal-backend.tx.test/api/apps/swagger/index.html http://portal-backend.tx.test/api/services/swagger/index.html http://portal-backend.tx.test/api/notification/swagger/index.html | | portal.postgresql.nameOverride | string | `"portal-backend-postgresql"` | | | portal.postgresql.architecture | string | `"standalone"` | | | portal.postgresql.auth.password | string | `"dbpasswordportal"` | | diff --git a/charts/localdev/README.md.gotmpl b/charts/localdev/README.md.gotmpl index 67bf3bb03..3ee033553 100644 --- a/charts/localdev/README.md.gotmpl +++ b/charts/localdev/README.md.gotmpl @@ -154,7 +154,14 @@ Then change to the chart directory: ```bash cd charts/localdev/ ``` -Download the chart dependencies: + +Download the postgres dependency of the Portal helm chart: + +```bash +helm dependency update ../portal +``` + +Download the chart dependencies of the LocalDev umbrella helm chart: ```bash helm dependency update