From 37fb531093658f182671eefb1fd5457ea03c65f9 Mon Sep 17 00:00:00 2001 From: Nico Koprowski Date: Wed, 22 May 2024 16:58:28 +0200 Subject: [PATCH] docs(charts): add default value descriptions to the README --- charts/bpdm/CHANGELOG.md | 5 + charts/bpdm/Chart.yaml | 15 +- charts/bpdm/README.md | 164 +++++++------ .../bpdm-cleaning-service-dummy/CHANGELOG.md | 1 + .../bpdm-cleaning-service-dummy/Chart.yaml | 2 +- .../bpdm-cleaning-service-dummy/README.md | 194 +++++++-------- charts/bpdm/charts/bpdm-gate/CHANGELOG.md | 1 + charts/bpdm/charts/bpdm-gate/Chart.yaml | 2 +- charts/bpdm/charts/bpdm-gate/README.md | 208 ++++++++-------- .../charts/bpdm-orchestrator/CHANGELOG.md | 1 + .../bpdm/charts/bpdm-orchestrator/Chart.yaml | 2 +- .../bpdm/charts/bpdm-orchestrator/README.md | 189 +++++++------- charts/bpdm/charts/bpdm-pool/CHANGELOG.md | 1 + charts/bpdm/charts/bpdm-pool/Chart.yaml | 2 +- charts/bpdm/charts/bpdm-pool/README.md | 231 ++++++++---------- 15 files changed, 494 insertions(+), 524 deletions(-) diff --git a/charts/bpdm/CHANGELOG.md b/charts/bpdm/CHANGELOG.md index 6c0c0e7ea..b07554934 100644 --- a/charts/bpdm/CHANGELOG.md +++ b/charts/bpdm/CHANGELOG.md @@ -10,6 +10,11 @@ The format is based on Keep a Changelog (https://keepachangelog.com/en/1.0.0/), - Default pull policy from 'Always' to 'IfNotPresent' - Fixes BPDM applications not connecting with each other when authenticated +- update BPDM Pool Chart to version 7.0.1 +- update BPDM Gate Chart to version 6.0.1 +- update BPDM Orchestrator Chart to version 3.0.1 +- update BPDM Cleaning Service Dummy Chart to version 3.0.1 +- update BPDM Bridge Chart to version 3.0.1 ## [5.0.0] - 2024-05-15 diff --git a/charts/bpdm/Chart.yaml b/charts/bpdm/Chart.yaml index f2b915a79..a1dee2d99 100644 --- a/charts/bpdm/Chart.yaml +++ b/charts/bpdm/Chart.yaml @@ -22,7 +22,7 @@ apiVersion: v2 name: bpdm type: application description: A Helm chart for Kubernetes that deploys the BPDM applications -version: 5.0.1-alpha.1 +version: 5.0.1-alpha.2 appVersion: "6.0.0" home: https://github.com/eclipse-tractusx/bpdm sources: @@ -33,23 +33,28 @@ maintainers: dependencies: - name: bpdm-gate - version: 6.0.1-alpha.0 + version: 6.0.1-alpha.1 alias: bpdm-gate condition: bpdm-gate.enabled + repository: "file://./bpdm-gate" - name: bpdm-pool - version: 7.0.1-alpha.0 + version: 7.0.1-alpha.1 alias: bpdm-pool condition: bpdm-pool.enabled + repository: "file://./bpdm-pool" - name: bpdm-cleaning-service-dummy - version: 3.0.1-alpha.0 + version: 3.0.1-alpha.1 alias: bpdm-cleaning-service-dummy condition: bpdm-cleaning-service-dummy.enabled + repository: "file://./bpdm-cleaning-service-dummy" - name: bpdm-orchestrator - version: 3.0.1-alpha.0 + version: 3.0.1-alpha.1 alias: bpdm-orchestrator condition: bpdm-orchestrator.enabled + repository: "file://./bpdm-orchestrator" - name: bpdm-common version: 1.0.1 + repository: "file://./bpdm-common" - name: postgresql version: 12.12.10 repository: https://charts.bitnami.com/bitnami diff --git a/charts/bpdm/README.md b/charts/bpdm/README.md index 81b2e4e54..500701c72 100644 --- a/charts/bpdm/README.md +++ b/charts/bpdm/README.md @@ -1,72 +1,92 @@ -# BPDM Helm Chart - -This Helm Chart deploys the BPDM services to a Kubernetes environment. - -## Prerequisites - -* [Kubernetes Cluster](https://kubernetes.io/) -* [Helm](https://helm.sh/docs/) - -In an existing Kubernetes cluster the application can be deployed with the following command: - -```bash -helm install release_name ./charts/bpdm --namespace your_namespace -``` - -This will install a new release of the BPDM in the given namespace. -On default values this release deploys the latest image tagged as `main` from the repository's GitHub Container Registry. -The application is run on default profile without authorization. -Additionally, the Helm deployment contains a PostgreSQL database and Opensearch instance which the BPDM Pool connects to. - -On the default values deployment no further action is needed to make the BPDM deployment run. -However, per default, ingress as well as authentication for endpoints are disabled. - -By giving your own values file you can configure the Helm deployment of the BPDM freely: - -```bash -helm install release_name ./charts/bpdm --namespace your_namespace -f ./path/to/your/values.yaml -``` - -In the following sections you can have a look at the most important configuration options. - -## Image Tag - -Per default, the Helm deployment references a certain BPDM release version where the newest Helm release points to the newest version. -This is a stable tag pointing to a fixed release version of the BPDM. -For your deployment you might want to follow the latest application releases instead. - -In your values file you can overwrite the default tag: - -```yaml -image: - tag: "latest" -``` - -## Helm Dependencies - -On default, the Helm deployment also contains a PostgreSQL deployment. -You can configure these deployments in your value file as well. -For this, consider the documentation of the correspondent dependency [PostgreSQL](https://artifacthub.io/packages/helm/bitnami/postgresql/11.9.13). -In case you want to use an already deployed database instance you can also disable the respective dependency and overwrite the default host -address in the `applicationConfig`: - -```yaml -applicationConfig: - spring: - datasource: - url: jdbc:postgresql://remote.host.net:5432/bpdm -postgres: - enabled: false -``` - -## Notice - -This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). - -- SPDX-License-Identifier: Apache-2.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 Mercedes Benz Group -- SPDX-FileCopyrightText: 2023,2023 Schaeffler AG -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/bpdm \ No newline at end of file +# bpdm + +![Version: 5.0.1-alpha.1](https://img.shields.io/badge/Version-5.0.1--alpha.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 6.0.0](https://img.shields.io/badge/AppVersion-6.0.0-informational?style=flat-square) + +A Helm chart for Kubernetes that deploys the BPDM applications + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| Nico Koprowski | | | +| Fabio D. Mota | | | + +## Source Code + +* + +## Requirements + +| Repository | Name | Version | +|------------|------|---------| +| file://./bpdm-cleaning-service-dummy | bpdm-cleaning-service-dummy(bpdm-cleaning-service-dummy) | 3.0.1-alpha.0 | +| file://./bpdm-common | bpdm-common | 1.0.1 | +| file://./bpdm-gate | bpdm-gate(bpdm-gate) | 6.0.1-alpha.0 | +| file://./bpdm-orchestrator | bpdm-orchestrator(bpdm-orchestrator) | 3.0.1-alpha.0 | +| file://./bpdm-pool | bpdm-pool(bpdm-pool) | 7.0.1-alpha.0 | +| https://charts.bitnami.com/bitnami | keycloak(keycloak) | 19.3.0 | +| https://charts.bitnami.com/bitnami | postgres(postgresql) | 12.12.10 | + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| bpdm-cleaning-service-dummy.applicationConfig.bpdm.client.orchestrator.provider.issuer-uri | string | `"http://bpdm-keycloak/realms/CX-Central"` | | +| bpdm-cleaning-service-dummy.applicationSecrets.bpdm.client.orchestrator.registration.client-secret | string | `"dummy_orch_client_secret"` | | +| bpdm-cleaning-service-dummy.enabled | bool | `true` | | +| bpdm-gate.applicationConfig.bpdm.security.auth-server-url | string | `"http://bpdm-keycloak"` | | +| bpdm-gate.applicationSecrets.bpdm.client.orchestrator.registration.client-secret | string | `"gate_orch_client_secret"` | | +| bpdm-gate.applicationSecrets.bpdm.client.pool.registration.client-secret | string | `"gate_pool_client_secret"` | | +| bpdm-gate.enabled | bool | `true` | | +| bpdm-gate.postgres.enabled | bool | `false` | | +| bpdm-gate.postgres.fullnameOverride | string | `"bpdm-postgres"` | | +| bpdm-orchestrator.applicationConfig.bpdm.security.auth-server-url | string | `"http://bpdm-keycloak"` | | +| bpdm-orchestrator.enabled | bool | `true` | | +| bpdm-pool.applicationConfig.bpdm.security.auth-server-url | string | `"http://bpdm-keycloak"` | | +| bpdm-pool.applicationSecrets.bpdm.client.orchestrator.registration.client-secret | string | `"pool_orch_client_secret"` | | +| bpdm-pool.enabled | bool | `true` | | +| bpdm-pool.postgres.enabled | bool | `false` | | +| bpdm-pool.postgres.fullnameOverride | string | `"bpdm-postgres"` | | +| keycloak.auth.adminPassword | string | `"admin"` | | +| keycloak.auth.adminUser | string | `"admin"` | | +| keycloak.bpdm.realm.clientSecrets.cleaningDummyOrchestrator | string | `"dummy_orch_client_secret"` | | +| keycloak.bpdm.realm.clientSecrets.gateOrchestrator | string | `"gate_orch_client_secret"` | | +| keycloak.bpdm.realm.clientSecrets.gatePool | string | `"gate_pool_client_secret"` | | +| keycloak.bpdm.realm.clientSecrets.poolOrchestrator | string | `"pool_orch_client_secret"` | | +| keycloak.enabled | bool | `true` | | +| keycloak.externalDatabase.database | string | `"bpdm"` | | +| keycloak.externalDatabase.host | string | `"bpdm-postgres"` | | +| keycloak.externalDatabase.password | string | `"bpdm"` | | +| keycloak.externalDatabase.user | string | `"bpdm"` | | +| keycloak.extraEnvVars[0].name | string | `"KEYCLOAK_EXTRA_ARGS"` | | +| keycloak.extraEnvVars[0].value | string | `"--import-realm"` | | +| keycloak.extraVolumeMounts[0].mountPath | string | `"/opt/bitnami/keycloak/data/import"` | | +| keycloak.extraVolumeMounts[0].name | string | `"import"` | | +| keycloak.extraVolumeMounts[0].readOnly | bool | `true` | | +| keycloak.extraVolumes[0].name | string | `"import"` | | +| keycloak.extraVolumes[0].secret.items[0].key | string | `"Cx-Central.json"` | | +| keycloak.extraVolumes[0].secret.items[0].path | string | `"Cx-Central.json"` | | +| keycloak.extraVolumes[0].secret.secretName | string | `"bpdm-keycloak-realm"` | | +| keycloak.fullnameOverride | string | `"bpdm-keycloak"` | | +| keycloak.livenessProbe.initialDelaySeconds | int | `0` | | +| keycloak.postgresql.enabled | bool | `false` | | +| keycloak.production | bool | `false` | | +| keycloak.readinessProbe.initialDelaySeconds | int | `0` | | +| keycloak.resources.limits.cpu | string | `"500m"` | | +| keycloak.resources.limits.memory | string | `"512Mi"` | | +| keycloak.resources.requests.cpu | string | `"100m"` | | +| keycloak.resources.requests.memory | string | `"512Mi"` | | +| keycloak.startupProbe.enabled | bool | `true` | | +| keycloak.startupProbe.failureThreshold | int | `40` | | +| keycloak.startupProbe.initialDelaySeconds | int | `60` | | +| keycloak.startupProbe.periodSeconds | int | `30` | | +| postgres.auth.database | string | `"bpdm"` | | +| postgres.auth.password | string | `"bpdm"` | | +| postgres.auth.username | string | `"bpdm"` | | +| postgres.enabled | bool | `true` | | +| postgres.fullnameOverride | string | `"bpdm-postgres"` | | + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1) diff --git a/charts/bpdm/charts/bpdm-cleaning-service-dummy/CHANGELOG.md b/charts/bpdm/charts/bpdm-cleaning-service-dummy/CHANGELOG.md index d3fa23cec..b4445f40a 100644 --- a/charts/bpdm/charts/bpdm-cleaning-service-dummy/CHANGELOG.md +++ b/charts/bpdm/charts/bpdm-cleaning-service-dummy/CHANGELOG.md @@ -9,6 +9,7 @@ The format is based on Keep a Changelog (https://keepachangelog.com/en/1.0.0/), ### Changed - Default pull policy from 'Always' to 'IfNotPresent' +- Added documentation for default values in the README ## [3.0.0] - 2024-05-15 diff --git a/charts/bpdm/charts/bpdm-cleaning-service-dummy/Chart.yaml b/charts/bpdm/charts/bpdm-cleaning-service-dummy/Chart.yaml index cf6280909..9cbcd3cd2 100644 --- a/charts/bpdm/charts/bpdm-cleaning-service-dummy/Chart.yaml +++ b/charts/bpdm/charts/bpdm-cleaning-service-dummy/Chart.yaml @@ -22,7 +22,7 @@ apiVersion: v2 type: application name: bpdm-cleaning-service-dummy appVersion: "6.0.0" -version: 3.0.1-alpha.0 +version: 3.0.1-alpha.1 description: A Helm chart for deploying the BPDM cleaning service home: https://eclipse-tractusx.github.io/docs/kits/Business%20Partner%20Kit/Adoption%20View sources: diff --git a/charts/bpdm/charts/bpdm-cleaning-service-dummy/README.md b/charts/bpdm/charts/bpdm-cleaning-service-dummy/README.md index 67e1e2197..23a94b4ef 100644 --- a/charts/bpdm/charts/bpdm-cleaning-service-dummy/README.md +++ b/charts/bpdm/charts/bpdm-cleaning-service-dummy/README.md @@ -1,105 +1,89 @@ -# BPDM Cleaning Service Dummy Helm Chart - -This Helm Chart deploys the BPDM service to a Kubernetes environment. - -## Prerequisites - -* [Kubernetes Cluster](https://kubernetes.io) -* [Helm](https://helm.sh/docs/) - -In an existing Kubernetes cluster the application can be deployed with the following command: - -```bash -helm install release_name ./charts/bpdm-cleanning-service-dummy --namespace your_namespace -f /path/to/my_release-values.yaml -``` - -This will install a new release of the BPDM Cleaning Service in the given namespace. -On default values this release deploys the latest image tagged as `main` from the repository's GitHub Container Registry. - -By giving your own values file you can configure the Helm deployment of the BPDM Cleaning Service freely. -In the following sections you can have a look at the most important configuration options. - -## Image Tag - -Per default, the Helm deployment references the latest BPDM Cleaning Service release tagged as `main`. -This tag follows the latest version of the Cleaning Service and contains the newest features and bug fixes. -You might want to switch to a more stable release tag instead for your deployment. -In your values file you can overwrite the default tag: - -```yaml -image: - tag: "latest" -``` - -## Profiles - -You can also activate Spring profiles in which the BPDM Cleaning Service should be run. -In case you want to run the Cleaning Service with authorization enabled you can write the following: - -```yaml -springProfiles: - - auth -``` - -## Ingress - -You can specify your own ingress configuration for the Helm deployment to make the BPDM Cleaning Service available over Ingress. -Note that you need to have the appropriate Ingress controller installed in your cluster first. -For example, consider a Kubernetes cluster with an [Ingress-Nginx](https://kubernetes.github.io/ingress-nginx/) installed. -An Ingress configuration for the Cleaning Service deployment could somehow look like this: - -```yaml -ingress: - enabled: true - annotations: - kubernetes.io/ingress.class: nginx - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: business-partners.your-domain.net - paths: - - path: /cleaning-service - pathType: Prefix -``` - -## Cleaning Service Configuration - -For the default deployment you already need to overwrite the configuration properties of the application. -The Helm deployment comes with the ability to configure the BPDM Cleaning Service application directly over the values file. -This way you are able to overwrite any configuration property of the `application.properties` and `application-auth.properties` files. -Consider that you would need to turn on `auth` profile first before overwriting any property in the corresponding properties file could take -effect. - - -Entries in the "applicationConfig" value are written directly to a configMap that is part of the Helm deployment. -This can be a problem if you want to overwrite configuration properties with secrets. -Therefore, you can specify secret configuration values in a different Helm value `applicationSecrets`. -Content of this value is written in a Kubernetes secret instead. -If you want to specify a keycloak client secret for example: - -```yaml -applicationSecrets: - bpdm: - security: - credentials: - secret: your_client_secret -``` - -## Notice - -This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). - -- SPDX-License-Identifier: Apache-2.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 Mercedes Benz Group -- SPDX-FileCopyrightText: 2023,2023 Schaeffler AG -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/bpdm \ No newline at end of file +# bpdm-cleaning-service-dummy + +![Version: 3.0.1-alpha.0](https://img.shields.io/badge/Version-3.0.1--alpha.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 6.0.0](https://img.shields.io/badge/AppVersion-6.0.0-informational?style=flat-square) + +A Helm chart for deploying the BPDM cleaning service + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| Nico Koprowski | | | +| Fabio D. Mota | | | + +## Source Code + +* + +## Requirements + +| Repository | Name | Version | +|------------|------|---------| +| file://../bpdm-common | bpdm-common | 1.0.1 | + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.labelSelector.matchExpressions[0].key | string | `"app.kubernetes.io/name"` | | +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.labelSelector.matchExpressions[0].operator | string | `"DoesNotExist"` | | +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.topologyKey | string | `"kubernetes.io/hostname"` | | +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].weight | int | `100` | | +| applicationConfig.bpdm.client.orchestrator.base-url | string | `nil` | | +| applicationSecrets | string | `nil` | | +| autoscaling.enabled | bool | `false` | | +| fullnameOverride | string | `nil` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.registry | string | `"docker.io"` | | +| image.repository | string | `"tractusx/bpdm-cleaning-service-dummy"` | | +| image.tag | string | `""` | | +| imagePullSecrets | list | `[]` | | +| livenessProbe.failureThreshold | int | `3` | | +| livenessProbe.httpGet.path | string | `"/actuator/health/liveness"` | | +| livenessProbe.httpGet.port | int | `8084` | | +| livenessProbe.httpGet.scheme | string | `"HTTP"` | | +| livenessProbe.initialDelaySeconds | int | `5` | | +| livenessProbe.periodSeconds | int | `5` | | +| livenessProbe.successThreshold | int | `1` | | +| livenessProbe.timeoutSeconds | int | `1` | | +| nameOverride | string | `nil` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| readinessProbe.failureThreshold | int | `3` | | +| readinessProbe.httpGet.path | string | `"/actuator/health/readiness"` | | +| readinessProbe.httpGet.port | int | `8084` | | +| readinessProbe.httpGet.scheme | string | `"HTTP"` | | +| readinessProbe.initialDelaySeconds | int | `5` | | +| readinessProbe.periodSeconds | int | `5` | | +| readinessProbe.successThreshold | int | `1` | | +| readinessProbe.timeoutSeconds | int | `1` | | +| replicaCount | int | `1` | | +| resources.limits.cpu | string | `"500m"` | | +| resources.limits.memory | string | `"1Gi"` | | +| resources.requests.cpu | string | `"100m"` | | +| resources.requests.memory | string | `"1Gi"` | | +| securityContext.allowPrivilegeEscalation | bool | `false` | | +| securityContext.capabilities.drop[0] | string | `"ALL"` | | +| securityContext.readOnlyRootFilesystem | bool | `true` | | +| securityContext.runAsGroup | int | `10001` | | +| securityContext.runAsNonRoot | bool | `true` | | +| securityContext.runAsUser | int | `10001` | | +| securityContext.seccompProfile.type | string | `"RuntimeDefault"` | | +| service.port | int | `80` | | +| service.targetPort | int | `8084` | | +| service.type | string | `"ClusterIP"` | | +| springProfiles | list | `[]` | | +| startupProbe.failureThreshold | int | `40` | | +| startupProbe.httpGet.path | string | `"/actuator/health/readiness"` | | +| startupProbe.httpGet.port | int | `8084` | | +| startupProbe.httpGet.scheme | string | `"HTTP"` | | +| startupProbe.initialDelaySeconds | int | `60` | | +| startupProbe.periodSeconds | int | `30` | | +| startupProbe.successThreshold | int | `1` | | +| startupProbe.timeoutSeconds | int | `1` | | +| tolerations | list | `[]` | | + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1) diff --git a/charts/bpdm/charts/bpdm-gate/CHANGELOG.md b/charts/bpdm/charts/bpdm-gate/CHANGELOG.md index e5f3bff21..27d692b11 100644 --- a/charts/bpdm/charts/bpdm-gate/CHANGELOG.md +++ b/charts/bpdm/charts/bpdm-gate/CHANGELOG.md @@ -9,6 +9,7 @@ The format is based on Keep a Changelog (https://keepachangelog.com/en/1.0.0/), ### Changed - Default pull policy from 'Always' to 'IfNotPresent' +- Added documentation for default values in the README ## [6.0.0] - 2024-05-15 diff --git a/charts/bpdm/charts/bpdm-gate/Chart.yaml b/charts/bpdm/charts/bpdm-gate/Chart.yaml index c68380c95..44def5255 100644 --- a/charts/bpdm/charts/bpdm-gate/Chart.yaml +++ b/charts/bpdm/charts/bpdm-gate/Chart.yaml @@ -22,7 +22,7 @@ apiVersion: v2 type: application name: bpdm-gate appVersion: "6.0.0" -version: 6.0.1-alpha.0 +version: 6.0.1-alpha.1 description: A Helm chart for deploying the BPDM gate service home: https://eclipse-tractusx.github.io/docs/kits/Business%20Partner%20Kit/Adoption%20View sources: diff --git a/charts/bpdm/charts/bpdm-gate/README.md b/charts/bpdm/charts/bpdm-gate/README.md index 2f151b235..ba6abe796 100644 --- a/charts/bpdm/charts/bpdm-gate/README.md +++ b/charts/bpdm/charts/bpdm-gate/README.md @@ -1,109 +1,99 @@ -# BPDM Gate Helm Chart - -This Helm Chart deploys the BPDM Gate service to a Kubernetes environment. - -## Prerequisites - -* [Kubernetes Cluster](https://kubernetes.io) -* [Helm](https://helm.sh/docs/) -* Running BPDM Pool instance - -In an existing Kubernetes cluster the application can be deployed with the following command: - -```bash -helm install release_name ./charts/bpdm-gate --namespace your_namespace -f /path/to/my_release-values.yaml -``` - -This will install a new release of the BPDM Gate in the given namespace. -On default values this release deploys the latest image tagged as `main` from the repository's GitHub Container Registry. -The application is run on default profile (without authorization for its own endpoints or BPDM Pool endpoints). -This deployment requires a BPDM Pool deployment to be reachable under host name `bpdm-pool` on port `8080`. - -By giving your own values file you can configure the Helm deployment of the BPDM Gate freely. -In the following sections you can have a look at the most important configuration options. - -## Image Tag - -Per default, the Helm deployment references the latest BPDM gate release tagged as `main`. -This tag follows the latest version of the Gate and contains the newest features and bug fixes. -You might want to switch to a more stable release tag instead for your deployment. -In your values file you can overwrite the default tag: - -```yaml -image: - tag: "latest" -``` - -## Profiles - -You can also activate Spring profiles in which the BPDM Gate should be run. -In case you want to run the Gate with authorization and oAuth Pool client enabled you can write the following: - -```yaml -springProfiles: - - auth - - pool-auth -``` - -## Ingress - -You can specify your own ingress configuration for the Helm deployment to make the BPDM Gate available over Ingress. -Note that you need to have the appropriate Ingress controller installed in your cluster first. -For example, consider a Kubernetes cluster with an [Ingress-Nginx](https://kubernetes.github.io/ingress-nginx/) installed. -An Ingress configuration for the Gate deployment could look like this: - -```yaml -ingress: - enabled: true - annotations: - kubernetes.io/ingress.class: nginx - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: business-partners.your-domain.net - paths: - - path: /companies/test-company - pathType: Prefix -``` - -## Gate Configuration - -For the default deployment you already need to overwrite the configuration properties of the application. -The Helm deployment comes with the ability to configure the BPDM Gate application directly over the values file. -This way you are able to overwrite any configuration property of the `application.properties`, `application-auth.properties` -and `application-pool-auth.properties` files. -Consider that you would need to turn on `auth` and `pool-auth` profile first before overwriting any property in the corresponding properties file could take -effect. -Overwriting configuration properties can be useful for connecting to a remotely hosted BPDM Pool instance: - -```yaml -applicationConfig: - bpdm: - pool: - base-url: http://remote.domain.net/api/catena -``` - -Entries in the "applicationConfig" value are written directly to a configMap that is part of the Helm deployment. -This can be a problem if you want to overwrite configuration properties with secrets. -Therefore, you can specify secret configuration values in a different Helm value `applicationSecrets`. -Content of this value is written in a Kubernetes secret instead. -If you want to specify a keycloak client secret for example: - -```yaml -applicationSecrets: - bpdm: - security: - credentials: - secret: your_client_secret -``` - -## Notice - -This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). - -- SPDX-License-Identifier: Apache-2.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 Mercedes Benz Group -- SPDX-FileCopyrightText: 2023,2023 Schaeffler AG -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/bpdm +# bpdm-gate + +![Version: 6.0.1-alpha.0](https://img.shields.io/badge/Version-6.0.1--alpha.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 6.0.0](https://img.shields.io/badge/AppVersion-6.0.0-informational?style=flat-square) + +A Helm chart for deploying the BPDM gate service + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| Nico Koprowski | | | +| Fabio D. Mota | | | + +## Source Code + +* + +## Requirements + +| Repository | Name | Version | +|------------|------|---------| +| file://../bpdm-common | bpdm-common | 1.0.1 | +| https://charts.bitnami.com/bitnami | postgres(postgresql) | 12.12.10 | + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.labelSelector.matchExpressions[0].key | string | `"app.kubernetes.io/name"` | | +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.labelSelector.matchExpressions[0].operator | string | `"DoesNotExist"` | | +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.topologyKey | string | `"kubernetes.io/hostname"` | | +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].weight | int | `100` | | +| applicationConfig.bpdm.client.orchestrator.base-url | string | `nil` | | +| applicationConfig.bpdm.client.pool.base-url | string | `nil` | | +| applicationConfig.bpdm.datasource.host | string | `nil` | | +| applicationSecrets.spring.datasource.password | string | `"bpdm"` | | +| autoscaling.enabled | bool | `false` | | +| fullnameOverride | string | `nil` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.registry | string | `"docker.io"` | | +| image.repository | string | `"tractusx/bpdm-gate"` | | +| image.tag | string | `""` | | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts | list | `[]` | | +| ingress.tls | list | `[]` | | +| livenessProbe.failureThreshold | int | `3` | | +| livenessProbe.httpGet.path | string | `"/actuator/health/liveness"` | | +| livenessProbe.httpGet.port | int | `8081` | | +| livenessProbe.httpGet.scheme | string | `"HTTP"` | | +| livenessProbe.initialDelaySeconds | int | `5` | | +| livenessProbe.periodSeconds | int | `5` | | +| livenessProbe.successThreshold | int | `1` | | +| livenessProbe.timeoutSeconds | int | `1` | | +| nameOverride | string | `nil` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| postgres.auth.database | string | `"bpdm"` | | +| postgres.auth.password | string | `"bpdm"` | | +| postgres.auth.username | string | `"bpdm"` | | +| postgres.enabled | bool | `true` | | +| readinessProbe.failureThreshold | int | `3` | | +| readinessProbe.httpGet.path | string | `"/actuator/health/readiness"` | | +| readinessProbe.httpGet.port | int | `8081` | | +| readinessProbe.httpGet.scheme | string | `"HTTP"` | | +| readinessProbe.initialDelaySeconds | int | `5` | | +| readinessProbe.periodSeconds | int | `5` | | +| readinessProbe.successThreshold | int | `1` | | +| readinessProbe.timeoutSeconds | int | `1` | | +| replicaCount | int | `1` | | +| resources.limits.cpu | string | `"1000m"` | | +| resources.limits.memory | string | `"1Gi"` | | +| resources.requests.cpu | string | `"200m"` | | +| resources.requests.memory | string | `"1Gi"` | | +| securityContext.allowPrivilegeEscalation | bool | `false` | | +| securityContext.capabilities.drop[0] | string | `"ALL"` | | +| securityContext.readOnlyRootFilesystem | bool | `true` | | +| securityContext.runAsGroup | int | `10001` | | +| securityContext.runAsNonRoot | bool | `true` | | +| securityContext.runAsUser | int | `10001` | | +| service.port | int | `80` | | +| service.targetPort | int | `8081` | | +| service.type | string | `"ClusterIP"` | | +| springProfiles | list | `[]` | | +| startupProbe.failureThreshold | int | `40` | | +| startupProbe.httpGet.path | string | `"/actuator/health/readiness"` | | +| startupProbe.httpGet.port | int | `8081` | | +| startupProbe.httpGet.scheme | string | `"HTTP"` | | +| startupProbe.initialDelaySeconds | int | `60` | | +| startupProbe.periodSeconds | int | `30` | | +| startupProbe.successThreshold | int | `1` | | +| startupProbe.timeoutSeconds | int | `1` | | +| tolerations | list | `[]` | | + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1) diff --git a/charts/bpdm/charts/bpdm-orchestrator/CHANGELOG.md b/charts/bpdm/charts/bpdm-orchestrator/CHANGELOG.md index 20538560b..76900e7c6 100644 --- a/charts/bpdm/charts/bpdm-orchestrator/CHANGELOG.md +++ b/charts/bpdm/charts/bpdm-orchestrator/CHANGELOG.md @@ -9,6 +9,7 @@ The format is based on Keep a Changelog (https://keepachangelog.com/en/1.0.0/), ### Changed - Default pull policy from 'Always' to 'IfNotPresent' +- Added documentation for default values in the README ## [3.0.0] - 2024-05-15 diff --git a/charts/bpdm/charts/bpdm-orchestrator/Chart.yaml b/charts/bpdm/charts/bpdm-orchestrator/Chart.yaml index 89dd72a23..b117a406d 100644 --- a/charts/bpdm/charts/bpdm-orchestrator/Chart.yaml +++ b/charts/bpdm/charts/bpdm-orchestrator/Chart.yaml @@ -22,7 +22,7 @@ apiVersion: v2 type: application name: bpdm-orchestrator appVersion: "6.0.0" -version: 3.0.1-alpha.0 +version: 3.0.1-alpha.1 description: A Helm chart for deploying the BPDM Orchestrator service home: https://eclipse-tractusx.github.io/docs/kits/Business%20Partner%20Kit/Adoption%20View sources: diff --git a/charts/bpdm/charts/bpdm-orchestrator/README.md b/charts/bpdm/charts/bpdm-orchestrator/README.md index a67c2ae08..49903fbff 100644 --- a/charts/bpdm/charts/bpdm-orchestrator/README.md +++ b/charts/bpdm/charts/bpdm-orchestrator/README.md @@ -1,96 +1,93 @@ -# BPDM Orchestrator Helm Chart - -This Helm Chart deploys the BPDM service to a Kubernetes environment. - -## Prerequisites - -* [Kubernetes Cluster](https://kubernetes.io) -* [Helm](https://helm.sh/docs/) - -In an existing Kubernetes cluster the application can be deployed with the following command: - -```bash -helm install release_name ./charts/bpdm-orchestrator --namespace your_namespace -f /path/to/my_release-values.yaml -``` - -This will install a new release of the BPDM Orchestrator Service in the given namespace. -On default values this release deploys the latest image tagged as `main` from the repository's GitHub Container Registry. - -By giving your own values file you can configure the Helm deployment of the BPDM Orchestrator Service freely. -In the following sections you can have a look at the most important configuration options. - -## Image Tag - -Per default, the Helm deployment references the latest BPDM Orchestrator Service release tagged as `main`. -This tag follows the latest version of the Orchestrator Service and contains the newest features and bug fixes. -You might want to switch to a more stable release tag instead for your deployment. -In your values file you can overwrite the default tag: - -```yaml -image: - tag: "latest" -``` - -## Profiles - -You can also activate Spring profiles in which the BPDM Orchestrator Service should be run. -In case you want to run the Orchestrator Service with authorization enabled you can write the following: - -```yaml -springProfiles: - - auth -``` - -## Ingress - -You can specify your own ingress configuration for the Helm deployment to make the BPDM Orchestrator Service available over Ingress. -Note that you need to have the appropriate Ingress controller installed in your cluster first. -For example, consider a Kubernetes cluster with an [Ingress-Nginx](https://kubernetes.github.io/ingress-nginx/) installed. -An Ingress configuration for the Orchestrator Service deployment could somehow look like this: - -```yaml -ingress: - enabled: true - annotations: - kubernetes.io/ingress.class: nginx - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: business-partners.your-domain.net - paths: - - path: /orchestrator - pathType: Prefix -``` - -## Orchestrator Service Configuration - -For the default deployment you already need to overwrite the configuration properties of the application. -The Helm deployment comes with the ability to configure the BPDM Orchestrator Service application directly over the values file. -This way you are able to overwrite any configuration property of the `application.properties` and `application-auth.properties` files. -Consider that you would need to turn on `auth` profile first before overwriting any property in the corresponding properties file could take -effect. - -Entries in the "applicationConfig" value are written directly to a configMap that is part of the Helm deployment. -This can be a problem if you want to overwrite configuration properties with secrets. -Therefore, you can specify secret configuration values in a different Helm value `applicationSecrets`. -Content of this value is written in a Kubernetes secret instead. -If you want to specify a keycloak client secret for example: - -```yaml -applicationSecrets: - bpdm: - security: - credentials: - secret: your_client_secret -``` - -## Notice - -This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). - -- SPDX-License-Identifier: Apache-2.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 Mercedes Benz Group -- SPDX-FileCopyrightText: 2023,2023 Schaeffler AG -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/bpdm +# bpdm-orchestrator + +![Version: 3.0.1-alpha.0](https://img.shields.io/badge/Version-3.0.1--alpha.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 6.0.0](https://img.shields.io/badge/AppVersion-6.0.0-informational?style=flat-square) + +A Helm chart for deploying the BPDM Orchestrator service + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| Nico Koprowski | | | +| Fabio D. Mota | | | + +## Source Code + +* + +## Requirements + +| Repository | Name | Version | +|------------|------|---------| +| file://../bpdm-common | bpdm-common | 1.0.1 | + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.labelSelector.matchExpressions[0].key | string | `"app.kubernetes.io/name"` | | +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.labelSelector.matchExpressions[0].operator | string | `"DoesNotExist"` | | +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.topologyKey | string | `"kubernetes.io/hostname"` | | +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].weight | int | `100` | | +| applicationConfig | string | `nil` | | +| applicationSecrets | string | `nil` | | +| autoscaling.enabled | bool | `false` | | +| fullnameOverride | string | `nil` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.registry | string | `"docker.io"` | | +| image.repository | string | `"tractusx/bpdm-orchestrator"` | | +| image.tag | string | `""` | | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts | list | `[]` | | +| ingress.tls | list | `[]` | | +| livenessProbe.failureThreshold | int | `3` | | +| livenessProbe.httpGet.path | string | `"/actuator/health/liveness"` | | +| livenessProbe.httpGet.port | int | `8085` | | +| livenessProbe.httpGet.scheme | string | `"HTTP"` | | +| livenessProbe.initialDelaySeconds | int | `5` | | +| livenessProbe.periodSeconds | int | `5` | | +| livenessProbe.successThreshold | int | `1` | | +| livenessProbe.timeoutSeconds | int | `1` | | +| nameOverride | string | `nil` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| readinessProbe.failureThreshold | int | `3` | | +| readinessProbe.httpGet.path | string | `"/actuator/health/readiness"` | | +| readinessProbe.httpGet.port | int | `8085` | | +| readinessProbe.httpGet.scheme | string | `"HTTP"` | | +| readinessProbe.initialDelaySeconds | int | `5` | | +| readinessProbe.periodSeconds | int | `5` | | +| readinessProbe.successThreshold | int | `1` | | +| readinessProbe.timeoutSeconds | int | `1` | | +| replicaCount | int | `1` | | +| resources.limits.cpu | string | `"500m"` | | +| resources.limits.memory | string | `"1Gi"` | | +| resources.requests.cpu | string | `"100m"` | | +| resources.requests.memory | string | `"1Gi"` | | +| securityContext.allowPrivilegeEscalation | bool | `false` | | +| securityContext.capabilities.drop[0] | string | `"ALL"` | | +| securityContext.readOnlyRootFilesystem | bool | `true` | | +| securityContext.runAsGroup | int | `10001` | | +| securityContext.runAsNonRoot | bool | `true` | | +| securityContext.runAsUser | int | `10001` | | +| securityContext.seccompProfile.type | string | `"RuntimeDefault"` | | +| service.port | int | `80` | | +| service.targetPort | int | `8085` | | +| service.type | string | `"ClusterIP"` | | +| springProfiles | list | `[]` | | +| startupProbe.failureThreshold | int | `40` | | +| startupProbe.httpGet.path | string | `"/actuator/health/readiness"` | | +| startupProbe.httpGet.port | int | `8085` | | +| startupProbe.httpGet.scheme | string | `"HTTP"` | | +| startupProbe.initialDelaySeconds | int | `60` | | +| startupProbe.periodSeconds | int | `30` | | +| startupProbe.successThreshold | int | `1` | | +| startupProbe.timeoutSeconds | int | `1` | | +| tolerations | list | `[]` | | + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1) diff --git a/charts/bpdm/charts/bpdm-pool/CHANGELOG.md b/charts/bpdm/charts/bpdm-pool/CHANGELOG.md index 58e743d33..6a86c8ade 100644 --- a/charts/bpdm/charts/bpdm-pool/CHANGELOG.md +++ b/charts/bpdm/charts/bpdm-pool/CHANGELOG.md @@ -9,6 +9,7 @@ The format is based on Keep a Changelog (https://keepachangelog.com/en/1.0.0/), ### Changed - Default pull policy from 'Always' to 'IfNotPresent' +- Added documentation for default values in the README ## [7.0.0] - 2024-05-15 diff --git a/charts/bpdm/charts/bpdm-pool/Chart.yaml b/charts/bpdm/charts/bpdm-pool/Chart.yaml index e9e544a0b..69c12f008 100644 --- a/charts/bpdm/charts/bpdm-pool/Chart.yaml +++ b/charts/bpdm/charts/bpdm-pool/Chart.yaml @@ -22,7 +22,7 @@ apiVersion: v2 type: application name: bpdm-pool appVersion: "6.0.0" -version: 7.0.1-alpha.0 +version: 7.0.1-alpha.1 description: A Helm chart for deploying the BPDM pool service home: https://eclipse-tractusx.github.io/docs/kits/Business%20Partner%20Kit/Adoption%20View sources: diff --git a/charts/bpdm/charts/bpdm-pool/README.md b/charts/bpdm/charts/bpdm-pool/README.md index 5183f0e89..503246ca9 100644 --- a/charts/bpdm/charts/bpdm-pool/README.md +++ b/charts/bpdm/charts/bpdm-pool/README.md @@ -1,133 +1,98 @@ -# BPDM Pool Helm Chart - -This Helm Chart deploys the BPDM Pool service to a Kubernetes environment. - -## Prerequisites - -* [Kubernetes Cluster](https://kubernetes.io/) -* [Helm](https://helm.sh/docs/) - -In an existing Kubernetes cluster the application can be deployed with the following command: - -```bash -helm install release_name ./charts/bpdm-pool --namespace your_namespace -``` - -This will install a new release of the BPDM Pool in the given namespace. -On default values this release deploys the latest image tagged as `main` from the repository's GitHub Container Registry. -The application is run on default profile (without authorization). -Additionally, the Helm deployment contains a PostgreSQL database and Opensearch instance which the BPDM Pool connects to. - -On the default values deployment no further action is needed to make the BPDM Pool deployment run. -However, per default, ingress as well as authentication for endpoints are disabled. - -By giving your own values file you can configure the Helm deployment of the BPDM Pool freely: - -```bash -helm install release_name ./charts/bpdm-pool --namespace your_namespace -f ./path/to/your/values.yaml -``` - -In the following sections you can have a look at the most important configuration options. - -## Image Tag - -Per default, the Helm deployment references a certain BPDM Pool release version where the newest Helm release points to the newest Pool version. -This is a stable tag pointing to a fixed release version of the BPDM Pool. -For your deployment you might want to follow the latest application releases instead. - -In your values file you can overwrite the default tag: - -```yaml -image: - tag: "latest" -``` - -## Profiles - -You can also activate Spring profiles in which the BPDM Pool should be run. -In case you want to run the Pool with authorization enabled you can write the following: - -```yaml -springProfiles: - - auth -``` - -## Ingress - -You can specify your own ingress configuration for the Helm deployment to make the BPDM Pool available over Ingress. -Note that you need to have the appropriate Ingress controller installed in your cluster first. -For example, consider a Kubernetes cluster with an [Ingress-Nginx](https://kubernetes.github.io/ingress-nginx/) installed. -An Ingress configuration for the Pool deployment could look like this: - -```yaml -ingress: - enabled: true - annotations: - kubernetes.io/ingress.class: nginx - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: business-partners.your-domain.net - paths: - - path: /pool - pathType: Prefix -``` - -## Pool Configuration - -The Helm deployment comes with the ability to configure the BPDM Pool application directly over the values file. -This way you are able to overwrite any configuration property of the `application.properties` and `application-auth.properties` files. -Consider that you would need to turn on `auth` profile first before overwriting any property in the corresponding properties file could take effect. -Overwriting configuration properties can be useful to connect to a remote service: - -```yaml -applicationConfig: - bpdm: - security: - auth-server-url: https://remote.keycloak.domain.com - realm: CUSTOM_REALM - client-id: POOL_CLIENT -``` - -In this example above a Pool with authenticated activated connects to a remote Keycloak instance and uses its custom realm and resource. - -Entries in the "applicationConfig" value are written directly to a configMap that is part of the Helm deployment. -This can be a problem if you want to overwrite configuration properties with secrets. -Therefore, you can specify secret configuration values in a different Helm value `applicationSecrets`. -Content of this value is written in a Kubernetes secret instead. -If you want to specify a custom database password for example: - -```yaml -applicationSecrets: - spring: - datasource: - password: your_database_secret -``` - -## Helm Dependencies - -On default, the Helm deployment also contains a PostgreSQL. -You can configure the deployment in your value file as well. -For this, consider the documentation of the correspondent dependency [PostgreSQL](https://artifacthub.io/packages/helm/bitnami/postgresql/11.9.13). -In case you want to use an already deployed database instance you can also disable the respective dependency and overwrite the default host -address in the `applicationConfig`: - -```yaml -applicationConfig: - spring: - datasource: - url: jdbc:postgresql://remote.host.net:5432/bpdm -postgres: - enabled: false -``` - -## Notice - -This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). - -- SPDX-License-Identifier: Apache-2.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 Mercedes Benz Group -- SPDX-FileCopyrightText: 2023,2023 Schaeffler AG -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/bpdm \ No newline at end of file +# bpdm-pool + +![Version: 7.0.1-alpha.0](https://img.shields.io/badge/Version-7.0.1--alpha.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 6.0.0](https://img.shields.io/badge/AppVersion-6.0.0-informational?style=flat-square) + +A Helm chart for deploying the BPDM pool service + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| Nico Koprowski | | | +| Fabio D. Mota | | | + +## Source Code + +* + +## Requirements + +| Repository | Name | Version | +|------------|------|---------| +| file://../bpdm-common | bpdm-common | 1.0.1 | +| https://charts.bitnami.com/bitnami | postgres(postgresql) | 12.12.10 | + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.labelSelector.matchExpressions[0].key | string | `"app.kubernetes.io/name"` | | +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.labelSelector.matchExpressions[0].operator | string | `"DoesNotExist"` | | +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.topologyKey | string | `"kubernetes.io/hostname"` | | +| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].weight | int | `100` | | +| applicationConfig.bpdm.client.orchestrator.base-url | string | `nil` | | +| applicationConfig.bpdm.datasource.host | string | `nil` | | +| applicationSecrets.spring.dataSource.password | string | `"bpdm"` | | +| autoscaling.enabled | bool | `false` | | +| fullnameOverride | string | `nil` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.registry | string | `"docker.io"` | | +| image.repository | string | `"tractusx/bpdm-pool"` | | +| image.tag | string | `""` | | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts | list | `[]` | | +| ingress.tls | list | `[]` | | +| livenessProbe.failureThreshold | int | `5` | | +| livenessProbe.httpGet.path | string | `"/actuator/health/liveness"` | | +| livenessProbe.httpGet.port | int | `8080` | | +| livenessProbe.httpGet.scheme | string | `"HTTP"` | | +| livenessProbe.initialDelaySeconds | int | `120` | | +| livenessProbe.periodSeconds | int | `10` | | +| livenessProbe.successThreshold | int | `1` | | +| livenessProbe.timeoutSeconds | int | `1` | | +| nameOverride | string | `nil` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| postgres.auth.database | string | `"bpdm"` | | +| postgres.auth.password | string | `"bpdm"` | | +| postgres.auth.username | string | `"bpdm"` | | +| postgres.enabled | bool | `true` | | +| readinessProbe.failureThreshold | int | `3` | | +| readinessProbe.httpGet.path | string | `"/actuator/health/readiness"` | | +| readinessProbe.httpGet.port | int | `8080` | | +| readinessProbe.httpGet.scheme | string | `"HTTP"` | | +| readinessProbe.initialDelaySeconds | int | `5` | | +| readinessProbe.periodSeconds | int | `5` | | +| readinessProbe.successThreshold | int | `1` | | +| readinessProbe.timeoutSeconds | int | `1` | | +| replicaCount | int | `1` | | +| resources.limits.cpu | string | `"1000m"` | | +| resources.limits.memory | string | `"1Gi"` | | +| resources.requests.cpu | string | `"300m"` | | +| resources.requests.memory | string | `"1Gi"` | | +| securityContext.allowPrivilegeEscalation | bool | `false` | | +| securityContext.capabilities.drop[0] | string | `"ALL"` | | +| securityContext.readOnlyRootFilesystem | bool | `true` | | +| securityContext.runAsGroup | int | `10001` | | +| securityContext.runAsNonRoot | bool | `true` | | +| securityContext.runAsUser | int | `10001` | | +| service.port | int | `80` | | +| service.targetPort | int | `8080` | | +| service.type | string | `"ClusterIP"` | | +| springProfiles | list | `[]` | | +| startupProbe.failureThreshold | int | `40` | | +| startupProbe.httpGet.path | string | `"/actuator/health/readiness"` | | +| startupProbe.httpGet.port | int | `8080` | | +| startupProbe.httpGet.scheme | string | `"HTTP"` | | +| startupProbe.initialDelaySeconds | int | `60` | | +| startupProbe.periodSeconds | int | `30` | | +| startupProbe.successThreshold | int | `1` | | +| startupProbe.timeoutSeconds | int | `1` | | +| tolerations | list | `[]` | | + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)