sheppy/opendesk
1
0
Fork 0
mirror of https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk.git synced 2025-12-07 07:51:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Overall fixes improvements

Browse Source
This commit is contained in:
Ben Schlagbauer
2025-03-20 16:04:20 +01:00
committed by Thorsten Roßner
parent c1f19131d9
commit d444d24489
27 changed files with 625 additions and 631 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/monitoring.md
View File

@@ -6,7 +6,7 @@ SPDX-License-Identifier: Apache-2.0
<h1>Monitoring</h1>
This document will cover how you can enable observability with Prometheus-based monitoring and Grafana dashboards as
well as the overall status of monitoring integration.
well as the overall status of the monitoring integration.
<!-- TOC -->
* [Technology](#technology)
@@ -19,12 +19,11 @@ well as the overall status of monitoring integration.
# Technology
We provide integration into the Prometheus-based monitoring.
Together with
[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) you
easily leverage the full potential of the open-source cloud-native observability stack.
openDesk includes integration with Prometheus-based monitoring.
Before enabling the following options, you need to install the respective CRDs from the kube-prometheus-stack
Together with [kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack), you can easily leverage the full potential of the open-source cloud-native observability stack.
Before enabling the following options, you need to install the respective custom resource definitions (CRDs) from the kube-prometheus-stack
repository or Prometheus operator.
# Defaults
@@ -38,10 +37,10 @@ To deploy `podMonitor` and `serviceMonitor` custom resources, enable it by:
```yaml
prometheus:
  serviceMonitors:
    enabled: true
  podMonitors:
    enabled: true
serviceMonitors:
enabled: true
podMonitors:
enabled: true
```
# Alerts
@@ -53,25 +52,25 @@ All alert rules are deployed as [PrometheusRule](https://prometheus-operator.dev
```yaml
prometheus:
  prometheusRules:
    enabled: true
prometheusRules:
enabled: true
```
# Dashboards for Grafana
To deploy optional ConfigMaps with Grafana dashboards, enable it by:
To deploy optional Grafana dashboards with ConfigMaps, enable the functionality with:
```yaml
grafana:
  dashboards:
    enabled: true
dashboards:
enabled: true
```
Please find the details in the [related Helm chart](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-dashboards).
Please find further details in the [related Helm chart](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-dashboards).
# Component overview
| Component | Metrics (pod- or serviceMonitor)  | Alerts (prometheusRule) | Dashboard (Grafana) |
|:----------|-----------------------------------|-------------------------|---------------------|
| Collabora | :white_check_mark:                | :white_check_mark:      | :white_check_mark:  |
| Nextcloud | :white_check_mark:                | :x:                     | :x:                 |
| Component | Metrics (pod- or serviceMonitor) | Alerts (prometheusRule) | Dashboard (Grafana) |
|:----------|----------------------------------|-------------------------|---------------------|
| Collabora | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Nextcloud | :white_check_mark: | :x: | :x: |