Skip to content

Commit

Permalink
release: update docs for v1.5.0-RC1
Browse files Browse the repository at this point in the history
  • Loading branch information
evegufy committed Jun 3, 2023
1 parent 5ed5e3e commit 9458f74
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 43 deletions.
52 changes: 31 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Helm chart for Catena-X Portal

![Version: 1.4.0](https://img.shields.io/badge/Version-1.4.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.4.0](https://img.shields.io/badge/AppVersion-1.4.0-informational?style=flat-square) ![Tag](https://img.shields.io/static/v1?label=&message=LeadingRepository&color=green&style=flat)
![Version: 1.5.0-RC1](https://img.shields.io/badge/Version-1.5.0--RC1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.5.0-RC1](https://img.shields.io/badge/AppVersion-1.5.0--RC1-informational?style=flat-square) ![Tag](https://img.shields.io/static/v1?label=&message=LeadingRepository&color=green&style=flat)

This helm chart installs the Catena-X Portal application which consists of

* [portal-frontend (v1.4.0)](https://github.com/eclipse-tractusx/portal-frontend/tree/v1.4.0),
* [portal-frontend-registration (v1.3.1)](https://github.com/eclipse-tractusx/portal-frontend-registration/tree/v1.3.1),
* [portal-assets (v1.4.0)](https://github.com/eclipse-tractusx/portal-assets/tree/v1.4.0) and
* [portal-backend (v1.4.0)](https://github.com/eclipse-tractusx/portal-backend/tree/v1.4.0).
* [portal-frontend (v1.5.0-RC1)](https://github.com/eclipse-tractusx/portal-frontend/tree/v1.5.0-RC1),
* [portal-frontend-registration (v1.4.0-RC1)](https://github.com/eclipse-tractusx/portal-frontend-registration/tree/v1.4.0-RC1),
* [portal-assets (v1.5.0-RC1)](https://github.com/eclipse-tractusx/portal-assets/tree/v1.5.0-RC1) and
* [portal-backend (v1.5.0-RC1)](https://github.com/eclipse-tractusx/portal-backend/tree/v1.5.0-RC1).

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 1.1.0 version of the IAM instances:
* [Central Keycloak Instance](https://github.com/eclipse-tractusx/portal-iam/blob/centralidp-1.1.0/charts/centralidp/README.md)
* [Shared Keycloak Instance](https://github.com/eclipse-tractusx/portal-iam/blob/sharedidp-1.1.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.4.0/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.5.0-RC1/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.4.0/developer/Technical%20Documentation).
For further information please refer to [Technical Documentation](https://github.com/eclipse-tractusx/portal-assets/tree/v1.5.0-RC1/developer/Technical%20Documentation).

The referenced container images are for demonstration purposes only.

Expand All @@ -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.4.0
version: 1.5.0-RC1
```
## Requirements
Expand Down Expand Up @@ -78,13 +78,13 @@ 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.4.0"` | |
| frontend.portal.image.portaltag | string | `"v1.5.0-RC1"` | |
| frontend.registration.name | string | `"registration"` | |
| frontend.registration.image.name | string | `"tractusx/portal-frontend-registration"` | |
| frontend.registration.image.registrationtag | string | `"v1.3.1"` | |
| frontend.registration.image.registrationtag | string | `"v1.4.0-RC1"` | |
| frontend.assets.name | string | `"assets"` | |
| frontend.assets.image.name | string | `"tractusx/portal-assets"` | |
| frontend.assets.image.assetstag | string | `"v1.4.0"` | |
| frontend.assets.image.assetstag | string | `"v1.5.0-RC1"` | |
| frontend.assets.path | string | `"/assets"` | |
| frontend.centralidpAuthPath | string | `"/auth"` | |
| frontend.bpdmPartnersPoolApiPath | string | `"/api"` | |
Expand Down Expand Up @@ -127,13 +127,13 @@ dependencies:
| backend.mailing.port | string | `"587"` | Provide port. |
| backend.mailing.user | string | `"smtp-user"` | Provide user. |
| backend.mailing.password | string | `""` | Password for the smtp username. Secret-key 'password'. |
| backend.interfaces.secret | string | `"secret-backend-interfaces"` | Secret containing the client-secrets for the connection to daps, custodian, bpdm, sdFactory and clearinghouse. |
| backend.interfaces.secret | string | `"secret-backend-interfaces"` | Secret containing the client-secrets for the connection to daps, custodian, bpdm, sdFactory, clearinghouse and offer provider. |
| backend.healthChecks.startup.path | string | `"/health/startup"` | |
| backend.healthChecks.liveness.path | string | `"/healthz"` | |
| 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.4.0"` | |
| backend.registration.image.registrationservicetag | string | `"v1.5.0-RC1"` | |
| backend.registration.logging.registrationServiceBpn | string | `"Information"` | |
| backend.registration.healthChecks | object | `{"startup":{"tags":[]}}` | Healthchecks to be enabled for startupProbe, enable by removing the brackets after 'tags:' and uncommenting the following lines. |
| backend.registration.portalRegistrationPath | string | `"/registration"` | |
Expand All @@ -147,7 +147,7 @@ dependencies:
| backend.registration.registrationDocumentTypeIds.type0 | string | `"CX_FRAME_CONTRACT"` | |
| backend.administration.name | string | `"administration-service"` | |
| backend.administration.image.name | string | `"tractusx/portal-administration-service"` | |
| backend.administration.image.administrationservicetag | string | `"v1.4.0"` | |
| backend.administration.image.administrationservicetag | string | `"v1.5.0-RC1"` | |
| backend.administration.logging.businessLogic | string | `"Information"` | |
| backend.administration.logging.sdfactoryLibrary | string | `"Information"` | |
| backend.administration.healthChecks | object | `{"startup":{"tags":[]}}` | Healthchecks to be enabled for startupProbe, enable by removing the brackets after 'tags:' and uncommenting the following lines. |
Expand Down Expand Up @@ -200,7 +200,7 @@ dependencies:
| backend.provisioning.sharedRealm.smtpServer.replyTo | string | `"[email protected]"` | 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.4.0"` | |
| backend.appmarketplace.image.appmarketplaceservicetag | string | `"v1.5.0-RC1"` | |
| backend.appmarketplace.logging.offersLibrary | string | `"Information"` | |
| backend.appmarketplace.healthChecks | object | `{"startup":{"tags":[]}}` | Healthchecks to be enabled for startupProbe, enable by removing the brackets after 'tags:' and uncommenting the following lines. |
| backend.appmarketplace.appOverviewPath | string | `"/appoverview"` | |
Expand Down Expand Up @@ -243,19 +243,19 @@ 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.4.0"` | |
| backend.portalmigrations.image.portalmigrationstag | string | `"v1.5.0-RC1"` | |
| backend.portalmigrations.seeding.testDataEnvironments | string | `""` | |
| backend.portalmaintenance.name | string | `"portal-maintenance"` | |
| backend.portalmaintenance.image.name | string | `"tractusx/portal-maintenance-service"` | |
| backend.portalmaintenance.image.portalmaintenancetag | string | `"v1.4.0"` | |
| backend.portalmaintenance.image.portalmaintenancetag | string | `"v1.5.0-RC1"` | |
| backend.notification.name | string | `"notification-service"` | |
| backend.notification.image.name | string | `"tractusx/portal-notification-service"` | |
| backend.notification.image.notificationservicetag | string | `"v1.4.0"` | |
| backend.notification.image.notificationservicetag | string | `"v1.5.0-RC1"` | |
| backend.notification.healthChecks | object | `{"startup":{"tags":[]}}` | Healthchecks to be enabled for startupProbe, enable by removing the brackets after 'tags:' and uncommenting the following lines. |
| backend.notification.swaggerEnabled | bool | `false` | |
| backend.services.name | string | `"services-service"` | |
| backend.services.image.name | string | `"tractusx/portal-services-service"` | |
| backend.services.image.servicesservicetag | string | `"v1.4.0"` | |
| backend.services.image.servicesservicetag | string | `"v1.5.0-RC1"` | |
| backend.services.logging.offersLibrary | string | `"Information"` | |
| backend.services.healthChecks | object | `{"startup":{"tags":[]}}` | Healthchecks to be enabled for startupProbe, enable by removing the brackets after 'tags:' and uncommenting the following lines. |
| backend.services.serviceMarketplacePath | string | `"/servicemarketplace"` | |
Expand Down Expand Up @@ -284,10 +284,10 @@ 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.4.0"` | |
| backend.provisioningmigrations.image.provisioningmigrationstag | string | `"v1.5.0-RC1"` | |
| backend.processesworker.name | string | `"processes-worker"` | |
| backend.processesworker.image.name | string | `"tractusx/portal-processes-worker"` | |
| backend.processesworker.image.processesworkertag | string | `"v1.4.0"` | |
| backend.processesworker.image.processesworkertag | string | `"v1.5.0-RC1"` | |
| backend.processesworker.logging.processesLibrary | string | `"Information"` | |
| backend.processesworker.logging.bpdmLibrary | string | `"Information"` | |
| backend.processesworker.logging.clearinghouseLibrary | string | `"Information"` | |
Expand Down Expand Up @@ -322,6 +322,14 @@ dependencies:
| backend.processesworker.clearinghouse.clientSecret | string | `""` | Client-secret for clearinghouse client-id. Secret-key 'clearinghouse-client-secret'. |
| backend.processesworker.clearinghouse.callbackPath | string | `"/api/administration/registration/clearinghouse"` | |
| backend.processesworker.processes.lockExpirySeconds | string | `"300"` | |
| backend.processesworker.offerSubscriptionProcess.serviceAccountRoles.role0 | string | `"Digital Twin Management"` | |
| backend.processesworker.offerSubscriptionProcess.serviceManagerRoles.role0 | string | `"App Manager"` | |
| backend.processesworker.offerSubscriptionProcess.itAdminRoles.role0 | string | `"IT Admin"` | |
| backend.processesworker.offerprovider.serviceManagerRoles.role0 | string | `"App Manager"` | |
| backend.processesworker.offerprovider.scope | string | `"openid"` | |
| backend.processesworker.offerprovider.grantType | string | `"client_credentials"` | |
| backend.processesworker.offerprovider.clientId | string | `"offerprovider-client-id"` | Provide offerprovider client-id from CX IAM centralidp. |
| backend.processesworker.offerprovider.clientSecret | string | `""` | Client-secret for offer provider client-id. Secret-key 'offerprovider-client-secret'. |
| backend.placeholder | string | `"empty"` | |
| postgresql.enabled | bool | `true` | PostgreSQL chart configuration Switch to enable or disable the PostgreSQL helm chart |
| postgresql.fullnameOverride | string | `"portal-backend-postgresql"` | FullnameOverride to 'portal-backend-postgresql'. |
Expand All @@ -337,13 +345,15 @@ dependencies:
| postgresql.architecture | string | `"replication"` | |
| postgresql.audit.pgAuditLog | string | `"write, ddl"` | |
| postgresql.audit.logLinePrefix | string | `"%m %u %d "` | |
| postgresql.primary.extendedConfiguration | string | `""` | Extended PostgreSQL Primary configuration (increase of max_connections recommended - default is 100) |
| postgresql.primary.initdb.scriptsConfigMap | string | `"configmap-postgres-init"` | |
| postgresql.primary.extraEnvVars[0].name | string | `"PORTAL_PASSWORD"` | |
| postgresql.primary.extraEnvVars[0].valueFrom.secretKeyRef.name | string | `"{{ .Values.auth.existingSecret }}"` | |
| postgresql.primary.extraEnvVars[0].valueFrom.secretKeyRef.key | string | `"portal-password"` | |
| postgresql.primary.extraEnvVars[1].name | string | `"PROVISIONING_PASSWORD"` | |
| postgresql.primary.extraEnvVars[1].valueFrom.secretKeyRef.name | string | `"{{ .Values.auth.existingSecret }}"` | |
| postgresql.primary.extraEnvVars[1].valueFrom.secretKeyRef.key | string | `"provisioning-password"` | |
| postgresql.readReplicas.extendedConfiguration | string | `""` | Extended PostgreSQL read only replicas configuration (increase of max_connections recommended - default is 100) |
| externalDatabase.host | string | `"portal-backend-postgresql-external-db"` | External PostgreSQL configuration IMPORTANT: init scripts (01-init-db-user.sh and 02-init-db.sql) available in templates/configmap-backend-postgres-init.yaml need to be executed beforehand. Database host |
| externalDatabase.database | string | `"postgres"` | Database name |
| externalDatabase.port | int | `5432` | Database port number |
Expand Down
Loading

0 comments on commit 9458f74

Please sign in to comment.