Apache Frontend: Change 'zope=true' option to 'type=zope'

slapos/recipe/apache_frontend/__init__.py

@@ -111,7 +111,7 @@ class Recipe(BaseSlapRecipe):
         # rule structure.
         # So we will have one RewriteMap for normal websites, and one
         # RewriteMap for Zope Virtual Host Monster websites.
-        if slave_instance.get("zope", "").upper() in ('1', 'TRUE'):
+        if slave_instance.get("type", "").lower() in ('zope'):
           rewrite_rule_zope_list.append(rewrite_rule)
         else:
           rewrite_rule_list.append(rewrite_rule)

software/apache-frontend/README.apache_frontend.txt

@@ -13,28 +13,28 @@ How to use
 ==========
 
 First, you will need to request a "master" instance of Apache Frontend with
-"domain" parameter, like : 
-<?xml version='1.0' encoding='utf-8'?>
-<instance>
- <parameter id="domain">moulefrite.com</parameter>
- <parameter id="port">443</parameter>
-</instance>
+"domain" parameter, like::
+  <?xml version='1.0' encoding='utf-8'?>
+  <instance>
+   <parameter id="domain">moulefrite.org</parameter>
+   <parameter id="port">443</parameter>
+  </instance>
 
 Then, it is possible to request many slave instances
 (currently only from slapconsole, UI doesn't work yet)
-of Apache Frontend, like : 
-instance = request(
-       software_release=apache_frontend,
-       partition_reference='frontend2',
-       shared=True,
-       partition_parameter_kw={"url":"https://[1:2:3:4]:1234/someresource"}
-     )
+of Apache Frontend, like::
+  instance = request(
+    software_release=apache_frontend,
+    partition_reference='frontend2',
+    shared=True,
+    partition_parameter_kw={"url":"https://[1:2:3:4]:1234/someresource"}
+  )
 Those slave instances will be redirected to the "master" instance,
 and you will see on the "master" instance the associated RewriteRules of
 all slave instances.
 
-Finally, the slave instance will be accessible from :
-https://someidentifier.moulefrite.com.
+Finally, the slave instance will be accessible from:
+https://someidentifier.moulefrite.org.
 
 Instance Parameters
 ===================
@@ -44,10 +44,12 @@ Master Instance Parameters
 
 domain
 ~~~~~~
-name of the domain to be used (example: mydomain.com). Subdomains of this domain will be used for the slave instances (example: instance12345.mydomain.com). It is then recommended to add a wildcard in DNS for the subdomains of the chosen domain like::
+name of the domain to be used (example: mydomain.com). Subdomains of this
+domain will be used for the slave instances (example:
+instance12345.mydomain.com). It is then recommended to add a wildcard in DNS
+for the subdomains of the chosen domain like::
   *.mydomain.com. IN A 123.123.123.123
 Using the IP given by the Master Instance.
-
 "domain" is a mandatory Parameter.
 
 port
@@ -62,24 +64,44 @@ url
 ~~~
 url of backend to use.
 "url" is a mandatory parameter.
-Example : http://mybackend.com/myresource
+Example: http://mybackend.com/myresource
 
 cache
 ~~~~~
 Specify if slave instance should use a varnish / stunnel to connect to backend.
-Possible values : "true", "false".
+Possible values: "true", "false".
 "cache" is an optional parameter. Defaults to "false". 
-Example : true
+Example: true
 
-zope
+type
 ~~~~
-Specify if slave instance will redirect to a zope backend. If specified, Apache RewriteRule will use Zope's Virtual Host Daemon.
-Possible values : "true", "false".
-"zope" is an optional parameter. Defaults to "false". 
-Example : true
+Specify if slave instance will redirect to a zope backend. If specified, Apache
+RewriteRule will use Zope's Virtual Host Daemon.
+Possible values: "zope", "default".
+"type" is an optional parameter. Defaults to "default". 
+Example: zope
 
 custom_domain
 ~~~~~~~~~~~~~
 Domain name to use as frontend. The frontend will be accessible from this domain.
-"custom_domain" is an optional parameter. Defaults to [instancereference].[masterdomain]. 
-Example : www.mycustomdomain.com
+"custom_domain" is an optional parameter. Defaults to
+[instancereference].[masterdomain]. 
+Example: www.mycustomdomain.com
+
+
+Advanced example
+================
+
+Request slave frontend instance using a Zope backend, with Varnish activated,
+listening to a custom domain::
+  instance = request(
+    software_release=apache_frontend,
+    partition_reference='frontend2',
+    shared=True,
+    partition_parameter_kw={
+        "url":"https://[1:2:3:4]:1234/someresource",
+        "cache":"true",
+        "type":"zope",
+        "custom_domain":"mycustomdomain.com",
+    }
+  )