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.
Introduction
===================
shacache
========
The network cache server is a NoSQL storage with a REST API.
How does it works
===================
-----------------
::
_______________
/ \
| |
......@@ -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
value and the server will send a response with the file data.
API:
PUT / :
parameter: file uploaded
Used to upload/modify an entry
::
API:
PUT / :
parameter: file uploaded
Used to upload/modify an entry
GET /<key>
Return raw content
Raise HTTP error (404) if key does not exist
GET /<key>
Return raw content
Raise HTTP error (404) if key does not exist
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
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]
host = 127.0.0.1
port = 5001
cache_base_folder = /var/cache/networkcached/
[networkcached]
host = 127.0.0.1
port = 5001
cache_base_folder = /var/cache/networkcached/
Run the server:
# networkcached networkcached.conf
Run the server::
# networkcached networkcached.conf
Setup Develoment Environment
===============================
----------------------------
::
$ mkdir -p ~/networkcached/downloads
$ cd ~/networkcached
$ mkdir -p ~/networkcached/downloads
$ cd ~/networkcached
Now it is time to create 'buildout.cfg' file in ~/networkcached 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::
[buildout]
extensions = mr.developer
auto-checkout = slapos.tool.networkcached
download-cache = /nexedi/buildout-networkcached/downloads
eggs-directory = /nexedi/buildout-networkcached/eggs
parts =
networkcached
[buildout]
extensions = mr.developer
auto-checkout = slapos.tool.networkcached
download-cache = /nexedi/buildout-networkcached/downloads
eggs-directory = /nexedi/buildout-networkcached/eggs
[sources]
slapos.tool.networkcached = svn https://svn.erp5.org/repos/vifib/trunk/utils/slapos.tool.networkcached
parts =
networkcached
[networkcached]
recipe = zc.recipe.egg
eggs =
slapos.tool.networkcached
[sources]
slapos.tool.networkcached = svn https://svn.erp5.org/repos/vifib/trunk/utils/slapos.tool.networkcached
Now you bootstrap the buildout::
[networkcached]
recipe = zc.recipe.egg
eggs =
slapos.tool.networkcached
$ python -S -c 'import urllib;print urllib.urlopen(\
"http://svn.zope.org/*checkout*/zc.buildout/trunk/bootstrap/bootstrap.py"\
).read()' | python -S -
Now you bootstrap 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::
Run the buildout:
$ bin/buildout -v
$ bin/buildout -v
Now it is time to create the 'networkcached.conf' file in ~/networkcached
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]
host = 127.0.0.1
port = 5001
cache_base_folder = ~/networkcached/networkcached-database
[networkcached]
host = 127.0.0.1
port = 5001
cache_base_folder = ~/networkcached/networkcached-database
Now you can start your networkcached server:
$ 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