From 4f24132ad413edde3998a2e3284222c4c7aeb0a9 Mon Sep 17 00:00:00 2001 From: Alexey Ovchinnikov Date: Mon, 4 Apr 2016 11:08:39 +0300 Subject: [PATCH] [manila] Config refernce update for Mitaka Change-Id: Ibab8c2f3c73d44213c179bd4b40c0dabd37cc3b7 --- .../source/samples/manila.conf.sample | 1293 ++++++++++++----- .../source/shared-file-systems/log-files.rst | 3 + .../source/shared-file-systems/overview.rst | 5 + 3 files changed, 921 insertions(+), 380 deletions(-) diff --git a/doc/config-reference/source/samples/manila.conf.sample b/doc/config-reference/source/samples/manila.conf.sample index 2e729d6cd5..38cea3383a 100644 --- a/doc/config-reference/source/samples/manila.conf.sample +++ b/doc/config-reference/source/samples/manila.conf.sample @@ -22,8 +22,11 @@ # Top-level directory for maintaining manila's state. (string value) #state_path = /var/lib/manila +# Region name of this node. (string value) +#os_region_name = + # IP address of this host. (string value) -#my_ip = 16.93.118.243 +#my_ip = 16.18.11.16 # The topic scheduler nodes listen on. (string value) #scheduler_topic = manila-scheduler @@ -31,6 +34,9 @@ # The topic share nodes listen on. (string value) #share_topic = manila-share +# The topic data nodes listen on. (string value) +#data_topic = manila-data + # Deploy v1 of the Manila API. This option is deprecated, is not used, # and will be removed in a future release. (boolean value) #enable_v1_api = false @@ -46,7 +52,7 @@ # option with manila.api.contrib.select_extensions. (list value) #osapi_share_ext_list = -# The osapi share extension to load. (multi valued) +# The osapi share extensions to load. (list value) #osapi_share_extension = manila.api.contrib.standard_extensions # The filename to use with sqlite. (string value) @@ -72,9 +78,12 @@ # 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. (string value) -#host = markstur +#host = manila # Availability zone of this node. (string value) #storage_availability_zone = nova @@ -109,8 +118,9 @@ # 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 for connecting to neutron in admin context. (string +# value) +# Deprecated group/name - [DEFAULT]/auth_strategy #auth_strategy = keystone # A list of share backend names to use. These backend names should be @@ -118,46 +128,13 @@ #enabled_share_backends = # Specify list of protocols to be allowed for share creation. -# Available values are '('NFS', 'CIFS', 'GLUSTERFS', 'HDFS')' (list -# value) +# Available values are '('NFS', 'CIFS', 'GLUSTERFS', 'HDFS', +# 'CEPHFS')' (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 -# Info to match when looking for nova in the service catalog. Format -# is separated values of the form: -# :: (string value) -#nova_catalog_info = compute:nova:publicURL - -# Same as nova_catalog_info, but for admin endpoint. (string value) -#nova_catalog_admin_info = compute:nova:adminURL - -# Region name of this node. (string value) -#os_region_name = - -# Location of CA certificates file to use for nova client requests. -# (string value) -#nova_ca_certificates_file = - -# Allow to perform insecure SSL requests to nova. (boolean value) -#nova_api_insecure = false - -# Nova admin username. (string value) -#nova_admin_username = nova - -# Nova admin password. (string value) -#nova_admin_password = - -# Nova admin tenant name. (string value) -#nova_admin_tenant_name = service - -# Identity service URL. (string value) -#nova_admin_auth_url = http://localhost:5000/v2.0 - -# Version of Nova API to be used. (string value) -#nova_api_microversion = 2.10 - # The backend to use for database. (string value) #db_backend = sqlalchemy @@ -187,44 +164,9 @@ # Deprecated group/name - [DEFAULT]/network_api_class #network_api_class = manila.network.neutron.neutron_network_plugin.NeutronNetworkPlugin -# URL for connecting to neutron. (string value) -# Deprecated group/name - [DEFAULT]/neutron_url -#neutron_url = http://127.0.0.1:9696 - -# Timeout value for connecting to neutron in seconds. (integer value) -# Deprecated group/name - [DEFAULT]/neutron_url_timeout -#neutron_url_timeout = 30 - -# Username for connecting to neutron in admin context. (string value) -# Deprecated group/name - [DEFAULT]/neutron_admin_username -#neutron_admin_username = neutron - -# Password for connecting to neutron in admin context. (string value) -# Deprecated group/name - [DEFAULT]/neutron_admin_password -#neutron_admin_password = - -# Project name for connecting to Neutron in admin context. (string +# Region name for connecting to neutron in admin context (string # value) -# Deprecated group/name - [DEFAULT]/neutron_admin_tenant_name -#neutron_admin_project_name = service - -# Auth URL for connecting to neutron in admin context. (string value) -# Deprecated group/name - [DEFAULT]/neutron_admin_auth_url -#neutron_admin_auth_url = http://localhost:5000/v2.0 - -# If set, ignore any SSL validation issues. (boolean value) -# Deprecated group/name - [DEFAULT]/neutron_api_insecure -#neutron_api_insecure = false - -# Auth strategy for connecting to neutron in admin context. (string -# value) -# Deprecated group/name - [DEFAULT]/neutron_auth_strategy -#neutron_auth_strategy = keystone - -# Location of CA certificates file to use for neutron client requests. -# (string value) -# Deprecated group/name - [DEFAULT]/neutron_ca_certificates_file -#neutron_ca_certificates_file = +#region_name = # Default Neutron network that will be used for share server creation. # This opt is used only with class 'NeutronSingleNetworkPlugin'. @@ -253,10 +195,18 @@ # Deprecated group/name - [DEFAULT]/standalone_network_plugin_mask #standalone_network_plugin_mask = +# 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) +# Allowed values: flat, vlan, vxlan, gre +# Deprecated group/name - [DEFAULT]/standalone_network_plugin_network_type +#standalone_network_plugin_network_type = + # 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 (string value) +# Example: 1001 (integer value) # Deprecated group/name - [DEFAULT]/standalone_network_plugin_segmentation_id #standalone_network_plugin_segmentation_id = @@ -310,13 +260,13 @@ # Which filter class names to use for filtering hosts when not # specified in the request. (list value) -#scheduler_default_filters = AvailabilityZoneFilter,CapacityFilter,CapabilitiesFilter,ConsistencyGroupFilter +#scheduler_default_filters = AvailabilityZoneFilter,CapacityFilter,CapabilitiesFilter,ConsistencyGroupFilter,ShareReplicationFilter # Which weigher class names to use for weighing hosts. (list value) #scheduler_default_weighers = CapacityWeigher # Default scheduler driver to use. (string value) -#scheduler_driver = manila.scheduler.filter_scheduler.FilterScheduler +#scheduler_driver = manila.scheduler.drivers.filter.FilterScheduler # Absolute path to scheduler configuration JSON file. (string value) #scheduler_json_config_location = @@ -348,7 +298,9 @@ # IP address for OpenStack Share API to listen on. (string value) #osapi_share_listen = :: -# Port for OpenStack Share API to listen on. (integer value) +# 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) @@ -365,6 +317,13 @@ # Path to main Ganesha config file. (string value) #ganesha_config_path = $ganesha_config_dir/ganesha.conf +# Options to use when exporting a share using ganesha NFS server. Note +# that these defaults can be overridden when a share is created by +# passing metadata with key name export_options. Also note the +# complete set of default ganesha export options is specified in +# ganesha_utils. (GPFS only.) (string value) +#ganesha_nfs_export_options = maxread = 65536, prefread = 65536 + # Name of the ganesha nfs service. (string value) #ganesha_service_name = ganesha.nfsd @@ -415,39 +374,40 @@ # invalid. (floating point value) #max_over_subscription_ratio = 20.0 -# Temporary path to create and mount shares during migration. (string -# value) -#migration_tmp_location = /tmp/ - # 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 -# Time to wait for access rules to be allowed/denied on backends when -# migrating shares using generic approach (seconds). (integer value) -#migration_wait_access_rules_timeout = 90 +# 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 %(export)s %(path)s -# Timeout for creating and deleting share instances when performing -# share migration (seconds). (integer value) -#migration_create_delete_share_timeout = 300 +# 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 -# Backend IP in admin network to use for mounting shares during -# migration. (string value) -#migration_mounting_backend_ip = +# Specify whether read only access rule mode is supported in this +# backend. (boolean value) +# Deprecated group/name - [DEFAULT]/migration_readonly_support +#migration_readonly_rules_support = true -# The IP of the node responsible for copying data during migration, -# such as the data copy service node, reachable by the backend. -# (string value) -#migration_data_copy_node_ip = +# 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 = -# The command for mounting shares for this backend. Must specifythe -# executable and all necessary parameters for the protocol supported. -# It is advisable to separate protocols per backend. (string value) -#migration_protocol_mount_command = - -# Specify whether read only access mode is supported in thisbackend. -# (boolean value) -#migration_readonly_support = true +# 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 = # Backend server SSH connection timeout. (integer value) #ssh_conn_timeout = 60 @@ -462,6 +422,19 @@ # 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 = + +# 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 + # User name for the EMC server. (string value) #emc_nas_login = @@ -471,7 +444,9 @@ # EMC server hostname or IP address. (string value) #emc_nas_server = -# Port number for the EMC server. (integer value) +# 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) @@ -483,8 +458,9 @@ # Container of share servers. (string value) #emc_nas_server_container = server_2 -# EMC pool name. (string value) -#emc_nas_pool_name = +# EMC pool names. (string value) +# Deprecated group/name - [DEFAULT]/emc_nas_pool_name +#emc_nas_pool_names = # The root directory where shares will be located. (string value) #emc_nas_root_dir = @@ -515,7 +491,7 @@ #service_instance_smb_config_path = $share_mount_path/smb.conf # Specify list of share export helpers. (list value) -#share_helpers = CIFS=manila.share.drivers.generic.CIFSHelper,NFS=manila.share.drivers.generic.NFSHelper +#share_helpers = CIFS=manila.share.drivers.helpers.CIFSHelperIPAccess,NFS=manila.share.drivers.helpers.NFSHelper # Filesystem type of the share volume. (string value) # Allowed values: ext4, ext3 @@ -525,6 +501,15 @@ # created by driver. (string value) #cinder_volume_type = +# 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 = + +# 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 = + # Type of NFS server that mediate access to the Gluster volumes # (Gluster or Ganesha). (string value) #glusterfs_nfs_server_type = Gluster @@ -551,13 +536,6 @@ # value) #glusterfs_mount_point_base = $state_path/mnt -# Remote GlusterFS server node's login password. This is not required -# if 'glusterfs_path_to_private_key' is configured. (string value) -#glusterfs_server_password = - -# Path of Manila host's private SSH key file. (string value) -#glusterfs_path_to_private_key = - # List of GlusterFS servers that can be used to create shares. Each # GlusterFS server should be of the form [remoteuser@], and # they are assumed to belong to distinct Gluster clusters. (list @@ -565,14 +543,6 @@ # Deprecated group/name - [DEFAULT]/glusterfs_targets #glusterfs_servers = -# Remote GlusterFS server node's login password. This is not required -# if 'glusterfs_native_path_to_private_key' is configured. (string -# value) -#glusterfs_native_server_password = - -# Path of Manila host's private SSH key file. (string value) -#glusterfs_native_path_to_private_key = - # 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 @@ -588,10 +558,14 @@ # The IP of the HDFS namenode. (string value) #hdfs_namenode_ip = -# The port of HDFS namenode service. (integer value) +# The port of HDFS namenode service. (port value) +# Minimum value: 0 +# Maximum value: 65535 #hdfs_namenode_port = 9000 -# HDFS namenode SSH port. (integer value) +# HDFS namenode SSH port. (port value) +# Minimum value: 0 +# Maximum value: 65535 #hdfs_ssh_port = 22 # HDFS namenode ssh login name. (string value) @@ -616,7 +590,7 @@ # (string value) #hds_hnas_password = -# Specify which EVS this backend is assigned to. (string value) +# Specify which EVS this backend is assigned to. (integer value) #hds_hnas_evs_id = # Specify IP for mounting shares. (string value) @@ -637,44 +611,118 @@ # (integer value) #hds_hnas_stalled_job_timeout = 30 +# Python class to be used for driver helper. (string value) +#hds_hnas_driver_helper = manila.share.drivers.hitachi.ssh.HNASSSHBackend + # 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1 (string # value) -#hp3par_api_url = +# Deprecated group/name - [DEFAULT]/hp3par_api_url +#hpe3par_api_url = # 3PAR username with the 'edit' role (string value) -#hp3par_username = +# Deprecated group/name - [DEFAULT]/hp3par_username +#hpe3par_username = -# 3PAR password for the user specified in hp3par_username (string +# 3PAR password for the user specified in hpe3par_username (string # value) -#hp3par_password = +# Deprecated group/name - [DEFAULT]/hp3par_password +#hpe3par_password = # IP address of SAN controller (string value) -#hp3par_san_ip = +# Deprecated group/name - [DEFAULT]/hp3par_san_ip +#hpe3par_san_ip = # Username for SAN controller (string value) -#hp3par_san_login = +# Deprecated group/name - [DEFAULT]/hp3par_san_login +#hpe3par_san_login = # Password for SAN controller (string value) -#hp3par_san_password = +# Deprecated group/name - [DEFAULT]/hp3par_san_password +#hpe3par_san_password = -# SSH port to use with SAN (integer value) -#hp3par_san_ssh_port = 22 +# 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 (string value) -#hp3par_fpg = OpenStack +# Deprecated group/name - [DEFAULT]/hp3par_fpg +#hpe3par_fpg = OpenStack # The IP address for shares not using a share server (string value) -#hp3par_share_ip_address = +# Deprecated group/name - [DEFAULT]/hp3par_share_ip_address +#hpe3par_share_ip_address = # Use one filestore per share (boolean value) -#hp3par_fstore_per_share = false +# 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) -#hp3par_debug = false +# 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. (string value) +#gpfs_share_export_ip = + +# Base folder where exported shares are located. (string value) +#gpfs_mount_point_base = $state_path/mnt + +# NFS Server type. Valid choices are "KNFS" (kernel NFS) or "GNFS" +# (Ganesha NFS). (string value) +#gpfs_nfs_server_type = KNFS + +# A list of the fully qualified NFS server names that make up the +# OpenStack Manila configuration. (list value) +#gpfs_nfs_server_list = + +# 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 = + +# GPFS server SSH login password. The password is not needed, if +# 'gpfs_ssh_private_key' is configured. (string value) +#gpfs_ssh_password = + +# Path to GPFS server SSH private key for login. (string value) +#gpfs_ssh_private_key = + +# Specify list of share export helpers. (list value) +#gpfs_share_helpers = KNFS=manila.share.drivers.ibm.gpfs.KNFSHelper,GNFS=manila.share.drivers.ibm.gpfs.GNFSHelper + +# 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) +#knfs_export_options = rw,sync,no_root_squash,insecure,no_wdelay,no_subtree_check + # 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 @@ -685,7 +733,9 @@ # 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. (integer value) +# HTTP and 443 for HTTPS. (port value) +# Minimum value: 0 +# Maximum value: 65535 #netapp_server_port = # The transport protocol used when communicating with the storage @@ -731,6 +781,18 @@ # 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 + # URL of the Quobyte API server (http or https) (string value) #quobyte_api_url = @@ -763,7 +825,7 @@ #service_instance_password = # Path to host's private key. (string value) -#path_to_private_key = ~/.ssh/id_rsa +#path_to_private_key = # Maximum time in seconds to wait for creating service instance. # (integer value) @@ -786,51 +848,78 @@ #tenant_net_name_or_ip = # Name of image in Glance, that will be used for service instance -# creation. (string value) +# creation. Only used if driver_handles_share_servers=True. (string +# value) #service_image_name = manila-service-image -# Name of service instance. (string value) +# 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. -# (string value) +# Only used if driver_handles_share_servers=True. (string value) #manila_service_keypair_name = manila-service -# Path to hosts public key. (string value) +# 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. (string value) +# 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. -# (integer value) +# 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. (string -# value) +# 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. (string -# value) +# 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. -# (integer value) +# 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. (string value) +# 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. (boolean value) +# Neutron and if driver_handles_share_servers=True. (boolean value) #connect_share_server_to_tenant_network = false -# Allowed values are ['nova', 'neutron']. (string value) +# Allowed values are ['nova', 'neutron']. Only used if +# driver_handles_share_servers=True. (string value) #service_instance_network_helper_type = neutron +# ID of neutron network used to communicate with admin network, to +# create additional admin export locations on. (string value) +#admin_network_id = + +# 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 = + +# Tegile NAS server hostname or IP address. (string value) +#tegile_nas_server = + +# User name for the Tegile NAS server. (string value) +#tegile_nas_login = + +# Password for the Tegile NAS server. (string value) +#tegile_nas_password = + +# Create shares in this project (string value) +#tegile_default_project = + # Path to the x509 certificate used for accessing the serviceinstance. # (string value) #winrm_cert_pem_path = ~/.ssl/cert.pem @@ -854,6 +943,65 @@ # WinRM retry interval in seconds (integer value) #winrm_retry_interval = 5 +# IP to be added to user-facing export location. Required. (string +# value) +#zfs_share_export_ip = + +# IP to be added to admin-facing export location. Required. (string +# value) +#zfs_service_ip = + +# 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 = + +# 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 = + +# 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 = + +# 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 = + +# 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 = + +# 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_ + # ZFSSA management IP address. (string value) #zfssa_host = @@ -956,42 +1104,22 @@ # Deprecated group/name - [DEFAULT]/unused_share_server_cleanup_interval #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 + # The full class name of the Volume API class to use. (string value) #volume_api_class = manila.volume.cinder.API -# Info to match when looking for cinder in the service catalog. Format -# is separated values of the form: -# :: (string value) -#cinder_catalog_info = volume:cinder:publicURL - -# Region name of this node. (string value) -#os_region_name = - -# Location of CA certificates file to use for cinder client requests. -# (string value) -#cinder_ca_certificates_file = - -# Number of cinderclient retries on failed HTTP calls. (integer value) -#cinder_http_retries = 3 - -# Allow to perform insecure SSL requests to cinder. (boolean value) -#cinder_api_insecure = false - # Allow attaching between instances and volumes in different # availability zones. (boolean value) -#cinder_cross_az_attach = true +# Deprecated group/name - [DEFAULT]/cinder_cross_az_attach +#cross_az_attach = true -# Cinder admin username. (string value) -#cinder_admin_username = cinder - -# Cinder admin password. (string value) -#cinder_admin_password = - -# Cinder admin tenant name. (string value) -#cinder_admin_tenant_name = service - -# Identity service URL. (string value) -#cinder_admin_auth_url = http://localhost:5000/v2.0 +# Number of cinderclient retries on failed HTTP calls. (integer value) +# Deprecated group/name - [DEFAULT]/cinder_http_retries +#http_retries = 3 # Maximum line size of message headers to be accepted. Option # max_header_line may need to be increased when using large tokens @@ -1041,16 +1169,12 @@ # value) #ssl_key_file = -# -# From manila -# - -# Print debugging output (set logging level to DEBUG instead of -# default INFO level). (boolean value) +# If set to true, the logging level will be set to DEBUG instead of +# the default INFO level. (boolean value) #debug = false -# If set to false, will disable INFO logging level, making WARNING the -# default. (boolean value) +# If set to false, the logging level will be set to WARNING instead of +# the default INFO level. (boolean value) # This option is deprecated for removal. # Its value may be silently ignored in the future. #verbose = true @@ -1058,59 +1182,71 @@ # 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. -# (string value) +# 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) # Deprecated group/name - [DEFAULT]/log_config #log_config_append = -# Format string for %%(asctime)s in log records. Default: %(default)s -# . (string value) +# 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 output to. If no default is set, -# logging will go to stdout. (string value) +# (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 = -# (Optional) The base directory used for relative --log-file paths. -# (string value) +# (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 = +# 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. (boolean value) +# will be changed later to honor RFC5424. This option is ignored if +# log_config_append is set. (boolean value) #use_syslog = false -# (Optional) Enables or disables syslog rfc5424 format for logging. If -# enabled, prefixes the MSG part of the syslog message with APP-NAME -# (RFC5424). The format without the APP-NAME is deprecated in Kilo, -# and will be removed in Mitaka, along with this option. (boolean -# value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#use_syslog_rfc_format = true - -# Syslog facility to receive log lines. (string value) +# Syslog facility to receive log lines. This option is ignored if +# log_config_append is set. (string value) #syslog_log_facility = LOG_USER -# Log output to standard error. (boolean value) +# Log output to standard error. This option is ignored if +# log_config_append is set. (boolean value) #use_stderr = true # 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 without context. (string -# value) +# 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 -# Data to append to log format when level is DEBUG. (string value) +# 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 -# List of logger=LEVEL pairs. (list value) -#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN +# 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,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 @@ -1140,10 +1276,12 @@ #rpc_zmq_bind_address = * # MatchMaker driver. (string value) -#rpc_zmq_matchmaker = local +# Allowed values: redis, dummy +#rpc_zmq_matchmaker = redis -# ZeroMQ receiver listening port. (integer value) -#rpc_zmq_port = 9501 +# Type of concurrency used. Either "native" or "eventlet" (string +# value) +#rpc_zmq_concurrency = eventlet # Number of ZeroMQ contexts, defaults to 1. (integer value) #rpc_zmq_contexts = 1 @@ -1159,28 +1297,42 @@ # Must match "host" option, if running Nova. (string value) #rpc_zmq_host = localhost -# Seconds to wait before a cast expires (TTL). Only supported by -# impl_zmq. (integer value) -#rpc_cast_timeout = 30 +# Seconds to wait before a cast expires (TTL). 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. Only supported by impl_zmq. (integer value) +#rpc_cast_timeout = -1 -# Heartbeat frequency. (integer value) -#matchmaker_heartbeat_freq = 300 +# The default number of seconds that poll should wait. Poll raises +# timeout exception when timeout expired. (integer value) +#rpc_poll_timeout = 1 -# Heartbeat time-to-live. (integer value) -#matchmaker_heartbeat_ttl = 600 +# Expiration timeout in seconds of a name service record about +# existing target ( < 0 means no timeout). (integer value) +#zmq_target_expire = 120 + +# Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. +# (boolean value) +#use_pub_sub = true + +# Minimal port number for random ports range. (port value) +# Minimum value: 0 +# Maximum value: 65535 +#rpc_zmq_min_port = 49152 + +# 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 # Size of executor thread pool. (integer value) # Deprecated group/name - [DEFAULT]/rpc_thread_pool_size #executor_thread_pool_size = 64 -# The Drivers(s) to handle sending notifications. Possible values are -# messaging, messagingv2, routing, log, test, noop (multi valued) -#notification_driver = - -# AMQP topic used for OpenStack notifications. (list value) -# Deprecated group/name - [rpc_notifier2]/topics -#notification_topics = notifications - # Seconds to wait for a response from a call. (integer value) #rpc_response_timeout = 60 @@ -1190,7 +1342,7 @@ #transport_url = # The messaging driver to use, defaults to rabbit. Other drivers -# include qpid and zmq. (string value) +# include amqp and zmq. (string value) #rpc_backend = rabbit # The default exchange under which topics are scoped. May be @@ -1199,6 +1351,94 @@ #control_exchange = openstack +[cinder] + +# +# From manila +# + +# Allow to perform insecure SSL requests to cinder. (boolean value) +# Deprecated group/name - [DEFAULT]/cinder_api_insecure +#api_insecure = false + +# Authentication URL (unknown value) +#auth_url = + +# Authentication type to load (unknown value) +# Deprecated group/name - [DEFAULT]/auth_plugin +#auth_type = + +# Location of CA certificates file to use for cinder client requests. +# (string value) +# Deprecated group/name - [DEFAULT]/cinder_ca_certificates_file +#ca_certificates_file = + +# PEM encoded Certificate Authority to use when verifying HTTPs +# connections. (string value) +#cafile = + +# PEM encoded client certificate cert file (string value) +#certfile = + +# 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. (unknown value) +#default_domain_id = + +# 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. (unknown value) +#default_domain_name = + +# Domain ID to scope to (unknown value) +#domain_id = + +# Domain name to scope to (unknown value) +#domain_name = + +# Verify HTTPS connections. (boolean value) +#insecure = false + +# PEM encoded client certificate key file (string value) +#keyfile = + +# User's password (unknown value) +#password = + +# Domain ID containing project (unknown value) +#project_domain_id = + +# Domain name containing project (unknown value) +#project_domain_name = + +# Project ID to scope to (unknown value) +# Deprecated group/name - [DEFAULT]/tenant-id +#project_id = + +# Project name to scope to (unknown value) +# Deprecated group/name - [DEFAULT]/tenant-name +#project_name = + +# Timeout value for http requests (integer value) +#timeout = + +# Trust ID (unknown value) +#trust_id = + +# User's domain id (unknown value) +#user_domain_id = + +# User's domain name (unknown value) +#user_domain_name = + +# User id (unknown value) +#user_id = + +# Username (unknown value) +# Deprecated group/name - [DEFAULT]/username +#username = + + [cors] # @@ -1206,7 +1446,7 @@ # # Indicate whether this resource may be shared with the domain -# received in the requests "origin" header. (string value) +# received in the requests "origin" header. (list value) #allowed_origin = # Indicate that the actual request can include user credentials @@ -1228,6 +1468,33 @@ # request. (list value) #allow_headers = Content-Type,Cache-Control,Content-Language,Expires,Last-Modified,Pragma +# +# From oslo.middleware.cors +# + +# Indicate whether this resource may be shared with the domain +# received in the requests "origin" header. (list value) +#allowed_origin = + +# 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 + [cors.subdomain] @@ -1236,7 +1503,7 @@ # # Indicate whether this resource may be shared with the domain -# received in the requests "origin" header. (string value) +# received in the requests "origin" header. (list value) #allowed_origin = # Indicate that the actual request can include user credentials @@ -1258,6 +1525,33 @@ # request. (list value) #allow_headers = Content-Type,Cache-Control,Content-Language,Expires,Last-Modified,Pragma +# +# From oslo.middleware.cors +# + +# Indicate whether this resource may be shared with the domain +# received in the requests "origin" header. (list value) +#allowed_origin = + +# 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] @@ -1328,7 +1622,7 @@ # value) # Deprecated group/name - [DEFAULT]/sql_max_overflow # Deprecated group/name - [DATABASE]/sqlalchemy_max_overflow -#max_overflow = +#max_overflow = 50 # Verbosity of SQL debugging information: 0=None, 100=Everything. # (integer value) @@ -1442,12 +1736,13 @@ #revocation_cache_time = 10 # (Optional) If defined, indicate whether token data should be -# authenticated or authenticated and encrypted. Acceptable values are -# MAC or ENCRYPT. 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) -#memcache_security_strategy = +# 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) +# Allowed values: None, MAC, ENCRYPT +#memcache_security_strategy = None # (Optional, mandatory if memcache_security_strategy is defined) This # string is used for key derivation. (string value) @@ -1508,42 +1803,13 @@ # value) #hash_algorithms = md5 -# Prefix to prepend at the beginning of the path. Deprecated, use -# identity_uri. (string value) -#auth_admin_prefix = +# Authentication type to load (unknown value) +# Deprecated group/name - [DEFAULT]/auth_plugin +#auth_type = -# Host providing the admin Identity API endpoint. Deprecated, use -# identity_uri. (string value) -#auth_host = 127.0.0.1 - -# Port of the admin Identity API endpoint. Deprecated, use -# identity_uri. (integer value) -#auth_port = 35357 - -# Protocol of the admin Identity API endpoint (http or https). -# Deprecated, use identity_uri. (string value) -#auth_protocol = https - -# Complete admin Identity API endpoint. This should specify the -# unversioned root endpoint e.g. https://localhost:35357/ (string +# Config Section from which to load plugin specific options (unknown # value) -#identity_uri = - -# This option is deprecated and may be removed in a future release. -# Single shared secret with the Keystone configuration used for -# bootstrapping a Keystone installation, or otherwise bypassing the -# normal authentication process. This option should not be used, use -# `admin_user` and `admin_password` instead. (string value) -#admin_token = - -# Service username. (string value) -#admin_user = - -# Service user password. (string value) -#admin_password = - -# Service tenant name. (string value) -#admin_tenant_name = admin +#auth_section = [matchmaker_redis] @@ -1555,22 +1821,199 @@ # Host to locate redis. (string value) #host = 127.0.0.1 -# Use this port to connect to redis host. (integer value) +# Use this port to connect to redis host. (port value) +# Minimum value: 0 +# Maximum value: 65535 #port = 6379 # Password for Redis server (optional). (string value) +#password = + +# List of Redis Sentinel hosts (fault tolerance mode) e.g. +# [host:port, host1:port ... ] (list value) +#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 = 500 + +# 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 = 1000 + + +[neutron] + +# +# From manila +# + +# Authentication URL (unknown value) +#auth_url = + +# Authentication type to load (unknown value) +# Deprecated group/name - [DEFAULT]/auth_plugin +#auth_type = + +# PEM encoded Certificate Authority to use when verifying HTTPs +# connections. (string value) +#cafile = + +# PEM encoded client certificate cert file (string value) +#certfile = + +# 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. (unknown value) +#default_domain_id = + +# 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. (unknown value) +#default_domain_name = + +# Domain ID to scope to (unknown value) +#domain_id = + +# Domain name to scope to (unknown value) +#domain_name = + +# Verify HTTPS connections. (boolean value) +#insecure = false + +# PEM encoded client certificate key file (string value) +#keyfile = + +# User's password (unknown value) #password = +# Domain ID containing project (unknown value) +#project_domain_id = -[matchmaker_ring] +# Domain name containing project (unknown value) +#project_domain_name = + +# Project ID to scope to (unknown value) +# Deprecated group/name - [DEFAULT]/tenant-id +#project_id = + +# Project name to scope to (unknown value) +# Deprecated group/name - [DEFAULT]/tenant-name +#project_name = + +# Timeout value for http requests (integer value) +#timeout = + +# Trust ID (unknown value) +#trust_id = + +# 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 + +# User's domain id (unknown value) +#user_domain_id = + +# User's domain name (unknown value) +#user_domain_name = + +# User id (unknown value) +#user_id = + +# Username (unknown value) +# Deprecated group/name - [DEFAULT]/username +#username = + + +[nova] # -# From oslo.messaging +# From manila # -# Matchmaker ring file (JSON). (string value) -# Deprecated group/name - [DEFAULT]/matchmaker_ringfile -#ringfile = /etc/oslo/matchmaker_ring.json +# Version of Nova API to be used. (string value) +# Deprecated group/name - [DEFAULT]/nova_api_microversion +#api_microversion = 2.10 + +# Authentication URL (unknown value) +#auth_url = + +# Authentication type to load (unknown value) +# Deprecated group/name - [DEFAULT]/auth_plugin +#auth_type = + +# PEM encoded Certificate Authority to use when verifying HTTPs +# connections. (string value) +#cafile = + +# PEM encoded client certificate cert file (string value) +#certfile = + +# 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. (unknown value) +#default_domain_id = + +# 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. (unknown value) +#default_domain_name = + +# Domain ID to scope to (unknown value) +#domain_id = + +# Domain name to scope to (unknown value) +#domain_name = + +# Verify HTTPS connections. (boolean value) +#insecure = false + +# PEM encoded client certificate key file (string value) +#keyfile = + +# User's password (unknown value) +#password = + +# Domain ID containing project (unknown value) +#project_domain_id = + +# Domain name containing project (unknown value) +#project_domain_name = + +# Project ID to scope to (unknown value) +# Deprecated group/name - [DEFAULT]/tenant-id +#project_id = + +# Project name to scope to (unknown value) +# Deprecated group/name - [DEFAULT]/tenant-name +#project_name = + +# Timeout value for http requests (integer value) +#timeout = + +# Trust ID (unknown value) +#trust_id = + +# User's domain id (unknown value) +#user_domain_id = + +# User's domain name (unknown value) +#user_domain_name = + +# User id (unknown value) +#user_id = + +# Username (unknown value) +# Deprecated group/name - [DEFAULT]/username +#username = [oslo_concurrency] @@ -1643,81 +2086,49 @@ # Deprecated group/name - [amqp1]/allow_insecure_clients #allow_insecure_clients = false +# Space separated list of acceptable SASL mechanisms (string value) +# Deprecated group/name - [amqp1]/sasl_mechanisms +#sasl_mechanisms = -[oslo_messaging_qpid] +# Path to directory that contains the SASL configuration (string +# value) +# Deprecated group/name - [amqp1]/sasl_config_dir +#sasl_config_dir = + +# Name of configuration file (without .conf suffix) (string value) +# Deprecated group/name - [amqp1]/sasl_config_name +#sasl_config_name = + +# User name for message broker authentication (string value) +# Deprecated group/name - [amqp1]/username +#username = + +# Password for message broker authentication (string value) +# Deprecated group/name - [amqp1]/password +#password = + + +[oslo_messaging_notifications] # # 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 +# 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 = -# Auto-delete queues in AMQP. (boolean value) -# Deprecated group/name - [DEFAULT]/amqp_auto_delete -#amqp_auto_delete = false +# 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 = -# Send a single AMQP reply to call message. The current behaviour -# since oslo-incubator is to send two AMQP replies - first one with -# the payload, a second one to ensure the other have finish to send -# the payload. We are going to remove it in the N release, but we must -# keep backward compatible at the same time. This option provides such -# compatibility - it defaults to False in Liberty and can be turned on -# for early adopters with a new installations or for testing. Please -# note, that this option will be removed in the Mitaka release. -# (boolean value) -#send_single_reply = false - -# Qpid broker hostname. (string value) -# Deprecated group/name - [DEFAULT]/qpid_hostname -#qpid_hostname = localhost - -# Qpid broker port. (integer value) -# Deprecated group/name - [DEFAULT]/qpid_port -#qpid_port = 5672 - -# Qpid HA cluster host:port pairs. (list value) -# Deprecated group/name - [DEFAULT]/qpid_hosts -#qpid_hosts = $qpid_hostname:$qpid_port - -# Username for Qpid connection. (string value) -# Deprecated group/name - [DEFAULT]/qpid_username -#qpid_username = - -# Password for Qpid connection. (string value) -# Deprecated group/name - [DEFAULT]/qpid_password -#qpid_password = - -# Space separated list of SASL mechanisms to use for auth. (string -# value) -# Deprecated group/name - [DEFAULT]/qpid_sasl_mechanisms -#qpid_sasl_mechanisms = - -# Seconds between connection keepalive heartbeats. (integer value) -# Deprecated group/name - [DEFAULT]/qpid_heartbeat -#qpid_heartbeat = 60 - -# Transport to use, either 'tcp' or 'ssl'. (string value) -# Deprecated group/name - [DEFAULT]/qpid_protocol -#qpid_protocol = tcp - -# Whether to disable the Nagle algorithm. (boolean value) -# Deprecated group/name - [DEFAULT]/qpid_tcp_nodelay -#qpid_tcp_nodelay = true - -# The number of prefetched messages held by receiver. (integer value) -# Deprecated group/name - [DEFAULT]/qpid_receiver_capacity -#qpid_receiver_capacity = 1 - -# The qpid topology version to use. Version 1 is what was originally -# used by impl_qpid. Version 2 includes some backwards-incompatible -# changes that allow broker federation to work. Users should update -# to version 2 when they are able to take everything down, as it -# requires a clean break. (integer value) -# Deprecated group/name - [DEFAULT]/qpid_topology_version -#qpid_topology_version = 1 +# AMQP topic used for OpenStack notifications. (list value) +# Deprecated group/name - [rpc_notifier2]/topics +# Deprecated group/name - [DEFAULT]/notification_topics +#topics = notifications [oslo_messaging_rabbit] @@ -1735,17 +2146,6 @@ # Deprecated group/name - [DEFAULT]/amqp_auto_delete #amqp_auto_delete = false -# Send a single AMQP reply to call message. The current behaviour -# since oslo-incubator is to send two AMQP replies - first one with -# the payload, a second one to ensure the other have finish to send -# the payload. We are going to remove it in the N release, but we must -# keep backward compatible at the same time. This option provides such -# compatibility - it defaults to False in Liberty and can be turned on -# for early adopters with a new installations or for testing. Please -# note, that this option will be removed in the Mitaka release. -# (boolean value) -#send_single_reply = false - # 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) @@ -1770,18 +2170,31 @@ # Deprecated group/name - [DEFAULT]/kombu_reconnect_delay #kombu_reconnect_delay = 1.0 -# How long to wait before considering a reconnect attempt to have -# failed. This value should not be longer than rpc_response_timeout. +# EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression +# will not be used. This option may notbe available in future +# versions. (string value) +#kombu_compression = + +# How long to wait a missing client beforce abandoning to send it its +# replies. This value should not be longer than rpc_response_timeout. # (integer value) -#kombu_reconnect_timeout = 60 +# Deprecated group/name - [DEFAULT]/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) +# Allowed values: round-robin, shuffle +#kombu_failover_strategy = round-robin # The RabbitMQ broker address where a single node is used. (string # value) # Deprecated group/name - [DEFAULT]/rabbit_host #rabbit_host = localhost -# The RabbitMQ broker port where a single node is used. (integer -# value) +# The RabbitMQ broker port where a single node is used. (port value) +# Minimum value: 0 +# Maximum value: 65535 # Deprecated group/name - [DEFAULT]/rabbit_port #rabbit_port = 5672 @@ -1817,16 +2230,36 @@ # Deprecated group/name - [DEFAULT]/rabbit_retry_backoff #rabbit_retry_backoff = 2 +# Maximum interval of RabbitMQ connection retries. Default is 30 +# seconds. (integer value) +#rabbit_interval_max = 30 + # Maximum number of RabbitMQ connection retries. Default is 0 # (infinite retry count). (integer value) # Deprecated group/name - [DEFAULT]/rabbit_max_retries #rabbit_max_retries = 0 -# Use HA queues in RabbitMQ (x-ha-policy: all). If you change this -# option, you must wipe the RabbitMQ database. (boolean value) +# 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) # Deprecated group/name - [DEFAULT]/rabbit_ha_queues #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) @@ -1841,6 +2274,110 @@ # Deprecated group/name - [DEFAULT]/fake_rabbit #fake_rabbit = false +# Maximum number of channels to allow (integer value) +#channel_max = + +# The maximum byte size for an AMQP frame (integer value) +#frame_max = + +# How often to send heartbeats for consumer's connections (integer +# value) +#heartbeat_interval = 1 + +# Enable SSL (boolean value) +#ssl = + +# Arguments passed to ssl.wrap_socket (dict value) +#ssl_options = + +# 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 + +# Maximum number of connections to keep queued. (integer value) +#pool_max_size = 10 + +# 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 + +# Persist notification messages. (boolean value) +#notification_persistence = false + +# Exchange name for 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 then 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_middleware] @@ -1853,13 +2390,11 @@ # Deprecated group/name - [DEFAULT]/max_request_body_size #max_request_body_size = 114688 -# -# From manila -# - # The HTTP Header that will be used to determine what the original # request protocol scheme was, even if it was hidden by an SSL # termination proxy. (string value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. #secure_proxy_ssl_header = X-Forwarded-Proto @@ -1884,6 +2419,4 @@ # policy_file must exist for these directories to be searched. # Missing or empty directories are ignored. (multi valued) # Deprecated group/name - [DEFAULT]/policy_dirs -# This option is deprecated for removal. -# Its value may be silently ignored in the future. #policy_dirs = policy.d diff --git a/doc/config-reference/source/shared-file-systems/log-files.rst b/doc/config-reference/source/shared-file-systems/log-files.rst index 798ab9d29c..6dbed9f8a4 100644 --- a/doc/config-reference/source/shared-file-systems/log-files.rst +++ b/doc/config-reference/source/shared-file-systems/log-files.rst @@ -25,3 +25,6 @@ runs. * - ``share.log`` - ``openstack-manila-share`` - ``manila-share`` + * - ``data.log`` + - ``openstack-manila-data`` + - ``manila-data`` diff --git a/doc/config-reference/source/shared-file-systems/overview.rst b/doc/config-reference/source/shared-file-systems/overview.rst index 88f47da271..f7139d3280 100644 --- a/doc/config-reference/source/shared-file-systems/overview.rst +++ b/doc/config-reference/source/shared-file-systems/overview.rst @@ -12,6 +12,11 @@ manila-api throughout the Shared File Systems service. It supports the OpenStack APIs. +manila-data + A standalone service whose purpose is to receive requests, process data + operations with potentially long running time such as copying, share + migration or backup. + manila-scheduler Schedules and routes requests to the appropriate share service. The scheduler uses configurable filters and weighers