diff --git a/doc/common/tables/cinder-api.xml b/doc/common/tables/cinder-api.xml index b8053e33f5..7d889597c2 100644 --- a/doc/common/tables/cinder-api.xml +++ b/doc/common/tables/cinder-api.xml @@ -63,30 +63,6 @@ volume_api_class=cinder.volume.api.API (StrOpt) The full class name of the volume API class to use - - xenapi_connection_password=None - (StrOpt) Password for XenAPI connection - - - xenapi_connection_url=None - (StrOpt) URL for XenAPI connection - - - xenapi_connection_username=root - (StrOpt) Username for XenAPI connection - - - xenapi_nfs_server=None - (StrOpt) NFS server to be used by XenAPINFSDriver - - - xenapi_nfs_serverpath=None - (StrOpt) Path of exported NFS, used by XenAPINFSDriver - - - xenapi_sr_base_path=/var/run/sr-mount - (StrOpt) Base path to the storage repository - \ No newline at end of file diff --git a/doc/common/tables/cinder-storage.xml b/doc/common/tables/cinder-storage.xml index e2002e39f9..1d35dbbd6a 100644 --- a/doc/common/tables/cinder-storage.xml +++ b/doc/common/tables/cinder-storage.xml @@ -267,30 +267,6 @@ num_volume_device_scan_tries=3 (IntOpt) The maximum number of times to rescan targetsto find volume - - rbd_ceph_conf= - (StrOpt) path to the ceph configuration file to use - - - rbd_flatten_volume_from_snapshot=False - (BoolOpt) flatten volumes created from snapshots to remove dependency - - - rbd_max_clone_depth=5 - (IntOpt) maximum number of nested clones that can be taken of a volume before enforcing a flatten prior to next clone. A value of zero disables cloning - - - rbd_pool=rbd - (StrOpt) the RADOS pool in which rbd volumes are stored - - - rbd_secret_uuid=None - (StrOpt) the libvirt uuid of the secret for the rbd_uservolumes - - - rbd_user=None - (StrOpt) the RADOS client name for accessing rbd volumes - only set when using cephx authentication - san_clustername= (StrOpt) Cluster name to use for creating volumes @@ -443,10 +419,6 @@ volume_name_template=volume-%s (StrOpt) Template string to be used to generate volume names - - volume_tmp_dir=None - (StrOpt) where to store temporary image files if the volume driver does not write them directly to the volume - volume_topic=cinder-volume (StrOpt) the topic volume nodes listen on diff --git a/doc/common/tables/cinder-storage_ceph.xml b/doc/common/tables/cinder-storage_ceph.xml new file mode 100644 index 0000000000..9c5291f1a4 --- /dev/null +++ b/doc/common/tables/cinder-storage_ceph.xml @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for storage_ceph
Configuration option=Default valueDescription
rbd_ceph_conf=(StrOpt) path to the ceph configuration file to use
rbd_flatten_volume_from_snapshot=False(BoolOpt) flatten volumes created from snapshots to remove dependency
rbd_max_clone_depth=5(IntOpt) maximum number of nested clones that can be taken of a volume before enforcing a flatten prior to next clone. A value of zero disables cloning
rbd_pool=rbd(StrOpt) the RADOS pool in which rbd volumes are stored
rbd_secret_uuid=None(StrOpt) the libvirt uuid of the secret for the rbd_uservolumes
rbd_user=None(StrOpt) the RADOS client name for accessing rbd volumes - only set when using cephx authentication
volume_tmp_dir=None(StrOpt) where to store temporary image files if the volume driver does not write them directly to the volume
+
\ No newline at end of file diff --git a/doc/common/tables/cinder-storage_xen.xml b/doc/common/tables/cinder-storage_xen.xml new file mode 100644 index 0000000000..60bfc298c1 --- /dev/null +++ b/doc/common/tables/cinder-storage_xen.xml @@ -0,0 +1,44 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for storage_xen
Configuration option=Default valueDescription
xenapi_connection_password=None(StrOpt) Password for XenAPI connection
xenapi_connection_url=None(StrOpt) URL for XenAPI connection
xenapi_connection_username=root(StrOpt) Username for XenAPI connection
xenapi_nfs_server=None(StrOpt) NFS server to be used by XenAPINFSDriver
xenapi_nfs_serverpath=None(StrOpt) Path of exported NFS, used by XenAPINFSDriver
xenapi_sr_base_path=/var/run/sr-mount(StrOpt) Base path to the storage repository
+
\ No newline at end of file diff --git a/doc/config-reference/block-storage/drivers/ceph-rbd-volume-driver.xml b/doc/config-reference/block-storage/drivers/ceph-rbd-volume-driver.xml index 59d367d049..1674343aea 100644 --- a/doc/config-reference/block-storage/drivers/ceph-rbd-volume-driver.xml +++ b/doc/config-reference/block-storage/drivers/ceph-rbd-volume-driver.xml @@ -134,4 +134,10 @@ xlink:href="http://www.sebastien-han.fr/blog/2012/06/10/introducing-ceph-to-openstack/" >http://www.sebastien-han.fr/blog/2012/06/10/introducing-ceph-to-openstack/. + + Driver Options + The following table contains the configuration options + supported by the Ceph RADOS Block Device driver. + + diff --git a/doc/config-reference/block-storage/drivers/xenapi-nfs.xml b/doc/config-reference/block-storage/drivers/xenapi-nfs.xml index 155efe3ed7..991c74e1fc 100644 --- a/doc/config-reference/block-storage/drivers/xenapi-nfs.xml +++ b/doc/config-reference/block-storage/drivers/xenapi-nfs.xml @@ -11,8 +11,8 @@ This driver is not accessing the NFS share directly, it is only accessing the share through XenAPI Storage Manager. This driver should be considered as a -reference implementation for using XenAPI's storage manager in OpenStack ( -present in XenServer and XCP). +reference implementation for using XenAPI's storage manager in OpenStack +(present in XenServer and XCP). @@ -30,7 +30,7 @@ present in XenServer and XCP). An NFS share, that is configured for XenServer/XCP. For the specific requirements, export options, please refer to the administration guide of your specific XenServer version. It is also - requirement, that the NFS share is accessible by all the XenServers + required that the NFS share is accessible by all the XenServers components within your cloud. @@ -91,10 +91,14 @@ present in XenServer and XCP). Configuration Options Assuming the following setup: - XenServer box at 10.2.2.1 - XenServer password is r00tme - NFS server is nfs.example.com - NFS export is at /volumes + XenServer box at 10.2.2.1 + + XenServer password is r00tme + + NFS server is nfs.example.com + + NFS export is at /volumes + To use XenAPINFS as your cinder driver, set the following @@ -108,5 +112,9 @@ xenapi_connection_password = r00tme xenapi_nfs_server = nfs.example.com xenapi_nfs_serverpath = /volumes + + The following table contains the configuration options + supported by the XenAPINFS driver. + diff --git a/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings b/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings index 182862e472..aad08eb098 100644 --- a/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings +++ b/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings @@ -236,12 +236,12 @@ rabbit_retry_interval rpc rabbit_use_ssl rpc rabbit_userid rpc rabbit_virtual_host rpc -rbd_ceph_conf storage -rbd_flatten_volume_from_snapshot storage -rbd_max_clone_depth storage -rbd_pool storage -rbd_secret_uuid storage -rbd_user storage +rbd_ceph_conf storage_ceph +rbd_flatten_volume_from_snapshot storage_ceph +rbd_max_clone_depth storage_ceph +rbd_pool storage_ceph +rbd_secret_uuid storage_ceph +rbd_user storage_ceph reservation_expire common reserved_percentage common restore_discard_excess_bytes backups @@ -333,19 +333,19 @@ volume_driver storage volume_group storage volume_manager storage volume_name_template storage -volume_tmp_dir storage +volume_tmp_dir storage_ceph volume_topic storage volume_transfer_key_length storage volume_transfer_salt_length storage volume_usage_audit_period storage volumes_dir storage windows_iscsi_lun_path storage -xenapi_connection_password api -xenapi_connection_url api -xenapi_connection_username api -xenapi_nfs_server api -xenapi_nfs_serverpath api -xenapi_sr_base_path api +xenapi_connection_password storage_xen +xenapi_connection_url storage_xen +xenapi_connection_username storage_xen +xenapi_nfs_server storage_xen +xenapi_nfs_serverpath storage_xen +xenapi_sr_base_path storage_xen xiv_ds8k_connection_type storage xiv_ds8k_proxy storage zadara_default_stripesize storage