Additional options

updated: 2019-08-16 16:59
Contents

Additional options

These options can also be set in the manila.conf file.

Description of API configuration options
Configuration option = Default value Description
[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.
enable_v1_api = False (Boolean) Deploy v1 of the Manila API. This option is deprecated, is not used, and will be removed in a future release.
enable_v2_api = False (Boolean) Deploy v2 of the Manila API. This option is deprecated, is not used, and will be removed in a future release.
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]  
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 an SSL termination proxy.
[oslo_policy]  
policy_default_rule = default (String) Default rule. Enforced when a requested rule is not found.
policy_dirs = ['policy.d'] (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
policy_file = policy.json (String) The JSON file that defines policies.
Description of Authorization Token configuration options
Configuration option = Default value Description
[keystone_authtoken]  
admin_password = None (String) Service user password.
admin_tenant_name = admin (String) Service tenant name.
admin_token = None (String) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use admin_user and admin_password instead.
admin_user = None (String) Service username.
auth_admin_prefix = (String) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
auth_host = 127.0.0.1 (String) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
auth_port = 35357 (Integer) Port of the admin Identity API endpoint. Deprecated, use identity_uri.
auth_protocol = https (String) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri.
auth_section = None (Unknown) Config Section from which to load plugin specific options
auth_type = None (Unknown) Authentication type to load
auth_uri = None (String) Complete public Identity API endpoint.
auth_version = None (String) API version of the admin Identity API endpoint.
cache = None (String) Env key for the swift cache.
cafile = None (String) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
certfile = None (String) Required if identity server requires client certificate
check_revocations_for_cached = False (Boolean) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
delay_auth_decision = False (Boolean) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
enforce_token_bind = permissive (String) Used to control the use and type of token binding. Can be set to: “disabled” to not check token binding. “permissive” (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. “strict” like “permissive” but if the bind type is unknown the token will be rejected. “required” any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
hash_algorithms = md5 (List) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
http_connect_timeout = None (Integer) Request timeout value for communicating with Identity API server.
http_request_max_retries = 3 (Integer) How many times are we trying to reconnect when communicating with Identity API Server.
identity_uri = None (String) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/
include_service_catalog = True (Boolean) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
insecure = False (Boolean) Verify HTTPS connections.
keyfile = None (String) Required if identity server requires client certificate
memcache_pool_conn_get_timeout = 10 (Integer) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
memcache_pool_dead_retry = 300 (Integer) (Optional) Number of seconds memcached server is considered dead before it is tried again.
memcache_pool_maxsize = 10 (Integer) (Optional) Maximum total number of open connections to every memcached server.
memcache_pool_socket_timeout = 3 (Integer) (Optional) Socket timeout in seconds for communicating with a memcached server.
memcache_pool_unused_timeout = 60 (Integer) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
memcache_secret_key = None (String) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
memcache_security_strategy = None (String) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
memcache_use_advanced_pool = False (Boolean) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.
memcached_servers = None (List) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
region_name = None (String) The region in which the identity server can be found.
revocation_cache_time = 10 (Integer) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
signing_dir = None (String) Directory used to cache files related to PKI tokens.
token_cache_time = 300 (Integer) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.
Description of Authorization configuration options
Configuration option = Default value Description
[DEFAULT]  
auth_strategy = keystone (String) The strategy to use for auth. Supports noauth, keystone, and deprecated.
Description of Certificate Authority configuration options
Configuration option = Default value Description
[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.
Description of CephFS Driver configuration options
Configuration option = Default value Description
[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.
Description of Common configuration options
Configuration option = Default value Description
[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_access_wait_access_rules_timeout = 180 (Integer) Time to wait for access rules to be allowed/denied on backends when migrating a share (seconds).
data_manager = manila.data.manager.DataManager (String) Full class name for the data manager.
data_node_access_cert = None (String) The certificate installed in the data node in order to allow access to certificate authentication-based shares.
data_node_access_ip = None (String) The IP of the node interface connected to the admin network. Used for allowing access to the mounting shares.
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.
host = localhost (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 = 10.0.0.1 (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_clean_db = clean.sqlite (String) File name of clean sqlite database.
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.
Description of Compute configuration options
Configuration option = Default value Description
[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.
Description of CORS configuration options
Configuration option = Default value Description
[cors]  
allow_credentials = True (Boolean) Indicate that the actual request can include user credentials
allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma (List) Indicate which header field names may be used during the actual request.
allow_methods = GET, POST, PUT, DELETE, OPTIONS (List) Indicate which methods can be used during the actual request.
allowed_origin = None (List) Indicate whether this resource may be shared with the domain received in the requests “origin” header.
expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
max_age = 3600 (Integer) Maximum cache age of CORS preflight requests.
[cors.subdomain]  
allow_credentials = True (Boolean) Indicate that the actual request can include user credentials
allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma (List) Indicate which header field names may be used during the actual request.
allow_methods = GET, POST, PUT, DELETE, OPTIONS (List) Indicate which methods can be used during the actual request.
allowed_origin = None (List) Indicate whether this resource may be shared with the domain received in the requests “origin” header.
expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
max_age = 3600 (Integer) Maximum cache age of CORS preflight requests.
Description of Database configuration options
Configuration option = Default value Description
[DEFAULT]  
db_backend = sqlalchemy (String) The backend to use for database.
db_driver = manila.db (String) Driver to use for database access.
[database]  
backend = sqlalchemy (String) The back end to use for the database.
connection = None (String) The SQLAlchemy connection string to use to connect to the database.
connection_debug = 0 (Integer) Verbosity of SQL debugging information: 0=None, 100=Everything.
connection_trace = False (Boolean) Add Python stack traces to SQL as comment strings.
db_inc_retry_interval = True (Boolean) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
db_max_retries = 20 (Integer) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.
db_max_retry_interval = 10 (Integer) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
db_retry_interval = 1 (Integer) Seconds between retries of a database transaction.
idle_timeout = 3600 (Integer) Timeout before idle SQL connections are reaped.
max_overflow = 50 (Integer) If set, use this value for max_overflow with SQLAlchemy.
max_pool_size = None (Integer) Maximum number of SQL connections to keep open in a pool.
max_retries = 10 (Integer) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
min_pool_size = 1 (Integer) Minimum number of SQL connections to keep open in a pool.
mysql_sql_mode = TRADITIONAL (String) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
pool_timeout = None (Integer) If set, use this value for pool_timeout with SQLAlchemy.
retry_interval = 10 (Integer) Interval between retries of opening a SQL connection.
slave_connection = None (String) The SQLAlchemy connection string to use to connect to the slave database.
sqlite_db = oslo.sqlite (String) The file name to use with SQLite.
sqlite_synchronous = True (Boolean) If True, SQLite uses synchronous mode.
use_db_reconnect = False (Boolean) Enable the experimental use of database reconnect on connection lost.
Description of Ganesha configuration options
Configuration option = Default value Description
[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.
Description of hnas configuration options
Configuration option = Default value Description
[DEFAULT]  
hds_hnas_driver_helper = manila.share.drivers.hitachi.ssh.HNASSSHBackend (String) Python class to be used for driver helper.
Description of Logging configuration options
Configuration option = Default value Description
[DEFAULT]  
debug = False (Boolean) If set to true, the logging level will be set to DEBUG instead of the default INFO level.
default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN, keystoneauth=WARN, oslo.cache=INFO, dogpile.core.dogpile=INFO (List) List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
fatal_deprecations = False (Boolean) Enables or disables fatal status of deprecations.
fatal_exception_format_errors = False (Boolean) Whether to make exception message format errors fatal.
instance_format = "[instance: %(uuid)s] " (String) The format for an instance that is passed with the log message.
instance_uuid_format = "[instance: %(uuid)s] " (String) The format for an instance UUID that is passed with the log message.
log_config_append = None (String) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string).
log_date_format = %Y-%m-%d %H:%M:%S (String) Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.
log_dir = None (String) (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
log_file = None (String) (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.
logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s (String) Format string to use for log messages with context.
logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d (String) Additional data to append to log message when logging level for the message is DEBUG.
logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s (String) Format string to use for log messages when context is undefined.
logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s (String) Prefix each line of exception output with this format.
logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s (String) Defines the format string for %(user_identity)s that is used in logging_context_format_string.
publish_errors = False (Boolean) Enables or disables publication of error events.
syslog_log_facility = LOG_USER (String) Syslog facility to receive log lines. This option is ignored if log_config_append is set.
use_stderr = True (Boolean) Log output to standard error. This option is ignored if log_config_append is set.
use_syslog = False (Boolean) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.
verbose = True (Boolean) DEPRECATED: If set to false, the logging level will be set to WARNING instead of the default INFO level.
watch_log_file = False (Boolean) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.
Description of Quota configuration options
Configuration option = Default value Description
[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.
Description of Redis configuration options
Configuration option = Default value Description
[matchmaker_redis]  
check_timeout = 20000 (Integer) Time in ms to wait before the transaction is killed.
host = 127.0.0.1 (String) Host to locate redis.
password = (String) Password for Redis server (optional).
port = 6379 (Port number) Use this port to connect to redis host.
sentinel_group_name = oslo-messaging-zeromq (String) Redis replica set name.
sentinel_hosts = (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ]
socket_timeout = 1000 (Integer) Timeout in ms on blocking socket operations
wait_timeout = 500 (Integer) Time in ms to wait between connection attempts.
Description of SAN configuration options
Configuration option = Default value Description
[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.
Description of Scheduler configuration options
Configuration option = Default value Description
[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, ConsistencyGroupFilter, ShareReplicationFilter (List) Which filter class names to use for filtering hosts when not specified in the request.
scheduler_default_weighers = CapacityWeigher (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.
Description of Share configuration options
Configuration option = Default value Description
[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_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’)’
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_create_delete_share_timeout = 300 (Integer) Timeout for creating and deleting share instances when performing share migration (seconds).
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) Specify whether read only access rule mode is supported in this backend.
migration_tmp_location = /tmp/ (String) Temporary path to create and mount shares during migration.
migration_wait_access_rules_timeout = 180 (Integer) Time to wait for access rules to be allowed/denied on backends when migrating shares using generic approach (seconds).
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_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.
Description of Tegile Share Driver configuration options
Configuration option = Default value Description
[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.
Description of WinRM configuration options
Configuration option = Default value Description
[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.
Description of ZFSSA Share Driver configuration options
Configuration option = Default value Description
[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_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).
updated: 2019-08-16 16:59
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug questions?