diff --git a/doc/common/tables/manila-generic.xml b/doc/common/tables/manila-generic.xml new file mode 100644 index 0000000000..0d3c587f17 --- /dev/null +++ b/doc/common/tables/manila-generic.xml @@ -0,0 +1,208 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of Generic Share Driver configuration options
Configuration option = Default valueDescription
[DEFAULT]
= http://localhost:5000/v2.0(StrOpt) Identity service URL.
= None(StrOpt) Cinder admin password.
= service(StrOpt) Cinder admin tenant name.
= cinder(StrOpt) Cinder admin username.
= False(BoolOpt) Allow to perform insecure SSL requests to cinder.
= None(StrOpt) Location of CA certificates file to use for cinder client requests.
= volume:cinder:publicURL(StrOpt) Info to match when looking for cinder in the service catalog. Format is separated values of the form: <service_type>:<service_name>:<endpoint_type>
= True(BoolOpt) Allow attaching between instances and volumes in different availability zones.
= 3(IntOpt) Number of cinderclient retries on failed HTTP calls.
= %volume_type%(StrOpt) Name or id of the Cinder volume type which will be used for all volumes created by driver.
= False/True(BoolOpt) Attach share server directly to share network. Used only with Neutron and only applies when the option driver_handles_share_servers is set to True and one of either Generic or Windows drivers is used.
= False(BoolOpt) Required option that defines driver mode. Possible values are True/False.
= manila.network.linux.interface.OVSInterfaceDriver(StrOpt) Vif driver. Used only with Neutron and only applies when the option driver_handles_share_servers is set to True.
= manila-service(StrOpt) Keypair name that will be created and used for service instances. This option only applies when the option driver_handles_share_servers is set to True.
= 120(IntOpt) Maximum time to wait for attachment of a Cinder volume.
= 300(IntOpt) Maximum time in seconds to wait for creating service instance. This option only applies when the option driver_handles_share_servers is set to True.
= 180(IntOpt) Maximum time to wait for creation of a Cinder volume.
= 180(IntOpt) Maximum time to wait for extention of a Cinder volume.
= br-int(StrOpt) Name of Open vSwitch bridge to use.
= ~/.ssh/id_rsa(StrOpt) Path to host's private key.
= ~/.ssh/id_rsa.pub(StrOpt) Path to hosts public key. This option only applies when the option driver_handles_share_servers is set to True.
= manila-service-image(StrOpt) Name of image in Glance, that will be used for service instance creation. This option only applies when the option driver_handles_share_servers is set to True.
= 100(IntOpt) ID of flavor, that will be used for service instance creation. This option only applies when the option driver_handles_share_servers is set to True.
= %nova_vm_name_or_id%(StrOpt) Name or ID of service instance in Nova to use for share exports. Used only when share servers handling is disabled. This option only applies when the option driver_handles_share_servers is set to False.
= manila_service_instance_%s(StrOpt) Template that will be used for naming of Nova VMs that are used and service instances. This option only applies when the option driver_handles_share_servers is set to True.
= neutron(StrOpt) Type of network helper for the Generic driver. Possible values are 'neutron' and 'nova'. This option only applies when the option driver_handles_share_servers is set to True.
= %password%(StrOpt) Password for service instance user. Optional, will be used in ase SSH keys are not set up.
= manila-service(StrOpt) Security group name, that will be used for service instance creation. This option only applies when the option driver_handles_share_servers is set to True.
= $share_mount_path/smb.conf(StrOpt) Path to SMB config in service instance.
= %username%(StrOpt) User in service instance that will be used for authentication.
= %nova_vm_net_name_or_ip%(StrOpt) Can be either name of network that is used by service instance within Nova to get IP address or IP address itself for managing shares there. This option only applies when the option driver_handles_share_servers is set to False.
= 10.254.0.0/16(StrOpt) CIDR of manila service network. Used only with Neutron and only applies when the option driver_handles_share_servers is set to True.
= 28(IntOpt) This mask is used for dividing service network into subnets, IP capacity of subnet with this mask directly defines possible amount of created service VMs per tenant's subnet. Used only with Neutron and only applies when the option driver_handles_share_servers is set to True.
= manila_service_network(StrOpt) Name of manila service network. Used only with Neutron and only applies when the option driver_handles_share_servers is set to True.
= Cinder_Volumes(StrOpt) The backend name for the Generic driver.
= manila.share.drivers.generic.GenericShareDriver(StrOpt) path to Generic driver.
= CIFS=manila.share.drivers.generic.CIFSHelper,NFS=manila.share.drivers.generic.NFSHelper(ListOpt) List of share export helpers.
= /shares(StrOpt) Parent path in service instance where shares will be mounted.
= ext4(StrOpt) Filesystem type of the share volume. Possible values are 'ext4' and 'ext3'
= %nova_vm_tenant_net_name_or_ip%(StrOpt) Can be either name of network that is used by service instance within Nova to get IP address or IP address itself for exporting shares. This option only applies when the option driver_handles_share_servers is set to False.
= manila-share-%s(StrOpt) Name template for Cinder volumes.
= manila-snapshot-%s(StrOpt) Name template for Cinder snapshots..
+
diff --git a/doc/common/tables/manila-share.xml b/doc/common/tables/manila-share.xml index 545e9db50c..13d18ce43a 100644 --- a/doc/common/tables/manila-share.xml +++ b/doc/common/tables/manila-share.xml @@ -43,10 +43,6 @@ = 4096 (IntOpt) Number of backlog requests to configure the socket with. - - = False - (BoolOpt) Attach share server directly to share network. Used only with Neutron. - = None (StrOpt) Default share type to use. @@ -87,30 +83,6 @@ = (ListOpt) Driver(s) to perform some additional actions before and after share driver actions and on a periodic basis. Default is []. - - = manila.network.linux.interface.OVSInterfaceDriver - (StrOpt) Vif driver. Used only with Neutron. - - - = manila-service - (StrOpt) Keypair name that will be created and used for service instances. - - - = 120 - (IntOpt) Maximum time to wait for attaching cinder volume. - - - = 300 - (IntOpt) Maximum time in seconds to wait for creating service instance. - - - = 180 - (IntOpt) Maximum time to wait for creating cinder volume. - - - = 180 - (IntOpt) Maximum time to wait for extending cinder volume. - = 300 (IntOpt) Timeout for creating and deleting share instances when performing share migration (seconds). @@ -147,74 +119,10 @@ = None (StrOpt) Name of the configuration group in the Manila conf file to look for network config options.If not set, the share backend's config group will be used.If an option is not found within provided group, then'DEFAULT' group will be used for search of option. - - = br-int - (StrOpt) Name of Open vSwitch bridge to use. - - - = ~/.ssh/id_rsa - (StrOpt) Path to host's private key. - - - = ~/.ssh/id_rsa.pub - (StrOpt) Path to hosts public key. - = sudo (StrOpt) Deprecated: command to use for running commands as root. - - = manila-service-image - (StrOpt) Name of image in Glance, that will be used for service instance creation. - - - = 100 - (IntOpt) ID of flavor, that will be used for service instance creation. - - - = None - (StrOpt) Name or ID of service instance in Nova to use for share exports. Used only when share servers handling is disabled. - - - = manila_service_instance_%s - (StrOpt) Name of service instance. - - - = neutron - (StrOpt) Allowed values are ['nova', 'neutron']. - - - = None - (StrOpt) Password for service instance user. - - - = manila-service - (StrOpt) Security group name, that will be used for service instance creation. - - - = $share_mount_path/smb.conf - (StrOpt) Path to SMB config in service instance. - - - = None - (StrOpt) User in service instance that will be used for authentication. - - - = None - (StrOpt) Can be either name of network that is used by service instance within Nova to get IP address or IP address itself for managing shares there. Used only when share servers handling is disabled. - - - = 10.254.0.0/16 - (StrOpt) CIDR of manila service network. Used only with Neutron. - - - = 28 - (IntOpt) This mask is used for dividing service network into subnets, IP capacity of subnet with this mask directly defines possible amount of created service VMs per tenant's subnet. Used only with Neutron. - - - = manila_service_network - (StrOpt) Name of manila service network. Used only with Neutron. - = None (StrOpt) The backend name for a given driver implementation. @@ -223,18 +131,10 @@ = manila.share.drivers.generic.GenericShareDriver (StrOpt) Driver to use for share creation. - - = CIFS=manila.share.drivers.generic.CIFSHelper, NFS=manila.share.drivers.generic.NFSHelper - (ListOpt) Specify list of share export helpers. - = manila.share.manager.ShareManager (StrOpt) Full class name for the share manager. - - = /shares - (StrOpt) Parent path in service instance where shares will be mounted. - = share-%s (StrOpt) Template string to be used to generate share names. @@ -247,14 +147,6 @@ = month (StrOpt) Time period to generate share usages for. Time period must be hour, day, month or year. - - = ext4 - (StrOpt) Filesystem type of the share volume. - - - = $state_path/smb.conf - (StrOpt) Path to smb config. - = False (BoolOpt) Whether to suppress post hook errors (allow driver's results to pass through) or not. @@ -263,10 +155,6 @@ = False (BoolOpt) Whether to suppress pre hook errors (allow driver perform actions) or not. - - = None - (StrOpt) Can be either name of network that is used by service instance within Nova to get IP address or IP address itself for exporting shares. Used only when share servers handling is disabled. - = False (BoolOpt) If set to True, then manila will deny access and remove all access rules on share unmanage.If set to False - nothing will be changed. diff --git a/doc/common/tables/manila-storage.xml b/doc/common/tables/manila-storage.xml deleted file mode 100644 index a84b9b356f..0000000000 --- a/doc/common/tables/manila-storage.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Description of Storage configuration options
Configuration option = Default valueDescription
[DEFAULT]
= http://localhost:5000/v2.0(StrOpt) Identity service URL.
= None(StrOpt) Cinder admin password.
= service(StrOpt) Cinder admin tenant name.
= cinder(StrOpt) Cinder admin username.
= False(BoolOpt) Allow to perform insecure SSL requests to cinder.
= None(StrOpt) Location of CA certificates file to use for cinder client requests.
= volume:cinder:publicURL(StrOpt) Info to match when looking for cinder in the service catalog. Format is separated values of the form: <service_type>:<service_name>:<endpoint_type>
= True(BoolOpt) Allow attaching between instances and volumes in different availability zones.
= 3(IntOpt) Number of cinderclient retries on failed HTTP calls.
= None(StrOpt) Name or id of cinder volume type which will be used for all volumes created by driver.
= 10000(IntOpt) Maximum number of volume gigabytes to allow per host.
-
diff --git a/doc/config-reference/shared-file-systems/drivers/generic-driver.xml b/doc/config-reference/shared-file-systems/drivers/generic-driver.xml index 6bd32c6995..41aa52269d 100644 --- a/doc/config-reference/shared-file-systems/drivers/generic-driver.xml +++ b/doc/config-reference/shared-file-systems/drivers/generic-driver.xml @@ -203,4 +203,9 @@ + + Driver options + The following table contains the configuration options specific to this driver. + + diff --git a/doc/config-reference/shared-file-systems/section_manila-misc.xml b/doc/config-reference/shared-file-systems/section_manila-misc.xml index 915c4a621e..5a7431dd2b 100644 --- a/doc/config-reference/shared-file-systems/section_manila-misc.xml +++ b/doc/config-reference/shared-file-systems/section_manila-misc.xml @@ -38,7 +38,6 @@ - diff --git a/tools/autogenerate-config-flagmappings/manila.flagmappings b/tools/autogenerate-config-flagmappings/manila.flagmappings index 32b240a741..f20c830b80 100644 --- a/tools/autogenerate-config-flagmappings/manila.flagmappings +++ b/tools/autogenerate-config-flagmappings/manila.flagmappings @@ -4,19 +4,19 @@ auth_strategy auth automatic_share_server_cleanup share backlog share capacity_weight_multiplier scheduler -cinder_admin_auth_url storage -cinder_admin_password storage -cinder_admin_tenant_name storage -cinder_admin_username storage -cinder_api_insecure storage -cinder_ca_certificates_file storage -cinder_catalog_info storage -cinder_cross_az_attach storage -cinder_http_retries storage -cinder_volume_type storage +cinder_admin_auth_url generic +cinder_admin_password generic +cinder_admin_tenant_name generic +cinder_admin_username generic +cinder_api_insecure generic +cinder_ca_certificates_file generic +cinder_catalog_info generic +cinder_cross_az_attach generic +cinder_http_retries generic +cinder_volume_type generic client_socket_timeout common compute_api_class common -connect_share_server_to_tenant_network share +connect_share_server_to_tenant_network generic control_exchange amqp db_backend database db_driver database @@ -24,7 +24,7 @@ debug logging default_log_levels logging default_share_type share delete_share_server_with_last_share share -driver_handles_share_servers share +driver_handles_share_servers share generic emc_nas_login emc emc_nas_password emc emc_nas_pool_name emc @@ -102,7 +102,7 @@ hpe3par_share_ip_address hpe3par hpe3par_username hpe3par instance_format logging instance_uuid_format logging -interface_driver share +interface_driver generic knfs_export_options gpfs log_config_append logging log_date_format logging @@ -115,15 +115,14 @@ logging_default_format_string logging logging_exception_prefix logging logging_user_identity_format logging manila_huawei_conf_file huawei -manila_service_keypair_name share +manila_service_keypair_name generic max_age quota -max_gigabytes storage max_header_line api max_over_subscription_ratio common -max_time_to_attach share -max_time_to_build_instance share -max_time_to_create_volume share -max_time_to_extend_volume share +max_time_to_attach generic +max_time_to_build_instance generic +max_time_to_create_volume generic +max_time_to_extend_volume generic memcached_servers common migration_create_delete_share_timeout share migration_data_copy_node_ip share @@ -172,10 +171,10 @@ osapi_share_extension api osapi_share_listen api osapi_share_listen_port api osapi_share_workers api -ovs_integration_bridge share +ovs_integration_bridge generic password redis -path_to_private_key share -path_to_public_key share +path_to_private_key generic +path_to_public_key generic periodic_fuzzy_delay common periodic_hooks_interval common periodic_interval common @@ -226,31 +225,30 @@ scheduler_manager scheduler scheduler_max_attempts scheduler scheduler_topic scheduler service_down_time common -service_image_name share -service_instance_flavor_id share -service_instance_name_or_id share -service_instance_name_template share -service_instance_network_helper_type share -service_instance_password share -service_instance_security_group share -service_instance_smb_config_path share -service_instance_user share -service_net_name_or_ip share -service_network_cidr share -service_network_division_mask share -service_network_name share +service_image_name generic +service_instance_flavor_id generic +service_instance_name_or_id generic +service_instance_name_template generic +service_instance_network_helper_type generic +service_instance_password generic +service_instance_security_group generic +service_instance_smb_config_path generic +service_instance_user generic +service_net_name_or_ip generic +service_network_cidr generic +service_network_division_mask generic +service_network_name generic share_api_class api -share_backend_name share -share_driver share -share_helpers share +share_backend_name share generic +share_driver share generic +share_helpers generic share_manager share -share_mount_path share +share_mount_path generic share_name_template share share_snapshot_name_template share share_topic rpc share_usage_audit_period share -share_volume_fstype share -smb_template_config_path share +share_volume_fstype generic sql_idle_timeout common sql_max_retries common sql_retry_interval common @@ -272,7 +270,7 @@ tcp_keepalive common tcp_keepalive_count common tcp_keepalive_interval common tcp_keepidle common -tenant_net_name_or_ip share +tenant_net_name_or_ip generic transport_url amqp unmanage_remove_access_rules share until_refresh common @@ -284,8 +282,8 @@ use_syslog logging use_syslog_rfc_format logging verbose logging volume_api_class api -volume_name_template api -volume_snapshot_name_template api +volume_name_template api generic +volume_snapshot_name_template api generic watch_log_file logging winrm_cert_key_pem_path winrm winrm_cert_pem_path winrm diff --git a/tools/autogenerate-config-flagmappings/manila.headers b/tools/autogenerate-config-flagmappings/manila.headers index 95b73306d7..d85323bb5c 100644 --- a/tools/autogenerate-config-flagmappings/manila.headers +++ b/tools/autogenerate-config-flagmappings/manila.headers @@ -9,6 +9,7 @@ cors CORS database Database emc EMC Share Drivers ganesha Ganesha +generic Generic Share Driver glusterfs GlusterFS Share Drivers gpfs IBM GPFS Share Driver hdfs HDFS Share Driver @@ -26,7 +27,6 @@ rpc RPC san SAN scheduler Scheduler share Share -storage Storage winrm WinRM zeromq ZeroMQ zfssa ZFSSA Share Driver