Add documentation to install prometheus and grafana #2912

aledbf · 2018-08-08T03:07:04Z

No description provided.

codecov-io · 2018-08-08T03:29:55Z

Codecov Report

Merging #2912 into master will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #2912      +/-   ##
==========================================
+ Coverage   47.57%   47.59%   +0.01%     
==========================================
  Files          77       77              
  Lines        5528     5528              
==========================================
+ Hits         2630     2631       +1     
+ Misses       2559     2557       -2     
- Partials      339      340       +1

Impacted Files	Coverage Δ
internal/watch/file_watcher.go	`84.61% <0%> (+3.84%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c141e2b...322dae6. Read the comment docs.

antoineco

Mostly grammar comments

antoineco · 2018-08-08T07:16:17Z

docs/user-guide/monitoring.md

@@ -0,0 +1,161 @@
+# Prometheus and Grafana installation
+
+This tutorial will show you how to install [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/) for the metric scraping from the NGINX Ingress controller.


"for scraping the metrics of" sounds better to me

antoineco · 2018-08-08T07:20:52Z

docs/user-guide/monitoring.md

+
+## Before You Begin
+
+Now, deploy the Ingress controller following the instructions [here](../deploy/index.md).


Since it's a prerequisite I'd change the imperative form "Now, ..." to "The NGINX Ingress controller should already be deployed according to the deployment instructions. See [Deployment] (...)"

antoineco · 2018-08-08T07:23:57Z

docs/user-guide/monitoring.md

+
+Now, deploy the Ingress controller following the instructions [here](../deploy/index.md).
+
+Note that the yaml files that are used in this tutorial, stored in [deploy/monitoring](https://github.com/kubernetes/ingress-nginx/tree/master/deploy/monitoring) folder in GitHub repository [kubernetes/ingress-nginx](https://github.com/kubernetes/ingress-nginx).


", stored ..." -> "are stored in the ... folder of the GitHub repository"

antoineco · 2018-08-08T07:26:59Z

docs/user-guide/monitoring.md

+Note that the yaml files that are used in this tutorial, stored in [deploy/monitoring](https://github.com/kubernetes/ingress-nginx/tree/master/deploy/monitoring) folder in GitHub repository [kubernetes/ingress-nginx](https://github.com/kubernetes/ingress-nginx).
+
+## Deploy and configure Prometheus Server
+


"is needed to configure so that it can ..." -> "must be configured so that it can discover the Services endpoints."

"running in the cluster"

"no extra configuration is needed"

antoineco · 2018-08-08T07:30:55Z

docs/user-guide/monitoring.md

+## Deploy and configure Prometheus Server
+
+The Prometheus server is needed to configure so that it can discover endpoints of services. If a Prometheus server is already running in cluster and if it is configured in a way that it can discover service endpoints, no extra configuration will be needed.
+If there is no existing Prometheus server running, rest of this tutorial will create a Prometheus server with appropriate configuration.


"the rest of this tutorial will guide you through the step needed to deploy a properly configured Prometheus server."

antoineco · 2018-08-08T07:37:02Z

docs/user-guide/monitoring.md

+
+### Prometheus Dashboard
+
+Now to open prometheus dashboard on Browser:


"the Prometheus dashboard in a web browser"

antoineco · 2018-08-08T07:41:03Z

docs/user-guide/monitoring.md

+10.192.0.2 10.192.0.3 10.192.0.4
+```
+
+Now, open your browser and go to the following URL: _http://{node IP address}:{prometheus-svc-nodeport}_ to visit Prometheus Dashboard.


All instructions steps start with "Now, ". It would sound better to me with if sentences simply started with a verb (eg. "Open this", "Obtain that"), but just a personal note.

"the Prometheus dashboard"

"visit the following URL"

antoineco · 2018-08-08T07:43:56Z

docs/user-guide/monitoring.md

