openstack/sahara
Code Issues Proposed changes

[DOC] update configuration guide doc

Browse Source 
Change-Id: I6377f4bcebf045770b66cadb35153a9da9e8bf7b
This commit is contained in:
Michael Ionkin 2016-09-16 14:39:53 +03:00
parent 4439daca6d
commit 205a5f0281
1 changed files with 4 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
doc/source/userdoc/configuration.guide.rst
View File

@ -21,8 +21,6 @@ command:
$ tox -e genconfig
..
Running this command will create a file named ``sahara.conf.sample``
in the ``etc/sahara`` directory of the project.
@ -34,7 +32,6 @@ database. For example, the connection string for a MySQL database will be:
.. sourcecode:: cfg
connection=mysql://username:password@host:port/database
..
Next you will configure the Identity service parameters in the
``[keystone_authtoken]`` section. The ``auth_uri`` parameter
@ -45,7 +42,6 @@ should point to the admin Identity API endpoint. For example:
auth_uri=http://127.0.0.1:5000/v2.0/
identity_uri=http://127.0.0.1:35357/
..
Specify the ``admin_user``, ``admin_password`` and ``admin_tenant_name``.
These parameters must specify an Identity user who has the ``admin`` role
@ -59,7 +55,6 @@ in the ``[DEFAULT]`` section:
.. sourcecode:: cfg
use_neutron=true
..
If you are using nova-network for networking then this parameter should
be set to ``false``.
@ -101,7 +96,7 @@ Floating IP management
++++++++++++++++++++++
During cluster setup sahara must access instances through a secure
shell(SSH). To establish this connection it may use either the fixed
shell (SSH). To establish this connection it may use either the fixed
or floating IP address of an instance. By default sahara is configured
to use floating IP addresses for access. This is controlled by the
``use_floating_ips`` configuration parameter. With this setup the user
@ -146,7 +141,6 @@ of the configuration file:
[oslo_messaging_notifications]
enable = true
..
And the following parameter ``driver`` should be set in the
``[oslo_messaging_notifications]`` section of the configuration file:
@ -155,7 +149,6 @@ And the following parameter ``driver`` should be set in the
[oslo_messaging_notifications]
driver = messaging
..
By default sahara is configured to use RabbitMQ as its message broker.
@ -165,7 +158,6 @@ following parameter in the ``[DEFAULT]`` section:
.. sourcecode:: cfg
rpc_backend = rabbit
..
You may also need to specify the connection parameters for your
RabbitMQ installation. The following example shows the default
@ -189,28 +181,13 @@ Orchestration configuration
By default sahara is configured to use the heat engine for instance
creation. The heat engine uses the OpenStack Orchestration service to
provision instances. Sahara can be configured to use the direct engine for
this purpose, but after the Liberty release it will be removed. This
engine makes calls directly to the services required for instance
provisioning. We recommend using the OpenStack Orchestration service.
To configure sahara to use the direct engine for instance
provisioning the ``infrastructure_engine`` parameter should be modified in
the configuration file as follows:
.. sourcecode:: cfg
[DEFAULT]
infrastructure_engine=direct
.. warning::
The direct engine will be removed after the Liberty release, we
recommend using the heat engine.
provision instances. This engine makes calls directly to the services required
for instance provisioning.
.. _policy-configuration-label:
Policy configuration
---------------------------
--------------------
Sahara’s public API calls may be restricted to certain sets of users by
using a policy configuration file. The location of the policy file(s)