Red Hat Training

A Red Hat training course is available for Red Hat OpenStack Platform

Chapter 10. Shared File Systems

The Shared File Systems service provides shared file systems that Compute instances can consume.

10.1. Shared Storage Configuration Options

Note

The common configurations for shared services and libraries, such as database connections and RPC messaging, are described at Common configurations.

10.1.1. Description of Configuration Options

The following tables provide a comprehensive list of the Shared File Systems configuration options.

Table 10.1. Description of API configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

admin_network_config_group = None

(String) If share driver requires to setup admin network for share, then define network plugin config options in some separate config group and set its name here. Used only with another option 'driver_handles_share_servers' set to 'True'.

admin_network_id = None

(String) ID of neutron network used to communicate with admin network, to create additional admin export locations on.

admin_subnet_id = None

(String) ID of neutron subnet used to communicate with admin network, to create additional admin export locations on. Related to 'admin_network_id'.

api_paste_config = api-paste.ini

(String) File name for the paste.deploy config for manila-api.

api_rate_limit = True

(Boolean) Whether to rate limit the API.

db_backend = sqlalchemy

(String) The backend to use for database.

max_header_line = 16384

(Integer) Maximum line size of message headers to be accepted. Option max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).

osapi_max_limit = 1000

(Integer) The maximum number of items returned in a single response from a collection resource.

osapi_share_base_URL = None

(String) Base URL to be presented to users in links to the Share API

osapi_share_ext_list =

(List) Specify list of extensions to load when using osapi_share_extension option with manila.api.contrib.select_extensions.

osapi_share_extension = manila.api.contrib.standard_extensions

(List) The osapi share extensions to load.

osapi_share_listen = ::

(String) IP address for OpenStack Share API to listen on.

osapi_share_listen_port = 8786

(Port number) Port for OpenStack Share API to listen on.

osapi_share_workers = 1

(Integer) Number of workers for OpenStack Share API service.

share_api_class = manila.share.api.API

(String) The full class name of the share API class to use.

volume_api_class = manila.volume.cinder.API

(String) The full class name of the Volume API class to use.

volume_name_template = manila-share-%s

(String) Volume name template.

volume_snapshot_name_template = manila-snapshot-%s

(String) Volume snapshot name template.

[oslo_middleware]

 

enable_proxy_headers_parsing = False

(Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.

max_request_body_size = 114688

(Integer) The maximum body size for each request, in bytes.

secure_proxy_ssl_header = X-Forwarded-Proto

(String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.

Table 10.2. Description of Authorization configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

auth_strategy = keystone

(String) The strategy to use for auth. Supports noauth, keystone, and deprecated.

Table 10.3. Description of Certificate Authority configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

ssl_ca_file = None

(String) CA certificate file to use to verify connecting clients.

ssl_cert_file = None

(String) Certificate file to use when starting the server securely.

ssl_key_file = None

(String) Private key file to use when starting the server securely.

Table 10.4. Description of CephFS share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

cephfs_auth_id = manila

(String) The name of the ceph auth identity to use.

cephfs_cluster_name = None

(String) The name of the cluster in use, if it is not the default ('ceph').

cephfs_conf_path =

(String) Fully qualified path to the ceph.conf file.

cephfs_enable_snapshots = False

(Boolean) Whether to enable snapshots in this driver.

Table 10.5. Description of Common configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

client_socket_timeout = 900

(Integer) Timeout for client connections socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.

compute_api_class = manila.compute.nova.API

(String) The full class name of the Compute API class to use.

data_manager = manila.data.manager.DataManager

(String) Full class name for the data manager.

data_topic = manila-data

(String) The topic data nodes listen on.

enable_new_services = True

(Boolean) Services to be added to the available pool on create.

fatal_exception_format_errors = False

(Boolean) Whether to make exception message format errors fatal.

filter_function = None

(String) String representation for an equation that will be used to filter hosts.

host = <your_hostname>

(String) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.

max_over_subscription_ratio = 20.0

(Floating point) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 is invalid.

memcached_servers = None

(List) Memcached servers or None for in process cache.

monkey_patch = False

(Boolean) Whether to log monkey patching.

monkey_patch_modules =

(List) List of modules or decorators to monkey patch.

my_ip = <your_ip>

(String) IP address of this host.

num_shell_tries = 3

(Integer) Number of times to attempt to run flakey shell commands.

periodic_fuzzy_delay = 60

(Integer) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)

periodic_hooks_interval = 300.0

(Floating point) Interval in seconds between execution of periodic hooks. Used when option 'enable_periodic_hooks' is set to True. Default is 300.

periodic_interval = 60

(Integer) Seconds between running periodic tasks.

replica_state_update_interval = 300

(Integer) This value, specified in seconds, determines how often the share manager will poll for the health (replica_state) of each replica instance.

replication_domain = None

(String) A string specifying the replication domain that the backend belongs to. This option needs to be specified the same in the configuration sections of all backends that support replication between each other. If this option is not specified in the group, it means that replication is not enabled on the backend.

report_interval = 10

(Integer) Seconds between nodes reporting state to datastore.

reserved_share_percentage = 0

(Integer) The percentage of backend capacity reserved.

rootwrap_config = None

(String) Path to the rootwrap configuration file to use for running commands as root.

service_down_time = 60

(Integer) Maximum time since last check-in for up service.

smb_template_config_path = $state_path/smb.conf

(String) Path to smb config.

sql_idle_timeout = 3600

(Integer) Timeout before idle SQL connections are reaped.

sql_max_retries = 10

(Integer) Maximum database connection retries during startup. (setting -1 implies an infinite retry count).

sql_retry_interval = 10

(Integer) Interval between retries of opening a SQL connection.

sqlite_db = manila.sqlite

(String) The filename to use with sqlite.

sqlite_synchronous = True

(Boolean) If passed, use synchronous mode for sqlite.

state_path = /var/lib/manila

(String) Top-level directory for maintaining manila’s state.

storage_availability_zone = nova

(String) Availability zone of this node.

tcp_keepalive = True

(Boolean) Sets the value of TCP_KEEPALIVE (True/False) for each server socket.

tcp_keepalive_count = None

(Integer) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X.

tcp_keepalive_interval = None

(Integer) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X.

tcp_keepidle = 600

(Integer) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.

until_refresh = 0

(Integer) Count of reservations until usage is refreshed.

use_forwarded_for = False

(Boolean) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.

wsgi_keep_alive = True

(Boolean) If False, closes the client socket connection explicitly. Setting it to True to maintain backward compatibility. Recommended setting is set it to False.

[coordination]

 

backend_url = file://$state_path

(String) The back end URL to use for distributed coordination.

heartbeat = 1.0

(Floating point) Number of seconds between heartbeats for distributed coordination.

initial_reconnect_backoff = 0.1

(Floating point) Initial number of seconds to wait after failed reconnection.

max_reconnect_backoff = 60.0

(Floating point) Maximum number of seconds between sequential reconnection retries.

[healthcheck]

 

backends =

(List) Additional backends that can perform health checks and report that information back as part of a request.

detailed = False

(Boolean) Show more detailed information as part of the response

disable_by_file_path = None

(String) Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin.

disable_by_file_paths =

(List) Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin.

path = /healthcheck

(String) DEPRECATED: The path to respond to healtcheck requests on.

Table 10.6. Description of Compute configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

nova_admin_auth_url = http://localhost:5000/v2.0

(String) DEPRECATED: Identity service URL. This option isn’t used any longer. Please use [nova] url instead.

nova_admin_password = None

(String) DEPRECATED: Nova admin password. This option isn’t used any longer. Please use [nova] password instead.

nova_admin_tenant_name = service

(String) DEPRECATED: Nova admin tenant name. This option isn’t used any longer. Please use [nova] tenant instead.

nova_admin_username = nova

(String) DEPRECATED: Nova admin username. This option isn’t used any longer. Please use [nova] username instead.

nova_catalog_admin_info = compute:nova:adminURL

(String) DEPRECATED: Same as nova_catalog_info, but for admin endpoint. This option isn’t used any longer.

nova_catalog_info = compute:nova:publicURL

(String) DEPRECATED: Info to match when looking for nova in the service catalog. Format is separated values of the form: <service_type>:<service_name>:<endpoint_type> This option isn’t used any longer.

os_region_name = None

(String) Region name of this node.

Table 10.7. Description of EMC share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

emc_nas_login = None

(String) User name for the EMC server.

emc_nas_password = None

(String) Password for the EMC server.

emc_nas_root_dir = None

(String) The root directory where shares will be located.

emc_nas_server = None

(String) EMC server hostname or IP address.

emc_nas_server_container = None

(String) DEPRECATED: Storage processor to host the NAS server. Obsolete. Unity driver supports nas server auto load balance.

emc_nas_server_port = 8080

(Port number) Port number for the EMC server.

emc_nas_server_secure = True

(Boolean) Use secure connection to server.

emc_share_backend = None

(String) Share backend.

Table 10.8. Description of Ganesha configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

ganesha_config_dir = /etc/ganesha

(String) Directory where Ganesha config files are stored.

ganesha_config_path = $ganesha_config_dir/ganesha.conf

(String) Path to main Ganesha config file.

ganesha_db_path = $state_path/manila-ganesha.db

(String) Location of Ganesha database file. (Ganesha module only.)

ganesha_export_dir = $ganesha_config_dir/export.d

(String) Path to directory containing Ganesha export configuration. (Ganesha module only.)

ganesha_export_template_dir = /etc/manila/ganesha-export-templ.d

(String) Path to directory containing Ganesha export block templates. (Ganesha module only.)

ganesha_nfs_export_options = maxread = 65536, prefread = 65536

(String) Options to use when exporting a share using ganesha NFS server. Note that these defaults can be overridden when a share is created by passing metadata with key name export_options. Also note the complete set of default ganesha export options is specified in ganesha_utils. (GPFS only.)

ganesha_service_name = ganesha.nfsd

(String) Name of the ganesha nfs service.

Table 10.9. Description of Generic share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

cinder_volume_type = None

(String) Name or id of cinder volume type which will be used for all volumes created by driver.

connect_share_server_to_tenant_network = False

(Boolean) Attach share server directly to share network. Used only with Neutron and if driver_handles_share_servers=True.

container_volume_group = manila_docker_volumes

(String) LVM volume group to use for volumes. This volume group must be created by the cloud administrator independently from manila operations.

driver_handles_share_servers = None

(Boolean) 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.

goodness_function = None

(String) String representation for an equation that will be used to determine the goodness of a host.

interface_driver = manila.network.linux.interface.OVSInterfaceDriver

(String) Vif driver. Used only with Neutron and if driver_handles_share_servers=True.

manila_service_keypair_name = manila-service

(String) Keypair name that will be created and used for service instances. Only used if driver_handles_share_servers=True.

max_time_to_attach = 120

(Integer) Maximum time to wait for attaching cinder volume.

max_time_to_build_instance = 300

(Integer) Maximum time in seconds to wait for creating service instance.

max_time_to_create_volume = 180

(Integer) Maximum time to wait for creating cinder volume.

max_time_to_extend_volume = 180

(Integer) Maximum time to wait for extending cinder volume.

ovs_integration_bridge = br-int

(String) Name of Open vSwitch bridge to use.

path_to_private_key = None

(String) Path to host’s private key.

path_to_public_key = ~/.ssh/id_rsa.pub

(String) Path to hosts public key. Only used if driver_handles_share_servers=True.

protocol_access_mapping = {'ip': ['nfs'], 'user': ['cifs']}

(Dict) Protocol access mapping for this backend. Should be a dictionary comprised of {'access_type1': ['share_proto1', 'share_proto2'], 'access_type2': ['share_proto2', 'share_proto3']}.

service_image_name = manila-service-image

(String) Name of image in Glance, that will be used for service instance creation. Only used if driver_handles_share_servers=True.

service_instance_flavor_id = 100

(Integer) ID of flavor, that will be used for service instance creation. Only used if driver_handles_share_servers=True.

service_instance_name_or_id = None

(String) Name or ID of service instance in Nova to use for share exports. Used only when share servers handling is disabled.

service_instance_name_template = manila_service_instance_%s

(String) Name of service instance. Only used if driver_handles_share_servers=True.

service_instance_network_helper_type = neutron

(String) DEPRECATED: Used to select between neutron and nova helpers when driver_handles_share_servers=True. Obsolete. This option isn’t used any longer because nova networking is no longer supported.

service_instance_password = None

(String) Password for service instance user.

service_instance_security_group = manila-service

(String) Security group name, that will be used for service instance creation. Only used if driver_handles_share_servers=True.

service_instance_smb_config_path = $share_mount_path/smb.conf

(String) Path to SMB config in service instance.

service_instance_user = None

(String) User in service instance that will be used for authentication.

service_net_name_or_ip = None

(String) 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.

service_network_cidr = 10.254.0.0/16

(String) CIDR of manila service network. Used only with Neutron and if driver_handles_share_servers=True.

service_network_division_mask = 28

(Integer) 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 if driver_handles_share_servers=True.

service_network_name = manila_service_network

(String) Name of manila service network. Used only with Neutron. Only used if driver_handles_share_servers=True.

share_helpers = CIFS=manila.share.drivers.helpers.CIFSHelperIPAccess, NFS=manila.share.drivers.helpers.NFSHelper

(List) Specify list of share export helpers.

share_mount_path = /shares

(String) Parent path in service instance where shares will be mounted.

share_mount_template = mount -vt %(proto)s %(options)s %(export)s %(path)s

(String) The template for mounting shares for this backend. Must specify the executable with all necessary parameters for the protocol supported. 'proto' template element may not be required if included in the command. 'export' and 'path' template elements are required. It is advisable to separate different commands per backend.

share_unmount_template = umount -v %(path)s

(String) The template for unmounting shares for this backend. Must specify the executable with all necessary parameters for the protocol supported. 'path' template element is required. It is advisable to separate different commands per backend.

share_volume_fstype = ext4

(String) Filesystem type of the share volume.

tenant_net_name_or_ip = None

(String) 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.

volume_name_template = manila-share-%s

(String) Volume name template.

volume_snapshot_name_template = manila-snapshot-%s

(String) Volume snapshot name template.

[cinder]

 

api_insecure = False

(Boolean) Allow to perform insecure SSL requests to cinder.

auth_section = None

(Unknown) Config Section from which to load plugin specific options

auth_type = None

(Unknown) Authentication type to load

ca_certificates_file = None

(String) Location of CA certificates file to use for cinder client requests.

cafile = None

(String) PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile = None

(String) PEM encoded client certificate cert file

cross_az_attach = True

(Boolean) Allow attaching between instances and volumes in different availability zones.

endpoint_type = publicURL

(String) Endpoint type to be used with cinder client calls.

http_retries = 3

(Integer) Number of cinderclient retries on failed HTTP calls.

insecure = False

(Boolean) Verify HTTPS connections.

keyfile = None

(String) PEM encoded client certificate key file

region_name = None

(String) Region name for connecting to cinder.

timeout = None

(Integer) Timeout value for http requests

[neutron]

 

cafile = None

(String) PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile = None

(String) PEM encoded client certificate cert file

insecure = False

(Boolean) Verify HTTPS connections.

keyfile = None

(String) PEM encoded client certificate key file

timeout = None

(Integer) Timeout value for http requests

[nova]

 

api_insecure = False

(Boolean) Allow to perform insecure SSL requests to nova.

api_microversion = 2.10

(String) Version of Nova API to be used.

auth_section = None

(Unknown) Config Section from which to load plugin specific options

auth_type = None

(Unknown) Authentication type to load

ca_certificates_file = None

(String) Location of CA certificates file to use for nova client requests.

cafile = None

(String) PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile = None

(String) PEM encoded client certificate cert file

endpoint_type = publicURL

(String) Endpoint type to be used with nova client calls.

insecure = False

(Boolean) Verify HTTPS connections.

keyfile = None

(String) PEM encoded client certificate key file

region_name = None

(String) Region name for connecting to nova.

timeout = None

(Integer) Timeout value for http requests

Table 10.10. Description of GlusterFS share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

glusterfs_ganesha_server_ip = None

(String) Remote Ganesha server node’s IP address.

glusterfs_ganesha_server_password = None

(String) Remote Ganesha server node’s login password. This is not required if 'glusterfs_path_to_private_key' is configured.

glusterfs_ganesha_server_username = root

(String) Remote Ganesha server node’s username.

glusterfs_mount_point_base = $state_path/mnt

(String) Base directory containing mount points for Gluster volumes.

glusterfs_nfs_server_type = Gluster

(String) Type of NFS server that mediate access to the Gluster volumes (Gluster or Ganesha).

glusterfs_path_to_private_key = None

(String) Path of Manila host’s private SSH key file.

glusterfs_server_password = None

(String) Remote GlusterFS server node’s login password. This is not required if 'glusterfs_path_to_private_key' is configured.

glusterfs_servers =

(List) List of GlusterFS servers that can be used to create shares. Each GlusterFS server should be of the form [remoteuser@]<volserver>, and they are assumed to belong to distinct Gluster clusters.

glusterfs_share_layout = None

(String) Specifies GlusterFS share layout, that is, the method of associating backing GlusterFS resources to shares.

glusterfs_target = None

(String) Specifies the GlusterFS volume to be mounted on the Manila host. It is of the form [remoteuser@]<volserver>:<volid>.

glusterfs_volume_pattern = None

(String) Regular expression template used to filter GlusterFS volumes for share creation. The regex template can optionally (ie. with support of the GlusterFS backend) contain the {size} parameter which matches an integer (sequence of digits) in which case the value shall be interpreted as size of the volume in GB. Examples: "manila-share-volume-d+$", "manila-share-volume-{size}G-d+$"; with matching volume names, respectively: "manila-share-volume-12", "manila-share-volume-3G-13". In latter example, the number that matches "#{size}", that is, 3, is an indication that the size of volume is 3G.

Table 10.11. Description of IBM GPFS share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

gpfs_mount_point_base = $state_path/mnt

(String) Base folder where exported shares are located.

gpfs_nfs_server_list = None

(List) A list of the fully qualified NFS server names that make up the OpenStack Manila configuration.

gpfs_nfs_server_type = KNFS

(String) NFS Server type. Valid choices are "KNFS" (kernel NFS) or "CES" (Ganesha NFS).

gpfs_share_export_ip = None

(String) IP to be added to GPFS export string.

gpfs_share_helpers = KNFS=manila.share.drivers.ibm.gpfs.KNFSHelper, CES=manila.share.drivers.ibm.gpfs.CESHelper

(List) Specify list of share export helpers.

gpfs_ssh_login = None

(String) GPFS server SSH login name.

gpfs_ssh_password = None

(String) GPFS server SSH login password. The password is not needed, if 'gpfs_ssh_private_key' is configured.

gpfs_ssh_port = 22

(Port number) GPFS server SSH port.

gpfs_ssh_private_key = None

(String) Path to GPFS server SSH private key for login.

is_gpfs_node = False

(Boolean) True:when Manila services are running on one of the Spectrum Scale node. False:when Manila services are not running on any of the Spectrum Scale node.

knfs_export_options = rw,sync,no_root_squash,insecure,no_wdelay,no_subtree_check

(String) DEPRECATED: Options to use when exporting a share using kernel NFS server. Note that these defaults can be overridden when a share is created by passing metadata with key name export_options. This option isn’t used any longer. Please use share-type extra specs for export options.

Table 10.12. Description of HDFS share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

hdfs_namenode_ip = None

(String) The IP of the HDFS namenode.

hdfs_namenode_port = 9000

(Port number) The port of HDFS namenode service.

hdfs_ssh_name = None

(String) HDFS namenode ssh login name.

hdfs_ssh_port = 22

(Port number) HDFS namenode SSH port.

hdfs_ssh_private_key = None

(String) Path to HDFS namenode SSH private key for login.

hdfs_ssh_pw = None

(String) HDFS namenode SSH login password, This parameter is not necessary, if 'hdfs_ssh_private_key' is configured.

Table 10.13. Description of HPE 3PAR share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

hpe3par_api_url =

(String) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1

hpe3par_cifs_admin_access_domain = LOCAL_CLUSTER

(String) File system domain for the CIFS admin user.

hpe3par_cifs_admin_access_password =

(String) File system admin password for CIFS.

hpe3par_cifs_admin_access_username =

(String) File system admin user name for CIFS.

hpe3par_debug = False

(Boolean) Enable HTTP debugging to 3PAR

hpe3par_fpg = None

(Unknown) The File Provisioning Group (FPG) to use

hpe3par_fstore_per_share = False

(Boolean) Use one filestore per share

hpe3par_password =

(String) 3PAR password for the user specified in hpe3par_username

hpe3par_require_cifs_ip = False

(Boolean) Require IP access rules for CIFS (in addition to user)

hpe3par_san_ip =

(String) IP address of SAN controller

hpe3par_san_login =

(String) Username for SAN controller

hpe3par_san_password =

(String) Password for SAN controller

hpe3par_san_ssh_port = 22

(Port number) SSH port to use with SAN

hpe3par_share_mount_path = /mnt/

(String) The path where shares will be mounted when deleting nested file trees.

hpe3par_username =

(String) 3PAR username with the 'edit' role

Table 10.14. Description of Huawei share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

manila_huawei_conf_file = /etc/manila/manila_huawei_conf.xml

(String) The configuration file for the Manila Huawei driver.

Table 10.15. Description of LVM share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

lvm_share_export_ip = None

(String) IP to be added to export string.

lvm_share_export_root = $state_path/mnt

(String) Base folder where exported shares are located.

lvm_share_helpers = CIFS=manila.share.drivers.helpers.CIFSHelperUserAccess, NFS=manila.share.drivers.helpers.NFSHelper

(List) Specify list of share export helpers.

lvm_share_mirrors = 0

(Integer) If set, create LVMs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space.

lvm_share_volume_group = lvm-shares

(String) Name for the VG that will contain exported shares.

Table 10.16. Description of MapRFS share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

maprfs_base_volume_dir = /

(String) Path in MapRFS where share volumes must be created.

maprfs_cldb_ip = None

(List) The list of IPs or hostnames of CLDB nodes.

maprfs_clinode_ip = None

(List) The list of IPs or hostnames of nodes where mapr-core is installed.

maprfs_rename_managed_volume = True

(Boolean) Specify whether existing volume should be renamed when start managing.

maprfs_ssh_name = mapr

(String) Cluster admin user ssh login name.

maprfs_ssh_port = 22

(Port number) CLDB node SSH port.

maprfs_ssh_private_key = None

(String) Path to SSH private key for login.

maprfs_ssh_pw = None

(String) Cluster node SSH login password, This parameter is not necessary, if 'maprfs_ssh_private_key' is configured.

maprfs_zookeeper_ip = None

(List) The list of IPs or hostnames of ZooKeeper nodes.

Table 10.17. Description of NetApp share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

netapp_aggregate_name_search_pattern = (.*)

(String) Pattern for searching available aggregates for provisioning.

netapp_enabled_share_protocols = nfs3, nfs4.0

(List) The NFS protocol versions that will be enabled. Supported values include nfs3, nfs4.0, nfs4.1. This option only applies when the option driver_handles_share_servers is set to True.

netapp_lif_name_template = os_%(net_allocation_id)s

(String) Logical interface (LIF) name template

netapp_login = None

(String) Administrative user account name used to access the storage system.

netapp_password = None

(String) Password for the administrative user account specified in the netapp_login option.

netapp_port_name_search_pattern = (.*)

(String) Pattern for overriding the selection of network ports on which to create Vserver LIFs.

netapp_root_volume = root

(String) Root volume name.

netapp_root_volume_aggregate = None

(String) Name of aggregate to create Vserver root volumes on. This option only applies when the option driver_handles_share_servers is set to True.

netapp_server_hostname = None

(String) The hostname (or IP address) for the storage system.

netapp_server_port = None

(Port number) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS.

netapp_snapmirror_quiesce_timeout = 3600

(Integer) The maximum time in seconds to wait for existing snapmirror transfers to complete before aborting when promoting a replica.

netapp_storage_family = ontap_cluster

(String) The storage family type used on the storage system; valid values include ontap_cluster for using clustered Data ONTAP.

netapp_trace_flags = None

(String) Comma-separated list of options that control which trace info is written to the debug logs. Values include method and api.

netapp_transport_type = http

(String) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.

netapp_volume_move_cutover_timeout = 3600

(Integer) The maximum time in seconds to wait for the completion of a volume move operation after the cutover was triggered.

netapp_volume_name_template = share_%(share_id)s

(String) NetApp volume name template.

netapp_volume_snapshot_reserve_percent = 5

(Integer) The percentage of share space set aside as reserve for snapshot usage; valid values range from 0 to 90.

netapp_vserver_name_template = os_%s

(String) Name template to use for new Vserver.

Table 10.18. Description of QNAP storage share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

qnap_management_url = None

(String) The URL to manage QNAP Storage.

qnap_nas_login = None

(String) Username for QNAP storage.

qnap_nas_password = None

(String) Password for QNAP storage.

qnap_poolname = None

(String) Pool within which QNAP shares must be created.

qnap_share_ip = None

(String) NAS share IP for mounting shares.

Table 10.19. Description of Quobyte share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

quobyte_api_ca = None

(String) The X.509 CA file to verify the server cert.

quobyte_api_password = quobyte

(String) Password for Quobyte API server

quobyte_api_url = None

(String) URL of the Quobyte API server (http or https)

quobyte_api_username = admin

(String) Username for Quobyte API server.

quobyte_default_volume_group = root

(String) Default owning group for new volumes.

quobyte_default_volume_user = root

(String) Default owning user for new volumes.

quobyte_delete_shares = False

(Boolean) Actually deletes shares (vs. unexport)

quobyte_volume_configuration = BASE

(String) Name of volume configuration used for new shares.

Table 10.20. Description of Quota configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

max_age = 0

(Integer) Number of seconds between subsequent usage refreshes.

max_gigabytes = 10000

(Integer) Maximum number of volume gigabytes to allow per host.

quota_driver = manila.quota.DbQuotaDriver

(String) Default driver to use for quota checks.

quota_gigabytes = 1000

(Integer) Number of share gigabytes allowed per project.

quota_share_networks = 10

(Integer) Number of share-networks allowed per project.

quota_shares = 50

(Integer) Number of shares allowed per project.

quota_snapshot_gigabytes = 1000

(Integer) Number of snapshot gigabytes allowed per project.

quota_snapshots = 50

(Integer) Number of share snapshots allowed per project.

reservation_expire = 86400

(Integer) Number of seconds until a reservation expires.

Table 10.21. Description of Redis configuration options

Configuration option = Default valueDescription

[matchmaker_redis]

 

check_timeout = 20000

(Integer) Time in ms to wait before the transaction is killed.

host = 127.0.0.1

(String) DEPRECATED: Host to locate redis. Replaced by [DEFAULT]/transport_url

password =

(String) DEPRECATED: Password for Redis server (optional). Replaced by [DEFAULT]/transport_url

port = 6379

(Port number) DEPRECATED: Use this port to connect to redis host. Replaced by [DEFAULT]/transport_url

sentinel_group_name = oslo-messaging-zeromq

(String) Redis replica set name.

sentinel_hosts =

(List) DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode), e.g., [host:port, host1:port …​ ] Replaced by [DEFAULT]/transport_url

