Files
openstack-manuals/doc/config-reference/source/tables/manila-api.rst
Gauvain Pocentek 26510e84dd [config-ref] Publish the RST version
Change-Id: Ia9dc15869ab201a787eecd479252282f0ae9113b
Implements: blueprint config-ref-rst
2015-12-21 09:44:24 +01:00

3.7 KiB

Description of API configuration options
Configuration option = Default value Description
[DEFAULT]
api_paste_config = api-paste.ini (StrOpt) File name for the paste.deploy config for manila-api.
api_rate_limit = True (BoolOpt) Whether to rate limit the API.
enable_v1_api = False (BoolOpt) 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 (BoolOpt) 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 (IntOpt) 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 (IntOpt) The maximum number of items returned in a single response from a collection resource.
osapi_share_base_URL = None (StrOpt) Base URL to be presented to users in links to the Share API
osapi_share_ext_list = (ListOpt) Specify list of extensions to load when using osapi_share_extension option with manila.api.contrib.select_extensions.
osapi_share_extension = ['manila.api.contrib.standard_extensions'] (MultiStrOpt) The osapi share extension to load.
osapi_share_listen = :: (StrOpt) IP address for OpenStack Share API to listen on.
osapi_share_listen_port = 8786 (PortOpt) Port for OpenStack Share API to listen on.
osapi_share_workers = 1 (IntOpt) Number of workers for OpenStack Share API service.
share_api_class = manila.share.api.API (StrOpt) The full class name of the share API class to use.
volume_api_class = manila.volume.cinder.API (StrOpt) The full class name of the Volume API class to use.
volume_name_template = manila-share-%s (StrOpt) Volume name template.
volume_snapshot_name_template = manila-snapshot-%s (StrOpt) Volume snapshot name template.
[oslo_middleware]
max_request_body_size = 114688 (IntOpt) The maximum body size for each request, in bytes.
secure_proxy_ssl_header = X-Forwarded-Proto (StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.
[oslo_policy]
policy_default_rule = default (StrOpt) Default rule. Enforced when a requested rule is not found.
policy_dirs = ['policy.d'] (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
policy_file = policy.json (StrOpt) The JSON file that defines policies.