[Wallaby] setup_ganesha_share_type: Manila client "Config opt 'driver_handles_share_servers' has improper value - 'None'"

[Aurelien Lourot]

Seen in this gate:
https://review.opendev.org/c/openstack/charm-manila-ganesha/+/807569
https://openstack-ci-reports.ubuntu.com/artifacts/9e1/807569/10/check/focal-wallaby/9e16a01/job-output.txt
https://openstack-ci-reports.ubuntu.com/artifacts/c52/807569/10/check/hirsute-wallaby/c52baae/job-output.txt

Traceback (most recent call last):
  File "/home/ubuntu/src/review.opendev.org/openstack/charm-manila-ganesha/build/builds/manila-ganesha/.tox/func-target/bin/functest-run-suite", line 8, in <module>
    sys.exit(main())
  File "/home/ubuntu/src/review.opendev.org/openstack/charm-manila-ganesha/build/builds/manila-ganesha/.tox/func-target/lib/python3.6/site-packages/zaza/charm_lifecycle/func_test_runner.py", line 372, in main
    test_directory=args.test_directory)
  File "/home/ubuntu/src/review.opendev.org/openstack/charm-manila-ganesha/build/builds/manila-ganesha/.tox/func-target/lib/python3.6/site-packages/zaza/charm_lifecycle/func_test_runner.py", line 278, in func_test_runner
    force=force, test_directory=test_directory)
  File "/home/ubuntu/src/review.opendev.org/openstack/charm-manila-ganesha/build/builds/manila-ganesha/.tox/func-target/lib/python3.6/site-packages/zaza/charm_lifecycle/func_test_runner.py", line 154, in run_env_deployment
    test_directory=test_directory)
  File "/home/ubuntu/src/review.opendev.org/openstack/charm-manila-ganesha/build/builds/manila-ganesha/.tox/func-target/lib/python3.6/site-packages/zaza/charm_lifecycle/configure.py", line 51, in configure
    run_configure_list(functions)
  File "/home/ubuntu/src/review.opendev.org/openstack/charm-manila-ganesha/build/builds/manila-ganesha/.tox/func-target/lib/python3.6/site-packages/zaza/charm_lifecycle/configure.py", line 37, in run_configure_list
    utils.get_class(func)()
  File "/home/ubuntu/src/review.opendev.org/openstack/charm-manila-ganesha/build/builds/manila-ganesha/.tox/func-target/lib/python3.6/site-packages/zaza/openstack/charm_tests/manila_ganesha/setup.py", line 45, in setup_ganesha_share_type
    'snapshot_support': False,
  File "/home/ubuntu/src/review.opendev.org/openstack/charm-manila-ganesha/build/builds/manila-ganesha/.tox/func-target/lib/python3.6/site-packages/manilaclient/api_versions.py", line 399, in substitution
    return method.func(obj, *args, **kwargs)
  File "/home/ubuntu/src/review.opendev.org/openstack/charm-manila-ganesha/build/builds/manila-ganesha/.tox/func-target/lib/python3.6/site-packages/manilaclient/v2/share_types.py", line 209, in create
    is_public_keyname="os-share-type-access:is_public")
  File "/home/ubuntu/src/review.opendev.org/openstack/charm-manila-ganesha/build/builds/manila-ganesha/.tox/func-target/lib/python3.6/site-packages/manilaclient/v2/share_types.py", line 169, in _do_create
    return self._create("/types", body, "share_type")
  File "/home/ubuntu/src/review.opendev.org/openstack/charm-manila-ganesha/build/builds/manila-ganesha/.tox/func-target/lib/python3.6/site-packages/manilaclient/base.py", line 161, in _create
    resp, body = self.api.client.post(url, body=body)
  File "/home/ubuntu/src/review.opendev.org/openstack/charm-manila-ganesha/build/builds/manila-ganesha/.tox/func-target/lib/python3.6/site-packages/manilaclient/common/httpclient.py", line 177, in post
    return self._cs_request(url, 'POST', **kwargs)
  File "/home/ubuntu/src/review.opendev.org/openstack/charm-manila-ganesha/build/builds/manila-ganesha/.tox/func-target/lib/python3.6/site-packages/manilaclient/common/httpclient.py", line 136, in _cs_request
    **kwargs)
  File "/home/ubuntu/src/review.opendev.org/openstack/charm-manila-ganesha/build/builds/manila-ganesha/.tox/func-target/lib/python3.6/site-packages/manilaclient/common/httpclient.py", line 150, in _cs_request_with_retries
    resp, body = self.request(url, method, **kwargs)
  File "/home/ubuntu/src/review.opendev.org/openstack/charm-manila-ganesha/build/builds/manila-ganesha/.tox/func-target/lib/python3.6/site-packages/manilaclient/common/httpclient.py", line 128, in request
    raise exceptions.from_response(resp, method, url)