socket_timeout = 10000

(Integer) Timeout in ms on blocking socket operations.

wait_timeout = 2000

(Integer) Time in ms to wait between connection attempts.

Table 10.22. Description of SSH connection configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

ssh_conn_timeout = 60

(Integer) Backend server SSH connection timeout.

ssh_max_pool_conn = 10

(Integer) Maximum number of connections in the SSH pool.

ssh_min_pool_conn = 1

(Integer) Minimum number of connections in the SSH pool.

Table 10.23. Description of Scheduler configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

capacity_weight_multiplier = 1.0

(Floating point) Multiplier used for weighing share capacity. Negative numbers mean to stack vs spread.

pool_weight_multiplier = 1.0

(Floating point) Multiplier used for weighing pools which have existing share servers. Negative numbers mean to spread vs stack.

scheduler_default_filters = AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter, DriverFilter, ShareReplicationFilter

(List) Which filter class names to use for filtering hosts when not specified in the request.

scheduler_default_weighers = CapacityWeigher, GoodnessWeigher

(List) Which weigher class names to use for weighing hosts.

scheduler_driver = manila.scheduler.drivers.filter.FilterScheduler

(String) Default scheduler driver to use.

scheduler_host_manager = manila.scheduler.host_manager.HostManager

(String) The scheduler host manager class to use.

