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.

Sign up for GitHub

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

[data-dashboard-backend] Update charts for data dashboard backend service #196

Merged
merged 3 commits into from
May 29, 2024
Merged

[data-dashboard-backend] Update charts for data dashboard backend service #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
40a756f
Add data-dashboard-backend to management portal OAuth2 clients
pvannierop May 16, 2024
1425ef5
Improve configuration options for data-dashboard-backend
pvannierop May 28, 2024
87e358d
Mention correct helm_docs version in README.md
pvannierop May 29, 2024
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
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ helm-docs -s file --template-files=charts/_templates.gotmpl --template-files=DOC
or, when using Docker:

```
docker run --rm -v "$(pwd):/helm-docs" jnorwood/helm-docs:latest -s file --template-files=charts/_templates.gotmpl --template-files=DOCS.md.gotmpl --template-files=README.md.gotmpl --chart-search-root=charts
HELMDOCS_IMAGE=jnorwood/helm-docs:v1.8.1
docker run --rm -v "$(pwd):/helm-docs" $HELMDOCS_IMAGE -s file --template-files=charts/_templates.gotmpl --template-files=DOCS.md.gotmpl --template-files=README.md.gotmpl --chart-search-root=charts
```

For general usage and instructions view the [helm-docs](https://github.com/norwoodj/helm-docs) README. Below is a short summary.
Expand Down
2 changes: 1 addition & 1 deletion charts/data-dashboard-backend/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v2
appVersion: "0.1.0"
name: data-dashboard-backend
description: API for data in the data dashboard
version: 0.1.6
version: 0.1.8
sources: ["https://github.com/thehyve/radar-data-dashboard-backend"]
deprecated: false
type: application
Expand Down
11 changes: 6 additions & 5 deletions charts/data-dashboard-backend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# data-dashboard-backend

![Version: 0.1.6](https://img.shields.io/badge/Version-0.1.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)
![Version: 0.1.8](https://img.shields.io/badge/Version-0.1.8-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)

API for data in the data dashboard

Expand Down Expand Up @@ -31,8 +31,9 @@ API for data in the data dashboard
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| replicaCount | int | `1` | Number of replicas to deploy |
| image.repository | string | `"ghcr.io/thehyve/radar-data-dashboard-backend"` | docker image repository |
| image.repository | string | `"radarbase/radar-data-dashboard-backend"` | docker image repository |
| image.pullPolicy | string | `"Always"` | image pull policy |
| image.tag | string | `"latest"` | Overrides the image tag whose default is the chart appVersion. |
| imagePullSecrets | list | `[]` | Docker registry secret names as an array |
| nameOverride | string | `""` | String to partially override fullname template with a string (will prepend the release name) |
| fullnameOverride | string | `""` | String to fully override fullname template with a string |
Expand Down Expand Up @@ -60,9 +61,9 @@ API for data in the data dashboard
| managementPortal.url | string | `"http://management-portal:8080/managementportal"` | ManagementPortal URL |
| managementPortal.clientId | string | `"radar_data_dashboard_backend"` | ManagementPortal OAuth 2.0 client ID, having grant type client_credentials |
| managementPortal.clientSecret | string | `"secret"` | ManagementPortal OAuth 2.0 client secret |
| path | string | `"/api"` | |
| path | string | `"/api"` | Base path to use in application |
| jdbc.driver | string | `"org.postgresql.Driver"` | JDBC Driver to connect to the database. |
| jdbc.url | string | `"jdbc:postgresql://postgresql:5432/data-dashboard"` | JDBC Connection url of the database. |
| jdbc.user | string | `"radarbase"` | Username of the database |
| jdbc.password | string | `"password"` | Password of the user |
| jdbc.user | string | `"postgres"` | Username of the database |
| jdbc.password | string | `"secret"` | Password of the user |
| jdbc.dialect | string | `"org.hibernate.dialect.PostgreSQLDialect"` | Hibernate dialect to use for JDBC Connection |
2 changes: 1 addition & 1 deletion charts/data-dashboard-backend/templates/configmap.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ data:
url: {{ .Values.managementPortal.url }}
clientId: {{ .Values.managementPortal.clientId }}
clientSecret: {{ .Values.managementPortal.clientSecret }}
jwtResourceName: res_data_dashboard_backend
jwtResourceName: {{ .Values.jwtResourceName }}
database:
url: {{ .Values.jdbc.url }}
user: {{ .Values.jdbc.user }}
Expand Down
4 changes: 2 additions & 2 deletions charts/data-dashboard-backend/templates/deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,14 @@ spec:
protocol: TCP
livenessProbe:
httpGet:
path: /api/health
path: {{ .Values.path }}/health
port: http
httpHeaders:
- name: Accept
value: application/json
readinessProbe:
httpGet:
path: /api/health
path: {{ .Values.path }}/health
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not really related to this PR but some of our components are pointed to a sub domain and some other to prefixes in the main domain and it's not clear for me when we use which one. I think we should have an agreement on it. I'll make an issue for it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, the grizzly application has this as a configurable option. The sub-path can be modified in the helmfile. I think that for this reason the helm chart must allow configuration of this path, in order to allow for outside changes of subpath?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that is true. It's good to have this configurable.

port: http
httpHeaders:
- name: Accept
Expand Down
10 changes: 6 additions & 4 deletions charts/data-dashboard-backend/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ replicaCount: 1

image:
# -- docker image repository
repository: ghcr.io/thehyve/radar-data-dashboard-backend
repository: radarbase/radar-data-dashboard-backend
# -- image pull policy
pullPolicy: Always
# -- Overrides the image tag whose default is the chart appVersion.
tag: latest

# -- Docker registry secret names as an array
imagePullSecrets: []
Expand Down Expand Up @@ -99,7 +101,7 @@ managementPortal:
# -- ManagementPortal OAuth 2.0 client secret
clientSecret: secret

# Base path to use in application
# -- Base path to use in application
path: /api

jdbc:
Expand All @@ -108,8 +110,8 @@ jdbc:
# -- JDBC Connection url of the database.
url: jdbc:postgresql://postgresql:5432/data-dashboard
# -- Username of the database
user: radarbase
user: postgres
# -- Password of the user
password: password
password: secret
# -- Hibernate dialect to use for JDBC Connection
dialect: org.hibernate.dialect.PostgreSQLDialect
2 changes: 1 addition & 1 deletion charts/management-portal/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v2
appVersion: "2.0.0"
description: A Helm chart for RADAR-Base Management Portal to manage projects and participants throughout RADAR-base.
name: management-portal
version: 1.1.4
version: 1.1.5
icon: "http://radar-base.org/wp-content/uploads/2022/09/Logo_RADAR-Base-RGB.png"
sources:
- https://github.com/RADAR-base/radar-helm-charts/tree/main/charts/management-portal
Expand Down
2 changes: 1 addition & 1 deletion charts/management-portal/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# management-portal
[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/management-portal)](https://artifacthub.io/packages/helm/radar-base/management-portal)

![Version: 1.1.4](https://img.shields.io/badge/Version-1.1.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.0.0](https://img.shields.io/badge/AppVersion-2.0.0-informational?style=flat-square)
![Version: 1.1.5](https://img.shields.io/badge/Version-1.1.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.0.0](https://img.shields.io/badge/AppVersion-2.0.0-informational?style=flat-square)

A Helm chart for RADAR-Base Management Portal to manage projects and participants throughout RADAR-base.

Expand Down
12 changes: 12 additions & 0 deletions charts/management-portal/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -593,3 +593,15 @@ oauth_clients:
authorized_grant_types:
- client_credentials
access_token_validity: 900

radar_data_dashboard_backend:
enable: false
resource_ids:
- res_DataDashboardAPI
client_secret: ""
scope:
- MEASUREMENT.READ
authorized_grant_types:
- authorization_code
- refresh_token
access_token_validity: 900
Loading