manila-share failed to start cause of improper 'driver_handles_share_servers' for cephfs nfs

[Eric Xie]

I setup one share node with configurations below
[DEFAULT]
...
enabled_share_backends = lvm, cephfnfs1
enabled_share_protocols = NFS,CIFS,CEPHFS

[cephfsnfs1]
ganesha_rados_store_enable = True
ganesha_rados_store_pool_name = cephfs_data
driver_handles_share_servers = False
share_backend_name = CEPHFSNFS1
share_driver = manila.share.drivers.cephfs.driver.CephFSDriver
cephfs_protocol_helper_type = NFS
cephfs_conf_path = /etc/ceph/ceph.conf
cephfs_auth_id = manila
cephfs_cluster_name = ceph
cephfs_enable_snapshots = False
cephfs_ganesha_server_is_remote= True
cephfs_ganesha_server_ip = 172.16.2.6
cephfs_ganesha_server_username = root
cephfs_ganesha_server_password = xxx

When i restarted the manila-share service, got error:
2019-08-07 22:39:42.789 6892 CRITICAL manila [req-816c8416-280a-4a8d-9377-81ce87214812 - - - - -] Unhandled error: ManilaException: Config opt 'driver_handles_share_servers' has improper value - 'None'. Please define it as boolean.
2019-08-07 22:39:42.789 6892 ERROR manila Traceback (most recent call last):
2019-08-07 22:39:42.789 6892 ERROR manila File "/usr/bin/manila-share", line 10, in <module>
2019-08-07 22:39:42.789 6892 ERROR manila sys.exit(main())
2019-08-07 22:39:42.789 6892 ERROR manila File "/usr/lib/python2.7/dist-packages/manila/cmd/share.py", line 56, in main
2019-08-07 22:39:42.789 6892 ERROR manila coordination=True)
2019-08-07 22:39:42.789 6892 ERROR manila File "/usr/lib/python2.7/dist-packages/manila/service.py", line 197, in create
2019-08-07 22:39:42.789 6892 ERROR manila coordination=coordination)
2019-08-07 22:39:42.789 6892 ERROR manila File "/usr/lib/python2.7/dist-packages/manila/service.py", line 94, in __init__
2019-08-07 22:39:42.789 6892 ERROR manila *args, **kwargs)
2019-08-07 22:39:42.789 6892 ERROR manila File "/usr/lib/python2.7/dist-packages/manila/share/manager.py", line 239, in __init__
2019-08-07 22:39:42.789 6892 ERROR manila configuration=self.configuration,
2019-08-07 22:39:42.789 6892 ERROR manila File "/usr/lib/python2.7/dist-packages/oslo_utils/importutils.py", line 44, in import_object
2019-08-07 22:39:42.789 6892 ERROR manila return import_class(import_str)(*args, **kwargs)
2019-08-07 22:39:42.789 6892 ERROR manila File "/usr/lib/python2.7/dist-packages/manila/share/drivers/generic.py", line 128, in __init__
2019-08-07 22:39:42.789 6892 ERROR manila [False, True], *args, **kwargs)
2019-08-07 22:39:42.789 6892 ERROR manila File "/usr/lib/python2.7/dist-packages/manila/share/driver.py", line 275, in __init__
2019-08-07 22:39:42.789 6892 ERROR manila self._verify_share_server_handling(driver_handles_share_servers)
2019-08-07 22:39:42.789 6892 ERROR manila File "/usr/lib/python2.7/dist-packages/manila/share/driver.py", line 320, in _verify_share_server_handling
2019-08-07 22:39:42.789 6892 ERROR manila self.driver_handles_share_servers)
2019-08-07 22:39:42.789 6892 ERROR manila ManilaException: Config opt 'driver_handles_share_servers' has improper value - 'None'. Please define it as boolean.

[Eric Xie (eric-xie)]

I found the specification has incorrect ref in https://docs.openstack.org/manila/latest/admin/cephfs_driver.html#for-cephfs-nfs-shares.
'Edit enabled_share_backends to point to the driver’s backend section using the section name, cephfnfs1.'
The cephfnfs1 should be cephfsnfs1. It missed 's'.
I push one commit for this.

[Tom Barron (tpb)]

Thanks, Eric, for your doc fix [1] of a typo that led to not including the cephfsnfs1 back end as an enabled back end in your configuration!

[1] https://review.opendev.org/675237

[Jason Grosso (jgrosso)]

https://review.opendev.org/#/c/675237/ adding to fixed released