scheduler_json_config_location =

(String) Absolute path to scheduler configuration JSON file.

scheduler_manager = manila.scheduler.manager.SchedulerManager

(String) Full class name for the scheduler manager.

scheduler_max_attempts = 3

(Integer) Maximum number of attempts to schedule a share.

scheduler_topic = manila-scheduler

(String) The topic scheduler nodes listen on.

Table 10.24. Description of Share configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

automatic_share_server_cleanup = True

(Boolean) 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.

backlog = 4096

(Integer) Number of backlog requests to configure the socket with.

default_share_group_type = None

(String) Default share group type to use.

default_share_type = None

(String) Default share type to use.

delete_share_server_with_last_share = False

(Boolean) Whether share servers will be deleted on deletion of the last share.

driver_handles_share_servers = None

(Boolean) 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.

enable_periodic_hooks = False

(Boolean) Whether to enable periodic hooks or not.

enable_post_hooks = False

(Boolean) Whether to enable post hooks or not.

enable_pre_hooks = False

(Boolean) Whether to enable pre hooks or not.

enabled_share_backends = None

(List) A list of share backend names to use. These backend names should be backed by a unique [CONFIG] group with its options.

enabled_share_protocols = NFS, CIFS

(List) Specify list of protocols to be allowed for share creation. Available values are '('NFS', 'CIFS', 'GLUSTERFS', 'HDFS', 'CEPHFS', 'MAPRFS')'

