Skip to content

Commit 1f5adcb

Browse files
committed
style(monitoring): fix bullet lists
1 parent 834c407 commit 1f5adcb

1 file changed

Lines changed: 22 additions & 5 deletions

File tree

src/managing-workflow/platform-monitoring.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
## Description
44
With the release of Workflow Beta4 we now include a monitoring stack for introspection on a running Kubernetes cluster. The stack includes 4 components:
5+
56
* [Telegraf](https://docs.influxdata.com/telegraf/v0.12/) - Metrics collection daemon written by team behind InfluxDB.
67
* [InfluxDB](https://docs.influxdata.com/influxdb/v0.12/) - Time series database
78
* [Grafana](http://grafana.org/) - Graphing tool for time series data
@@ -34,18 +35,34 @@ With the release of Workflow Beta4 we now include a monitoring stack for introsp
3435
```
3536

3637
### Grafana
37-
We expose Grafana through the router using [service annotations](https://github.com/deis/router#how-it-works). This allows users to access the Grafana UI by accessing `grafana.mydomain.com`. While we provide a default username/password of `admin/admin` this can be overridden at any time by setting the following environment variables in `$CHART_HOME/workspace/workflow-$WORKFLOW_RELEASE/manifests/deis-monitor-grafana-rc.yaml`: `GRAFANA_USER` and `GRAFANA_PASSWD`.
3838

39-
It will preload several dashboards that we've created to help operators get started with monitoring their Kubernetes and Workflow installations. Each dashboard is meant to be a starting place for the operator and is not representative of all the dashboards needed to monitor a production installation.
39+
We expose Grafana through the router using [service annotations](https://github.com/deis/router#how-it-works). This
40+
allows users to access the Grafana UI by accessing `grafana.mydomain.com`. While we provide a default username/password
41+
of `admin/admin` this can be overridden at any time by setting the following environment variables in
42+
`$CHART_HOME/workspace/workflow-$WORKFLOW_RELEASE/manifests/deis-monitor-grafana-rc.yaml`: `GRAFANA_USER` and
43+
`GRAFANA_PASSWD`.
44+
45+
It will preload several dashboards that we've created to help operators get started with monitoring their Kubernetes and
46+
Workflow installations. Each dashboard is meant to be a starting place for the operator and is not representative of all
47+
the dashboards needed to monitor a production installation.
4048

41-
We are currently not writing the data to the host file system or to long term storage. Therefore, if the Grafana instance dies you will lose all custom and modified dashboards. It is recommended that you export your dashboards and store them in version control until a solution is implemented for long term storage.
49+
We are currently not writing the data to the host file system or to long term storage. Therefore, if the Grafana
50+
instance dies you will lose all custom and modified dashboards. It is recommended that you export your dashboards and
51+
store them in version control until a solution is implemented for long term storage.
4252

4353
### InfluxDB
44-
As of the Beta4 release InfluxDB is writing data to the host disk, however, if the InfluxDB pod dies and comes back on another host the data will not be recovered. We intend to fix this in a future release. The InfluxDB Admin UI is also exposed through the router allowing users to access the query engine by going to `influx.mydomain.com`. You will need to configure where to find the `influx-api` endpoint by clicking the "gear" icon at the top right and changing the host to `influxapi.mydomain.com` and port to `80`.
54+
As of the Beta4 release InfluxDB is writing data to the host disk, however, if the InfluxDB pod dies and comes back on
55+
another host the data will not be recovered. We intend to fix this in a future release. The InfluxDB Admin UI is also
56+
exposed through the router allowing users to access the query engine by going to `influx.mydomain.com`. You will need to
57+
configure where to find the `influx-api` endpoint by clicking the "gear" icon at the top right and changing the host to
58+
`influxapi.mydomain.com` and port to `80`.
4559

4660
** Note: Each user accessing the Influx UI will need to make this change. **
4761

48-
You can choose to not expose the Influx UI and API to the world by updating `$CHART_HOME/workspace/workflow-$WORKFLOW_RELEASE/manifests/deis-monitor-influxdb-api-svc.yaml` and `$CHART_HOME/workspace/workflow-$WORKFLOW_RELEASE/manifests/deis-monitor-influxdb-ui-svc.yaml` and removing the following line - `router.deis.io/routable: "true"`.
62+
You can choose to not expose the Influx UI and API to the world by updating
63+
`$CHART_HOME/workspace/workflow-$WORKFLOW_RELEASE/manifests/deis-monitor-influxdb-api-svc.yaml` and
64+
`$CHART_HOME/workspace/workflow-$WORKFLOW_RELEASE/manifests/deis-monitor-influxdb-ui-svc.yaml` and removing the
65+
following line - `router.deis.io/routable: "true"`.
4966

5067
### Telegraf
5168
Telegraf is the metrics collection daemon used within the monitoring stack. It will collect and send the following metrics to InfluxDB:

0 commit comments

Comments
 (0)