Skip to content

Commit 46ae43c

Browse files
committed
chore: document deploying the memcached exporter
Signed-off-by: Kevin Carter <[email protected]>
1 parent 005c267 commit 46ae43c

File tree

3 files changed

+18
-36
lines changed

3 files changed

+18
-36
lines changed

base-kustomize/memcached/base-monitoring/kustomization.yaml

-23
This file was deleted.

docs/infrastructure-memcached.md

+2
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,5 @@ kubectl --namespace openstack \
3838
!!! Note
3939

4040
This is a shared secret that is distributed to all services that require it. Rotating this value means updating all services.
41+
42+
For more information on how to enable memcached monitoring with prometheus, see the [memcached exporter](prometheus-monitoring-overview.md) documentation.

docs/prometheus-memcached-exporter.md

+16-13
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
11
# Memcached Exporter
22

3-
Memcached Exporter is used to expose metrics from a running Memcached deployment.
3+
Memcached Exporter is used to expose metrics from a running Memcached deployment. The memcached exporter is an integrated part
4+
of the memcached deployment in Genestack but will need to be enabled.
45

56
!!! note
67

78
To deploy metric exporters you will first need to deploy the Prometheus Operator, see: ([Deploy Prometheus](prometheus.md)).
89

9-
## Installation
10+
## Deploy the Memcached Cluster With Monitoring Enabled
1011

11-
Install the Memcached Exporter
12+
Edit the Helm overrides file for memcached at `/etc/genestack/helm-configs/memcached/memcached-helm-overrides.yaml` and add the following values
13+
to enable the memcached exporter:
1214

13-
!!! note
14-
15-
Following this installation step will also deploy [memcached](infrastructure-memcached.md) in a HA production ready cluster that includes monitoring via the metric exporters. If memcached is already installed running this will simply enable the exporters which allows Prometheus to begin scraping the memcached service.
15+
``` yaml
16+
metrics:
17+
enabled: true
18+
serviceMonitor:
19+
enabled: true
20+
```
1621
17-
### Deploy the Memcached Cluster With Monitoring Enabled
22+
Once the changes have been made, apply the changes to the memcached deployment with the `bin/install-memcached.sh` script:
1823

19-
``` shell
20-
kubectl kustomize --enable-helm /etc/genestack/kustomize/memcached/base-monitoring | \
21-
kubectl apply --namespace openstack --server-side -f -
22-
```
24+
!!! example "`bin/install-memcached.sh`"
2325

24-
!!! success
25-
If the installation is successful, you should see the exporter pod in the openstack namespace.
26+
``` shell
27+
--8<-- "bin/install-memcached.sh"
28+
```

0 commit comments

Comments
 (0)