executor_thread_pool_size = 64

(Integer) Size of executor thread pool.

hook_drivers =

(List) Driver(s) to perform some additional actions before and after share driver actions and on a periodic basis. Default is [].

migration_ignore_files = lost+found

(List) List of files and folders to be ignored when migrating shares. Items should be names (not including any path).

migration_readonly_rules_support = True

(Boolean) DEPRECATED: Specify whether read only access rule mode is supported in this backend. Obsolete. All drivers are now required to support read-only access rules.

network_config_group = None

(String) 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.

root_helper = sudo

(String) Deprecated: command to use for running commands as root.

share_manager = manila.share.manager.ShareManager

(String) Full class name for the share manager.

share_name_template = share-%s

(String) Template string to be used to generate share names.

share_snapshot_name_template = share-snapshot-%s

(String) Template string to be used to generate share snapshot names.

share_topic = manila-share

(String) The topic share nodes listen on.

share_usage_audit_period = month

(String) Time period to generate share usages for. Time period must be hour, day, month or year.

suppress_post_hooks_errors = False

(Boolean) Whether to suppress post hook errors (allow driver’s results to pass through) or not.

suppress_pre_hooks_errors = False

(Boolean) Whether to suppress pre hook errors (allow driver perform actions) or not.

unmanage_remove_access_rules = False

