Skip to content

Commit f78abce

Browse files
authored
Merge pull request #443 from kmala/maint
feat(maintenance): Add docs for maintenance mode support
2 parents d41b1a0 + c41f71e commit f78abce

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

src/applications/managing-app-lifecycle.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,22 @@ From deis-controller.local:peachy-waxworks
9898
* [new branch] master -> deis/master
9999
```
100100

101+
102+
## Application Maintenance
103+
104+
Maintenance mode for applications is useful to perform certain migrations or upgrades during which we don't want to serve client requests. Deis Workflow supports maintenance mode for an app during which the access to the app is blocked. Blocking access to the application means all the requests to the app are served with an error code of `503` and a static maintenance page by the router but the app will still be running and one-off commands can still be run. Currently the maintenance page is not configurable and is present as part of the router component.
105+
106+
To enable maintenance mode for app, use `deis maintenance`:
107+
108+
$ deis maintenance:on
109+
Enabling maintenance for drafty-zaniness... done
110+
111+
This will make the [router][] answer all requests to the application with a 503, although the app is still running. To disable maintenance mode:
112+
113+
$ deis maintenance:off
114+
Disabling maintenance for drafty-zaniness... done
115+
116+
101117
## Application Troubleshooting
102118

103119
Applications deployed on Deis Workflow [treat logs as event streams][]. Deis Workflow aggregates `stdout` and `stderr`
@@ -124,3 +140,4 @@ Use `deis logs` to view the log output from your deployed application.
124140
[treat logs as event streams]: http://12factor.net/logs
125141
[use one-off processes for admin tasks]: http://12factor.net/admin-processes
126142
[Procfile]: http://ddollar.github.io/foreman/#PROCFILE
143+
[router]: ../understanding-workflow/components.md#router

0 commit comments

Comments
 (0)