openstack/openstack-manuals
Code Issues Proposed changes

[config-ref] Update manila tables

Browse Source 
Change-Id: Ib86c655941dc3f2771555b33d36059deac007495
This commit is contained in:
venkatamahesh 2016-09-03 17:15:21 +05:30
parent 44e31bf4f6
commit 48b0aee3cd
18 changed files with 243 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/config-reference/source/tables/manila-amqp.rst
View File

@ -21,4 +21,4 @@
* - ``control_exchange`` = ``openstack``
- (String) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
* - ``transport_url`` = ``None``
- (String) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.
- (String) A URL representing the messaging driver to use and its full configuration.

8
doc/config-reference/source/tables/manila-api.rst
View File

@ -30,10 +30,6 @@
- (Boolean) Whether to rate limit the API.
* - ``db_backend`` = ``sqlalchemy``
- (String) The backend to use for database.
* - ``enable_v1_api`` = ``False``
- (Boolean) Deploy v1 of the Manila API. This option is deprecated, is not used, and will be removed in a future release.
* - ``enable_v2_api`` = ``False``
- (Boolean) Deploy v2 of the Manila API. This option is deprecated, is not used, and will be removed in a future release.
* - ``max_header_line`` = ``16384``
- (Integer) Maximum line size of message headers to be accepted. Option max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
* - ``osapi_max_limit`` = ``1000``
@ -60,7 +56,9 @@
- (String) Volume snapshot name template.
* - **[oslo_middleware]**
-
* - ``enable_proxy_headers_parsing`` = ``False``
- (Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.
* - ``max_request_body_size`` = ``114688``
- (Integer) The maximum body size for each request, in bytes.
* - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto``
- (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.
- (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.

14
doc/config-reference/source/tables/manila-common.rst
View File

@ -18,6 +18,8 @@
- Description
* - **[DEFAULT]**
-
* - ``check_hash`` = ``False``
- (Boolean) Chooses whether hash of each file should be checked on data copying.
* - ``client_socket_timeout`` = ``900``
- (Integer) Timeout for client connections socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.
* - ``compute_api_class`` = ``manila.compute.nova.API``
@ -26,17 +28,23 @@
- (Integer) Time to wait for access rules to be allowed/denied on backends when migrating a share (seconds).
* - ``data_manager`` = ``manila.data.manager.DataManager``
- (String) Full class name for the data manager.
* - ``data_node_access_admin_user`` = ``None``
- (String) The admin user name registered in the security service in order to allow access to user authentication-based shares.
* - ``data_node_access_cert`` = ``None``
- (String) The certificate installed in the data node in order to allow access to certificate authentication-based shares.
* - ``data_node_access_ip`` = ``None``
- (String) The IP of the node interface connected to the admin network. Used for allowing access to the mounting shares.
* - ``data_node_mount_options`` = ``{}``
- (Dict) 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'}
* - ``data_topic`` = ``manila-data``
- (String) The topic data nodes listen on.
* - ``enable_new_services`` = ``True``
- (Boolean) Services to be added to the available pool on create.
* - ``fatal_exception_format_errors`` = ``False``
- (Boolean) Whether to make exception message format errors fatal.
* - ``host`` = ``localhost``
* - ``filter_function`` = ``None``
- (String) String representation for an equation that will be used to filter hosts.
* - ``host`` = ``<your_hostname>``
- (String) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.
* - ``max_over_subscription_ratio`` = ``20.0``
- (Floating point) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 is invalid.
@ -46,7 +54,9 @@
- (Boolean) Whether to log monkey patching.
* - ``monkey_patch_modules`` =
- (List) List of modules or decorators to monkey patch.
* - ``my_ip`` = ``10.0.0.1``
* - ``mount_tmp_location`` = ``/tmp/``
- (String) Temporary path to create and mount shares during migration.
* - ``my_ip`` = ``<your_ip>``
- (String) IP address of this host.
* - ``num_shell_tries`` = ``3``
- (Integer) Number of times to attempt to run flakey shell commands.

8
doc/config-reference/source/tables/manila-emc.rst
View File

@ -18,18 +18,22 @@
- Description
* - **[DEFAULT]**
-
* - ``emc_interface_ports`` = ``None``
- (List) Comma separated list specifying the ports that can be used for share server interfaces. Members of the list can be Unix-style glob expressions.
* - ``emc_nas_login`` = ``None``
- (String) User name for the EMC server.
* - ``emc_nas_password`` = ``None``
- (String) Password for the EMC server.
* - ``emc_nas_pool_names`` = ``None``
- (String) EMC pool names.
- (List) EMC pool names.
* - ``emc_nas_root_dir`` = ``None``
- (String) The root directory where shares will be located.
* - ``emc_nas_server`` = ``None``
- (String) EMC server hostname or IP address.
* - ``emc_nas_server_container`` = ``server_2``
* - ``emc_nas_server_container`` = ``None``
- (String) Container of share servers.
* - ``emc_nas_server_pool`` = ``None``
- (String) Pool to persist the meta-data of NAS server.
* - ``emc_nas_server_port`` = ``8080``
- (Port number) Port number for the EMC server.
* - ``emc_nas_server_secure`` = ``True``

8
doc/config-reference/source/tables/manila-generic.rst
View File

@ -32,8 +32,12 @@
- (String) Name or id of cinder volume type which will be used for all volumes created by driver.
* - ``connect_share_server_to_tenant_network`` = ``False``
- (Boolean) Attach share server directly to share network. Used only with Neutron and if driver_handles_share_servers=True.
* - ``container_volume_group`` = ``manila_docker_volumes``
- (String) LVM volume group to use for volumes. This volume group must be created by the cloud administrator independently from manila operations.
* - ``driver_handles_share_servers`` = ``None``
- (Boolean) There are two possible approaches for share drivers in Manila. First is when share driver is able to handle share-servers and second when not. Drivers can support either both or only one of these approaches. So, set this opt to True if share driver is able to handle share servers and it is desired mode else set False. It is set to None by default to make this choice intentional.
* - ``goodness_function`` = ``None``
- (String) String representation for an equation that will be used to determine the goodness of a host.
* - ``interface_driver`` = ``manila.network.linux.interface.OVSInterfaceDriver``
- (String) Vif driver. Used only with Neutron and if driver_handles_share_servers=True.
* - ``manila_service_keypair_name`` = ``manila-service``
@ -52,6 +56,8 @@
- (String) Path to host's private key.
* - ``path_to_public_key`` = ``~/.ssh/id_rsa.pub``
- (String) Path to hosts public key. Only used if driver_handles_share_servers=True.
* - ``protocol_access_mapping`` = ``{'ip': ['nfs'], 'user': ['cifs']}``
- (Dict) Protocol access mapping for this backend. Should be a dictionary comprised of {'access_type1': ['share_proto1', 'share_proto2'], 'access_type2': ['share_proto2', 'share_proto3']}.
* - ``service_image_name`` = ``manila-service-image``
- (String) Name of image in Glance, that will be used for service instance creation. Only used if driver_handles_share_servers=True.
* - ``service_instance_flavor_id`` = ``100``
@ -82,7 +88,7 @@
- (List) Specify list of share export helpers.
* - ``share_mount_path`` = ``/shares``
- (String) Parent path in service instance where shares will be mounted.
* - ``share_mount_template`` = ``mount -vt %(proto)s %(export)s %(path)s``
* - ``share_mount_template`` = ``mount -vt %(proto)s %(options)s %(export)s %(path)s``
- (String) The template for mounting shares for this backend. Must specify the executable with all necessary parameters for the protocol supported. 'proto' template element may not be required if included in the command. 'export' and 'path' template elements are required. It is advisable to separate different commands per backend.
* - ``share_unmount_template`` = ``umount -v %(path)s``
- (String) The template for unmounting shares for this backend. Must specify the executable with all necessary parameters for the protocol supported. 'path' template element is required. It is advisable to separate different commands per backend.

8
doc/config-reference/source/tables/manila-gpfs.rst
View File

@ -23,10 +23,10 @@
* - ``gpfs_nfs_server_list`` = ``None``
- (List) A list of the fully qualified NFS server names that make up the OpenStack Manila configuration.
* - ``gpfs_nfs_server_type`` = ``KNFS``
- (String) NFS Server type. Valid choices are "KNFS" (kernel NFS) or "GNFS" (Ganesha NFS).
- (String) NFS Server type. Valid choices are "KNFS" (kernel NFS) or "CES" (Ganesha NFS).
* - ``gpfs_share_export_ip`` = ``None``
- (String) IP to be added to GPFS export string.
* - ``gpfs_share_helpers`` = ``KNFS=manila.share.drivers.ibm.gpfs.KNFSHelper, GNFS=manila.share.drivers.ibm.gpfs.GNFSHelper``
* - ``gpfs_share_helpers`` = ``KNFS=manila.share.drivers.ibm.gpfs.KNFSHelper, CES=manila.share.drivers.ibm.gpfs.CESHelper``
- (List) Specify list of share export helpers.
* - ``gpfs_ssh_login`` = ``None``
- (String) GPFS server SSH login name.
@ -36,5 +36,7 @@
- (Port number) GPFS server SSH port.
* - ``gpfs_ssh_private_key`` = ``None``
- (String) Path to GPFS server SSH private key for login.
* - ``is_gpfs_node`` = ``False``
- (Boolean) True:when Manila services are running on one of the Spectrum Scale node. False:when Manila services are not running on any of the Spectrum Scale node.
* - ``knfs_export_options`` = ``rw,sync,no_root_squash,insecure,no_wdelay,no_subtree_check``
- (String) 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) DEPRECATED: Options to use when exporting a share using kernel NFS server. Note that these defaults can be overridden when a share is created by passing metadata with key name export_options. This option isn't used any longer. Please use share-type extra specs for export options.

50
doc/config-reference/source/tables/manila-hds_hnas.rst
View File

@ -16,29 +16,33 @@
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``hitachi_hnas_allow_cifs_snapshot_while_mounted`` = ``False``
- (Boolean) 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.
* - ``hitachi_hnas_cluster_admin_ip0`` = ``None``
- (String) The IP of the clusters admin node. Only set in HNAS multinode clusters.
* - ``hitachi_hnas_driver_helper`` = ``manila.share.drivers.hitachi.hnas.ssh.HNASSSHBackend``
- (String) Python class to be used for driver helper.
* - ``hitachi_hnas_evs_id`` = ``None``
- (Integer) Specify which EVS this backend is assigned to.
* - ``hitachi_hnas_evs_ip`` = ``None``
- (String) Specify IP for mounting shares.
* - ``hitachi_hnas_file_system_name`` = ``None``
- (String) Specify file-system name for creating shares.
* - ``hitachi_hnas_ip`` = ``None``
- (String) HNAS management interface IP for communication between Manila controller and HNAS.
* - ``hitachi_hnas_password`` = ``None``
- (String) HNAS user password. Required only if private key is not provided.
* - ``hitachi_hnas_ssh_private_key`` = ``None``
- (String) RSA/DSA private key value used to connect into HNAS. Required only if password is not provided.
* - ``hitachi_hnas_stalled_job_timeout`` = ``30``
- (Integer) The time (in seconds) to wait for stalled HNAS jobs before aborting.
* - ``hitachi_hnas_user`` = ``None``
- (String) HNAS username Base64 String in order to perform tasks such as create file-systems and network interfaces.
* - **[hnas1]**
-
* - ``hds_hnas_cluster_admin_ip0`` = ``None``
- (String) The IP of the clusters admin node. Only set in HNAS multinode clusters.
* - ``hds_hnas_evs_id`` = ``None``
- (Integer) Specify which EVS this backend is assigned to.
* - ``hds_hnas_evs_ip`` = ``None``
- (String) Specify IP for mounting shares.
* - ``hds_hnas_file_system_name`` = ``None``
- (String) Specify file-system name for creating shares.
* - ``hds_hnas_ip`` = ``None``
- (String) HNAS management interface IP for communication between Manila controller and HNAS.
* - ``hds_hnas_password`` = ``None``
- (String) HNAS user password. Required only if private key is not provided.
* - ``hds_hnas_ssh_private_key`` = ``None``
- (String) RSA/DSA private key value used to connect into HNAS. Required only if password is not provided.
* - ``hds_hnas_stalled_job_timeout`` = ``30``
- (Integer) The time (in seconds) to wait for stalled HNAS jobs before aborting.
* - ``hds_hnas_user`` = ``None``
- (String) HNAS username Base64 String in order to perform tasks such as create file-systems and network interfaces.
* - ``share_backend_name`` = ``None``
- (StrOpt) The backend name for a given driver implementation.
* - ``share_driver`` = ``manila.share.drivers.hitachi.hds_hnas.HDSHNASDriver``
- (StrOpt) Driver to use for share creation.
* - ``hds_hnas_driver_helper`` = ``manila.share.drivers.hitachi.ssh.HNASSSHBackend``
- (StrOpt) Python class to be used for driver helper.
- (String) The backend name for a given driver implementation.
* - ``share_driver`` = ``manila.share.drivers.generic.GenericShareDriver``
- (String) Driver to use for share creation.

6
doc/config-reference/source/tables/manila-hpe3par.rst
View File

@ -28,8 +28,8 @@
- (String) File system admin user name for CIFS.
* - ``hpe3par_debug`` = ``False``
- (Boolean) Enable HTTP debugging to 3PAR
* - ``hpe3par_fpg`` = ``OpenStack``
- (String) The File Provisioning Group (FPG) to use
* - ``hpe3par_fpg`` = ``None``
- (Unknown) The File Provisioning Group (FPG) to use
* - ``hpe3par_fstore_per_share`` = ``False``
- (Boolean) Use one filestore per share
* - ``hpe3par_password`` =
@ -44,8 +44,6 @@
- (String) Password for SAN controller
* - ``hpe3par_san_ssh_port`` = ``22``
- (Port number) SSH port to use with SAN
* - ``hpe3par_share_ip_address`` =
- (String) The IP address for shares not using a share server
* - ``hpe3par_share_mount_path`` = ``/mnt/``
- (String) The path where shares will be mounted when deleting nested file trees.
* - ``hpe3par_username`` =

2
doc/config-reference/source/tables/manila-netapp.rst
View File

@ -20,6 +20,8 @@
-
* - ``netapp_aggregate_name_search_pattern`` = ``(.*)``
- (String) Pattern for searching available aggregates for provisioning.
* - ``netapp_enabled_share_protocols`` = ``nfs3, nfs4.0``
- (List) The NFS protocol versions that will be enabled. Supported values include nfs3, nfs4.0, nfs4.1. This option only applies when the option driver_handles_share_servers is set to True.
* - ``netapp_lif_name_template`` = ``os_%(net_allocation_id)s``
- (String) Logical interface (LIF) name template
* - ``netapp_login`` = ``None``

22
doc/config-reference/source/tables/manila-rabbitmq.rst
View File

@ -24,8 +24,10 @@
- (Boolean) Use durable queues in AMQP.
* - ``channel_max`` = ``None``
- (Integer) Maximum number of channels to allow
* - ``connection_factory`` = ``single``
- (String) Connection factory implementation
* - ``default_notification_exchange`` = ``${control_exchange}_notification``
- (String) Exchange name for for sending notifications
- (String) Exchange name for sending notifications
* - ``default_notification_retry_attempts`` = ``-1``
- (Integer) Reconnecting retry count in case of connectivity problem during sending notification, -1 means infinite retry.
* - ``default_rpc_exchange`` = ``${control_exchange}_rpc``
@ -36,7 +38,7 @@
- (Boolean) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
* - ``frame_max`` = ``None``
- (Integer) The maximum byte size for an AMQP frame
* - ``heartbeat_interval`` = ``1``
* - ``heartbeat_interval`` = ``3``
- (Integer) How often to send heartbeats for consumer's connections
* - ``heartbeat_rate`` = ``2``
- (Integer) How often times during the heartbeat_timeout_threshold we check the heartbeat.
@ -68,7 +70,7 @@
- (Floating point) Reconnecting retry delay in case of connectivity problem during sending notification message
* - ``pool_max_overflow`` = ``0``
- (Integer) Maximum number of connections to create above `pool_max_size`.
* - ``pool_max_size`` = ``10``
* - ``pool_max_size`` = ``30``
- (Integer) Maximum number of connections to keep queued.
* - ``pool_recycle`` = ``600``
- (Integer) Lifetime of a connection (since creation) in seconds or None for no recycling. Expired connections are closed on acquire.
@ -79,19 +81,19 @@
* - ``rabbit_ha_queues`` = ``False``
- (Boolean) 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"}' "
* - ``rabbit_host`` = ``localhost``
- (String) The RabbitMQ broker address where a single node is used.
- (String) DEPRECATED: The RabbitMQ broker address where a single node is used. Replaced by [DEFAULT]/transport_url
* - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port``
- (List) RabbitMQ HA cluster host:port pairs.
- (List) DEPRECATED: RabbitMQ HA cluster host:port pairs. Replaced by [DEFAULT]/transport_url
* - ``rabbit_interval_max`` = ``30``
- (Integer) Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
* - ``rabbit_login_method`` = ``AMQPLAIN``
- (String) The RabbitMQ login method.
* - ``rabbit_max_retries`` = ``0``
- (Integer) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
- (Integer) DEPRECATED: Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
* - ``rabbit_password`` = ``guest``
- (String) The RabbitMQ password.
- (String) DEPRECATED: The RabbitMQ password. Replaced by [DEFAULT]/transport_url
* - ``rabbit_port`` = ``5672``
- (Port number) The RabbitMQ broker port where a single node is used.
- (Port number) DEPRECATED: The RabbitMQ broker port where a single node is used. Replaced by [DEFAULT]/transport_url
* - ``rabbit_qos_prefetch_count`` = ``0``
- (Integer) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
* - ``rabbit_retry_backoff`` = ``2``
@ -103,9 +105,9 @@
* - ``rabbit_use_ssl`` = ``False``
- (Boolean) Connect over SSL for RabbitMQ.
* - ``rabbit_userid`` = ``guest``
- (String) The RabbitMQ userid.
- (String) DEPRECATED: The RabbitMQ userid. Replaced by [DEFAULT]/transport_url
* - ``rabbit_virtual_host`` = ``/``
- (String) The RabbitMQ virtual host.
- (String) DEPRECATED: The RabbitMQ virtual host. Replaced by [DEFAULT]/transport_url
* - ``rpc_listener_prefetch_count`` = ``100``
- (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc listener.
* - ``rpc_queue_expiration`` = ``60``

12
doc/config-reference/source/tables/manila-redis.rst
View File

@ -21,16 +21,16 @@
* - ``check_timeout`` = ``20000``
- (Integer) Time in ms to wait before the transaction is killed.
* - ``host`` = ``127.0.0.1``
- (String) Host to locate redis.
- (String) DEPRECATED: Host to locate redis. Replaced by [DEFAULT]/transport_url
* - ``password`` =
- (String) Password for Redis server (optional).
- (String) DEPRECATED: Password for Redis server (optional). Replaced by [DEFAULT]/transport_url
* - ``port`` = ``6379``
- (Port number) Use this port to connect to redis host.
- (Port number) DEPRECATED: Use this port to connect to redis host. Replaced by [DEFAULT]/transport_url
* - ``sentinel_group_name`` = ``oslo-messaging-zeromq``
- (String) Redis replica set name.
* - ``sentinel_hosts`` =
- (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ]
* - ``socket_timeout`` = ``1000``
- (List) DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] Replaced by [DEFAULT]/transport_url
* - ``socket_timeout`` = ``10000``
- (Integer) Timeout in ms on blocking socket operations
* - ``wait_timeout`` = ``500``
* - ``wait_timeout`` = ``2000``
- (Integer) Time in ms to wait between connection attempts.

40
doc/config-reference/source/tables/manila-rpc.rst
View File

@ -19,7 +19,7 @@
* - **[DEFAULT]**
-
* - ``rpc_backend`` = ``rabbit``
- (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq.
- (String) DEPRECATED: The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. Replaced by [DEFAULT]/transport_url
* - ``rpc_cast_timeout`` = ``-1``
- (Integer) 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.
* - ``rpc_conn_pool_size`` = ``30``
@ -38,18 +38,52 @@
- (String) 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.
* - **[oslo_messaging_amqp]**
-
* - ``addressing_mode`` = ``dynamic``
- (String) 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
* - ``allow_insecure_clients`` = ``False``
- (Boolean) Accept clients using either SSL or plain TCP
* - ``anycast_address`` = ``anycast``
- (String) 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.
* - ``broadcast_prefix`` = ``broadcast``
- (String) address prefix used when broadcasting to all servers
* - ``connection_retry_backoff`` = ``2``
- (Integer) Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt.
* - ``connection_retry_interval`` = ``1``
- (Integer) Seconds to pause before attempting to re-connect.
* - ``connection_retry_interval_max`` = ``30``
- (Integer) Maximum limit for connection_retry_interval + connection_retry_backoff
* - ``container_name`` = ``None``
- (String) Name for the AMQP container
- (String) Name for the AMQP container. must be globally unique. Defaults to a generated UUID
* - ``default_notification_exchange`` = ``None``
- (String) 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'
* - ``default_notify_timeout`` = ``30``
- (Integer) The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry.
* - ``default_reply_timeout`` = ``30``
- (Integer) The deadline for an rpc reply message delivery. Only used when caller does not provide a timeout expiry.
* - ``default_rpc_exchange`` = ``None``
- (String) 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'
* - ``default_send_timeout`` = ``30``
- (Integer) The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry.
* - ``group_request_prefix`` = ``unicast``
- (String) address prefix when sending to any server in group
* - ``idle_timeout`` = ``0``
- (Integer) Timeout for inactive connections (in seconds)
* - ``link_retry_delay`` = ``10``
- (Integer) Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error.
* - ``multicast_address`` = ``multicast``
- (String) Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages.
* - ``notify_address_prefix`` = ``openstack.org/om/notify``
- (String) Address prefix for all generated Notification addresses
* - ``notify_server_credit`` = ``100``
- (Integer) Window size for incoming Notification messages
* - ``password`` =
- (String) Password for message broker authentication
* - ``reply_link_credit`` = ``200``
- (Integer) Window size for incoming RPC Reply messages.
* - ``rpc_address_prefix`` = ``openstack.org/om/rpc``
- (String) Address prefix for all generated RPC addresses
* - ``rpc_server_credit`` = ``100``
- (Integer) Window size for incoming RPC Request messages
* - ``sasl_config_dir`` =
- (String) Path to directory that contains the SASL configuration
* - ``sasl_config_name`` =
@ -68,6 +102,8 @@
- (String) Password for decrypting ssl_key_file (if encrypted)
* - ``trace`` = ``False``
- (Boolean) Debug: dump AMQP frames to stdout
* - ``unicast_address`` = ``unicast``
- (String) 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.
* - ``username`` =
- (String) User name for message broker authentication
* - **[oslo_messaging_notifications]**

4
doc/config-reference/source/tables/manila-scheduler.rst
View File

@ -22,9 +22,9 @@
- (Floating point) Multiplier used for weighing share capacity. Negative numbers mean to stack vs spread.
* - ``pool_weight_multiplier`` = ``1.0``
- (Floating point) Multiplier used for weighing pools which have existing share servers. Negative numbers mean to spread vs stack.
* - ``scheduler_default_filters`` = ``AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter, ConsistencyGroupFilter, ShareReplicationFilter``
* - ``scheduler_default_filters`` = ``AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter, ConsistencyGroupFilter, DriverFilter, ShareReplicationFilter``
- (List) Which filter class names to use for filtering hosts when not specified in the request.
* - ``scheduler_default_weighers`` = ``CapacityWeigher``
* - ``scheduler_default_weighers`` = ``CapacityWeigher, GoodnessWeigher``
- (List) Which weigher class names to use for weighing hosts.
* - ``scheduler_driver`` = ``manila.scheduler.drivers.filter.FilterScheduler``
- (String) Default scheduler driver to use.

4
doc/config-reference/source/tables/manila-share.rst
View File

@ -44,12 +44,12 @@
- (List) Driver(s) to perform some additional actions before and after share driver actions and on a periodic basis. Default is [].
* - ``migration_create_delete_share_timeout`` = ``300``
- (Integer) Timeout for creating and deleting share instances when performing share migration (seconds).
* - ``migration_driver_continue_update_interval`` = ``60``
- (Integer) 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.
* - ``migration_ignore_files`` = ``lost+found``
- (List) List of files and folders to be ignored when migrating shares. Items should be names (not including any path).
* - ``migration_readonly_rules_support`` = ``True``
- (Boolean) Specify whether read only access rule mode is supported in this backend.
* - ``migration_tmp_location`` = ``/tmp/``
- (String) Temporary path to create and mount shares during migration.
* - ``migration_wait_access_rules_timeout`` = ``180``
- (Integer) Time to wait for access rules to be allowed/denied on backends when migrating shares using generic approach (seconds).
* - ``network_config_group`` = ``None``

48
doc/config-reference/source/tables/manila-zeromq.rst
View File

@ -22,8 +22,6 @@
- (String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.
* - ``rpc_zmq_bind_port_retries`` = ``100``
- (Integer) Number of retries to find free port number before fail with ZMQBindError.
* - ``rpc_zmq_concurrency`` = ``eventlet``
- (String) Type of concurrency used. Either "native" or "eventlet"
* - ``rpc_zmq_contexts`` = ``1``
- (Integer) Number of ZeroMQ contexts, defaults to 1.
* - ``rpc_zmq_host`` = ``localhost``
@ -34,11 +32,53 @@
- (String) MatchMaker driver.
* - ``rpc_zmq_max_port`` = ``65536``
- (Integer) Maximal port number for random ports range.
* - ``rpc_zmq_min_port`` = ``49152``
* - ``rpc_zmq_min_port`` = ``49153``
- (Port number) Minimal port number for random ports range.
* - ``rpc_zmq_serialization`` = ``json``
- (String) Default serialization mechanism for serializing/deserializing outgoing/incoming messages
* - ``rpc_zmq_topic_backlog`` = ``None``
- (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
* - ``use_pub_sub`` = ``True``
- (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
* - ``zmq_target_expire`` = ``120``
* - ``zmq_immediate`` = ``False``
- (Boolean) 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.
* - ``zmq_target_expire`` = ``300``
- (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).
* - ``zmq_target_update`` = ``180``
- (Integer) Update period in seconds of a name service record about existing target.
* - **[oslo_messaging_zmq]**
-
* - ``rpc_cast_timeout`` = ``-1``
- (Integer) 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.
* - ``rpc_poll_timeout`` = ``1``
- (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.
* - ``rpc_zmq_bind_address`` = ``*``
- (String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.
* - ``rpc_zmq_bind_port_retries`` = ``100``
- (Integer) Number of retries to find free port number before fail with ZMQBindError.
* - ``rpc_zmq_contexts`` = ``1``
- (Integer) Number of ZeroMQ contexts, defaults to 1.
* - ``rpc_zmq_host`` = ``localhost``
- (String) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.
* - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack``
- (String) Directory for holding IPC sockets.
* - ``rpc_zmq_matchmaker`` = ``redis``
- (String) MatchMaker driver.
* - ``rpc_zmq_max_port`` = ``65536``
- (Integer) Maximal port number for random ports range.
* - ``rpc_zmq_min_port`` = ``49153``
- (Port number) Minimal port number for random ports range.
* - ``rpc_zmq_serialization`` = ``json``
- (String) Default serialization mechanism for serializing/deserializing outgoing/incoming messages
* - ``rpc_zmq_topic_backlog`` = ``None``
- (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
* - ``use_pub_sub`` = ``True``
- (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
* - ``use_router_proxy`` = ``True``
- (Boolean) Use ROUTER remote proxy.
* - ``zmq_immediate`` = ``False``
- (Boolean) 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.
* - ``zmq_target_expire`` = ``300``
- (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).
* - ``zmq_target_update`` = ``180``
- (Integer) Update period in seconds of a name service record about existing target.

2
doc/config-reference/source/tables/manila-zfs.rst
View File

@ -24,6 +24,8 @@
- (String) Prefix to be used in each dataset name. Optional.
* - ``zfs_dataset_snapshot_name_prefix`` = ``manila_share_snapshot_``
- (String) Prefix to be used in each dataset snapshot name. Optional.
* - ``zfs_migration_snapshot_prefix`` = ``tmp_snapshot_for_share_migration_``
- (String) Set snapshot prefix for usage in ZFS migration. Required.
* - ``zfs_replica_snapshot_prefix`` = ``tmp_snapshot_for_replication_``
- (String) Set snapshot prefix for usage in ZFS replication. Required.
* - ``zfs_service_ip`` = ``None``

2
doc/config-reference/source/tables/manila-zfssa.rst
View File

@ -26,6 +26,8 @@
- (String) IP address for data.
* - ``zfssa_host`` = ``None``
- (String) ZFSSA management IP address.
* - ``zfssa_manage_policy`` = ``loose``
- (String) Driver policy for share manage. A strict policy checks for a schema named manila_managed, and makes sure its value is true. A loose policy does not check for the schema.
* - ``zfssa_nas_checksum`` = ``fletcher4``
- (String) Controls checksum used for data blocks.
* - ``zfssa_nas_compression`` = ``off``

84
tools/autogenerate-config-flagmappings/manila.flagmappings
View File

@ -11,6 +11,7 @@ cephfs_auth_id cephfs
cephfs_cluster_name cephfs
cephfs_conf_path cephfs
cephfs_enable_snapshots cephfs
check_hash common
cinder_admin_auth_url generic
cinder_admin_password generic
cinder_admin_tenant_name generic
@ -19,12 +20,17 @@ cinder_catalog_info generic
cinder_volume_type generic
client_socket_timeout common
compute_api_class common
conn_pool_min_size disable
conn_pool_ttl disable
connect_share_server_to_tenant_network generic
container_volume_group generic
control_exchange amqp
data_access_wait_access_rules_timeout common
data_manager common
data_node_access_admin_user common
data_node_access_cert common
data_node_access_ip common
data_node_mount_options common
data_topic common
db_backend api
db_driver disable
@ -33,12 +39,14 @@ default_log_levels disable
default_share_type share
delete_share_server_with_last_share share
driver_handles_share_servers share generic
emc_interface_ports emc
emc_nas_login emc
emc_nas_password emc
emc_nas_pool_names emc
emc_nas_root_dir emc
emc_nas_server emc
emc_nas_server_container emc
emc_nas_server_pool emc
emc_nas_server_port emc
emc_nas_server_secure emc
emc_share_backend emc
@ -46,13 +54,12 @@ enable_new_services common
enable_periodic_hooks share
enable_post_hooks share
enable_pre_hooks share
enable_v1_api api
enable_v2_api api
enabled_share_backends share
enabled_share_protocols share
executor_thread_pool_size share
fatal_deprecations disable
fatal_exception_format_errors common
filter_function common
ganesha_config_dir ganesha
ganesha_config_path ganesha
ganesha_db_path ganesha
@ -71,6 +78,7 @@ glusterfs_servers glusterfs
glusterfs_share_layout glusterfs
glusterfs_target glusterfs
glusterfs_volume_pattern glusterfs
goodness_function generic
gpfs_mount_point_base gpfs
gpfs_nfs_server_list gpfs
gpfs_nfs_server_type gpfs
@ -86,7 +94,17 @@ hdfs_ssh_name hdfs
hdfs_ssh_port hdfs
hdfs_ssh_private_key hdfs
hdfs_ssh_pw hdfs
hds_hnas_driver_helper hnas
hitachi_hnas_allow_cifs_snapshot_while_mounted hds_hnas
hitachi_hnas_cluster_admin_ip0 hds_hnas
hitachi_hnas_driver_helper hds_hnas
hitachi_hnas_evs_id hds_hnas
hitachi_hnas_evs_ip hds_hnas
hitachi_hnas_file_system_name hds_hnas
hitachi_hnas_ip hds_hnas
hitachi_hnas_password hds_hnas
hitachi_hnas_ssh_private_key hds_hnas
hitachi_hnas_stalled_job_timeout hds_hnas
hitachi_hnas_user hds_hnas
hook_drivers share
host common
hpe3par_api_url hpe3par
@ -102,12 +120,12 @@ hpe3par_san_ip hpe3par
hpe3par_san_login hpe3par
hpe3par_san_password hpe3par
hpe3par_san_ssh_port hpe3par
hpe3par_share_ip_address hpe3par
hpe3par_share_mount_path hpe3par
hpe3par_username hpe3par
instance_format disable
instance_uuid_format disable
interface_driver generic
is_gpfs_node gpfs
knfs_export_options gpfs
log_config_append disable
log_date_format disable
@ -135,14 +153,16 @@ max_time_to_create_volume generic
max_time_to_extend_volume generic
memcached_servers common
migration_create_delete_share_timeout share
migration_driver_continue_update_interval share
migration_ignore_files share
migration_readonly_rules_support share
migration_tmp_location share
migration_wait_access_rules_timeout share
monkey_patch common
monkey_patch_modules common
mount_tmp_location common
my_ip common
netapp_aggregate_name_search_pattern netapp
netapp_enabled_share_protocols netapp
netapp_lif_name_template netapp
netapp_login netapp
netapp_password netapp
@ -181,6 +201,7 @@ periodic_fuzzy_delay common
periodic_hooks_interval common
periodic_interval common
pool_weight_multiplier scheduler
protocol_access_mapping generic
publish_errors disable
quobyte_api_ca quobyte
quobyte_api_password quobyte
@ -210,13 +231,13 @@ rpc_poll_timeout rpc
rpc_response_timeout rpc
rpc_zmq_bind_address zeromq
rpc_zmq_bind_port_retries zeromq
rpc_zmq_concurrency zeromq
rpc_zmq_contexts zeromq
rpc_zmq_host zeromq
rpc_zmq_ipc_dir zeromq
rpc_zmq_matchmaker zeromq
rpc_zmq_max_port zeromq
rpc_zmq_min_port zeromq
rpc_zmq_serialization zeromq
rpc_zmq_topic_backlog zeromq
scheduler_default_filters scheduler
scheduler_default_weighers scheduler
@ -284,6 +305,7 @@ until_refresh common
unused_share_server_cleanup_interval share
use_forwarded_for common
use_pub_sub zeromq
use_router_proxy disable
use_scheduler_creating_share_from_snapshot share
use_stderr disable
use_syslog disable
@ -303,6 +325,7 @@ wsgi_keep_alive common
zfs_dataset_creation_options zfs
zfs_dataset_name_prefix zfs
zfs_dataset_snapshot_name_prefix zfs
zfs_migration_snapshot_prefix zfs
zfs_replica_snapshot_prefix zfs
zfs_service_ip zfs
zfs_share_export_ip zfs
@ -316,6 +339,7 @@ zfssa_auth_password zfssa
zfssa_auth_user zfssa
zfssa_data_ip zfssa
zfssa_host zfssa
zfssa_manage_policy zfssa
zfssa_nas_checksum zfssa
zfssa_nas_compression zfssa
zfssa_nas_logbias zfssa
@ -326,7 +350,9 @@ zfssa_nas_vscan zfssa
zfssa_pool zfssa
zfssa_project zfssa
zfssa_rest_timeout zfssa
zmq_immediate zeromq
zmq_target_expire zeromq
zmq_target_update zeromq
cinder/api_insecure generic
cinder/auth_section generic
cinder/auth_type generic
@ -370,15 +396,6 @@ database/slave_connection disable
database/sqlite_db disable
database/sqlite_synchronous disable
database/use_db_reconnect disable
hnas1/hds_hnas_cluster_admin_ip0 hds_hnas
hnas1/hds_hnas_evs_id hds_hnas
hnas1/hds_hnas_evs_ip hds_hnas
hnas1/hds_hnas_file_system_name hds_hnas
hnas1/hds_hnas_ip hds_hnas
hnas1/hds_hnas_password hds_hnas
hnas1/hds_hnas_ssh_private_key hds_hnas
hnas1/hds_hnas_stalled_job_timeout hds_hnas
hnas1/hds_hnas_user hds_hnas
hnas1/share_backend_name hds_hnas
hnas1/share_driver hds_hnas
keystone_authtoken/admin_password disable
@ -444,12 +461,29 @@ nova/keyfile generic
nova/timeout generic
oslo_concurrency/disable_process_locking rpc
oslo_concurrency/lock_path rpc
oslo_messaging_amqp/addressing_mode rpc
oslo_messaging_amqp/allow_insecure_clients rpc
oslo_messaging_amqp/anycast_address rpc
oslo_messaging_amqp/broadcast_prefix rpc
oslo_messaging_amqp/connection_retry_backoff rpc
oslo_messaging_amqp/connection_retry_interval rpc
oslo_messaging_amqp/connection_retry_interval_max rpc
oslo_messaging_amqp/container_name rpc
oslo_messaging_amqp/default_notification_exchange rpc
oslo_messaging_amqp/default_notify_timeout rpc
oslo_messaging_amqp/default_reply_timeout rpc
oslo_messaging_amqp/default_rpc_exchange rpc
oslo_messaging_amqp/default_send_timeout rpc
oslo_messaging_amqp/group_request_prefix rpc
oslo_messaging_amqp/idle_timeout rpc
oslo_messaging_amqp/link_retry_delay rpc
oslo_messaging_amqp/multicast_address rpc
oslo_messaging_amqp/notify_address_prefix rpc
oslo_messaging_amqp/notify_server_credit rpc
oslo_messaging_amqp/password rpc
oslo_messaging_amqp/reply_link_credit rpc
oslo_messaging_amqp/rpc_address_prefix rpc
oslo_messaging_amqp/rpc_server_credit rpc
oslo_messaging_amqp/sasl_config_dir rpc
oslo_messaging_amqp/sasl_config_name rpc
oslo_messaging_amqp/sasl_mechanisms rpc
@ -459,6 +493,7 @@ oslo_messaging_amqp/ssl_cert_file rpc
oslo_messaging_amqp/ssl_key_file rpc
oslo_messaging_amqp/ssl_key_password rpc
oslo_messaging_amqp/trace rpc
oslo_messaging_amqp/unicast_address rpc
oslo_messaging_amqp/username rpc
oslo_messaging_notifications/driver rpc
oslo_messaging_notifications/topics rpc
@ -466,6 +501,7 @@ oslo_messaging_notifications/transport_url rpc
oslo_messaging_rabbit/amqp_auto_delete rabbitmq
oslo_messaging_rabbit/amqp_durable_queues rabbitmq
oslo_messaging_rabbit/channel_max rabbitmq
oslo_messaging_rabbit/connection_factory rabbitmq
oslo_messaging_rabbit/default_notification_exchange rabbitmq
oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq
oslo_messaging_rabbit/default_rpc_exchange rabbitmq
@ -518,6 +554,24 @@ oslo_messaging_rabbit/socket_timeout rabbitmq
oslo_messaging_rabbit/ssl rabbitmq
oslo_messaging_rabbit/ssl_options rabbitmq
oslo_messaging_rabbit/tcp_user_timeout rabbitmq
oslo_messaging_zmq/rpc_cast_timeout zeromq
oslo_messaging_zmq/rpc_poll_timeout zeromq
oslo_messaging_zmq/rpc_zmq_bind_address zeromq
oslo_messaging_zmq/rpc_zmq_bind_port_retries zeromq
oslo_messaging_zmq/rpc_zmq_contexts zeromq
oslo_messaging_zmq/rpc_zmq_host zeromq
oslo_messaging_zmq/rpc_zmq_ipc_dir zeromq
oslo_messaging_zmq/rpc_zmq_matchmaker zeromq
oslo_messaging_zmq/rpc_zmq_max_port zeromq
oslo_messaging_zmq/rpc_zmq_min_port zeromq
oslo_messaging_zmq/rpc_zmq_serialization zeromq
oslo_messaging_zmq/rpc_zmq_topic_backlog zeromq
oslo_messaging_zmq/use_pub_sub zeromq
oslo_messaging_zmq/use_router_proxy zeromq
oslo_messaging_zmq/zmq_immediate zeromq
oslo_messaging_zmq/zmq_target_expire zeromq
oslo_messaging_zmq/zmq_target_update zeromq
oslo_middleware/enable_proxy_headers_parsing api
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule disable