(Boolean) 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.

unused_share_server_cleanup_interval = 10

(Integer) 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.

use_scheduler_creating_share_from_snapshot = False

(Boolean) 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.

Table 10.25. Description of Tegile share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

tegile_default_project = None

(String) Create shares in this project

tegile_nas_login = None

(String) User name for the Tegile NAS server.

tegile_nas_password = None

(String) Password for the Tegile NAS server.

tegile_nas_server = None

(String) Tegile NAS server hostname or IP address.

Table 10.26. Description of Dell EMC VMAX share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

vmax_ethernet_ports = None

(List) Comma separated list of ports that can be used for share server interfaces. Members of the list can be Unix-style glob expressions.

vmax_server_container = None

(String) Data mover to host the NAS server.

vmax_share_data_pools = None

(List) Comma separated list of pools that can be used to persist share data.

Table 10.27. Description of Dell EMC VNX share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

vnx_ethernet_ports = None

(List) Comma separated list of ports that can be used for share server interfaces. Members of the list can be Unix-style glob expressions.

vnx_server_container = None

(String) Data mover to host the NAS server.

vnx_share_data_pools = None

(List) Comma separated list of pools that can be used to persist share data.

Table 10.28. Description of WinRM configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

winrm_cert_key_pem_path = ~/.ssl/key.pem

