Skip to content

Update helm charts for Sentry configuration #311

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Update helm charts for Sentry configuration #311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8dbeefe
Update helm charts for Sentry configuration.
ewelinagr Dec 18, 2024
89b5be2
Add default Sentry stacktrace app packages.
ewelinagr Dec 30, 2024
432853d
Add helper variables for sentry name and release.
ewelinagr Jan 6, 2025
bac7b94
Remove unnecessary sentry helper variables, update sentry name and re…
ewelinagr Jan 20, 2025
9bb45b5
Bump charts versions.
ewelinagr Jan 20, 2025
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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ This documentation assumes familiarity with all referenced Kubernetes concepts,

The following tools should be installed in your local machine to install the RADAR-Kubernetes on your Kubernetes cluster.

| Component | Description |
| -------------------------------------------------- | ----------------------------------------------------------------------- |
| [helm 3](https://github.com/helm/helm#install) | Helm Charts are used to package Kubernetes resources for each component |
| kubernetes | The charts support Kubernetes versions 1.19 up to 1.22. |
| [helm-docs](https://github.com/norwoodj/helm-docs) | README generator for each chart. |
| Component | Description |
|----------------------------------------------------------------------------|-------------------------------------------------------------------------|
| [helm 3](https://github.com/helm/helm#install) | Helm Charts are used to package Kubernetes resources for each component |
| kubernetes | The charts support Kubernetes versions 1.19 up to 1.22. |
| [helm-docs v1.8.1.](https://github.com/norwoodj/helm-docs/releases/v1.8.1) | README generator for each chart. |

Installation of these charts is best managed via [RADAR-Kubernetes](https://github.com/RADAR-base/RADAR-Kubernetes).

Expand Down
2 changes: 1 addition & 1 deletion charts/app-config/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.5.2"
description: A Helm chart for RADAR-base application config (app-config) backend service which is used as mobile app configuration engine with per-project and per-user configuration.
name: app-config
version: 1.4.0
version: 1.5.0
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/app-config
Expand Down
9 changes: 8 additions & 1 deletion charts/app-config/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# app-config
[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/app-config)](https://artifacthub.io/packages/helm/radar-base/app-config)

![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: 0.5.2](https://img.shields.io/badge/AppVersion-0.5.2-informational?style=flat-square)
![Version: 1.5.0](https://img.shields.io/badge/Version-1.5.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.5.2](https://img.shields.io/badge/AppVersion-0.5.2-informational?style=flat-square)

A Helm chart for RADAR-base application config (app-config) backend service which is used as mobile app configuration engine with per-project and per-user configuration.

Expand Down Expand Up @@ -91,3 +91,10 @@ A Helm chart for RADAR-base application config (app-config) backend service whic
| jdbc.user | string | `"postgres"` | Username of the database |
| jdbc.password | string | `"password"` | Password of the user |
| jdbc.dialect | string | `"org.hibernate.dialect.PostgreSQLDialect"` | JDBC dialect to use for JDBC Connection |
| sentry.dsn | string | `nil` | DSN (Data Source Name) of the sentry server |
| sentry.level | string | `"ERROR"` | Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR) |
| sentry.service.name | string | `nil` | Name of the service to be displayed in the sentry dashboard |
| sentry.service.release | string | `nil` | App version to be displayed in the sentry dashboard |
| sentry.service.environment | string | `"production"` | Environment of the sentry service |
| sentry.stacktrace.enabled | bool | `true` | Set to true, if stack trace should be enabled |
| sentry.stacktrace.packages | string | `"org.radarbase.appconfig,org.radarbase.lang,comparisons"` | Comma-separated list of package prefixes to be included in the stacktrace |
21 changes: 21 additions & 0 deletions charts/app-config/templates/deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,27 @@ spec:
secretKeyRef:
name: {{ template "app-config.secretName" . }}
key: databasePassword
{{- if .Values.sentry.dsn }}
- name: SENTRY_DSN
value: {{ .Values.sentry.dsn }}
- name: SENTRY_LOG_LEVEL
value: {{ .Values.sentry.level }}
{{- if .Values.sentry.stacktrace.enabled }}
- name: SENTRY_ATTACH_STACKTRACE
value: {{ .Values.sentry.stacktrace.enabled | quote }}
- name: SENTRY_STACKTRACE_APP_PACKAGES
value: {{ .Values.sentry.stacktrace.packages}}
{{- end }}
- name: SENTRY_NAME
value: {{ .Values.sentry.service.name | default (include "app-config.fullname" .) }}
- name: SENTRY_RELEASE
value: {{ .Values.sentry.service.release | default (printf "%s-%s" .Chart.Version .Chart.AppVersion) }}
- name: SENTRY_ENVIRONMENT
value: {{ .Values.sentry.service.environment }}
{{- else }}
- name: SENTRY_ENABLED
value: "false"
{{- end }}
{{- with .Values.extraEnvVars }}
{{- toYaml . | nindent 10 }}
{{- end }}
Expand Down
19 changes: 19 additions & 0 deletions charts/app-config/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,3 +206,22 @@ jdbc:
password: password
# -- JDBC dialect to use for JDBC Connection
dialect: org.hibernate.dialect.PostgreSQLDialect

# Sentry monitoring configuration
sentry:
# -- DSN (Data Source Name) of the sentry server
dsn:
# -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
level: ERROR
service:
# -- Name of the service to be displayed in the sentry dashboard
name:
# -- App version to be displayed in the sentry dashboard
release:
# -- Environment of the sentry service
environment: production
stacktrace:
# -- Set to true, if stack trace should be enabled
enabled: true
# -- Comma-separated list of package prefixes to be included in the stacktrace
packages: "org.radarbase.appconfig,org.radarbase.lang,comparisons"
Copy link
Contributor

@pvannierop pvannierop Jan 13, 2025

Choose a reason for hiding this comment

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

Is this package string correct? The comparisons part looks strange to me.

Copy link
Contributor Author

@ewelinagr ewelinagr Jan 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

yes,this is the one that is packaged under comparisons:
radar-expression-lang/src/main/kotlin/comparisons/Library.kt
If not needed, I can remove it

Copy link
Contributor

@pvannierop pvannierop Jan 13, 2025

Choose a reason for hiding this comment

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

@ewelinagr Did you perhaps miss this comment?

2 changes: 1 addition & 1 deletion charts/catalog-server/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.8.11"
description: A Helm chart for RADAR-base catalogue server. This application creates RADAR-base topics in Kafka, registers schemas in Schema Registry and keeps a catalog of available source types.
name: catalog-server
version: 0.7.0
version: 0.8.0
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/catalog-server
Expand Down
9 changes: 8 additions & 1 deletion charts/catalog-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# catalog-server
[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/catalog-server)](https://artifacthub.io/packages/helm/radar-base/catalog-server)

![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) ![AppVersion: 0.8.11](https://img.shields.io/badge/AppVersion-0.8.11-informational?style=flat-square)
![Version: 0.8.0](https://img.shields.io/badge/Version-0.8.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.8.11](https://img.shields.io/badge/AppVersion-0.8.11-informational?style=flat-square)

A Helm chart for RADAR-base catalogue server. This application creates RADAR-base topics in Kafka, registers schemas in Schema Registry and keeps a catalog of available source types.

Expand Down Expand Up @@ -104,3 +104,10 @@ A Helm chart for RADAR-base catalogue server. This application creates RADAR-bas
| cc.apiSecret | string | `"ccApiSecret"` | API secret of the Confluent Cloud based kafka cluster |
| cc.schemaRegistryApiKey | string | `"srApiKey"` | API key of the Confluent Cloud based schema registry |
| cc.schemaRegistryApiSecret | string | `"srApiSecret"` | API secret of the Confluent Cloud based schema registry |
| sentry.dsn | string | `nil` | DSN (Data Source Name) of the sentry server |
| sentry.level | string | `"ERROR"` | Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR) |
| sentry.service.name | string | `nil` | Name of the service to be displayed in the sentry dashboard |
| sentry.service.release | string | `nil` | App version to be displayed in the sentry dashboard |
| sentry.service.environment | string | `"production"` | Environment of the sentry service |
| sentry.stacktrace.enabled | bool | `true` | Set to true, if stack trace should be enabled |
| sentry.stacktrace.packages | string | `"org.radarbase.schema,org.radarbase.stream"` | Comma-separated list of package prefixes to be included in the stacktrace |
43 changes: 43 additions & 0 deletions charts/catalog-server/templates/deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,27 @@ spec:
name: {{ template "catalog-server.fullname" . }}
key: srApiSecret
{{- end }}
{{- if .Values.sentry.dsn }}
- name: SENTRY_DSN
value: {{ .Values.sentry.dsn }}
- name: SENTRY_LOG_LEVEL
value: {{ .Values.sentry.level }}
{{- if .Values.sentry.stacktrace.enabled }}
- name: SENTRY_ATTACH_STACKTRACE
value: {{ .Values.sentry.stacktrace.packages | quote }}
- name: SENTRY_STACKTRACE_APP_PACKAGES
value: {{ .Values.sentry.stacktrace.packages}}
{{- end }}
- name: SENTRY_NAME
value: {{ .Values.sentry.service.name | default (include "catalog-server.fullname" .) }}
- name: SENTRY_RELEASE
value: {{ .Values.sentry.service.release | default (printf "%s-%s" .Chart.Version .Chart.AppVersion) }}
- name: SENTRY_ENVIRONMENT
value: {{ .Values.sentry.service.environment }}
{{- else }}
- name: SENTRY_ENABLED
value: "false"
{{- end }}
{{- with .Values.extraEnvVarsInit }}
{{- toYaml . | nindent 8 }}
{{- end }}
Expand All @@ -101,6 +122,28 @@ spec:
- -c
- /etc/radar-schemas-tools/config.yaml
- /schema/merged
env:
{{- if .Values.sentry.dsn }}
- name: SENTRY_DSN
value: {{ .Values.sentry.dsn }}
- name: SENTRY_LOG_LEVEL
value: {{ .Values.sentry.level }}
{{- if .Values.sentry.stacktrace.enabled }}
- name: SENTRY_ATTACH_STACKTRACE
value: {{ .Values.sentry.stacktrace.enabled | quote }}
- name: SENTRY_STACKTRACE_APP_PACKAGES
value: {{ .Values.sentry.stacktrace.packages}}
{{- end }}
- name: SENTRY_NAME
value: {{ .Values.sentry.service.name | default (include "catalog-server.fullname" .) }}
- name: SENTRY_RELEASE
value: {{ .Values.sentry.service.release | default (printf "%s-%s" .Chart.Version .Chart.AppVersion) }}
- name: SENTRY_ENVIRONMENT
value: {{ .Values.sentry.service.environment }}
{{- else }}
- name: SENTRY_ENABLED
value: "false"
{{- end }}
ports:
- name: http
containerPort: 9010
Expand Down
19 changes: 19 additions & 0 deletions charts/catalog-server/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,3 +257,22 @@ cc:
schemaRegistryApiKey: srApiKey
# -- API secret of the Confluent Cloud based schema registry
schemaRegistryApiSecret: srApiSecret

# Sentry monitoring configuration
sentry:
# -- DSN (Data Source Name) of the sentry server
dsn:
# -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
level: ERROR
service:
# -- Name of the service to be displayed in the sentry dashboard
name:
# -- App version to be displayed in the sentry dashboard
release:
# -- Environment of the sentry service
environment: production
stacktrace:
# -- Set to true, if stack trace should be enabled
enabled: true
# -- Comma-separated list of package prefixes to be included in the stacktrace
packages: "org.radarbase.schema,org.radarbase.stream"
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.2.2"
name: data-dashboard-backend
description: API for data in the data dashboard
version: 0.4.0
version: 0.5.0
sources: ["https://github.com/thehyve/radar-data-dashboard-backend"]
deprecated: false
type: application
Expand Down
9 changes: 8 additions & 1 deletion 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.4.0](https://img.shields.io/badge/Version-0.4.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.2.2](https://img.shields.io/badge/AppVersion-0.2.2-informational?style=flat-square)
![Version: 0.5.0](https://img.shields.io/badge/Version-0.5.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.2.2](https://img.shields.io/badge/AppVersion-0.2.2-informational?style=flat-square)

API for data in the data dashboard

Expand Down Expand Up @@ -77,3 +77,10 @@ API for data in the data dashboard
| jdbc.dialect | string | `"org.hibernate.dialect.PostgreSQLDialect"` | Hibernate dialect to use for JDBC Connection |
| jdbc.properties."hibernate.globally_quoted_identifiers" | bool | `true` | Must be _true_ for compatibility with table created by jdbc-connector |
| jdbc.properties."hibernate.physical_naming_strategy" | string | `"org.radarbase.datadashboard.api.domain.model.CamelCaseToUppercaseColumnNamingStrategy"` | Must be _CamelCaseToUppercaseColumnNamingStrategy_ for compatibility with table created by jdbc-connector |
| sentry.dsn | string | `nil` | DSN (Data Source Name) of the sentry server |
| sentry.level | string | `"ERROR"` | Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR) |
| sentry.service.name | string | `nil` | Name of the service to be displayed in the sentry dashboard |
| sentry.service.release | string | `nil` | App version to be displayed in the sentry dashboard |
| sentry.service.environment | string | `"production"` | The environment name for this installation. |
| sentry.stacktrace.enabled | bool | `true` | Set to true, if stack trace should be enabled |
| sentry.stacktrace.packages | string | `"org.radarbase.datadashboard,org.radarbase.upload"` | Comma-separated list of package prefixes to be included in the stacktrace |
21 changes: 21 additions & 0 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 @@ -68,6 +68,27 @@ spec:
secretKeyRef:
name: {{ template "data-dashboard-backend.secretName" . }}
key: databasePassword
{{- if .Values.sentry.dsn }}
- name: SENTRY_DSN
value: {{ .Values.sentry.dsn }}
- name: SENTRY_LOG_LEVEL
value: {{ .Values.sentry.level }}
{{- if .Values.sentry.stacktrace.enabled }}
- name: SENTRY_ATTACH_STACKTRACE
value: {{ .Values.sentry.stacktrace.enabled | quote }}
- name: SENTRY_STACKTRACE_APP_PACKAGES
value: {{ .Values.sentry.stacktrace.packages}}
{{- end }}
- name: SENTRY_NAME
value: {{ .Values.sentry.service.name | default (include "data-dashboard-backend.fullname" .) }}
- name: SENTRY_RELEASE
value: {{ .Values.sentry.service.release | default (printf "%s-%s" .Chart.Version .Chart.AppVersion) }}
- name: SENTRY_ENVIRONMENT
value: {{ .Values.sentry.service.environment }}
{{- else }}
- name: SENTRY_ENABLED
value: "false"
{{- end }}
ports:
- name: http
containerPort: 9000
Expand Down
19 changes: 19 additions & 0 deletions charts/data-dashboard-backend/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,3 +173,22 @@ jdbc:
hibernate.globally_quoted_identifiers: true
# -- Must be _CamelCaseToUppercaseColumnNamingStrategy_ for compatibility with table created by jdbc-connector
hibernate.physical_naming_strategy: org.radarbase.datadashboard.api.domain.model.CamelCaseToUppercaseColumnNamingStrategy

# Sentry monitoring configuration
sentry:
# -- DSN (Data Source Name) of the sentry server
dsn:
# -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
level: ERROR
service:
# -- Name of the service to be displayed in the sentry dashboard
name:
# -- App version to be displayed in the sentry dashboard
release:
# -- The environment name for this installation.
environment: production
stacktrace:
# -- Set to true, if stack trace should be enabled
enabled: true
# -- Comma-separated list of package prefixes to be included in the stacktrace
packages: "org.radarbase.datadashboard,org.radarbase.upload"
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.1.5"
description: A Helm chart for RADAR-Base Management Portal to manage projects and participants throughout RADAR-base.
name: management-portal
version: 1.4.0
version: 1.5.0
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
9 changes: 8 additions & 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.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: 2.1.5](https://img.shields.io/badge/AppVersion-2.1.5-informational?style=flat-square)
![Version: 1.5.0](https://img.shields.io/badge/Version-1.5.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.1.5](https://img.shields.io/badge/AppVersion-2.1.5-informational?style=flat-square)

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

Expand Down Expand Up @@ -114,6 +114,13 @@ A Helm chart for RADAR-Base Management Portal to manage projects and participant
| smtp.starttls | bool | `false` | set to true,if ttls should be enabled |
| smtp.auth | bool | `true` | set to true, if the account should be authenticated before sending emails |
| oauth_clients | object | check `values.yaml` | OAuth2 Client configuration |
| sentry.dsn | string | `nil` | DSN (Data Source Name) of the sentry server |
| sentry.level | string | `"ERROR"` | Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR) |
| sentry.service.name | string | `nil` | Name of the service to be displayed in the sentry dashboard |
| sentry.service.release | string | `nil` | App version to be displayed in the sentry dashboard |
| sentry.service.environment | string | `"production"` | Environment of the sentry service |
| sentry.stacktrace.enabled | bool | `true` | Set to true, if stack trace should be enabled |
| sentry.stacktrace.packages | string | `"org.radarbase.management,org.radarbase.auth"` | Comma-separated list of package prefixes to be included in the stacktrace |

## OAuth Client Configuration
List of OAuth client configurations supported by RADAR-base. Each client should be enabled separately, if relevant and used in the installation.
Expand Down
Loading
Loading