diff options
author | Eddie Arrage <eddie.arrage@huawei.com> | 2018-04-25 21:19:29 +0000 |
---|---|---|
committer | Eddie Arrage <eddie.arrage@huawei.com> | 2018-04-25 21:23:52 +0000 |
commit | 757216df68b1bc7c49384b0aa65392896c06393b (patch) | |
tree | af9726f04e85d67ae6f080dd7202be13ec47af41 /docs/monitoring.rst | |
parent | dc27eb3f6db07e68fc49661692bb6111a4fe4f5c (diff) |
Add index and cleanup design docs on stable/fraser
- Add toplevel index to design docs on stable/fraser
- Add headers to each of the design docs
- Added usage of Clover container to install Jaeger/Prometheus
in combination in tracing and monitoring docs
- Minor edits including removing TODO/TBD
Change-Id: I1a33544a5b3d6be4147810ef9472b8d72cdec28c
Signed-off-by: Eddie Arrage <eddie.arrage@huawei.com>
Diffstat (limited to 'docs/monitoring.rst')
-rw-r--r-- | docs/monitoring.rst | 30 |
1 files changed, 22 insertions, 8 deletions
diff --git a/docs/monitoring.rst b/docs/monitoring.rst index 44b01e3..76c19b6 100644 --- a/docs/monitoring.rst +++ b/docs/monitoring.rst @@ -1,3 +1,10 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Authors of Clover + +.. _monitoring: + ########## Monitoring ########## @@ -6,26 +13,33 @@ Monitoring Installation ************ -Currently, we use the Istio build-in prometheus addon to install prometheus:: +Currently, we use the Istio built-in Prometheus add-on to install Prometheus:: cd <istio-release-path> kubectl apply -f install/kubernetes/addons/prometheus.yaml + +Alternatively, both Prometheus and Jaeger can be installed in combination with the +Clover container using the command:: + + $ sudo docker run --rm \ + -v ~/.kube/config:/root/.kube/config \ + opnfv/clover \ + /bin/bash -c '/home/opnfv/repos/clover/samples/scenarios/view.sh' + ******** Validate ******** -Setup port-forwarding for prometheus by executing the following command:: +Setup port-forwarding for Prometheus by executing the following command:: kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=prometheus -o jsonpath='{.items[0].metadata.name}') 9090:9090 & -Run the scripts in ``clover/monitoring`` validates prometheus installation:: +Run the scripts in ``clover/monitoring`` to validate the Prometheus installation:: python clover/monitoring/validate.py -It validates the installation with the following criterias +It validates the installation with the following criteria: -#. [DONE] prometheus pod is in Running state -#. [DONE] prometheus is conneted to monitoring targets -#. [TODO] test collecting telemetry data from istio -#. [TODO] TBD +#. Prometheus pod is in running state +#. Prometheus is connected to monitoring targets |