Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: document deploying the memcached exporter #755

Merged
merged 1 commit into from
Feb 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/helm-memcached.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ jobs:
matrix:
overlays:
- base
- base-monitoring
- aio
name: Helm
runs-on: ubuntu-latest
Expand Down
23 changes: 0 additions & 23 deletions base-kustomize/memcached/base-monitoring/kustomization.yaml

This file was deleted.

8 changes: 4 additions & 4 deletions docs/infrastructure-memcached.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@

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

!!! note

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)).

View the [memcached exporter](prometheus-memcached-exporter.md) instructions to install a HA ready memcached cluster with monitoring and metric collection enabled.

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

This is a shared secret that is distributed to all services that require it. Rotating this value means updating all services.

!!! Genestack

For more information on how to enable memcached monitoring with prometheus, see the [memcached exporter](prometheus-monitoring-overview.md) documentation.
29 changes: 16 additions & 13 deletions docs/prometheus-memcached-exporter.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,28 @@
# Memcached Exporter

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

!!! note

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

## Installation
## Deploy the Memcached Cluster With Monitoring Enabled

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

!!! note

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.
``` yaml
metrics:
enabled: true
serviceMonitor:
enabled: true
```

### Deploy the Memcached Cluster With Monitoring Enabled
Once the changes have been made, apply the changes to the memcached deployment with the `bin/install-memcached.sh` script:

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

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