Skip to content

Commit 1f75618

Browse files
jmckulkandrewlecuyer
authored andcommitted
Adds guidance docs to upgrade from old metrics
1 parent 7ef89de commit 1f75618

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

docs/content/Upgrade/metrics.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
title: Monitoring Upgrade Guidance
3+
date:
4+
draft: false
5+
weight: 100
6+
---
7+
8+
# Upgrade Guidance for PostgreSQL Operator Monitoring
9+
10+
## Migration to Upstream Containers
11+
12+
The Crunchy PostgreSQL Monitoring infrastructure now uses upstream Prometheus and Grafana
13+
containers. By default the installers will deploy the monitoring infrastructure using
14+
images from Docker Hub but can easily be updated to point to a Red Hat certified
15+
container repository. The Red Hat certified image catalog can be found
16+
[here](https://catalog.redhat.com/software/containers/explore) and the Docker Hub
17+
images can be found at the following links:
18+
19+
- https://hub.docker.com/r/prom/prometheus
20+
- https://hub.docker.com/r/grafana/grafana
21+
- https://hub.docker.com/r/prom/alertmanager
22+
23+
These containers are configurable through Kubernetes ConfigMaps and the updated
24+
PostgreSQL Operator Monitoring installers. Once deployed Prometheus and Grafana
25+
will be populated with resource data from metrics-enabled PostgreSQL clusters.
26+
27+
## New Monitoring Features
28+
29+
### Alerting
30+
The updated PostgreSQL Operator Monitoring Infrastructure supports deployment of
31+
Prometheus Alertmanager. This deployment uses upstream Prometheus
32+
Alertmanager images that can be installed and configured with the metrics
33+
installers and Kubernetes ConfigMaps.
34+
35+
### Updated pgMonitor
36+
Prometheus and Grafana have been updated to include a default configuration from
37+
[pgMonitor](https://github.com/CrunchyData/pgmonitor) that is tailored for
38+
container-based PostgreSQL deployments. This updated configuration will show
39+
container specific resource information from your metrics-enabled PostgreSQL
40+
clusters. By default the metrics infrastructure will include:
41+
42+
- New Grafana dashboards tailored for container-based PostgreSQL deployments
43+
- Container specific operating system metrics
44+
- General PostgreSQL alerting rules.
45+
46+
### Updated Monitoring Installer
47+
The installer for the PostgreSQL Operating Monitoring infrastructure has been
48+
split out into a separate set of installers. With each installer
49+
([Ansible]({{< relref "/installation/metrics/other/ansible" >}}),
50+
a [Kubectl job]({{< relref "installation/metrics/postgres-operator-metrics" >}}),
51+
or [Helm]({{< relref "/installation/metrics/other/helm-metrics" >}}))
52+
you will be able to apply custom configurations through Kubernetes
53+
ConfigMaps. This includes:
54+
55+
- Custom Grafana dashboards and datasources
56+
- Custom Prometheus scrape configuration
57+
- Custom Prometheus alerting rules
58+
- Custom Alertmanager notification configuration
59+
60+
## Updating from Pre-4.5.0 Monitoring
61+
62+
Ensure that you have a copy of any install or custom configurations you have
63+
applied to your previous metrics install.
64+
65+
You can upgrade the Grafana and Prometheus deployments in place by using the new
66+
installers. After you have updated the PostgreSQL Operator and configured the
67+
`values.yaml`, run the
68+
[metrics update]({{< relref "/installation/metrics/other/ansible/updating-metrics" >}}).
69+
This will replace the old deployments while keeping your pvcs in place.
70+
71+
{{% notice tip %}}
72+
To make use of the updated exporter queries you must update
73+
the PostgreSQL Operator and
74+
[upgrade]({{< relref "/upgrade/automatedupgrade" >}})
75+
your cluster.
76+
{{% /notice %}}
77+
78+

0 commit comments

Comments
 (0)