Commit 8a41e3cf authored by Jérome Perrin's avatar Jérome Perrin

*.rst: fix rst syntax (so that hopefully it renders correctly on pypi)

parent 7b1db16a
...@@ -4,12 +4,12 @@ generic_cloudooo ...@@ -4,12 +4,12 @@ generic_cloudooo
The generic_cloudooo recipe helps you to deploy cloudooo services with their configuration files. The generic_cloudooo recipe helps you to deploy cloudooo services with their configuration files.
How to use? How to use generic_cloudooo?
----------- ----------------------------
Here is an example of a section to add in your software.cfg : Here is an example of a section to add in your software.cfg :
.. code-block:: .. code-block:: ini
[cloudooo-configuration] [cloudooo-configuration]
recipe = slapos.cookbook:generic_cloudooo recipe = slapos.cookbook:generic_cloudooo
...@@ -42,7 +42,7 @@ Where : ...@@ -42,7 +42,7 @@ Where :
order to make the global mimetype at the bottom of the list. order to make the global mimetype at the bottom of the list.
(i.e. `* * ooo` > `text/* * ooo`) (i.e. `* * ooo` > `text/* * ooo`)
.. code-block:: .. code-block:: ini
mimetype_entry_addition = mimetype_entry_addition =
<input_format> <output_format> <handler> <input_format> <output_format> <handler>
...@@ -57,7 +57,7 @@ Where : ...@@ -57,7 +57,7 @@ Where :
Default mimetype registry Default mimetype registry
------------------------- -------------------------
.. code-block:: .. code-block:: ini
application/vnd.oasis.opendocument* * ooo application/vnd.oasis.opendocument* * ooo
application/vnd.sun.xml* * ooo application/vnd.sun.xml* * ooo
......
...@@ -4,12 +4,12 @@ generic_varnish ...@@ -4,12 +4,12 @@ generic_varnish
This recipe creates a varnish instance dedicated for ERP5 with a web checker[1] This recipe creates a varnish instance dedicated for ERP5 with a web checker[1]
set up. set up.
How to Use How to Use generic_varnish ?
========== ============================
On slap console, you can instanciate varnish like this: On slap console, you can instanciate varnish like this::
instance = request( instance = request(
software_type='varnish', software_type='varnish',
partition_parameter_kw={ partition_parameter_kw={
'backend-url':'https://[your_backend_address]:your_backend_port', 'backend-url':'https://[your_backend_address]:your_backend_port',
...@@ -17,7 +17,7 @@ instance = request( ...@@ -17,7 +17,7 @@ instance = request(
'web-checker-mail-address':'web-checker-result@example.com', 'web-checker-mail-address':'web-checker-result@example.com',
'web-checker-smtp-host':'mail.example.com', 'web-checker-smtp-host':'mail.example.com',
} }
) )
backend-url is the backend url that varnish will cache. backend-url is the backend url that varnish will cache.
......
kvm kvm
=== ===
Introduction kvm: Introduction
------------ -----------------
The erp5.recipe.kvm aims to integrate KVM setups and buildout. This recipe is 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. able to download one remote image and setup a KVM environment to use it.
......
kvm_frontend kvm_frontend
============= =============
Introduction kvm_frontend: Introduction
------------ ---------------------------
The ``slapos.recipe.kvm_frontend`` aims to provide proxy server to KVM instances. The ``slapos.recipe.kvm_frontend`` aims to provide proxy server to KVM instances.
...@@ -13,44 +13,40 @@ It works following the master/slave instances system. A master instance is ...@@ -13,44 +13,40 @@ It works following the master/slave instances system. A master instance is
created, containing all what is needed to run the proxy. Slave instances created, containing all what is needed to run the proxy. Slave instances
are later created, adding one line in the master instance's proxy configuration are later created, adding one line in the master instance's proxy configuration
that specify the IP/port to proxy to the KVM. that specify the IP/port to proxy to the KVM.
The slave instance (kvm) is then accessible from The slave instance (kvm) is then accessible from
http://[masterinstanceIPorhostname]/[randomgeneratednumber] http://[masterinstanceIPorhostname]/[randomgeneratednumber]
Instance parameters Instance parameters
------------ -------------------
Incoming master instance parameters Incoming master instance parameters
+++++++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``port`` - Port of server, optional, defaults to 4443. * ``port`` - Port of server, optional, defaults to 4443.
``domain`` - domain name to use, optional, default to * ``domain`` - domain name to use, optional, default to ``host.vifib.net``.
"host.vifib.net". * ``redirect_plain_http`` - if value is one of ``['y', 'yes', '1', 'true']``,
``redirect_plain_http`` - if value is one of ['y', 'yes', '1', 'true'], instance will try to create a simple http server on port 80 redirecting to the proxy. Optional.
will try to create a simple http server on port 80
redirecting to the proxy. Optional.
Incoming slave instance parameters Incoming slave instance parameters
+++++++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``host`` - KVM instance IP or hostname. Mandatory. * ``host`` - KVM instance IP or hostname. Mandatory.
``port`` - KVM instance port, Mandatory. * ``port`` - KVM instance port, Mandatory.
``https`` - if value is one of ['n', 'no', '0', 'false'], will try to connect * ``https`` - if value is one of ``['n', 'no', '0', 'false']``, will try to connect to target in plain http. Optional.
to target in plain http. Optional.
Connection parameters Connection parameters
------------- ---------------------
Outgoing master connection parameters Outgoing master connection parameters
+++++++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``domain_ipv6_address`` - Proxy IP * ``domain_ipv6_address`` - Proxy IP
``site_url`` - Proxy URL * ``site_url`` - Proxy URL
Outgoing slave connection parameters are : Outgoing slave connection parameters
+++++++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``site_url`` - URL of instance * ``site_url`` - URL of instance
``domain_name`` - Domain name of proxy * ``domain_name`` - Domain name of proxy
``port`` - Port of proxy * ``port`` - Port of proxy
...@@ -6,12 +6,12 @@ able to setup mariadb, apache and apache-php for your php application, and is al ...@@ -6,12 +6,12 @@ able to setup mariadb, apache and apache-php for your php application, and is al
configuring your software during installation to ensure a full compatibility. configuring your software during installation to ensure a full compatibility.
How to use? How to use lamp ?
----------- -----------------
just add this part in your software.cfg to use the lamp.simple module just add this part in your software.cfg to use the lamp.simple module
.. code-block:: .. code-block:: ini
[instance-recipe] [instance-recipe]
egg = slapos.cookbook egg = slapos.cookbook
...@@ -19,7 +19,7 @@ just add this part in your software.cfg to use the lamp.simple module ...@@ -19,7 +19,7 @@ just add this part in your software.cfg to use the lamp.simple module
you also need to extend lamp.cfg you also need to extend lamp.cfg
.. code-block:: .. code-block:: ini
extends = extends =
https://lab.nexedi.com/nexedi/slapos/raw/slapos-0.50/stack/lamp.cfg https://lab.nexedi.com/nexedi/slapos/raw/slapos-0.50/stack/lamp.cfg
...@@ -35,13 +35,13 @@ in this case you need to write a python script and lamp recipe must run it when ...@@ -35,13 +35,13 @@ in this case you need to write a python script and lamp recipe must run it when
How to use? How to use lamp.runner ?
----------- ------------------------
this part of lamp recipe work with slapos.toolbox, Therefore you must add it to your recipe. this part of lamp recipe work with slapos.toolbox, Therefore you must add it to your recipe.
in software.cfg, replace instance-recipe-egg part by in software.cfg, replace instance-recipe-egg part by
.. code-block:: .. code-block:: ini
[instance-recipe-egg] [instance-recipe-egg]
recipe = zc.recipe.egg recipe = zc.recipe.egg
...@@ -52,7 +52,7 @@ in software.cfg, replace instance-recipe-egg part by ...@@ -52,7 +52,7 @@ in software.cfg, replace instance-recipe-egg part by
and add into your instance.cfg and add into your instance.cfg
.. code-block:: .. code-block:: ini
lampconfigure_directory = ${buildout:bin-directory}/lampconfigure lampconfigure_directory = ${buildout:bin-directory}/lampconfigure
...@@ -71,10 +71,10 @@ you can also use database to check condition. add :: ...@@ -71,10 +71,10 @@ you can also use database to check condition. add ::
table_name = name_of_table table_name = name_of_table
constraint = sql_where_condition constraint = sql_where_condition
name_of_table is the full or partial name(in some cases we can not know the prefix used to create tables) of table ``name_of_table`` is the full or partial name(in some cases we can not know the prefix used to create tables) of table
into mariadb databse for example table_name = admin. if you use into mariadb databse for example ``table_name = admin``. if you use
name_of_table = **, the action will begin when database is ready. ``name_of_table = **``, the action will begin when database is ready.
constraint is the sql_condition to use when search entry into name_of_table for example constraint = `admin_id`=1 constraint is the sql_condition to use when search entry into name_of_table for example constraint = ``admin_id=1``
you can't use file_token and table_name at the same time, otherwise file_token will be used in priority. Beware of conditions that will never be satisfied. you can't use file_token and table_name at the same time, otherwise file_token will be used in priority. Beware of conditions that will never be satisfied.
...@@ -115,7 +115,7 @@ mode = mode_to_apply (ex= 0644) ...@@ -115,7 +115,7 @@ mode = mode_to_apply (ex= 0644)
use script = ${configure-script:location}/${configure-script:filename} into instance.cfg, add part configure-script use script = ${configure-script:location}/${configure-script:filename} into instance.cfg, add part configure-script
into software.cfg into software.cfg
.. code-block:: .. code-block:: ini
parts = configure-script parts = configure-script
......
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