Skip to content

Commit 67063c2

Browse files
authored
chore: document deploying the memcached exporter (#755)
Signed-off-by: Kevin Carter <[email protected]>
1 parent 005c267 commit 67063c2

File tree

4 files changed

+20
-41
lines changed

4 files changed

+20
-41
lines changed

.github/workflows/helm-memcached.yaml

-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ jobs:
1212
matrix:
1313
overlays:
1414
- base
15-
- base-monitoring
1615
- aio
1716
name: Helm
1817
runs-on: ubuntu-latest

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

-23
This file was deleted.

docs/infrastructure-memcached.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,6 @@
1414

1515
### Alternative - Deploy the Memcached Cluster With Monitoring Enabled
1616

17-
!!! note
18-
19-
Memcached has a base-monitoring configuration which is HA and production ready that also includes a metrics exporter for prometheus metrics collection. If you'd like to have monitoring enabled for your memcached cluster ensure the prometheus operator is installed first ([Deploy Prometheus](prometheus.md)).
20-
2117
View the [memcached exporter](prometheus-memcached-exporter.md) instructions to install a HA ready memcached cluster with monitoring and metric collection enabled.
2218

2319
## Verify readiness with the following command
@@ -38,3 +34,7 @@ kubectl --namespace openstack \
3834
!!! Note
3935

4036
This is a shared secret that is distributed to all services that require it. Rotating this value means updating all services.
37+
38+
!!! Genestack
39+
40+
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)