[doc] update the README file and the example pillar
authorDavid Douard <david.douard@logilab.fr>
Tue, 19 May 2015 14:12:38 +0200
changeset 25 83c1a8d26a29
parent 24 d3c95626e76c
child 26 1c03667c96dd
[doc] update the README file and the example pillar
README.rst
pillar.example
--- a/README.rst	Thu Jun 04 14:30:10 2015 +0200
+++ b/README.rst	Tue May 19 14:12:38 2015 +0200
@@ -14,7 +14,10 @@
 ===========
 
 * set your pillars from pillar.example
-* add one of the cubicweb states (e.g. ``cubicweb`` or ``cubicweb.instances``) to your top.sls
+* add the cubicweb states to your top.sls:
+  - use the ``cubicweb.instances`` state for the host that will run cubicweb applications 
+  - use the ``cubicweb.postgres`` state on the database host 
+  - use the ``cubicweb.apache`` state on the web frontend host 
 * salt 'host' saltutil.refresh_pillars
 * salt 'host' state.highstate
 
--- a/pillar.example	Thu Jun 04 14:30:10 2015 +0200
+++ b/pillar.example	Tue May 19 14:12:38 2015 +0200
@@ -1,24 +1,27 @@
+## Apache related configurations
 apache: 
-  enable: False # set to True if you want to deploy an apache in proxy mode
-  disable_default: False # set to True to disable default apache configuration
-  modules: #this requires the https://github.com/saltstack-formulas/apache-formula formula
+  disable_default: False # set to True to disable default apache configuration (000-default)
+  modules: # this requires the https://github.com/saltstack-formulas/apache-formula formula
     enabled:
-       - rewrite #list of modules to enable
+       - rewrite # list of modules to enable
   vhost_conf: | 
     # insert inline configuration
     # lines here, valid for all vhosts
 
-postgresql:
-  enable: False # set to True to install postgresql on same host
+cubicweb_repo: production # set to acceptance if you want more recent versions of cubicweb 
+
+## you may specify a precise cw version (package version). If set, the
+## 'cubicweb_repo' option is ignored
+#cubicweb_version: 3.20.5-1
 
-cubicweb_repo: production # set to acceptance if you want more recent versions of cubicweb 
-#cubicweb_version: # enter debian package version to pin down your install, cubicweb_repo is then ignored
+## you can add extra repository sources
+#extra_sources:
+#  - deb https://user:password@domain.com/path/dists/ wheezy/
 
-extra_source: deb https://user:password@domain.com/path/dists/ wheezy/
-
+## Declare your cubicweb applications there
 cubicweb_apps:
   www.cubicweb.org:
-    demo1:
+    demo1: 
       database:
         name: cw_blog
         user: logidemo
@@ -26,7 +29,7 @@
         host: db1
         port: 5432
       cwapp:
-        basepath: /demo/blog
+        basepath: /demo/blog # will be served as http(s)://www.cubicweb.org/demo/blog 
         port: 9090
         adminuser: admin
         adminpass: admin
@@ -48,3 +51,17 @@
           blog: cubicweb-blog
       apache: | 
         #additional configuration specific to demo2
+
+  test_app:
+    /:
+      database:
+        name: testapp
+        user: testuser
+        password: something cool
+      cwapp:
+        port: 8080
+        adminuser: admin
+        adminpass: admin
+        cubes:
+          blog: cubicweb-blog: 1.9.7-1 # be careful, no version depency checks are done there
+