manilaclient.common.apiclient.exceptions.Forbidden: Access was denied to this resource. (HTTP 403) (Request-ID: req-4f316a92-8394-4808-a90a-2dca352cfc48)

manila-share.log on the manila unit repetedly shows:
CRITICAL manila [req-73157ee7-724e-4a92-9da7-368a4755fbdf - - - - -] Unhandled error: manila.exception.ManilaException: Config opt 'driver_handles_share_servers' has improper value - 'None'. Please define it as boolean.
ERROR manila Traceback (most recent call last):
ERROR manila File "/usr/bin/manila-share", line 10, in <module>
ERROR manila sys.exit(main())
ERROR manila File "/usr/lib/python3/dist-packages/manila/cmd/share.py", line 62, in main
ERROR manila server = service.Service.create(binary='manila-share')
ERROR manila File "/usr/lib/python3/dist-packages/manila/service.py", line 224, in create
ERROR manila service_obj = cls(host, binary, topic, manager,
ERROR manila File "/usr/lib/python3/dist-packages/manila/service.py", line 120, in __init__
ERROR manila self.manager = manager_class(host=self.host,
ERROR manila File "/usr/lib/python3/dist-packages/manila/share/manager.py", line 269, in __init__
ERROR manila self.driver = importutils.import_object(
ERROR manila File "/usr/lib/python3/dist-packages/oslo_utils/importutils.py", line 44, in import_object
ERROR manila return import_class(import_str)(*args, **kwargs)
ERROR manila File "/usr/lib/python3/dist-packages/manila/share/drivers/generic.py", line 127, in __init__
ERROR manila super(GenericShareDriver, self).__init__(
ERROR manila File "/usr/lib/python3/dist-packages/manila/share/driver.py", line 293, in __init__
ERROR manila self._verify_share_server_handling(driver_handles_share_servers)
ERROR manila File "/usr/lib/python3/dist-packages/manila/share/driver.py", line 350, in _verify_share_server_handling
ERROR manila raise exception.ManilaException(
ERROR manila manila.exception.ManilaException: Config opt 'driver_handles_share_servers' has improper value - 'None'. Please define it as boolean.

[Corey Bryant (corey.bryant)]

The 403 is likely a duplicate of https://bugs.launchpad.net/charm-manila-ganesha/+bug/1952763. I've been updating that bug so I'll plan to fix it via that bug.

I think the "Config opt 'driver_handles_share_servers' has improper value - 'None'. Please define it as boolean." may not be an issue, but regardless something should be done about it.

The reason I think it may not be an issue, at least with manila-ganesha as a backend, is that the driver_handles_share_servers config option is needed in the manila-ganesha units' /etc/manila/manila.conf config.

Perhaps we could put it in manila's config to quiet it down or perhaps this should be fixed upstream? Hoping someone more familiar with manila can check my reasoning here.

[Corey Bryant (corey.bryant)]

Or perhaps the better answer is disabling the manila-share service on manila, if that makes sense.