[DOC] document additional generic driver configuration options

Bug #1944696 reported by Arturo Borrero Gonzalez
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Shared File Systems Service (Manila)
Fix Released
Arturo Borrero Gonzalez

Bug Description

Dear developers,

thanks for your hard work with openstack manila. It is really appreciated.

This bug report refers to the documentation of the project. We've been reading the documentation, and detected this:

* some drivers have extensive documentation on how to configure/setup them, for example ZFS on Linux: https://docs.openstack.org/manila/latest/admin/zfs_on_linux_driver.html#backend-configuration This includes the configuration options that make sense for manila.conf and such.

* some other drivers, for example the generic one, lacks this information: https://docs.openstack.org/manila/latest/admin/generic_driver.html

Several configuration modes are mentioned in that document, but they aren't described anywhere.

Specifically, it would be great if you can include documentation on how configure the share backend when using:

=== 8< ===
share_driver = manila.share.drivers.generic.GenericShareDriver
driver_handles_share_servers = False
# what other options are expected here?

share_driver = manila.share.drivers.generic.GenericShareDriver
driver_handles_share_servers = True
# what other options are expected here?
=== 8< ===

In the example manila.conf file, each configuration option has a small comment like this:

=== 8< ===
# Name or ID of service instance in Nova to use for share exports.
# Used only when share servers handling is disabled. (string value)
#service_instance_name_or_id = <None>
=== 8< ===

But is not enough to get a general overview of what we are supposed to configure. For someone new to openstack manila this guessing game can be discouraging.

Would it be possible to get a sample manila.conf file for both cases? (I mean DHSS=false and DHSS=true)

Tags: doc driver
Vida Haririan (vhariria)
summary: - document additional generic driver configuration options
+ [DOC] document additional generic driver configuration options
tags: added: doc
tags: added: driver
Revision history for this message
Goutham Pacha Ravi (gouthamr) wrote :

Hi Arturo,

Thank you so much for taking the time to fill out this bug report and for submitting a fix! I missed your ping on IRC; we'll try to get this fix reviewed and merged: https://review.opendev.org/c/openstack/manila/+/810719

Vida Haririan (vhariria)
Changed in manila:
assignee: nobody → Arturo Borrero Gonzalez (arturoborrero)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to manila (master)

Reviewed: https://review.opendev.org/c/openstack/manila/+/810719
Committed: https://opendev.org/openstack/manila/commit/666403169e034f51d3b22f255d11b6ccd9e641c0
Submitter: "Zuul (22348)"
Branch: master

commit 666403169e034f51d3b22f255d11b6ccd9e641c0
Author: Arturo Borrero Gonzalez <email address hidden>
Date: Thu Sep 23 17:00:20 2021 +0200

    doc: admin: generic_driver: extend documentation

    Hopefully this will make life easier to those looking at Manila
    for the first time.

    Closes-Bug: #1944696
    Signed-off-by: Arturo Borrero Gonzalez <email address hidden>
    Change-Id: Ifc40db7540612c30abec95562b5688da3873fbbc

Changed in manila:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/manila

This issue was fixed in the openstack/manila release candidate.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.