README 4.59 KB
Newer Older
Vincent Pelletier's avatar
Vincent Pelletier committed
1 2
NEO is a distributed, redundant and scalable implementation of ZODB API.
NEO stands for Nexedi Enterprise Object.
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3

4 5
Overview
========
6

7
A NEO cluster is composed of the following types of nodes:
Vincent Pelletier's avatar
Vincent Pelletier committed
8

9
- "master" nodes (mandatory, 1 or more)
10

11 12 13
  Takes care of transactionality. Only one master node is really active
  (the active master node is called "primary master") at any given time,
  extra masters are spares (they are called "secondary masters").
14

15
- "storage" nodes (mandatory, 1 or more)
16

Julien Muchembled's avatar
Julien Muchembled committed
17 18 19
  Stores data in a MySQL database, preserving history. All available storage
  nodes are in use simultaneously. This offers redundancy and data distribution.
  Other storage backends than MySQL are considered for future release.
20

21
- "admin" nodes (mandatory for startup, optional after)
Vincent Pelletier's avatar
Vincent Pelletier committed
22

23 24
  Accepts commands from neoctl tool and transmits them to the
  primary master, and monitors cluster state.
Vincent Pelletier's avatar
Vincent Pelletier committed
25

26
- "client" nodes
Vincent Pelletier's avatar
Vincent Pelletier committed
27

28
  Well... Something needing to store/load data in a NEO cluster.
Vincent Pelletier's avatar
Vincent Pelletier committed
29

Julien Muchembled's avatar
Julien Muchembled committed
30 31 32 33 34 35 36 37 38 39 40
ZODB API is fully implemented except:

- pack: only old revisions of objects are removed for the moment
        (full implementation is considered)
- blobs: not implemented (not considered yet)

There is a simple way to convert FileStorage to NEO and back again.

See also http://www.neoppod.org/links for more detailed information about
features related to scalability.

41 42
Disclaimer
==========
Vincent Pelletier's avatar
Vincent Pelletier committed
43

44 45
In addition of the disclaimer contained in the licence this code is
released under, please consider the following.
Vincent Pelletier's avatar
Vincent Pelletier committed
46

47 48 49 50
NEO does not implement any authentication mechanism between its nodes, and
does not encrypt data exchanged between nodes either.
If you want to protect your cluster from malicious nodes, or your data from
being snooped, please consider encrypted tunelling (such as openvpn).
Vincent Pelletier's avatar
Vincent Pelletier committed
51

52 53
Requirements
============
Vincent Pelletier's avatar
Vincent Pelletier committed
54

55 56
- Linux 2.6 or later

57
- Python 2.6.x or 2.7.x
58

59 60 61
- For storage nodes:

  - MySQLdb: http://sourceforge.net/projects/mysql-python
62

63
- For client nodes: ZODB 3.10.x but it should work with ZODB 3.9.x
Vincent Pelletier's avatar
Vincent Pelletier committed
64

Aurel's avatar
Aurel committed
65
Installation
66
============
Aurel's avatar
Aurel committed
67

68 69
a. Make neo directory available for python to import (for example, by
   adding its container directory to the PYTHONPATH environment variable).
Vincent Pelletier's avatar
Vincent Pelletier committed
70

71
b. Choose a cluster name and setup a MySQL database
Vincent Pelletier's avatar
Vincent Pelletier committed
72

73
c. Start all required nodes::
Vincent Pelletier's avatar
Vincent Pelletier committed
74

75
    neomaster --cluster=<cluster name>
Julien Muchembled's avatar
Julien Muchembled committed
76
    neostorage --cluster=<cluster name> --database=user:passwd@db
77
    neoadmin --cluster=<cluster name>
Vincent Pelletier's avatar
Vincent Pelletier committed
78

79
d. Tell the cluster it can provide service::
Vincent Pelletier's avatar
Vincent Pelletier committed
80

81
    neoctl start
Vincent Pelletier's avatar
Vincent Pelletier committed
82 83

How to use
84
==========
Vincent Pelletier's avatar
Vincent Pelletier committed
85

86 87
First make sure Python can import 'neo.client' package.

88 89
In zope
-------
Aurel's avatar
Aurel committed
90

91
a. Edit your zope.conf, add a neo import and edit the `zodb_db` section by
92 93
   replacing its filestorage subsection by a NEOStorage one.
   It should look like::
Aurel's avatar
Aurel committed
94

95 96 97 98 99 100 101 102 103
    %import neo.client
    <zodb_db main>
        # Main FileStorage database
        <NEOStorage>
            master_nodes 127.0.0.1:10000
            name <cluster name>
        </NEOStorage>
        mount-point /
    </zodb_db>
Aurel's avatar
Aurel committed
104

105
b. Start zope
Aurel's avatar
Aurel committed
106

107 108
In a Python script
------------------
Aurel's avatar
Aurel committed
109

110 111 112 113 114
Just create the storage object and play with it::

  from neo.client.Storage import Storage
  s = Storage(master_nodes="127.0.0.1:10010", name="main")
  ...
Aurel's avatar
Aurel committed
115

116 117
"name" and "master_nodes" parameters have the same meaning as in
configuration file.
Aurel's avatar
Aurel committed
118

119 120
Shutting down
-------------
Aurel's avatar
Aurel committed
121

Julien Muchembled's avatar
Julien Muchembled committed
122
There is no administration command yet to stop properly a running cluster.
123
So following manual actions should be done:
Vincent Pelletier's avatar
Vincent Pelletier committed
124

125 126 127 128 129
a. Make sure all clients like Zope instances are stopped, so that cluster
   become idle.
b. Stop all master nodes first with a SIGINT or SIGTERM, so that storage nodes
   don't become in OUT_OF_DATE state.
c. At last stop remaining nodes with a SIGINT or SIGTERM.
Grégory Wisniewski's avatar
Grégory Wisniewski committed
130

131 132
Deployment
==========
Grégory Wisniewski's avatar
Grégory Wisniewski committed
133 134

NEO has no built-in deployment features such as process daemonization. We use
Julien Muchembled's avatar
Julien Muchembled committed
135
`supervisor <http://supervisord.org/>`_ with configuration like below::
Grégory Wisniewski's avatar
Grégory Wisniewski committed
136

137 138
  [group:neo]
  programs=master_01,storage_01,admin
Grégory Wisniewski's avatar
Grégory Wisniewski committed
139

140
  [program:storage_01]
141
  priority=10
142
  command=neostorage -c neo -s storage_01 -f /neo/neo.conf
143 144 145 146

  [program:master_01]
  priority=20
  command=neomaster -c neo -s master_01 -f /neo/neo.conf
Grégory Wisniewski's avatar
Grégory Wisniewski committed
147

148
  [program:admin]
149
  priority=20
150
  command=neoadmin -c neo -s admin -f /neo/neo.conf
Julien Muchembled's avatar
Julien Muchembled committed
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169

Developers
==========

Developers interested in NEO may refer to
`NEO Web site <http://www.neoppod.org/>`_ and subscribe to following mailing
lists:

- `neo-users <http://mail.tiolive.com/mailman/listinfo/neo-users>`_:
  users discussion
- `neo-dev <http://mail.tiolive.com/mailman/listinfo/neo-dev>`_:
  developers discussion
- `neo-report <http://mail.tiolive.com/mailman/listinfo/neo-report>`_:
  automated test results (read-only list)

Commercial Support
==================

Nexedi provides commercial support for NEO: http://www.nexedi.com/