+          emptyDir: {}
+```
+
+Now, run the following command to deploy prometheus in kubernetes:


P rometheus
K ubernetes

antoineco · 2018-08-08T07:50:05Z

docs/user-guide/monitoring.md

+Now obtain the IP address of the nodes in the cluster running:
+
+```console
+$ kubectl get nodes --selector=kubernetes.io/role!=master -o jsonpath={.items[*].status.addresses[?\(@.type==\"InternalIP\"\)].address}


This is super fancy 👍 But for a documentation page, which is supposed to be as clear as possible to all kind of users, wouldn't get nodes be sufficient?

antoineco · 2018-08-08T07:51:28Z

docs/user-guide/monitoring.md

+grafana                NodePort    10.98.233.86    <none>        9090:31086/TCP                               10m
+```
+
+Now, open your browser and go to the following URL: _http://{node IP address}:{prometheus-svc-nodeport}_ to visit Prometheus Dashboard.


"visit the following URL"

"Prometheus" -> "Grafana"

antoineco · 2018-08-08T18:54:38Z

docs/user-guide/monitoring.md

+
+## Deploy and configure Prometheus Server
+
+The Prometheus server is needed to configure so that it can discover endpoints of services. If a Prometheus server is already running in the cluster and if it is configured in a way that it can find the ingress controller pods, no extra configuration is needed.


"is needed to configure" -> "must be configured "

antoineco · 2018-08-08T18:55:37Z

docs/user-guide/monitoring.md

+
+The Prometheus server is needed to configure so that it can discover endpoints of services. If a Prometheus server is already running in the cluster and if it is configured in a way that it can find the ingress controller pods, no extra configuration is needed.
+
+If there is no existing Prometheus server running, the rest of this tutorial will guide you through the step needed to deploy a properly configured Prometheus server.


step s
(my fault, missed it in my previous review comment)

antoineco · 2018-08-08T18:57:20Z

docs/user-guide/monitoring.md

+
+The NGINX Ingress controller should already be deployed according to the deployment instructions [here](../deploy/index.md).
+
+Note that the yaml files that are used in this tutorial, are stored in the [deploy/monitoring](https://github.com/kubernetes/ingress-nginx/tree/master/deploy/monitoring) folder of the GitHub repository [kubernetes/ingress-nginx](https://github.com/kubernetes/ingress-nginx).


(nit pick)

"that the yaml files that are used" -> "that the yaml files used"

", are" (left over comma?)

antoineco · 2018-08-08T18:59:57Z

docs/user-guide/monitoring.md

+
+The configuration file is provided by a `ConfigMap`.
+
+```yaml


If this is a dupe of deploy/monitoring/configuration.yaml, wouldn't it be better to just link it?

antoineco · 2018-08-08T19:01:29Z

docs/user-guide/monitoring.md

+
+The next yaml snippet is used to deploy Prometheus in Kubernetes:
+
+```yaml


If this is a dupe of deploy/monitoring/prometheus.yaml, wouldn't it be better to just link it?

antoineco · 2018-08-08T19:03:55Z

docs/user-guide/monitoring.md

+10.192.0.2 10.192.0.3 10.192.0.4
+```
+
+Open your browser and visit the following URL: _http://{node IP address}:{prometheus-svc-nodeport}_ to visit the Prometheus Dashboard.


"visit ... to visit" -> "visit ... to load"

antoineco · 2018-08-08T19:05:04Z

docs/user-guide/monitoring.md

+
+This tutorial will show you how to install [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/) for scraping the metrics of the NGINX Ingress controller.
+
+!!! Important: this example uses `emptyDir` volumes for Prometheus and Grafana. This means once the pod dies you will lose all the data.


"dies" -> "gets terminated" ✝️

antoineco · 2018-08-08T19:07:43Z

docs/user-guide/monitoring.md

+
+Open your browser and visit the following URL: _http://{node IP address}:{prometheus-svc-nodeport}_ to visit the Prometheus Dashboard.
+
+According to the above example, this URL will be [http://10.192.0.3:32630](http://10.192.0.3:32630).


(nit) [http://xxx](http://xxx) is the same as just http://xxx in markdown.

antoineco · 2018-08-08T19:09:57Z

docs/user-guide/monitoring.md

+grafana                NodePort    10.98.233.86    <none>        9090:31086/TCP                               10m
+```
+
+Open your browser and visit the following URL: _http://{node IP address}:{grafana-svc-nodeport}_ to visit the Grafana Dashboard.


"visit ... to visit" -> "visit ... to load"

antoineco · 2018-08-08T19:10:21Z

docs/user-guide/monitoring.md

+```
+
+Open your browser and visit the following URL: _http://{node IP address}:{grafana-svc-nodeport}_ to visit the Grafana Dashboard.
+According to the above example, this URL will be [http://10.192.0.3:31086](http://10.192.0.3:31086).


(nit) [http://xxx](http://xxx) is the same as just http://xxx in markdown.

aledbf · 2018-08-13T15:36:02Z

@antoineco is this ok to merge?

antoineco · 2018-08-13T16:01:26Z

Oh, sure. Missed the label removal, sorry!
/lgtm

k8s-ci-robot · 2018-08-13T16:01:32Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aledbf, antoineco

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [aledbf,antoineco]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

antoineco reviewed Aug 8, 2018

View reviewed changes

aledbf force-pushed the prometheus-grafana branch 2 times, most recently from 302e437 to 6a3b7dd Compare August 8, 2018 15:22

antoineco suggested changes Aug 8, 2018

View reviewed changes

aledbf force-pushed the prometheus-grafana branch 2 times, most recently from 4553563 to d23ce34 Compare August 8, 2018 22:42

Add documentation to install prometheus and grafana

322dae6

aledbf force-pushed the prometheus-grafana branch from d23ce34 to 322dae6 Compare August 8, 2018 22:44

antoineco approved these changes Aug 9, 2018

View reviewed changes

aledbf changed the title ~~WIP: Add documentation to install prometheus and grafana~~ Add documentation to install prometheus and grafana Aug 9, 2018

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 9, 2018

k8s-ci-robot assigned antoineco Aug 13, 2018

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 13, 2018

k8s-ci-robot merged commit 01cc29e into kubernetes:master Aug 13, 2018

aledbf deleted the prometheus-grafana branch August 15, 2018 01:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation to install prometheus and grafana #2912

Add documentation to install prometheus and grafana #2912

aledbf commented Aug 8, 2018

codecov-io commented Aug 8, 2018 •

edited

Loading

antoineco left a comment

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018 •

edited

Loading

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018

aledbf Aug 8, 2018

antoineco Aug 8, 2018 •

edited

Loading

antoineco Aug 8, 2018

antoineco Aug 8, 2018

antoineco Aug 8, 2018 •

edited

Loading

antoineco Aug 8, 2018

aledbf commented Aug 13, 2018

antoineco commented Aug 13, 2018

k8s-ci-robot commented Aug 13, 2018

		@@ -0,0 +1,161 @@
		# Prometheus and Grafana installation

		This tutorial will show you how to install [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/) for the metric scraping from the NGINX Ingress controller.


		## Before You Begin

		Now, deploy the Ingress controller following the instructions [here](../deploy/index.md).


		Now, deploy the Ingress controller following the instructions [here](../deploy/index.md).

		Note that the yaml files that are used in this tutorial, stored in [deploy/monitoring](https://github.com/kubernetes/ingress-nginx/tree/master/deploy/monitoring) folder in GitHub repository [kubernetes/ingress-nginx](https://github.com/kubernetes/ingress-nginx).

		Note that the yaml files that are used in this tutorial, stored in [deploy/monitoring](https://github.com/kubernetes/ingress-nginx/tree/master/deploy/monitoring) folder in GitHub repository [kubernetes/ingress-nginx](https://github.com/kubernetes/ingress-nginx).

		## Deploy and configure Prometheus Server


		### Prometheus Dashboard

		Now to open prometheus dashboard on Browser:


		## Deploy and configure Prometheus Server

		The Prometheus server is needed to configure so that it can discover endpoints of services. If a Prometheus server is already running in the cluster and if it is configured in a way that it can find the ingress controller pods, no extra configuration is needed.


		The Prometheus server is needed to configure so that it can discover endpoints of services. If a Prometheus server is already running in the cluster and if it is configured in a way that it can find the ingress controller pods, no extra configuration is needed.

		If there is no existing Prometheus server running, the rest of this tutorial will guide you through the step needed to deploy a properly configured Prometheus server.


		The NGINX Ingress controller should already be deployed according to the deployment instructions [here](../deploy/index.md).

		Note that the yaml files that are used in this tutorial, are stored in the [deploy/monitoring](https://github.com/kubernetes/ingress-nginx/tree/master/deploy/monitoring) folder of the GitHub repository [kubernetes/ingress-nginx](https://github.com/kubernetes/ingress-nginx).


		The next yaml snippet is used to deploy Prometheus in Kubernetes:

		```yaml


		This tutorial will show you how to install [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/) for scraping the metrics of the NGINX Ingress controller.

		!!! Important: this example uses `emptyDir` volumes for Prometheus and Grafana. This means once the pod dies you will lose all the data.


		Open your browser and visit the following URL: _http://{node IP address}:{prometheus-svc-nodeport}_ to visit the Prometheus Dashboard.

		According to the above example, this URL will be [http://10.192.0.3:32630](http://10.192.0.3:32630).

Add documentation to install prometheus and grafana #2912

Add documentation to install prometheus and grafana #2912

Conversation

aledbf commented Aug 8, 2018

codecov-io commented Aug 8, 2018 • edited Loading

Codecov Report

antoineco left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

antoineco Aug 8, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

antoineco Aug 8, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

antoineco Aug 8, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aledbf commented Aug 13, 2018

antoineco commented Aug 13, 2018

k8s-ci-robot commented Aug 13, 2018

codecov-io commented Aug 8, 2018 •

edited

Loading

antoineco Aug 8, 2018 •

edited

Loading

antoineco Aug 8, 2018 •

edited

Loading

antoineco Aug 8, 2018 •

edited

Loading