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

fix: simple doc updates #123

Merged
merged 1 commit into from
Mar 7, 2024
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
7 changes: 7 additions & 0 deletions docs/infrastructure-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,10 @@ The full scale Genestack infrastructure is bound to change over time, however, t
!!! tip

The infrastructure deployment can almost all be run in parallel. The above demo does everything serially to keep things consistent and easy to understand but if you just need to get things done, feel free to do it all at once.

## Deployment choices

When you're building the cloud, many of the underlying infrastructure components have a deployment choice of `base` or `aio`.

* `base` creates a production-ready environment that ensures an HA system is deployed across the hardware available in your cloud.
* `aio` creates a minimal cloud environment which is suitable for test, which may have low resources.
12 changes: 6 additions & 6 deletions docs/prometheus-mysql-exporter.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
## Mariadb Exporter
# Mariadb Exporter

Mysql Exporter is used to expose metrics from a running mysql/mariadb server. The type of metrics exposed is controlled
by the exporter and expressed in values.yaml file.

## Installation

First create secret containing password for monitoring user
```

``` shell
kubectl --namespace openstack \
create secret generic mariadb-monitoring \
--type Opaque \
Expand All @@ -16,10 +17,9 @@ kubectl --namespace openstack \

Next, install the exporter

```
cd /opt/genestack/kustomize/prometheus-mysql-exporter

kubectl kustomize --enable-helm . | kubectl create -n openstack -f -
``` shell
kubectl kustomize --enable-helm /opt/genestack/kustomize/prometheus-mysql-exporter | \
kubectl -n openstack apply --server-side -f -
```

If the installation is successful, you should see the exporter pod in openstack namespace.
15 changes: 11 additions & 4 deletions docs/prometheus-openstack-metrics-exporter.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
## Openstack MetricsExporter
# Openstack MetricsExporter

We are using Prometheus for monitoring and metrics collection backend along with the openstack exporter to gather openstack resource metrics
For more information see: https://prometheus.io and https://github.com/openstack-exporter/openstack-exporter

## Deploy the Prometheus Openstack Exporter

### Create clouds-yaml secret

Modify genestack/helm-configs/monitoring/openstack-metrics-exporter/clouds-yaml with the appropriate settings and create the secret.

```shell
kubectl create secret generic clouds-yaml-secret --from-file /opt/genestack/helm-configs/monitoring/openstack-metrics-exporter/clouds-yaml
!!! tip

See the [documentation](openstack-clouds.md) on generating your own `clouds.yaml` file which can be used to populate the monitoring configuration file.

``` shell
kubectl create secret generic clouds-yaml-secret \
--from-file /opt/genestack/helm-configs/monitoring/openstack-metrics-exporter/clouds-yaml
```

### Install openstack-metrics-exporter helm chart
```shell

``` shell
cd /opt/genestack/submodules/openstack-exporter/helm-charts/charts

helm upgrade --install os-metrics ./prometheus-openstack-exporter \
Expand Down
11 changes: 5 additions & 6 deletions docs/prometheus-rabbitmq-exporter.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
## RabbitMQ Exporter
# RabbitMQ Exporter

RabbitMQ Exporter is used to expose metrics from a running rabbitMQ deployment.

## Installation

Next, install the exporter
Install the RabbitMQ Exporter

```
cd /opt/genestack/kustomize/prometheus-rabbitmq-exporter

kubectl kustomize --enable-helm . | kubectl create -n openstack -f -
``` shell
kubectl kustomize --enable-helm /opt/genestack/kustomize/prometheus-rabbitmq-exporter | \
kubectl -n openstack apply --server-side -f -
```

If the installation is successful, you should see the exporter pod in openstack namespace.
Loading