feat (maintenance): allow to specify maintenance behavior. Add docs.

manifests/resource/vhost.pp

@@ -135,6 +135,9 @@
 #   [*owner*]                   - Defines owner of the .conf file
 #   [*group*]                   - Defines group of the .conf file
 #   [*mode*]                    - Defines mode of the .conf file
+#   [*maintenance*]             - A boolean value to set a vhost in maintenance
+#   [*maintenance_value*]       - Value to return when maintenance is on.
+#                                 Default to return 503
 # Actions:
 #
 # Requires:
@@ -232,6 +235,7 @@ define nginx::resource::vhost (
   $group                        = $::nginx::config::global_group,
   $mode                         = $::nginx::config::global_mode,
   $maintenance                  = false,
+  $maintenance_value            = 'return 503'
 ) {
 
   validate_re($ensure, '^(present|absent)$',

templates/vhost/vhost_header.erb

@@ -108,7 +108,7 @@ server {
   set $maintenance "off";
 <% end -%>
   if ($maintenance = "on") {
-      return 503;
+      <%= @maintenance_value %>;
   }
 <% if @rewrite_to_https -%>
   if ($ssl_protocol = "") {

templates/vhost/vhost_ssl_header.erb

@@ -78,7 +78,7 @@ server {
   set $maintenance "off";
 <% end -%>
   if ($maintenance = "on") {
-      return 503;
+      <%= @maintenance_value %>;
   }
 <% if Array(@resolver).count > 0 -%>
   resolver                  <% Array(@resolver).each do |r| %> <%= r %><% end %>;