The manila.conf
file is installed in /etc/manila
by default.
When you manually install the Shared File Systems service, the options
in the manila.conf
file are set to default values.
The manila.conf
file contains most of the options needed to configure
the Shared File Systems service.
[DEFAULT]
#
# From manila
#
# The maximum number of items returned in a single response from a
# collection resource. (integer value)
#osapi_max_limit = 1000
# Base URL to be presented to users in links to the Share API (string
# value)
#osapi_share_base_URL = <None>
# Treat X-Forwarded-For as the canonical remote address. Only enable
# this if you have a sanitizing proxy. (boolean value)
#use_forwarded_for = false
# Top-level directory for maintaining manila's state. (string value)
#state_path = /var/lib/manila
# IP address of this host. (unknown value)
#my_ip = <your_ip>
# The topic scheduler nodes listen on. (string value)
#scheduler_topic = manila-scheduler
# The topic share nodes listen on. (string value)
#share_topic = manila-share
# The topic data nodes listen on. (string value)
#data_topic = manila-data
# Whether to rate limit the API. (boolean value)
#api_rate_limit = true
# Specify list of extensions to load when using osapi_share_extension
# option with manila.api.contrib.select_extensions. (list value)
#osapi_share_ext_list =
# The osapi share extensions to load. (list value)
#osapi_share_extension = manila.api.contrib.standard_extensions
# The filename to use with sqlite. (string value)
#sqlite_db = manila.sqlite
# If passed, use synchronous mode for sqlite. (boolean value)
#sqlite_synchronous = true
# Timeout before idle SQL connections are reaped. (integer value)
#sql_idle_timeout = 3600
# Maximum database connection retries during startup. (setting -1
# implies an infinite retry count). (integer value)
#sql_max_retries = 10
# Interval between retries of opening a SQL connection. (integer
# value)
#sql_retry_interval = 10
# Full class name for the scheduler manager. (string value)
#scheduler_manager = manila.scheduler.manager.SchedulerManager
# Full class name for the share manager. (string value)
#share_manager = manila.share.manager.ShareManager
# Full class name for the data manager. (string value)
#data_manager = manila.data.manager.DataManager
# Name of this node. This can be an opaque identifier. It is not
# necessarily a hostname, FQDN, or IP address. (unknown value)
#host = <your_hostname>
# Availability zone of this node. (string value)
#storage_availability_zone = nova
# Default share type to use. (string value)
#default_share_type = <None>
# Default share group type to use. (string value)
#default_share_group_type = <None>
# Memcached servers or None for in process cache. (list value)
#memcached_servers = <None>
# Time period to generate share usages for. Time period must be hour,
# day, month or year. (string value)
#share_usage_audit_period = month
# Deprecated: command to use for running commands as root. (string
# value)
#root_helper = sudo
# Path to the rootwrap configuration file to use for running commands
# as root. (string value)
#rootwrap_config = <None>
# Whether to log monkey patching. (boolean value)
#monkey_patch = false
# List of modules or decorators to monkey patch. (list value)
#monkey_patch_modules =
# Maximum time since last check-in for up service. (integer value)
#service_down_time = 60
# The full class name of the share API class to use. (string value)
#share_api_class = manila.share.api.API
# The strategy to use for auth. Supports noauth, keystone, and
# deprecated. (string value)
#auth_strategy = keystone
# A list of share backend names to use. These backend names should be
# backed by a unique [CONFIG] group with its options. (list value)
#enabled_share_backends = <None>
# Specify list of protocols to be allowed for share creation.
# Available values are '('NFS', 'CIFS', 'GLUSTERFS', 'HDFS', 'CEPHFS',
# 'MAPRFS')' (list value)
#enabled_share_protocols = NFS,CIFS
# The full class name of the Compute API class to use. (string value)
#compute_api_class = manila.compute.nova.API
# The back end URL to use for distributed coordination. (string value)
#backend_url = file://$state_path
# Time to wait for access rules to be allowed/denied on backends when
# migrating a share (seconds). (integer value)
#data_access_wait_access_rules_timeout = 180
# A list of the IPs of the node interface connected to the admin
# network. Used for allowing access to the mounting shares. Default is
# []. (list value)
#data_node_access_ips =
# DEPRECATED: The IP of the node interface connected to the admin
# network. Used for allowing access to the mounting shares. (string
# value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: New config option 'data_node_access_ips' added to support
# multiple IPs, including IPv6 addresses alongside IPv4.
#data_node_access_ip = <None>
# The certificate installed in the data node in order to allow access
# to certificate authentication-based shares. (string value)
#data_node_access_cert = <None>
# The admin user name registered in the security service in order to
# allow access to user authentication-based shares. (string value)
#data_node_access_admin_user = <None>
# Mount options to be included in the mount command for share
# protocols. Use dictionary format, example: {'nfs': '-o nfsvers=3',
# 'cifs': '-o user=foo,pass=bar'} (dict value)
#data_node_mount_options =
# The backend to use for database. (string value)
#db_backend = sqlalchemy
# Services to be added to the available pool on create. (boolean
# value)
#enable_new_services = true
# Template string to be used to generate share names. (string value)
#share_name_template = share-%s
# Template string to be used to generate share snapshot names. (string
# value)
#share_snapshot_name_template = share-snapshot-%s
# Driver to use for database access. (string value)
#db_driver = manila.db
# Whether to make exception message format errors fatal. (boolean
# value)
#fatal_exception_format_errors = false
# Message minimum life in seconds. (integer value)
#message_ttl = 2592000
# Interval between periodic task runs to clean expired messages in
# seconds. (integer value)
#message_reap_interval = 86400
# Name of Open vSwitch bridge to use. (string value)
#ovs_integration_bridge = br-int
# The full class name of the Networking API class to use. (string
# value)
#network_api_class = manila.network.neutron.neutron_network_plugin.NeutronNetworkPlugin
# Whether to support IPv4 network resource, Default=True. (boolean
# value)
#network_plugin_ipv4_enabled = true
# Whether to support IPv6 network resource, Default=False. If this
# option is True, the value of 'network_plugin_ipv4_enabled' will be
# ignored. (boolean value)
#network_plugin_ipv6_enabled = false
# The name of the physical network to determine which net segment is
# used. This opt is optional and will only be used for networks
# configured with multiple segments. (string value)
#neutron_physical_net_name = <None>
# Default Neutron network that will be used for share server creation.
# This opt is used only with class 'NeutronSingleNetworkPlugin'.
# (string value)
#neutron_net_id = <None>
# Default Neutron subnet that will be used for share server creation.
# Should be assigned to network defined in opt 'neutron_net_id'. This
# opt is used only with class 'NeutronSingleNetworkPlugin'. (string
# value)
#neutron_subnet_id = <None>
# vNIC type used for binding. (string value)
# Possible values:
# baremetal - <No description provided>
# normal - <No description provided>
# direct - <No description provided>
# direct-physical - <No description provided>
# macvtap - <No description provided>
#neutron_vnic_type = baremetal
# Host ID to be used when creating neutron port. If not set host is
# set to manila-share host by default. (string value)
#neutron_host_id = ubuntu-xenial-ovh-gra1-0022636072
# A list of binding profiles to be used during port binding. This
# option can be used with the NeutronBindNetworkPlugin. The value for
# this option has to be a comma separated list of names that
# correspond to each binding profile. Each binding profile needs to be
# specified as an individual configuration section using the binding
# profile name as the section name. (list value)
#neutron_binding_profiles = <None>
# Switch ID for binding profile. (string value)
#neutron_switch_id = <None>
# Port ID on the given switch. (string value)
#neutron_port_id = <None>
# Switch label. For example: 'switch_ip: 10.4.30.5'. Multiple key-
# value pairs separated by commas are accepted. (dict value)
#neutron_switch_info = <None>
# Gateway address that should be used. Required. (string value)
#standalone_network_plugin_gateway = <None>
# Network mask that will be used. Can be either decimal like '24' or
# binary like '255.255.255.0'. Required. (string value)
#standalone_network_plugin_mask = <None>
# Network type, such as 'flat', 'vlan', 'vxlan' or 'gre'. Empty value
# is alias for 'flat'. It will be assigned to share-network and share
# drivers will be able to use this for network interfaces within
# provisioned share servers. Optional. (string value)
# Possible values:
# flat - <No description provided>
# vlan - <No description provided>
# vxlan - <No description provided>
# gre - <No description provided>
#standalone_network_plugin_network_type = <None>
# Set it if network has segmentation (VLAN, VXLAN, etc...). It will be
# assigned to share-network and share drivers will be able to use this
# for network interfaces within provisioned share servers. Optional.
# Example: 1001 (integer value)
#standalone_network_plugin_segmentation_id = <None>
# Can be IP address, range of IP addresses or list of addresses or
# ranges. Contains addresses from IP network that are allowed to be
# used. If empty, then will be assumed that all host addresses from
# network can be used. Optional. Examples: 10.0.0.10 or
# 10.0.0.10-10.0.0.20 or
# 10.0.0.10-10.0.0.20,10.0.0.30-10.0.0.40,10.0.0.50 (list value)
#standalone_network_plugin_allowed_ip_ranges = <None>
# DEPRECATED: IP version of network. Optional.Allowed values are '4'
# and '6'. Default value is '4'. Note: This option is no longer used
# and has no effect (integer value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: This option has been replaced by
# 'network_plugin_ipv4_enabled' and 'network_plugin_ipv6_enabled'
# options.
#standalone_network_plugin_ip_version = 4
# Maximum Transmission Unit (MTU) value of the network. Default value
# is 1500. (integer value)
#standalone_network_plugin_mtu = 1500
# Number of shares allowed per project. (integer value)
#quota_shares = 50
# Number of share snapshots allowed per project. (integer value)
#quota_snapshots = 50
# Number of share gigabytes allowed per project. (integer value)
#quota_gigabytes = 1000
# Number of snapshot gigabytes allowed per project. (integer value)
#quota_snapshot_gigabytes = 1000
# Number of share-networks allowed per project. (integer value)
#quota_share_networks = 10
# Number of share groups allowed. (integer value)
#quota_share_groups = 50
# Number of share group snapshots allowed. (integer value)
#quota_share_group_snapshots = 50
# Number of seconds until a reservation expires. (integer value)
#reservation_expire = 86400
# Count of reservations until usage is refreshed. (integer value)
#until_refresh = 0
# Number of seconds between subsequent usage refreshes. (integer
# value)
#max_age = 0
# Default driver to use for quota checks. (string value)
#quota_driver = manila.quota.DbQuotaDriver
# The scheduler host manager class to use. (string value)
#scheduler_host_manager = manila.scheduler.host_manager.HostManager
# Maximum number of attempts to schedule a share. (integer value)
#scheduler_max_attempts = 3
# Which filter class names to use for filtering hosts when not
# specified in the request. (list value)
#scheduler_default_filters = AvailabilityZoneFilter,CapacityFilter,CapabilitiesFilter,DriverFilter,ShareReplicationFilter
# Which weigher class names to use for weighing hosts. (list value)
#scheduler_default_weighers = CapacityWeigher,GoodnessWeigher
# Which filter class names to use for filtering hosts creating share
# group when not specified in the request. (list value)
#scheduler_default_share_group_filters = AvailabilityZoneFilter,ConsistentSnapshotFilter
# Default scheduler driver to use. (string value)
#scheduler_driver = manila.scheduler.drivers.filter.FilterScheduler
# Absolute path to scheduler configuration JSON file. (string value)
#scheduler_json_config_location =
# Maximum number of volume gigabytes to allow per host. (integer
# value)
#max_gigabytes = 10000
# Multiplier used for weighing share capacity. Negative numbers mean
# to stack vs spread. (floating point value)
#capacity_weight_multiplier = 1.0
# Multiplier used for weighing pools which have existing share
# servers. Negative numbers mean to spread vs stack. (floating point
# value)
#pool_weight_multiplier = 1.0
# Seconds between nodes reporting state to datastore. (integer value)
#report_interval = 10
# Seconds between running periodic tasks. (integer value)
#periodic_interval = 60
# Range of seconds to randomly delay when starting the periodic task
# scheduler to reduce stampeding. (Disable by setting to 0) (integer
# value)
#periodic_fuzzy_delay = 60
# IP address for OpenStack Share API to listen on. (unknown value)
#osapi_share_listen = ::
# Port for OpenStack Share API to listen on. (port value)
# Minimum value: 0
# Maximum value: 65535
#osapi_share_listen_port = 8786
# Number of workers for OpenStack Share API service. (integer value)
#osapi_share_workers = 1
# Wraps the socket in a SSL context if True is set. A certificate file
# and key file must be specified. (boolean value)
#osapi_share_use_ssl = false
# 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.
# (boolean value)
#use_scheduler_creating_share_from_snapshot = false
# Directory where Ganesha config files are stored. (string value)
#ganesha_config_dir = /etc/ganesha
# Path to main Ganesha config file. (string value)
#ganesha_config_path = $ganesha_config_dir/ganesha.conf
# Name of the ganesha nfs service. (string value)
#ganesha_service_name = ganesha.nfsd
# Location of Ganesha database file. (Ganesha module only.) (string
# value)
#ganesha_db_path = $state_path/manila-ganesha.db
# Path to directory containing Ganesha export configuration. (Ganesha
# module only.) (string value)
#ganesha_export_dir = $ganesha_config_dir/export.d
# Path to directory containing Ganesha export block templates.
# (Ganesha module only.) (string value)
#ganesha_export_template_dir = /etc/manila/ganesha-export-templ.d
# Persist Ganesha exports and export counter in Ceph RADOS objects,
# highly available storage. (boolean value)
#ganesha_rados_store_enable = false
# Name of the Ceph RADOS pool to store Ganesha exports and export
# counter. (string value)
#ganesha_rados_store_pool_name = <None>
# Name of the Ceph RADOS object used as the Ganesha export counter.
# (string value)
#ganesha_rados_export_counter = ganesha-export-counter
# Name of the Ceph RADOS object used to store a list of the export
# RADOS object URLS. (string value)
#ganesha_rados_export_index = ganesha-export-index
# Number of times to attempt to run flakey shell commands. (integer
# value)
#num_shell_tries = 3
# The percentage of backend capacity reserved. (integer value)
#reserved_share_percentage = 0
# The backend name for a given driver implementation. (string value)
#share_backend_name = <None>
# 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. (string
# value)
#network_config_group = <None>
# 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. (boolean
# value)
#driver_handles_share_servers = <None>
# 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. (floating point value)
#max_over_subscription_ratio = 20.0
# List of files and folders to be ignored when migrating shares. Items
# should be names (not including any path). (list value)
#migration_ignore_files = lost+found
# 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. (string value)
#share_mount_template = mount -vt %(proto)s %(options)s %(export)s %(path)s
# 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. (string value)
#share_unmount_template = umount -v %(path)s
# Protocol access mapping for this backend. Should be a dictionary
# comprised of {'access_type1': ['share_proto1', 'share_proto2'],
# 'access_type2': ['share_proto2', 'share_proto3']}. (dict value)
#protocol_access_mapping = ip:['nfs'],user:['cifs']
# DEPRECATED: Specify whether read only access rule mode is supported
# in this backend. Obsolete. (boolean value)
# Deprecated group/name - [DEFAULT]/migration_readonly_support
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: All drivers are now required to support read-only access
# rules.
#migration_readonly_rules_support = true
# 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'. (string value)
#admin_network_config_group = <None>
# 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. (string value)
#replication_domain = <None>
# String representation for an equation that will be used to filter
# hosts. (string value)
#filter_function = <None>
# String representation for an equation that will be used to determine
# the goodness of a host. (string value)
#goodness_function = <None>
# Backend server SSH connection timeout. (integer value)
#ssh_conn_timeout = 60
# Minimum number of connections in the SSH pool. (integer value)
#ssh_min_pool_conn = 1
# Maximum number of connections in the SSH pool. (integer value)
#ssh_max_pool_conn = 10
# The full class name of the Private Data Driver class to use. (string
# value)
#drivers_private_storage_class = manila.share.drivers_private_data.SqlStorageDriver
# Fully qualified path to the ceph.conf file. (string value)
#cephfs_conf_path =
# The name of the cluster in use, if it is not the default ('ceph').
# (string value)
#cephfs_cluster_name = <None>
# The name of the ceph auth identity to use. (string value)
#cephfs_auth_id = manila
# Whether to enable snapshots in this driver. (boolean value)
#cephfs_enable_snapshots = false
# The type of protocol helper to use. Default is CEPHFS. (string
# value)
# Possible values:
# CEPHFS - <No description provided>
# NFS - <No description provided>
#cephfs_protocol_helper_type = CEPHFS
# Whether the NFS-Ganesha server is remote to the driver. (boolean
# value)
#cephfs_ganesha_server_is_remote = false
# The IP address of the NFS-Ganesha server. (string value)
#cephfs_ganesha_server_ip = <None>
# The username to authenticate as in the remote NFS-Ganesha server
# host. (string value)
#cephfs_ganesha_server_username = root
# The path of the driver host's private SSH key file. (string value)
#cephfs_ganesha_path_to_private_key = <None>
# The password to authenticate as the user in the remote Ganesha
# server host. This is not required if
# 'cephfs_ganesha_path_to_private_key' is configured. (string value)
#cephfs_ganesha_server_password = <None>
# The read/write/execute permissions mode for CephFS volumes,
# snapshots, and snapshot groups expressed in Octal as with linux
# 'chmod' or 'umask' commands. (string value)
#cephfs_volume_mode = 755
# Linux bridge used by container hypervisor to plug host-side veth to.
# It will be unplugged from here by the driver. (string value)
#container_linux_bridge_name = docker0
# OVS bridge to use to plug a container to. (string value)
#container_ovs_bridge_name = br-int
# Determines whether to allow guest access to CIFS share or not.
# (boolean value)
#container_cifs_guest_ok = true
# Image to be used for a container-based share server. (string value)
#container_image_name = manila-docker-container
# Container helper which provides container-related operations to the
# driver. (string value)
#container_helper = manila.share.drivers.container.container_helper.DockerExecHelper
# Helper which facilitates interaction with share server. (string
# value)
#container_protocol_helper = manila.share.drivers.container.protocol_helper.DockerCIFSHelper
# Helper which facilitates interaction with storage solution used to
# actually store data. By default LVM is used to provide storage for a
# share. (string value)
#container_storage_helper = manila.share.drivers.container.storage_helper.LVMHelper
# LVM volume group to use for volumes. This volume group must be
# created by the cloud administrator independently from manila
# operations. (string value)
#container_volume_group = manila_docker_volumes
# User name for the EMC server. (string value)
#emc_nas_login = <None>
# Password for the EMC server. (string value)
#emc_nas_password = <None>
# EMC server hostname or IP address. (unknown value)
#emc_nas_server = <None>
# Port number for the EMC server. (port value)
# Minimum value: 0
# Maximum value: 65535
#emc_nas_server_port = 8080
# Use secure connection to server. (boolean value)
#emc_nas_server_secure = true
# Share backend. (string value)
# Possible values:
# isilon - <No description provided>
# vnx - <No description provided>
# unity - <No description provided>
# vmax - <No description provided>
#emc_share_backend = <None>
# The root directory where shares will be located. (string value)
#emc_nas_root_dir = <None>
# If set to False the https client will not validate the SSL
# certificate of the backend endpoint. (boolean value)
#emc_ssl_cert_verify = true
# Can be used to specify a non default path to a CA_BUNDLE file or
# directory with certificates of trusted CAs, which will be used to
# validate the backend. (string value)
#emc_ssl_cert_path = <None>
# Data mover to host the NAS server. (string value)
# Deprecated group/name - [DEFAULT]/emc_nas_server_container
#vmax_server_container = <None>
# Comma separated list of pools that can be used to persist share
# data. (list value)
# Deprecated group/name - [DEFAULT]/emc_nas_pool_names
#vmax_share_data_pools = <None>
# Comma separated list of ports that can be used for share server
# interfaces. Members of the list can be Unix-style glob expressions.
# (list value)
# Deprecated group/name - [DEFAULT]/emc_interface_ports
#vmax_ethernet_ports = <None>
# Path to smb config. (string value)
#smb_template_config_path = $state_path/smb.conf
# Volume name template. (string value)
#volume_name_template = manila-share-%s
# Volume snapshot name template. (string value)
#volume_snapshot_name_template = manila-snapshot-%s
# Parent path in service instance where shares will be mounted.
# (string value)
#share_mount_path = /shares
# Maximum time to wait for creating cinder volume. (integer value)
#max_time_to_create_volume = 180
# Maximum time to wait for extending cinder volume. (integer value)
#max_time_to_extend_volume = 180
# Maximum time to wait for attaching cinder volume. (integer value)
#max_time_to_attach = 120
# Path to SMB config in service instance. (string value)
#service_instance_smb_config_path = $share_mount_path/smb.conf
# Specify list of share export helpers. (list value)
#share_helpers = CIFS=manila.share.drivers.helpers.CIFSHelperIPAccess,NFS=manila.share.drivers.helpers.NFSHelper
# Filesystem type of the share volume. (string value)
# Possible values:
# ext4 - <No description provided>
# ext3 - <No description provided>
#share_volume_fstype = ext4
# Name or id of cinder volume type which will be used for all volumes
# created by driver. (string value)
#cinder_volume_type = <None>
# Remote GlusterFS server node's login password. This is not required
# if 'glusterfs_path_to_private_key' is configured. (string value)
# Deprecated group/name - [DEFAULT]/glusterfs_native_server_password
#glusterfs_server_password = <None>
# Path of Manila host's private SSH key file. (string value)
# Deprecated group/name - [DEFAULT]/glusterfs_native_path_to_private_key
#glusterfs_path_to_private_key = <None>
# Type of NFS server that mediate access to the Gluster volumes
# (Gluster or Ganesha). (string value)
#glusterfs_nfs_server_type = Gluster
# Remote Ganesha server node's IP address. (unknown value)
#glusterfs_ganesha_server_ip = <None>
# Remote Ganesha server node's username. (string value)
#glusterfs_ganesha_server_username = root
# Remote Ganesha server node's login password. This is not required if
# 'glusterfs_path_to_private_key' is configured. (string value)
#glusterfs_ganesha_server_password = <None>
# Specifies GlusterFS share layout, that is, the method of associating
# backing GlusterFS resources to shares. (string value)
#glusterfs_share_layout = <None>
# Specifies the GlusterFS volume to be mounted on the Manila host. It
# is of the form [remoteuser@]<volserver>:<volid>. (string value)
#glusterfs_target = <None>
# Base directory containing mount points for Gluster volumes. (string
# value)
#glusterfs_mount_point_base = $state_path/mnt
# 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. (list
# value)
# Deprecated group/name - [DEFAULT]/glusterfs_targets
#glusterfs_servers =
# 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. (string value)
#glusterfs_volume_pattern = <None>
# The IP of the HDFS namenode. (unknown value)
#hdfs_namenode_ip = <None>
# The port of HDFS namenode service. (port value)
# Minimum value: 0
# Maximum value: 65535
#hdfs_namenode_port = 9000
# HDFS namenode SSH port. (port value)
# Minimum value: 0
# Maximum value: 65535
#hdfs_ssh_port = 22
# HDFS namenode ssh login name. (string value)
#hdfs_ssh_name = <None>
# HDFS namenode SSH login password, This parameter is not necessary,
# if 'hdfs_ssh_private_key' is configured. (string value)
#hdfs_ssh_pw = <None>
# Path to HDFS namenode SSH private key for login. (string value)
#hdfs_ssh_private_key = <None>
# HNAS management interface IP for communication between Manila
# controller and HNAS. (unknown value)
# Deprecated group/name - [DEFAULT]/hds_hnas_ip
#hitachi_hnas_ip = <None>
# HNAS username Base64 String in order to perform tasks such as create
# file-systems and network interfaces. (string value)
# Deprecated group/name - [DEFAULT]/hds_hnas_user
#hitachi_hnas_user = <None>
# HNAS user password. Required only if private key is not provided.
# (string value)
# Deprecated group/name - [DEFAULT]/hds_hnas_password
#hitachi_hnas_password = <None>
# Specify which EVS this backend is assigned to. (integer value)
# Deprecated group/name - [DEFAULT]/hds_hnas_evs_id
#hitachi_hnas_evs_id = <None>
# Specify IP for mounting shares. (unknown value)
# Deprecated group/name - [DEFAULT]/hds_hnas_evs_ip
#hitachi_hnas_evs_ip = <None>
# Specify IP for mounting shares in the Admin network. (unknown value)
#hitachi_hnas_admin_network_ip = <None>
# Specify file-system name for creating shares. (string value)
# Deprecated group/name - [DEFAULT]/hds_hnas_file_system_name
#hitachi_hnas_file_system_name = <None>
# RSA/DSA private key value used to connect into HNAS. Required only
# if password is not provided. (string value)
# Deprecated group/name - [DEFAULT]/hds_hnas_ssh_private_key
#hitachi_hnas_ssh_private_key = <None>
# The IP of the clusters admin node. Only set in HNAS multinode
# clusters. (unknown value)
# Deprecated group/name - [DEFAULT]/hds_hnas_cluster_admin_ip0
#hitachi_hnas_cluster_admin_ip0 = <None>
# The time (in seconds) to wait for stalled HNAS jobs before aborting.
# (integer value)
# Deprecated group/name - [DEFAULT]/hds_hnas_stalled_job_timeout
#hitachi_hnas_stalled_job_timeout = 30
# Python class to be used for driver helper. (string value)
# Deprecated group/name - [DEFAULT]/hds_hnas_driver_helper
#hitachi_hnas_driver_helper = manila.share.drivers.hitachi.hnas.ssh.HNASSSHBackend
# By default, CIFS snapshots are not allowed to be taken when the
# share has clients connected because consistent point-in-time replica
# cannot be guaranteed for all files. Enabling this might cause
# inconsistent snapshots on CIFS shares. (boolean value)
# Deprecated group/name - [DEFAULT]/hds_hnas_allow_cifs_snapshot_while_mounted
#hitachi_hnas_allow_cifs_snapshot_while_mounted = false
# HSP management host for communication between Manila controller and
# HSP. (unknown value)
#hitachi_hsp_host = <None>
# HSP username to perform tasks such as create filesystems and shares.
# (string value)
#hitachi_hsp_username = <None>
# HSP password for the username provided. (string value)
#hitachi_hsp_password = <None>
# 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1 (string
# value)
# Deprecated group/name - [DEFAULT]/hp3par_api_url
#hpe3par_api_url =
# 3PAR username with the 'edit' role (string value)
# Deprecated group/name - [DEFAULT]/hp3par_username
#hpe3par_username =
# 3PAR password for the user specified in hpe3par_username (string
# value)
# Deprecated group/name - [DEFAULT]/hp3par_password
#hpe3par_password =
# IP address of SAN controller (unknown value)
# Deprecated group/name - [DEFAULT]/hp3par_san_ip
#hpe3par_san_ip = <None>
# Username for SAN controller (string value)
# Deprecated group/name - [DEFAULT]/hp3par_san_login
#hpe3par_san_login =
# Password for SAN controller (string value)
# Deprecated group/name - [DEFAULT]/hp3par_san_password
#hpe3par_san_password =
# SSH port to use with SAN (port value)
# Minimum value: 0
# Maximum value: 65535
# Deprecated group/name - [DEFAULT]/hp3par_san_ssh_port
#hpe3par_san_ssh_port = 22
# The File Provisioning Group (FPG) to use (FPG)
# Deprecated group/name - [DEFAULT]/hp3par_fpg
#hpe3par_fpg = <None>
# Use one filestore per share (boolean value)
# Deprecated group/name - [DEFAULT]/hp3par_fstore_per_share
#hpe3par_fstore_per_share = false
# Require IP access rules for CIFS (in addition to user) (boolean
# value)
#hpe3par_require_cifs_ip = false
# Enable HTTP debugging to 3PAR (boolean value)
# Deprecated group/name - [DEFAULT]/hp3par_debug
#hpe3par_debug = false
# File system admin user name for CIFS. (string value)
# Deprecated group/name - [DEFAULT]/hp3par_cifs_admin_access_username
#hpe3par_cifs_admin_access_username =
# File system admin password for CIFS. (string value)
# Deprecated group/name - [DEFAULT]/hp3par_cifs_admin_access_password
#hpe3par_cifs_admin_access_password =
# File system domain for the CIFS admin user. (string value)
# Deprecated group/name - [DEFAULT]/hp3par_cifs_admin_access_domain
#hpe3par_cifs_admin_access_domain = LOCAL_CLUSTER
# The path where shares will be mounted when deleting nested file
# trees. (string value)
# Deprecated group/name - [DEFAULT]/hpe3par_share_mount_path
#hpe3par_share_mount_path = /mnt/
# The configuration file for the Manila Huawei driver. (string value)
#manila_huawei_conf_file = /etc/manila/manila_huawei_conf.xml
# IP to be added to GPFS export string. (unknown value)
#gpfs_share_export_ip = <None>
# Base folder where exported shares are located. (string value)
#gpfs_mount_point_base = $state_path/mnt
# NFS Server type. Valid choices are "CES" (Ganesha NFS) or "KNFS"
# (Kernel NFS). (string value)
#gpfs_nfs_server_type = CES
# A list of the fully qualified NFS server names that make up the
# OpenStack Manila configuration. (list value)
#gpfs_nfs_server_list = <None>
# 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. (boolean value)
#is_gpfs_node = false
# GPFS server SSH port. (port value)
# Minimum value: 0
# Maximum value: 65535
#gpfs_ssh_port = 22
# GPFS server SSH login name. (string value)
#gpfs_ssh_login = <None>
# GPFS server SSH login password. The password is not needed, if
# 'gpfs_ssh_private_key' is configured. (string value)
#gpfs_ssh_password = <None>
# Path to GPFS server SSH private key for login. (string value)
#gpfs_ssh_private_key = <None>
# Specify list of share export helpers. (list value)
#gpfs_share_helpers = KNFS=manila.share.drivers.ibm.gpfs.KNFSHelper,CES=manila.share.drivers.ibm.gpfs.CESHelper
# 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. (string
# value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: This option isn't used any longer. Please use share-type
# extra specs for export options.
#knfs_export_options = rw,sync,no_root_squash,insecure,no_wdelay,no_subtree_check
# Administrative user account name used to access the INFINIDAT
# Infinibox storage system. (string value)
#infinibox_login = <None>
# Password for the administrative user account specified in the
# infinibox_login option. (string value)
#infinibox_password = <None>
# The name (or IP address) for the INFINIDAT Infinibox storage system.
# (unknown value)
#infinibox_hostname = <None>
# Name of the pool from which volumes are allocated. (string value)
#infinidat_pool_name = <None>
# Name of the NAS network space on the INFINIDAT InfiniBox. (string
# value)
#infinidat_nas_network_space_name = <None>
# Use thin provisioning. (boolean value)
#infinidat_thin_provision = true
# The list of IPs or hostnames of nodes where mapr-core is installed.
# (list value)
#maprfs_clinode_ip = <None>
# CLDB node SSH port. (port value)
# Minimum value: 0
# Maximum value: 65535
#maprfs_ssh_port = 22
# Cluster admin user ssh login name. (string value)
#maprfs_ssh_name = mapr
# Cluster node SSH login password, This parameter is not necessary, if
# 'maprfs_ssh_private_key' is configured. (string value)
#maprfs_ssh_pw = <None>
# Path to SSH private key for login. (string value)
#maprfs_ssh_private_key = <None>
# Path in MapRFS where share volumes must be created. (string value)
#maprfs_base_volume_dir = /
# The list of IPs or hostnames of ZooKeeper nodes. (list value)
#maprfs_zookeeper_ip = <None>
# The list of IPs or hostnames of CLDB nodes. (list value)
#maprfs_cldb_ip = <None>
# Specify whether existing volume should be renamed when start
# managing. (boolean value)
#maprfs_rename_managed_volume = true
# Base folder where exported shares are located. (string value)
#lvm_share_export_root = $state_path/mnt
# DEPRECATED: IP to be added to export string. (string value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Use lvm_share_export_ips instead.
#lvm_share_export_ip = <None>
# List of IPs to export shares. (list value)
#lvm_share_export_ips = <None>
# If set, create LVMs with multiple mirrors. Note that this requires
# lvm_mirrors + 2 PVs with available space. (integer value)
#lvm_share_mirrors = 0
# Name for the VG that will contain exported shares. (string value)
#lvm_share_volume_group = lvm-shares
# Specify list of share export helpers. (list value)
#lvm_share_helpers = CIFS=manila.share.drivers.helpers.CIFSHelperUserAccess,NFS=manila.share.drivers.helpers.NFSHelper
# The storage family type used on the storage system; valid values
# include ontap_cluster for using clustered Data ONTAP. (string value)
#netapp_storage_family = ontap_cluster
# The hostname (or IP address) for the storage system. (unknown value)
# Deprecated group/name - [DEFAULT]/netapp_nas_server_hostname
#netapp_server_hostname = <None>
# 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. (port value)
# Minimum value: 0
# Maximum value: 65535
#netapp_server_port = <None>
# The transport protocol used when communicating with the storage
# system or proxy server. Valid values are http or https. (string
# value)
# Deprecated group/name - [DEFAULT]/netapp_nas_transport_type
#netapp_transport_type = http
# Administrative user account name used to access the storage system.
# (string value)
# Deprecated group/name - [DEFAULT]/netapp_nas_login
#netapp_login = <None>
# Password for the administrative user account specified in the
# netapp_login option. (string value)
# Deprecated group/name - [DEFAULT]/netapp_nas_password
#netapp_password = <None>
# 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. (list value)
#netapp_enabled_share_protocols = nfs3,nfs4.0
# NetApp volume name template. (string value)
# Deprecated group/name - [DEFAULT]/netapp_nas_volume_name_template
#netapp_volume_name_template = share_%(share_id)s
# Name template to use for new Vserver. (string value)
#netapp_vserver_name_template = os_%s
# NetApp QoS policy group name template. (string value)
#netapp_qos_policy_group_name_template = qos_share_%(share_id)s
# Pattern for overriding the selection of network ports on which to
# create Vserver LIFs. (string value)
#netapp_port_name_search_pattern = (.*)
# Logical interface (LIF) name template (string value)
#netapp_lif_name_template = os_%(net_allocation_id)s
# Pattern for searching available aggregates for provisioning. (string
# value)
#netapp_aggregate_name_search_pattern = (.*)
# Name of aggregate to create Vserver root volumes on. This option
# only applies when the option driver_handles_share_servers is set to
# True. (string value)
#netapp_root_volume_aggregate = <None>
# Root volume name. (string value)
# Deprecated group/name - [DEFAULT]/netapp_root_volume_name
#netapp_root_volume = root
# The percentage of share space set aside as reserve for snapshot
# usage; valid values range from 0 to 90. (integer value)
# Minimum value: 0
# Maximum value: 90
#netapp_volume_snapshot_reserve_percent = 5
# The maximum time in seconds to wait for existing snapmirror
# transfers to complete before aborting when promoting a replica.
# (integer value)
# Minimum value: 0
#netapp_snapmirror_quiesce_timeout = 3600
# The maximum time in seconds to wait for the completion of a volume
# move operation after the cutover was triggered. (integer value)
# Minimum value: 0
#netapp_volume_move_cutover_timeout = 3600
# The maximum time in seconds that migration cancel waits for all
# migration operations be completely aborted. (integer value)
# Minimum value: 0
#netapp_migration_cancel_timeout = 3600
# IP address of Nexenta storage appliance. (unknown value)
#nexenta_host = <None>
# Port to connect to Nexenta REST API server. (integer value)
#nexenta_rest_port = 8457
# Number of retries for unsuccessful API calls. (integer value)
#nexenta_retry_count = 6
# Use http or https for REST connection (default auto). (string value)
# Possible values:
# http - <No description provided>
# https - <No description provided>
# auto - <No description provided>
#nexenta_rest_protocol = auto
# User name to connect to Nexenta SA. (string value)
#nexenta_user = admin
# Password to connect to Nexenta SA. (string value)
#nexenta_password = <None>
# Volume name on NexentaStor. (string value)
#nexenta_volume = volume1
# Pool name on NexentaStor. (string value)
#nexenta_pool = pool1
# On if share over NFS is enabled. (boolean value)
#nexenta_nfs = true
# Parent folder on NexentaStor. (string value)
#nexenta_nfs_share = nfs_share
# Compression value for new ZFS folders. (string value)
# Possible values:
# on - <No description provided>
# off - <No description provided>
# gzip - <No description provided>
# gzip-1 - <No description provided>
# gzip-2 - <No description provided>
# gzip-3 - <No description provided>
# gzip-4 - <No description provided>
# gzip-5 - <No description provided>
# gzip-6 - <No description provided>
# gzip-7 - <No description provided>
# gzip-8 - <No description provided>
# gzip-9 - <No description provided>
# lzjb - <No description provided>
# zle - <No description provided>
# lz4 - <No description provided>
#nexenta_dataset_compression = on
# Deduplication value for new ZFS folders. (string value)
# Possible values:
# on - <No description provided>
# off - <No description provided>
# sha256 - <No description provided>
# verify - <No description provided>
# sha256, verify - <No description provided>
#nexenta_dataset_dedupe = off
# If True shares will not be space guaranteed and overprovisioning
# will be enabled. (boolean value)
#nexenta_thin_provisioning = true
# Base directory that contains NFS share mount points. (string value)
#nexenta_mount_point_base = $state_path/mnt
# The URL to manage QNAP Storage. (string value)
#qnap_management_url = <None>
# NAS share IP for mounting shares. (unknown value)
#qnap_share_ip = <None>
# Username for QNAP storage. (string value)
#qnap_nas_login = <None>
# Password for QNAP storage. (string value)
#qnap_nas_password = <None>
# Pool within which QNAP shares must be created. (string value)
#qnap_poolname = <None>
# URL of the Quobyte API server (http or https) (string value)
#quobyte_api_url = <None>
# The X.509 CA file to verify the server cert. (string value)
#quobyte_api_ca = <None>
# Actually deletes shares (vs. unexport) (boolean value)
#quobyte_delete_shares = false
# Username for Quobyte API server. (string value)
#quobyte_api_username = admin
# Password for Quobyte API server (string value)
#quobyte_api_password = quobyte
# Name of volume configuration used for new shares. (string value)
#quobyte_volume_configuration = BASE
# Default owning user for new volumes. (string value)
#quobyte_default_volume_user = root
# Default owning group for new volumes. (string value)
#quobyte_default_volume_group = root
# User in service instance that will be used for authentication.
# (string value)
#service_instance_user = <None>
# Password for service instance user. (string value)
#service_instance_password = <None>
# Path to host's private key. (string value)
#path_to_private_key = <None>
# Maximum time in seconds to wait for creating service instance.
# (integer value)
#max_time_to_build_instance = 300
# Name or ID of service instance in Nova to use for share exports.
# Used only when share servers handling is disabled. (string value)
#service_instance_name_or_id = <None>
# Can be either name of network that is used by service instance
# within Nova to get IP address or IP address itself (either IPv4 or
# IPv6) for managing shares there. Used only when share servers
# handling is disabled. (unknown value)
#service_net_name_or_ip = <None>
# Can be either name of network that is used by service instance
# within Nova to get IP address or IP address itself (either IPv4 or
# IPv6) for exporting shares. Used only when share servers handling is
# disabled. (unknown value)
#tenant_net_name_or_ip = <None>
# Name of image in Glance, that will be used for service instance
# creation. Only used if driver_handles_share_servers=True. (string
# value)
#service_image_name = manila-service-image
# Name of service instance. Only used if
# driver_handles_share_servers=True. (string value)
#service_instance_name_template = manila_service_instance_%s
# Keypair name that will be created and used for service instances.
# Only used if driver_handles_share_servers=True. (string value)
#manila_service_keypair_name = manila-service
# Path to hosts public key. Only used if
# driver_handles_share_servers=True. (string value)
#path_to_public_key = ~/.ssh/id_rsa.pub
# Security group name, that will be used for service instance
# creation. Only used if driver_handles_share_servers=True. (string
# value)
#service_instance_security_group = manila-service
# ID of flavor, that will be used for service instance creation. Only
# used if driver_handles_share_servers=True. (integer value)
#service_instance_flavor_id = 100
# Name of manila service network. Used only with Neutron. Only used if
# driver_handles_share_servers=True. (string value)
#service_network_name = manila_service_network
# CIDR of manila service network. Used only with Neutron and if
# driver_handles_share_servers=True. (string value)
#service_network_cidr = 10.254.0.0/16
# 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. (integer value)
#service_network_division_mask = 28
# Vif driver. Used only with Neutron and if
# driver_handles_share_servers=True. (string value)
#interface_driver = manila.network.linux.interface.OVSInterfaceDriver
# Attach share server directly to share network. Used only with
# Neutron and if driver_handles_share_servers=True. (boolean value)
#connect_share_server_to_tenant_network = false
# ID of neutron network used to communicate with admin network, to
# create additional admin export locations on. (string value)
#admin_network_id = <None>
# ID of neutron subnet used to communicate with admin network, to
# create additional admin export locations on. Related to
# 'admin_network_id'. (string value)
#admin_subnet_id = <None>
# Tegile NAS server hostname or IP address. (unknown value)
#tegile_nas_server = <None>
# User name for the Tegile NAS server. (string value)
#tegile_nas_login = <None>
# Password for the Tegile NAS server. (string value)
#tegile_nas_password = <None>
# Create shares in this project (string value)
#tegile_default_project = <None>
# Path to the x509 certificate used for accessing the serviceinstance.
# (string value)
#winrm_cert_pem_path = ~/.ssl/cert.pem
# Path to the x509 certificate key. (string value)
#winrm_cert_key_pem_path = ~/.ssl/key.pem
# Use x509 certificates in order to authenticate to theservice
# instance. (boolean value)
#winrm_use_cert_based_auth = false
# WinRM connection timeout. (integer value)
#winrm_conn_timeout = 60
# WinRM operation timeout. (integer value)
#winrm_operation_timeout = 60
# WinRM retry count. (integer value)
#winrm_retry_count = 3
# WinRM retry interval in seconds (integer value)
#winrm_retry_interval = 5
# IP to be added to user-facing export location. Required. (unknown
# value)
#zfs_share_export_ip = <None>
# IP to be added to admin-facing export location. Required. (unknown
# value)
#zfs_service_ip = <None>
# 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. (list value)
#zfs_zpool_list = <None>
# 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. (list value)
#zfs_dataset_creation_options = <None>
# Prefix to be used in each dataset name. Optional. (string value)
#zfs_dataset_name_prefix = manila_share_
# Prefix to be used in each dataset snapshot name. Optional. (string
# value)
#zfs_dataset_snapshot_name_prefix = manila_share_snapshot_
# Remote ZFS storage hostname that should be used for SSH'ing.
# Optional. (boolean value)
#zfs_use_ssh = false
# 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.
# (string value)
#zfs_ssh_username = <None>
# Password for user that is used for SSH'ing ZFS storage host. Not
# used for replication operations. They require passwordless SSH
# access. Optional. (string value)
#zfs_ssh_user_password = <None>
# Path to SSH private key that should be used for SSH'ing ZFS storage
# host. Not used for replication operations. Optional. (string value)
#zfs_ssh_private_key_path = <None>
# Specify list of share export helpers for ZFS storage. It should look
# like following:
# 'FOO_protocol=foo.FooClass,BAR_protocol=bar.BarClass'. Required.
# (list value)
#zfs_share_helpers = NFS=manila.share.drivers.zfsonlinux.utils.NFSviaZFSHelper
# Set snapshot prefix for usage in ZFS replication. Required. (string
# value)
#zfs_replica_snapshot_prefix = tmp_snapshot_for_replication_
# Set snapshot prefix for usage in ZFS migration. Required. (string
# value)
#zfs_migration_snapshot_prefix = tmp_snapshot_for_share_migration_
# ZFSSA management IP address. (unknown value)
#zfssa_host = <None>
# IP address for data. (unknown value)
#zfssa_data_ip = <None>
# ZFSSA management authorized username. (string value)
#zfssa_auth_user = <None>
# ZFSSA management authorized userpassword. (string value)
#zfssa_auth_password = <None>
# ZFSSA storage pool name. (string value)
#zfssa_pool = <None>
# ZFSSA project name. (string value)
#zfssa_project = <None>
# Controls checksum used for data blocks. (string value)
#zfssa_nas_checksum = fletcher4
# Data compression-off, lzjb, gzip-2, gzip, gzip-9. (string value)
#zfssa_nas_compression = off
# Controls behavior when servicing synchronous writes. (string value)
#zfssa_nas_logbias = latency
# Location of project in ZFS/SA. (string value)
#zfssa_nas_mountpoint =
# Controls whether a share quota includes snapshot. (string value)
#zfssa_nas_quota_snap = true
# Controls whether file ownership can be changed. (string value)
#zfssa_nas_rstchown = true
# Controls whether the share is scanned for viruses. (string value)
#zfssa_nas_vscan = false
# REST connection timeout (in seconds). (string value)
#zfssa_rest_timeout = <None>
# 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. (string value)
# Possible values:
# loose - <No description provided>
# strict - <No description provided>
#zfssa_manage_policy = loose
# Whether to enable pre hooks or not. (boolean value)
#enable_pre_hooks = false
# Whether to enable post hooks or not. (boolean value)
#enable_post_hooks = false
# Whether to enable periodic hooks or not. (boolean value)
#enable_periodic_hooks = false
# Whether to suppress pre hook errors (allow driver perform actions)
# or not. (boolean value)
#suppress_pre_hooks_errors = false
# Whether to suppress post hook errors (allow driver's results to pass
# through) or not. (boolean value)
#suppress_post_hooks_errors = false
# Interval in seconds between execution of periodic hooks. Used when
# option 'enable_periodic_hooks' is set to True. Default is 300.
# (floating point value)
#periodic_hooks_interval = 300.0
# Driver to use for share creation. (string value)
#share_driver = manila.share.drivers.generic.GenericShareDriver
# Driver(s) to perform some additional actions before and after share
# driver actions and on a periodic basis. Default is []. (list value)
#hook_drivers =
# Whether share servers will be deleted on deletion of the last share.
# (boolean value)
#delete_share_server_with_last_share = false
# 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.
# (boolean value)
#unmanage_remove_access_rules = false
# 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. (boolean value)
#automatic_share_server_cleanup = true
# 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. (integer value)
# Minimum value: 10
# Maximum value: 60
#unused_share_server_cleanup_interval = 10
# This value, specified in seconds, determines how often the share
# manager will poll for the health (replica_state) of each replica
# instance. (integer value)
#replica_state_update_interval = 300
# This value, specified in seconds, determines how often the share
# manager will poll the driver to perform the next step of migration
# in the storage backend, for a migrating share. (integer value)
#migration_driver_continue_update_interval = 60
# This value, specified in seconds, determines how often the share
# manager will poll the driver to update the share usage size in the
# storage backend, for shares in that backend. (integer value)
#share_usage_size_update_interval = 300
# If set to True, share usage size will be polled for in the interval
# specified with "share_usage_size_update_interval". Usage data can be
# consumed by telemetry integration. If telemetry is not configured,
# this option must be set to False. If set to False - gathering share
# usage size will be disabled. (boolean value)
#enable_gathering_share_usage_size = false
# The full class name of the Volume API class to use. (string value)
#volume_api_class = manila.volume.cinder.API
# Sets the value of TCP_KEEPALIVE (True/False) for each server socket.
# (boolean value)
#tcp_keepalive = true
# Sets the value of TCP_KEEPINTVL in seconds for each server socket.
# Not supported on OS X. (integer value)
#tcp_keepalive_interval = <None>
# Sets the value of TCP_KEEPCNT for each server socket. Not supported
# on OS X. (integer value)
#tcp_keepalive_count = <None>
# If set to true, the logging level will be set to DEBUG instead of
# the default INFO level. (boolean value)
# Note: This option can be changed without restarting.
#debug = false
# 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). (string value)
# Note: This option can be changed without restarting.
# Deprecated group/name - [DEFAULT]/log_config
#log_config_append = <None>
# Defines the format string for %%(asctime)s in log records. Default:
# %(default)s . This option is ignored if log_config_append is set.
# (string value)
#log_date_format = %Y-%m-%d %H:%M:%S
# (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. (string value)
# Deprecated group/name - [DEFAULT]/logfile
#log_file = <None>
# (Optional) The base directory used for relative log_file paths.
# This option is ignored if log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logdir
#log_dir = <None>
# 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. (boolean value)
#watch_log_file = false
# 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. (boolean value)
#use_syslog = false
# Enable journald for logging. If running in a systemd environment you
# may wish to enable journal support. Doing so will use the journal
# native protocol which includes structured metadata in addition to
# log messages.This option is ignored if log_config_append is set.
# (boolean value)
#use_journal = false
# Syslog facility to receive log lines. This option is ignored if
# log_config_append is set. (string value)
#syslog_log_facility = LOG_USER
# Use JSON formatting for logging. This option is ignored if
# log_config_append is set. (boolean value)
#use_json = false
# Log output to standard error. This option is ignored if
# log_config_append is set. (boolean value)
#use_stderr = false
# Format string to use for log messages with context. (string value)
#logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s
# Format string to use for log messages when context is undefined.
# (string value)
#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s
# Additional data to append to log message when logging level for the
# message is DEBUG. (string value)
#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d
# Prefix each line of exception output with this format. (string
# value)
#logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s
# Defines the format string for %(user_identity)s that is used in
# logging_context_format_string. (string value)
#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s
# List of package logging levels in logger=LEVEL pairs. This option is
# ignored if log_config_append is set. (list value)
#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=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
# Enables or disables publication of error events. (boolean value)
#publish_errors = false
# The format for an instance that is passed with the log message.
# (string value)
#instance_format = "[instance: %(uuid)s] "
# The format for an instance UUID that is passed with the log message.
# (string value)
#instance_uuid_format = "[instance: %(uuid)s] "
# Interval, number of seconds, of log rate limiting. (integer value)
#rate_limit_interval = 0
# Maximum number of logged messages per rate_limit_interval. (integer
# value)
#rate_limit_burst = 0
# Log level name used by rate limiting: CRITICAL, ERROR, INFO,
# WARNING, DEBUG or empty string. Logs with level greater or equal to
# rate_limit_except_level are not filtered. An empty string means that
# all levels are filtered. (string value)
#rate_limit_except_level = CRITICAL
# Enables or disables fatal status of deprecations. (boolean value)
#fatal_deprecations = false
#
# From oslo.messaging
#
# Size of RPC connection pool. (integer value)
#rpc_conn_pool_size = 30
# The pool size limit for connections expiration policy (integer
# value)
#conn_pool_min_size = 2
# The time-to-live in sec of idle connections in the pool (integer
# value)
#conn_pool_ttl = 1200
# ZeroMQ bind address. Should be a wildcard (*), an ethernet
# interface, or IP. The "host" option should point or resolve to this
# address. (string value)
#rpc_zmq_bind_address = *
# MatchMaker driver. (string value)
# Possible values:
# redis - <No description provided>
# sentinel - <No description provided>
# dummy - <No description provided>
#rpc_zmq_matchmaker = redis
# Number of ZeroMQ contexts, defaults to 1. (integer value)
#rpc_zmq_contexts = 1
# Maximum number of ingress messages to locally buffer per topic.
# Default is unlimited. (integer value)
#rpc_zmq_topic_backlog = <None>
# Directory for holding IPC sockets. (string value)
#rpc_zmq_ipc_dir = /var/run/openstack
# Name of this node. Must be a valid hostname, FQDN, or IP address.
# Must match "host" option, if running Nova. (string value)
#rpc_zmq_host = localhost
# Number of seconds to wait before all pending messages will be sent
# after closing a socket. The default value of -1 specifies an
# infinite linger period. The value of 0 specifies no linger period.
# Pending messages shall be discarded immediately when the socket is
# closed. Positive values specify an upper bound for the linger
# period. (integer value)
# Deprecated group/name - [DEFAULT]/rpc_cast_timeout
#zmq_linger = -1
# The default number of seconds that poll should wait. Poll raises
# timeout exception when timeout expired. (integer value)
#rpc_poll_timeout = 1
# Expiration timeout in seconds of a name service record about
# existing target ( < 0 means no timeout). (integer value)
#zmq_target_expire = 300
# Update period in seconds of a name service record about existing
# target. (integer value)
#zmq_target_update = 180
# Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
# (boolean value)
#use_pub_sub = false
# Use ROUTER remote proxy. (boolean value)
#use_router_proxy = false
# This option makes direct connections dynamic or static. It makes
# sense only with use_router_proxy=False which means to use direct
# connections for direct message types (ignored otherwise). (boolean
# value)
#use_dynamic_connections = false
# How many additional connections to a host will be made for failover
# reasons. This option is actual only in dynamic connections mode.
# (integer value)
#zmq_failover_connections = 2
# Minimal port number for random ports range. (port value)
# Minimum value: 0
# Maximum value: 65535
#rpc_zmq_min_port = 49153
# Maximal port number for random ports range. (integer value)
# Minimum value: 1
# Maximum value: 65536
#rpc_zmq_max_port = 65536
# Number of retries to find free port number before fail with
# ZMQBindError. (integer value)
#rpc_zmq_bind_port_retries = 100
# Default serialization mechanism for serializing/deserializing
# outgoing/incoming messages (string value)
# Possible values:
# json - <No description provided>
# msgpack - <No description provided>
#rpc_zmq_serialization = json
# This option configures round-robin mode in zmq socket. True means
# not keeping a queue when server side disconnects. False means to
# keep queue and messages even if server is disconnected, when the
# server appears we send all accumulated messages to it. (boolean
# value)
#zmq_immediate = true
# Enable/disable TCP keepalive (KA) mechanism. The default value of -1
# (or any other negative value) means to skip any overrides and leave
# it to OS default; 0 and 1 (or any other positive value) mean to
# disable and enable the option respectively. (integer value)
#zmq_tcp_keepalive = -1
# The duration between two keepalive transmissions in idle condition.
# The unit is platform dependent, for example, seconds in Linux,
# milliseconds in Windows etc. The default value of -1 (or any other
# negative value and 0) means to skip any overrides and leave it to OS
# default. (integer value)
#zmq_tcp_keepalive_idle = -1
# The number of retransmissions to be carried out before declaring
# that remote end is not available. The default value of -1 (or any
# other negative value and 0) means to skip any overrides and leave it
# to OS default. (integer value)
#zmq_tcp_keepalive_cnt = -1
# The duration between two successive keepalive retransmissions, if
# acknowledgement to the previous keepalive transmission is not
# received. The unit is platform dependent, for example, seconds in
# Linux, milliseconds in Windows etc. The default value of -1 (or any
# other negative value and 0) means to skip any overrides and leave it
# to OS default. (integer value)
#zmq_tcp_keepalive_intvl = -1
# Maximum number of (green) threads to work concurrently. (integer
# value)
#rpc_thread_pool_size = 100
# Expiration timeout in seconds of a sent/received message after which
# it is not tracked anymore by a client/server. (integer value)
#rpc_message_ttl = 300
# Wait for message acknowledgements from receivers. This mechanism
# works only via proxy without PUB/SUB. (boolean value)
#rpc_use_acks = false
# Number of seconds to wait for an ack from a cast/call. After each
# retry attempt this timeout is multiplied by some specified
# multiplier. (integer value)
#rpc_ack_timeout_base = 15
# Number to multiply base ack timeout by after each retry attempt.
# (integer value)
#rpc_ack_timeout_multiplier = 2
# Default number of message sending attempts in case of any problems
# occurred: positive value N means at most N retries, 0 means no
# retries, None or -1 (or any other negative values) mean to retry
# forever. This option is used only if acknowledgments are enabled.
# (integer value)
#rpc_retry_attempts = 3
# List of publisher hosts SubConsumer can subscribe on. This option
# has higher priority then the default publishers list taken from the
# matchmaker. (list value)
#subscribe_on =
# Size of executor thread pool when executor is threading or eventlet.
# (integer value)
# Deprecated group/name - [DEFAULT]/rpc_thread_pool_size
#executor_thread_pool_size = 64
# Seconds to wait for a response from a call. (integer value)
#rpc_response_timeout = 60
# The network address and optional user credentials for connecting to
# the messaging backend, in URL format. The expected format is:
#
# driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query
#
# Example: rabbit://rabbitmq:password@127.0.0.1:5672//
#
# For full details on the fields in the URL see the documentation of
# oslo_messaging.TransportURL at
# https://docs.openstack.org/oslo.messaging/latest/reference/transport.html
# (string value)
#transport_url = <None>
# DEPRECATED: The messaging driver to use, defaults to rabbit. Other
# drivers include amqp and zmq. (string value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Replaced by [DEFAULT]/transport_url
#rpc_backend = rabbit
# The default exchange under which topics are scoped. May be
# overridden by an exchange name specified in the transport_url
# option. (string value)
#control_exchange = openstack
[cinder]
#
# From manila
#
# Allow attaching between instances and volumes in different
# availability zones. (boolean value)
# Deprecated group/name - [DEFAULT]/cinder_cross_az_attach
#cross_az_attach = true
# Number of cinderclient retries on failed HTTP calls. (integer value)
# Deprecated group/name - [DEFAULT]/cinder_http_retries
#http_retries = 3
# Endpoint type to be used with cinder client calls. (string value)
#endpoint_type = publicURL
# Region name for connecting to cinder. (string value)
#region_name = <None>
# Authentication URL (string value)
#auth_url = <None>
# Authentication type to load (string value)
# Deprecated group/name - [cinder]/auth_plugin
#auth_type = <None>
# PEM encoded Certificate Authority to use when verifying HTTPs
# connections. (string value)
#cafile = <None>
# PEM encoded client certificate cert file (string value)
#certfile = <None>
# Optional domain ID to use with v3 and v2 parameters. It will be used
# for both the user and project domain in v3 and ignored in v2
# authentication. (string value)
#default_domain_id = <None>
# Optional domain name to use with v3 API and v2 parameters. It will
# be used for both the user and project domain in v3 and ignored in v2
# authentication. (string value)
#default_domain_name = <None>
# Domain ID to scope to (string value)
#domain_id = <None>
# Domain name to scope to (string value)
#domain_name = <None>
# Verify HTTPS connections. (boolean value)
#insecure = false
# PEM encoded client certificate key file (string value)
#keyfile = <None>
# User's password (string value)
#password = <None>
# Domain ID containing project (string value)
#project_domain_id = <None>
# Domain name containing project (string value)
#project_domain_name = <None>
# Project ID to scope to (string value)
# Deprecated group/name - [cinder]/tenant_id
#project_id = <None>
# Project name to scope to (string value)
# Deprecated group/name - [cinder]/tenant_name
#project_name = <None>
# Scope for system operations (string value)
#system_scope = <None>
# Timeout value for http requests (integer value)
#timeout = <None>
# Trust ID (string value)
#trust_id = <None>
# User's domain id (string value)
#user_domain_id = <None>
# User's domain name (string value)
#user_domain_name = <None>
# User id (string value)
#user_id = <None>
# Username (string value)
# Deprecated group/name - [cinder]/user_name
#username = <None>
[cors]
#
# From manila
#
# Indicate whether this resource may be shared with the domain
# received in the requests "origin" header. Format:
# "<protocol>://<host>[:<port>]", no trailing slash. Example:
# https://horizon.example.com (list value)
#allowed_origin = <None>
# Indicate that the actual request can include user credentials
# (boolean value)
#allow_credentials = true
# Indicate which headers are safe to expose to the API. Defaults to
# HTTP Simple Headers. (list value)
#expose_headers =
# Maximum cache age of CORS preflight requests. (integer value)
#max_age = 3600
# Indicate which methods can be used during the actual request. (list
# value)
#allow_methods = OPTIONS,GET,HEAD,POST,PUT,DELETE,TRACE,PATCH
# Indicate which header field names may be used during the actual
# request. (list value)
#allow_headers =
#
# From oslo.middleware.cors
#
# Indicate whether this resource may be shared with the domain
# received in the requests "origin" header. Format:
# "<protocol>://<host>[:<port>]", no trailing slash. Example:
# https://horizon.example.com (list value)
#allowed_origin = <None>
# Indicate that the actual request can include user credentials
# (boolean value)
#allow_credentials = true
# Indicate which headers are safe to expose to the API. Defaults to
# HTTP Simple Headers. (list value)
#expose_headers = X-Auth-Token,X-OpenStack-Request-ID,X-Openstack-Manila-Api-Version,X-OpenStack-Manila-API-Experimental,X-Subject-Token,X-Service-Token
# Maximum cache age of CORS preflight requests. (integer value)
#max_age = 3600
# Indicate which methods can be used during the actual request. (list
# value)
#allow_methods = GET,PUT,POST,DELETE,PATCH
# Indicate which header field names may be used during the actual
# request. (list value)
#allow_headers = X-Auth-Token,X-OpenStack-Request-ID,X-Openstack-Manila-Api-Version,X-OpenStack-Manila-API-Experimental,X-Identity-Status,X-Roles,X-Service-Catalog,X-User-Id,X-Tenant-Id
[database]
#
# From oslo.db
#
# If True, SQLite uses synchronous mode. (boolean value)
#sqlite_synchronous = true
# The back end to use for the database. (string value)
# Deprecated group/name - [DEFAULT]/db_backend
#backend = sqlalchemy
# The SQLAlchemy connection string to use to connect to the database.
# (string value)
# Deprecated group/name - [DEFAULT]/sql_connection
# Deprecated group/name - [DATABASE]/sql_connection
# Deprecated group/name - [sql]/connection
#connection = <None>
# The SQLAlchemy connection string to use to connect to the slave
# database. (string value)
#slave_connection = <None>
# 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= (string value)
#mysql_sql_mode = TRADITIONAL
# If True, transparently enables support for handling MySQL Cluster
# (NDB). (boolean value)
#mysql_enable_ndb = false
# Connections which have been present in the connection pool longer
# than this number of seconds will be replaced with a new one the next
# time they are checked out from the pool. (integer value)
# Deprecated group/name - [DATABASE]/idle_timeout
# Deprecated group/name - [database]/idle_timeout
# Deprecated group/name - [DEFAULT]/sql_idle_timeout
# Deprecated group/name - [DATABASE]/sql_idle_timeout
# Deprecated group/name - [sql]/idle_timeout
#connection_recycle_time = 3600
# Minimum number of SQL connections to keep open in a pool. (integer
# value)
# Deprecated group/name - [DEFAULT]/sql_min_pool_size
# Deprecated group/name - [DATABASE]/sql_min_pool_size
#min_pool_size = 1
# Maximum number of SQL connections to keep open in a pool. Setting a
# value of 0 indicates no limit. (integer value)
# Deprecated group/name - [DEFAULT]/sql_max_pool_size
# Deprecated group/name - [DATABASE]/sql_max_pool_size
#max_pool_size = 5
# Maximum number of database connection retries during startup. Set to
# -1 to specify an infinite retry count. (integer value)
# Deprecated group/name - [DEFAULT]/sql_max_retries
# Deprecated group/name - [DATABASE]/sql_max_retries
#max_retries = 10
# Interval between retries of opening a SQL connection. (integer
# value)
# Deprecated group/name - [DEFAULT]/sql_retry_interval
# Deprecated group/name - [DATABASE]/reconnect_interval
#retry_interval = 10
# If set, use this value for max_overflow with SQLAlchemy. (integer
# value)
# Deprecated group/name - [DEFAULT]/sql_max_overflow
# Deprecated group/name - [DATABASE]/sqlalchemy_max_overflow
#max_overflow = 50
# Verbosity of SQL debugging information: 0=None, 100=Everything.
# (integer value)
# Minimum value: 0
# Maximum value: 100
# Deprecated group/name - [DEFAULT]/sql_connection_debug
#connection_debug = 0
# Add Python stack traces to SQL as comment strings. (boolean value)
# Deprecated group/name - [DEFAULT]/sql_connection_trace
#connection_trace = false
# If set, use this value for pool_timeout with SQLAlchemy. (integer
# value)
# Deprecated group/name - [DATABASE]/sqlalchemy_pool_timeout
#pool_timeout = <None>
# Enable the experimental use of database reconnect on connection
# lost. (boolean value)
#use_db_reconnect = false
# Seconds between retries of a database transaction. (integer value)
#db_retry_interval = 1
# If True, increases the interval between retries of a database
# operation up to db_max_retry_interval. (boolean value)
#db_inc_retry_interval = true
# If db_inc_retry_interval is set, the maximum seconds between retries
# of a database operation. (integer value)
#db_max_retry_interval = 10
# Maximum retries in case of connection error or deadlock error before
# error is raised. Set to -1 to specify an infinite retry count.
# (integer value)
#db_max_retries = 20
#
# From oslo.db.concurrency
#
# Enable the experimental use of thread pooling for all DB API calls
# (boolean value)
# Deprecated group/name - [DEFAULT]/dbapi_use_tpool
#use_tpool = false
[healthcheck]
#
# From manila
#
# DEPRECATED: The path to respond to healtcheck requests on. (string
# value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
#path = /healthcheck
# Show more detailed information as part of the response (boolean
# value)
#detailed = false
# Additional backends that can perform health checks and report that
# information back as part of a request. (list value)
#backends =
# Check the presence of a file to determine if an application is
# running on a port. Used by DisableByFileHealthcheck plugin. (string
# value)
#disable_by_file_path = <None>
# 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. (list value)
#disable_by_file_paths =
[keystone_authtoken]
#
# From keystonemiddleware.auth_token
#
# Complete "public" Identity API endpoint. This endpoint should not be
# an "admin" endpoint, as it should be accessible by all end users.
# Unauthenticated clients are redirected to this endpoint to
# authenticate. Although this endpoint should ideally be unversioned,
# client support in the wild varies. If you're using a versioned v2
# endpoint here, then this should *not* be the same endpoint the
# service user utilizes for validating tokens, because normal end
# users may not be able to reach that endpoint. (string value)
# Deprecated group/name - [keystone_authtoken]/auth_uri
#www_authenticate_uri = <None>
# DEPRECATED: Complete "public" Identity API endpoint. This endpoint
# should not be an "admin" endpoint, as it should be accessible by all
# end users. Unauthenticated clients are redirected to this endpoint
# to authenticate. Although this endpoint should ideally be
# unversioned, client support in the wild varies. If you're using a
# versioned v2 endpoint here, then this should *not* be the same
# endpoint the service user utilizes for validating tokens, because
# normal end users may not be able to reach that endpoint. This option
# is deprecated in favor of www_authenticate_uri and will be removed
# in the S release. (string value)
# This option is deprecated for removal since Queens.
# Its value may be silently ignored in the future.
# Reason: The auth_uri option is deprecated in favor of
# www_authenticate_uri and will be removed in the S release.
#auth_uri = <None>
# API version of the admin Identity API endpoint. (string value)
#auth_version = <None>
# Do not handle authorization requests within the middleware, but
# delegate the authorization decision to downstream WSGI components.
# (boolean value)
#delay_auth_decision = false
# Request timeout value for communicating with Identity API server.
# (integer value)
#http_connect_timeout = <None>
# How many times are we trying to reconnect when communicating with
# Identity API Server. (integer value)
#http_request_max_retries = 3
# Request environment key where the Swift cache object is stored. When
# auth_token middleware is deployed with a Swift cache, use this
# option to have the middleware share a caching backend with swift.
# Otherwise, use the ``memcached_servers`` option instead. (string
# value)
#cache = <None>
# Required if identity server requires client certificate (string
# value)
#certfile = <None>
# Required if identity server requires client certificate (string
# value)
#keyfile = <None>
# A PEM encoded Certificate Authority to use when verifying HTTPs
# connections. Defaults to system CAs. (string value)
#cafile = <None>
# Verify HTTPS connections. (boolean value)
#insecure = false
# The region in which the identity server can be found. (string value)
#region_name = <None>
# DEPRECATED: Directory used to cache files related to PKI tokens.
# This option has been deprecated in the Ocata release and will be
# removed in the P release. (string value)
# This option is deprecated for removal since Ocata.
# Its value may be silently ignored in the future.
# Reason: PKI token format is no longer supported.
#signing_dir = <None>
# Optionally specify a list of memcached server(s) to use for caching.
# If left undefined, tokens will instead be cached in-process. (list
# value)
# Deprecated group/name - [keystone_authtoken]/memcache_servers
#memcached_servers = <None>
# 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. (integer
# value)
#token_cache_time = 300
# DEPRECATED: 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. Only valid for PKI tokens. This
# option has been deprecated in the Ocata release and will be removed
# in the P release. (integer value)
# This option is deprecated for removal since Ocata.
# Its value may be silently ignored in the future.
# Reason: PKI token format is no longer supported.
#revocation_cache_time = 10
# (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. (string value)
# Possible values:
# None - <No description provided>
# MAC - <No description provided>
# ENCRYPT - <No description provided>
#memcache_security_strategy = None
# (Optional, mandatory if memcache_security_strategy is defined) This
# string is used for key derivation. (string value)
#memcache_secret_key = <None>
# (Optional) Number of seconds memcached server is considered dead
# before it is tried again. (integer value)
#memcache_pool_dead_retry = 300
# (Optional) Maximum total number of open connections to every
# memcached server. (integer value)
#memcache_pool_maxsize = 10
# (Optional) Socket timeout in seconds for communicating with a
# memcached server. (integer value)
#memcache_pool_socket_timeout = 3
# (Optional) Number of seconds a connection to memcached is held
# unused in the pool before it is closed. (integer value)
#memcache_pool_unused_timeout = 60
# (Optional) Number of seconds that an operation will wait to get a
# memcached client connection from the pool. (integer value)
#memcache_pool_conn_get_timeout = 10
# (Optional) Use the advanced (eventlet safe) memcached client pool.
# The advanced pool will only work under python 2.x. (boolean value)
#memcache_use_advanced_pool = false
# (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. (boolean
# value)
#include_service_catalog = true
# 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. (string value)
#enforce_token_bind = permissive
# DEPRECATED: If true, the revocation list will be checked for cached
# tokens. This requires that PKI tokens are configured on the identity
# server. (boolean value)
# This option is deprecated for removal since Ocata.
# Its value may be silently ignored in the future.
# Reason: PKI token format is no longer supported.
#check_revocations_for_cached = false
# DEPRECATED: 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. (list value)
# This option is deprecated for removal since Ocata.
# Its value may be silently ignored in the future.
# Reason: PKI token format is no longer supported.
#hash_algorithms = md5
# A choice of roles that must be present in a service token. Service
# tokens are allowed to request that an expired token can be used and
# so this check should tightly control that only actual services
# should be sending this token. Roles here are applied as an ANY check
# so any role in this list must be present. For backwards
# compatibility reasons this currently only affects the allow_expired
# check. (list value)
#service_token_roles = service
# For backwards compatibility reasons we must let valid service tokens
# pass that don't pass the service_token_roles check as valid. Setting
# this true will become the default in a future release and should be
# enabled if possible. (boolean value)
#service_token_roles_required = false
# Authentication type to load (string value)
# Deprecated group/name - [keystone_authtoken]/auth_plugin
#auth_type = <None>
# Config Section from which to load plugin specific options (string
# value)
#auth_section = <None>
[matchmaker_redis]
#
# From oslo.messaging
#
# DEPRECATED: Host to locate redis. (string value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Replaced by [DEFAULT]/transport_url
#host = 127.0.0.1
# DEPRECATED: Use this port to connect to redis host. (port value)
# Minimum value: 0
# Maximum value: 65535
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Replaced by [DEFAULT]/transport_url
#port = 6379
# DEPRECATED: Password for Redis server (optional). (string value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Replaced by [DEFAULT]/transport_url
#password =
# DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode),
# e.g., [host:port, host1:port ... ] (list value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Replaced by [DEFAULT]/transport_url
#sentinel_hosts =
# Redis replica set name. (string value)
#sentinel_group_name = oslo-messaging-zeromq
# Time in ms to wait between connection attempts. (integer value)
#wait_timeout = 2000
# Time in ms to wait before the transaction is killed. (integer value)
#check_timeout = 20000
# Timeout in ms on blocking socket operations. (integer value)
#socket_timeout = 10000
[neutron]
#
# From manila
#
# URL for connecting to neutron. (string value)
# Deprecated group/name - [DEFAULT]/neutron_url
#url = http://127.0.0.1:9696
# Timeout value for connecting to neutron in seconds. (integer value)
# Deprecated group/name - [DEFAULT]/neutron_url_timeout
#url_timeout = 30
# Auth strategy for connecting to neutron in admin context. (string
# value)
#auth_strategy = keystone
# Endpoint type to be used with neutron client calls. (string value)
#endpoint_type = publicURL
# Region name for connecting to neutron in admin context. (string
# value)
#region_name = <None>
# Authentication URL (string value)
#auth_url = <None>
# Authentication type to load (string value)
# Deprecated group/name - [neutron]/auth_plugin
#auth_type = <None>
# PEM encoded Certificate Authority to use when verifying HTTPs
# connections. (string value)
#cafile = <None>
# PEM encoded client certificate cert file (string value)
#certfile = <None>
# Optional domain ID to use with v3 and v2 parameters. It will be used
# for both the user and project domain in v3 and ignored in v2
# authentication. (string value)
#default_domain_id = <None>
# Optional domain name to use with v3 API and v2 parameters. It will
# be used for both the user and project domain in v3 and ignored in v2
# authentication. (string value)
#default_domain_name = <None>
# Domain ID to scope to (string value)
#domain_id = <None>
# Domain name to scope to (string value)
#domain_name = <None>
# Verify HTTPS connections. (boolean value)
#insecure = false
# PEM encoded client certificate key file (string value)
#keyfile = <None>
# User's password (string value)
#password = <None>
# Domain ID containing project (string value)
#project_domain_id = <None>
# Domain name containing project (string value)
#project_domain_name = <None>
# Project ID to scope to (string value)
# Deprecated group/name - [neutron]/tenant_id
#project_id = <None>
# Project name to scope to (string value)
# Deprecated group/name - [neutron]/tenant_name
#project_name = <None>
# Scope for system operations (string value)
#system_scope = <None>
# Timeout value for http requests (integer value)
#timeout = <None>
# Trust ID (string value)
#trust_id = <None>
# User's domain id (string value)
#user_domain_id = <None>
# User's domain name (string value)
#user_domain_name = <None>
# User id (string value)
#user_id = <None>
# Username (string value)
# Deprecated group/name - [neutron]/user_name
#username = <None>
[nova]
#
# From manila
#
# Version of Nova API to be used. (string value)
# Deprecated group/name - [DEFAULT]/nova_api_microversion
#api_microversion = 2.10
# Endpoint type to be used with nova client calls. (string value)
#endpoint_type = publicURL
# Region name for connecting to nova. (string value)
#region_name = <None>
# Authentication URL (string value)
#auth_url = <None>
# Authentication type to load (string value)
# Deprecated group/name - [nova]/auth_plugin
#auth_type = <None>
# PEM encoded Certificate Authority to use when verifying HTTPs
# connections. (string value)
#cafile = <None>
# PEM encoded client certificate cert file (string value)
#certfile = <None>
# Optional domain ID to use with v3 and v2 parameters. It will be used
# for both the user and project domain in v3 and ignored in v2
# authentication. (string value)
#default_domain_id = <None>
# Optional domain name to use with v3 API and v2 parameters. It will
# be used for both the user and project domain in v3 and ignored in v2
# authentication. (string value)
#default_domain_name = <None>
# Domain ID to scope to (string value)
#domain_id = <None>
# Domain name to scope to (string value)
#domain_name = <None>
# Verify HTTPS connections. (boolean value)
#insecure = false
# PEM encoded client certificate key file (string value)
#keyfile = <None>
# User's password (string value)
#password = <None>
# Domain ID containing project (string value)
#project_domain_id = <None>
# Domain name containing project (string value)
#project_domain_name = <None>
# Project ID to scope to (string value)
# Deprecated group/name - [nova]/tenant_id
#project_id = <None>
# Project name to scope to (string value)
# Deprecated group/name - [nova]/tenant_name
#project_name = <None>
# Scope for system operations (string value)
#system_scope = <None>
# Timeout value for http requests (integer value)
#timeout = <None>
# Trust ID (string value)
#trust_id = <None>
# User's domain id (string value)
#user_domain_id = <None>
# User's domain name (string value)
#user_domain_name = <None>
# User id (string value)
#user_id = <None>
# Username (string value)
# Deprecated group/name - [nova]/user_name
#username = <None>
[oslo_concurrency]
#
# From manila
#
# Enables or disables inter-process locks. (boolean value)
#disable_process_locking = false
# Directory to use for lock files. For security, the specified
# directory should only be writable by the user running the processes
# that need locking. Defaults to environment variable OSLO_LOCK_PATH.
# If external locks are used, a lock path must be set. (string value)
#lock_path = <None>
[oslo_messaging_amqp]
#
# From oslo.messaging
#
# Name for the AMQP container. must be globally unique. Defaults to a
# generated UUID (string value)
#container_name = <None>
# Timeout for inactive connections (in seconds) (integer value)
#idle_timeout = 0
# Debug: dump AMQP frames to stdout (boolean value)
#trace = false
# Attempt to connect via SSL. If no other ssl-related parameters are
# given, it will use the system's CA-bundle to verify the server's
# certificate. (boolean value)
#ssl = false
# CA certificate PEM file used to verify the server's certificate
# (string value)
#ssl_ca_file =
# Self-identifying certificate PEM file for client authentication
# (string value)
#ssl_cert_file =
# Private key PEM file used to sign ssl_cert_file certificate
# (optional) (string value)
#ssl_key_file =
# Password for decrypting ssl_key_file (if encrypted) (string value)
#ssl_key_password = <None>
# By default SSL checks that the name in the server's certificate
# matches the hostname in the transport_url. In some configurations it
# may be preferable to use the virtual hostname instead, for example
# if the server uses the Server Name Indication TLS extension
# (rfc6066) to provide a certificate per virtual host. Set
# ssl_verify_vhost to True if the server's SSL certificate uses the
# virtual host name instead of the DNS name. (boolean value)
#ssl_verify_vhost = false
# DEPRECATED: Accept clients using either SSL or plain TCP (boolean
# value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Not applicable - not a SSL server
#allow_insecure_clients = false
# Space separated list of acceptable SASL mechanisms (string value)
#sasl_mechanisms =
# Path to directory that contains the SASL configuration (string
# value)
#sasl_config_dir =
# Name of configuration file (without .conf suffix) (string value)
#sasl_config_name =
# SASL realm to use if no realm present in username (string value)
#sasl_default_realm =
# DEPRECATED: User name for message broker authentication (string
# value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Should use configuration option transport_url to provide the
# username.
#username =
# DEPRECATED: Password for message broker authentication (string
# value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Should use configuration option transport_url to provide the
# password.
#password =
# Seconds to pause before attempting to re-connect. (integer value)
# Minimum value: 1
#connection_retry_interval = 1
# Increase the connection_retry_interval by this many seconds after
# each unsuccessful failover attempt. (integer value)
# Minimum value: 0
#connection_retry_backoff = 2
# Maximum limit for connection_retry_interval +
# connection_retry_backoff (integer value)
# Minimum value: 1
#connection_retry_interval_max = 30
# Time to pause between re-connecting an AMQP 1.0 link that failed due
# to a recoverable error. (integer value)
# Minimum value: 1
#link_retry_delay = 10
# The maximum number of attempts to re-send a reply message which
# failed due to a recoverable error. (integer value)
# Minimum value: -1
#default_reply_retry = 0
# The deadline for an rpc reply message delivery. (integer value)
# Minimum value: 5
#default_reply_timeout = 30
# The deadline for an rpc cast or call message delivery. Only used
# when caller does not provide a timeout expiry. (integer value)
# Minimum value: 5
#default_send_timeout = 30
# The deadline for a sent notification message delivery. Only used
# when caller does not provide a timeout expiry. (integer value)
# Minimum value: 5
#default_notify_timeout = 30
# The duration to schedule a purge of idle sender links. Detach link
# after expiry. (integer value)
# Minimum value: 1
#default_sender_link_timeout = 600
# Indicates the addressing mode used by the driver.
# Permitted values:
# 'legacy' - use legacy non-routable addressing
# 'routable' - use routable addresses
# 'dynamic' - use legacy addresses if the message bus does not
# support routing otherwise use routable addressing (string value)
#addressing_mode = dynamic
# Enable virtual host support for those message buses that do not
# natively support virtual hosting (such as qpidd). When set to true
# the virtual host name will be added to all message bus addresses,
# effectively creating a private 'subnet' per virtual host. Set to
# False if the message bus supports virtual hosting using the
# 'hostname' field in the AMQP 1.0 Open performative as the name of
# the virtual host. (boolean value)
#pseudo_vhost = true
# address prefix used when sending to a specific server (string value)
#server_request_prefix = exclusive
# address prefix used when broadcasting to all servers (string value)
#broadcast_prefix = broadcast
# address prefix when sending to any server in group (string value)
#group_request_prefix = unicast
# Address prefix for all generated RPC addresses (string value)
#rpc_address_prefix = openstack.org/om/rpc
# Address prefix for all generated Notification addresses (string
# value)
#notify_address_prefix = openstack.org/om/notify
# Appended to the address prefix when sending a fanout message. Used
# by the message bus to identify fanout messages. (string value)
#multicast_address = multicast
# Appended to the address prefix when sending to a particular
# RPC/Notification server. Used by the message bus to identify
# messages sent to a single destination. (string value)
#unicast_address = unicast
# Appended to the address prefix when sending to a group of consumers.
# Used by the message bus to identify messages that should be
# delivered in a round-robin fashion across consumers. (string value)
#anycast_address = anycast
# Exchange name used in notification addresses.
# Exchange name resolution precedence:
# Target.exchange if set
# else default_notification_exchange if set
# else control_exchange if set
# else 'notify' (string value)
#default_notification_exchange = <None>
# Exchange name used in RPC addresses.
# Exchange name resolution precedence:
# Target.exchange if set
# else default_rpc_exchange if set
# else control_exchange if set
# else 'rpc' (string value)
#default_rpc_exchange = <None>
# Window size for incoming RPC Reply messages. (integer value)
# Minimum value: 1
#reply_link_credit = 200
# Window size for incoming RPC Request messages (integer value)
# Minimum value: 1
#rpc_server_credit = 100
# Window size for incoming Notification messages (integer value)
# Minimum value: 1
#notify_server_credit = 100
# Send messages of this type pre-settled.
# Pre-settled messages will not receive acknowledgement
# from the peer. Note well: pre-settled messages may be
# silently discarded if the delivery fails.
# Permitted values:
# 'rpc-call' - send RPC Calls pre-settled
# 'rpc-reply'- send RPC Replies pre-settled
# 'rpc-cast' - Send RPC Casts pre-settled
# 'notify' - Send Notifications pre-settled
# (multi valued)
#pre_settled = rpc-cast
#pre_settled = rpc-reply
[oslo_messaging_kafka]
#
# From oslo.messaging
#
# DEPRECATED: Default Kafka broker Host (string value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Replaced by [DEFAULT]/transport_url
#kafka_default_host = localhost
# DEPRECATED: Default Kafka broker Port (port value)
# Minimum value: 0
# Maximum value: 65535
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Replaced by [DEFAULT]/transport_url
#kafka_default_port = 9092
# Max fetch bytes of Kafka consumer (integer value)
#kafka_max_fetch_bytes = 1048576
# Default timeout(s) for Kafka consumers (floating point value)
#kafka_consumer_timeout = 1.0
# DEPRECATED: Pool Size for Kafka Consumers (integer value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Driver no longer uses connection pool.
#pool_size = 10
# DEPRECATED: The pool size limit for connections expiration policy
# (integer value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Driver no longer uses connection pool.
#conn_pool_min_size = 2
# DEPRECATED: The time-to-live in sec of idle connections in the pool
# (integer value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Driver no longer uses connection pool.
#conn_pool_ttl = 1200
# Group id for Kafka consumer. Consumers in one group will coordinate
# message consumption (string value)
#consumer_group = oslo_messaging_consumer
# Upper bound on the delay for KafkaProducer batching in seconds
# (floating point value)
#producer_batch_timeout = 0.0
# Size of batch for the producer async send (integer value)
#producer_batch_size = 16384
[oslo_messaging_notifications]
#
# From oslo.messaging
#
# The Drivers(s) to handle sending notifications. Possible values are
# messaging, messagingv2, routing, log, test, noop (multi valued)
# Deprecated group/name - [DEFAULT]/notification_driver
#driver =
# A URL representing the messaging driver to use for notifications. If
# not set, we fall back to the same configuration used for RPC.
# (string value)
# Deprecated group/name - [DEFAULT]/notification_transport_url
#transport_url = <None>
# AMQP topic used for OpenStack notifications. (list value)
# Deprecated group/name - [rpc_notifier2]/topics
# Deprecated group/name - [DEFAULT]/notification_topics
#topics = notifications
# The maximum number of attempts to re-send a notification message
# which failed to be delivered due to a recoverable error. 0 - No
# retry, -1 - indefinite (integer value)
#retry = -1
[oslo_messaging_rabbit]
#
# From oslo.messaging
#
# Use durable queues in AMQP. (boolean value)
# Deprecated group/name - [DEFAULT]/amqp_durable_queues
# Deprecated group/name - [DEFAULT]/rabbit_durable_queues
#amqp_durable_queues = false
# Auto-delete queues in AMQP. (boolean value)
#amqp_auto_delete = false
# Enable SSL (boolean value)
#ssl = <None>
# SSL version to use (valid only if SSL enabled). Valid values are
# TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be
# available on some distributions. (string value)
# Deprecated group/name - [oslo_messaging_rabbit]/kombu_ssl_version
#ssl_version =
# SSL key file (valid only if SSL enabled). (string value)
# Deprecated group/name - [oslo_messaging_rabbit]/kombu_ssl_keyfile
#ssl_key_file =
# SSL cert file (valid only if SSL enabled). (string value)
# Deprecated group/name - [oslo_messaging_rabbit]/kombu_ssl_certfile
#ssl_cert_file =
# SSL certification authority file (valid only if SSL enabled).
# (string value)
# Deprecated group/name - [oslo_messaging_rabbit]/kombu_ssl_ca_certs
#ssl_ca_file =
# How long to wait before reconnecting in response to an AMQP consumer
# cancel notification. (floating point value)
#kombu_reconnect_delay = 1.0
# EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression
# will not be used. This option may not be available in future
# versions. (string value)
#kombu_compression = <None>
# How long to wait a missing client before abandoning to send it its
# replies. This value should not be longer than rpc_response_timeout.
# (integer value)
# Deprecated group/name - [oslo_messaging_rabbit]/kombu_reconnect_timeout
#kombu_missing_consumer_retry_timeout = 60
# Determines how the next RabbitMQ node is chosen in case the one we
# are currently connected to becomes unavailable. Takes effect only if
# more than one RabbitMQ node is provided in config. (string value)
# Possible values:
# round-robin - <No description provided>
# shuffle - <No description provided>
#kombu_failover_strategy = round-robin
# DEPRECATED: The RabbitMQ broker address where a single node is used.
# (string value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Replaced by [DEFAULT]/transport_url
#rabbit_host = localhost
# DEPRECATED: The RabbitMQ broker port where a single node is used.
# (port value)
# Minimum value: 0
# Maximum value: 65535
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Replaced by [DEFAULT]/transport_url
#rabbit_port = 5672
# DEPRECATED: RabbitMQ HA cluster host:port pairs. (list value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Replaced by [DEFAULT]/transport_url
#rabbit_hosts = $rabbit_host:$rabbit_port
# DEPRECATED: The RabbitMQ userid. (string value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Replaced by [DEFAULT]/transport_url
#rabbit_userid = guest
# DEPRECATED: The RabbitMQ password. (string value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Replaced by [DEFAULT]/transport_url
#rabbit_password = guest
# The RabbitMQ login method. (string value)
# Possible values:
# PLAIN - <No description provided>
# AMQPLAIN - <No description provided>
# RABBIT-CR-DEMO - <No description provided>
#rabbit_login_method = AMQPLAIN
# DEPRECATED: The RabbitMQ virtual host. (string value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Replaced by [DEFAULT]/transport_url
#rabbit_virtual_host = /
# How frequently to retry connecting with RabbitMQ. (integer value)
#rabbit_retry_interval = 1
# How long to backoff for between retries when connecting to RabbitMQ.
# (integer value)
#rabbit_retry_backoff = 2
# Maximum interval of RabbitMQ connection retries. Default is 30
# seconds. (integer value)
#rabbit_interval_max = 30
# DEPRECATED: Maximum number of RabbitMQ connection retries. Default
# is 0 (infinite retry count). (integer value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
#rabbit_max_retries = 0
# Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change
# this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0,
# queue mirroring is no longer controlled by the x-ha-policy argument
# when declaring a queue. If you just want to make sure that all
# queues (except those with auto-generated names) are mirrored across
# all nodes, run: "rabbitmqctl set_policy HA '^(?!amq\.).*' '{"ha-
# mode": "all"}' " (boolean value)
#rabbit_ha_queues = false
# Positive integer representing duration in seconds for queue TTL
# (x-expires). Queues which are unused for the duration of the TTL are
# automatically deleted. The parameter affects only reply and fanout
# queues. (integer value)
# Minimum value: 1
#rabbit_transient_queues_ttl = 1800
# Specifies the number of messages to prefetch. Setting to zero allows
# unlimited messages. (integer value)
#rabbit_qos_prefetch_count = 0
# Number of seconds after which the Rabbit broker is considered down
# if heartbeat's keep-alive fails (0 disable the heartbeat).
# EXPERIMENTAL (integer value)
#heartbeat_timeout_threshold = 60
# How often times during the heartbeat_timeout_threshold we check the
# heartbeat. (integer value)
#heartbeat_rate = 2
# Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
# (boolean value)
#fake_rabbit = false
# Maximum number of channels to allow (integer value)
#channel_max = <None>
# The maximum byte size for an AMQP frame (integer value)
#frame_max = <None>
# How often to send heartbeats for consumer's connections (integer
# value)
#heartbeat_interval = 3
# Arguments passed to ssl.wrap_socket (dict value)
#ssl_options = <None>
# Set socket timeout in seconds for connection's socket (floating
# point value)
#socket_timeout = 0.25
# Set TCP_USER_TIMEOUT in seconds for connection's socket (floating
# point value)
#tcp_user_timeout = 0.25
# Set delay for reconnection to some host which has connection error
# (floating point value)
#host_connection_reconnect_delay = 0.25
# Connection factory implementation (string value)
# Possible values:
# new - <No description provided>
# single - <No description provided>
# read_write - <No description provided>
#connection_factory = single
# Maximum number of connections to keep queued. (integer value)
#pool_max_size = 30
# Maximum number of connections to create above `pool_max_size`.
# (integer value)
#pool_max_overflow = 0
# Default number of seconds to wait for a connections to available
# (integer value)
#pool_timeout = 30
# Lifetime of a connection (since creation) in seconds or None for no
# recycling. Expired connections are closed on acquire. (integer
# value)
#pool_recycle = 600
# Threshold at which inactive (since release) connections are
# considered stale in seconds or None for no staleness. Stale
# connections are closed on acquire. (integer value)
#pool_stale = 60
# Default serialization mechanism for serializing/deserializing
# outgoing/incoming messages (string value)
# Possible values:
# json - <No description provided>
# msgpack - <No description provided>
#default_serializer_type = json
# Persist notification messages. (boolean value)
#notification_persistence = false
# Exchange name for sending notifications (string value)
#default_notification_exchange = ${control_exchange}_notification
# Max number of not acknowledged message which RabbitMQ can send to
# notification listener. (integer value)
#notification_listener_prefetch_count = 100
# Reconnecting retry count in case of connectivity problem during
# sending notification, -1 means infinite retry. (integer value)
#default_notification_retry_attempts = -1
# Reconnecting retry delay in case of connectivity problem during
# sending notification message (floating point value)
#notification_retry_delay = 0.25
# Time to live for rpc queues without consumers in seconds. (integer
# value)
#rpc_queue_expiration = 60
# Exchange name for sending RPC messages (string value)
#default_rpc_exchange = ${control_exchange}_rpc
# Exchange name for receiving RPC replies (string value)
#rpc_reply_exchange = ${control_exchange}_rpc_reply
# Max number of not acknowledged message which RabbitMQ can send to
# rpc listener. (integer value)
#rpc_listener_prefetch_count = 100
# Max number of not acknowledged message which RabbitMQ can send to
# rpc reply listener. (integer value)
#rpc_reply_listener_prefetch_count = 100
# Reconnecting retry count in case of connectivity problem during
# sending reply. -1 means infinite retry during rpc_timeout (integer
# value)
#rpc_reply_retry_attempts = -1
# Reconnecting retry delay in case of connectivity problem during
# sending reply. (floating point value)
#rpc_reply_retry_delay = 0.25
# Reconnecting retry count in case of connectivity problem during
# sending RPC message, -1 means infinite retry. If actual retry
# attempts in not 0 the rpc request could be processed more than one
# time (integer value)
#default_rpc_retry_attempts = -1
# Reconnecting retry delay in case of connectivity problem during
# sending RPC message (floating point value)
#rpc_retry_delay = 0.25
[oslo_messaging_zmq]
#
# From oslo.messaging
#
# ZeroMQ bind address. Should be a wildcard (*), an ethernet
# interface, or IP. The "host" option should point or resolve to this
# address. (string value)
#rpc_zmq_bind_address = *
# MatchMaker driver. (string value)
# Possible values:
# redis - <No description provided>
# sentinel - <No description provided>
# dummy - <No description provided>
#rpc_zmq_matchmaker = redis
# Number of ZeroMQ contexts, defaults to 1. (integer value)
#rpc_zmq_contexts = 1
# Maximum number of ingress messages to locally buffer per topic.
# Default is unlimited. (integer value)
#rpc_zmq_topic_backlog = <None>
# Directory for holding IPC sockets. (string value)
#rpc_zmq_ipc_dir = /var/run/openstack
# Name of this node. Must be a valid hostname, FQDN, or IP address.
# Must match "host" option, if running Nova. (string value)
#rpc_zmq_host = localhost
# Number of seconds to wait before all pending messages will be sent
# after closing a socket. The default value of -1 specifies an
# infinite linger period. The value of 0 specifies no linger period.
# Pending messages shall be discarded immediately when the socket is
# closed. Positive values specify an upper bound for the linger
# period. (integer value)
# Deprecated group/name - [DEFAULT]/rpc_cast_timeout
#zmq_linger = -1
# The default number of seconds that poll should wait. Poll raises
# timeout exception when timeout expired. (integer value)
#rpc_poll_timeout = 1
# Expiration timeout in seconds of a name service record about
# existing target ( < 0 means no timeout). (integer value)
#zmq_target_expire = 300
# Update period in seconds of a name service record about existing
# target. (integer value)
#zmq_target_update = 180
# Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
# (boolean value)
#use_pub_sub = false
# Use ROUTER remote proxy. (boolean value)
#use_router_proxy = false
# This option makes direct connections dynamic or static. It makes
# sense only with use_router_proxy=False which means to use direct
# connections for direct message types (ignored otherwise). (boolean
# value)
#use_dynamic_connections = false
# How many additional connections to a host will be made for failover
# reasons. This option is actual only in dynamic connections mode.
# (integer value)
#zmq_failover_connections = 2
# Minimal port number for random ports range. (port value)
# Minimum value: 0
# Maximum value: 65535
#rpc_zmq_min_port = 49153
# Maximal port number for random ports range. (integer value)
# Minimum value: 1
# Maximum value: 65536
#rpc_zmq_max_port = 65536
# Number of retries to find free port number before fail with
# ZMQBindError. (integer value)
#rpc_zmq_bind_port_retries = 100
# Default serialization mechanism for serializing/deserializing
# outgoing/incoming messages (string value)
# Possible values:
# json - <No description provided>
# msgpack - <No description provided>
#rpc_zmq_serialization = json
# This option configures round-robin mode in zmq socket. True means
# not keeping a queue when server side disconnects. False means to
# keep queue and messages even if server is disconnected, when the
# server appears we send all accumulated messages to it. (boolean
# value)
#zmq_immediate = true
# Enable/disable TCP keepalive (KA) mechanism. The default value of -1
# (or any other negative value) means to skip any overrides and leave
# it to OS default; 0 and 1 (or any other positive value) mean to
# disable and enable the option respectively. (integer value)
#zmq_tcp_keepalive = -1
# The duration between two keepalive transmissions in idle condition.
# The unit is platform dependent, for example, seconds in Linux,
# milliseconds in Windows etc. The default value of -1 (or any other
# negative value and 0) means to skip any overrides and leave it to OS
# default. (integer value)
#zmq_tcp_keepalive_idle = -1
# The number of retransmissions to be carried out before declaring
# that remote end is not available. The default value of -1 (or any
# other negative value and 0) means to skip any overrides and leave it
# to OS default. (integer value)
#zmq_tcp_keepalive_cnt = -1
# The duration between two successive keepalive retransmissions, if
# acknowledgement to the previous keepalive transmission is not
# received. The unit is platform dependent, for example, seconds in
# Linux, milliseconds in Windows etc. The default value of -1 (or any
# other negative value and 0) means to skip any overrides and leave it
# to OS default. (integer value)
#zmq_tcp_keepalive_intvl = -1
# Maximum number of (green) threads to work concurrently. (integer
# value)
#rpc_thread_pool_size = 100
# Expiration timeout in seconds of a sent/received message after which
# it is not tracked anymore by a client/server. (integer value)
#rpc_message_ttl = 300
# Wait for message acknowledgements from receivers. This mechanism
# works only via proxy without PUB/SUB. (boolean value)
#rpc_use_acks = false
# Number of seconds to wait for an ack from a cast/call. After each
# retry attempt this timeout is multiplied by some specified
# multiplier. (integer value)
#rpc_ack_timeout_base = 15
# Number to multiply base ack timeout by after each retry attempt.
# (integer value)
#rpc_ack_timeout_multiplier = 2
# Default number of message sending attempts in case of any problems
# occurred: positive value N means at most N retries, 0 means no
# retries, None or -1 (or any other negative values) mean to retry
# forever. This option is used only if acknowledgments are enabled.
# (integer value)
#rpc_retry_attempts = 3
# List of publisher hosts SubConsumer can subscribe on. This option
# has higher priority then the default publishers list taken from the
# matchmaker. (list value)
#subscribe_on =
[oslo_middleware]
#
# From manila
#
# The maximum body size for each request, in bytes. (integer value)
# Deprecated group/name - [DEFAULT]/osapi_max_request_body_size
# Deprecated group/name - [DEFAULT]/max_request_body_size
#max_request_body_size = 114688
# 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. (string value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
#secure_proxy_ssl_header = X-Forwarded-Proto
# Whether the application is behind a proxy or not. This determines if
# the middleware should parse the headers or not. (boolean value)
#enable_proxy_headers_parsing = false
#
# From oslo.middleware.http_proxy_to_wsgi
#
# Whether the application is behind a proxy or not. This determines if
# the middleware should parse the headers or not. (boolean value)
#enable_proxy_headers_parsing = false
[oslo_policy]
#
# From manila
#
# This option controls whether or not to enforce scope when evaluating
# policies. If ``True``, the scope of the token used in the request is
# compared to the ``scope_types`` of the policy being enforced. If the
# scopes do not match, an ``InvalidScope`` exception will be raised.
# If ``False``, a message will be logged informing operators that
# policies are being invoked with mismatching scope. (boolean value)
#enforce_scope = false
# The file that defines policies. (string value)
#policy_file = policy.json
# Default rule. Enforced when a requested rule is not found. (string
# value)
#policy_default_rule = default
# 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. (multi valued)
#policy_dirs = policy.d
# Content Type to send and receive data for REST based policy check
# (string value)
# Possible values:
# application/x-www-form-urlencoded - <No description provided>
# application/json - <No description provided>
#remote_content_type = application/x-www-form-urlencoded
# server identity verification for REST based policy check (boolean
# value)
#remote_ssl_verify_server_crt = false
# Absolute path to ca cert file for REST based policy check (string
# value)
#remote_ssl_ca_crt_file = <None>
# Absolute path to client cert for REST based policy check (string
# value)
#remote_ssl_client_crt_file = <None>
# Absolute path client key file REST based policy check (string value)
#remote_ssl_client_key_file = <None>
[ssl]
#
# From manila
#
# CA certificate file to use to verify connecting clients. (string
# value)
# Deprecated group/name - [DEFAULT]/ssl_ca_file
#ca_file = <None>
# Certificate file to use when starting the server securely. (string
# value)
# Deprecated group/name - [DEFAULT]/ssl_cert_file
#cert_file = <None>
# Private key file to use when starting the server securely. (string
# value)
# Deprecated group/name - [DEFAULT]/ssl_key_file
#key_file = <None>
# SSL version to use (valid only if SSL enabled). Valid values are
# TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be
# available on some distributions. (string value)
#version = <None>
# Sets the list of available ciphers. value should be a string in the
# OpenSSL cipher list format. (string value)
#ciphers = <None>
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.