openstack-manuals/doc/common/tables/manila-share.xml

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
  <!-- Warning: Do not edit this file. It is automatically
     generated and your changes will be overwritten.
     The tool to do so lives in openstack-doc-tools repository. -->
  <table rules="all" xml:id="config_table_manila_share">
    <caption>Description of Share configuration options</caption>
    <col width="50%"/>
    <col width="50%"/>
    <thead>
      <tr>
        <th>Configuration option = Default value</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <th colspan="2">[DEFAULT]</th>
      </tr>
      <tr>
        <td><option>automatic_share_server_cleanup</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) If set to True, then Manila will delete all share servers which were unused more than specified time .If set to False - automatic deletion of share servers will be disabled.</td>
      </tr>
      <tr>
        <td><option>backlog</option> = <replaceable>4096</replaceable></td>
        <td>(IntOpt) Number of backlog requests to configure the socket with.</td>
      </tr>
      <tr>
        <td><option>connect_share_server_to_tenant_network</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Attach share server directly to share network. Used only with Neutron.</td>
      </tr>
      <tr>
        <td><option>default_share_type</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Default share type to use.</td>
      </tr>
      <tr>
        <td><option>delete_share_server_with_last_share</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Whether share servers will be deleted on deletion of the last share.</td>
      </tr>
      <tr>
        <td><option>driver_handles_share_servers</option> = <replaceable>None</replaceable></td>
        <td>(BoolOpt) There are two possible approaches for share drivers in Manila. First is when share driver is able to handle share-servers and second when not. Drivers can support either both or only one of these approaches. So, set this opt to True if share driver is able to handle share servers and it is desired mode else set False. It is set to None by default to make this choice intentional.</td>
      </tr>
      <tr>
        <td><option>enable_periodic_hooks</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Whether to enable periodic hooks or not.</td>
      </tr>
      <tr>
        <td><option>enable_post_hooks</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Whether to enable post hooks or not.</td>
      </tr>
      <tr>
        <td><option>enable_pre_hooks</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Whether to enable pre hooks or not.</td>
      </tr>
      <tr>
        <td><option>enabled_share_backends</option> = <replaceable>None</replaceable></td>
        <td>(ListOpt) A list of share backend names to use. These backend names should be backed by a unique [CONFIG] group with its options.</td>
      </tr>
      <tr>
        <td><option>enabled_share_protocols</option> = <replaceable>NFS, CIFS</replaceable></td>
        <td>(ListOpt) Specify list of protocols to be allowed for share creation. Available values are '('NFS', 'CIFS', 'GLUSTERFS', 'HDFS')'</td>
      </tr>
      <tr>
        <td><option>executor_thread_pool_size</option> = <replaceable>64</replaceable></td>
        <td>(IntOpt) Size of executor thread pool.</td>
      </tr>
      <tr>
        <td><option>hook_drivers</option> = <replaceable></replaceable></td>
        <td>(ListOpt) Driver(s) to perform some additional actions before and after share driver actions and on a periodic basis. Default is [].</td>
      </tr>
      <tr>
        <td><option>interface_driver</option> = <replaceable>manila.network.linux.interface.OVSInterfaceDriver</replaceable></td>
        <td>(StrOpt) Vif driver. Used only with Neutron.</td>
      </tr>
      <tr>
        <td><option>manila_service_keypair_name</option> = <replaceable>manila-service</replaceable></td>
        <td>(StrOpt) Keypair name that will be created and used for service instances.</td>
      </tr>
      <tr>
        <td><option>max_time_to_attach</option> = <replaceable>120</replaceable></td>
        <td>(IntOpt) Maximum time to wait for attaching cinder volume.</td>
      </tr>
      <tr>
        <td><option>max_time_to_build_instance</option> = <replaceable>300</replaceable></td>
        <td>(IntOpt) Maximum time in seconds to wait for creating service instance.</td>
      </tr>
      <tr>
        <td><option>max_time_to_create_volume</option> = <replaceable>180</replaceable></td>
        <td>(IntOpt) Maximum time to wait for creating cinder volume.</td>
      </tr>
      <tr>
        <td><option>max_time_to_extend_volume</option> = <replaceable>180</replaceable></td>
        <td>(IntOpt) Maximum time to wait for extending cinder volume.</td>
      </tr>
      <tr>
        <td><option>migration_create_delete_share_timeout</option> = <replaceable>300</replaceable></td>
        <td>(IntOpt) Timeout for creating and deleting share instances when performing share migration (seconds).</td>
      </tr>
      <tr>
        <td><option>migration_data_copy_node_ip</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The IP of the node responsible for copying data during migration, such as the data copy service node, reachable by the backend.</td>
      </tr>
      <tr>
        <td><option>migration_ignore_files</option> = <replaceable>lost+found</replaceable></td>
        <td>(ListOpt) List of files and folders to be ignored when migrating shares. Items should be names (not including any path).</td>
      </tr>
      <tr>
        <td><option>migration_mounting_backend_ip</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Backend IP in admin network to use for mounting shares during migration.</td>
      </tr>
      <tr>
        <td><option>migration_protocol_mount_command</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The command for mounting shares for this backend. Must specifythe executable and all necessary parameters for the protocol supported. It is advisable to separate protocols per backend.</td>
      </tr>
      <tr>
        <td><option>migration_readonly_support</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Specify whether read only access mode is supported in thisbackend.</td>
      </tr>
      <tr>
        <td><option>migration_tmp_location</option> = <replaceable>/tmp/</replaceable></td>
        <td>(StrOpt) Temporary path to create and mount shares during migration.</td>
      </tr>
      <tr>
        <td><option>migration_wait_access_rules_timeout</option> = <replaceable>90</replaceable></td>
        <td>(IntOpt) Time to wait for access rules to be allowed/denied on backends when migrating shares using generic approach (seconds).</td>
      </tr>
      <tr>
        <td><option>network_config_group</option> = <replaceable>None</replaceable></td>
        <td>(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.</td>
      </tr>
      <tr>
        <td><option>ovs_integration_bridge</option> = <replaceable>br-int</replaceable></td>
        <td>(StrOpt) Name of Open vSwitch bridge to use.</td>
      </tr>
      <tr>
        <td><option>path_to_private_key</option> = <replaceable>~/.ssh/id_rsa</replaceable></td>
        <td>(StrOpt) Path to host's private key.</td>
      </tr>
      <tr>
        <td><option>path_to_public_key</option> = <replaceable>~/.ssh/id_rsa.pub</replaceable></td>
        <td>(StrOpt) Path to hosts public key.</td>
      </tr>
      <tr>
        <td><option>root_helper</option> = <replaceable>sudo</replaceable></td>
        <td>(StrOpt) Deprecated: command to use for running commands as root.</td>
      </tr>
      <tr>
        <td><option>service_image_name</option> = <replaceable>manila-service-image</replaceable></td>
        <td>(StrOpt) Name of image in Glance, that will be used for service instance creation.</td>
      </tr>
      <tr>
        <td><option>service_instance_flavor_id</option> = <replaceable>100</replaceable></td>
        <td>(IntOpt) ID of flavor, that will be used for service instance creation.</td>
      </tr>
      <tr>
        <td><option>service_instance_name_or_id</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Name or ID of service instance in Nova to use for share exports. Used only when share servers handling is disabled.</td>
      </tr>
      <tr>
        <td><option>service_instance_name_template</option> = <replaceable>manila_service_instance_%s</replaceable></td>
        <td>(StrOpt) Name of service instance.</td>
      </tr>
      <tr>
        <td><option>service_instance_network_helper_type</option> = <replaceable>neutron</replaceable></td>
        <td>(StrOpt) Allowed values are ['nova', 'neutron'].</td>
      </tr>
      <tr>
        <td><option>service_instance_password</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Password for service instance user.</td>
      </tr>
      <tr>
        <td><option>service_instance_security_group</option> = <replaceable>manila-service</replaceable></td>
        <td>(StrOpt) Security group name, that will be used for service instance creation.</td>
      </tr>
      <tr>
        <td><option>service_instance_smb_config_path</option> = <replaceable>$share_mount_path/smb.conf</replaceable></td>
        <td>(StrOpt) Path to SMB config in service instance.</td>
      </tr>
      <tr>
        <td><option>service_instance_user</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) User in service instance that will be used for authentication.</td>
      </tr>
      <tr>
        <td><option>service_net_name_or_ip</option> = <replaceable>None</replaceable></td>
        <td>(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.</td>
      </tr>
      <tr>
        <td><option>service_network_cidr</option> = <replaceable>10.254.0.0/16</replaceable></td>
        <td>(StrOpt) CIDR of manila service network. Used only with Neutron.</td>
      </tr>
      <tr>
        <td><option>service_network_division_mask</option> = <replaceable>28</replaceable></td>
        <td>(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.</td>
      </tr>
      <tr>
        <td><option>service_network_name</option> = <replaceable>manila_service_network</replaceable></td>
        <td>(StrOpt) Name of manila service network. Used only with Neutron.</td>
      </tr>
      <tr>
        <td><option>share_backend_name</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The backend name for a given driver implementation.</td>
      </tr>
      <tr>
        <td><option>share_driver</option> = <replaceable>manila.share.drivers.generic.GenericShareDriver</replaceable></td>
        <td>(StrOpt) Driver to use for share creation.</td>
      </tr>
      <tr>
        <td><option>share_helpers</option> = <replaceable>CIFS=manila.share.drivers.generic.CIFSHelper, NFS=manila.share.drivers.generic.NFSHelper</replaceable></td>
        <td>(ListOpt) Specify list of share export helpers.</td>
      </tr>
      <tr>
        <td><option>share_manager</option> = <replaceable>manila.share.manager.ShareManager</replaceable></td>
        <td>(StrOpt) Full class name for the share manager.</td>
      </tr>
      <tr>
        <td><option>share_mount_path</option> = <replaceable>/shares</replaceable></td>
        <td>(StrOpt) Parent path in service instance where shares will be mounted.</td>
      </tr>
      <tr>
        <td><option>share_name_template</option> = <replaceable>share-%s</replaceable></td>
        <td>(StrOpt) Template string to be used to generate share names.</td>
      </tr>
      <tr>
        <td><option>share_snapshot_name_template</option> = <replaceable>share-snapshot-%s</replaceable></td>
        <td>(StrOpt) Template string to be used to generate share snapshot names.</td>
      </tr>
      <tr>
        <td><option>share_usage_audit_period</option> = <replaceable>month</replaceable></td>
        <td>(StrOpt) Time period to generate share usages for.  Time period must be hour, day, month or year.</td>
      </tr>
      <tr>
        <td><option>share_volume_fstype</option> = <replaceable>ext4</replaceable></td>
        <td>(StrOpt) Filesystem type of the share volume.</td>
      </tr>
      <tr>
        <td><option>smb_template_config_path</option> = <replaceable>$state_path/smb.conf</replaceable></td>
        <td>(StrOpt) Path to smb config.</td>
      </tr>
      <tr>
        <td><option>suppress_post_hooks_errors</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Whether to suppress post hook errors (allow driver's results to pass through) or not.</td>
      </tr>
      <tr>
        <td><option>suppress_pre_hooks_errors</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Whether to suppress pre hook errors (allow driver perform actions) or not.</td>
      </tr>
      <tr>
        <td><option>tenant_net_name_or_ip</option> = <replaceable>None</replaceable></td>
        <td>(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.</td>
      </tr>
      <tr>
        <td><option>unmanage_remove_access_rules</option> = <replaceable>False</replaceable></td>
        <td>(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.</td>
      </tr>
      <tr>
        <td><option>unused_share_server_cleanup_interval</option> = <replaceable>10</replaceable></td>
        <td>(IntOpt) Unallocated share servers reclamation time interval (minutes). Minimum value is 10 minutes, maximum is 60 minutes. The reclamation function is run every 10 minutes and delete share servers which were unused more than unused_share_server_cleanup_interval option defines. This value reflects the shortest time Manila will wait for a share server to go unutilized before deleting it.</td>
      </tr>
      <tr>
        <td><option>use_scheduler_creating_share_from_snapshot</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) If set to False, then share creation from snapshot will be performed on the same host. If set to True, then scheduling step will be used.</td>
      </tr>
    </tbody>
  </table>
</para>