From 097f640bbb57d6bdadf4f18f6ce83746f1db59ef Mon Sep 17 00:00:00 2001 From: Alexander Trost Date: Fri, 7 Dec 2018 12:42:04 +0100 Subject: [PATCH] doc: rename monitoring doc for Ceph doc: move Ceph mon example files to ceph example subfolder Signed-off-by: Alexander Trost --- Documentation/ceph-dashboard.md | 2 +- .../{monitoring.md => ceph-monitoring.md} | 14 +++++++------- Documentation/ceph-quickstart.md | 2 +- Documentation/development-flow.md | 2 +- .../{ => ceph}/monitoring/prometheus-service.yaml | 0 .../{ => ceph}/monitoring/prometheus.yaml | 0 .../{ => ceph}/monitoring/service-monitor.yaml | 0 7 files changed, 10 insertions(+), 10 deletions(-) rename Documentation/{monitoring.md => ceph-monitoring.md} (91%) rename cluster/examples/kubernetes/{ => ceph}/monitoring/prometheus-service.yaml (100%) rename cluster/examples/kubernetes/{ => ceph}/monitoring/prometheus.yaml (100%) rename cluster/examples/kubernetes/{ => ceph}/monitoring/service-monitor.yaml (100%) diff --git a/Documentation/ceph-dashboard.md b/Documentation/ceph-dashboard.md index bc3281097..81d305225 100755 --- a/Documentation/ceph-dashboard.md +++ b/Documentation/ceph-dashboard.md @@ -35,7 +35,7 @@ rook-ceph-mgr ClusterIP 10.108.111.192 9283/TCP rook-ceph-mgr-dashboard ClusterIP 10.110.113.240 8443/TCP 3h ``` -The first service is for reporting the [Prometheus metrics](monitoring.md), while the latter service is for the dashboard. +The first service is for reporting the [Prometheus metrics](ceph-monitoring.md), while the latter service is for the dashboard. If you are on a node in the cluster, you will be able to connect to the dashboard by using either the DNS name of the service at `https://rook-ceph-mgr-dashboard-https:8443` or by connecting to the cluster IP, in this example at `https://10.110.113.240:8443`. diff --git a/Documentation/monitoring.md b/Documentation/ceph-monitoring.md similarity index 91% rename from Documentation/monitoring.md rename to Documentation/ceph-monitoring.md index 630a8c1af..b5f63e03c 100644 --- a/Documentation/monitoring.md +++ b/Documentation/ceph-monitoring.md @@ -1,11 +1,12 @@ --- title: Monitoring -weight: 45 +weight: 27 +indent: true --- # Monitoring -Each Rook cluster has some built in metrics collectors/exporters for monitoring with [Prometheus](https://prometheus.io/). +Each Rook Ceph cluster has some built in metrics collectors/exporters for monitoring with [Prometheus](https://prometheus.io/). If you do not have Prometheus running, follow the steps below to enable monitoring of Rook. If your cluster already contains a Prometheus instance, it will automatically discover Rooks scrape endpoint using the standard `prometheus.io/scrape` and `prometheus.io/port` annotations. @@ -14,9 +15,9 @@ contains a Prometheus instance, it will automatically discover Rooks scrape endp ## Prometheus Operator First the Prometheus operator needs to be started in the cluster so it can watch for our requests to start monitoring Rook and respond by deploying the correct Prometheus pods and configuration. -A full explanation can be found in the [Prometheus operator repository on github](https://github.com/coreos/prometheus-operator), but the quick instructions can be found here: +A full explanation can be found in the [Prometheus operator repository on GitHub](https://github.com/coreos/prometheus-operator), but the quick instructions can be found here: ```bash -kubectl apply -f https://raw.githubusercontent.com/coreos/prometheus-operator/release-0.15/bundle.yaml +kubectl apply -f https://raw.githubusercontent.com/coreos/prometheus-operator/v0.26.0/bundle.yaml ``` This will start the Prometheus operator, but before moving on, wait until the operator is in the `Running` state: ```bash @@ -29,7 +30,7 @@ Once the Prometheus operator is in the `Running` state, proceed to the next sect With the Prometheus operator running, we can create a service monitor that will watch the Rook cluster and collect metrics regularly. From the root of your locally cloned Rook repo, go the monitoring directory: ```bash -cd cluster/examples/kubernetes/monitoring +cd cluster/examples/kubernetes/ceph/monitoring ``` Create the service monitor as well as the Prometheus server pod and service: @@ -96,8 +97,7 @@ To clean up all the artifacts created by the monitoring walkthrough, copy/paste kubectl delete -f service-monitor.yaml kubectl delete -f prometheus.yaml kubectl delete -f prometheus-service.yaml -kubectl -n rook-ceph delete statefulset prometheus-rook-prometheus -kubectl delete -f https://raw.githubusercontent.com/coreos/prometheus-operator/release-0.8/bundle.yaml +kubectl delete -f https://raw.githubusercontent.com/coreos/prometheus-operator/v0.26.0/bundle.yaml ``` Then the rest of the instructions in the [Prometheus Operator docs](https://github.com/coreos/prometheus-operator#removal) can be followed to finish cleaning up. diff --git a/Documentation/ceph-quickstart.md b/Documentation/ceph-quickstart.md index 9f14a3d13..25abd6c0c 100644 --- a/Documentation/ceph-quickstart.md +++ b/Documentation/ceph-quickstart.md @@ -271,7 +271,7 @@ We have created a toolbox container that contains the full suite of Ceph clients # Monitoring Each Rook cluster has some built in metrics collectors/exporters for monitoring with [Prometheus](https://prometheus.io/). -To learn how to set up monitoring for your Rook cluster, you can follow the steps in the [monitoring guide](./monitoring.md). +To learn how to set up monitoring for your Rook cluster, you can follow the steps in the [monitoring guide](./ceph-monitoring.md). # Teardown diff --git a/Documentation/development-flow.md b/Documentation/development-flow.md index fac86667f..774eba187 100644 --- a/Documentation/development-flow.md +++ b/Documentation/development-flow.md @@ -31,7 +31,7 @@ mkdir -p $GOPATH/src/github.com/rook # Navigate to the local repo path and clone your fork cd $GOPATH/src/github.com/rook -# Clone your fork, where is your github account name +# Clone your fork, where is your GitHub account name git clone https://github.com//rook.git cd rook diff --git a/cluster/examples/kubernetes/monitoring/prometheus-service.yaml b/cluster/examples/kubernetes/ceph/monitoring/prometheus-service.yaml similarity index 100% rename from cluster/examples/kubernetes/monitoring/prometheus-service.yaml rename to cluster/examples/kubernetes/ceph/monitoring/prometheus-service.yaml diff --git a/cluster/examples/kubernetes/monitoring/prometheus.yaml b/cluster/examples/kubernetes/ceph/monitoring/prometheus.yaml similarity index 100% rename from cluster/examples/kubernetes/monitoring/prometheus.yaml rename to cluster/examples/kubernetes/ceph/monitoring/prometheus.yaml diff --git a/cluster/examples/kubernetes/monitoring/service-monitor.yaml b/cluster/examples/kubernetes/ceph/monitoring/service-monitor.yaml similarity index 100% rename from cluster/examples/kubernetes/monitoring/service-monitor.yaml rename to cluster/examples/kubernetes/ceph/monitoring/service-monitor.yaml