Skip to content

Commit

Permalink
Add helper variables for sentry name and release.
Browse files Browse the repository at this point in the history
  • Loading branch information
ewelinagr committed Jan 9, 2025
1 parent a18faea commit 7562af7
Show file tree
Hide file tree
Showing 63 changed files with 288 additions and 120 deletions.
10 changes: 5 additions & 5 deletions README.md
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
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.3.4
version: 1.4.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
8 changes: 4 additions & 4 deletions charts/app-config/README.md
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.3.4](https://img.shields.io/badge/Version-1.3.4-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.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)

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 @@ -85,8 +85,8 @@ A Helm chart for RADAR-base application config (app-config) backend service whic
| 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 sentry service |
| sentry.service.release | string | `nil` | App version of the sentry service |
| 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 | `""` | Comma-separated list of package prefixes to be included in the stacktrace |
| sentry.stacktrace.packages | string | `"org.radarbase.appconfig,org.radarbase.lang,comparisons"` | Comma-separated list of package prefixes to be included in the stacktrace |
14 changes: 14 additions & 0 deletions charts/app-config/templates/_helpers.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,17 @@ Create the name of the service account to use
{{ default "default" .Values.serviceAccount.name }}
{{- end -}}
{{- end -}}

{{/*
Service name to be used by Sentry
*/}}
{{- define "app-config.sentryName" -}}
{{- printf "%s" (include "app-config.fullname" .) -}}
{{- end -}}

{{/*
App release to be used by Sentry
*/}}
{{- define "app-config.sentryRelease" -}}
{{- printf "%s" .Chart.AppVersion -}}
{{- end -}}
4 changes: 2 additions & 2 deletions charts/app-config/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,9 @@ spec:
value: {{ .Values.sentry.stacktrace.packages}}
{{- end }}
- name: SENTRY_NAME
value: {{ .Values.sentry.service.name }}
value: {{ include "app-config.sentryName" . }}
- name: SENTRY_RELEASE
value: {{ .Values.sentry.service.release }}
value: {{ include "app-config.sentryRelease" . }}
- name: SENTRY_ENVIRONMENT
value: {{ .Values.sentry.service.environment }}
{{- else }}
Expand Down
4 changes: 2 additions & 2 deletions charts/app-config/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -206,9 +206,9 @@ sentry:
# -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
level: ERROR
service:
# -- Name of the sentry service
# -- Name of the service to be displayed in the sentry dashboard
name:
# -- App version of the sentry service
# -- App version to be displayed in the sentry dashboard
release:
# -- Environment of the sentry service
environment: production
Expand Down
2 changes: 1 addition & 1 deletion charts/catalog-server/Chart.yaml
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.6.3
version: 0.7.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
8 changes: 4 additions & 4 deletions charts/catalog-server/README.md
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.6.3](https://img.shields.io/badge/Version-0.6.3-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.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)

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 @@ -98,8 +98,8 @@ A Helm chart for RADAR-base catalogue server. This application creates RADAR-bas
| 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 sentry service |
| sentry.service.release | string | `nil` | App version of the sentry service |
| 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 | `""` | Comma-separated list of package prefixes to be included in the stacktrace |
| sentry.stacktrace.packages | string | `"org.radarbase.schema,org.radarbase.stream"` | Comma-separated list of package prefixes to be included in the stacktrace |
14 changes: 14 additions & 0 deletions charts/catalog-server/templates/_helpers.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,17 @@ Create chart name and version as used by the chart label.
{{- define "catalog-server.saslJaasConfig" -}}
{{- printf "org.apache.kafka.common.security.plain.PlainLoginModule required username='%s' password='%s';" .apiKey .apiSecret | b64enc | quote -}}
{{- end -}}

{{/*
Service name to be used by Sentry
*/}}
{{- define "catalog-server.sentryName" -}}
{{- printf "%s" (include "catalog-server.fullname" .) -}}
{{- end -}}

{{/*
App release to be used by Sentry
*/}}
{{- define "catalog-server.sentryRelease" -}}
{{- printf "%s" .Chart.AppVersion -}}
{{- end -}}
8 changes: 4 additions & 4 deletions charts/catalog-server/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,9 @@ spec:
value: {{ .Values.sentry.stacktrace.packages}}
{{- end }}
- name: SENTRY_NAME
value: {{ .Values.sentry.service.name }}
value: {{ include "catalog-server.sentryName" . }}
- name: SENTRY_RELEASE
value: {{ .Values.sentry.service.release }}
value: {{ include "catalog-server.sentryRelease" . }}
- name: SENTRY_ENVIRONMENT
value: {{ .Values.sentry.service.environment }}
{{- else }}
Expand Down Expand Up @@ -137,9 +137,9 @@ spec:
value: {{ .Values.sentry.stacktrace.packages}}
{{- end }}
- name: SENTRY_NAME
value: {{ .Values.sentry.service.name }}
value: {{ include "catalog-server.sentryName" . }}
- name: SENTRY_RELEASE
value: {{ .Values.sentry.service.release }}
value: {{ include "catalog-server.sentryRelease" . }}
- name: SENTRY_ENVIRONMENT
value: {{ .Values.sentry.service.environment }}
{{- else }}
Expand Down
4 changes: 2 additions & 2 deletions charts/catalog-server/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -257,9 +257,9 @@ sentry:
# -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
level: ERROR
service:
# -- Name of the sentry service
# -- Name of the service to be displayed in the sentry dashboard
name:
# -- App version of the sentry service
# -- App version to be displayed in the sentry dashboard
release:
# -- Environment of the sentry service
environment: production
Expand Down
2 changes: 1 addition & 1 deletion charts/data-dashboard-backend/Chart.yaml
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.3.8
version: 0.4.0
sources: ["https://github.com/thehyve/radar-data-dashboard-backend"]
deprecated: false
type: application
Expand Down
10 changes: 5 additions & 5 deletions charts/data-dashboard-backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# data-dashboard-backend

![Version: 0.3.8](https://img.shields.io/badge/Version-0.3.8-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.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)

API for data in the data dashboard

Expand Down Expand Up @@ -71,8 +71,8 @@ API for data in the data dashboard
| 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 sentry service |
| sentry.service.release | string | `nil` | App version of the sentry service |
| sentry.service.environment | string | `"production"` | Environment of the sentry service |
| 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 | `""` | Comma-separated list of package prefixes to be included in the stacktrace |
| sentry.stacktrace.packages | string | `"org.radarbase.datadashboard,org.radarbase.upload"` | Comma-separated list of package prefixes to be included in the stacktrace |
14 changes: 14 additions & 0 deletions charts/data-dashboard-backend/templates/_helpers.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,17 @@ Selector labels
app.kubernetes.io/name: {{ include "data-dashboard-backend.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
{{- end }}

{{/*
Service name to be used by Sentry
*/}}
{{- define "data-dashboard-backend.sentryName" -}}
{{- printf "%s" (include "data-dashboard-backend.fullname" .) -}}
{{- end -}}

{{/*
App release to be used by Sentry
*/}}
{{- define "data-dashboard-backend.sentryRelease" -}}
{{- printf "%s" .Chart.AppVersion -}}
{{- end -}}
4 changes: 2 additions & 2 deletions charts/data-dashboard-backend/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ spec:
value: {{ .Values.sentry.stacktrace.packages}}
{{- end }}
- name: SENTRY_NAME
value: {{ .Values.sentry.service.name }}
value: {{ include "data-dashboard-backend.sentryName" . }}
- name: SENTRY_RELEASE
value: {{ .Values.sentry.service.release }}
value: {{ include "data-dashboard-backend.sentryRelease" . }}
- name: SENTRY_ENVIRONMENT
value: {{ .Values.sentry.service.environment }}
{{- else }}
Expand Down
6 changes: 3 additions & 3 deletions charts/data-dashboard-backend/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -172,11 +172,11 @@ sentry:
# -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
level: ERROR
service:
# -- Name of the sentry service
# -- Name of the service to be displayed in the sentry dashboard
name:
# -- App version of the sentry service
# -- App version to be displayed in the sentry dashboard
release:
# -- Environment of the sentry service
# -- The environment name for this installation.
environment: production
stacktrace:
# -- Set to true, if stack trace should be enabled
Expand Down
2 changes: 1 addition & 1 deletion charts/management-portal/Chart.yaml
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.3.1
version: 1.4.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
8 changes: 4 additions & 4 deletions charts/management-portal/README.md
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.3.1](https://img.shields.io/badge/Version-1.3.1-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.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)

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

Expand Down Expand Up @@ -108,11 +108,11 @@ A Helm chart for RADAR-Base Management Portal to manage projects and participant
| 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 sentry service |
| sentry.service.release | string | `nil` | App version of the sentry service |
| 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 | `""` | Comma-separated list of package prefixes to be included in the stacktrace |
| 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
14 changes: 14 additions & 0 deletions charts/management-portal/templates/_helpers.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,17 @@ Return true if a secret object should be created
{{- true -}}
{{- end -}}
{{- end -}}

{{/*
Service name to be used by Sentry
*/}}
{{- define "management-portal.sentryName" -}}
{{- printf "%s" (include "management-portal.fullname" .) -}}
{{- end -}}

{{/*
App release to be used by Sentry
*/}}
{{- define "management-portal.sentryRelease" -}}
{{- printf "%s" .Chart.AppVersion -}}
{{- end -}}
4 changes: 2 additions & 2 deletions charts/management-portal/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -154,9 +154,9 @@ spec:
value: {{ .Values.sentry.stacktrace.packages}}
{{- end }}
- name: SENTRY_NAME
value: {{ .Values.sentry.service.name }}
value: {{ include "management-portal.sentryName" . }}
- name: SENTRY_RELEASE
value: {{ .Values.sentry.service.release }}
value: {{ include "management-portal.sentryRelease" . }}
- name: SENTRY_ENVIRONMENT
value: {{ .Values.sentry.service.environment }}
{{- else }}
Expand Down
4 changes: 2 additions & 2 deletions charts/management-portal/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -605,9 +605,9 @@ sentry:
# -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
level: ERROR
service:
# -- Name of the sentry service
# -- Name of the service to be displayed in the sentry dashboard
name:
# -- App version of the sentry service
# -- App version to be displayed in the sentry dashboard
release:
# -- Environment of the sentry service
environment: production
Expand Down
2 changes: 1 addition & 1 deletion charts/radar-appserver/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v2
appVersion: "2.4.3"
description: A Helm chart for the backend application of RADAR-base Appserver
name: radar-appserver
version: 0.7.2
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/radar-appserver
Expand Down
Loading

0 comments on commit 7562af7

Please sign in to comment.