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

Stabilise documentation a bit.

Mostly formatting changes and few obvious mistakes.
parent 86c55cc8
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
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?
-----------
......
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
=========
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.
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