ERP5 and Jupyter integrated together
[slapos.git] / software / erp5 / README.rst
1 Available ``software-type`` values
2 ==================================
3
4 - ``default``
5
6   Recommended for production use.
7   
8 - ``create-erp5-site``
9
10   Automated creation of ERP5Site instance, for easy deployment.
11   Usage in production discouraged due to the increased risk of data loss.
12
13 Notes
14 =====
15
16 This software release is not intended to be accessed directly, but through a
17 front-end instance which is expected to contains the RewriteRules_ (or
18 equivalent) needed to relocate Zope's urls via its VirtualHostMonster_. See the
19 ``frontend`` erp5 instance parameter.
20
21 Included cloudooo partition is **deprecated**. It is not recommended for
22 intensive usage. See the ``cloudooo`` Software Release to setup a cloudooo
23 cluster, more suitable for intensive usage.
24
25 Port ranges
26 ===========
27
28 This software release assigns the following port ranges by default:
29
30   ====================  ==========
31   Partition type        Port range
32   ====================  ==========
33   memcached-persistent  2000-2009
34   memcached-volatile    2010-2019
35   cloudooo              2020-2024
36   smtp                  2025-2029
37   neo (admin & master)  2050-2051
38   mariadb               2099
39   zeo                   2100-2149
40   balancer              2150-2199
41   zope                  2200-*
42   jupyter               8888
43   ====================  ==========
44
45 Non-zope partitions are unique in an ERP5 cluster, so you shouldn't have to
46 care about them as a user (but a Software Release developer needs to know
47 them).
48
49 Zope partitions should be assigned port ranges starting at 2200, incrementing
50 by some value which depends on how many zope process you want per partition
51 (see the ``port-base`` parameter in ``zope-partition-dict``).
52
53 Notes to the Software Release developper: These ranges are not strictly
54 defined. Not each port is actually used so one may reduce alread-assigned
55 ranges if needed (ex: memcached partitions use actually fewer ports). There
56 should be enough room for evolution (as between smtp and mariadb types). It is
57 important to not allocate any port after 2200 as user may have assigned ports
58 to his zope processes.
59
60 .. _RewriteRules: http://httpd.apache.org/docs/current/en/mod/mod_rewrite.html#rewriterule
61 .. _VirtualHostMonster: http://docs.zope.org/zope2/zope2book/VirtualHosting.html