[DOC] document additional generic driver configuration options
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
OpenStack Shared File Systems Service (Manila) |
Fix Released
|
Undecided
|
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:/
* some other drivers, for example the generic one, lacks this information: https:/
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< ===
[mybackend1]
share_driver = manila.
driver_
# what other options are expected here?
[mybackend2]
share_driver = manila.
driver_
# 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_
=== 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)
summary: |
- document additional generic driver configuration options + [DOC] document additional generic driver configuration options |
tags: | added: doc |
tags: | added: driver |
Changed in manila: | |
assignee: | nobody → Arturo Borrero Gonzalez (arturoborrero) |
status: | New → In Progress |
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