Commit 933039b0 authored by Łukasz Nowak's avatar Łukasz Nowak

Format and stabilise a bit documentation.

parent f3d33177
slapconsole console
=========== =======
SlapOS Formatter format
================ ======
slapformat is an application to prepare SlapOS ready node (machine). slapformat is an application to prepare SlapOS ready node (machine).
...@@ -16,7 +16,7 @@ configured SlapOS server. ...@@ -16,7 +16,7 @@ configured SlapOS server.
This program shall be only run by root. This program shall be only run by root.
Requirements Requirements
============ ------------
Linux with IPv6, bridging and tap interface support. Linux with IPv6, bridging and tap interface support.
......
slapgrid grid
======== ====
slapgrid is a client of SLAPos. SLAPos provides support for deploying a SaaS slapgrid is a client of SLAPos. SLAPos provides support for deploying a SaaS
system in a minute. system in a minute.
...@@ -9,7 +9,7 @@ For more informations about SLAP and SLAPos, please see the SLAP documentation. ...@@ -9,7 +9,7 @@ For more informations about SLAP and SLAPos, please see the SLAP documentation.
Requirements Requirements
============ ------------
A working SLAP server with informations about your computer, in order to A working SLAP server with informations about your computer, in order to
retrieve them. retrieve them.
...@@ -25,7 +25,7 @@ releases. ...@@ -25,7 +25,7 @@ releases.
Concepts Concepts
======== --------
Here are the fundamental concepts of slapgrid : Here are the fundamental concepts of slapgrid :
A Software Release (SR) is just a software. A Software Release (SR) is just a software.
...@@ -36,7 +36,7 @@ i.e configuring it for your needs, as a Computer Partition. ...@@ -36,7 +36,7 @@ i.e configuring it for your needs, as a Computer Partition.
How it works How it works
============ ------------
When run, slapgrid will authenticate to the SLAP library with a computer_id and When run, slapgrid will authenticate to the SLAP library with a computer_id and
fetch the list of Software Releases to install or remove and Computer fetch the list of Software Releases to install or remove and Computer
...@@ -47,14 +47,11 @@ Partition. ...@@ -47,14 +47,11 @@ Partition.
Installation Installation
============ ------------
With easy_install : With easy_install::
$ easy_install slapgrid
With buildout (for developers): $ easy_install slapgrid
Checkout svn.erp5.org/repos/vifib/software_release/slapgrid.development,
then read the README.txt.
slapgrid needs several directories to be created and configured before being slapgrid needs several directories to be created and configured before being
able to run : a software releases directory, and an instances directory with able to run : a software releases directory, and an instances directory with
...@@ -65,7 +62,7 @@ directory should belongs to this specific user, with permissions of 0750. ...@@ -65,7 +62,7 @@ directory should belongs to this specific user, with permissions of 0750.
Usage Usage
===== -----
slapgrid needs several informations in order to run. You can specify them by slapgrid needs several informations in order to run. You can specify them by
adding arguments to the slapgrid command line, or by putting then in a adding arguments to the slapgrid command line, or by putting then in a
...@@ -74,22 +71,25 @@ Beware : you need a valid computer resource on server side. ...@@ -74,22 +71,25 @@ Beware : you need a valid computer resource on server side.
Examples Examples
======== --------
simple example : simple example :
Just run slapgrid : Just run slapgrid:
$ slapgrid --instance-root /path/to/instance/root --software-root
/path/to/software_root --master-url https://some.server/some.resource
--computer-id my.computer.id
$ slapgrid --instance-root /path/to/instance/root --software-root
/path/to/software_root --master-url https://some.server/some.resource
--computer-id my.computer.id
configuration file example :
[slapgrid]
instance_root = /path/to/instance/root
software_root = /path/to/software/root
master_url = https://slapos.server/slap_service
computer_id = my.computer.id
then run slapgrid : configuration file example::
$ slapgrid --configuration-file = path/to/configuration/file
[slapgrid]
instance_root = /path/to/instance/root
software_root = /path/to/software/root
master_url = https://slapos.server/slap_service
computer_id = my.computer.id
then run slapgrid::
$ slapgrid --configuration-file = path/to/configuration/file
Introduction libnetworkcache
============== ===============
The goal of libnetworkcache python library is to abstract the REST calls. The goal of libnetworkcache python library is to abstract the REST calls.
It works as wrapper of python httplib to use the Networkcache HTTP Server. It works as wrapper of python httplib to use the Networkcache HTTP Server.
API API
====== ---
So, it must provide 2 methods: So, it must provide 2 methods:
put(file) put(file)
......
slapproxy proxy
========= =====
...@@ -4,7 +4,7 @@ slap ...@@ -4,7 +4,7 @@ slap
Simple Language for Accounting and Provisioning python library. Simple Language for Accounting and Provisioning python library.
Developer note - python version Developer note - python version
=============================== -------------------------------
This library is used on client (slapgrid) and server side. This library is used on client (slapgrid) and server side.
Server is using python2.4 and client is using python2.6 Server is using python2.4 and client is using python2.6
...@@ -12,7 +12,7 @@ Having this in mind, code of this library *have* to work ...@@ -12,7 +12,7 @@ Having this in mind, code of this library *have* to work
on python2.4 on python2.4
How it works How it works
============ ------------
The SLAP main server which is in charge of service coordination receives from participating servers the number of computer paritions which are available, the type of resource which a party is ready provide, and request from parties for resources which are needed. The SLAP main server which is in charge of service coordination receives from participating servers the number of computer paritions which are available, the type of resource which a party is ready provide, and request from parties for resources which are needed.
......
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