manila/doc/source/install/common/dhss-true-mode-configuration.rst
Goutham Pacha Ravi 9b21f4e476 [doc] Fix config and install guide for the generic driver
The generic driver needs to communicate with cinder, nova, neutron
and glance. It does so using credentials set in the configuration
file; some of this information was missing in our install and config
guides.

Change-Id: Ia7dc0e441057487e42b356b5d0ee22d5615be0a5
Closes-Bug: #1948646
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2021-10-26 22:08:36 +00:00

108 lines
3.3 KiB
ReStructuredText

Configure components
--------------------
#. Edit the ``/etc/manila/manila.conf`` file and complete the following
actions:
* In the ``[DEFAULT]`` section, enable the generic driver and the NFS
protocol:
.. code-block:: ini
[DEFAULT]
...
enabled_share_backends = generic
enabled_share_protocols = NFS
.. note::
Back end names are arbitrary. As an example, this guide uses the name
of the driver.
* In the ``[neutron]``, ``[nova]``, ``[cinder]`` and ``[glance]`` sections,
enable authentication for those services:
.. code-block:: ini
[neutron]
...
url = http://controller:9696
www_authenticate_uri = http://controller:5000
auth_url = http://controller:5000
memcached_servers = controller:11211
auth_type = password
project_domain_name = Default
user_domain_name = Default
region_name = RegionOne
project_name = service
username = neutron
password = NEUTRON_PASS
[nova]
...
www_authenticate_uri = http://controller:5000
auth_url = http://controller:5000
memcached_servers = controller:11211
auth_type = password
project_domain_name = Default
user_domain_name = Default
region_name = RegionOne
project_name = service
username = nova
password = NOVA_PASS
[cinder]
...
www_authenticate_uri = http://controller:5000
auth_url = http://controller:5000
memcached_servers = controller:11211
auth_type = password
project_domain_name = Default
user_domain_name = Default
region_name = RegionOne
project_name = service
username = cinder
password = CINDER_PASS
[glance]
...
www_authenticate_uri = http://controller:5000
auth_url = http://controller:5000
memcached_servers = controller:11211
auth_type = password
project_domain_name = Default
user_domain_name = Default
region_name = RegionOne
project_name = service
username = glance
password = GLANCE_PASS
* In the ``[generic]`` section, configure the generic driver:
.. code-block:: ini
[generic]
share_backend_name = GENERIC
share_driver = manila.share.drivers.generic.GenericShareDriver
driver_handles_share_servers = True
service_instance_flavor_id = 100
service_image_name = manila-service-image
service_instance_user = manila
service_instance_password = manila
interface_driver = manila.network.linux.interface.BridgeInterfaceDriver
.. note::
You can also use SSH keys instead of password authentication for
service instance credentials.
.. important::
The ``service_image_name``, ``service_instance_flavor_id``,
``service_instance_user`` and ``service_instance_password`` are with
reference to the service image that is used by the driver to create
share servers. A sample service image for use with the ``generic``
driver is available in the ``manila-image-elements`` project. Its
creation is explained in the post installation steps (See:
:ref:`post-install`).