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

Stabilise documentation a bit.

Mostly formatting changes and few obvious mistakes.
parent 86c55cc8
master bk_master bk_ncurses fix_onlyoffice_core_out_of_memory json_schema_changes onlyoffice-core pypi_url_change revert wip/feat/json-test-failure 20120218 20110914-CR1108b 20110914-CR1108b-cookbook 20110823-CR1108-zeosizefix 20110823-CR1108-zeosizefix-cookbook 20110722-CR1108 20110720-CR1056 20110720-CR1056-cookbook 20110617 1.0.13 1.0.12 1.0.11 1.0.10 1.0.9 1.0.8.1 1.0.8 1.0.7 1.0.6 1.0.5 1.0.4 1.0.3 1.0.2 1.0.1 vifib-20150331 vifib-20150203 vifib-20150130 vifib-20150123 vifib-20150116 vifib-20141222 vifib-20141119 slaprunner-resilient-v1 slaprunner-resilient-v1-RC1 slapos.core-1.0.0rc6-1 slapos.cookbook-0.102 slapos.cookbook-0.101 slapos.cookbook-0.100 slapos.cookbook-0.99 slapos.cookbook-0.98 slapos.cookbook-0.97 slapos.cookbook-0.96 slapos.cookbook-0.95 slapos.cookbook-0.94 slapos.cookbook-0.93 slapos.cookbook-0.92 slapos.cookbook-0.91 slapos.cookbook-0.90 slapos.cookbook-0.89 slapos.cookbook-0.88 slapos.cookbook-0.87 slapos.cookbook-0.86 slapos.cookbook-0.85 slapos.cookbook-0.84.2 slapos.cookbook-0.84.1 slapos.cookbook-0.84 slapos.cookbook-0.83.1 slapos.cookbook-0.83 slapos.cookbook-0.82 slapos.cookbook-0.81 slapos.cookbook-0.80 slapos.cookbook-0.79 slapos.cookbook-0.78.5 slapos.cookbook-0.78.4 slapos.cookbook-0.78.3 slapos.cookbook-0.78.2 slapos.cookbook-0.78.1 slapos.cookbook-0.78.0 slapos.cookbook-0.77.1 slapos.cookbook-0.77.0 slapos.cookbook-0.76.0 slapos.cookbook-0.75.0 slapos.cookbook-0.74.0 slapos.cookbook-0.73.1 slapos.cookbook-0.72.0 slapos.cookbook-0.71.4 slapos.cookbook-0.71.3 slapos.cookbook-0.71.2 slapos.cookbook-0.71.1 slapos.cookbook-0.71 slapos.cookbook-0.70 slapos.cookbook-0.69 slapos.cookbook-0.68.1 slapos.cookbook-0.68 slapos.cookbook-0.67 slapos.cookbook-0.66 slapos.cookbook-0.64.2 slapos.cookbook-0.64.1 slapos.cookbook-0.64 slapos.cookbook-0.63 slapos.cookbook-0.62 slapos.cookbook-0.61 slapos.cookbook-0.60 slapos.cookbook-0.59 slapos.cookbook-0.58 slapos.cookbook-0.57 slapos.cookbook-0.55 slapos.cookbook-0.54.1 slapos.cookbook-0.54 slapos.cookbook-0.53 slapos.cookbook-0.51 slapos.cookbook-0.50 slapos.cookbook-0.49 slapos.cookbook-0.48 slapos.cookbook-0.47 slapos.cookbook-0.46 slapos.cookbook-0.45 slapos.cookbook-0.44 slapos.cookbook-0.43 slapos.cookbook-0.42 slapos.cookbook-0.41 slapos.cookbook-0.40.1 slapos.cookbook-0.40 slapos.cookbook-0.39 slapos.cookbook-0.38 slapos.cookbook-0.37 slapos.cookbook-0.35 slapos.cookbook-0.34 slapos.cookbook-0.33 slapos.cookbook-0.32 slapos.cookbook-0.31 slapos.cookbook-0.30 slapos.cookbook-0.29 slapos.cookbook-0.28 slapos.cookbook-0.27 slapos.cookbook-0.26 slapos.cookbook-0.25 slapos.cookbook-0.24 slapos.cookbook-0.23 slapos.cookbook-0.20 slapos.cookbook-0.19 slapos.cookbook-0.18 slapos.cookbook-0.17 slapos.cookbook-0.16 slapos.cookbook-0.15 slapos.cookbook-0.14 slapos.cookbook-0.13 slapos.cookbook-0.12 slapos.cookbook-0.11 slapos.cookbook-0.10 slapos.cookbook-0.9 slapos.cookbook-0.8 slapos.cookbook-0.7 slapos.cookbook-0.6 slapos.cookbook-0.5 slapos.cookbook-0.4 slapos.cookbook-0.3 slapos.cookbook-0.2 slapos.cookbook-0.1 slapos-legacy-flask-stack slapos-159 slapos-0.271 slapos-0.270 slapos-0.269 slapos-0.268 slapos-0.267 slapos-0.266 slapos-0.265 slapos-0.264 slapos-0.263 slapos-0.262 slapos-0.261 slapos-0.260 slapos-0.259.2 slapos-0.259.1 slapos-0.259 slapos-0.258 slapos-0.257 slapos-0.256 slapos-0.255 slapos-0.254 slapos-0.253.3 slapos-0.253.2 slapos-0.253.1 slapos-0.253 slapos-0.252.1 slapos-0.252 slapos-0.251 slapos-0.250.2 slapos-0.250.1 slapos-0.250 slapos-0.249.1 slapos-0.249 slapos-0.248.1 slapos-0.248 slapos-0.247.1 slapos-0.247 slapos-0.246 slapos-0.245 slapos-0.244 slapos-0.243 slapos-0.242 slapos-0.241 slapos-0.240.0 slapos-0.240 slapos-0.239 slapos-0.238 slapos-0.237 slapos-0.236 slapos-0.235 slapos-0.234 slapos-0.233 slapos-0.232 slapos-0.231 slapos-0.230 slapos-0.229 slapos-0.228 slapos-0.227 slapos-0.226 slapos-0.225 slapos-0.224 slapos-0.223.1 slapos-0.223 slapos-0.222 slapos-0.221 slapos-0.220 slapos-0.219 slapos-0.218.2 slapos-0.218.1 slapos-0.218 slapos-0.217 slapos-0.217-B1 slapos-0.216 slapos-0.215 slapos-0.214 slapos-0.213 slapos-0.212 slapos-0.211 slapos-0.210 slapos-0.209 slapos-0.208 slapos-0.207 slapos-0.206 slapos-0.205 slapos-0.204 slapos-0.203 slapos-0.202 slapos-0.201 slapos-0.200 slapos-0.199 slapos-0.199-hotfix-20140409 slapos-0.198 slapos-0.197 slapos-0.196 slapos-0.195 slapos-0.194-RC3 slapos-0.194-RC2 slapos-0.194-RC1 slapos-0.193 slapos-0.192 slapos-0.191 slapos-0.190 slapos-0.189 slapos-0.188 slapos-0.187 slapos-0.186 slapos-0.185 slapos-0.184 slapos-0.183 slapos-0.182 slapos-0.181 slapos-0.180 slapos-0.179 slapos-0.178 slapos-0.177.5 slapos-0.177.4 slapos-0.177.3 slapos-0.177.2 slapos-0.177.1 slapos-0.177 slapos-0.176.4 slapos-0.176.3 slapos-0.176.2 slapos-0.176.1 slapos-0.176 slapos-0.175 slapos-0.174 slapos-0.173 slapos-0.172 slapos-0.171 slapos-0.170 slapos-0.169 slapos-0.168.9 slapos-0.168.8 slapos-0.168.7 slapos-0.168.6 slapos-0.168.5 slapos-0.168.4 slapos-0.168.3 slapos-0.168.2 slapos-0.168.1 slapos-0.168 slapos-0.167 slapos-0.166 slapos-0.165 slapos-0.164 slapos-0.163 slapos-0.162 slapos-0.161 slapos-0.160 slapos-0.159 slapos-0.158 slapos-0.157 slapos-0.156 slapos-0.155 slapos-0.154 slapos-0.153 slapos-0.152 slapos-0.151 slapos-0.150 slapos-0.149 slapos-0.148 slapos-0.147 slapos-0.146 slapos-0.145 slapos-0.144 slapos-0.143 slapos-0.142 slapos-0.141 slapos-0.140 slapos-0.139 slapos-0.138 slapos-0.137 slapos-0.136 slapos-0.135.1 slapos-0.135 slapos-0.134 slapos-0.133 slapos-0.132 slapos-0.131 slapos-0.130 slapos-0.129 slapos-0.128 slapos-0.127 slapos-0.126 slapos-0.125 slapos-0.124 slapos-0.123 slapos-0.122 slapos-0.121 slapos-0.120 slapos-0.119 slapos-0.118 slapos-0.117.1 slapos-0.117 slapos-0.116 slapos-0.115 slapos-0.114 slapos-0.113 slapos-0.112 slapos-0.111 slapos-0.110 slapos-0.109 slapos-0.108 slapos-0.107 slapos-0.106 slapos-0.105 slapos-0.104 slapos-0.103 slapos-0.102 slapos-0.101 slapos-0.100 slapos-0.99 slapos-0.98.2 slapos-0.98.1 slapos-0.98 slapos-0.97 slapos-0.96 slapos-0.95 slapos-0.94 slapos-0.93 slapos-0.92 slapos-0.91 slapos-0.90 slapos-0.89 slapos-0.88 slapos-0.87 slapos-0.86 slapos-0.85 slapos-0.84 slapos-0.83 slapos-0.82 slapos-0.81 slapos-0.80 slapos-0.79 slapos-0.78 slapos-0.77 slapos-0.76 slapos-0.75.2 slapos-0.75.1 slapos-0.75 slapos-0.74 slapos-0.73.1 slapos-0.73 slapos-0.72 slapos-0.71 slapos-0.70 slapos-0.69 slapos-0.68 slapos-0.67 slapos-0.66 slapos-0.65 slapos-0.64 slapos-0.63 slapos-0.62 slapos-0.61 slapos-0.60 slapos-0.59 slapos-0.58 slapos-0.57 slapos-0.56 slapos-0.55 slapos-0.54 slapos-0.53 slapos-0.52 slapos-0.51 slapos-0.50 slapos-0.49 slapos-0.48 slapos-0.47 slapos-0.46 slapos-0.45 slapos-0.44 slapos-0.43 slapos-0.42 slapos-0.41 slapos-0.40 slapos-0.39 slapos-0.38 slapos-0.37 slapos-0.36 slapos-0.35 slapos-0.34 slapos-0.33 slapos-0.32 slapos-0.31 slapos-0.30 slapos-0.29 slapos-0.28 slapos-0.27 slapos-0.26 slapos-0.25 slapos-0.24 slapos-0.23 slapos-0.22 slapos-0.21 slapos-0.20 slapos-0.19 slapos-0.18 slapos-0.17 slapos-0.16 slapos-0.16-hotfix slapos-0.16-hotfix-4 slapos-0.16-hotfix-3 slapos-0.16-hotfix-2 slapos-0.15 slapos-0.14 slapos-0.13 slapos-0.12 slapos-0.11 slapos-0.10 slapos-0.9 slapos-0.8 slapos-0.7 slapos-0.6 slapos-0.5 slapos-0.4 slapos-0.3 slapos-0.2 slapos-0.1 erp5-cluster-0.1.1 cygwin-resstack-3 cygwin-resstack-2 cygwin-resstack-1 cygwin-cachetest-4 cygwin-cachetest-3 cygwin-cachetest-2 cygwin-cachetest-1 apache_frontend_prod_test CR1094
No related merge requests found
slapos.recipe.build
===================
build
=====
Recipe to build the software.
......@@ -9,11 +9,9 @@ Example buildout::
parts =
file
develop = slapos.recipe.build
[zlib]
# Use standard configure, make, make install way
recipe = slapos.recipe.build:cmmi
recipe = slapos.cookbook:build
url = http://prdownloads.sourceforge.net/libpng/zlib-1.2.5.tar.gz?download
md5sum = c735eab2d659a96e5a594c9e8541ad63
slapos_promisee =
......@@ -33,7 +31,7 @@ slapos_promisee =
file:share/man/man3/zlib.3
[file]
recipe = slapos.recipe.build:cmmi
recipe = slapos.cookbook:buildcmmi
url = ftp://ftp.astron.com/pub/file/file-5.04.tar.gz
md5sum = accade81ff1cc774904b47c72c8aeea0
environment =
......@@ -64,7 +62,7 @@ slapos_promisee =
[somethingelse]
# default way with using script
recipe = slapos.recipe.build
recipe = slapos.cookbook:build
url_0 = http://host/path/file.tar.gz
md5sum = 9631070eac74f92a812d4785a84d1b4e
script =
......@@ -76,14 +74,6 @@ script =
slapos_promisee =
...
[anythingelse]
# reusing different recipe?
recipe = slapos.recipe.build:backend
backend = hexagonit.recipe.cmmi
slapos_promisee =
...
# parameters to build
TODO:
* add linking suport, buildout definition:
......
slapos.recipe.download
======================
download
========
Extremely simple recipe to download using zc.buildout download utility.
......@@ -11,7 +11,7 @@ Usage
download
[download]
recipe = slapos.recipe.download
recipe = slapos.cookbook:download
url = https://some.url/file
Such profile will download https://some.url/file and put it in
......
The slapos.recipe.erp5 aims to instanciate an ERP5 environnment
===============================================================
erp5
====
Instantiates ERP5 instance.
The erp5.recipe.tesnode aims to install generic erp5 testnode.
erp5testnode
============
The slapos.recipe.helloworld is used as a recipe to test slapos functionnalities. It only installs a dummy wrapper saying "Hello World!" and sends to the master an "HelloWorld" parameter.
helloworld
==========
It only installs a dummy wrapper saying "Hello World!" and sends to the master an "HelloWorld" parameter.
slapos.recipe.java
=====================
java
====
This recipe downloads and installs java in your buildout.
......@@ -15,18 +15,18 @@ Buildout configuration:
...
[java]
recipe = slapos.recipe.java
recipe = slapos.cookbook:java
By default it will fetch Java 6u25, but you might want to install from another location or another version like this::
[java]
recipe = slapos.recipe.java
recipe = slapos.cookbook:java
download-url = ftp://location/to/self-extracting/java.bin
Or you can install openjdk instead.
[java]
recipe = slapos.recipe.java
recipe = slapos.cookbook:java
flavour = openjdk
......
kvm
===
Introduction
============
------------
The erp5.recipe.kvm aims to integrate KVM setups and buildout. This recipe is
able to download one remote image and setup a KVM environment to use it.
......@@ -8,13 +11,13 @@ This recipe is also capable to reuse images or partitions already present on
disk to create the setup.
Examples
========
--------
The follow examples lists different kind of configurations.
KVM with Remote and gzipped Image
----------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[kvm-testing-with-remote-gzip-image]
image = http://URL/public.mdv2010.0_x86_64.qcow2.img.gz
......@@ -51,7 +54,7 @@ KVM with Remote and gzipped Image
ssh_key_path = /path/to/mykey.key
KVM with Remote and raw Image
----------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[kvm-testing-with-remote-raw-image]
image = http://URL/public.mdv2010.0_x86_64.qcow2.img
......@@ -63,7 +66,7 @@ KVM with Remote and raw Image
### The Rest Same configuration as previous ###
KVM with direct local Image file
----------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This does not copy and/or download the image.
......@@ -75,7 +78,7 @@ This does not copy and/or download the image.
### The Rest Same configuration as previous ###
KVM with a linux partition
----------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~
This does not copy and/or download the image.
......@@ -87,7 +90,7 @@ This does not copy and/or download the image.
Options
=======
-------
location
......@@ -188,7 +191,7 @@ kvm_run_directory
Generated Commands
====================
------------------
Few scripts are generated to you manage your KVM instance. The scripts names are
created with the followed standard:
......@@ -196,7 +199,7 @@ created with the followed standard:
KVM-PARTS-NAME-ctl
Commands usage
---------------
~~~~~~~~~~~~~~
KVM-PARTS-NAME-ctl (start|stop|status|restart)
......
libcloud recipe
*********************
libcloud
========
Slapified recipe to interact with any libcloud supported IaaS system
\ No newline at end of file
Slapified recipe to interact with any libcloud supported IaaS system
libcloudrequest
===============
Library for creating SlapOS recipes for software instantiation
==============================================================
librecipe
=========
Thanks to using slapos.lib.recipe it is easier to create zc.buildout recipes in SlapOS environment.
Thanks to using slapos.cookbook:librecipe it is easier to create zc.buildout recipes in SlapOS environment.
How to use?
-----------
......
nbdserver
=========
slapos.recipe.nosqltestbed
==========================
nosqltestbed
============
The slapos.recipe.proactive aims to instantiate an proactive environment.
proactive
=========
Instantiate an proactive environment.
slapos.recipe.sheepdogtestbed
=============================
sheepdogtestbed
===============
Introduction
============
siptester
=========
slaprunner
==========
slapos.recipe.template
======================
template
========
Fully networked template recipe, reusing collective.recipe.template with
ability to download template over the network
......@@ -11,7 +11,7 @@ Usage
parts = template
[template]
recipe = slapos.recipe.template
recipe = slapos.cookbook:template
url = http://server/with/template
# optional md5sum
md5sum = 1234567890
......
The slapos.recipe.tesnode aims to install generic testnode.
testnode
========
Generic testnode.
vifib
=====
The slapos.recipe.xwiki aims to instantiate an xwiki environment.
xwiki
=====
Instantiates an xwiki environment.
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