README 6.3 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
  Stores data, preserving history. All available storage nodes are in use
  simultaneously. This offers redundancy and data distribution.
Julien Muchembled's avatar
Julien Muchembled committed
19
  Available backends: MySQL (InnoDB or TokuDB), SQLite
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
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)

36 37 38
Any ZODB like FileStorage can be converted to NEO instanteously,
which means the database is operational before all data are imported.
There's also a tool to convert back to FileStorage.
Julien Muchembled's avatar
Julien Muchembled committed
39 40 41 42

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

43 44
Requirements
============
Vincent Pelletier's avatar
Vincent Pelletier committed
45

46 47
- Linux 2.6 or later

Julien Muchembled's avatar
Julien Muchembled committed
48
- Python 2.7.x (2.7.9 or later for SSL support)
49

Julien Muchembled's avatar
Julien Muchembled committed
50
- For storage nodes using MySQL backend:
51 52

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

Julien Muchembled's avatar
Julien Muchembled committed
54
- For client nodes: ZODB 3.10.x
Vincent Pelletier's avatar
Vincent Pelletier committed
55

Aurel's avatar
Aurel committed
56
Installation
57
============
Aurel's avatar
Aurel committed
58

Julien Muchembled's avatar
Julien Muchembled committed
59 60
a. NEO can be installed like any other egg (see setup.py). Or you can simply
   make `neo` directory available for Python to import (for example, by
61
   adding its container directory to the PYTHONPATH environment variable).
Vincent Pelletier's avatar
Vincent Pelletier committed
62

Julien Muchembled's avatar
Julien Muchembled committed
63 64
b. Write a neo.conf file like the example provided. If you use MySQL,
   you'll also need create 1 database per storage node.
Vincent Pelletier's avatar
Vincent Pelletier committed
65

66
c. Start all required nodes::
Vincent Pelletier's avatar
Vincent Pelletier committed
67

Julien Muchembled's avatar
Julien Muchembled committed
68 69 70 71
    $ neomaster -f neo.conf
    $ neostorage -f neo.conf -s storage1
    $ neostorage -f neo.conf -s storage2
    $ neoadmin -f neo.conf
Vincent Pelletier's avatar
Vincent Pelletier committed
72

Julien Muchembled's avatar
Julien Muchembled committed
73
d. Tell the cluster to initialize storage nodes::
Vincent Pelletier's avatar
Vincent Pelletier committed
74

Julien Muchembled's avatar
Julien Muchembled committed
75 76 77 78 79 80 81
    $ neoctl -a <admin> start

e. Clients can connect when the cluster is in RUNNING state::

    $ neoctl -a <admin> print cluster
    RUNNING

82
f. See `importer.conf` file to import an existing database,
Julien Muchembled's avatar
Julien Muchembled committed
83 84 85 86
   or `neoctl` command for more administrative tasks.

Alternatively, you can use `neosimple` command to quickly setup a cluster for
testing.
Vincent Pelletier's avatar
Vincent Pelletier committed
87 88

How to use
89
==========
Vincent Pelletier's avatar
Vincent Pelletier committed
90

91 92
First make sure Python can import 'neo.client' package.

93 94
In zope
-------
Aurel's avatar
Aurel committed
95

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

100 101 102 103 104 105 106 107
    %import neo.client
    <zodb_db main>
        <NEOStorage>
            master_nodes 127.0.0.1:10000
            name <cluster name>
        </NEOStorage>
        mount-point /
    </zodb_db>
Aurel's avatar
Aurel committed
108

109
b. Start zope
Aurel's avatar
Aurel committed
110

111 112
In a Python script
------------------
Aurel's avatar
Aurel committed
113

114 115 116 117 118
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
119

120 121
"name" and "master_nodes" parameters have the same meaning as in
configuration file.
Aurel's avatar
Aurel committed
122

123 124
Shutting down
-------------
Aurel's avatar
Aurel committed
125

126 127 128
Before shutting down NEO, all clients like Zope instances should be stopped,
so that cluster become idle. This is required for multi-DB setups, to prevent
critical failures in second phase of TPC.
Vincent Pelletier's avatar
Vincent Pelletier committed
129

130 131 132 133 134 135 136 137
A cluster (i.e. masters+storages+admin) can be stopped gracefully by putting it
in STOPPING state using neoctl::

  neoctl -a <admin> set cluster STOPPING

This can also be done manually, which helps if your cluster is in bad state:

- Stop all master nodes first with a SIGINT or SIGTERM, so that storage nodes
138
   don't become in OUT_OF_DATE state.
139
- Next stop remaining nodes with a SIGINT or SIGTERM.
Grégory Wisniewski's avatar
Grégory Wisniewski committed
140

Julien Muchembled's avatar
Julien Muchembled committed
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
Master-slave asynchronous replication
-------------------------------------

This is the recommanded way to backup a NEO cluster.
Once a cluster with appropriate `upstream_cluster` & `upstream_masters`
configuration is started, you can switch it into backup mode
using::

  neoctl -a <admin> set cluster STARTING_BACKUP

It remembers it is in such mode when it is stopped, and it can be put back into
normal mode (RUNNING)  by setting it into STOPPING_BACKUP state.

Packs are currently not replicated, which means packing should always be done
up to a TID that is already fully replicated, so that the backup cluster has a
full history (and not random holes).

Julien Muchembled's avatar
Julien Muchembled committed
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
SSL support
-----------

In addition to any external solution like OpenVPN, NEO has builtin SSL support
to authenticate and encrypt communications between nodes.

All commands and configuration files have options to specify a CA certificate,
the node certificate and the node private key. A certificate can be shared
by several nodes.

NEO always uses the latest SSL protocol supported by the Python interpreter,
without fallback to older versions. A "SSL: WRONG_VERSION_NUMBER" error means
that a node runs in an older environment (Python + OpenSSL) than others.

Note also that you can't mix non-SSL nodes and SSL nodes, even between a
upstream cluster and a backup one. In doing so, connections can get stuck,
or fail with malformed packets or SSL handshake errors.

176 177
Deployment
==========
Grégory Wisniewski's avatar
Grégory Wisniewski committed
178 179

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

182 183
  [group:neo]
  programs=master_01,storage_01,admin
Grégory Wisniewski's avatar
Grégory Wisniewski committed
184

185
  [program:storage_01]
186
  priority=10
Julien Muchembled's avatar
Julien Muchembled committed
187
  command=neostorage -s storage_01 -f /neo/neo.conf
188 189 190

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

193
  [program:admin]
194
  priority=20
Julien Muchembled's avatar
Julien Muchembled committed
195
  command=neoadmin -s admin -f /neo/neo.conf
Julien Muchembled's avatar
Julien Muchembled committed
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214

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/