(String) Path to the x509 certificate key.

winrm_cert_pem_path = ~/.ssl/cert.pem

(String) Path to the x509 certificate used for accessing the serviceinstance.

winrm_conn_timeout = 60

(Integer) WinRM connection timeout.

winrm_operation_timeout = 60

(Integer) WinRM operation timeout.

winrm_retry_count = 3

(Integer) WinRM retry count.

winrm_retry_interval = 5

(Integer) WinRM retry interval in seconds

winrm_use_cert_based_auth = False

(Boolean) Use x509 certificates in order to authenticate to theservice instance.

Table 10.29. Description of ZFS share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

zfs_dataset_creation_options = None

(List) Define here list of options that should be applied for each dataset creation if needed. Example: compression=gzip,dedup=off. Note that, for secondary replicas option 'readonly' will be set to 'on' and for active replicas to 'off' in any way. Also, 'quota' will be equal to share size. Optional.

zfs_dataset_name_prefix = manila_share_

(String) Prefix to be used in each dataset name. Optional.

zfs_dataset_snapshot_name_prefix = manila_share_snapshot_

(String) Prefix to be used in each dataset snapshot name. Optional.

zfs_migration_snapshot_prefix = tmp_snapshot_for_share_migration_

(String) Set snapshot prefix for usage in ZFS migration. Required.

zfs_replica_snapshot_prefix = tmp_snapshot_for_replication_

(String) Set snapshot prefix for usage in ZFS replication. Required.

zfs_service_ip = None

(String) IP to be added to admin-facing export location. Required.

zfs_share_export_ip = None

(String) IP to be added to user-facing export location. Required.

zfs_share_helpers = NFS=manila.share.drivers.zfsonlinux.utils.NFSviaZFSHelper

(List) Specify list of share export helpers for ZFS storage. It should look like following: 'FOO_protocol=foo.FooClass,BAR_protocol=bar.BarClass'. Required.

zfs_ssh_private_key_path = None

(String) Path to SSH private key that should be used for SSH’ing ZFS storage host. Not used for replication operations. Optional.

zfs_ssh_user_password = None

(String) Password for user that is used for SSH’ing ZFS storage host. Not used for replication operations. They require passwordless SSH access. Optional.

zfs_ssh_username = None

(String) SSH user that will be used in 2 cases: 1) By manila-share service in case it is located on different host than its ZFS storage. 2) By manila-share services with other ZFS backends that perform replication. It is expected that SSH’ing will be key-based, passwordless. This user should be passwordless sudoer. Optional.

zfs_use_ssh = False

(Boolean) Remote ZFS storage hostname that should be used for SSH’ing. Optional.

zfs_zpool_list = None

(List) Specify list of zpools that are allowed to be used by backend. Can contain nested datasets. Examples: Without nested dataset: 'zpool_name'. With nested dataset: 'zpool_name/nested_dataset_name'. Required.

Table 10.30. Description of ZFSSA share driver configuration options

Configuration option = Default valueDescription

[DEFAULT]

 

zfssa_auth_password = None

(String) ZFSSA management authorized userpassword.

zfssa_auth_user = None

(String) ZFSSA management authorized username.

zfssa_data_ip = None

(String) IP address for data.

zfssa_host = None

(String) ZFSSA management IP address.

zfssa_manage_policy = loose

(String) Driver policy for share manage. A strict policy checks for a schema named manila_managed, and makes sure its value is true. A loose policy does not check for the schema.

zfssa_nas_checksum = fletcher4

(String) Controls checksum used for data blocks.

zfssa_nas_compression = off

(String) Data compression-off, lzjb, gzip-2, gzip, gzip-9.

zfssa_nas_logbias = latency

(String) Controls behavior when servicing synchronous writes.

zfssa_nas_mountpoint =

(String) Location of project in ZFS/SA.

zfssa_nas_quota_snap = true

(String) Controls whether a share quota includes snapshot.

zfssa_nas_rstchown = true

(String) Controls whether file ownership can be changed.

zfssa_nas_vscan = false

(String) Controls whether the share is scanned for viruses.

zfssa_pool = None

