diff --git a/slapos/README.console.txt b/slapos/README.console.txt index 7637d9d42c6e898025f07e0f2c54a149e704029d..22eb8017f9ff05955770dea1f0e6830a714fae52 100644 --- a/slapos/README.console.txt +++ b/slapos/README.console.txt @@ -1,3 +1,2 @@ -slapconsole -=========== - +console +======= diff --git a/slapos/README.format.txt b/slapos/README.format.txt index 13fbd803c6edceee0ebbf9022677e278e6f1b9f9..bc7ee967c934102f3a9d4086bf57b9b8bca73b65 100644 --- a/slapos/README.format.txt +++ b/slapos/README.format.txt @@ -1,5 +1,5 @@ -SlapOS Formatter -================ +format +====== slapformat is an application to prepare SlapOS ready node (machine). @@ -16,7 +16,7 @@ configured SlapOS server. This program shall be only run by root. Requirements -============ +------------ Linux with IPv6, bridging and tap interface support. diff --git a/slapos/README.grid.txt b/slapos/README.grid.txt index 104d0728b86de3636edf04620fb0456b8ae1fdc0..206081de2768885514a904a07badbd4555632aa4 100644 --- a/slapos/README.grid.txt +++ b/slapos/README.grid.txt @@ -1,5 +1,5 @@ -slapgrid -======== +grid +==== slapgrid is a client of SLAPos. SLAPos provides support for deploying a SaaS system in a minute. @@ -9,7 +9,7 @@ For more informations about SLAP and SLAPos, please see the SLAP documentation. Requirements -============ +------------ A working SLAP server with informations about your computer, in order to retrieve them. @@ -25,7 +25,7 @@ releases. Concepts -======== +-------- Here are the fundamental concepts of slapgrid : A Software Release (SR) is just a software. @@ -36,7 +36,7 @@ i.e configuring it for your needs, as a Computer Partition. How it works -============ +------------ 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 @@ -47,14 +47,11 @@ Partition. Installation -============ +------------ -With easy_install : -$ easy_install slapgrid +With easy_install:: -With buildout (for developers): -Checkout svn.erp5.org/repos/vifib/software_release/slapgrid.development, -then read the README.txt. + $ easy_install slapgrid slapgrid needs several directories to be created and configured before being 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. Usage -===== +----- 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 @@ -74,22 +71,25 @@ Beware : you need a valid computer resource on server side. Examples -======== +-------- simple example : -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 +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 -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 : -$ slapgrid --configuration-file = path/to/configuration/file +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:: + + $ slapgrid --configuration-file = path/to/configuration/file diff --git a/slapos/README.libnetworkcache.txt b/slapos/README.libnetworkcache.txt index fa4153e55d6557db51ea82958a7789d278fa4095..8b3d31282708212586d04246fbcac782be157dde 100644 --- a/slapos/README.libnetworkcache.txt +++ b/slapos/README.libnetworkcache.txt @@ -1,10 +1,10 @@ -Introduction -============== +libnetworkcache +=============== 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. API -====== +--- So, it must provide 2 methods: put(file) diff --git a/slapos/README.proxy.txt b/slapos/README.proxy.txt index 51179af70f7c072a89502a91da4b73d831f93559..afab973c98db690b98914527fca371072300c937 100644 --- a/slapos/README.proxy.txt +++ b/slapos/README.proxy.txt @@ -1,3 +1,2 @@ -slapproxy -========= - +proxy +===== diff --git a/slapos/README.slap.txt b/slapos/README.slap.txt index 4d358f45249aad81133548a39980f85e5e24b4dd..45bda30dba07b9a7f0d2817258f0dbae8a49c00a 100644 --- a/slapos/README.slap.txt +++ b/slapos/README.slap.txt @@ -4,7 +4,7 @@ slap Simple Language for Accounting and Provisioning python library. Developer note - python version -=============================== +------------------------------- This library is used on client (slapgrid) and server side. 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 on python2.4 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.