You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/installing-workflow/index.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,16 +41,16 @@ the master returned by `helmc target` matches the expected cluster.
41
41
## Choose Your Deployment Strategy
42
42
43
43
Deis Workflow includes everything it needs to run out of the box. However, these defaults are aimed at simplicity rather than
44
-
production readiness. Production and staging deployments of Workflow should, at a minimum, use off-cluster storage.
45
-
Which is used by Workflow components to store and backup critical data. Should an operator need to completely re-install
44
+
production readiness. Production and staging deployments of Workflow should, at a minimum, use off-cluster storage
45
+
which is used by Workflow components to store and backup critical data. Should an operator need to completely re-install
46
46
Workflow, the required components can recover from off-cluster storage. See the documentation for [configuring object
47
47
storage](configuring-object-storage.md) for more details.
48
48
49
-
Workflow may also be configured to use off-cluster persistence for [Postgres](configuring-postgres.md) and
50
-
Redis; a deployment strategy that mirrors the "stateless" clusters from the Deis v1 PaaS.
51
-
52
-
Last but not least, Workflow may also use a dedicated off-cluster image registry, including Docker Hub, Quay.io, ECR or
53
-
GCR for all container images. Read more about [configuring your registry](configuring-registry.md).
49
+
More rigorous installations would benefit from using outside sources for the following things:
50
+
*[Postgres](configuring-postgres.md) - For example AWS RDS.
51
+
*[Registry](configuring-registry.md) - This includes [quay.io](https://quay.io), [dockerhub](https://hub.docker.com), [Amazon ECR](https://aws.amazon.com/ecr/), and [Google GCR](https://cloud.google.com/container-registry/).
52
+
*[Redis](../managing-workflow/platform-logging.md#configuring-off-cluster-redis) - Such as AWS Elasticache
53
+
*[InfluxDB](../managing-workflow/platform-monitoring.md#configuring-off-cluster-influxdb) and [Grafana](../managing-workflow/platform-monitoring.md#off-cluster-grafana)
Copy file name to clipboardExpand all lines: src/managing-workflow/platform-logging.md
+32Lines changed: 32 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,38 @@ If the message is from the [Workflow Router](https://github.com/deis/router) we
10
10
11
11
Logger then acts as a consumer reading messages off of the NSQ logs topic storing those messages in a local Redis instance. When a user wants to retrieve log entries using the `deis logs` command we make an HTTP request from Controller to Logger which then fetches the appropriate data from Redis.
12
12
13
+
## Configuring Off Cluster Redis
14
+
Even though we provide a redis instance with the default Workflow install. It is recommended that operators use a 3rd party source like Elasticache or similar offering. This way your data is durable across upgrades or outages. If you have a 3rd party Redis installation you would like to use all you need to do is set the following values in `generate_params.toml` within your chart's tpl directory.
15
+
16
+
* db = "0"
17
+
* host = "my.host.redis"
18
+
* port = "6379"
19
+
* password = ""
20
+
21
+
You can also provide this environment variables when you run your `helm generate` command instead of editing `generate_params.toml`.
22
+
23
+
* LOGGER_REDIS_LOCATION="off-cluster"
24
+
* DEIS_LOGGER_REDIS_DB="0"
25
+
* DEIS_LOGGER_REDIS_SERVICE_HOST="my.host.redis"
26
+
* DEIS_LOGGER_REDIS_SERVICE_PORT="6379"
27
+
28
+
The database password can also be set as a kubernetes secret using the following name: `logger-redis-creds`.
29
+
30
+
```
31
+
apiVersion: v1
32
+
kind: Secret
33
+
metadata:
34
+
name: logger-redis-creds
35
+
namespace: deis
36
+
labels:
37
+
app: deis-logger-redis
38
+
heritage: deis
39
+
annotations:
40
+
helm-keep: "true"
41
+
data:
42
+
password: your-base64-password-here
43
+
```
44
+
13
45
## Debugging Logger
14
46
If the `deis logs` command encounters an error it will return the following message:
Copy file name to clipboardExpand all lines: src/managing-workflow/platform-monitoring.md
+15-3Lines changed: 15 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ We now include a monitoring stack for introspection on a running Kubernetes clus
38
38
└──────────┘
39
39
```
40
40
41
-
###Grafana
41
+
## Grafana
42
42
43
43
Deis Workflow exposes Grafana through the router using [service annotations](https://github.com/deis/router#how-it-works). This
44
44
allows users to access the Grafana UI at `http://grafana.mydomain.com`. The default username/password of
@@ -54,7 +54,10 @@ Deis Workflow monitoring does not currently write data to the host filesystem or
54
54
instance fails, modified dashboards are lost. Until there is a solution to persist this, export dashboards and store
55
55
them separately in version control.
56
56
57
-
### InfluxDB
57
+
### Off Cluster Grafana
58
+
It is recommended that users provide their own installation for Grafana if possible. The current deployment of Grafana within Workflow is durable across pod restarts which means custom dashboards that are created after startup will not be restored when the pod comes back up. If you wish to provide your own Grafana instance you can either set the `GRAFANA_LOCATION` environment variable when your run `helm generate` or set `grafana_location` in the generate_params.toml.
59
+
60
+
## InfluxDB
58
61
59
62
InfluxDB writes data to the host disk, however, if the InfluxDB pod dies and comes back on
60
63
another host the data will not be recovered. We intend to fix this in a future release. The InfluxDB Admin UI is also
@@ -69,7 +72,16 @@ You can choose to not expose the Influx UI and API to the world by updating
69
72
`$CHART_HOME/workspace/workflow-$WORKFLOW_RELEASE/manifests/deis-monitor-influxdb-ui-svc.yaml` and removing the
70
73
following line - `router.deis.io/routable: "true"`.
71
74
72
-
### Telegraf
75
+
### Off Cluster Influxdb
76
+
To use off-cluster Influx please provide the following values in either the `generate_params.toml` file or as environment variables when running `helm generate`.
0 commit comments