(String) ZFSSA storage pool name.

zfssa_project = None

(String) ZFSSA project name.

zfssa_rest_timeout = None

(String) REST connection timeout (in seconds).

10.1.2. New, updated, and deprecated options in Ocata for Shared File Systems service

Table 10.31. New options

Option = default value(Type) Help string

[DEFAULT] default_share_group_type = None

(StrOpt) Default share group type to use.

[DEFAULT] hitachi_hnas_admin_network_ip = None

(StrOpt) Specify IP for mounting shares in the Admin network.

[DEFAULT] maprfs_base_volume_dir = /

(StrOpt) Path in MapRFS where share volumes must be created.

[DEFAULT] maprfs_cldb_ip = None

(ListOpt) The list of IPs or hostnames of CLDB nodes.

[DEFAULT] maprfs_clinode_ip = None

(ListOpt) The list of IPs or hostnames of nodes where mapr-core is installed.

[DEFAULT] maprfs_rename_managed_volume = True

(BoolOpt) Specify whether existing volume should be renamed when start managing.

[DEFAULT] maprfs_ssh_name = mapr

(StrOpt) Cluster admin user ssh login name.

[DEFAULT] maprfs_ssh_port = 22

(PortOpt) CLDB node SSH port.

[DEFAULT] maprfs_ssh_private_key = None

(StrOpt) Path to SSH private key for login.

[DEFAULT] maprfs_ssh_pw = None

(StrOpt) Cluster node SSH login password, This parameter is not necessary, if 'maprfs_ssh_private_key' is configured.

[DEFAULT] maprfs_zookeeper_ip = None

(ListOpt) The list of IPs or hostnames of ZooKeeper nodes.

[DEFAULT] netapp_volume_move_cutover_timeout = 3600

(IntOpt) The maximum time in seconds to wait for the completion of a volume move operation after the cutover was triggered.

[DEFAULT] qnap_management_url = None

(StrOpt) The URL to manage QNAP Storage.

[DEFAULT] qnap_nas_login = None

(StrOpt) Username for QNAP storage.

[DEFAULT] qnap_nas_password = None

(StrOpt) Password for QNAP storage.

[DEFAULT] qnap_poolname = None

(StrOpt) Pool within which QNAP shares must be created.

[DEFAULT] qnap_share_ip = None

(StrOpt) NAS share IP for mounting shares.

[DEFAULT] unity_ethernet_ports = None

(ListOpt) Comma separated list of ports that can be used for share server interfaces. Members of the list can be Unix-style glob expressions.

[DEFAULT] unity_server_meta_pool = None

(StrOpt) Pool to persist the meta-data of NAS server.

[DEFAULT] unity_share_data_pools = None

(ListOpt) Comma separated list of pools that can be used to persist share data.

[DEFAULT] vmax_ethernet_ports = None

(ListOpt) Comma separated list of ports that can be used for share server interfaces. Members of the list can be Unix-style glob expressions.

[DEFAULT] vmax_server_container = None

(StrOpt) Data mover to host the NAS server.

[DEFAULT] vmax_share_data_pools = None

(ListOpt) Comma separated list of pools that can be used to persist share data.

[DEFAULT] vnx_ethernet_ports = None

(ListOpt) Comma separated list of ports that can be used for share server interfaces. Members of the list can be Unix-style glob expressions.

[DEFAULT] vnx_server_container = None

(StrOpt) Data mover to host the NAS server.

[DEFAULT] vnx_share_data_pools = None

(ListOpt) Comma separated list of pools that can be used to persist share data.

[coordination] backend_url = file://$state_path

(StrOpt) The back end URL to use for distributed coordination.

[coordination] heartbeat = 1.0

(FloatOpt) Number of seconds between heartbeats for distributed coordination.

[coordination] initial_reconnect_backoff = 0.1

(FloatOpt) Initial number of seconds to wait after failed reconnection.

[coordination] max_reconnect_backoff = 60.0

(FloatOpt) Maximum number of seconds between sequential reconnection retries.

Table 10.32. New default values

OptionPrevious default valueNew default value

[DEFAULT] scheduler_default_filters

AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter, ConsistencyGroupFilter, DriverFilter, ShareReplicationFilter

AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter, DriverFilter, ShareReplicationFilter

Table 10.33. Deprecated options

Deprecated optionNew Option

[DEFAULT] db_backend

[database] backend

[DEFAULT] emc_interface_ports

[DEFAULT] unity_ethernet_ports

[DEFAULT] emc_interface_ports

[DEFAULT] vnx_ethernet_ports

[DEFAULT] emc_nas_pool_names

[DEFAULT] vnx_share_data_pools

[DEFAULT] emc_nas_pool_names

[DEFAULT] unity_share_data_pools

[DEFAULT] emc_nas_server_container

[DEFAULT] vnx_server_container

[DEFAULT] emc_nas_server_pool

[DEFAULT] unity_server_meta_pool

[DEFAULT] hpe3par_share_mount_path

[DEFAULT] hpe3par_share_mount_path

[DEFAULT] rpc_thread_pool_size

[DEFAULT] executor_thread_pool_size

[DEFAULT] sql_idle_timeout

[database] idle_timeout

[DEFAULT] sql_max_retries

[database] max_retries

[DEFAULT] sql_retry_interval

[database] retry_interval

[DEFAULT] use_syslog

None