Compare commits

...

3 Commits

Author SHA1 Message Date
Daniel Gerber
dcddc73785 docs(getting-started.md): Update section "DNS" 2025-12-08 11:45:11 +01:00
Daniel Gerber
8867d1b204 docs(getting-started.md): AAAA record on base domain is optional 2025-12-03 15:44:05 +00:00
Lilly Sell
cca755d4af docs(monitoring.md): Correct references and wordings in monitoring documentation 2025-12-03 15:56:36 +01:00
2 changed files with 24 additions and 17 deletions

View File

@@ -60,12 +60,14 @@ For the following guide, we will use `dev` as environment where variables can be
## DNS ## DNS
The deployment is designed to deploy each application/service under a dedicated subdomain. The deployment is designed to deploy each application/service under a dedicated subdomain.
For your convenience, we recommend creating a `*.domain.tld` A-Record for your cluster Ingress Controller; otherwise, you must create an A-Record for each subdomain. For your convenience, we recommend creating a `*.domain.tld` A/AAAA-Record for your cluster Ingress Controller; otherwise, you must create an A/AAAA-Record for each subdomain.
| Record name | Type | Value | Additional information | | Record name | Type | Value | Additional information |
|-------------------------------|------|----------------------------------------------------|-------------------------------------------------------------------| |-------------------------------|------|----------------------------------------------------|-------------------------------------------------------------------|
| domain.tld | A | IPv4 address of your Ingress Controller | |
| domain.tld | AAAA | IPv6 address of your Ingress Controller | Optional |
| *.domain.tld | A | IPv4 address of your Ingress Controller | | | *.domain.tld | A | IPv4 address of your Ingress Controller | |
| *.domain.tld | AAAA | IPv6 address of your Ingress Controller | | | *.domain.tld | AAAA | IPv6 address of your Ingress Controller | Optional |
| mail.domain.tld | A | IPv4 address of your postfix NodePort/LoadBalancer | Optional, mail should directly be delivered to openDesk's Postfix | | mail.domain.tld | A | IPv4 address of your postfix NodePort/LoadBalancer | Optional, mail should directly be delivered to openDesk's Postfix |
| mail.domain.tld | AAAA | IPv6 address of your postfix NodePort/LoadBalancer | Optional, mail should directly be delivered to openDesk's Postfix | | mail.domain.tld | AAAA | IPv6 address of your postfix NodePort/LoadBalancer | Optional, mail should directly be delivered to openDesk's Postfix |
| domain.tld | MX | `10 mail.domain.tld` | | | domain.tld | MX | `10 mail.domain.tld` | |

View File

@@ -23,8 +23,7 @@ openDesk includes integration with Prometheus-based monitoring.
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. 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 Before enabling the following options, you need to install the respective custom resource definitions (CRDs) from the kube-prometheus-stack repository which should at least include the Prometheus Operator.
repository or Prometheus operator.
# Defaults # Defaults
@@ -33,14 +32,16 @@ All configurable options and their defaults can be found in
# Metrics # Metrics
To deploy `podMonitor` and `serviceMonitor` custom resources, enable it by: To deploy `podMonitor` and `serviceMonitor` custom resources, enable them by:
```yaml ```yaml
prometheus: monitoring:
serviceMonitors: prometheus:
enabled: true serviceMonitors:
podMonitors: enabled: true
enabled: true podMonitors:
enabled: true
```
``` ```
# Alerts # Alerts
@@ -51,19 +52,23 @@ Some of these are created by our partners while others are defined in [opendesk-
All alert rules are deployed as [PrometheusRule](https://prometheus-operator.dev/docs/api-reference/api/#monitoring.coreos.com/v1.PrometheusRule) and can be enabled like this: All alert rules are deployed as [PrometheusRule](https://prometheus-operator.dev/docs/api-reference/api/#monitoring.coreos.com/v1.PrometheusRule) and can be enabled like this:
```yaml ```yaml
prometheus: monitoring:
prometheusRules: prometheus:
enabled: true prometheusRules:
enabled: true
``` ```
# Dashboards for Grafana # Dashboards for Grafana
To deploy optional Grafana dashboards with ConfigMaps, enable the functionality with: If your Grafana instance is deployed via kube-prometheus-stack, or you have deployed the [Sidecar for datasources](https://github.com/grafana/helm-charts/blob/main/charts/grafana/README.md#sidecar-for-datasources), openDesk can make dashboards available via ConfigMap resources.
Enable the functionality with the following snippet:
```yaml ```yaml
grafana: monitoring:
dashboards: grafana:
enabled: true dashboards:
enabled: true
``` ```
Please find further 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).