Merge branch 'docs/deploys-perf-dashboard' into 'master'

Move environment monitoring to environments doc

See merge request !11583

4 files changed, 49 insertions, 12 deletions

diff --git a/doc/ci/environments.md b/doc/ci/environments.md
index bab765d1e12..169e0fbae3d 100644
--- a/doc/ci/environments.md
+++ b/doc/ci/environments.md
@@ -591,6 +591,38 @@ exist, you should see something like:
 
 ![Environment groups](img/environments_dynamic_groups.png)
 
+## Monitoring environments
+
+>**Notes:**
+>
+- For the monitor dashboard to appear, you need to:
+  - Have enabled the [Kubernetes integration][kube]
+  - Have your app deployed on Kubernetes
+  - Have enabled the [Prometheus integration][prom]
+- With GitLab 9.2, all deployments to an environment are shown directly on the
+  monitoring dashboard
+
+If your application is deployed on Kubernetes and you have enabled Prometheus
+collecting metrics, you can monitor the performance behavior of your app
+through the environments.
+
+Once configured, GitLab will attempt to retrieve performance metrics for any
+environment which has had a successful deployment. If monitoring data was
+successfully retrieved, a Monitoring button will appear on the environment's
+detail page.
+
+![Environment Detail with Metrics](img/prometheus_environment_detail_with_metrics.png)
+
+Clicking on the Monitoring button will display a new page, showing up to the last
+8 hours of performance data. It may take a minute or two for data to appear
+after initial deployment.
+
+All deployments to an environment are shown directly on the monitoring dashboard
+which allows easy correlation between any changes in performance and a new
+version of the app, all without leaving GitLab.
+
+![Monitoring dashboard](img/environments_monitoring.png)
+
 ## Checkout deployments locally
 
 Since 8.13, a reference in the git repository is saved for each deployment, so
@@ -632,3 +664,5 @@ Below are some links you may find interesting:
 [gitlab-flow]: ../workflow/gitlab_flow.md
 [gitlab runner]: https://docs.gitlab.com/runner/
 [git-strategy]: yaml/README.md#git-strategy
+[kube]: ../user/project/integrations/kubernetes.md
+[prom]: ../user/project/integrations/prometheus.md
diff --git a/doc/ci/img/environments_monitoring.png b/doc/ci/img/environments_monitoring.png
new file mode 100644
index 00000000000..387b6c54b61
--- /dev/null
+++ b/doc/ci/img/environments_monitoring.png
diff --git a/doc/user/project/integrations/img/prometheus_environment_detail_with_metrics.png b/doc/ci/img/prometheus_environment_detail_with_metrics.png
index 214b10624a9..214b10624a9 100644
--- a/doc/user/project/integrations/img/prometheus_environment_detail_with_metrics.png
+++ b/doc/ci/img/prometheus_environment_detail_with_metrics.png
diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md
index 7aa6d070a1b..d3fb5916dc6 100644
--- a/doc/user/project/integrations/prometheus.md
+++ b/doc/user/project/integrations/prometheus.md
@@ -17,6 +17,7 @@ the settings page with a default template. To configure the template, see the
 Integration with Prometheus requires the following:
 
 1. GitLab 9.0 or higher
+1. The [Kubernetes integration must be enabled][kube] on your project
 1. Your app must be deployed on [Kubernetes][]
 1. Prometheus must be configured to collect Kubernetes metrics
 1. Each metric must be have a label to indicate the environment
@@ -159,25 +160,26 @@ The queries utilized by GitLab are shown in the following table.
 ## Monitoring CI/CD Environments
 
 Once configured, GitLab will attempt to retrieve performance metrics for any
-environment which has had a successful deployment. If monitoring data was
-successfully retrieved, a Monitoring button will appear on the environment's
-detail page.
+environment which has had a successful deployment.
 
-![Environment Detail with Metrics](img/prometheus_environment_detail_with_metrics.png)
+[Learn more about monitoring environments.](../../../ci/environments.md#monitoring-environments)
 
-Clicking on the Monitoring button will display a new page, showing up to the last
-8 hours of performance data. It may take a minute or two for data to appear
-after initial deployment.
-
-## Determining performance impact of a merge
+## Determining the performance impact of a merge
 
 > [Introduced][ce-10408] in GitLab 9.2.
 
-Developers can view the performance impact of their changes within the merge request workflow. When a source branch has been deployed to an environment, a sparkline will appear showing the average memory consumption of the app. The dot indicates when the current changes were deployed, with up to 30 minutes of performance data displayed before and after. The sparkline will be updated after each commit has been deployed.
+Developers can view the performance impact of their changes within the merge
+request workflow. When a source branch has been deployed to an environment, a
+sparkline will appear showing the average memory consumption of the app. The dot
+indicates when the current changes were deployed, with up to 30 minutes of
+performance data displayed before and after. The sparkline will be updated after
+each commit has been deployed.
 
-Once merged and the target branch has been redeployed, the sparkline will switch to show the new environments this revision has been deployed to. 
+Once merged and the target branch has been redeployed, the sparkline will switch
+to show the new environments this revision has been deployed to.
 
-Performance data will be available for the duration it is persisted on the Prometheus server.
+Performance data will be available for the duration it is persisted on the
+Prometheus server.
 
 ![Merge Request with Performance Impact](img/merge_request_performance.png)
 
@@ -193,6 +195,7 @@ If the "Attempting to load performance data" screen continues to appear, it coul
 
 [autodeploy]: ../../../ci/autodeploy/index.md
 [kubernetes]: https://kubernetes.io
+[kube]: ./kubernetes.md
 [prometheus-k8s-sd]: https://prometheus.io/docs/operating/configuration/#<kubernetes_sd_config>
 [prometheus]: https://prometheus.io
 [gitlab-prometheus-k8s-monitor]: ../../../administration/monitoring/prometheus/index.md#configuring-prometheus-to-monitor-kubernetes