openstack/deb-sahara
Code Issues Proposed changes

Focus the documentation on distributed mode

Browse Source 
It was introduced for a few releases and it is the suggested deployment mode.

Change-Id: Ib72d31eb44344100c74dd2420993b4c8b92acbe3
This commit is contained in:
Luigi Toscano 2016-04-20 11:08:53 +02:00
parent 75c5e8da33
commit ef0bf04801
3 changed files with 19 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/userdoc/features.rst
View File

@ -92,10 +92,9 @@ documentation.
Distributed Mode Distributed Mode
---------------- ----------------
The :doc:`installation.guide` suggests launching sahara as a single The :doc:`installation.guide` suggests launching sahara in distributed mode
``sahara-all`` process. It is also possible to run sahara in distributed with ``sahara-api`` and ``sahara-engine`` processes potentially running on
mode with ``sahara-api`` and ``sahara-engine`` processes running on several several machines simultaneously. Running in distributed mode allows sahara to
machines simultaneously. Running in distributed mode allows sahara to
offload intensive tasks to the engine processes while keeping the API offload intensive tasks to the engine processes while keeping the API
process free to handle requests. process free to handle requests.

21
doc/source/userdoc/installation.guide.rst
View File

@ -51,18 +51,20 @@ To install with RDO
5. Go through :ref:`common_installation_steps` and make any 5. Go through :ref:`common_installation_steps` and make any
necessary changes. necessary changes.
6. Start the sahara-all service: 6. Start the sahara-api and sahara-engine services:
.. sourcecode:: console .. sourcecode:: console
# systemctl start openstack-sahara-all # systemctl start openstack-sahara-api
# systemctl start openstack-sahara-engine
.. ..
7. *(Optional)* Enable sahara to start on boot 7. *(Optional)* Enable sahara services to start on boot
.. sourcecode:: console .. sourcecode:: console
# systemctl enable openstack-sahara-all # systemctl enable openstack-sahara-api
# systemctl enable openstack-sahara-engine
.. ..
@ -167,11 +169,15 @@ installations of sahara.
$ sahara-venv/bin/sahara-db-manage --config-file sahara-venv/etc/sahara.conf upgrade head $ sahara-venv/bin/sahara-db-manage --config-file sahara-venv/etc/sahara.conf upgrade head
.. ..
3. To start sahara call: 3. Start sahara services from different terminals:
.. sourcecode:: console .. sourcecode:: console
$ sahara-venv/bin/sahara-all --config-file sahara-venv/etc/sahara.conf # first terminal
$ sahara-venv/bin/sahara-api --config-file sahara-venv/etc/sahara.conf
# second terminal
$ sahara-venv/bin/sahara-engine --config-file sahara-venv/etc/sahara.conf
.. ..
.. _register-sahara-label: .. _register-sahara-label:
@ -259,7 +265,8 @@ To get the list of all possible options run:
.. sourcecode:: console .. sourcecode:: console
$ sahara-venv/bin/python sahara-venv/bin/sahara-all --help $ sahara-venv/bin/python sahara-venv/bin/sahara-api --help
$ sahara-venv/bin/python sahara-venv/bin/sahara-engine --help
.. ..

4
sahara/config.py
View File

@ -85,8 +85,8 @@ networking_opts = [
cfg.BoolOpt('use_rootwrap', cfg.BoolOpt('use_rootwrap',
default=False, default=False,
help="Use rootwrap facility to allow non-root users to run " help="Use rootwrap facility to allow non-root users to run "
"the sahara-all server instance and access private " "the sahara services and access private network IPs "
"network IPs (only valid to use in conjunction with " "(only valid to use in conjunction with "
"use_namespaces=True)"), "use_namespaces=True)"),
cfg.StrOpt('rootwrap_command', cfg.StrOpt('rootwrap_command',
default='sudo sahara-rootwrap /etc/sahara/rootwrap.conf', default='sudo sahara-rootwrap /etc/sahara/rootwrap.conf',