openstack/manila
Code Issues Proposed changes

Merge "[doc] Add sample dummy driver config"

Browse Source
This commit is contained in:
Zuul 2023-03-28 15:02:35 +00:00 committed by Gerrit Code Review
commit f3ec5e738c
2 changed files with 89 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/source/contributor/development-environment-devstack.rst
View File

@ -60,14 +60,17 @@ Sample local.conf files that get you started
Now that you have cloned the devstack repository, you need to
configure devstack before deploying it. This is done with a ``local.conf``
file. For manila, the local.conf file can also determine which back end(s)
are set up.
are set up. The choice of back end(s) is important because there are optional
API features in Manila `that are not supported by some drivers
<../admin/share_back_ends_feature_support_mapping.html>`_.
.. caution::
When using devstack with the below configurations, be aware that you will
be setting up fake storage. The `LVM`, `Generic`, `ZFSOnLinux` drivers
have not been developed for production use. They exist to provide a
vanilla development and testing environment for manila contributors.
be setting up with node local storage. The `LVM`, `Generic`,
`ZFSOnLinux` drivers have not been developed for production use.
They exist to provide a vanilla development and testing environment for
manila contributors.
DHSS=False (`driver_handles_share_servers=False`) mode:
`````````````````````````````````````````````````````````
@ -102,6 +105,22 @@ setup before attempting ``DHSS=True``.
* :download:`Generic driver <samples/generic_local.conf>`
* :download:`Container driver <samples/container_local.conf>`
Using a dummy back end driver
`````````````````````````````
If you're absolutely new to manila code development, you may want to skip a
real storage driver altogether and attempt a development environment that
abstracts the back end storage layer. This could also be the situation if
you're building API integrations such as CLI, UI or SDK clients. Here, you
probably don't care about restrictions that individual back end choices bring
you such as their lack of support for optional API features. Manila ships a
fake backend driver called "Dummy Driver" that supports all API features and
is capable of operating in both DHSS modes. You may use the following `local
.conf` sample to bootstrap your devstack with a "Dummy" driver. Do remember
however that you cannot really *use* the resources that are provisioned by
this driver.
* :download:`Dummy driver <samples/dummy_local.conf>`
Building your devstack
----------------------

66
doc/source/contributor/samples/dummy_local.conf Normal file
View File

@ -0,0 +1,66 @@
#################################################################
# This local.conf sets up Devstack with manila enabling the Dummy
# driver which operates in driver_handles_share_services=False
# and driver_handles_share_services=True modes via four distinct
# backends. It's important to remember that this driver does
# not provision real storage.
#################################################################
[[local|localrc]]
ADMIN_PASSWORD=secret
DATABASE_PASSWORD=$ADMIN_PASSWORD
RABBIT_PASSWORD=$ADMIN_PASSWORD
SERVICE_PASSWORD=$ADMIN_PASSWORD
DEST=/opt/stack
DATA_DIR=/opt/stack/data
LOGFILE=/opt/stack/devstacklog.txt
# Enabling manila services
LIBS_FROM_GIT=python-manilaclient
enable_plugin manila https://opendev.org/openstack/manila
enable_plugin manila-ui https://opendev.org/openstack/manila-ui
enable_plugin manila-tempest-plugin https://opendev.org/openstack/manila-tempest-plugin
# Dummy Backends config options
SHARE_DRIVER=manila.tests.share.drivers.dummy.DummyDriver
MANILA_CONFIGURE_GROUPS=buenosaires,saopaulo,lima,bogota,membernet,adminnet
MANILA_CONFIGURE_DEFAULT_TYPES=true
MANILA_SERVICE_IMAGE_ENABLED=false
MANILA_SHARE_MIGRATION_PERIOD_TASK_INTERVAL=1
MANILA_SERVER_MIGRATION_PERIOD_TASK_INTERVAL=10
MANILA_REPLICA_STATE_UPDATE_INTERVAL=10
MANILA_DEFAULT_SHARE_TYPE_EXTRA_SPECS='snapshot_support=True create_share_from_snapshot_support=True revert_to_snapshot_support=True mount_snapshot_support=True'
MANILA_ENABLED_BACKENDS=buenosaires,saopaulo,lima,bogota
MANILA_OPTGROUP_buenosaires_driver_handles_share_servers=false
MANILA_OPTGROUP_buenosaires_replication_domain=DUMMY_DOMAIN
MANILA_OPTGROUP_buenosaires_share_backend_name=ALPHA
MANILA_OPTGROUP_buenosaires_share_driver=manila.tests.share.drivers.dummy.DummyDriver
MANILA_OPTGROUP_saopaulo_driver_handles_share_servers=false
MANILA_OPTGROUP_saopaulo_replication_domain=DUMMY_DOMAIN
MANILA_OPTGROUP_saopaulo_share_backend_name=BETA
MANILA_OPTGROUP_saopaulo_share_driver=manila.tests.share.drivers.dummy.DummyDriver
MANILA_OPTGROUP_lima_driver_handles_share_servers=true
MANILA_OPTGROUP_lima_network_config_group=membernet
MANILA_OPTGROUP_lima_share_backend_name=GAMMA
MANILA_OPTGROUP_lima_share_driver=manila.tests.share.drivers.dummy.DummyDriver
MANILA_OPTGROUP_lima_admin_network_config_group=membernet
MANILA_OPTGROUP_bogota_share_driver=manila.tests.share.drivers.dummy.DummyDriver
MANILA_OPTGROUP_bogota_driver_handles_share_servers=False
MANILA_OPTGROUP_bogota_share_backend_name=DELTA
MANILA_OPTGROUP_bogota_replication_domain=DUMMY_DOMAIN
MANILA_OPTGROUP_membernet_network_api_class=manila.network.standalone_network_plugin.StandaloneNetworkPlugin
MANILA_OPTGROUP_membernet_network_plugin_ipv4_enabled=true
MANILA_OPTGROUP_membernet_standalone_network_plugin_allowed_ip_ranges=10.0.0.10-10.0.0.209
MANILA_OPTGROUP_membernet_standalone_network_plugin_gateway=10.0.0.1
MANILA_OPTGROUP_membernet_standalone_network_plugin_mask=24
MANILA_OPTGROUP_membernet_standalone_network_plugin_network_type=vlan
MANILA_OPTGROUP_membernet_standalone_network_plugin_segmentation_id=1010
MANILA_OPTGROUP_adminnet_network_api_class=manila.network.standalone_network_plugin.StandaloneNetworkPlugin
MANILA_OPTGROUP_adminnet_standalone_network_plugin_gateway=11.0.0.1
MANILA_OPTGROUP_adminnet_standalone_network_plugin_mask=24
MANILA_OPTGROUP_adminnet_standalone_network_plugin_network_type=vlan
MANILA_OPTGROUP_adminnet_standalone_network_plugin_segmentation_id=1011
MANILA_OPTGROUP_adminnet_standalone_network_plugin_allowed_ip_ranges=11.0.0.10-11.0.0.19,11.0.0.30-11.0.0.39,11.0.0.50-11.0.0.199
MANILA_OPTGROUP_adminnet_network_plugin_ipv4_enabled=True