feat(maintenance): Add support for maintenance mode for apps

kmala · kmala · commit 59e753cbafed · 2016-08-12T11:56:57.000-04:00
diff --git a/README.md b/README.md
@@ -287,6 +287,7 @@ _Note that Kubernetes annotation maps are all of Go type `map[string]string`.  A
 | <a name="app-whitelist"></a>routable application | service | [router.deis.io/whitelist](#app-whitelist) | N/A | Comma-delimited list of addresses permitted to access the application (using IP or CIDR notation).  These may either extend or override the router-wide default whitelist (if defined).  Requests from all other addresses are denied. |
 | <a name="app-connect-timeout"></a>routable application | service | [router.deis.io/connectTimeout](#app-connect-timeout) | `"30s"` | nginx `proxy_connect_timeout` setting expressed in units `ms`, `s`, `m`, `h`, `d`, `w`, `M`, or `y`. |
 | <a name="app-tcp-timeout"></a>routable application | service | [router.deis.io/tcpTimeout](#app-tcp-timeout) | router's `defaultTimeout` | nginx `proxy_send_timeout` and `proxy_read_timeout` settings expressed in units `ms`, `s`, `m`, `h`, `d`, `w`, `M`, or `y`. |
+| <a name="app-maintenance"></a>routable application | service | [router.deis.io/maintenance](#app-maintenance) | `"false"` | Whether the app is under maintenance so that all traffic for this app is redirected to a static maintenance page with an error code of `503`. |
 
 #### Annotations by example
 
diff --git a/model/model.go b/model/model.go
@@ -53,7 +53,7 @@ type RouterConfig struct {
 	AppConfigs               []*AppConfig
 	BuilderConfig            *BuilderConfig
 	PlatformCertificate      *Certificate
-	Http2Enabled             bool        `key:"http2Enabled" constraint:"(?i)^(true|false)$"`
+	Http2Enabled             bool `key:"http2Enabled" constraint:"(?i)^(true|false)$"`
 }
 
 func newRouterConfig() *RouterConfig {
@@ -112,6 +112,7 @@ type AppConfig struct {
 	CertMappings   map[string]string `key:"certificates" constraint:"(?i)^((([a-z0-9]+(-*[a-z0-9]+)*)|((\\*\\.)?[a-z0-9]+(-*[a-z0-9]+)*\\.)+[a-z0-9]+(-*[a-z0-9]+)+):([a-z0-9]+(-*[a-z0-9]+)*)(\\s*,\\s*)?)+$"`
 	Certificates   map[string]*Certificate
 	Available      bool
+	Maintenance    bool `key:"maintenance" constraint:"(?i)^(true|false)$"`
 }
 
 func newAppConfig(routerConfig *RouterConfig) *AppConfig {
diff --git a/nginx/config.go b/nginx/config.go
@@ -188,7 +188,7 @@ http {
 		vhost_traffic_status_filter_by_set_key {{ $appConfig.Name }} application::*;
 
 		location / {
-			{{ if $appConfig.Available }}proxy_buffering off;
+			{{ if $appConfig.Maintenance }}return 503;{{ else if $appConfig.Available }}proxy_buffering off;
 			proxy_set_header Host $host;
 			proxy_set_header X-Forwarded-For $remote_addr;
 			proxy_set_header X-Forwarded-Proto $access_scheme;
@@ -209,6 +209,12 @@ http {
 
 			proxy_pass http://{{$appConfig.ServiceIP}}:80;{{ else }}return 503;{{ end }}
 		}
+		{{ if $appConfig.Maintenance }}error_page 503 @maintenance;
+			location @maintenance {
+					root /;
+			    rewrite ^(.*)$ /www/maintenance.html break;
+			}
+		{{ end }}
 	}
 
 	{{end}}{{end}}
diff --git a/rootfs/www/maintenance.html b/rootfs/www/maintenance.html
@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+<title>Site Maintenance</title>

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ type RouterConfig struct {`
`53`	`53`	`AppConfigs []*AppConfig`
`54`	`54`	`BuilderConfig *BuilderConfig`
`55`	`55`	`PlatformCertificate *Certificate`
`56`		- Http2Enabled bool `key:"http2Enabled" constraint:"(?i)^(true\|false)$"`
	`56`	+ Http2Enabled bool `key:"http2Enabled" constraint:"(?i)^(true\|false)$"`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`func newRouterConfig() *RouterConfig {`
`@@ -112,6 +112,7 @@ type AppConfig struct {`
`112`	`112`	CertMappings map[string]string `key:"certificates" constraint:"(?i)^((([a-z0-9]+(-[a-z0-9]+))\|((\\\\.)?[a-z0-9]+(-[a-z0-9]+)\\.)+[a-z0-9]+(-[a-z0-9]+)+):([a-z0-9]+(-[a-z0-9]+))(\\s,\\s)?)+$"`
`113`	`113`	`Certificates map[string]*Certificate`
`114`	`114`	`Available bool`
	`115`	+ Maintenance bool `key:"maintenance" constraint:"(?i)^(true\|false)$"`
`115`	`116`	`}`
`116`	`117`
`117`	`118`	`func newAppConfig(routerConfig RouterConfig) AppConfig {`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<!DOCTYPE html>`
	`2`	`+<title>Site Maintenance</title>`