Skip to content

Commit 640222c

Browse files
committed
update docu
1 parent efa6a2e commit 640222c

2 files changed

Lines changed: 14 additions & 3 deletions

File tree

docs/hugo/content/en/crd/crd-postgresql.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,7 @@ key, operator, value, effect and tolerationSeconds |
168168

169169
| Name | Type | required | Description |
170170
| ------------------------------ |:-------:| ---------:| ------------------:|
171+
| customQueries | string | false | Name of the ConfigMap containing custom queries |
171172
| [env](#env) | array | false | Allows you to add custom environment variables to all expoerter-sidecar containers |
172173
| image | string | true | Docker-Image for the metric exporter |
173174

@@ -251,6 +252,8 @@ key, operator, value, effect and tolerationSeconds |
251252
| ------------------------------ |:-------:| ---------:| ------------------:|
252253
| standby_host | string | true | Endpoint of the primary cluster |
253254
| standby_port | string | true | PostgreSQL port of the primary cluster |
255+
| standby_primary_slot_name | string | true | replication slot of the primary cluster |
256+
254257

255258
{{< back >}}
256259

docs/hugo/content/en/monitoring/_index.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ These Stack is based on:
1313

1414
CPO has prepared an own Exporter for the PostgreSQl-Pod which can used as a sidecar.
1515

16+
#### Configure Cluster for monitoring
17+
To deploy a monitoring exporter for Prometheus and create the necessary users and permissions in the cluster, the cluster manifest must be extended to include the `monitor` object.
18+
- `customQueries`: Name of the ConfigMap containing custom queries for PostgreSQL and Prometheus.
19+
- `env`: Additional environment variables for the sidecar container
20+
- `image`: Image for the monitoring sidecar. For example: `containers.cybertec.at/cybertec-pg-container/exporter:rocky9-18.3-2`
21+
22+
{{< hint type=Info >}}The ConfigMap is mounted in the sidecar container. Any additional permissions required for the queries must be manually granted to the monitoring user if necessary.{{< /hint >}}
23+
1624
#### Setting up the Monitoring Stack
1725
To setup the Monitoring-Stack we suggest that you create an own namespace and use the prepared kustomization file inside the Operator-Tutorials.
1826
```
@@ -24,7 +32,7 @@ No resources found in cpo-monitoring namespace.
2432
git clone https://github.com/cybertec-postgresql/CYBERTEC-operator-tutorial
2533
cd CYBERTEC-operator-tutorial/setup/monitoring
2634
27-
# Hint: Please check if youn want to use a specific storage-class the file pvcs.yaml and add your storageclass on the commented part. Please ensure that you removed the comment-char.
35+
{{< hint type=Info >}}Hint: Please check if you want to use a specific storage-class the file pvcs.yaml and add your storageclass on the commented part. Please ensure that you removed the comment-char.{{< /hint >}}
2836
2937
$ kubectl apply -n cpo-monitoring -k .
3038
serviceaccount/cpo-monitoring created
@@ -47,9 +55,9 @@ deployment.apps/cpo-monitoring-alertmanager created
4755
deployment.apps/cpo-monitoring-grafana created
4856
deployment.apps/cpo-monitoring-prometheus created
4957
50-
Hint: If you're not running Openshift you will get a error like this:
58+
{{< hint type=Info >}}Hint: If you're not running Openshift you will get a error like this:
5159
error: resource mapping not found for name: "grafana" namespace: "" from ".":
52-
no matches for kind "Route" in version "route.openshift.io/v1" ensure CRDs are installed first
60+
no matches for kind "Route" in version "route.openshift.io/v1" ensure CRDs are installed first{{< /hint >}}
5361
5462
You can ignore this, because it depends on an object with the type route which is part of Openshift.
5563
It is not needed replaced by ingress-rules or an loadbalancer-service.

0 commit comments

Comments
 (0)