Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(charts): add default value descriptions to the README #936

Merged
merged 1 commit into from
May 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions charts/bpdm/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
15 changes: 10 additions & 5 deletions charts/bpdm/Chart.yaml
nicoprow marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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://./charts/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://./charts/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://./charts/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://./charts/bpdm-orchestrator"
- name: bpdm-common
version: 1.0.1
repository: "file://./charts/bpdm-common"
- name: postgresql
version: 12.12.10
repository: https://charts.bitnami.com/bitnami
Expand Down
164 changes: 92 additions & 72 deletions charts/bpdm/README.md
Original file line number Diff line number Diff line change
@@ -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
# bpdm

![Version: 5.0.1-alpha.2](https://img.shields.io/badge/Version-5.0.1--alpha.2-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:** <https://github.com/eclipse-tractusx/bpdm>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| Nico Koprowski | | |
| Fabio D. Mota | | |

## Source Code

* <https://github.com/eclipse-tractusx/bpdm>

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| file://./charts/bpdm-cleaning-service-dummy | bpdm-cleaning-service-dummy(bpdm-cleaning-service-dummy) | 3.0.1-alpha.1 |
| file://./charts/bpdm-common | bpdm-common | 1.0.1 |
| file://./charts/bpdm-gate | bpdm-gate(bpdm-gate) | 6.0.1-alpha.1 |
| file://./charts/bpdm-orchestrator | bpdm-orchestrator(bpdm-orchestrator) | 3.0.1-alpha.1 |
| file://./charts/bpdm-pool | bpdm-pool(bpdm-pool) | 7.0.1-alpha.1 |
| 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)
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion charts/bpdm/charts/bpdm-cleaning-service-dummy/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading