From 4668af7b169a884d691c639399ecd4fa1e74ec63 Mon Sep 17 00:00:00 2001 From: Kevin Carter Date: Thu, 7 Mar 2024 00:22:50 -0600 Subject: [PATCH] fix: simple doc updates Signed-off-by: Kevin Carter --- docs/infrastructure-overview.md | 7 +++++++ docs/prometheus-mysql-exporter.md | 12 ++++++------ docs/prometheus-openstack-metrics-exporter.md | 15 +++++++++++---- docs/prometheus-rabbitmq-exporter.md | 11 +++++------ docs/prometheus.md | 4 +--- 5 files changed, 30 insertions(+), 19 deletions(-) diff --git a/docs/infrastructure-overview.md b/docs/infrastructure-overview.md index ba4ca138..8fd64b3e 100644 --- a/docs/infrastructure-overview.md +++ b/docs/infrastructure-overview.md @@ -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. diff --git a/docs/prometheus-mysql-exporter.md b/docs/prometheus-mysql-exporter.md index de69bbfe..8352ced3 100644 --- a/docs/prometheus-mysql-exporter.md +++ b/docs/prometheus-mysql-exporter.md @@ -1,4 +1,4 @@ -## 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. @@ -6,7 +6,8 @@ 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 \ @@ -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. diff --git a/docs/prometheus-openstack-metrics-exporter.md b/docs/prometheus-openstack-metrics-exporter.md index fed12da8..acdbe795 100644 --- a/docs/prometheus-openstack-metrics-exporter.md +++ b/docs/prometheus-openstack-metrics-exporter.md @@ -1,4 +1,4 @@ -## 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 @@ -6,14 +6,21 @@ For more information see: https://prometheus.io and https://github.com/openstack ## 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 \ diff --git a/docs/prometheus-rabbitmq-exporter.md b/docs/prometheus-rabbitmq-exporter.md index 9152ad0f..7d69bc2a 100644 --- a/docs/prometheus-rabbitmq-exporter.md +++ b/docs/prometheus-rabbitmq-exporter.md @@ -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. diff --git a/docs/prometheus.md b/docs/prometheus.md index de5973bf..67e1b4ce 100644 --- a/docs/prometheus.md +++ b/docs/prometheus.md @@ -6,7 +6,5 @@ To read more about Prometheus see: https://prometheus.io #### Install kube-prometheus helm chart ``` shell -cd /opt/genestack/kustomize/prometheus - -kubectl kustomize --enable-helm . | kubectl create -f - +kubectl kustomize --enable-helm /opt/genestack/kustomize/prometheus | kubectl apply --server-side -f - ```