Commit e40bdd6f authored by Łukasz Nowak's avatar Łukasz Nowak

Stabilise documentation formatting.

parent 62fa4ccb
slapos.toolbox
==============
slapbuilder builder
=========== =======
slapbuilder is a program to install a slapos image. builder is a program to install a slapos image.
slap.monitor monitor
============ =======
Monitoring for SLAP (Simple Language for Accounting and Provisioning) python library. Monitoring for SLAP (Simple Language for Accounting and Provisioning) python library.
Introduction shacache
=================== ========
The network cache server is a NoSQL storage with a REST API. The network cache server is a NoSQL storage with a REST API.
How does it works How does it works
=================== -----------------
::
_______________ _______________
/ \ / \
| | | |
...@@ -24,76 +27,86 @@ Basically, the networkcached archives the files through HTTP PUT method. ...@@ -24,76 +27,86 @@ Basically, the networkcached archives the files through HTTP PUT method.
When a client want to download the file it just need to provide the key When a client want to download the file it just need to provide the key
value and the server will send a response with the file data. value and the server will send a response with the file data.
API: ::
PUT / :
parameter: file uploaded API:
Used to upload/modify an entry PUT / :
parameter: file uploaded
Used to upload/modify an entry
GET /<key> GET /<key>
Return raw content Return raw content
Raise HTTP error (404) if key does not exist Raise HTTP error (404) if key does not exist
Installation Installation
============== ------------
$ python2.6 setup.py install
::
$ python2.6 setup.py install
Now it is time to create the 'networkcached.conf' file in /etc/networkcached.conf Now it is time to create the 'networkcached.conf' file in /etc/networkcached.conf
directory, using your preferred text editor (gedit, kate, vim.). directory, using your preferred text editor (gedit, kate, vim.).
Follow text shall be put in this file: Follow text shall be put in this file::
[networkcached] [networkcached]
host = 127.0.0.1 host = 127.0.0.1
port = 5001 port = 5001
cache_base_folder = /var/cache/networkcached/ cache_base_folder = /var/cache/networkcached/
Run the server: Run the server::
# networkcached networkcached.conf
# networkcached networkcached.conf
Setup Develoment Environment Setup Develoment Environment
=============================== ----------------------------
::
$ mkdir -p ~/networkcached/downloads $ mkdir -p ~/networkcached/downloads
$ cd ~/networkcached $ cd ~/networkcached
Now it is time to create 'buildout.cfg' file in ~/networkcached directory, Now it is time to create 'buildout.cfg' file in ~/networkcached directory,
using your preferred text editor (gedit, kate, vim.). using your preferred text editor (gedit, kate, vim.).
Follow text shall be put in this file: Follow text shall be put in this file::
[buildout]
extensions = mr.developer
auto-checkout = slapos.tool.networkcached
download-cache = /nexedi/buildout-networkcached/downloads
eggs-directory = /nexedi/buildout-networkcached/eggs
parts =
networkcached
[buildout] [sources]
extensions = mr.developer slapos.tool.networkcached = svn https://svn.erp5.org/repos/vifib/trunk/utils/slapos.tool.networkcached
auto-checkout = slapos.tool.networkcached
download-cache = /nexedi/buildout-networkcached/downloads
eggs-directory = /nexedi/buildout-networkcached/eggs
parts = [networkcached]
networkcached recipe = zc.recipe.egg
eggs =
slapos.tool.networkcached
[sources] Now you bootstrap the buildout::
slapos.tool.networkcached = svn https://svn.erp5.org/repos/vifib/trunk/utils/slapos.tool.networkcached
[networkcached] $ python -S -c 'import urllib;print urllib.urlopen(\
recipe = zc.recipe.egg "http://svn.zope.org/*checkout*/zc.buildout/trunk/bootstrap/bootstrap.py"\
eggs = ).read()' | python -S -
slapos.tool.networkcached
Now you bootstrap the buildout: Run the buildout::
$ python -S -c 'import urllib;print urllib.urlopen(\
"http://svn.zope.org/*checkout*/zc.buildout/trunk/bootstrap/bootstrap.py"\
).read()' | python -S -
Run the buildout: $ bin/buildout -v
$ bin/buildout -v
Now it is time to create the 'networkcached.conf' file in ~/networkcached Now it is time to create the 'networkcached.conf' file in ~/networkcached
directory, using your preferred text editor (gedit, kate, vim.). directory, using your preferred text editor (gedit, kate, vim.).
Follow text shall be put in this file: Follow text shall be put in this file::
[networkcached] [networkcached]
host = 127.0.0.1 host = 127.0.0.1
port = 5001 port = 5001
cache_base_folder = ~/networkcached/networkcached-database cache_base_folder = ~/networkcached/networkcached-database
Now you can start your networkcached server: Now you can start your networkcached server:
$ bin/networkcached networkcached.conf $ bin/networkcached networkcached.conf
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment