| Configuration option = Default value | -Description | -
|---|---|
| [alarm] | -|
| evaluation_interval = 60 | -(IntOpt) Period of evaluation cycle, should be >= than configured pipeline interval for collection of underlying metrics. | -
| evaluation_service = ceilometer.alarm.service.SingletonAlarmService | -(StrOpt) Class to launch as alarm evaluation service. | -
| notifier_rpc_topic = alarm_notifier | -(StrOpt) The topic that ceilometer uses for alarm notifier messages. | -
| partition_rpc_topic = alarm_partition_coordination | -(StrOpt) The topic that ceilometer uses for alarm partition coordination messages. | -
| record_history = True | -(BoolOpt) Record alarm change events. | -
| rest_notifier_certificate_file = | -(StrOpt) SSL Client certificate for REST notifier. | -
| rest_notifier_certificate_key = | -(StrOpt) SSL Client private key for REST notifier. | -
| rest_notifier_ssl_verify = True | -(BoolOpt) Whether to verify the SSL Server certificate when calling alarm action. | -
| Configuration option = Default value | +Description | +
|---|---|
| [alarm] | +|
| evaluation_interval = 60 | +(IntOpt) Period of evaluation cycle, should be >= than configured pipeline interval for collection of underlying metrics. | +
| evaluation_service = ceilometer.alarm.service.SingletonAlarmService | +(StrOpt) Class to launch as alarm evaluation service. | +
| notifier_rpc_topic = alarm_notifier | +(StrOpt) The topic that ceilometer uses for alarm notifier messages. | +
| partition_rpc_topic = alarm_partition_coordination | +(StrOpt) The topic that ceilometer uses for alarm partition coordination messages. | +
| record_history = True | +(BoolOpt) Record alarm change events. | +
| rest_notifier_certificate_file = | +(StrOpt) SSL Client certificate for REST notifier. | +
| rest_notifier_certificate_key = | +(StrOpt) SSL Client private key for REST notifier. | +
| rest_notifier_ssl_verify = True | +(BoolOpt) Whether to verify the SSL Server certificate when calling alarm action. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| amqp_auto_delete = False | -(BoolOpt) Auto-delete queues in amqp. | -
| amqp_durable_queues = False | -(BoolOpt) Use durable queues in amqp. | -
| notification_driver = [] | -(MultiStrOpt) Driver or drivers to handle sending notifications | -
| notification_topics = notifications | -(ListOpt) AMQP topic used for OpenStack notifications | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| amqp_auto_delete = False | +(BoolOpt) Auto-delete queues in amqp. | +
| amqp_durable_queues = False | +(BoolOpt) Use durable queues in amqp. | +
| notification_driver = [] | +(MultiStrOpt) Driver or drivers to handle sending notifications. | +
| notification_topics = notifications | +(ListOpt) AMQP topic used for OpenStack notifications. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| enable_v1_api = True | -(BoolOpt) Deploy the deprecated v1 API. | -
| max_request_body_size = 114688 | -(IntOpt) The maximum body size per request, in bytes | -
| pipeline_cfg_file = pipeline.yaml | -(StrOpt) Configuration file for pipeline definition. | -
| policy_default_rule = default | -(StrOpt) Rule enforced when requested rule is not found | -
| policy_file = policy.json | -(StrOpt) JSON file containing policy | -
| reserved_metadata_length = 256 | -(IntOpt) Limit on length of reserved metadata values. | -
| reserved_metadata_namespace = metering. | -(ListOpt) List of metadata prefixes reserved for metering use. | -
| [api] | -|
| host = 0.0.0.0 | -(StrOpt) The listen IP for the ceilometer API server. | -
| port = 8777 | -(IntOpt) The port for the ceilometer API server. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| api_paste_config = api_paste.ini | +(StrOpt) Configuration file for WSGI definition of API. | +
| max_request_body_size = 114688 | +(IntOpt) The maximum body size for each request, in bytes. | +
| pipeline_cfg_file = pipeline.yaml | +(StrOpt) Configuration file for pipeline definition. | +
| policy_default_rule = default | +(StrOpt) Default rule. Enforced when a requested rule is not found. | +
| policy_file = policy.json | +(StrOpt) The JSON file that defines policies. | +
| reserved_metadata_length = 256 | +(IntOpt) Limit on length of reserved metadata values. | +
| reserved_metadata_namespace = metering. | +(ListOpt) List of metadata prefixes reserved for metering use. | +
| [api] | +|
| enable_reverse_dns_lookup = False | +(BoolOpt) Set it to False if your environment does not need or have dns server, otherwise it will delay the response from api. | +
| host = 0.0.0.0 | +(StrOpt) The listen IP for the ceilometer API server. | +
| port = 8777 | +(IntOpt) The port for the ceilometer API server. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| auth_strategy = keystone | -(StrOpt) The strategy to use for auth: noauth or keystone. | -
| [keystone_authtoken] | -|
| admin_password = None | -(StrOpt) Keystone account password | -
| admin_tenant_name = admin | -(StrOpt) Keystone service account tenant name to validate user tokens | -
| admin_token = None | -(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. | -
| admin_user = None | -(StrOpt) Keystone account username | -
| auth_admin_prefix = | -(StrOpt) Prefix to prepend at the beginning of the path | -
| auth_host = 127.0.0.1 | -(StrOpt) Host providing the admin Identity API endpoint | -
| auth_port = 35357 | -(IntOpt) Port of the admin Identity API endpoint | -
| auth_protocol = https | -(StrOpt) Protocol of the admin Identity API endpoint(http or https) | -
| auth_uri = None | -(StrOpt) Complete public Identity API endpoint | -
| auth_version = None | -(StrOpt) API version of the admin Identity API endpoint | -
| cache = None | -(StrOpt) Env key for the swift cache | -
| cafile = None | -(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| certfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| delay_auth_decision = False | -(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | -
| enforce_token_bind = permissive | -(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| http_connect_timeout = None | -(BoolOpt) Request timeout value for communicating with Identity API server. | -
| http_request_max_retries = 3 | -(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| include_service_catalog = True | -(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| insecure = False | -(BoolOpt) Verify HTTPS connections. | -
| keyfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| memcache_secret_key = None | -(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | -
| memcache_security_strategy = None | -(StrOpt) (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. | -
| memcached_servers = None | -(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| revocation_cache_time = 300 | -(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| signing_dir = None | -(StrOpt) Directory used to cache files related to PKI tokens | -
| token_cache_time = 300 | -(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| [service_credentials] | -|
| insecure = False | -(BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established. | -
| os_auth_url = http://localhost:5000/v2.0 | -(StrOpt) Auth URL to use for OpenStack service access. | -
| os_cacert = None | -(StrOpt) Certificate chain for SSL validation. | -
| os_endpoint_type = publicURL | -(StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services. | -
| os_password = admin | -(StrOpt) Password to use for OpenStack service access. | -
| os_region_name = None | -(StrOpt) Region name to use for OpenStack service endpoints. | -
| os_tenant_id = | -(StrOpt) Tenant ID to use for OpenStack service access. | -
| os_tenant_name = admin | -(StrOpt) Tenant name to use for OpenStack service access. | -
| os_username = ceilometer | -(StrOpt) User name to use for OpenStack service access. | -
| Configuration option = Default value | +Description | +
|---|---|
| [service_credentials] | +|
| insecure = False | +(BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established. | +
| os_auth_url = http://localhost:5000/v2.0 | +(StrOpt) Auth URL to use for OpenStack service access. | +
| os_cacert = None | +(StrOpt) Certificate chain for SSL validation. | +
| os_endpoint_type = publicURL | +(StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services. | +
| os_password = admin | +(StrOpt) Password to use for OpenStack service access. | +
| os_region_name = None | +(StrOpt) Region name to use for OpenStack service endpoints. | +
| os_tenant_id = | +(StrOpt) Tenant ID to use for OpenStack service access. | +
| os_tenant_name = admin | +(StrOpt) Tenant name to use for OpenStack service access. | +
| os_username = ceilometer | +(StrOpt) User name to use for OpenStack service access. | +
| Configuration option = Default value | +Description | +
|---|---|
| [keystone_authtoken] | +|
| admin_password = None | +(StrOpt) Keystone account password | +
| admin_tenant_name = admin | +(StrOpt) Keystone service account tenant name to validate user tokens | +
| admin_token = None | +(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | +
| admin_user = None | +(StrOpt) Keystone account username | +
| auth_admin_prefix = | +(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | +
| auth_host = 127.0.0.1 | +(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_port = 35357 | +(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_protocol = https | +(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | +
| auth_uri = None | +(StrOpt) Complete public Identity API endpoint | +
| auth_version = None | +(StrOpt) API version of the admin Identity API endpoint | +
| cache = None | +(StrOpt) Env key for the swift cache | +
| cafile = None | +(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | +
| certfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| check_revocations_for_cached = False | +(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server. | +
| delay_auth_decision = False | +(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | +
| enforce_token_bind = permissive | +(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | +
| hash_algorithms = md5 | +(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | +
| http_connect_timeout = None | +(BoolOpt) Request timeout value for communicating with Identity API server. | +
| http_request_max_retries = 3 | +(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | +
| identity_uri = None | +(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | +
| include_service_catalog = True | +(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | +
| insecure = False | +(BoolOpt) Verify HTTPS connections. | +
| keyfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| memcache_secret_key = None | +(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | +
| memcache_security_strategy = None | +(StrOpt) (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. | +
| memcached_servers = None | +(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | +
| revocation_cache_time = 10 | +(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | +
| signing_dir = None | +(StrOpt) Directory used to cache files related to PKI tokens | +
| token_cache_time = 300 | +(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | +
| Configuration option = Default value | -Description | -
|---|---|
| [cells] | -|
| bandwidth_update_interval = 600 | -(IntOpt) Seconds between bandwidth updates for cells. | -
| call_timeout = 60 | -(IntOpt) Seconds to wait for response from a call to a cell. | -
| capabilities = hypervisor=xenserver;kvm, os=linux;windows | -(ListOpt) Key/Multi-value list with the capabilities of the cell | -
| cell_type = compute | -(StrOpt) Type of cell: api or compute | -
| enable = False | -(BoolOpt) Enable cell functionality | -
| manager = nova.cells.manager.CellsManager | -(StrOpt) Manager for cells | -
| mute_child_interval = 300 | -(IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute. | -
| name = nova | -(StrOpt) Name of this cell | -
| reserve_percent = 10.0 | -(FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization | -
| topic = cells | -(StrOpt) The topic cells nodes listen on | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| collector_workers = 1 | -(IntOpt) Number of workers for collector service. A single collector is enabled by default. | -
| [collector] | -|
| udp_address = 0.0.0.0 | -(StrOpt) Address to which the UDP socket is bound. Set to an empty string to disable. | -
| udp_port = 4952 | -(IntOpt) Port to which the UDP socket is bound. | -
| [dispatcher_file] | -|
| backup_count = 0 | -(IntOpt) The max number of the files to keep. | -
| file_path = None | -(StrOpt) Name and the location of the file to record meters. | -
| max_bytes = 0 | -(IntOpt) The max size of the file. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| collector_workers = 1 | +(IntOpt) Number of workers for collector service. A single collector is enabled by default. | +
| [dispatcher_file] | +|
| backup_count = 0 | +(IntOpt) The max number of the files to keep. | +
| file_path = None | +(StrOpt) Name and the location of the file to record meters. | +
| max_bytes = 0 | +(IntOpt) The max size of the file. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| backdoor_port = None | -(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. | -
| disable_process_locking = False | -(BoolOpt) Whether to disable inter-process locks. | -
| fatal_deprecations = False | -(BoolOpt) Make deprecations fatal | -
| lock_path = None | -(StrOpt) Directory to use for lock files. | -
| memcached_servers = None | -(ListOpt) Memcached servers or None for in process cache. | -
| notification_workers = 1 | -(IntOpt) Number of workers for notification service. A single notification agent is enabled by default. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| backdoor_port = None | +(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. | +
| disable_process_locking = False | +(BoolOpt) Enables or disables inter-process locks. | +
| fatal_deprecations = False | +(BoolOpt) Enables or disables fatal status of deprecations. | +
| fatal_exception_format_errors = False | +(BoolOpt) Make exception message format errors fatal | +
| lock_path = None | +(StrOpt) Directory to use for lock files. | +
| memcached_servers = None | +(ListOpt) Memcached servers or None for in process cache. | +
| notification_workers = 1 | +(IntOpt) Number of workers for notification service. A single notification agent is enabled by default. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| database_connection = None | -(StrOpt) DEPRECATED - Database connection string. | -
| mysql_engine = InnoDB | -(StrOpt) MySQL engine to use. | -
| sqlite_db = ceilometer.sqlite | -(StrOpt) The file name to use with SQLite | -
| sqlite_synchronous = True | -(BoolOpt) If True, SQLite uses synchronous mode | -
| [database] | -|
| backend = sqlalchemy | -(StrOpt) The backend to use for db | -
| connection = sqlite:////usr/lib/python/site-packages/ceilometer/openstack/common/db/$sqlite_db | -(StrOpt) The SQLAlchemy connection string used to connect to the database | -
| connection_debug = 0 | -(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything | -
| connection_trace = False | -(BoolOpt) Add python stack traces to SQL as comment strings | -
| idle_timeout = 3600 | -(IntOpt) Timeout before idle sql connections are reaped | -
| max_overflow = None | -(IntOpt) If set, use this value for max_overflow with sqlalchemy | -
| max_pool_size = None | -(IntOpt) Maximum number of SQL connections to keep open in a pool | -
| max_retries = 10 | -(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count) | -
| min_pool_size = 1 | -(IntOpt) Minimum number of SQL connections to keep open in a pool | -
| pool_timeout = None | -(IntOpt) If set, use this value for pool_timeout with sqlalchemy | -
| retry_interval = 10 | -(IntOpt) Interval between retries of opening a sql connection | -
| slave_connection = | -(StrOpt) The SQLAlchemy connection string used to connect to the slave database | -
| time_to_live = -1 | -(IntOpt) Number of seconds that samples are kept in the database for (<= 0 means forever). | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| database_connection = None | +(StrOpt) DEPRECATED - Database connection string. | +
| [database] | +|
| backend = sqlalchemy | +(StrOpt) The backend to use for db | +
| connection = None | +(StrOpt) The SQLAlchemy connection string used to connect to the database | +
| connection_debug = 0 | +(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything | +
| connection_trace = False | +(BoolOpt) Add python stack traces to SQL as comment strings | +
| db_inc_retry_interval = True | +(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval | +
| db_max_retries = 20 | +(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count) | +
| db_max_retry_interval = 10 | +(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled | +
| db_retry_interval = 1 | +(IntOpt) seconds between db connection retries | +
| idle_timeout = 3600 | +(IntOpt) Timeout before idle sql connections are reaped | +
| max_overflow = None | +(IntOpt) If set, use this value for max_overflow with sqlalchemy | +
| max_pool_size = None | +(IntOpt) Maximum number of SQL connections to keep open in a pool | +
| max_retries = 10 | +(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count) | +
| min_pool_size = 1 | +(IntOpt) Minimum number of SQL connections to keep open in a pool | +
| mysql_sql_mode = TRADITIONAL | +(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | +
| pool_timeout = None | +(IntOpt) If set, use this value for pool_timeout with sqlalchemy | +
| retry_interval = 10 | +(IntOpt) Interval between retries of opening a sql connection | +
| sqlite_db = ceilometer.sqlite | +(StrOpt) The file name to use with SQLite | +
| sqlite_synchronous = True | +(BoolOpt) If True, SQLite uses synchronous mode | +
| time_to_live = -1 | +(IntOpt) Number of seconds that samples are kept in the database for (<= 0 means forever). | +
| use_db_reconnect = False | +(BoolOpt) Enable the experimental use of database reconnect on connection lost | +
| use_tpool = False | +(BoolOpt) Enable the experimental use of thread pooling for all DB API calls | +
| Configuration option = Default value | -Description | -
|---|---|
| [event] | -|
| definitions_cfg_file = event_definitions.yaml | -(StrOpt) Configuration file for event definitions. | -
| drop_unmatched_notifications = False | -(BoolOpt) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits) | -
| [notification] | -|
| ack_on_event_error = True | -(BoolOpt) Acknowledge message when event persistence fails. | -
| store_events = False | -(BoolOpt) Save event details. | -
| Configuration option = Default value | +Description | +
|---|---|
| [event] | +|
| definitions_cfg_file = event_definitions.yaml | +(StrOpt) Configuration file for event definitions. | +
| drop_unmatched_notifications = False | +(BoolOpt) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits) | +
| [notification] | +|
| ack_on_event_error = True | +(BoolOpt) Acknowledge message when event persistence fails. | +
| store_events = False | +(BoolOpt) Save event details. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| cinder_control_exchange = cinder | -(StrOpt) Exchange name for Cinder notifications. | -
| control_exchange = openstack | -(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid | -
| default_publisher_id = None | -(StrOpt) Default publisher_id for outgoing notifications | -
| glance_control_exchange = glance | -(StrOpt) Exchange name for Glance notifications. | -
| heat_control_exchange = heat | -(StrOpt) Exchange name for Heat notifications | -
| http_control_exchanges = ['nova', 'glance', 'neutron', 'cinder'] | -(MultiStrOpt) Exchanges name to listen for notifications. | -
| neutron_control_exchange = neutron | -(StrOpt) Exchange name for Neutron notifications. | -
| nova_control_exchange = nova | -(StrOpt) Exchange name for Nova notifications. | -
| sample_source = openstack | -(StrOpt) Source for samples emitted on this instance. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| cinder_control_exchange = cinder | +(StrOpt) Exchange name for Cinder notifications. | +
| control_exchange = openstack | +(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid | +
| glance_control_exchange = glance | +(StrOpt) Exchange name for Glance notifications. | +
| heat_control_exchange = heat | +(StrOpt) Exchange name for Heat notifications | +
| http_control_exchanges = ['nova', 'glance', 'neutron', 'cinder'] | +(MultiStrOpt) Exchanges name to listen for notifications. | +
| neutron_control_exchange = neutron | +(StrOpt) Exchange name for Neutron notifications. | +
| nova_control_exchange = nova | +(StrOpt) Exchange name for Nova notifications. | +
| sample_source = openstack | +(StrOpt) Source for samples emitted on this instance. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| hypervisor_inspector = libvirt | -(StrOpt) Inspector to use for inspecting the hypervisor layer. | -
| libvirt_type = kvm | -(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen). | -
| libvirt_uri = | -(StrOpt) Override the default libvirt URI (which is dependent on libvirt_type). | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| hypervisor_inspector = libvirt | +(StrOpt) Inspector to use for inspecting the hypervisor layer. | +
| libvirt_type = kvm | +(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen). | +
| libvirt_uri = | +(StrOpt) Override the default libvirt URI (which is dependent on libvirt_type). | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| debug = False | -(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | -
| default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN | -(ListOpt) List of logger=LEVEL pairs | -
| default_notification_level = INFO | -(StrOpt) Default notification level for outgoing notifications | -
| instance_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance is passed with the log message, format it like this | -
| instance_uuid_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance UUID is passed with the log message, format it like this | -
| log_config_append = None | -(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files. | -
| log_date_format = %Y-%m-%d %H:%M:%S | -(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s | -
| log_dir = None | -(StrOpt) (Optional) The base directory used for relative --log-file paths | -
| log_file = None | -(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | -
| log_format = None | -(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | -
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | -(StrOpt) Format string to use for log messages with context | -
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | -(StrOpt) Data to append to log format when level is DEBUG | -
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | -(StrOpt) Format string to use for log messages without context | -
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -(StrOpt) Prefix each line of exception output with this format | -
| publish_errors = False | -(BoolOpt) Publish error events | -
| syslog_log_facility = LOG_USER | -(StrOpt) Syslog facility to receive log lines | -
| use_stderr = True | -(BoolOpt) Log output to standard error | -
| use_syslog = False | -(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424 | -
| use_syslog_rfc_format = False | -(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J. | -
| verbose = False | -(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | -
| [audit] | -|
| api_audit_map = api_audit_map.conf | -(StrOpt) File containing mapping for api paths and service endpoints | -
| namespace = openstack | -(StrOpt) namespace prefix for generated id | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| debug = False | +(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | +
| default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN | +(ListOpt) List of logger=LEVEL pairs. | +
| instance_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance that is passed with the log message. | +
| instance_uuid_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance UUID that is passed with the log message. | +
| log_config_append = None | +(StrOpt) 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. | +
| log_date_format = %Y-%m-%d %H:%M:%S | +(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . | +
| log_dir = None | +(StrOpt) (Optional) The base directory used for relative --log-file paths. | +
| log_file = None | +(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | +
| log_format = None | +(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | +
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages with context. | +
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | +(StrOpt) Data to append to log format when level is DEBUG. | +
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages without context. | +
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | +(StrOpt) Prefix each line of exception output with this format. | +
| publish_errors = False | +(BoolOpt) Enables or disables publication of error events. | +
| syslog_log_facility = LOG_USER | +(StrOpt) Syslog facility to receive log lines. | +
| use_stderr = True | +(BoolOpt) Log output to standard error. | +
| use_syslog = False | +(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424. | +
| use_syslog_rfc_format = False | +(BoolOpt) (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 I, and will be removed in J. | +
| verbose = False | +(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | +
| Configuration option = Default value | +Description | +
|---|---|
| [cells] | +|
| bandwidth_update_interval = 600 | +(IntOpt) Seconds between bandwidth updates for cells. | +
| call_timeout = 60 | +(IntOpt) Seconds to wait for response from a call to a cell. | +
| capabilities = hypervisor=xenserver;kvm, os=linux;windows | +(ListOpt) Key/Multi-value list with the capabilities of the cell | +
| cell_type = compute | +(StrOpt) Type of cell: api or compute | +
| enable = False | +(BoolOpt) Enable cell functionality | +
| manager = nova.cells.manager.CellsManager | +(StrOpt) Manager for cells | +
| mute_child_interval = 300 | +(IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute. | +
| name = nova | +(StrOpt) Name of this cell | +
| reserve_percent = 10.0 | +(FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization | +
| topic = cells | +(StrOpt) The topic cells nodes listen on | +
| [upgrade_levels] | +|
| cells = None | +(StrOpt) Set a version cap for messages sent to local cells services | +
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| enable_new_services = True | +(BoolOpt) Services to be added to the available pool on create | +
| instance_name_template = instance-%08x | +(StrOpt) Template string to be used to generate instance names | +
| network_api_class = nova.network.api.API | +(StrOpt) The full class name of the network API class to use | +
| snapshot_name_template = snapshot-%s | +(StrOpt) Template string to be used to generate snapshot names | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| qpid_heartbeat = 60 | -(IntOpt) Seconds between connection keepalive heartbeats | -
| qpid_hostname = localhost | -(StrOpt) Qpid broker hostname | -
| qpid_hosts = $qpid_hostname:$qpid_port | -(ListOpt) Qpid HA cluster host:port pairs | -
| qpid_password = | -(StrOpt) Password for qpid connection | -
| qpid_port = 5672 | -(IntOpt) Qpid broker port | -
| qpid_protocol = tcp | -(StrOpt) Transport to use, either 'tcp' or 'ssl' | -
| qpid_sasl_mechanisms = | -(StrOpt) Space separated list of SASL mechanisms to use for auth | -
| qpid_tcp_nodelay = True | -(BoolOpt) Disable Nagle algorithm | -
| qpid_topology_version = 1 | -(IntOpt) 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. | -
| qpid_username = | -(StrOpt) Username for qpid connection | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| qpid_heartbeat = 60 | +(IntOpt) Seconds between connection keepalive heartbeats. | +
| qpid_hostname = localhost | +(StrOpt) Qpid broker hostname. | +
| qpid_hosts = $qpid_hostname:$qpid_port | +(ListOpt) Qpid HA cluster host:port pairs. | +
| qpid_password = | +(StrOpt) Password for Qpid connection. | +
| qpid_port = 5672 | +(IntOpt) Qpid broker port. | +
| qpid_protocol = tcp | +(StrOpt) Transport to use, either 'tcp' or 'ssl'. | +
| qpid_sasl_mechanisms = | +(StrOpt) Space separated list of SASL mechanisms to use for auth. | +
| qpid_tcp_nodelay = True | +(BoolOpt) Whether to disable the Nagle algorithm. | +
| qpid_topology_version = 1 | +(IntOpt) 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. | +
| qpid_username = | +(StrOpt) Username for Qpid connection. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| fake_rabbit = False | -(BoolOpt) If passed, use a fake RabbitMQ provider | -
| kombu_ssl_ca_certs = | -(StrOpt) SSL certification authority file (valid only if SSL enabled) | -
| kombu_ssl_certfile = | -(StrOpt) SSL cert file (valid only if SSL enabled) | -
| kombu_ssl_keyfile = | -(StrOpt) SSL key file (valid only if SSL enabled) | -
| kombu_ssl_version = | -(StrOpt) If SSL is enabled, the SSL version to use. Valid values are TLSv1, SSLv23 and SSLv3. SSLv2 might be available on some distributions. | -
| rabbit_ha_queues = False | -(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| rabbit_host = localhost | -(StrOpt) The RabbitMQ broker address where a single node is used | -
| rabbit_hosts = $rabbit_host:$rabbit_port | -(ListOpt) RabbitMQ HA cluster host:port pairs | -
| rabbit_max_retries = 0 | -(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count) | -
| rabbit_password = guest | -(StrOpt) The RabbitMQ password | -
| rabbit_port = 5672 | -(IntOpt) The RabbitMQ broker port where a single node is used | -
| rabbit_retry_backoff = 2 | -(IntOpt) How long to backoff for between retries when connecting to RabbitMQ | -
| rabbit_retry_interval = 1 | -(IntOpt) How frequently to retry connecting with RabbitMQ | -
| rabbit_use_ssl = False | -(BoolOpt) Connect over SSL for RabbitMQ | -
| rabbit_userid = guest | -(StrOpt) The RabbitMQ userid | -
| rabbit_virtual_host = / | -(StrOpt) The RabbitMQ virtual host | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| fake_rabbit = False | +(BoolOpt) If passed, use a fake RabbitMQ provider | +
| kombu_reconnect_delay = 1.0 | +(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | +
| kombu_ssl_ca_certs = | +(StrOpt) SSL certification authority file (valid only if SSL enabled). | +
| kombu_ssl_certfile = | +(StrOpt) SSL cert file (valid only if SSL enabled). | +
| kombu_ssl_keyfile = | +(StrOpt) SSL key file (valid only if SSL enabled). | +
| kombu_ssl_version = | +(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions. | +
| rabbit_ha_queues = False | +(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | +
| rabbit_host = localhost | +(StrOpt) The RabbitMQ broker address where a single node is used. | +
| rabbit_hosts = $rabbit_host:$rabbit_port | +(ListOpt) RabbitMQ HA cluster host:port pairs. | +
| rabbit_login_method = AMQPLAIN | +(StrOpt) the RabbitMQ login method | +
| rabbit_max_retries = 0 | +(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | +
| rabbit_password = guest | +(StrOpt) The RabbitMQ password. | +
| rabbit_port = 5672 | +(IntOpt) The RabbitMQ broker port where a single node is used. | +
| rabbit_retry_backoff = 2 | +(IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | +
| rabbit_retry_interval = 1 | +(IntOpt) How frequently to retry connecting with RabbitMQ. | +
| rabbit_use_ssl = False | +(BoolOpt) Connect over SSL for RabbitMQ. | +
| rabbit_userid = guest | +(StrOpt) The RabbitMQ userid. | +
| rabbit_virtual_host = / | +(StrOpt) The RabbitMQ virtual host. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| host = oslo | -(StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address. | -
| matchmaker_heartbeat_freq = 300 | -(IntOpt) Heartbeat frequency | -
| matchmaker_heartbeat_ttl = 600 | -(IntOpt) Heartbeat time-to-live. | -
| [matchmaker_redis] | -|
| host = 127.0.0.1 | -(StrOpt) Host to locate redis | -
| password = None | -(StrOpt) Password for Redis server. (optional) | -
| port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| [matchmaker_ring] | -|
| ringfile = /etc/oslo/matchmaker_ring.json | -(StrOpt) Matchmaker ring file (JSON) | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| host = oslo | +(StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address. | +
| matchmaker_heartbeat_freq = 300 | +(IntOpt) Heartbeat frequency. | +
| matchmaker_heartbeat_ttl = 600 | +(IntOpt) Heartbeat time-to-live. | +
| [matchmaker_ring] | +|
| ringfile = /etc/oslo/matchmaker_ring.json | +(StrOpt) Matchmaker ring file (JSON). | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions | -(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call. | -
| dispatcher = ['database'] | -(MultiStrOpt) Dispatcher to process data. | -
| rpc_backend = ceilometer.openstack.common.rpc.impl_kombu | -(StrOpt) The messaging module to use, defaults to kombu. | -
| rpc_cast_timeout = 30 | -(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool | -
| rpc_response_timeout = 60 | -(IntOpt) Seconds to wait for a response from call or multicall | -
| rpc_thread_pool_size = 64 | -(IntOpt) Size of RPC thread pool | -
| rpc_zmq_bind_address = * | -(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| rpc_zmq_contexts = 1 | -(IntOpt) Number of ZeroMQ contexts, defaults to 1 | -
| rpc_zmq_host = oslo | -(StrOpt) 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 | -(StrOpt) Directory for holding IPC sockets | -
| rpc_zmq_matchmaker = ceilometer.openstack.common.rpc.matchmaker.MatchMakerLocalhost | -(StrOpt) MatchMaker driver | -
| rpc_zmq_port = 9501 | -(IntOpt) ZeroMQ receiver listening port | -
| rpc_zmq_topic_backlog = None | -(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| [publisher] | -|
| metering_secret = change this or be hacked | -(StrOpt) Secret value for signing metering messages. | -
| [publisher_rpc] | -|
| metering_topic = metering | -(StrOpt) The topic that ceilometer uses for metering messages. | -
| [rpc_notifier2] | -|
| topics = notifications | -(ListOpt) AMQP topic(s) used for OpenStack notifications | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions | +(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call. | +
| dispatcher = ['database'] | +(MultiStrOpt) Dispatcher to process data. | +
| password = None | +(StrOpt) Password for Redis server (optional). | +
| port = 6379 | +(IntOpt) Use this port to connect to redis host. | +
| rpc_backend = ceilometer.openstack.common.rpc.impl_kombu | +(StrOpt) The messaging module to use, defaults to kombu. | +
| rpc_cast_timeout = 30 | +(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | +
| rpc_conn_pool_size = 30 | +(IntOpt) Size of RPC connection pool | +
| rpc_response_timeout = 60 | +(IntOpt) Seconds to wait for a response from call or multicall | +
| rpc_thread_pool_size = 64 | +(IntOpt) Size of RPC thread pool | +
| rpc_zmq_bind_address = * | +(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | +
| rpc_zmq_contexts = 1 | +(IntOpt) Number of ZeroMQ contexts, defaults to 1. | +
| rpc_zmq_host = oslo | +(StrOpt) 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 | +(StrOpt) Directory for holding IPC sockets. | +
| rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost | +(StrOpt) MatchMaker driver. | +
| rpc_zmq_port = 9501 | +(IntOpt) ZeroMQ receiver listening port. | +
| rpc_zmq_topic_backlog = None | +(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | +
| transport_url = None | +(StrOpt) 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. | +
| [notification] | +|
| messaging_urls = [] | +(MultiStrOpt) Messaging URLs to listen for notifications. Example: transport://user:pass@host1:port[,hostN:portN]/virtual_host (DEFAULT/transport_url is used if empty) | +
| [publisher] | +|
| metering_secret = change this or be hacked | +(StrOpt) Secret value for signing metering messages. | +
| [publisher_rpc] | +|
| metering_topic = metering | +(StrOpt) The topic that ceilometer uses for metering messages. | +
| Configuration option = Default value | -Description | -
|---|---|
| [ssl] | -|
| ca_file = None | -(StrOpt) CA certificate file to use to verify connecting clients | -
| cert_file = None | -(StrOpt) Certificate file to use when starting the server securely | -
| key_file = None | -(StrOpt) Private key file to use when starting the server securely | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| reseller_prefix = AUTH_ | -(StrOpt) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| reseller_prefix = AUTH_ | +(StrOpt) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf. | +
| Configuration option = Default value | -Description | -
|---|---|
| [vmware] | -|
| api_retry_count = 10 | -(IntOpt) Number of times a VMware Vsphere API must be retried | -
| host_ip = | -(StrOpt) IP address of the VMware Vsphere host | -
| host_password = | -(StrOpt) Password of VMware Vsphere | -
| host_username = | -(StrOpt) Username of VMware Vsphere | -
| task_poll_interval = 0.5 | -(FloatOpt) Sleep time in seconds for polling an ongoing async task | -
| Configuration option = Default value | +Description | +
|---|---|
| [vmware] | +|
| api_retry_count = 10 | +(IntOpt) Number of times a VMware Vsphere API must be retried | +
| host_ip = | +(StrOpt) IP address of the VMware Vsphere host | +
| host_password = | +(StrOpt) Password of VMware Vsphere | +
| host_username = | +(StrOpt) Username of VMware Vsphere | +
| task_poll_interval = 0.5 | +(FloatOpt) Sleep time in seconds for polling an ongoing async task | +
| wsdl_location = None | +(StrOpt) Optional vim service WSDL location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| api_paste_config = api-paste.ini | -(StrOpt) File name for the paste.deploy config for cinder-api | -
| api_rate_limit = True | -(BoolOpt) whether to rate limit the api | -
| backdoor_port = None | -(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. | -
| enable_v1_api = True | -(BoolOpt) Deploy v1 of the Cinder API. | -
| enable_v2_api = True | -(BoolOpt) Deploy v2 of the Cinder API. | -
| extra_capabilities = {} | -(StrOpt) User defined capabilities, a JSON formatted string specifying key/value pairs. | -
| max_header_line = 16384 | -(IntOpt) Maximum line size of message headers to be accepted. 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_max_request_body_size = 114688 | -(IntOpt) Max size for body of a request | -
| osapi_volume_base_URL = None | -(StrOpt) Base URL that will be presented to users in links to the OpenStack Volume API | -
| osapi_volume_ext_list = | -(ListOpt) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions | -
| osapi_volume_extension = ['cinder.api.contrib.standard_extensions'] | -(MultiStrOpt) osapi volume extension to load | -
| osapi_volume_listen = 0.0.0.0 | -(StrOpt) IP address for OpenStack Volume API to listen | -
| osapi_volume_listen_port = 8776 | -(IntOpt) port for os volume api to listen | -
| osapi_volume_workers = None | -(IntOpt) Number of workers for OpenStack Volume API service | -
| transfer_api_class = cinder.transfer.api.API | -(StrOpt) The full class name of the volume transfer API class | -
| volume_api_class = cinder.volume.api.API | -(StrOpt) The full class name of the volume API class to use | -
| volume_name_template = volume-%s | -(StrOpt) Template string to be used to generate volume names | -
| volume_transfer_key_length = 16 | -(IntOpt) The number of characters in the autogenerated auth key. | -
| volume_transfer_salt_length = 8 | -(IntOpt) The number of characters in the salt. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| api_paste_config = api-paste.ini | +(StrOpt) File name for the paste.deploy config for cinder-api | +
| api_rate_limit = True | +(BoolOpt) Enables or disables rate limit of the API. | +
| az_cache_duration = 3600 | +(IntOpt) Cache volume availability zones in memory for the provided duration in seconds | +
| backdoor_port = None | +(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. | +
| enable_v1_api = True | +(BoolOpt) Deploy v1 of the Cinder API. | +
| enable_v2_api = True | +(BoolOpt) Deploy v2 of the Cinder API. | +
| extra_capabilities = {} | +(StrOpt) User defined capabilities, a JSON formatted string specifying key/value pairs. | +
| max_header_line = 16384 | +(IntOpt) Maximum line size of message headers to be accepted. 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 that a collection resource returns in a single response | +
| osapi_max_request_body_size = 114688 | +(IntOpt) Max size for body of a request | +
| osapi_volume_base_URL = None | +(StrOpt) Base URL that will be presented to users in links to the OpenStack Volume API | +
| osapi_volume_ext_list = | +(ListOpt) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions | +
| osapi_volume_extension = ['cinder.api.contrib.standard_extensions'] | +(MultiStrOpt) osapi volume extension to load | +
| osapi_volume_listen = 0.0.0.0 | +(StrOpt) IP address on which OpenStack Volume API listens | +
| osapi_volume_listen_port = 8776 | +(IntOpt) Port on which OpenStack Volume API listens | +
| transfer_api_class = cinder.transfer.api.API | +(StrOpt) The full class name of the volume transfer API class | +
| volume_api_class = cinder.volume.api.API | +(StrOpt) The full class name of the volume API class to use | +
| volume_name_template = volume-%s | +(StrOpt) Template string to be used to generate volume names | +
| volume_transfer_key_length = 16 | +(IntOpt) The number of characters in the autogenerated auth key. | +
| volume_transfer_salt_length = 8 | +(IntOpt) The number of characters in the salt. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| auth_strategy = noauth | -(StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| auth_strategy = noauth | +(StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| memcached_servers = None | -(ListOpt) Memcached servers or None for in process cache. | -
| [keystone_authtoken] | -|
| admin_password = None | -(StrOpt) Keystone account password | -
| admin_tenant_name = admin | -(StrOpt) Keystone service account tenant name to validate user tokens | -
| admin_token = None | -(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. | -
| admin_user = None | -(StrOpt) Keystone account username | -
| auth_admin_prefix = | -(StrOpt) Prefix to prepend at the beginning of the path | -
| auth_host = 127.0.0.1 | -(StrOpt) Host providing the admin Identity API endpoint | -
| auth_port = 35357 | -(IntOpt) Port of the admin Identity API endpoint | -
| auth_protocol = https | -(StrOpt) Protocol of the admin Identity API endpoint(http or https) | -
| auth_uri = None | -(StrOpt) Complete public Identity API endpoint | -
| auth_version = None | -(StrOpt) API version of the admin Identity API endpoint | -
| cache = None | -(StrOpt) Env key for the swift cache | -
| cafile = None | -(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| certfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| delay_auth_decision = False | -(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | -
| enforce_token_bind = permissive | -(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| http_connect_timeout = None | -(BoolOpt) Request timeout value for communicating with Identity API server. | -
| http_request_max_retries = 3 | -(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| include_service_catalog = True | -(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| insecure = False | -(BoolOpt) Verify HTTPS connections. | -
| keyfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| memcache_secret_key = None | -(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | -
| memcache_security_strategy = None | -(StrOpt) (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. | -
| memcached_servers = None | -(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| revocation_cache_time = 300 | -(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| signing_dir = None | -(StrOpt) Directory used to cache files related to PKI tokens | -
| token_cache_time = 300 | -(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| memcached_servers = None | +(ListOpt) Memcached servers or None for in process cache. | +
| [keystone_authtoken] | +|
| admin_password = None | +(StrOpt) Keystone account password | +
| admin_tenant_name = admin | +(StrOpt) Keystone service account tenant name to validate user tokens | +
| admin_token = None | +(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | +
| admin_user = None | +(StrOpt) Keystone account username | +
| auth_admin_prefix = | +(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | +
| auth_host = 127.0.0.1 | +(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_port = 35357 | +(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_protocol = https | +(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | +
| auth_uri = None | +(StrOpt) Complete public Identity API endpoint | +
| auth_version = None | +(StrOpt) API version of the admin Identity API endpoint | +
| cache = None | +(StrOpt) Env key for the swift cache | +
| cafile = None | +(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | +
| certfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| check_revocations_for_cached = False | +(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server. | +
| delay_auth_decision = False | +(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | +
| enforce_token_bind = permissive | +(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | +
| hash_algorithms = md5 | +(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | +
| http_connect_timeout = None | +(BoolOpt) Request timeout value for communicating with Identity API server. | +
| http_request_max_retries = 3 | +(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | +
| identity_uri = None | +(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | +
| include_service_catalog = True | +(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | +
| insecure = False | +(BoolOpt) Verify HTTPS connections. | +
| keyfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| memcache_secret_key = None | +(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | +
| memcache_security_strategy = None | +(StrOpt) (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. | +
| memcached_servers = None | +(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | +
| revocation_cache_time = 10 | +(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | +
| signing_dir = None | +(StrOpt) Directory used to cache files related to PKI tokens | +
| token_cache_time = 300 | +(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| backup_api_class = cinder.backup.api.API | -(StrOpt) The full class name of the volume backup API class | -
| backup_compression_algorithm = zlib | -(StrOpt) Compression algorithm (None to disable) | -
| backup_driver = cinder.backup.drivers.swift | -(StrOpt) Driver to use for backups. | -
| backup_manager = cinder.backup.manager.BackupManager | -(StrOpt) full class name for the Manager for volume backup | -
| backup_metadata_version = 1 | -(IntOpt) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version. | -
| backup_name_template = backup-%s | -(StrOpt) Template string to be used to generate backup names | -
| backup_topic = cinder-backup | -(StrOpt) the topic volume backup nodes listen on | -
| snapshot_name_template = snapshot-%s | -(StrOpt) Template string to be used to generate snapshot names | -
| snapshot_same_host = True | -(BoolOpt) Create volume from snapshot at the host where snapshot resides | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| backup_api_class = cinder.backup.api.API | +(StrOpt) The full class name of the volume backup API class | +
| backup_compression_algorithm = zlib | +(StrOpt) Compression algorithm (None to disable) | +
| backup_driver = cinder.backup.drivers.swift | +(StrOpt) Driver to use for backups. | +
| backup_manager = cinder.backup.manager.BackupManager | +(StrOpt) Full class name for the Manager for volume backup | +
| backup_metadata_version = 1 | +(IntOpt) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version. | +
| backup_name_template = backup-%s | +(StrOpt) Template string to be used to generate backup names | +
| backup_topic = cinder-backup | +(StrOpt) The topic that volume backup nodes listen on | +
| snapshot_name_template = snapshot-%s | +(StrOpt) Template string to be used to generate snapshot names | +
| snapshot_same_host = True | +(BoolOpt) Create volume from snapshot at the host where snapshot resides | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| backup_ceph_chunk_size = 134217728 | -(IntOpt) The chunk size, in bytes, that a backup is broken into before transfer to the Ceph object store. | -
| backup_ceph_conf = /etc/ceph/ceph.conf | -(StrOpt) Ceph configuration file to use. | -
| backup_ceph_pool = backups | -(StrOpt) The Ceph pool where volume backups are stored. | -
| backup_ceph_stripe_count = 0 | -(IntOpt) RBD stripe count to use when creating a backup image. | -
| backup_ceph_stripe_unit = 0 | -(IntOpt) RBD stripe unit to use when creating a backup image. | -
| backup_ceph_user = cinder | -(StrOpt) The Ceph user to connect with. Default here is to use the same user as for Cinder volumes. If not using cephx this should be set to None. | -
| restore_discard_excess_bytes = True | -(BoolOpt) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| backup_ceph_chunk_size = 134217728 | +(IntOpt) The chunk size, in bytes, that a backup is broken into before transfer to the Ceph object store. | +
| backup_ceph_conf = /etc/ceph/ceph.conf | +(StrOpt) Ceph configuration file to use. | +
| backup_ceph_pool = backups | +(StrOpt) The Ceph pool where volume backups are stored. | +
| backup_ceph_stripe_count = 0 | +(IntOpt) RBD stripe count to use when creating a backup image. | +
| backup_ceph_stripe_unit = 0 | +(IntOpt) RBD stripe unit to use when creating a backup image. | +
| backup_ceph_user = cinder | +(StrOpt) The Ceph user to connect with. Default here is to use the same user as for Cinder volumes. If not using cephx this should be set to None. | +
| restore_discard_excess_bytes = True | +(BoolOpt) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| backup_swift_auth = per_user | -(StrOpt) Swift authentication mechanism | -
| backup_swift_container = volumebackups | -(StrOpt) The default Swift container to use | -
| backup_swift_key = None | -(StrOpt) Swift key for authentication | -
| backup_swift_object_size = 52428800 | -(IntOpt) The size in bytes of Swift backup objects | -
| backup_swift_retry_attempts = 3 | -(IntOpt) The number of retries to make for Swift operations | -
| backup_swift_retry_backoff = 2 | -(IntOpt) The backoff time in seconds between Swift retries | -
| backup_swift_url = http://localhost:8080/v1/AUTH_ | -(StrOpt) The URL of the Swift endpoint | -
| backup_swift_user = None | -(StrOpt) Swift user name | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| backup_swift_auth = per_user | +(StrOpt) Swift authentication mechanism | +
| backup_swift_container = volumebackups | +(StrOpt) The default Swift container to use | +
| backup_swift_key = None | +(StrOpt) Swift key for authentication | +
| backup_swift_object_size = 52428800 | +(IntOpt) The size in bytes of Swift backup objects | +
| backup_swift_retry_attempts = 3 | +(IntOpt) The number of retries to make for Swift operations | +
| backup_swift_retry_backoff = 2 | +(IntOpt) The backoff time in seconds between Swift retries | +
| backup_swift_url = http://localhost:8080/v1/AUTH_ | +(StrOpt) The URL of the Swift endpoint | +
| backup_swift_user = None | +(StrOpt) Swift user name | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| backup_tsm_compression = True | -(BoolOpt) Enable or Disable compression for backups | -
| backup_tsm_password = password | -(StrOpt) TSM password for the running username | -
| backup_tsm_volume_prefix = backup | -(StrOpt) Volume prefix for the backup id when backing up to TSM | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| backup_tsm_compression = True | +(BoolOpt) Enable or Disable compression for backups | +
| backup_tsm_password = password | +(StrOpt) TSM password for the running username | +
| backup_tsm_volume_prefix = backup | +(StrOpt) Volume prefix for the backup id when backing up to TSM | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| available_devices = | -(ListOpt) List of all available devices | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| available_devices = | +(ListOpt) List of all available devices | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| compute_api_class = cinder.compute.nova.API | -(StrOpt) The full class name of the compute API class to use | -
| debug = False | -(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | -
| default_availability_zone = None | -(StrOpt) default availability zone to use when creating a new volume. If this is not set then we use the value from the storage_availability_zone option as the default availability_zone for new volumes. | -
| 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 | -(ListOpt) List of logger=LEVEL pairs | -
| default_volume_type = None | -(StrOpt) default volume type to use | -
| disable_process_locking = False | -(BoolOpt) Whether to disable inter-process locks | -
| enable_new_services = True | -(BoolOpt) Services to be added to the available pool on create | -
| fatal_deprecations = False | -(BoolOpt) Make deprecations fatal | -
| fatal_exception_format_errors = False | -(BoolOpt) make exception message format errors fatal | -
| host = oslo | -(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. | -
| iet_conf = /etc/iet/ietd.conf | -(StrOpt) IET configuration file | -
| lio_initiator_iqns = | -(StrOpt) Comma-separated list of initiator IQNs allowed to connect to the iSCSI target. (From Nova compute nodes.) | -
| lock_path = None | -(StrOpt) Directory to use for lock files. Default to a temp directory | -
| log_config_append = None | -(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files. | -
| log_date_format = %Y-%m-%d %H:%M:%S | -(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s | -
| log_dir = None | -(StrOpt) (Optional) The base directory used for relative --log-file paths | -
| log_file = None | -(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | -
| log_format = None | -(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | -
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | -(StrOpt) Format string to use for log messages with context | -
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | -(StrOpt) Data to append to log format when level is DEBUG | -
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | -(StrOpt) Format string to use for log messages without context | -
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -(StrOpt) Prefix each line of exception output with this format | -
| monkey_patch = False | -(BoolOpt) Enable monkey patching | -
| monkey_patch_modules = | -(ListOpt) List of modules/decorators to monkey patch | -
| my_ip = 10.0.0.1 | -(StrOpt) ip address of this host | -
| no_snapshot_gb_quota = False | -(BoolOpt) Whether snapshots count against GigaByte quota | -
| num_shell_tries = 3 | -(IntOpt) number of times to attempt to run flakey shell commands | -
| periodic_fuzzy_delay = 60 | -(IntOpt) range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) | -
| periodic_interval = 60 | -(IntOpt) seconds between running periodic tasks | -
| policy_default_rule = default | -(StrOpt) Rule checked when requested rule is not found | -
| policy_file = policy.json | -(StrOpt) JSON file representing policy | -
| report_interval = 10 | -(IntOpt) seconds between nodes reporting state to datastore | -
| reserved_percentage = 0 | -(IntOpt) The percentage of backend capacity is reserved | -
| rootwrap_config = /etc/cinder/rootwrap.conf | -(StrOpt) Path to the rootwrap configuration file to use for running commands as root | -
| run_external_periodic_tasks = True | -(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here? | -
| service_down_time = 60 | -(IntOpt) maximum time since last check-in for up service | -
| sqlite_db = cinder.sqlite | -(StrOpt) the filename to use with sqlite | -
| sqlite_synchronous = True | -(BoolOpt) If true, use synchronous mode for sqlite | -
| ssl_ca_file = None | -(StrOpt) CA certificate file to use to verify connecting clients | -
| ssl_cert_file = None | -(StrOpt) Certificate file to use when starting the server securely | -
| ssl_key_file = None | -(StrOpt) Private key file to use when starting the server securely | -
| state_path = /var/lib/cinder | -(StrOpt) Top-level directory for maintaining cinder's state | -
| storage_availability_zone = nova | -(StrOpt) availability zone of this node | -
| syslog_log_facility = LOG_USER | -(StrOpt) Syslog facility to receive log lines | -
| tcp_keepidle = 600 | -(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. | -
| until_refresh = 0 | -(IntOpt) count of reservations until usage is refreshed | -
| use_forwarded_for = False | -(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. | -
| use_stderr = True | -(BoolOpt) Log output to standard error | -
| use_syslog = False | -(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424 | -
| use_syslog_rfc_format = False | -(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J. | -
| verbose = False | -(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | -
| [database] | -|
| idle_timeout = 3600 | -(IntOpt) timeout before idle sql connections are reaped | -
| retry_interval = 10 | -(IntOpt) interval between retries of opening a sql connection | -
| use_tpool = False | -(BoolOpt) Enable the experimental use of thread pooling for all DB API calls | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| compute_api_class = cinder.compute.nova.API | +(StrOpt) The full class name of the compute API class to use | +
| debug = False | +(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | +
| default_availability_zone = None | +(StrOpt) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes. | +
| 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 | +(ListOpt) List of logger=LEVEL pairs. | +
| default_volume_type = None | +(StrOpt) Default volume type to use | +
| disable_process_locking = False | +(BoolOpt) Whether to disable inter-process locks | +
| enable_new_services = True | +(BoolOpt) Services to be added to the available pool on create | +
| fatal_deprecations = False | +(BoolOpt) Enables or disables fatal status of deprecations. | +
| fatal_exception_format_errors = False | +(BoolOpt) make exception message format errors fatal | +
| host = oslo | +(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address. | +
| iet_conf = /etc/iet/ietd.conf | +(StrOpt) IET configuration file | +
| lio_initiator_iqns = | +(StrOpt) Comma-separated list of initiator IQNs allowed to connect to the iSCSI target. (From Nova compute nodes.) | +
| lock_path = None | +(StrOpt) Directory to use for lock files. Default to a temp directory | +
| log_config_append = None | +(StrOpt) 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. | +
| log_date_format = %Y-%m-%d %H:%M:%S | +(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . | +
| log_dir = None | +(StrOpt) (Optional) The base directory used for relative --log-file paths. | +
| log_file = None | +(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | +
| log_format = None | +(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | +
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages with context. | +
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | +(StrOpt) Data to append to log format when level is DEBUG. | +
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages without context. | +
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | +(StrOpt) Prefix each line of exception output with this format. | +
| monkey_patch = False | +(BoolOpt) Enable monkey patching | +
| monkey_patch_modules = | +(ListOpt) List of modules/decorators to monkey patch | +
| my_ip = 10.0.0.1 | +(StrOpt) IP address of this host | +
| no_snapshot_gb_quota = False | +(BoolOpt) Whether snapshots count against GigaByte quota | +
| num_shell_tries = 3 | +(IntOpt) Number of times to attempt to run flakey shell commands | +
| periodic_fuzzy_delay = 60 | +(IntOpt) Range, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) | +
| periodic_interval = 60 | +(IntOpt) Interval, in seconds, between running periodic tasks | +
| policy_default_rule = default | +(StrOpt) Rule checked when requested rule is not found | +
| policy_file = policy.json | +(StrOpt) JSON file representing policy | +
| report_interval = 10 | +(IntOpt) Interval, in seconds, between nodes reporting state to datastore | +
| reserved_percentage = 0 | +(IntOpt) The percentage of backend capacity is reserved | +
| rootwrap_config = /etc/cinder/rootwrap.conf | +(StrOpt) Path to the rootwrap configuration file to use for running commands as root | +
| run_external_periodic_tasks = True | +(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here? | +
| service_down_time = 60 | +(IntOpt) Maximum time since last check-in for a service to be considered up | +
| ssl_ca_file = None | +(StrOpt) CA certificate file to use to verify connecting clients | +
| ssl_cert_file = None | +(StrOpt) Certificate file to use when starting the server securely | +
| ssl_key_file = None | +(StrOpt) Private key file to use when starting the server securely | +
| state_path = /var/lib/cinder | +(StrOpt) Top-level directory for maintaining cinder's state | +
| storage_availability_zone = nova | +(StrOpt) Availability zone of this node | +
| syslog_log_facility = LOG_USER | +(StrOpt) Syslog facility to receive log lines. | +
| tcp_keepalive = True | +(BoolOpt) Sets the value of TCP_KEEPALIVE (True/False) for each server socket. | +
| tcp_keepalive_count = None | +(IntOpt) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X. | +
| tcp_keepalive_interval = None | +(IntOpt) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X. | +
| tcp_keepidle = 600 | +(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. | +
| until_refresh = 0 | +(IntOpt) Count of reservations until usage is refreshed | +
| use_forwarded_for = False | +(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. | +
| use_stderr = True | +(BoolOpt) Log output to standard error. | +
| use_syslog = False | +(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will chang in J to honor RFC5424. | +
| use_syslog_rfc_format = False | +(BoolOpt) (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 I, and will be removed in J. | +
| verbose = False | +(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| nova_api_insecure = False | -(BoolOpt) Allow to perform insecure SSL requests to nova | -
| nova_ca_certificates_file = None | -(StrOpt) Location of ca certificates file to use for nova client requests. | -
| nova_catalog_admin_info = compute:nova:adminURL | -(StrOpt) Same as nova_catalog_info, but for admin endpoint. | -
| nova_catalog_info = compute:nova:publicURL | -(StrOpt) Info to match when looking for nova in the service catalog. Format is : separated values of the form: <service_type>:<service_name>:<endpoint_type> | -
| nova_endpoint_admin_template = None | -(StrOpt) Same as nova_endpoint_template, but for admin endpoint. | -
| nova_endpoint_template = None | -(StrOpt) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s | -
| os_region_name = None | -(StrOpt) region name of this node | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| nova_api_insecure = False | +(BoolOpt) Allow to perform insecure SSL requests to nova | +
| nova_ca_certificates_file = None | +(StrOpt) Location of ca certificates file to use for nova client requests. | +
| nova_catalog_admin_info = compute:nova:adminURL | +(StrOpt) Same as nova_catalog_info, but for admin endpoint. | +
| nova_catalog_info = compute:nova:publicURL | +(StrOpt) Match this value when searching for nova in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> | +
| nova_endpoint_admin_template = None | +(StrOpt) Same as nova_endpoint_template, but for admin endpoint. | +
| nova_endpoint_template = None | +(StrOpt) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s | +
| os_region_name = None | +(StrOpt) Region name of this node | +
| Configuration option = Default value | -Description | -
|---|---|
| [database] | -|
| connection = sqlite:///$state_path/$sqlite_db | -(StrOpt) The SQLAlchemy connection string used to connect to the database | -
| connection_debug = 0 | -(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything | -
| connection_trace = False | -(BoolOpt) Add python stack traces to SQL as comment strings | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| coraid_esm_address = | -(StrOpt) IP address of Coraid ESM | -
| coraid_group = admin | -(StrOpt) Name of group on Coraid ESM to which coraid_user belongs (must have admin privilege) | -
| coraid_password = password | -(StrOpt) Password to connect to Coraid ESM | -
| coraid_repository_key = coraid_repository | -(StrOpt) Volume Type key name to store ESM Repository Name | -
| coraid_user = admin | -(StrOpt) User name to connect to Coraid ESM | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| coraid_esm_address = | +(StrOpt) IP address of Coraid ESM | +
| coraid_group = admin | +(StrOpt) Name of group on Coraid ESM to which coraid_user belongs (must have admin privilege) | +
| coraid_password = password | +(StrOpt) Password to connect to Coraid ESM | +
| coraid_repository_key = coraid_repository | +(StrOpt) Volume Type key name to store ESM Repository Name | +
| coraid_user = admin | +(StrOpt) User name to connect to Coraid ESM | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| db_backend = sqlalchemy | -(StrOpt) The backend to use for db | -
| db_driver = cinder.db | -(StrOpt) driver to use for database access | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| db_backend = sqlalchemy | +(StrOpt) The backend to use for db | +
| db_driver = cinder.db | +(StrOpt) Driver to use for database access | +
| sqlite_clean_db = clean.sqlite | +(StrOpt) File name of clean sqlite db | +
| [database] | +|
| backend = sqlalchemy | +(StrOpt) The backend to use for db | +
| connection = sqlite:///$state_path/$sqlite_db | +(StrOpt) The SQLAlchemy connection string used to connect to the database | +
| connection_debug = 0 | +(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything | +
| connection_trace = False | +(BoolOpt) Add python stack traces to SQL as comment strings | +
| db_inc_retry_interval = True | +(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval | +
| db_max_retries = 20 | +(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count) | +
| db_max_retry_interval = 10 | +(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled | +
| db_retry_interval = 1 | +(IntOpt) seconds between db connection retries | +
| idle_timeout = 3600 | +(IntOpt) Timeout before idle sql connections are reaped | +
| max_overflow = None | +(IntOpt) If set, use this value for max_overflow with sqlalchemy | +
| max_pool_size = None | +(IntOpt) Maximum number of SQL connections to keep open in a pool | +
| max_retries = 10 | +(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count) | +
| min_pool_size = 1 | +(IntOpt) Minimum number of SQL connections to keep open in a pool | +
| mysql_sql_mode = TRADITIONAL | +(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | +
| pool_timeout = None | +(IntOpt) If set, use this value for pool_timeout with sqlalchemy | +
| retry_interval = 10 | +(IntOpt) Interval between retries of opening a sql connection | +
| sqlite_db = cinder.sqlite | +(StrOpt) The file name to use with SQLite | +
| sqlite_synchronous = True | +(BoolOpt) If True, SQLite uses synchronous mode | +
| use_db_reconnect = False | +(BoolOpt) Enable the experimental use of database reconnect on connection lost | +
| use_tpool = False | +(BoolOpt) Enable the experimental use of thread pooling for all DB API calls | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| cinder_emc_config_file = /etc/cinder/cinder_emc_config.xml | -(StrOpt) use this file for cinder emc plugin config data | -
| max_luns_per_storage_group = 256 | -(IntOpt) Default max number of LUNs in a storage group | -
| naviseccli_path = | -(StrOpt) Naviseccli Path | -
| storage_vnx_pool_name = None | -(StrOpt) ISCSI pool name | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| cinder_emc_config_file = /etc/cinder/cinder_emc_config.xml | +(StrOpt) The configuration file for the Cinder EMC driver | +
| max_luns_per_storage_group = 256 | +(IntOpt) Default max number of LUNs in a storage group | +
| naviseccli_path = | +(StrOpt) Naviseccli Path | +
| storage_vnx_pool_name = None | +(StrOpt) ISCSI pool name | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| eqlx_chap_login = admin | -(StrOpt) Existing CHAP account name | -
| eqlx_chap_password = password | -(StrOpt) Password for specified CHAP account name | -
| eqlx_cli_max_retries = 5 | -(IntOpt) Maximum retry count for reconnection | -
| eqlx_cli_timeout = 30 | -(IntOpt) Timeout for the Group Manager cli command execution | -
| eqlx_group_name = group-0 | -(StrOpt) Group name to use for creating volumes | -
| eqlx_pool = default | -(StrOpt) Pool in which volumes will be created | -
| eqlx_use_chap = False | -(BoolOpt) Use CHAP authentication for targets? | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| eqlx_chap_login = admin | +(StrOpt) Existing CHAP account name | +
| eqlx_chap_password = password | +(StrOpt) Password for specified CHAP account name | +
| eqlx_cli_max_retries = 5 | +(IntOpt) Maximum retry count for reconnection | +
| eqlx_cli_timeout = 30 | +(IntOpt) Timeout for the Group Manager cli command execution | +
| eqlx_group_name = group-0 | +(StrOpt) Group name to use for creating volumes | +
| eqlx_pool = default | +(StrOpt) Pool in which volumes will be created | +
| eqlx_use_chap = False | +(BoolOpt) Use CHAP authentication for targets? | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| hds_cinder_config_file = /opt/hds/hus/cinder_hus_conf.xml | -(StrOpt) configuration file for HDS cinder plugin for HUS | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| hds_cinder_config_file = /opt/hds/hus/cinder_hus_conf.xml | +(StrOpt) The configuration file for the Cinder HDS driver for HUS | +
| hds_hnas_iscsi_config_file = /opt/hds/hnas/cinder_iscsi_conf.xml | +(StrOpt) configuration file for HDS iSCSI cinder plugin | +
| hds_hnas_nfs_config_file = /opt/hds/hnas/cinder_nfs_conf.xml | +(StrOpt) configuration file for HDS NFS cinder plugin | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| hp3par_api_url = | -(StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1 | -
| hp3par_cpg = OpenStack | -(StrOpt) The CPG to use for volume creation | -
| hp3par_cpg_snap = | -(StrOpt) The CPG to use for Snapshots for volumes. If empty hp3par_cpg will be used | -
| hp3par_debug = False | -(BoolOpt) Enable HTTP debugging to 3PAR | -
| hp3par_iscsi_ips = | -(ListOpt) List of target iSCSI addresses to use. | -
| hp3par_password = | -(StrOpt) 3PAR Super user password | -
| hp3par_snapshot_expiration = | -(StrOpt) The time in hours when a snapshot expires and is deleted. This must be larger than expiration | -
| hp3par_snapshot_retention = | -(StrOpt) The time in hours to retain a snapshot. You can't delete it before this expires. | -
| hp3par_username = | -(StrOpt) 3PAR Super user username | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| hp3par_api_url = | +(StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1 | +
| hp3par_cpg = OpenStack | +(StrOpt) The CPG to use for volume creation | +
| hp3par_cpg_snap = | +(StrOpt) The CPG to use for Snapshots for volumes. If empty hp3par_cpg will be used | +
| hp3par_debug = False | +(BoolOpt) Enable HTTP debugging to 3PAR | +
| hp3par_iscsi_ips = | +(ListOpt) List of target iSCSI addresses to use. | +
| hp3par_password = | +(StrOpt) 3PAR Super user password | +
| hp3par_snapshot_expiration = | +(StrOpt) The time in hours when a snapshot expires and is deleted. This must be larger than expiration | +
| hp3par_snapshot_retention = | +(StrOpt) The time in hours to retain a snapshot. You can't delete it before this expires. | +
| hp3par_username = | +(StrOpt) 3PAR Super user username | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| hplefthand_api_url = None | -(StrOpt) HP LeftHand WSAPI Server Url like https://<LeftHand ip>:8081/lhos | -
| hplefthand_clustername = None | -(StrOpt) HP LeftHand cluster name | -
| hplefthand_debug = False | -(BoolOpt) Enable HTTP debugging to LeftHand | -
| hplefthand_iscsi_chap_enabled = False | -(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled) | -
| hplefthand_password = None | -(StrOpt) HP LeftHand Super user password | -
| hplefthand_username = None | -(StrOpt) HP LeftHand Super user username | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| hplefthand_api_url = None | +(StrOpt) HP LeftHand WSAPI Server Url like https://<LeftHand ip>:8081/lhos | +
| hplefthand_clustername = None | +(StrOpt) HP LeftHand cluster name | +
| hplefthand_debug = False | +(BoolOpt) Enable HTTP debugging to LeftHand | +
| hplefthand_iscsi_chap_enabled = False | +(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled) | +
| hplefthand_password = None | +(StrOpt) HP LeftHand Super user password | +
| hplefthand_username = None | +(StrOpt) HP LeftHand Super user username | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| msa_vdisk = OpenStack | -(StrOpt) The VDisk to use for volume creation. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| msa_vdisk = OpenStack | +(StrOpt) The VDisk to use for volume creation. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| cinder_huawei_conf_file = /etc/cinder/cinder_huawei_conf.xml | -(StrOpt) config data for cinder huawei plugin | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| cinder_huawei_conf_file = /etc/cinder/cinder_huawei_conf.xml | +(StrOpt) The configuration file for the Cinder Huawei driver | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| allowed_direct_url_schemes = | -(ListOpt) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. | -
| glance_api_insecure = False | -(BoolOpt) Allow to perform insecure SSL (https) requests to glance | -
| glance_api_servers = $glance_host:$glance_port | -(ListOpt) A list of the glance api servers available to cinder ([hostname|ip]:port) | -
| glance_api_ssl_compression = False | -(BoolOpt) Whether to attempt to negotiate SSL layer compression when using SSL (https) requests. Set to False to disable SSL layer compression. In some cases disabling this may improve data throughput, eg when high network bandwidth is available and you are using already compressed image formats such as qcow2 . | -
| glance_api_version = 1 | -(IntOpt) Version of the glance api to use | -
| glance_host = $my_ip | -(StrOpt) default glance hostname or ip | -
| glance_num_retries = 0 | -(IntOpt) Number retries when downloading an image from glance | -
| glance_port = 9292 | -(IntOpt) default glance port | -
| glance_request_timeout = None | -(IntOpt) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used. | -
| image_conversion_dir = $state_path/conversion | -(StrOpt) Directory used for temporary storage during image conversion | -
| instance_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance is passed with the log message, format it like this | -
| instance_uuid_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance UUID is passed with the log message, format it like this | -
| use_multipath_for_image_xfer = False | -(BoolOpt) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers? | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| allowed_direct_url_schemes = | +(ListOpt) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. | +
| glance_api_insecure = False | +(BoolOpt) Allow to perform insecure SSL (https) requests to glance | +
| glance_api_servers = $glance_host:$glance_port | +(ListOpt) A list of the glance API servers available to cinder ([hostname|ip]:port) | +
| glance_api_ssl_compression = False | +(BoolOpt) Enables or disables negotiation of SSL layer compression. In some cases disabling compression can improve data throughput, such as when high network bandwidth is available and you use compressed image formats like qcow2. | +
| glance_api_version = 1 | +(IntOpt) Version of the glance API to use | +
| glance_core_properties = checksum, container_format, disk_format, image_name, image_id, min_disk, min_ram, name, size | +(ListOpt) Default core properties of image | +
| glance_host = $my_ip | +(StrOpt) Default glance host name or IP | +
| glance_num_retries = 0 | +(IntOpt) Number retries when downloading an image from glance | +
| glance_port = 9292 | +(IntOpt) Default glance port | +
| glance_request_timeout = None | +(IntOpt) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used. | +
| image_conversion_dir = $state_path/conversion | +(StrOpt) Directory used for temporary storage during image conversion | +
| instance_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance that is passed with the log message. | +
| instance_uuid_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance UUID that is passed with the log message. | +
| use_multipath_for_image_xfer = False | +(BoolOpt) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers? | +
| Configuration option = Default value | -Description | -
|---|---|
| [keymgr] | -|
| api_class = cinder.keymgr.conf_key_mgr.ConfKeyManager | -(StrOpt) The full class name of the key manager API class | -
| fixed_key = None | -(StrOpt) Fixed key returned by key manager, specified in hex | -
| Configuration option = Default value | +Description | +
|---|---|
| [keymgr] | +|
| api_class = cinder.keymgr.conf_key_mgr.ConfKeyManager | +(StrOpt) The full class name of the key manager API class | +
| fixed_key = None | +(StrOpt) Fixed key returned by key manager, specified in hex | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| lvm_mirrors = 0 | -(IntOpt) If set, create lvms with multiple mirrors. Note that this requires lvm_mirrors + 2 pvs with available space | -
| lvm_type = default | -(StrOpt) Type of LVM volumes to deploy; (default or thin) | -
| volume_group = cinder-volumes | -(StrOpt) Name for the VG that will contain exported volumes | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| lvm_mirrors = 0 | +(IntOpt) If set, create lvms with multiple mirrors. Note that this requires lvm_mirrors + 2 pvs with available space | +
| lvm_type = default | +(StrOpt) Type of LVM volumes to deploy; (default or thin) | +
| volume_group = cinder-volumes | +(StrOpt) Name for the VG that will contain exported volumes | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| nas_ip = | -(StrOpt) IP address or Hostname of NAS system. | -
| nas_login = admin | -(StrOpt) User name to connect to NAS system. | -
| nas_password = | -(StrOpt) Password to connect to NAS system. | -
| nas_private_key = | -(StrOpt) Filename of private key to use for SSH authentication. | -
| nas_ssh_port = 22 | -(IntOpt) SSH port to use to connect to NAS system. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| nas_ip = | +(StrOpt) IP address or Hostname of NAS system. | +
| nas_login = admin | +(StrOpt) User name to connect to NAS system. | +
| nas_password = | +(StrOpt) Password to connect to NAS system. | +
| nas_private_key = | +(StrOpt) Filename of private key to use for SSH authentication. | +
| nas_ssh_port = 22 | +(IntOpt) SSH port to use to connect to NAS system. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| netapp_login = None | -(StrOpt) Administrative user account name used to access the storage system or proxy server. | -
| netapp_password = None | -(StrOpt) Password for the administrative user account specified in the netapp_login option. | -
| netapp_server_hostname = None | -(StrOpt) The hostname (or IP address) for the storage system or proxy server. | -
| netapp_server_port = 80 | -(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server. | -
| netapp_size_multiplier = 1.2 | -(FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. | -
| netapp_storage_family = ontap_cluster | -(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. | -
| netapp_storage_protocol = None | -(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs. | -
| netapp_transport_type = http | -(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https. | -
| netapp_vfiler = None | -(StrOpt) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode and the storage protocol selected is iSCSI. Only use this option when utilizing the MultiStore feature on the NetApp storage system. | -
| netapp_volume_list = None | -(StrOpt) This option is only utilized when the storage protocol is configured to use iSCSI. This option is used to restrict provisioning to the specified controller volumes. Specify the value of this option to be a comma separated list of NetApp controller volume names to be used for provisioning. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| netapp_login = None | +(StrOpt) Administrative user account name used to access the storage system or proxy server. | +
| netapp_password = None | +(StrOpt) Password for the administrative user account specified in the netapp_login option. | +
| netapp_server_hostname = None | +(StrOpt) The hostname (or IP address) for the storage system or proxy server. | +
| netapp_server_port = 80 | +(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server. | +
| netapp_size_multiplier = 1.2 | +(FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. | +
| netapp_storage_family = ontap_cluster | +(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. | +
| netapp_storage_protocol = None | +(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs. | +
| netapp_transport_type = http | +(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https. | +
| netapp_vfiler = None | +(StrOpt) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode and the storage protocol selected is iSCSI. Only use this option when utilizing the MultiStore feature on the NetApp storage system. | +
| netapp_volume_list = None | +(StrOpt) This option is only utilized when the storage protocol is configured to use iSCSI. This option is used to restrict provisioning to the specified controller volumes. Specify the value of this option to be a comma separated list of NetApp controller volume names to be used for provisioning. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| expiry_thres_minutes = 720 | -(IntOpt) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share. | -
| netapp_login = None | -(StrOpt) Administrative user account name used to access the storage system or proxy server. | -
| netapp_password = None | -(StrOpt) Password for the administrative user account specified in the netapp_login option. | -
| netapp_server_hostname = None | -(StrOpt) The hostname (or IP address) for the storage system or proxy server. | -
| netapp_server_port = 80 | -(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server. | -
| netapp_storage_family = ontap_cluster | -(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. | -
| netapp_storage_protocol = None | -(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs. | -
| netapp_transport_type = http | -(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https. | -
| thres_avl_size_perc_start = 20 | -(IntOpt) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned. | -
| thres_avl_size_perc_stop = 60 | -(IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| expiry_thres_minutes = 720 | +(IntOpt) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share. | +
| netapp_login = None | +(StrOpt) Administrative user account name used to access the storage system or proxy server. | +
| netapp_password = None | +(StrOpt) Password for the administrative user account specified in the netapp_login option. | +
| netapp_server_hostname = None | +(StrOpt) The hostname (or IP address) for the storage system or proxy server. | +
| netapp_server_port = 80 | +(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server. | +
| netapp_storage_family = ontap_cluster | +(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. | +
| netapp_storage_protocol = None | +(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs. | +
| netapp_transport_type = http | +(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https. | +
| thres_avl_size_perc_start = 20 | +(IntOpt) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned. | +
| thres_avl_size_perc_stop = 60 | +(IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| netapp_login = None | -(StrOpt) Administrative user account name used to access the storage system or proxy server. | -
| netapp_password = None | -(StrOpt) Password for the administrative user account specified in the netapp_login option. | -
| netapp_server_hostname = None | -(StrOpt) The hostname (or IP address) for the storage system or proxy server. | -
| netapp_server_port = 80 | -(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server. | -
| netapp_size_multiplier = 1.2 | -(FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. | -
| netapp_storage_family = ontap_cluster | -(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. | -
| netapp_storage_protocol = None | -(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs. | -
| netapp_transport_type = http | -(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https. | -
| netapp_vserver = None | -(StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. If using the NFS storage protocol, this parameter is mandatory for storage service catalog support (utilized by Cinder volume type extra_specs support). If this option is specified, the exports belonging to the Vserver will only be used for provisioning in the future. Block storage volumes on exports not belonging to the Vserver specified by this option will continue to function normally. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| netapp_login = None | +(StrOpt) Administrative user account name used to access the storage system or proxy server. | +
| netapp_password = None | +(StrOpt) Password for the administrative user account specified in the netapp_login option. | +
| netapp_server_hostname = None | +(StrOpt) The hostname (or IP address) for the storage system or proxy server. | +
| netapp_server_port = 80 | +(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server. | +
| netapp_size_multiplier = 1.2 | +(FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. | +
| netapp_storage_family = ontap_cluster | +(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. | +
| netapp_storage_protocol = None | +(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs. | +
| netapp_transport_type = http | +(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https. | +
| netapp_vserver = None | +(StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. If using the NFS storage protocol, this parameter is mandatory for storage service catalog support (utilized by Cinder volume type extra_specs support). If this option is specified, the exports belonging to the Vserver will only be used for provisioning in the future. Block storage volumes on exports not belonging to the Vserver specified by this option will continue to function normally. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| expiry_thres_minutes = 720 | -(IntOpt) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share. | -
| netapp_copyoffload_tool_path = None | -(StrOpt) This option specifies the path of the NetApp copy offload tool binary. Ensure that the binary has execute permissions set which allow the effective user of the cinder-volume process to execute the file. | -
| netapp_login = None | -(StrOpt) Administrative user account name used to access the storage system or proxy server. | -
| netapp_password = None | -(StrOpt) Password for the administrative user account specified in the netapp_login option. | -
| netapp_server_hostname = None | -(StrOpt) The hostname (or IP address) for the storage system or proxy server. | -
| netapp_server_port = 80 | -(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server. | -
| netapp_storage_family = ontap_cluster | -(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. | -
| netapp_storage_protocol = None | -(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs. | -
| netapp_transport_type = http | -(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https. | -
| netapp_vserver = None | -(StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. If using the NFS storage protocol, this parameter is mandatory for storage service catalog support (utilized by Cinder volume type extra_specs support). If this option is specified, the exports belonging to the Vserver will only be used for provisioning in the future. Block storage volumes on exports not belonging to the Vserver specified by this option will continue to function normally. | -
| thres_avl_size_perc_start = 20 | -(IntOpt) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned. | -
| thres_avl_size_perc_stop = 60 | -(IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| expiry_thres_minutes = 720 | +(IntOpt) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share. | +
| netapp_copyoffload_tool_path = None | +(StrOpt) This option specifies the path of the NetApp copy offload tool binary. Ensure that the binary has execute permissions set which allow the effective user of the cinder-volume process to execute the file. | +
| netapp_login = None | +(StrOpt) Administrative user account name used to access the storage system or proxy server. | +
| netapp_password = None | +(StrOpt) Password for the administrative user account specified in the netapp_login option. | +
| netapp_server_hostname = None | +(StrOpt) The hostname (or IP address) for the storage system or proxy server. | +
| netapp_server_port = 80 | +(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server. | +
| netapp_storage_family = ontap_cluster | +(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. | +
| netapp_storage_protocol = None | +(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs. | +
| netapp_transport_type = http | +(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https. | +
| netapp_vserver = None | +(StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. If using the NFS storage protocol, this parameter is mandatory for storage service catalog support (utilized by Cinder volume type extra_specs support). If this option is specified, the exports belonging to the Vserver will only be used for provisioning in the future. Block storage volumes on exports not belonging to the Vserver specified by this option will continue to function normally. | +
| thres_avl_size_perc_start = 20 | +(IntOpt) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned. | +
| thres_avl_size_perc_stop = 60 | +(IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| netapp_controller_ips = None | -(StrOpt) This option is only utilized when the storage family is configured to eseries. This option is used to restrict provisioning to the specified controllers. Specify the value of this option to be a comma separated list of controller hostnames or IP addresses to be used for provisioning. | -
| netapp_login = None | -(StrOpt) Administrative user account name used to access the storage system or proxy server. | -
| netapp_password = None | -(StrOpt) Password for the administrative user account specified in the netapp_login option. | -
| netapp_sa_password = None | -(StrOpt) Password for the NetApp E-Series storage array. | -
| netapp_server_hostname = None | -(StrOpt) The hostname (or IP address) for the storage system or proxy server. | -
| netapp_server_port = 80 | -(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server. | -
| netapp_storage_family = ontap_cluster | -(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. | -
| netapp_storage_pools = None | -(StrOpt) This option is used to restrict provisioning to the specified storage pools. Only dynamic disk pools are currently supported. Specify the value of this option to be a comma separated list of disk pool names to be used for provisioning. | -
| netapp_transport_type = http | -(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https. | -
| netapp_webservice_path = /devmgr/v2 | -(StrOpt) This option is used to specify the path to the E-Series proxy application on a proxy server. The value is combined with the value of the netapp_transport_type, netapp_server_hostname, and netapp_server_port options to create the URL used by the driver to connect to the proxy application. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| netapp_controller_ips = None | +(StrOpt) This option is only utilized when the storage family is configured to eseries. This option is used to restrict provisioning to the specified controllers. Specify the value of this option to be a comma separated list of controller hostnames or IP addresses to be used for provisioning. | +
| netapp_login = None | +(StrOpt) Administrative user account name used to access the storage system or proxy server. | +
| netapp_password = None | +(StrOpt) Password for the administrative user account specified in the netapp_login option. | +
| netapp_sa_password = None | +(StrOpt) Password for the NetApp E-Series storage array. | +
| netapp_server_hostname = None | +(StrOpt) The hostname (or IP address) for the storage system or proxy server. | +
| netapp_server_port = 80 | +(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server. | +
| netapp_storage_family = ontap_cluster | +(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. | +
| netapp_storage_pools = None | +(StrOpt) This option is used to restrict provisioning to the specified storage pools. Only dynamic disk pools are currently supported. Specify the value of this option to be a comma separated list of disk pool names to be used for provisioning. | +
| netapp_transport_type = http | +(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https. | +
| netapp_webservice_path = /devmgr/v2 | +(StrOpt) This option is used to specify the path to the E-Series proxy application on a proxy server. The value is combined with the value of the netapp_transport_type, netapp_server_hostname, and netapp_server_port options to create the URL used by the driver to connect to the proxy application. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| nexenta_blocksize = | -(StrOpt) block size for volumes (blank=default,8KB) | -
| nexenta_host = | -(StrOpt) IP address of Nexenta SA | -
| nexenta_iscsi_target_portal_port = 3260 | -(IntOpt) Nexenta target portal port | -
| nexenta_password = nexenta | -(StrOpt) Password to connect to Nexenta SA | -
| nexenta_rest_port = 2000 | -(IntOpt) HTTP port to connect to Nexenta REST API server | -
| nexenta_rest_protocol = auto | -(StrOpt) Use http or https for REST connection (default auto) | -
| nexenta_rrmgr_compression = 0 | -(IntOpt) Enable stream compression, level 1..9. 1 - gives best speed; 9 - gives best compression. | -
| nexenta_rrmgr_connections = 2 | -(IntOpt) Number of TCP connections. | -
| nexenta_rrmgr_tcp_buf_size = 4096 | -(IntOpt) TCP Buffer size in KiloBytes. | -
| nexenta_sparse = False | -(BoolOpt) flag to create sparse volumes | -
| nexenta_sparsed_volumes = True | -(BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time. | -
| nexenta_target_group_prefix = cinder/ | -(StrOpt) prefix for iSCSI target groups on SA | -
| nexenta_target_prefix = iqn.1986-03.com.sun:02:cinder- | -(StrOpt) IQN prefix for iSCSI targets | -
| nexenta_user = admin | -(StrOpt) User name to connect to Nexenta SA | -
| nexenta_volume = cinder | -(StrOpt) pool on SA that will hold all volumes | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| nexenta_blocksize = | +(StrOpt) Block size for volumes (default=blank means 8KB) | +
| nexenta_host = | +(StrOpt) IP address of Nexenta SA | +
| nexenta_iscsi_target_portal_port = 3260 | +(IntOpt) Nexenta target portal port | +
| nexenta_password = nexenta | +(StrOpt) Password to connect to Nexenta SA | +
| nexenta_rest_port = 2000 | +(IntOpt) HTTP port to connect to Nexenta REST API server | +
| nexenta_rest_protocol = auto | +(StrOpt) Use http or https for REST connection (default auto) | +
| nexenta_rrmgr_compression = 0 | +(IntOpt) Enable stream compression, level 1..9. 1 - gives best speed; 9 - gives best compression. | +
| nexenta_rrmgr_connections = 2 | +(IntOpt) Number of TCP connections. | +
| nexenta_rrmgr_tcp_buf_size = 4096 | +(IntOpt) TCP Buffer size in KiloBytes. | +
| nexenta_sparse = False | +(BoolOpt) Enables or disables the creation of sparse volumes | +
| nexenta_sparsed_volumes = True | +(BoolOpt) Enables or disables the creation of volumes as sparsed files that take no space. If disabled (False), volume is created as a regular file, which takes a long time. | +
| nexenta_target_group_prefix = cinder/ | +(StrOpt) Prefix for iSCSI target groups on SA | +
| nexenta_target_prefix = iqn.1986-03.com.sun:02:cinder- | +(StrOpt) IQN prefix for iSCSI targets | +
| nexenta_user = admin | +(StrOpt) User name to connect to Nexenta SA | +
| nexenta_volume = cinder | +(StrOpt) SA Pool that holds all volumes | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| nexenta_mount_point_base = $state_path/mnt | -(StrOpt) Base dir containing mount points for nfs shares | -
| nexenta_nms_cache_volroot = True | -(BoolOpt) If set True cache NexentaStor appliance volroot option value. | -
| nexenta_shares_config = /etc/cinder/nfs_shares | -(StrOpt) File with the list of available nfs shares | -
| nexenta_volume_compression = on | -(StrOpt) Default compression value for new ZFS folders. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| nexenta_mount_point_base = $state_path/mnt | +(StrOpt) Base directory that contains NFS share mount points | +
| nexenta_nms_cache_volroot = True | +(BoolOpt) If set True cache NexentaStor appliance volroot option value. | +
| nexenta_shares_config = /etc/cinder/nfs_shares | +(StrOpt) File with the list of available nfs shares | +
| nexenta_volume_compression = on | +(StrOpt) Default compression value for new ZFS folders. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| max_age = 0 | -(IntOpt) number of seconds between subsequent usage refreshes | -
| quota_driver = cinder.quota.DbQuotaDriver | -(StrOpt) default driver to use for quota checks | -
| quota_gigabytes = 1000 | -(IntOpt) number of volume gigabytes (snapshots are also included) allowed per project | -
| quota_snapshots = 10 | -(IntOpt) number of volume snapshots allowed per project | -
| quota_volumes = 10 | -(IntOpt) number of volumes allowed per project | -
| reservation_expire = 86400 | -(IntOpt) number of seconds until a reservation expires | -
| use_default_quota_class = True | -(BoolOpt) whether to use default quota class for default quota | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| max_age = 0 | +(IntOpt) Number of seconds between subsequent usage refreshes | +
| quota_driver = cinder.quota.DbQuotaDriver | +(StrOpt) Default driver to use for quota checks | +
| quota_gigabytes = 1000 | +(IntOpt) Total amount of storage, in gigabytes, allowed for volumes and snapshots per project | +
| quota_snapshots = 10 | +(IntOpt) Number of volume snapshots allowed per project | +
| quota_volumes = 10 | +(IntOpt) Number of volumes allowed per project | +
| reservation_expire = 86400 | +(IntOpt) Number of seconds until a reservation expires | +
| use_default_quota_class = True | +(BoolOpt) Enables or disables use of default quota class with default quota. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| filters_path = /etc/cinder/rootwrap.d,/usr/share/cinder/rootwrap | -List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root ! | -
| exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin | -List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root ! | -
| use_syslog = False | -Enable logging to syslog Default value is False | -
| syslog_log_facility = syslog | -Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog' | -
| syslog_log_level = ERROR | -Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| filters_path = /etc/cinder/rootwrap.d,/usr/share/cinder/rootwrap | +List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root ! | +
| exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin | +List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root ! | +
| use_syslog = False | +Enable logging to syslog Default value is False | +
| syslog_log_facility = syslog | +Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog' | +
| syslog_log_level = ERROR | +Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions | -(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call. | -
| amqp_auto_delete = False | -(BoolOpt) Auto-delete queues in amqp. | -
| amqp_durable_queues = False | -(BoolOpt) Use durable queues in amqp. | -
| control_exchange = openstack | -(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| default_timeout = 20 | -(IntOpt) Default Time Out For CLI operations in minutes | -
| fake_rabbit = False | -(BoolOpt) If passed, use a fake RabbitMQ provider. | -
| kombu_reconnect_delay = 1.0 | -(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| kombu_ssl_ca_certs = | -(StrOpt) SSL certification authority file (valid only if SSL enabled). | -
| kombu_ssl_certfile = | -(StrOpt) SSL cert file (valid only if SSL enabled). | -
| kombu_ssl_keyfile = | -(StrOpt) SSL key file (valid only if SSL enabled). | -
| kombu_ssl_version = | -(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions. | -
| matchmaker_heartbeat_freq = 300 | -(IntOpt) Heartbeat frequency. | -
| matchmaker_heartbeat_ttl = 600 | -(IntOpt) Heartbeat time-to-live. | -
| notification_driver = [] | -(MultiStrOpt) Driver or drivers to handle sending notifications. | -
| notification_topics = notifications | -(ListOpt) AMQP topic used for OpenStack notifications. | -
| password = None | -(StrOpt) Password for Redis server (optional). | -
| port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| publish_errors = False | -(BoolOpt) Publish error events | -
| qpid_heartbeat = 60 | -(IntOpt) Seconds between connection keepalive heartbeats. | -
| qpid_hostname = localhost | -(StrOpt) Qpid broker hostname. | -
| qpid_hosts = $qpid_hostname:$qpid_port | -(ListOpt) Qpid HA cluster host:port pairs. | -
| qpid_password = | -(StrOpt) Password for Qpid connection. | -
| qpid_port = 5672 | -(IntOpt) Qpid broker port. | -
| qpid_protocol = tcp | -(StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| qpid_sasl_mechanisms = | -(StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| qpid_tcp_nodelay = True | -(BoolOpt) Whether to disable the Nagle algorithm. | -
| qpid_topology_version = 1 | -(IntOpt) 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. | -
| qpid_username = | -(StrOpt) Username for Qpid connection. | -
| rabbit_ha_queues = False | -(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| rabbit_host = localhost | -(StrOpt) The RabbitMQ broker address where a single node is used. | -
| rabbit_hosts = $rabbit_host:$rabbit_port | -(ListOpt) RabbitMQ HA cluster host:port pairs. | -
| rabbit_login_method = AMQPLAIN | -(StrOpt) the RabbitMQ login method | -
| rabbit_max_retries = 0 | -(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| rabbit_password = guest | -(StrOpt) The RabbitMQ password. | -
| rabbit_port = 5672 | -(IntOpt) The RabbitMQ broker port where a single node is used. | -
| rabbit_retry_backoff = 2 | -(IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| rabbit_retry_interval = 1 | -(IntOpt) How frequently to retry connecting with RabbitMQ. | -
| rabbit_use_ssl = False | -(BoolOpt) Connect over SSL for RabbitMQ. | -
| rabbit_userid = guest | -(StrOpt) The RabbitMQ userid. | -
| rabbit_virtual_host = / | -(StrOpt) The RabbitMQ virtual host. | -
| rpc_backend = rabbit | -(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| rpc_cast_timeout = 30 | -(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| rpc_response_timeout = 60 | -(IntOpt) Seconds to wait for a response from a call. | -
| rpc_thread_pool_size = 64 | -(IntOpt) Size of RPC greenthread pool. | -
| rpc_zmq_bind_address = * | -(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| rpc_zmq_contexts = 1 | -(IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| rpc_zmq_host = oslo | -(StrOpt) 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 | -(StrOpt) Directory for holding IPC sockets. | -
| rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost | -(StrOpt) MatchMaker driver. | -
| rpc_zmq_port = 9501 | -(IntOpt) ZeroMQ receiver listening port. | -
| rpc_zmq_topic_backlog = None | -(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| transport_url = None | -(StrOpt) 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. | -
| volume_topic = cinder-volume | -(StrOpt) the topic volume nodes listen on | -
| [matchmaker_ring] | -|
| ringfile = /etc/oslo/matchmaker_ring.json | -(StrOpt) Matchmaker ring file (JSON). | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions | +(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call. | +
| amqp_auto_delete = False | +(BoolOpt) Auto-delete queues in amqp. | +
| amqp_durable_queues = False | +(BoolOpt) Use durable queues in amqp. | +
| control_exchange = openstack | +(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | +
| default_timeout = 20 | +(IntOpt) Default Time Out For CLI operations in minutes | +
| fake_rabbit = False | +(BoolOpt) If passed, use a fake RabbitMQ provider. | +
| kombu_reconnect_delay = 1.0 | +(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | +
| kombu_ssl_ca_certs = | +(StrOpt) SSL certification authority file (valid only if SSL enabled). | +
| kombu_ssl_certfile = | +(StrOpt) SSL cert file (valid only if SSL enabled). | +
| kombu_ssl_keyfile = | +(StrOpt) SSL key file (valid only if SSL enabled). | +
| kombu_ssl_version = | +(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions. | +
| matchmaker_heartbeat_freq = 300 | +(IntOpt) Heartbeat frequency. | +
| matchmaker_heartbeat_ttl = 600 | +(IntOpt) Heartbeat time-to-live. | +
| notification_driver = [] | +(MultiStrOpt) Driver or drivers to handle sending notifications. | +
| notification_topics = notifications | +(ListOpt) AMQP topic used for OpenStack notifications. | +
| password = None | +(StrOpt) Password for Redis server (optional). | +
| port = 6379 | +(IntOpt) Use this port to connect to redis host. | +
| publish_errors = False | +(BoolOpt) Enables or disables publication of error events. | +
| qpid_heartbeat = 60 | +(IntOpt) Seconds between connection keepalive heartbeats. | +
| qpid_hostname = localhost | +(StrOpt) Qpid broker hostname. | +
| qpid_hosts = $qpid_hostname:$qpid_port | +(ListOpt) Qpid HA cluster host:port pairs. | +
| qpid_password = | +(StrOpt) Password for Qpid connection. | +
| qpid_port = 5672 | +(IntOpt) Qpid broker port. | +
| qpid_protocol = tcp | +(StrOpt) Transport to use, either 'tcp' or 'ssl'. | +
| qpid_sasl_mechanisms = | +(StrOpt) Space separated list of SASL mechanisms to use for auth. | +
| qpid_tcp_nodelay = True | +(BoolOpt) Whether to disable the Nagle algorithm. | +
| qpid_topology_version = 1 | +(IntOpt) 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. | +
| qpid_username = | +(StrOpt) Username for Qpid connection. | +
| rabbit_ha_queues = False | +(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | +
| rabbit_host = localhost | +(StrOpt) The RabbitMQ broker address where a single node is used. | +
| rabbit_hosts = $rabbit_host:$rabbit_port | +(ListOpt) RabbitMQ HA cluster host:port pairs. | +
| rabbit_login_method = AMQPLAIN | +(StrOpt) the RabbitMQ login method | +
| rabbit_max_retries = 0 | +(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | +
| rabbit_password = guest | +(StrOpt) The RabbitMQ password. | +
| rabbit_port = 5672 | +(IntOpt) The RabbitMQ broker port where a single node is used. | +
| rabbit_retry_backoff = 2 | +(IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | +
| rabbit_retry_interval = 1 | +(IntOpt) How frequently to retry connecting with RabbitMQ. | +
| rabbit_use_ssl = False | +(BoolOpt) Connect over SSL for RabbitMQ. | +
| rabbit_userid = guest | +(StrOpt) The RabbitMQ userid. | +
| rabbit_virtual_host = / | +(StrOpt) The RabbitMQ virtual host. | +
| rpc_backend = rabbit | +(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | +
| rpc_cast_timeout = 30 | +(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | +
| rpc_conn_pool_size = 30 | +(IntOpt) Size of RPC connection pool. | +
| rpc_response_timeout = 60 | +(IntOpt) Seconds to wait for a response from a call. | +
| rpc_thread_pool_size = 64 | +(IntOpt) Size of RPC greenthread pool. | +
| rpc_zmq_bind_address = * | +(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | +
| rpc_zmq_contexts = 1 | +(IntOpt) Number of ZeroMQ contexts, defaults to 1. | +
| rpc_zmq_host = oslo | +(StrOpt) 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 | +(StrOpt) Directory for holding IPC sockets. | +
| rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost | +(StrOpt) MatchMaker driver. | +
| rpc_zmq_port = 9501 | +(IntOpt) ZeroMQ receiver listening port. | +
| rpc_zmq_topic_backlog = None | +(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | +
| transport_url = None | +(StrOpt) 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. | +
| volume_topic = cinder-volume | +(StrOpt) The topic that volume nodes listen on | +
| [matchmaker_ring] | +|
| ringfile = /etc/oslo/matchmaker_ring.json | +(StrOpt) Matchmaker ring file (JSON). | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| san_zfs_volume_base = rpool/ | -(StrOpt) The ZFS path under which to create zvols for volumes. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| san_zfs_volume_base = rpool/ | +(StrOpt) The ZFS path under which to create zvols for volumes. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| san_clustername = | -(StrOpt) Cluster name to use for creating volumes | -
| san_ip = | -(StrOpt) IP address of SAN controller | -
| san_is_local = False | -(BoolOpt) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device | -
| san_login = admin | -(StrOpt) Username for SAN controller | -
| san_password = | -(StrOpt) Password for SAN controller | -
| san_private_key = | -(StrOpt) Filename of private key to use for SSH authentication | -
| san_ssh_port = 22 | -(IntOpt) SSH port to use with SAN | -
| san_thin_provision = True | -(BoolOpt) Use thin provisioning for SAN volumes? | -
| ssh_conn_timeout = 30 | -(IntOpt) SSH connection timeout in seconds | -
| ssh_max_pool_conn = 5 | -(IntOpt) Maximum ssh connections in the pool | -
| ssh_min_pool_conn = 1 | -(IntOpt) Minimum ssh connections in the pool | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| san_clustername = | +(StrOpt) Cluster name to use for creating volumes | +
| san_ip = | +(StrOpt) IP address of SAN controller | +
| san_is_local = False | +(BoolOpt) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device | +
| san_login = admin | +(StrOpt) Username for SAN controller | +
| san_password = | +(StrOpt) Password for SAN controller | +
| san_private_key = | +(StrOpt) Filename of private key to use for SSH authentication | +
| san_ssh_port = 22 | +(IntOpt) SSH port to use with SAN | +
| san_thin_provision = True | +(BoolOpt) Use thin provisioning for SAN volumes? | +
| ssh_conn_timeout = 30 | +(IntOpt) SSH connection timeout in seconds | +
| ssh_max_pool_conn = 5 | +(IntOpt) Maximum ssh connections in the pool | +
| ssh_min_pool_conn = 1 | +(IntOpt) Minimum ssh connections in the pool | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| scality_sofs_config = None | -(StrOpt) Path or URL to Scality SOFS configuration file | -
| scality_sofs_mount_point = $state_path/scality | -(StrOpt) Base dir where Scality SOFS shall be mounted | -
| scality_sofs_volume_dir = cinder/volumes | -(StrOpt) Path from Scality SOFS root to volume dir | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| scality_sofs_config = None | +(StrOpt) Path or URL to Scality SOFS configuration file | +
| scality_sofs_mount_point = $state_path/scality | +(StrOpt) Base dir where Scality SOFS shall be mounted | +
| scality_sofs_volume_dir = cinder/volumes | +(StrOpt) Path from Scality SOFS root to volume dir | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| scheduler_default_filters = AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter | -(ListOpt) Which filter class names to use for filtering hosts when not specified in the request. | -
| scheduler_default_weighers = CapacityWeigher | -(ListOpt) Which weigher class names to use for weighing hosts. | -
| scheduler_driver = cinder.scheduler.filter_scheduler.FilterScheduler | -(StrOpt) Default scheduler driver to use | -
| scheduler_host_manager = cinder.scheduler.host_manager.HostManager | -(StrOpt) The scheduler host manager class to use | -
| scheduler_json_config_location = | -(StrOpt) Absolute path to scheduler configuration JSON file. | -
| scheduler_manager = cinder.scheduler.manager.SchedulerManager | -(StrOpt) full class name for the Manager for scheduler | -
| scheduler_max_attempts = 3 | -(IntOpt) Maximum number of attempts to schedule an volume | -
| scheduler_topic = cinder-scheduler | -(StrOpt) the topic scheduler nodes listen on | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| scheduler_default_filters = AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter | +(ListOpt) Which filter class names to use for filtering hosts when not specified in the request. | +
| scheduler_default_weighers = CapacityWeigher | +(ListOpt) Which weigher class names to use for weighing hosts. | +
| scheduler_driver = cinder.scheduler.filter_scheduler.FilterScheduler | +(StrOpt) Default scheduler driver to use | +
| scheduler_host_manager = cinder.scheduler.host_manager.HostManager | +(StrOpt) The scheduler host manager class to use | +
| scheduler_json_config_location = | +(StrOpt) Absolute path to scheduler configuration JSON file. | +
| scheduler_manager = cinder.scheduler.manager.SchedulerManager | +(StrOpt) Full class name for the Manager for scheduler | +
| scheduler_max_attempts = 3 | +(IntOpt) Maximum number of attempts to schedule an volume | +
| scheduler_topic = cinder-scheduler | +(StrOpt) The topic that scheduler nodes listen on | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| sf_account_prefix = None | -(StrOpt) Create SolidFire accounts with this prefix. Any string can be used here, but the string "hostname" is special and will create a prefix using the cinder node hostsname (previous default behavior). The default is NO prefix. | -
| sf_allow_tenant_qos = False | -(BoolOpt) Allow tenants to specify QOS on create | -
| sf_api_port = 443 | -(IntOpt) SolidFire API port. Useful if the device api is behind a proxy on a different port. | -
| sf_emulate_512 = True | -(BoolOpt) Set 512 byte emulation on volume creation; | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| sf_account_prefix = None | +(StrOpt) Create SolidFire accounts with this prefix. Any string can be used here, but the string "hostname" is special and will create a prefix using the cinder node hostsname (previous default behavior). The default is NO prefix. | +
| sf_allow_tenant_qos = False | +(BoolOpt) Allow tenants to specify QOS on create | +
| sf_api_port = 443 | +(IntOpt) SolidFire API port. Useful if the device api is behind a proxy on a different port. | +
| sf_emulate_512 = True | +(BoolOpt) Set 512 byte emulation on volume creation; | +
| Configuration option = Default value | -Description | -
|---|---|
| [ssl] | -|
| ca_file = None | -(StrOpt) CA certificate file to use to verify connecting clients | -
| cert_file = None | -(StrOpt) Certificate file to use when starting the server securely | -
| key_file = None | -(StrOpt) Private key file to use when starting the server securely | -
| Configuration option = Default value | +Description | +
|---|---|
| [ssl] | +|
| ca_file = None | +(StrOpt) CA certificate file to use to verify connecting clients | +
| cert_file = None | +(StrOpt) Certificate file to use when starting the server securely | +
| key_file = None | +(StrOpt) Private key file to use when starting the server securely | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| allocated_capacity_weight_multiplier = -1.0 | -(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread. | -
| capacity_weight_multiplier = 1.0 | -(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread. | -
| enabled_backends = None | -(ListOpt) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options | -
| iscsi_helper = tgtadm | -(StrOpt) iscsi target user-land tool to use | -
| iscsi_iotype = fileio | -(StrOpt) Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device | -
| iscsi_ip_address = $my_ip | -(StrOpt) The IP address that the iSCSI daemon is listening on | -
| iscsi_num_targets = 100 | -(IntOpt) The maximum number of iscsi target ids per host | -
| iscsi_port = 3260 | -(IntOpt) The port that the iSCSI daemon is listening on | -
| iscsi_target_prefix = iqn.2010-10.org.openstack: | -(StrOpt) prefix for iscsi volumes | -
| iser_helper = tgtadm | -(StrOpt) iser target user-land tool to use | -
| iser_ip_address = $my_ip | -(StrOpt) The IP address that the iSER daemon is listening on | -
| iser_num_targets = 100 | -(IntOpt) The maximum number of iser target ids per host | -
| iser_port = 3260 | -(IntOpt) The port that the iSER daemon is listening on | -
| iser_target_prefix = iqn.2010-10.org.iser.openstack: | -(StrOpt) prefix for iser volumes | -
| max_gigabytes = 10000 | -(IntOpt) This configure option has been deprecated along with the SimpleScheduler. New scheduler is able to gather capacity information for each host, thus setting the maximum number of volume gigabytes for host is no longer needed. It's safe to remove this configure from cinder.conf. | -
| migration_create_volume_timeout_secs = 300 | -(IntOpt) Timeout for creating the volume to migrate to when performing volume migration (seconds) | -
| num_iser_scan_tries = 3 | -(IntOpt) The maximum number of times to rescan iSER targetto find volume | -
| num_volume_device_scan_tries = 3 | -(IntOpt) The maximum number of times to rescan targets to find volume | -
| volume_backend_name = None | -(StrOpt) The backend name for a given driver implementation | -
| volume_clear = zero | -(StrOpt) Method used to wipe old voumes (valid options are: none, zero, shred) | -
| volume_clear_ionice = None | -(StrOpt) The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority. | -
| volume_clear_size = 0 | -(IntOpt) Size in MiB to wipe at start of old volumes. 0 => all | -
| volume_dd_blocksize = 1M | -(StrOpt) The default block size used when copying/clearing volumes | -
| volume_driver = cinder.volume.drivers.lvm.LVMISCSIDriver | -(StrOpt) Driver to use for volume creation | -
| volume_manager = cinder.volume.manager.VolumeManager | -(StrOpt) full class name for the Manager for volume | -
| volume_service_inithost_offload = False | -(BoolOpt) Offload pending volume delete during volume service startup | -
| volume_usage_audit_period = month | -(StrOpt) time period to generate volume usages for. Time period must be hour, day, month or year | -
| volumes_dir = $state_path/volumes | -(StrOpt) Volume configuration file storage directory | -
| [database] | -|
| backend = sqlalchemy | -(StrOpt) The backend to use for db | -
| max_overflow = None | -(IntOpt) If set, use this value for max_overflow with sqlalchemy | -
| max_pool_size = 5 | -(IntOpt) Maximum number of SQL connections to keep open in a pool | -
| max_retries = 10 | -(IntOpt) maximum db connection retries during startup. (setting -1 implies an infinite retry count) | -
| min_pool_size = 1 | -(IntOpt) Minimum number of SQL connections to keep open in a pool | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| allocated_capacity_weight_multiplier = -1.0 | +(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread. | +
| capacity_weight_multiplier = 1.0 | +(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread. | +
| enabled_backends = None | +(ListOpt) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options | +
| iscsi_helper = tgtadm | +(StrOpt) iSCSI target user-land tool to use | +
| iscsi_iotype = fileio | +(StrOpt) Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device | +
| iscsi_ip_address = $my_ip | +(StrOpt) The IP address that the iSCSI daemon is listening on | +
| iscsi_num_targets = 100 | +(IntOpt) The maximum number of iSCSI target IDs per host | +
| iscsi_port = 3260 | +(IntOpt) The port that the iSCSI daemon is listening on | +
| iscsi_target_prefix = iqn.2010-10.org.openstack: | +(StrOpt) Prefix for iSCSI volumes | +
| iser_helper = tgtadm | +(StrOpt) The name of the iSER target user-land tool to use | +
| iser_ip_address = $my_ip | +(StrOpt) The IP address that the iSER daemon is listening on | +
| iser_num_targets = 100 | +(IntOpt) The maximum number of iSER target IDs per host | +
| iser_port = 3260 | +(IntOpt) The port that the iSER daemon is listening on | +
| iser_target_prefix = iqn.2010-10.org.iser.openstack: | +(StrOpt) Prefix for iSER volumes | +
| max_gigabytes = 10000 | +(IntOpt) This configure option has been deprecated along with the SimpleScheduler. New scheduler is able to gather capacity information for each host, thus setting the maximum number of volume gigabytes for host is no longer needed. It's safe to remove this configure from cinder.conf. | +
| migration_create_volume_timeout_secs = 300 | +(IntOpt) Timeout for creating the volume to migrate to when performing volume migration (seconds) | +
| num_iser_scan_tries = 3 | +(IntOpt) The maximum number of times to rescan iSER targetto find volume | +
| num_volume_device_scan_tries = 3 | +(IntOpt) The maximum number of times to rescan targets to find volume | +
| volume_backend_name = None | +(StrOpt) The backend name for a given driver implementation | +
| volume_clear = zero | +(StrOpt) Method used to wipe old volumes (valid options are: none, zero, shred) | +
| volume_clear_ionice = None | +(StrOpt) The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority. | +
| volume_clear_size = 0 | +(IntOpt) Size in MiB to wipe at start of old volumes. 0 => all | +
| volume_copy_blkio_cgroup_name = cinder-volume-copy | +(StrOpt) The blkio cgroup name to be used to limit bandwidth of volume copy | +
| volume_copy_bps_limit = 0 | +(IntOpt) The upper limit of bandwidth of volume copy. 0 => unlimited | +
| volume_dd_blocksize = 1M | +(StrOpt) The default block size used when copying/clearing volumes | +
| volume_driver = cinder.volume.drivers.lvm.LVMISCSIDriver | +(StrOpt) Driver to use for volume creation | +
| volume_manager = cinder.volume.manager.VolumeManager | +(StrOpt) Full class name for the Manager for volume | +
| volume_service_inithost_offload = False | +(BoolOpt) Offload pending volume delete during volume service startup | +
| volume_usage_audit_period = month | +(StrOpt) Time period for which to generate volume usages. The options are hour, day, month, or year. | +
| volumes_dir = $state_path/volumes | +(StrOpt) Volume configuration file storage directory | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| rbd_ceph_conf = | -(StrOpt) path to the ceph configuration file to use | -
| rbd_flatten_volume_from_snapshot = False | -(BoolOpt) flatten volumes created from snapshots to remove dependency | -
| rbd_max_clone_depth = 5 | -(IntOpt) maximum number of nested clones that can be taken of a volume before enforcing a flatten prior to next clone. A value of zero disables cloning | -
| rbd_pool = rbd | -(StrOpt) the RADOS pool in which rbd volumes are stored | -
| rbd_secret_uuid = None | -(StrOpt) the libvirt uuid of the secret for the rbd_uservolumes | -
| rbd_user = None | -(StrOpt) the RADOS client name for accessing rbd volumes - only set when using cephx authentication | -
| volume_tmp_dir = None | -(StrOpt) where to store temporary image files if the volume driver does not write them directly to the volume | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| rbd_ceph_conf = | +(StrOpt) Path to the ceph configuration file | +
| rbd_flatten_volume_from_snapshot = False | +(BoolOpt) Flatten volumes created from snapshots to remove dependency from volume to snapshot | +
| rbd_max_clone_depth = 5 | +(IntOpt) Maximum number of nested volume clones that are taken before a flatten occurs. Set to 0 to disable cloning. | +
| rbd_pool = rbd | +(StrOpt) The RADOS pool where rbd volumes are stored | +
| rbd_secret_uuid = None | +(StrOpt) The libvirt uuid of the secret for the rbd_user volumes | +
| rbd_store_chunk_size = 4 | +(IntOpt) Volumes will be chunked into objects of this size (in megabytes). | +
| rbd_user = None | +(StrOpt) The RADOS client name for accessing rbd volumes - only set when using cephx authentication | +
| volume_tmp_dir = None | +(StrOpt) Directory where temporary image files are stored when the volume driver does not write them directly to the volume. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| glusterfs_mount_point_base = $state_path/mnt | -(StrOpt) Base dir containing mount points for gluster shares. | -
| glusterfs_qcow2_volumes = False | -(BoolOpt) Create volumes as QCOW2 files rather than raw files. | -
| glusterfs_shares_config = /etc/cinder/glusterfs_shares | -(StrOpt) File with the list of available gluster shares | -
| glusterfs_sparsed_volumes = True | -(BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| glusterfs_mount_point_base = $state_path/mnt | +(StrOpt) Base dir containing mount points for gluster shares. | +
| glusterfs_qcow2_volumes = False | +(BoolOpt) Create volumes as QCOW2 files rather than raw files. | +
| glusterfs_shares_config = /etc/cinder/glusterfs_shares | +(StrOpt) File with the list of available gluster shares | +
| glusterfs_sparsed_volumes = True | +(BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| gpfs_images_dir = None | -(StrOpt) Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS. | -
| gpfs_images_share_mode = None | -(StrOpt) Specifies the type of image copy to be used. Set this when the Image service repository also uses GPFS so that image files can be transferred efficiently from the Image service to the Block Storage service. There are two valid values: "copy" specifies that a full copy of the image is made; "copy_on_write" specifies that copy-on-write optimization strategy is used and unmodified blocks of the image file are shared efficiently. | -
| gpfs_max_clone_depth = 0 | -(IntOpt) Specifies an upper limit on the number of indirections required to reach a specific block due to snapshots or clones. A lengthy chain of copy-on-write snapshots or clones can have a negative impact on performance, but improves space utilization. 0 indicates unlimited clone depth. | -
| gpfs_mount_point_base = None | -(StrOpt) Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored. | -
| gpfs_sparse_volumes = True | -(BoolOpt) Specifies that volumes are created as sparse files which initially consume no space. If set to False, the volume is created as a fully allocated file, in which case, creation may take a significantly longer time. | -
| gpfs_storage_pool = None | -(StrOpt) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| gpfs_images_dir = None | +(StrOpt) Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS. | +
| gpfs_images_share_mode = None | +(StrOpt) Specifies the type of image copy to be used. Set this when the Image service repository also uses GPFS so that image files can be transferred efficiently from the Image service to the Block Storage service. There are two valid values: "copy" specifies that a full copy of the image is made; "copy_on_write" specifies that copy-on-write optimization strategy is used and unmodified blocks of the image file are shared efficiently. | +
| gpfs_max_clone_depth = 0 | +(IntOpt) Specifies an upper limit on the number of indirections required to reach a specific block due to snapshots or clones. A lengthy chain of copy-on-write snapshots or clones can have a negative impact on performance, but improves space utilization. 0 indicates unlimited clone depth. | +
| gpfs_mount_point_base = None | +(StrOpt) Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored. | +
| gpfs_sparse_volumes = True | +(BoolOpt) Specifies that volumes are created as sparse files which initially consume no space. If set to False, the volume is created as a fully allocated file, in which case, creation may take a significantly longer time. | +
| gpfs_storage_pool = None | +(StrOpt) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| nfs_mount_options = None | -(StrOpt) Mount options passed to the nfs client. See section of the nfs man page for details. | -
| nfs_mount_point_base = $state_path/mnt | -(StrOpt) Base dir containing mount points for nfs shares. | -
| nfs_oversub_ratio = 1.0 | -(FloatOpt) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid. | -
| nfs_shares_config = /etc/cinder/nfs_shares | -(StrOpt) File with the list of available nfs shares | -
| nfs_sparsed_volumes = True | -(BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time. | -
| nfs_used_ratio = 0.95 | -(FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| nfs_mount_options = None | +(StrOpt) Mount options passed to the nfs client. See section of the nfs man page for details. | +
| nfs_mount_point_base = $state_path/mnt | +(StrOpt) Base dir containing mount points for nfs shares. | +
| nfs_oversub_ratio = 1.0 | +(FloatOpt) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid. | +
| nfs_shares_config = /etc/cinder/nfs_shares | +(StrOpt) File with the list of available nfs shares | +
| nfs_sparsed_volumes = True | +(BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time. | +
| nfs_used_ratio = 0.95 | +(FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| xenapi_connection_password = None | -(StrOpt) Password for XenAPI connection | -
| xenapi_connection_url = None | -(StrOpt) URL for XenAPI connection | -
| xenapi_connection_username = root | -(StrOpt) Username for XenAPI connection | -
| xenapi_nfs_server = None | -(StrOpt) NFS server to be used by XenAPINFSDriver | -
| xenapi_nfs_serverpath = None | -(StrOpt) Path of exported NFS, used by XenAPINFSDriver | -
| xenapi_sr_base_path = /var/run/sr-mount | -(StrOpt) Base path to the storage repository | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| xenapi_connection_password = None | +(StrOpt) Password for XenAPI connection | +
| xenapi_connection_url = None | +(StrOpt) URL for XenAPI connection | +
| xenapi_connection_username = root | +(StrOpt) Username for XenAPI connection | +
| xenapi_nfs_server = None | +(StrOpt) NFS server to be used by XenAPINFSDriver | +
| xenapi_nfs_serverpath = None | +(StrOpt) Path of exported NFS, used by XenAPINFSDriver | +
| xenapi_sr_base_path = /var/run/sr-mount | +(StrOpt) Base path to the storage repository | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| storwize_svc_connection_protocol = iSCSI | -(StrOpt) Connection protocol (iSCSI/FC) | -
| storwize_svc_flashcopy_timeout = 120 | -(IntOpt) Maximum number of seconds to wait for FlashCopy to be prepared. Maximum value is 600 seconds (10 minutes) | -
| storwize_svc_iscsi_chap_enabled = True | -(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Enabled) | -
| storwize_svc_multihostmap_enabled = True | -(BoolOpt) Allows vdisk to multi host mapping | -
| storwize_svc_multipath_enabled = False | -(BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova) | -
| storwize_svc_vol_autoexpand = True | -(BoolOpt) Storage system autoexpand parameter for volumes (True/False) | -
| storwize_svc_vol_compression = False | -(BoolOpt) Storage system compression option for volumes | -
| storwize_svc_vol_easytier = True | -(BoolOpt) Enable Easy Tier for volumes | -
| storwize_svc_vol_grainsize = 256 | -(IntOpt) Storage system grain size parameter for volumes (32/64/128/256) | -
| storwize_svc_vol_iogrp = 0 | -(IntOpt) The I/O group in which to allocate volumes | -
| storwize_svc_vol_rsize = 2 | -(IntOpt) Storage system space-efficiency parameter for volumes (percentage) | -
| storwize_svc_vol_warning = 0 | -(IntOpt) Storage system threshold for volume capacity warnings (percentage) | -
| storwize_svc_volpool_name = volpool | -(StrOpt) Storage system storage pool for volumes | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| storwize_svc_connection_protocol = iSCSI | +(StrOpt) Connection protocol (iSCSI/FC) | +
| storwize_svc_flashcopy_timeout = 120 | +(IntOpt) Maximum number of seconds to wait for FlashCopy to be prepared. Maximum value is 600 seconds (10 minutes) | +
| storwize_svc_iscsi_chap_enabled = True | +(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Enabled) | +
| storwize_svc_multihostmap_enabled = True | +(BoolOpt) Allows vdisk to multi host mapping | +
| storwize_svc_multipath_enabled = False | +(BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova) | +
| storwize_svc_vol_autoexpand = True | +(BoolOpt) Storage system autoexpand parameter for volumes (True/False) | +
| storwize_svc_vol_compression = False | +(BoolOpt) Storage system compression option for volumes | +
| storwize_svc_vol_easytier = True | +(BoolOpt) Enable Easy Tier for volumes | +
| storwize_svc_vol_grainsize = 256 | +(IntOpt) Storage system grain size parameter for volumes (32/64/128/256) | +
| storwize_svc_vol_iogrp = 0 | +(IntOpt) The I/O group in which to allocate volumes | +
| storwize_svc_vol_rsize = 2 | +(IntOpt) Storage system space-efficiency parameter for volumes (percentage) | +
| storwize_svc_vol_warning = 0 | +(IntOpt) Storage system threshold for volume capacity warnings (percentage) | +
| storwize_svc_volpool_name = volpool | +(StrOpt) Storage system storage pool for volumes | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| vmware_api_retry_count = 10 | -(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues. | -
| vmware_host_ip = None | -(StrOpt) IP address for connecting to VMware ESX/VC server. | -
| vmware_host_password = None | -(StrOpt) Password for authenticating with VMware ESX/VC server. | -
| vmware_host_username = None | -(StrOpt) Username for authenticating with VMware ESX/VC server. | -
| vmware_host_version = None | -(StrOpt) Optional string specifying the VMware VC server version. The driver attempts to retrieve the version from VMware VC server. Set this configuration only if you want to override the VC server version. | -
| vmware_image_transfer_timeout_secs = 7200 | -(IntOpt) Timeout in seconds for VMDK volume transfer between Cinder and Glance. | -
| vmware_max_objects_retrieval = 100 | -(IntOpt) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value. | -
| vmware_task_poll_interval = 5 | -(IntOpt) The interval (in seconds) for polling remote tasks invoked on VMware ESX/VC server. | -
| vmware_volume_folder = cinder-volumes | -(StrOpt) Name for the folder in the VC datacenter that will contain cinder volumes. | -
| vmware_wsdl_location = None | -(StrOpt) Optional VIM service WSDL Location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| vmware_api_retry_count = 10 | +(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues. | +
| vmware_host_ip = None | +(StrOpt) IP address for connecting to VMware ESX/VC server. | +
| vmware_host_password = None | +(StrOpt) Password for authenticating with VMware ESX/VC server. | +
| vmware_host_username = None | +(StrOpt) Username for authenticating with VMware ESX/VC server. | +
| vmware_host_version = None | +(StrOpt) Optional string specifying the VMware VC server version. The driver attempts to retrieve the version from VMware VC server. Set this configuration only if you want to override the VC server version. | +
| vmware_image_transfer_timeout_secs = 7200 | +(IntOpt) Timeout in seconds for VMDK volume transfer between Cinder and Glance. | +
| vmware_max_objects_retrieval = 100 | +(IntOpt) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value. | +
| vmware_task_poll_interval = 5 | +(IntOpt) The interval (in seconds) for polling remote tasks invoked on VMware ESX/VC server. | +
| vmware_volume_folder = cinder-volumes | +(StrOpt) Name for the folder in the VC datacenter that will contain cinder volumes. | +
| vmware_wsdl_location = None | +(StrOpt) Optional VIM service WSDL Location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| windows_iscsi_lun_path = C:\iSCSIVirtualDisks | -(StrOpt) Path to store VHD backed volumes | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| windows_iscsi_lun_path = C:\iSCSIVirtualDisks | +(StrOpt) Path to store VHD backed volumes | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| xiv_chap = disabled | -(StrOpt) CHAP authentication mode, effective only for iscsi (disabled|enabled) | -
| xiv_ds8k_connection_type = iscsi | -(StrOpt) Connection type to the IBM Storage Array (fibre_channel|iscsi) | -
| xiv_ds8k_proxy = xiv_ds8k_openstack.nova_proxy.XIVDS8KNovaProxy | -(StrOpt) Proxy driver that connects to the IBM Storage Array | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| xiv_chap = disabled | +(StrOpt) CHAP authentication mode, effective only for iscsi (disabled|enabled) | +
| xiv_ds8k_connection_type = iscsi | +(StrOpt) Connection type to the IBM Storage Array (fibre_channel|iscsi) | +
| xiv_ds8k_proxy = xiv_ds8k_openstack.nova_proxy.XIVDS8KNovaProxy | +(StrOpt) Proxy driver that connects to the IBM Storage Array | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| zadara_password = None | -(StrOpt) Password for the VPSA | -
| zadara_user = None | -(StrOpt) User name for the VPSA | -
| zadara_vol_encrypt = False | -(BoolOpt) Default encryption policy for volumes | -
| zadara_vol_name_template = OS_%s | -(StrOpt) Default template for VPSA volume names | -
| zadara_vol_thin = True | -(BoolOpt) Default thin provisioning policy for volumes | -
| zadara_vpsa_allow_nonexistent_delete = True | -(BoolOpt) Don't halt on deletion of non-existing volumes | -
| zadara_vpsa_auto_detach_on_delete = True | -(BoolOpt) Automatically detach from servers on volume delete | -
| zadara_vpsa_ip = None | -(StrOpt) Management IP of Zadara VPSA | -
| zadara_vpsa_poolname = None | -(StrOpt) Name of VPSA storage pool for volumes | -
| zadara_vpsa_port = None | -(StrOpt) Zadara VPSA port number | -
| zadara_vpsa_use_ssl = False | -(BoolOpt) Use SSL connection | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| zadara_password = None | +(StrOpt) Password for the VPSA | +
| zadara_user = None | +(StrOpt) User name for the VPSA | +
| zadara_vol_encrypt = False | +(BoolOpt) Default encryption policy for volumes | +
| zadara_vol_name_template = OS_%s | +(StrOpt) Default template for VPSA volume names | +
| zadara_vol_thin = True | +(BoolOpt) Default thin provisioning policy for volumes | +
| zadara_vpsa_allow_nonexistent_delete = True | +(BoolOpt) Don't halt on deletion of non-existing volumes | +
| zadara_vpsa_auto_detach_on_delete = True | +(BoolOpt) Automatically detach from servers on volume delete | +
| zadara_vpsa_ip = None | +(StrOpt) Management IP of Zadara VPSA | +
| zadara_vpsa_poolname = None | +(StrOpt) Name of VPSA storage pool for volumes | +
| zadara_vpsa_port = None | +(StrOpt) Zadara VPSA port number | +
| zadara_vpsa_use_ssl = False | +(BoolOpt) Use SSL connection | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| cloned_volume_same_az = True | -(BoolOpt) Ensure that the new volumes are the same AZ as snapshot or source volume | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| cloned_volume_same_az = True | +(BoolOpt) Ensure that the new volumes are the same AZ as snapshot or source volume | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| zoning_mode = none | -(StrOpt) FC Zoning mode configured | -
| [fc-zone-manager] | -|
| fc_fabric_names = None | -(StrOpt) Comma separated list of fibre channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric | -
| zoning_policy = initiator-target | -(StrOpt) Zoning policy configured by user | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| zoning_mode = none | +(StrOpt) FC Zoning mode configured | +
| [fc-zone-manager] | +|
| fc_fabric_names = None | +(StrOpt) Comma separated list of fibre channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric | +
| zoning_policy = initiator-target | +(StrOpt) Zoning policy configured by user | +
| Configuration option = Default value | -Description | -
|---|---|
| [BRCD_FABRIC_EXAMPLE] | -|
| fc_fabric_address = | -(StrOpt) Management IP of fabric | -
| fc_fabric_password = | -(StrOpt) Password for user | -
| fc_fabric_port = 22 | -(IntOpt) Connecting port | -
| fc_fabric_user = | -(StrOpt) Fabric user ID | -
| principal_switch_wwn = None | -(StrOpt) Principal switch WWN of the fabric | -
| zone_activate = True | -(BoolOpt) overridden zoning activation state | -
| zone_name_prefix = None | -(StrOpt) overridden zone name prefix | -
| zoning_policy = initiator-target | -(StrOpt) overridden zoning policy | -
| Configuration option = Default value | +Description | +
|---|---|
| [BRCD_FABRIC_EXAMPLE] | +|
| fc_fabric_address = | +(StrOpt) Management IP of fabric | +
| fc_fabric_password = | +(StrOpt) Password for user | +
| fc_fabric_port = 22 | +(IntOpt) Connecting port | +
| fc_fabric_user = | +(StrOpt) Fabric user ID | +
| principal_switch_wwn = None | +(StrOpt) Principal switch WWN of the fabric | +
| zone_activate = True | +(BoolOpt) overridden zoning activation state | +
| zone_name_prefix = None | +(StrOpt) overridden zone name prefix | +
| zoning_policy = initiator-target | +(StrOpt) overridden zoning policy | +
| Configuration option = Default value | -Description | -
|---|---|
| [fc-zone-manager] | -|
| brcd_sb_connector = cinder.zonemanager.drivers.brocade.brcd_fc_zone_client_cli.BrcdFCZoneClientCLI | -(StrOpt) Southbound connector for zoning operation | -
| fc_san_lookup_service = cinder.zonemanager.drivers.brocade.brcd_fc_san_lookup_service.BrcdFCSanLookupService | -(StrOpt) FC San Lookup Service | -
| zone_driver = cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver.BrcdFCZoneDriver | -(StrOpt) FC Zone Driver responsible for zone management | -
| Configuration option = Default value | +Description | +
|---|---|
| [fc-zone-manager] | +|
| brcd_sb_connector = cinder.zonemanager.drivers.brocade.brcd_fc_zone_client_cli.BrcdFCZoneClientCLI | +(StrOpt) Southbound connector for zoning operation | +
| fc_san_lookup_service = cinder.zonemanager.drivers.brocade.brcd_fc_san_lookup_service.BrcdFCSanLookupService | +(StrOpt) FC San Lookup Service | +
| zone_driver = cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver.BrcdFCZoneDriver | +(StrOpt) FC Zone Driver responsible for zone management | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| amqp_auto_delete = False | -(BoolOpt) Auto-delete queues in amqp. | -
| amqp_durable_queues = False | -(BoolOpt) Use durable queues in amqp. | -
| notification_driver = [] | -(MultiStrOpt) Driver or drivers to handle sending notifications. | -
| notification_topics = notifications | -(ListOpt) AMQP topic used for OpenStack notifications. | -
| rpc_backend = rabbit | -(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| rpc_response_timeout = 60 | -(IntOpt) Seconds to wait for a response from a call. | -
| rpc_thread_pool_size = 64 | -(IntOpt) Size of RPC greenthread pool. | -
| transport_url = None | -(StrOpt) 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. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| amqp_auto_delete = False | +(BoolOpt) Auto-delete queues in amqp. | +
| amqp_durable_queues = False | +(BoolOpt) Use durable queues in amqp. | +
| notification_driver = [] | +(MultiStrOpt) Driver or drivers to handle sending notifications. | +
| notification_topics = notifications | +(ListOpt) AMQP topic used for OpenStack notifications. | +
| rpc_backend = rabbit | +(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | +
| rpc_conn_pool_size = 30 | +(IntOpt) Size of RPC connection pool. | +
| rpc_response_timeout = 60 | +(IntOpt) Seconds to wait for a response from a call. | +
| rpc_thread_pool_size = 64 | +(IntOpt) Size of RPC greenthread pool. | +
| transport_url = None | +(StrOpt) 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. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| admin_role = admin | -(StrOpt) Role used to identify an authenticated user as administrator. | -
| allow_anonymous_access = False | -(BoolOpt) Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware. | -
| default_publisher_id = image.localhost | -(StrOpt) Default publisher_id for outgoing notifications. | -
| default_store = file | -(StrOpt) Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the 'known_stores' config option. | -
| enable_v1_api = True | -(BoolOpt) Deploy the v1 OpenStack Images API. | -
| enable_v1_registry = True | -(BoolOpt) Deploy the v1 OpenStack Registry API. | -
| enable_v2_api = True | -(BoolOpt) Deploy the v2 OpenStack Images API. | -
| enable_v2_registry = True | -(BoolOpt) Deploy the v2 OpenStack Registry API. | -
| image_size_cap = 1099511627776 | -(IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB). | -
| known_stores = glance.store.filesystem.Store, glance.store.http.Store | -(ListOpt) List of which store classes and store class locations are currently known to glance at startup. | -
| location_strategy = location_order | -(StrOpt) This value sets what strategy will be used to determine the image location order. Currently two strategies are packaged with Glance 'location_order' and 'store_type'. | -
| owner_is_tenant = True | -(BoolOpt) When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request. | -
| send_identity_headers = False | -(BoolOpt) Whether to pass through headers containing user and tenant information when making requests to the registry. This allows the registry to use the context middleware without the keystoneclients' auth_token middleware, removing calls to the keystone auth service. It is recommended that when using this option, secure communication between glance api and glance registry is ensured by means other than auth_token middleware. | -
| show_multiple_locations = False | -(BoolOpt) Whether to include the backend image locations in image properties. Revealing storage location can be a security risk, so use this setting with caution! The overrides show_image_direct_url. | -
| use_user_token = True | -(BoolOpt) Whether to pass through the user token when making requests to the registry. | -
| [store_type_location_strategy] | -|
| store_type_preference = | -(ListOpt) The store names to use to get store preference order. The name must be registered by one of the stores defined by the 'known_stores' config option. This option will be applied when you using 'store_type' option as image location strategy defined by the 'location_strategy' config option. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| admin_role = admin | +(StrOpt) Role used to identify an authenticated user as administrator. | +
| allow_anonymous_access = False | +(BoolOpt) Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware. | +
| default_store = file | +(StrOpt) Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the 'known_stores' config option. | +
| default_swift_reference = ref1 | +(StrOpt) The reference to the default swift account/backing store parameters to use for adding new images. | +
| enable_v1_api = True | +(BoolOpt) Deploy the v1 OpenStack Images API. | +
| enable_v1_registry = True | +(BoolOpt) Deploy the v1 OpenStack Registry API. | +
| enable_v2_api = True | +(BoolOpt) Deploy the v2 OpenStack Images API. | +
| enable_v2_registry = True | +(BoolOpt) Deploy the v2 OpenStack Registry API. | +
| image_size_cap = 1099511627776 | +(IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB). | +
| known_stores = glance.store.filesystem.Store, glance.store.http.Store | +(ListOpt) List of which store classes and store class locations are currently known to glance at startup. | +
| location_strategy = location_order | +(StrOpt) This value sets what strategy will be used to determine the image location order. Currently two strategies are packaged with Glance 'location_order' and 'store_type'. | +
| owner_is_tenant = True | +(BoolOpt) When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request. | +
| send_identity_headers = False | +(BoolOpt) Whether to pass through headers containing user and tenant information when making requests to the registry. This allows the registry to use the context middleware without the keystoneclients' auth_token middleware, removing calls to the keystone auth service. It is recommended that when using this option, secure communication between glance api and glance registry is ensured by means other than auth_token middleware. | +
| show_multiple_locations = False | +(BoolOpt) Whether to include the backend image locations in image properties. Revealing storage location can be a security risk, so use this setting with caution! The overrides show_image_direct_url. | +
| use_user_token = True | +(BoolOpt) Whether to pass through the user token when making requests to the registry. | +
| [store_type_location_strategy] | +|
| store_type_preference = | +(ListOpt) The store names to use to get store preference order. The name must be registered by one of the stores defined by the 'known_stores' config option. This option will be applied when you using 'store_type' option as image location strategy defined by the 'location_strategy' config option. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| memcached_servers = None | -(ListOpt) Memcached servers or None for in process cache. | -
| [keystone_authtoken] | -|
| admin_password = None | -(StrOpt) Keystone account password | -
| admin_tenant_name = admin | -(StrOpt) Keystone service account tenant name to validate user tokens | -
| admin_token = None | -(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. | -
| admin_user = None | -(StrOpt) Keystone account username | -
| auth_admin_prefix = | -(StrOpt) Prefix to prepend at the beginning of the path | -
| auth_host = 127.0.0.1 | -(StrOpt) Host providing the admin Identity API endpoint | -
| auth_port = 35357 | -(IntOpt) Port of the admin Identity API endpoint | -
| auth_protocol = https | -(StrOpt) Protocol of the admin Identity API endpoint(http or https) | -
| auth_uri = None | -(StrOpt) Complete public Identity API endpoint | -
| auth_version = None | -(StrOpt) API version of the admin Identity API endpoint | -
| cache = None | -(StrOpt) Env key for the swift cache | -
| cafile = None | -(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| certfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| delay_auth_decision = False | -(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | -
| enforce_token_bind = permissive | -(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| http_connect_timeout = None | -(BoolOpt) Request timeout value for communicating with Identity API server. | -
| http_request_max_retries = 3 | -(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| include_service_catalog = True | -(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| insecure = False | -(BoolOpt) Verify HTTPS connections. | -
| keyfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| memcache_secret_key = None | -(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | -
| memcache_security_strategy = None | -(StrOpt) (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. | -
| memcached_servers = None | -(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| revocation_cache_time = 300 | -(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| signing_dir = None | -(StrOpt) Directory used to cache files related to PKI tokens | -
| token_cache_time = 300 | -(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| memcached_servers = None | +(ListOpt) Memcached servers or None for in process cache. | +
| [keystone_authtoken] | +|
| admin_password = None | +(StrOpt) Keystone account password | +
| admin_tenant_name = admin | +(StrOpt) Keystone service account tenant name to validate user tokens | +
| admin_token = None | +(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | +
| admin_user = None | +(StrOpt) Keystone account username | +
| auth_admin_prefix = | +(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | +
| auth_host = 127.0.0.1 | +(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_port = 35357 | +(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_protocol = https | +(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | +
| auth_uri = None | +(StrOpt) Complete public Identity API endpoint | +
| auth_version = None | +(StrOpt) API version of the admin Identity API endpoint | +
| cache = None | +(StrOpt) Env key for the swift cache | +
| cafile = None | +(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | +
| certfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| check_revocations_for_cached = False | +(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server. | +
| delay_auth_decision = False | +(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | +
| enforce_token_bind = permissive | +(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | +
| hash_algorithms = md5 | +(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | +
| http_connect_timeout = None | +(BoolOpt) Request timeout value for communicating with Identity API server. | +
| http_request_max_retries = 3 | +(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | +
| identity_uri = None | +(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | +
| include_service_catalog = True | +(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | +
| insecure = False | +(BoolOpt) Verify HTTPS connections. | +
| keyfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| memcache_secret_key = None | +(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | +
| memcache_security_strategy = None | +(StrOpt) (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. | +
| memcached_servers = None | +(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | +
| revocation_cache_time = 10 | +(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | +
| signing_dir = None | +(StrOpt) Directory used to cache files related to PKI tokens | +
| token_cache_time = 300 | +(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| cinder_api_insecure = False | -(BoolOpt) Allow to perform insecure SSL requests to cinder. | -
| cinder_ca_certificates_file = None | -(StrOpt) Location of CA certicates file to use for cinder client requests. | -
| cinder_catalog_info = volume:cinder:publicURL | -(StrOpt) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type>. | -
| cinder_endpoint_template = None | -(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s. | -
| cinder_http_retries = 3 | -(IntOpt) Number of cinderclient retries on failed http calls. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| cinder_api_insecure = False | +(BoolOpt) Allow to perform insecure SSL requests to cinder. | +
| cinder_ca_certificates_file = None | +(StrOpt) Location of CA certicates file to use for cinder client requests. | +
| cinder_catalog_info = volume:cinder:publicURL | +(StrOpt) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type>. | +
| cinder_endpoint_template = None | +(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s. | +
| cinder_http_retries = 3 | +(IntOpt) Number of cinderclient retries on failed http calls. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| allow_additional_image_properties = True | -(BoolOpt) Whether to allow users to specify image properties beyond what the image schema provides | -
| api_limit_max = 1000 | -(IntOpt) Maximum permissible number of items that could be returned by a request | -
| backlog = 4096 | -(IntOpt) The backlog value that will be used when creating the TCP listener socket. | -
| bind_host = 0.0.0.0 | -(StrOpt) Address to bind the server. Useful when selecting a particular network interface. | -
| bind_port = None | -(IntOpt) The port on which the server will listen. | -
| data_api = glance.db.sqlalchemy.api | -(StrOpt) Python module path of data access API | -
| disable_process_locking = False | -(BoolOpt) Whether to disable inter-process locks | -
| image_location_quota = 10 | -(IntOpt) Maximum number of locations allowed on an image. Negative values evaluate to unlimited. | -
| image_member_quota = 128 | -(IntOpt) Maximum number of image members per image. Negative values evaluate to unlimited. | -
| image_property_quota = 128 | -(IntOpt) Maximum number of properties allowed on an image. Negative values evaluate to unlimited. | -
| image_tag_quota = 128 | -(IntOpt) Maximum number of tags allowed on an image. Negative values evaluate to unlimited. | -
| limit_param_default = 25 | -(IntOpt) Default value for the number of items returned by a request if not specified explicitly in the request | -
| lock_path = None | -(StrOpt) Directory to use for lock files. | -
| metadata_encryption_key = None | -(StrOpt) Key used for encrypting sensitive metadata while talking to the registry or database. | -
| notifier_strategy = default | -(StrOpt) Notifications can be sent when images are create, updated or deleted. There are three methods of sending notifications, logging (via the log_file directive), rabbit (via a rabbitmq queue), qpid (via a Qpid message queue), or noop (no notifications sent, the default). (DEPRECATED) | -
| os_region_name = None | -(StrOpt) Region name of this node. | -
| property_protection_file = None | -(StrOpt) The location of the property protection file. | -
| property_protection_rule_format = roles | -(StrOpt) This config value indicates whether "roles" or "policies" are used in the property protection file. | -
| show_image_direct_url = False | -(BoolOpt) Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution! | -
| user_storage_quota = 0 | -(IntOpt) Set a system wide quota for every user. This value is the total number of bytes that a user can use across all storage systems. A value of 0 means unlimited. | -
| workers = 1 | -(IntOpt) The number of child process workers that will be created to service API requests. | -
| [image_format] | -|
| container_formats = ami, ari, aki, bare, ovf, ova | -(ListOpt) Supported values for the 'container_format' image attribute | -
| disk_formats = ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso | -(ListOpt) Supported values for the 'disk_format' image attribute | -
| [task] | -|
| task_time_to_live = 48 | -(IntOpt) Time in hours for which a task lives after, either succeeding or failing | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| allow_additional_image_properties = True | +(BoolOpt) Whether to allow users to specify image properties beyond what the image schema provides | +
| api_limit_max = 1000 | +(IntOpt) Maximum permissible number of items that could be returned by a request | +
| backlog = 4096 | +(IntOpt) The backlog value that will be used when creating the TCP listener socket. | +
| bind_host = 0.0.0.0 | +(StrOpt) Address to bind the server. Useful when selecting a particular network interface. | +
| bind_port = None | +(IntOpt) The port on which the server will listen. | +
| data_api = glance.db.sqlalchemy.api | +(StrOpt) Python module path of data access API | +
| disable_process_locking = False | +(BoolOpt) Whether to disable inter-process locks | +
| image_location_quota = 10 | +(IntOpt) Maximum number of locations allowed on an image. Negative values evaluate to unlimited. | +
| image_member_quota = 128 | +(IntOpt) Maximum number of image members per image. Negative values evaluate to unlimited. | +
| image_property_quota = 128 | +(IntOpt) Maximum number of properties allowed on an image. Negative values evaluate to unlimited. | +
| image_tag_quota = 128 | +(IntOpt) Maximum number of tags allowed on an image. Negative values evaluate to unlimited. | +
| limit_param_default = 25 | +(IntOpt) Default value for the number of items returned by a request if not specified explicitly in the request | +
| lock_path = None | +(StrOpt) Directory to use for lock files. | +
| metadata_encryption_key = None | +(StrOpt) Key used for encrypting sensitive metadata while talking to the registry or database. | +
| notifier_strategy = default | +(StrOpt) Notifications can be sent when images are create, updated or deleted. There are three methods of sending notifications, logging (via the log_file directive), rabbit (via a rabbitmq queue), qpid (via a Qpid message queue), or noop (no notifications sent, the default). | +
| os_region_name = None | +(StrOpt) Region name of this node. | +
| property_protection_file = None | +(StrOpt) The location of the property protection file. | +
| property_protection_rule_format = roles | +(StrOpt) This config value indicates whether "roles" or "policies" are used in the property protection file. | +
| show_image_direct_url = False | +(BoolOpt) Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution! | +
| user_storage_quota = 0 | +(StrOpt) Set a system wide quota for every user. This value is the total capacity that a user can use across all storage systems. A value of 0 means unlimited.Optional unit can be specified for the value. Accepted units are B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytesrespectively. If no unit is specified then Bytes is assumed. Note that there should not be any space between value and unit and units are case sensitive. | +
| workers = 1 | +(IntOpt) The number of child process workers that will be created to service API requests. | +
| [image_format] | +|
| container_formats = ami, ari, aki, bare, ovf, ova | +(ListOpt) Supported values for the 'container_format' image attribute | +
| disk_formats = ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso | +(ListOpt) Supported values for the 'disk_format' image attribute | +
| [task] | +|
| task_time_to_live = 48 | +(IntOpt) Time in hours for which a task lives after, either succeeding or failing | +
| Configuration option = Default value | +Description | +
|---|---|
| [database] | +|
| backend = sqlalchemy | +(StrOpt) The backend to use for db | +
| connection = None | +(StrOpt) The SQLAlchemy connection string used to connect to the database | +
| connection_debug = 0 | +(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything | +
| connection_trace = False | +(BoolOpt) Add python stack traces to SQL as comment strings | +
| db_inc_retry_interval = True | +(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval | +
| db_max_retries = 20 | +(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count) | +
| db_max_retry_interval = 10 | +(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled | +
| db_retry_interval = 1 | +(IntOpt) seconds between db connection retries | +
| idle_timeout = 3600 | +(IntOpt) Timeout before idle sql connections are reaped | +
| max_overflow = None | +(IntOpt) If set, use this value for max_overflow with sqlalchemy | +
| max_pool_size = None | +(IntOpt) Maximum number of SQL connections to keep open in a pool | +
| max_retries = 10 | +(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count) | +
| min_pool_size = 1 | +(IntOpt) Minimum number of SQL connections to keep open in a pool | +
| mysql_sql_mode = TRADITIONAL | +(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | +
| pool_timeout = None | +(IntOpt) If set, use this value for pool_timeout with sqlalchemy | +
| retry_interval = 10 | +(IntOpt) Interval between retries of opening a sql connection | +
| sqlite_db = glance.sqlite | +(StrOpt) The file name to use with SQLite | +
| sqlite_synchronous = True | +(BoolOpt) If True, SQLite uses synchronous mode | +
| use_db_reconnect = False | +(BoolOpt) Enable the experimental use of database reconnect on connection lost | +
| Configuration option = Default value | -Description | -
|---|---|
| [database] | -|
| backend = sqlalchemy | -(StrOpt) The backend to use for db | -
| connection = None | -(StrOpt) The SQLAlchemy connection string used to connect to the database | -
| connection_debug = 0 | -(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything | -
| connection_trace = False | -(BoolOpt) Add python stack traces to SQL as comment strings | -
| db_inc_retry_interval = True | -(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval | -
| db_max_retries = 20 | -(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count) | -
| db_max_retry_interval = 10 | -(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled | -
| db_retry_interval = 1 | -(IntOpt) seconds between db connection retries | -
| idle_timeout = 3600 | -(IntOpt) Timeout before idle sql connections are reaped | -
| max_overflow = None | -(IntOpt) If set, use this value for max_overflow with sqlalchemy | -
| max_pool_size = None | -(IntOpt) Maximum number of SQL connections to keep open in a pool | -
| max_retries = 10 | -(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count) | -
| min_pool_size = 1 | -(IntOpt) Minimum number of SQL connections to keep open in a pool | -
| mysql_sql_mode = TRADITIONAL | -(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | -
| pool_timeout = None | -(IntOpt) If set, use this value for pool_timeout with sqlalchemy | -
| retry_interval = 10 | -(IntOpt) Interval between retries of opening a sql connection | -
| sqlite_db = glance.sqlite | -(StrOpt) The file name to use with SQLite | -
| sqlite_synchronous = True | -(BoolOpt) If True, SQLite uses synchronous mode | -
| use_db_reconnect = False | -(BoolOpt) Enable the experimental use of database reconnect on connection lost | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| filesystem_store_datadir = None | -(StrOpt) Directory to which the Filesystem backend store writes images. | -
| filesystem_store_datadirs = None | -(MultiStrOpt) List of directories and its priorities to which the Filesystem backend store writes images. | -
| filesystem_store_metadata_file = None | -(StrOpt) The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON dict. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| filesystem_store_datadir = None | +(StrOpt) Directory to which the Filesystem backend store writes images. | +
| filesystem_store_datadirs = None | +(MultiStrOpt) List of directories and its priorities to which the Filesystem backend store writes images. | +
| filesystem_store_metadata_file = None | +(StrOpt) The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON dict. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| mongodb_store_db = None | -(StrOpt) Database to use. | -
| mongodb_store_uri = None | -(StrOpt) Hostname or IP address of the instance to connect to, or a mongodb URI, or a list of hostnames / mongodb URIs. If host is an IPv6 literal it must be enclosed in '[' and ']' characters following the RFC2732 URL syntax (e.g. '[::1]' for localhost). | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| mongodb_store_db = None | +(StrOpt) Database to use. | +
| mongodb_store_uri = None | +(StrOpt) Hostname or IP address of the instance to connect to, or a mongodb URI, or a list of hostnames / mongodb URIs. If host is an IPv6 literal it must be enclosed in '[' and ']' characters following the RFC2732 URL syntax (e.g. '[::1]' for localhost). | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| cleanup_scrubber = False | -(BoolOpt) A boolean that determines if the scrubber should clean up the files it uses for taking data. Only one server in your deployment should be designated the cleanup host. | -
| cleanup_scrubber_time = 86400 | -(IntOpt) Items must have a modified time that is older than this value in order to be candidates for cleanup. | -
| delayed_delete = False | -(BoolOpt) Turn on/off delayed delete. | -
| image_cache_dir = None | -(StrOpt) Base directory that the Image Cache uses. | -
| image_cache_driver = sqlite | -(StrOpt) The driver to use for image cache management. | -
| image_cache_max_size = 10737418240 | -(IntOpt) The maximum size in bytes that the cache can use. | -
| image_cache_sqlite_db = cache.db | -(StrOpt) The path to the sqlite file database that will be used for image cache management. | -
| image_cache_stall_time = 86400 | -(IntOpt) The amount of time to let an image remain in the cache without being accessed. | -
| scrub_time = 0 | -(IntOpt) The amount of time in seconds to delay before performing a delete. | -
| scrubber_datadir = /var/lib/glance/scrubber | -(StrOpt) Directory that the scrubber will use to track information about what to delete. Make sure this is set in glance-api.conf and glance-scrubber.conf. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| cleanup_scrubber = False | +(BoolOpt) A boolean that determines if the scrubber should clean up the files it uses for taking data. Only one server in your deployment should be designated the cleanup host. | +
| cleanup_scrubber_time = 86400 | +(IntOpt) Items must have a modified time that is older than this value in order to be candidates for cleanup. | +
| delayed_delete = False | +(BoolOpt) Turn on/off delayed delete. | +
| image_cache_dir = None | +(StrOpt) Base directory that the Image Cache uses. | +
| image_cache_driver = sqlite | +(StrOpt) The driver to use for image cache management. | +
| image_cache_max_size = 10737418240 | +(IntOpt) The maximum size in bytes that the cache can use. | +
| image_cache_sqlite_db = cache.db | +(StrOpt) The path to the sqlite file database that will be used for image cache management. | +
| image_cache_stall_time = 86400 | +(IntOpt) The amount of time to let an image remain in the cache without being accessed. | +
| scrub_time = 0 | +(IntOpt) The amount of time in seconds to delay before performing a delete. | +
| scrubber_datadir = /var/lib/glance/scrubber | +(StrOpt) Directory that the scrubber will use to track information about what to delete. Make sure this is set in glance-api.conf and glance-scrubber.conf. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| debug = False | -(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | -
| default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN | -(ListOpt) List of logger=LEVEL pairs | -
| fatal_deprecations = False | -(BoolOpt) Make deprecations fatal | -
| instance_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance is passed with the log message, format it like this | -
| instance_uuid_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance UUID is passed with the log message, format it like this | -
| log_config_append = None | -(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files. | -
| log_date_format = %Y-%m-%d %H:%M:%S | -(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s | -
| log_dir = None | -(StrOpt) (Optional) The base directory used for relative --log-file paths | -
| log_file = None | -(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | -
| log_format = None | -(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | -
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | -(StrOpt) Format string to use for log messages with context | -
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | -(StrOpt) Data to append to log format when level is DEBUG | -
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | -(StrOpt) Format string to use for log messages without context | -
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -(StrOpt) Prefix each line of exception output with this format | -
| publish_errors = False | -(BoolOpt) Publish error events | -
| syslog_log_facility = LOG_USER | -(StrOpt) Syslog facility to receive log lines | -
| use_stderr = True | -(BoolOpt) Log output to standard error | -
| use_syslog = False | -(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424 | -
| use_syslog_rfc_format = False | -(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J. | -
| verbose = False | -(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| debug = False | +(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | +
| default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN | +(ListOpt) List of logger=LEVEL pairs. | +
| fatal_deprecations = False | +(BoolOpt) Enables or disables fatal status of deprecations. | +
| instance_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance that is passed with the log message. | +
| instance_uuid_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance UUID that is passed with the log message. | +
| log_config_append = None | +(StrOpt) 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. | +
| log_date_format = %Y-%m-%d %H:%M:%S | +(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . | +
| log_dir = None | +(StrOpt) (Optional) The base directory used for relative --log-file paths. | +
| log_file = None | +(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | +
| log_format = None | +(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | +
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages with context. | +
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | +(StrOpt) Data to append to log format when level is DEBUG. | +
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages without context. | +
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | +(StrOpt) Prefix each line of exception output with this format. | +
| publish_errors = False | +(BoolOpt) Enables or disables publication of error events. | +
| syslog_log_facility = LOG_USER | +(StrOpt) Syslog facility to receive log lines. | +
| use_stderr = True | +(BoolOpt) Log output to standard error. | +
| use_syslog = False | +(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will chang in J to honor RFC5424. | +
| use_syslog_rfc_format = False | +(BoolOpt) (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 I, and will be removed in J. | +
| verbose = False | +(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| matchmaker_heartbeat_freq = 300 | -(IntOpt) Heartbeat frequency. | -
| matchmaker_heartbeat_ttl = 600 | -(IntOpt) Heartbeat time-to-live. | -
| [matchmaker_ring] | -|
| ringfile = /etc/oslo/matchmaker_ring.json | -(StrOpt) Matchmaker ring file (JSON). | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| matchmaker_heartbeat_freq = 300 | +(IntOpt) Heartbeat frequency. | +
| matchmaker_heartbeat_ttl = 600 | +(IntOpt) Heartbeat time-to-live. | +
| [matchmaker_ring] | +|
| ringfile = /etc/oslo/matchmaker_ring.json | +(StrOpt) Matchmaker ring file (JSON). | +
| Configuration option = Default value | -Description | -
|---|---|
| [paste_deploy] | -|
| config_file = None | -(StrOpt) Name of the paste configuration file. | -
| flavor = None | -(StrOpt) Partial name of a pipeline in your paste configuration file with the service name removed. For example, if your paste section name is [pipeline:glance-api-keystone] use the value "keystone" | -
| Configuration option = Default value | +Description | +
|---|---|
| [paste_deploy] | +|
| config_file = None | +(StrOpt) Name of the paste configuration file. | +
| flavor = None | +(StrOpt) Partial name of a pipeline in your paste configuration file with the service name removed. For example, if your paste section name is [pipeline:glance-api-keystone] use the value "keystone" | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| policy_default_rule = default | -(StrOpt) The default policy to use. | -
| policy_file = policy.json | -(StrOpt) The location of the policy file. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| policy_default_rule = default | +(StrOpt) The default policy to use. | +
| policy_file = policy.json | +(StrOpt) The location of the policy file. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| qpid_heartbeat = 60 | -(IntOpt) Seconds between connection keepalive heartbeats. | -
| qpid_hostname = localhost | -(StrOpt) Qpid broker hostname. | -
| qpid_hosts = $qpid_hostname:$qpid_port | -(ListOpt) Qpid HA cluster host:port pairs. | -
| qpid_password = | -(StrOpt) Password for Qpid connection. | -
| qpid_port = 5672 | -(IntOpt) Qpid broker port. | -
| qpid_protocol = tcp | -(StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| qpid_sasl_mechanisms = | -(StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| qpid_tcp_nodelay = True | -(BoolOpt) Whether to disable the Nagle algorithm. | -
| qpid_topology_version = 1 | -(IntOpt) 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. | -
| qpid_username = | -(StrOpt) Username for Qpid connection. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| qpid_heartbeat = 60 | +(IntOpt) Seconds between connection keepalive heartbeats. | +
| qpid_hostname = localhost | +(StrOpt) Qpid broker hostname. | +
| qpid_hosts = $qpid_hostname:$qpid_port | +(ListOpt) Qpid HA cluster host:port pairs. | +
| qpid_password = | +(StrOpt) Password for Qpid connection. | +
| qpid_port = 5672 | +(IntOpt) Qpid broker port. | +
| qpid_protocol = tcp | +(StrOpt) Transport to use, either 'tcp' or 'ssl'. | +
| qpid_sasl_mechanisms = | +(StrOpt) Space separated list of SASL mechanisms to use for auth. | +
| qpid_tcp_nodelay = True | +(BoolOpt) Whether to disable the Nagle algorithm. | +
| qpid_topology_version = 1 | +(IntOpt) 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. | +
| qpid_username = | +(StrOpt) Username for Qpid connection. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| control_exchange = openstack | -(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| fake_rabbit = False | -(BoolOpt) If passed, use a fake RabbitMQ provider. | -
| kombu_reconnect_delay = 1.0 | -(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| kombu_ssl_ca_certs = | -(StrOpt) SSL certification authority file (valid only if SSL enabled). | -
| kombu_ssl_certfile = | -(StrOpt) SSL cert file (valid only if SSL enabled). | -
| kombu_ssl_keyfile = | -(StrOpt) SSL key file (valid only if SSL enabled). | -
| kombu_ssl_version = | -(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions. | -
| rabbit_ha_queues = False | -(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| rabbit_host = localhost | -(StrOpt) The RabbitMQ broker address where a single node is used. | -
| rabbit_hosts = $rabbit_host:$rabbit_port | -(ListOpt) RabbitMQ HA cluster host:port pairs. | -
| rabbit_login_method = AMQPLAIN | -(StrOpt) the RabbitMQ login method | -
| rabbit_max_retries = 0 | -(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| rabbit_password = guest | -(StrOpt) The RabbitMQ password. | -
| rabbit_port = 5672 | -(IntOpt) The RabbitMQ broker port where a single node is used. | -
| rabbit_retry_backoff = 2 | -(IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| rabbit_retry_interval = 1 | -(IntOpt) How frequently to retry connecting with RabbitMQ. | -
| rabbit_use_ssl = False | -(BoolOpt) Connect over SSL for RabbitMQ. | -
| rabbit_userid = guest | -(StrOpt) The RabbitMQ userid. | -
| rabbit_virtual_host = / | -(StrOpt) The RabbitMQ virtual host. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| control_exchange = openstack | +(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | +
| fake_rabbit = False | +(BoolOpt) If passed, use a fake RabbitMQ provider. | +
| kombu_reconnect_delay = 1.0 | +(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | +
| kombu_ssl_ca_certs = | +(StrOpt) SSL certification authority file (valid only if SSL enabled). | +
| kombu_ssl_certfile = | +(StrOpt) SSL cert file (valid only if SSL enabled). | +
| kombu_ssl_keyfile = | +(StrOpt) SSL key file (valid only if SSL enabled). | +
| kombu_ssl_version = | +(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions. | +
| rabbit_ha_queues = False | +(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | +
| rabbit_host = localhost | +(StrOpt) The RabbitMQ broker address where a single node is used. | +
| rabbit_hosts = $rabbit_host:$rabbit_port | +(ListOpt) RabbitMQ HA cluster host:port pairs. | +
| rabbit_login_method = AMQPLAIN | +(StrOpt) the RabbitMQ login method | +
| rabbit_max_retries = 0 | +(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | +
| rabbit_password = guest | +(StrOpt) The RabbitMQ password. | +
| rabbit_port = 5672 | +(IntOpt) The RabbitMQ broker port where a single node is used. | +
| rabbit_retry_backoff = 2 | +(IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | +
| rabbit_retry_interval = 1 | +(IntOpt) How frequently to retry connecting with RabbitMQ. | +
| rabbit_use_ssl = False | +(BoolOpt) Connect over SSL for RabbitMQ. | +
| rabbit_userid = guest | +(StrOpt) The RabbitMQ userid. | +
| rabbit_virtual_host = / | +(StrOpt) The RabbitMQ virtual host. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| rbd_store_ceph_conf = /etc/ceph/ceph.conf | -(StrOpt) Ceph configuration file path. If <None>, librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client.<USER> section. | -
| rbd_store_chunk_size = 8 | -(IntOpt) RADOS images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two. | -
| rbd_store_pool = images | -(StrOpt) RADOS pool in which images are stored. | -
| rbd_store_user = None | -(StrOpt) RADOS user to authenticate as (only applicable if using Cephx. If <None>, a default will be chosen based on the client. section in rbd_store_ceph_conf). | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| rbd_store_ceph_conf = /etc/ceph/ceph.conf | +(StrOpt) Ceph configuration file path. If <None>, librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client.<USER> section. | +
| rbd_store_chunk_size = 8 | +(IntOpt) RADOS images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two. | +
| rbd_store_pool = images | +(StrOpt) RADOS pool in which images are stored. | +
| rbd_store_user = None | +(StrOpt) RADOS user to authenticate as (only applicable if using Cephx. If <None>, a default will be chosen based on the client. section in rbd_store_ceph_conf). | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| host = 127.0.0.1 | -(StrOpt) Host to locate redis. | -
| password = None | -(StrOpt) Password for Redis server (optional). | -
| port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| host = 127.0.0.1 | +(StrOpt) Host to locate redis. | +
| password = None | +(StrOpt) Password for Redis server (optional). | +
| port = 6379 | +(IntOpt) Use this port to connect to redis host. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| admin_password = None | -(StrOpt) The administrators password. | -
| admin_tenant_name = None | -(StrOpt) The tenant name of the administrative user. | -
| admin_user = None | -(StrOpt) The administrators user name. | -
| auth_region = None | -(StrOpt) The region for the authentication service. | -
| auth_strategy = noauth | -(StrOpt) The strategy to use for authentication. | -
| auth_url = None | -(StrOpt) The URL to the keystone service. | -
| registry_client_ca_file = None | -(StrOpt) The path to the certifying authority cert file to use in SSL connections to the registry server. | -
| registry_client_cert_file = None | -(StrOpt) The path to the cert file to use in SSL connections to the registry server. | -
| registry_client_insecure = False | -(BoolOpt) When using SSL in connections to the registry server, do not require validation via a certifying authority. | -
| registry_client_key_file = None | -(StrOpt) The path to the key file to use in SSL connections to the registry server. | -
| registry_client_protocol = http | -(StrOpt) The protocol to use for communication with the registry server. Either http or https. | -
| registry_client_timeout = 600 | -(IntOpt) The period of time, in seconds, that the API server will wait for a registry request to complete. A value of 0 implies no timeout. | -
| registry_host = 0.0.0.0 | -(StrOpt) Address to find the registry server. | -
| registry_port = 9191 | -(IntOpt) Port the registry server is listening on. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| admin_password = None | +(StrOpt) The administrators password. | +
| admin_tenant_name = None | +(StrOpt) The tenant name of the administrative user. | +
| admin_user = None | +(StrOpt) The administrators user name. | +
| auth_region = None | +(StrOpt) The region for the authentication service. | +
| auth_strategy = noauth | +(StrOpt) The strategy to use for authentication. | +
| auth_url = None | +(StrOpt) The URL to the keystone service. | +
| registry_client_ca_file = None | +(StrOpt) The path to the certifying authority cert file to use in SSL connections to the registry server. | +
| registry_client_cert_file = None | +(StrOpt) The path to the cert file to use in SSL connections to the registry server. | +
| registry_client_insecure = False | +(BoolOpt) When using SSL in connections to the registry server, do not require validation via a certifying authority. | +
| registry_client_key_file = None | +(StrOpt) The path to the key file to use in SSL connections to the registry server. | +
| registry_client_protocol = http | +(StrOpt) The protocol to use for communication with the registry server. Either http or https. | +
| registry_client_timeout = 600 | +(IntOpt) The period of time, in seconds, that the API server will wait for a registry request to complete. A value of 0 implies no timeout. | +
| registry_host = 0.0.0.0 | +(StrOpt) Address to find the registry server. | +
| registry_port = 9191 | +(IntOpt) Port the registry server is listening on. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| allowed_rpc_exception_modules = openstack.common.exception, glance.common.exception, exceptions | -(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| allowed_rpc_exception_modules = openstack.common.exception, glance.common.exception, exceptions | +(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| s3_store_access_key = None | -(StrOpt) The S3 query token access key. | -
| s3_store_bucket = None | -(StrOpt) The S3 bucket to be used to store the Glance data. | -
| s3_store_bucket_url_format = subdomain | -(StrOpt) The S3 calling format used to determine the bucket. Either subdomain or path can be used. | -
| s3_store_create_bucket_on_put = False | -(BoolOpt) A boolean to determine if the S3 bucket should be created on upload if it does not exist or if an error should be returned to the user. | -
| s3_store_host = None | -(StrOpt) The host where the S3 server is listening. | -
| s3_store_object_buffer_dir = None | -(StrOpt) The local directory where uploads will be staged before they are transferred into S3. | -
| s3_store_secret_key = None | -(StrOpt) The S3 query token secret key. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| s3_store_access_key = None | +(StrOpt) The S3 query token access key. | +
| s3_store_bucket = None | +(StrOpt) The S3 bucket to be used to store the Glance data. | +
| s3_store_bucket_url_format = subdomain | +(StrOpt) The S3 calling format used to determine the bucket. Either subdomain or path can be used. | +
| s3_store_create_bucket_on_put = False | +(BoolOpt) A boolean to determine if the S3 bucket should be created on upload if it does not exist or if an error should be returned to the user. | +
| s3_store_host = None | +(StrOpt) The host where the S3 server is listening. | +
| s3_store_large_object_chunk_size = 10 | +(IntOpt) What multipart upload part size, in MB, should S3 use when uploading parts. The size must be greater than or equal to 5M. | +
| s3_store_large_object_size = 100 | +(IntOpt) What size, in MB, should S3 start chunking image files and do a multipart upload in S3. | +
| s3_store_object_buffer_dir = None | +(StrOpt) The local directory where uploads will be staged before they are transferred into S3. | +
| s3_store_secret_key = None | +(StrOpt) The S3 query token secret key. | +
| s3_store_thread_pools = 10 | +(IntOpt) The number of thread pools to perform a multipart upload in S3. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| sheepdog_store_address = 127.0.0.1 | -(StrOpt) IP address of sheep daemon. | -
| sheepdog_store_chunk_size = 64 | -(IntOpt) Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two. | -
| sheepdog_store_port = 7000 | -(IntOpt) Port of sheep daemon. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| sheepdog_store_address = 127.0.0.1 | +(StrOpt) IP address of sheep daemon. | +
| sheepdog_store_chunk_size = 64 | +(IntOpt) Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two. | +
| sheepdog_store_port = 7000 | +(IntOpt) Port of sheep daemon. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| ca_file = None | -(StrOpt) CA certificate file to use to verify connecting clients. | -
| cert_file = None | -(StrOpt) Certificate file to use when starting API server securely. | -
| key_file = None | -(StrOpt) Private key file to use when starting API server securely. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| ca_file = None | +(StrOpt) CA certificate file to use to verify connecting clients. | +
| cert_file = None | +(StrOpt) Certificate file to use when starting API server securely. | +
| key_file = None | +(StrOpt) Private key file to use when starting API server securely. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| swift_enable_snet = False | -(BoolOpt) Whether to use ServiceNET to communicate with the Swift storage servers. | -
| swift_store_admin_tenants = | -(ListOpt) A list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode. | -
| swift_store_auth_address = None | -(StrOpt) The address where the Swift authentication service is listening. | -
| swift_store_auth_insecure = False | -(BoolOpt) If True, swiftclient won't check for a valid SSL certificate when authenticating. | -
| swift_store_auth_version = 2 | -(StrOpt) Version of the authentication service to use. Valid versions are 2 for keystone and 1 for swauth and rackspace. | -
| swift_store_container = glance | -(StrOpt) Container within the account that the account should use for storing images in Swift. | -
| swift_store_create_container_on_put = False | -(BoolOpt) A boolean value that determines if we create the container if it does not exist. | -
| swift_store_endpoint_type = publicURL | -(StrOpt) A string giving the endpoint type of the swift service to use (publicURL, adminURL or internalURL). This setting is only used if swift_store_auth_version is 2. | -
| swift_store_key = None | -(StrOpt) Auth key for the user authenticating against the Swift authentication service. | -
| swift_store_large_object_chunk_size = 200 | -(IntOpt) The amount of data written to a temporary disk buffer during the process of chunking the image file. | -
| swift_store_large_object_size = 5120 | -(IntOpt) The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift. | -
| swift_store_multi_tenant = False | -(BoolOpt) If set to True, enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts. | -
| swift_store_region = None | -(StrOpt) The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints. | -
| swift_store_retry_get_count = 0 | -(IntOpt) The number of times a Swift download will be retried before the request fails. | -
| swift_store_service_type = object-store | -(StrOpt) A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is 2. | -
| swift_store_ssl_compression = True | -(BoolOpt) If set to False, disables SSL layer compression of https swift requests. Setting to False may improve performance for images which are already in a compressed format, eg qcow2. | -
| swift_store_user = None | -(StrOpt) The user to authenticate against the Swift authentication service. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| swift_enable_snet = False | +(BoolOpt) Whether to use ServiceNET to communicate with the Swift storage servers. | +
| swift_store_admin_tenants = | +(ListOpt) A list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode. | +
| swift_store_auth_address = None | +(StrOpt) The address where the Swift authentication service is listening.(deprecated) | +
| swift_store_auth_insecure = False | +(BoolOpt) If True, swiftclient won't check for a valid SSL certificate when authenticating. | +
| swift_store_auth_version = 2 | +(StrOpt) Version of the authentication service to use. Valid versions are 2 for keystone and 1 for swauth and rackspace. (deprecated) | +
| swift_store_config_file = None | +(StrOpt) The config file that has the swift account(s)configs. | +
| swift_store_container = glance | +(StrOpt) Container within the account that the account should use for storing images in Swift. | +
| swift_store_create_container_on_put = False | +(BoolOpt) A boolean value that determines if we create the container if it does not exist. | +
| swift_store_endpoint_type = publicURL | +(StrOpt) A string giving the endpoint type of the swift service to use (publicURL, adminURL or internalURL). This setting is only used if swift_store_auth_version is 2. | +
| swift_store_key = None | +(StrOpt) Auth key for the user authenticating against the Swift authentication service. (deprecated) | +
| swift_store_large_object_chunk_size = 200 | +(IntOpt) The amount of data written to a temporary disk buffer during the process of chunking the image file. | +
| swift_store_large_object_size = 5120 | +(IntOpt) The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift. | +
| swift_store_multi_tenant = False | +(BoolOpt) If set to True, enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts. | +
| swift_store_region = None | +(StrOpt) The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints. | +
| swift_store_retry_get_count = 0 | +(IntOpt) The number of times a Swift download will be retried before the request fails. | +
| swift_store_service_type = object-store | +(StrOpt) A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is 2. | +
| swift_store_ssl_compression = True | +(BoolOpt) If set to False, disables SSL layer compression of https swift requests. Setting to False may improve performance for images which are already in a compressed format, eg qcow2. | +
| swift_store_user = None | +(StrOpt) The user to authenticate against the Swift authentication service (deprecated) | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| pydev_worker_debug_host = None | -(StrOpt) The hostname/IP of the pydev process listening for debug connections | -
| pydev_worker_debug_port = 5678 | -(IntOpt) The port on which a pydev process is listening for connections. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| pydev_worker_debug_host = None | +(StrOpt) The hostname/IP of the pydev process listening for debug connections | +
| pydev_worker_debug_port = 5678 | +(IntOpt) The port on which a pydev process is listening for connections. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| vmware_api_insecure = False | -(BoolOpt) Allow to perform insecure SSL requests to ESX/VC. | -
| vmware_api_retry_count = 10 | -(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues. | -
| vmware_datacenter_path = ha-datacenter | -(StrOpt) Inventory path to a datacenter. If the vmware_server_host specified is an ESX/ESXi, the vmware_datacenter_path is optional. If specified, it should be "ha-datacenter". | -
| vmware_datastore_name = None | -(StrOpt) Datastore associated with the datacenter. | -
| vmware_server_host = None | -(StrOpt) ESX/ESXi or vCenter Server target system. The server value can be an IP address or a DNS name. | -
| vmware_server_password = None | -(StrOpt) Password for authenticating with VMware ESX/VC server. | -
| vmware_server_username = None | -(StrOpt) Username for authenticating with VMware ESX/VC server. | -
| vmware_store_image_dir = /openstack_glance | -(StrOpt) The name of the directory where the glance images will be stored in the VMware datastore. | -
| vmware_task_poll_interval = 5 | -(IntOpt) The interval used for polling remote tasks invoked on VMware ESX/VC server. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| vmware_api_insecure = False | +(BoolOpt) Allow to perform insecure SSL requests to ESX/VC. | +
| vmware_api_retry_count = 10 | +(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues. | +
| vmware_datacenter_path = ha-datacenter | +(StrOpt) Inventory path to a datacenter. If the vmware_server_host specified is an ESX/ESXi, the vmware_datacenter_path is optional. If specified, it should be "ha-datacenter". | +
| vmware_datastore_name = None | +(StrOpt) Datastore associated with the datacenter. | +
| vmware_server_host = None | +(StrOpt) ESX/ESXi or vCenter Server target system. The server value can be an IP address or a DNS name. | +
| vmware_server_password = None | +(StrOpt) Password for authenticating with VMware ESX/VC server. | +
| vmware_server_username = None | +(StrOpt) Username for authenticating with VMware ESX/VC server. | +
| vmware_store_image_dir = /openstack_glance | +(StrOpt) The name of the directory where the glance images will be stored in the VMware datastore. | +
| vmware_task_poll_interval = 5 | +(IntOpt) The interval used for polling remote tasks invoked on VMware ESX/VC server. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| backdoor_port = None | -(IntOpt) port for eventlet backdoor to listen | -
| eventlet_hub = poll | -(StrOpt) Name of eventlet hub to use. Traditionally, we have only supported 'poll', however 'selects' may be appropriate for some platforms. See http://eventlet.net/doc/hubs.html for more details. | -
| max_header_line = 16384 | -(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs | -
| tcp_keepidle = 600 | -(IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| eventlet_hub = poll | +(StrOpt) Name of eventlet hub to use. Traditionally, we have only supported 'poll', however 'selects' may be appropriate for some platforms. See http://eventlet.net/doc/hubs.html for more details. | +
| max_header_line = 16384 | +(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs | +
| tcp_keepidle = 600 | +(IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| rpc_cast_timeout = 30 | -(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| rpc_zmq_bind_address = * | -(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| rpc_zmq_contexts = 1 | -(IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| rpc_zmq_host = oslo | -(StrOpt) 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 | -(StrOpt) Directory for holding IPC sockets. | -
| rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost | -(StrOpt) MatchMaker driver. | -
| rpc_zmq_port = 9501 | -(IntOpt) ZeroMQ receiver listening port. | -
| rpc_zmq_topic_backlog = None | -(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| rpc_cast_timeout = 30 | +(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | +
| rpc_zmq_bind_address = * | +(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | +
| rpc_zmq_contexts = 1 | +(IntOpt) Number of ZeroMQ contexts, defaults to 1. | +
| rpc_zmq_host = oslo | +(StrOpt) 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 | +(StrOpt) Directory for holding IPC sockets. | +
| rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost | +(StrOpt) MatchMaker driver. | +
| rpc_zmq_port = 9501 | +(IntOpt) ZeroMQ receiver listening port. | +
| rpc_zmq_topic_backlog = None | +(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| amqp_auto_delete = False | -(BoolOpt) Auto-delete queues in amqp. | -
| amqp_durable_queues = False | -(BoolOpt) Use durable queues in amqp. | -
| control_exchange = heat | -(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid | -
| default_notification_level = INFO | -(StrOpt) Default notification level for outgoing notifications | -
| default_publisher_id = None | -(StrOpt) Default publisher_id for outgoing notifications | -
| fake_rabbit = False | -(BoolOpt) If passed, use a fake RabbitMQ provider | -
| list_notifier_drivers = ['heat.openstack.common.notifier.no_op_notifier'] | -(MultiStrOpt) List of drivers to send notifications | -
| notification_driver = [] | -(MultiStrOpt) Driver or drivers to handle sending notifications | -
| notification_topics = notifications | -(ListOpt) AMQP topic used for OpenStack notifications | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| amqp_auto_delete = False | +(BoolOpt) Auto-delete queues in amqp. | +
| amqp_durable_queues = False | +(BoolOpt) Use durable queues in amqp. | +
| control_exchange = openstack | +(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid | +
| default_notification_level = INFO | +(StrOpt) Default notification level for outgoing notifications | +
| default_publisher_id = None | +(StrOpt) Default publisher_id for outgoing notifications | +
| fake_rabbit = False | +(BoolOpt) If passed, use a fake RabbitMQ provider | +
| list_notifier_drivers = None | +(MultiStrOpt) List of drivers to send notifications (DEPRECATED) | +
| notification_driver = [] | +(MultiStrOpt) Driver or drivers to handle sending notifications. | +
| notification_topics = notifications | +(ListOpt) AMQP topic used for OpenStack notifications. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| heat_metadata_server_url = | -(StrOpt) URL of the Heat metadata server. | -
| heat_stack_user_role = heat_stack_user | -(StrOpt) Keystone role for heat template-defined users. | -
| heat_waitcondition_server_url = | -(StrOpt) URL of the Heat waitcondition server. | -
| heat_watch_server_url = | -(StrOpt) URL of the Heat CloudWatch server. | -
| max_json_body_size = 1048576 | -(IntOpt) Maximum raw byte size of JSON request body. Should be larger than max_template_size. | -
| policy_default_rule = default | -(StrOpt) Rule enforced when requested rule is not found | -
| policy_file = policy.json | -(StrOpt) JSON file containing policy | -
| secure_proxy_ssl_header = X-Forwarded-Proto | -(StrOpt) The HTTP Header that will be used to determine which the original request protocol scheme was, even if it was removed by an SSL terminator proxy. | -
| stack_action_timeout = 3600 | -(IntOpt) Timeout in seconds for stack action (ie. create or update). | -
| stack_domain_admin = None | -(StrOpt) Keystone username, a user with roles sufficient to manage users and projects in the stack_user_domain. | -
| stack_domain_admin_password = None | -(StrOpt) Keystone password for stack_domain_admin user. | -
| stack_user_domain = None | -(StrOpt) Keystone domain ID which contains heat template-defined users. | -
| trusts_delegated_roles = heat_stack_owner | -(ListOpt) Subset of trustor roles to be delegated to heat. | -
| [auth_password] | -|
| allowed_auth_uris = | -(ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. | -
| multi_cloud = False | -(BoolOpt) Allow orchestration of multiple clouds. | -
| [ec2authtoken] | -|
| allowed_auth_uris = | -(ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. | -
| auth_uri = None | -(StrOpt) Authentication Endpoint URI. | -
| multi_cloud = False | -(BoolOpt) Allow orchestration of multiple clouds. | -
| [heat_api] | -|
| backlog = 4096 | -(IntOpt) Number of backlog requests to configure the socket with. | -
| bind_host = 0.0.0.0 | -(StrOpt) Address to bind the server. Useful when selecting a particular network interface. | -
| bind_port = 8004 | -(IntOpt) The port on which the server will listen. | -
| cert_file = None | -(StrOpt) Location of the SSL certificate file to use for SSL mode. | -
| key_file = None | -(StrOpt) Location of the SSL key file to use for enabling SSL mode. | -
| max_header_line = 16384 | -(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). | -
| workers = 0 | -(IntOpt) Number of workers for Heat service. | -
| [paste_deploy] | -|
| api_paste_config = api-paste.ini | -(StrOpt) The API paste config file to use. | -
| flavor = None | -(StrOpt) The flavor to use. | -
| [ssl] | -|
| ca_file = None | -(StrOpt) CA certificate file to use to verify connecting clients | -
| cert_file = None | -(StrOpt) Certificate file to use when starting the server securely | -
| key_file = None | -(StrOpt) Private key file to use when starting the server securely | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| heat_metadata_server_url = | +(StrOpt) URL of the Heat metadata server. | +
| heat_stack_user_role = heat_stack_user | +(StrOpt) Keystone role for heat template-defined users. | +
| heat_waitcondition_server_url = | +(StrOpt) URL of the Heat waitcondition server. | +
| heat_watch_server_url = | +(StrOpt) URL of the Heat CloudWatch server. | +
| max_json_body_size = 1048576 | +(IntOpt) Maximum raw byte size of JSON request body. Should be larger than max_template_size. | +
| num_engine_workers = 1 | +(IntOpt) Number of heat-engine processes to fork and run. | +
| policy_default_rule = default | +(StrOpt) Default rule. Enforced when a requested rule is not found. | +
| policy_file = policy.json | +(StrOpt) The JSON file that defines policies. | +
| secure_proxy_ssl_header = X-Forwarded-Proto | +(StrOpt) The HTTP Header that will be used to determine which the original request protocol scheme was, even if it was removed by an SSL terminator proxy. | +
| stack_action_timeout = 3600 | +(IntOpt) Timeout in seconds for stack action (ie. create or update). | +
| stack_domain_admin = None | +(StrOpt) Keystone username, a user with roles sufficient to manage users and projects in the stack_user_domain. | +
| stack_domain_admin_password = None | +(StrOpt) Keystone password for stack_domain_admin user. | +
| stack_user_domain = None | +(StrOpt) Keystone domain ID which contains heat template-defined users. | +
| trusts_delegated_roles = heat_stack_owner | +(ListOpt) Subset of trustor roles to be delegated to heat. | +
| [auth_password] | +|
| allowed_auth_uris = | +(ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. | +
| multi_cloud = False | +(BoolOpt) Allow orchestration of multiple clouds. | +
| [ec2authtoken] | +|
| allowed_auth_uris = | +(ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. | +
| auth_uri = None | +(StrOpt) Authentication Endpoint URI. | +
| multi_cloud = False | +(BoolOpt) Allow orchestration of multiple clouds. | +
| [heat_api] | +|
| backlog = 4096 | +(IntOpt) Number of backlog requests to configure the socket with. | +
| bind_host = 0.0.0.0 | +(StrOpt) Address to bind the server. Useful when selecting a particular network interface. | +
| bind_port = 8004 | +(IntOpt) The port on which the server will listen. | +
| cert_file = None | +(StrOpt) Location of the SSL certificate file to use for SSL mode. | +
| key_file = None | +(StrOpt) Location of the SSL key file to use for enabling SSL mode. | +
| max_header_line = 16384 | +(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). | +
| workers = 0 | +(IntOpt) Number of workers for Heat service. | +
| [paste_deploy] | +|
| api_paste_config = api-paste.ini | +(StrOpt) The API paste config file to use. | +
| flavor = None | +(StrOpt) The flavor to use. | +
| [ssl] | +|
| ca_file = None | +(StrOpt) CA certificate file to use to verify connecting clients. | +
| cert_file = None | +(StrOpt) Certificate file to use when starting the server securely. | +
| key_file = None | +(StrOpt) Private key file to use when starting the server securely. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| memcached_servers = None | -(ListOpt) Memcached servers or None for in process cache. | -
| [keystone_authtoken] | -|
| admin_password = None | -(StrOpt) Keystone account password | -
| admin_tenant_name = admin | -(StrOpt) Keystone service account tenant name to validate user tokens | -
| admin_token = None | -(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. | -
| admin_user = None | -(StrOpt) Keystone account username | -
| auth_admin_prefix = | -(StrOpt) Prefix to prepend at the beginning of the path | -
| auth_host = 127.0.0.1 | -(StrOpt) Host providing the admin Identity API endpoint | -
| auth_port = 35357 | -(IntOpt) Port of the admin Identity API endpoint | -
| auth_protocol = https | -(StrOpt) Protocol of the admin Identity API endpoint(http or https) | -
| auth_uri = None | -(StrOpt) Complete public Identity API endpoint | -
| auth_version = None | -(StrOpt) API version of the admin Identity API endpoint | -
| cache = None | -(StrOpt) Env key for the swift cache | -
| cafile = None | -(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| certfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| delay_auth_decision = False | -(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | -
| enforce_token_bind = permissive | -(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| http_connect_timeout = None | -(BoolOpt) Request timeout value for communicating with Identity API server. | -
| http_request_max_retries = 3 | -(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| include_service_catalog = True | -(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| insecure = False | -(BoolOpt) Verify HTTPS connections. | -
| keyfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| memcache_secret_key = None | -(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | -
| memcache_security_strategy = None | -(StrOpt) (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. | -
| memcached_servers = None | -(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| revocation_cache_time = 300 | -(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| signing_dir = None | -(StrOpt) Directory used to cache files related to PKI tokens | -
| token_cache_time = 300 | -(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| memcached_servers = None | +(ListOpt) Memcached servers or None for in process cache. | +
| [keystone_authtoken] | +|
| admin_password = None | +(StrOpt) Keystone account password | +
| admin_tenant_name = admin | +(StrOpt) Keystone service account tenant name to validate user tokens | +
| admin_token = None | +(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | +
| admin_user = None | +(StrOpt) Keystone account username | +
| auth_admin_prefix = | +(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | +
| auth_host = 127.0.0.1 | +(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_port = 35357 | +(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_protocol = https | +(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | +
| auth_uri = None | +(StrOpt) Complete public Identity API endpoint | +
| auth_version = None | +(StrOpt) API version of the admin Identity API endpoint | +
| cache = None | +(StrOpt) Env key for the swift cache | +
| cafile = None | +(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | +
| certfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| check_revocations_for_cached = False | +(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server. | +
| delay_auth_decision = False | +(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | +
| enforce_token_bind = permissive | +(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | +
| hash_algorithms = md5 | +(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | +
| http_connect_timeout = None | +(BoolOpt) Request timeout value for communicating with Identity API server. | +
| http_request_max_retries = 3 | +(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | +
| identity_uri = None | +(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | +
| include_service_catalog = True | +(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | +
| insecure = False | +(BoolOpt) Verify HTTPS connections. | +
| keyfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| memcache_secret_key = None | +(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | +
| memcache_security_strategy = None | +(StrOpt) (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. | +
| memcached_servers = None | +(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | +
| revocation_cache_time = 10 | +(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | +
| signing_dir = None | +(StrOpt) Directory used to cache files related to PKI tokens | +
| token_cache_time = 300 | +(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| instance_connection_https_validate_certificates = 1 | -(StrOpt) Instance connection to CFN/CW API validate certs if SSL is used. | -
| instance_connection_is_secure = 0 | -(StrOpt) Instance connection to CFN/CW API via https. | -
| [heat_api_cfn] | -|
| backlog = 4096 | -(IntOpt) Number of backlog requests to configure the socket with. | -
| bind_host = 0.0.0.0 | -(StrOpt) Address to bind the server. Useful when selecting a particular network interface. | -
| bind_port = 8000 | -(IntOpt) The port on which the server will listen. | -
| cert_file = None | -(StrOpt) Location of the SSL certificate file to use for SSL mode. | -
| key_file = None | -(StrOpt) Location of the SSL key file to use for enabling SSL mode. | -
| max_header_line = 16384 | -(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). | -
| workers = 0 | -(IntOpt) Number of workers for Heat service. | -
| [ssl] | -|
| ca_file = None | -(StrOpt) CA certificate file to use to verify connecting clients | -
| cert_file = None | -(StrOpt) Certificate file to use when starting the server securely | -
| key_file = None | -(StrOpt) Private key file to use when starting the server securely | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| instance_connection_https_validate_certificates = 1 | +(StrOpt) Instance connection to CFN/CW API validate certs if SSL is used. | +
| instance_connection_is_secure = 0 | +(StrOpt) Instance connection to CFN/CW API via https. | +
| [heat_api_cfn] | +|
| backlog = 4096 | +(IntOpt) Number of backlog requests to configure the socket with. | +
| bind_host = 0.0.0.0 | +(StrOpt) Address to bind the server. Useful when selecting a particular network interface. | +
| bind_port = 8000 | +(IntOpt) The port on which the server will listen. | +
| cert_file = None | +(StrOpt) Location of the SSL certificate file to use for SSL mode. | +
| key_file = None | +(StrOpt) Location of the SSL key file to use for enabling SSL mode. | +
| max_header_line = 16384 | +(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). | +
| workers = 0 | +(IntOpt) Number of workers for Heat service. | +
| [ssl] | +|
| ca_file = None | +(StrOpt) CA certificate file to use to verify connecting clients. | +
| cert_file = None | +(StrOpt) Certificate file to use when starting the server securely. | +
| key_file = None | +(StrOpt) Private key file to use when starting the server securely. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| region_name_for_services = None | -(StrOpt) Default region name used to get services endpoints. | -
| [clients] | -|
| ca_file = None | -(StrOpt) Optional CA cert file to use in SSL connections. | -
| cert_file = None | -(StrOpt) Optional PEM-formatted certificate chain file. | -
| endpoint_type = publicURL | -(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| insecure = False | -(BoolOpt) If set, then the server's certificate will not be verified. | -
| key_file = None | -(StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| region_name_for_services = None | +(StrOpt) Default region name used to get services endpoints. | +
| [clients] | +|
| ca_file = None | +(StrOpt) Optional CA cert file to use in SSL connections. | +
| cert_file = None | +(StrOpt) Optional PEM-formatted certificate chain file. | +
| endpoint_type = publicURL | +(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | +
| insecure = False | +(BoolOpt) If set, then the server's certificate will not be verified. | +
| key_file = None | +(StrOpt) Optional PEM-formatted file that contains the private key. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| cloud_backend = heat.engine.clients.OpenStackClients | -(StrOpt) Fully qualified class name to use as a client backend. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| cloud_backend = heat.engine.clients.OpenStackClients | +(StrOpt) Fully qualified class name to use as a client backend. | +
| Configuration option = Default value | -Description | -
|---|---|
| [clients_ceilometer] | -|
| ca_file = None | -(StrOpt) Optional CA cert file to use in SSL connections. | -
| cert_file = None | -(StrOpt) Optional PEM-formatted certificate chain file. | -
| endpoint_type = publicURL | -(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| insecure = False | -(BoolOpt) If set, then the server's certificate will not be verified. | -
| key_file = None | -(StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | +Description | +
|---|---|
| [clients_ceilometer] | +|
| ca_file = None | +(StrOpt) Optional CA cert file to use in SSL connections. | +
| cert_file = None | +(StrOpt) Optional PEM-formatted certificate chain file. | +
| endpoint_type = publicURL | +(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | +
| insecure = False | +(BoolOpt) If set, then the server's certificate will not be verified. | +
| key_file = None | +(StrOpt) Optional PEM-formatted file that contains the private key. | +
| Configuration option = Default value | -Description | -
|---|---|
| [clients_cinder] | -|
| ca_file = None | -(StrOpt) Optional CA cert file to use in SSL connections. | -
| cert_file = None | -(StrOpt) Optional PEM-formatted certificate chain file. | -
| endpoint_type = publicURL | -(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| insecure = False | -(BoolOpt) If set, then the server's certificate will not be verified. | -
| key_file = None | -(StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | +Description | +
|---|---|
| [clients_cinder] | +|
| ca_file = None | +(StrOpt) Optional CA cert file to use in SSL connections. | +
| cert_file = None | +(StrOpt) Optional PEM-formatted certificate chain file. | +
| endpoint_type = publicURL | +(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | +
| insecure = False | +(BoolOpt) If set, then the server's certificate will not be verified. | +
| key_file = None | +(StrOpt) Optional PEM-formatted file that contains the private key. | +
| Configuration option = Default value | +Description | +
|---|---|
| [clients_glance] | +|
| ca_file = None | +(StrOpt) Optional CA cert file to use in SSL connections. | +
| cert_file = None | +(StrOpt) Optional PEM-formatted certificate chain file. | +
| endpoint_type = publicURL | +(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | +
| insecure = False | +(BoolOpt) If set, then the server's certificate will not be verified. | +
| key_file = None | +(StrOpt) Optional PEM-formatted file that contains the private key. | +
| Configuration option = Default value | -Description | -
|---|---|
| [clients_heat] | -|
| ca_file = None | -(StrOpt) Optional CA cert file to use in SSL connections. | -
| cert_file = None | -(StrOpt) Optional PEM-formatted certificate chain file. | -
| endpoint_type = publicURL | -(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| insecure = False | -(BoolOpt) If set, then the server's certificate will not be verified. | -
| key_file = None | -(StrOpt) Optional PEM-formatted file that contains the private key. | -
| url = None | -(StrOpt) Optional heat url in format like http://0.0.0.0:8004/v1/%(tenant_id)s. | -
| Configuration option = Default value | +Description | +
|---|---|
| [clients_heat] | +|
| ca_file = None | +(StrOpt) Optional CA cert file to use in SSL connections. | +
| cert_file = None | +(StrOpt) Optional PEM-formatted certificate chain file. | +
| endpoint_type = publicURL | +(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | +
| insecure = False | +(BoolOpt) If set, then the server's certificate will not be verified. | +
| key_file = None | +(StrOpt) Optional PEM-formatted file that contains the private key. | +
| url = None | +(StrOpt) Optional heat url in format like http://0.0.0.0:8004/v1/%(tenant_id)s. | +
| Configuration option = Default value | -Description | -
|---|---|
| [clients_keystone] | -|
| ca_file = None | -(StrOpt) Optional CA cert file to use in SSL connections. | -
| cert_file = None | -(StrOpt) Optional PEM-formatted certificate chain file. | -
| endpoint_type = publicURL | -(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| insecure = False | -(BoolOpt) If set, then the server's certificate will not be verified. | -
| key_file = None | -(StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | +Description | +
|---|---|
| [clients_keystone] | +|
| ca_file = None | +(StrOpt) Optional CA cert file to use in SSL connections. | +
| cert_file = None | +(StrOpt) Optional PEM-formatted certificate chain file. | +
| endpoint_type = publicURL | +(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | +
| insecure = False | +(BoolOpt) If set, then the server's certificate will not be verified. | +
| key_file = None | +(StrOpt) Optional PEM-formatted file that contains the private key. | +
| Configuration option = Default value | -Description | -
|---|---|
| [clients_neutron] | -|
| ca_file = None | -(StrOpt) Optional CA cert file to use in SSL connections. | -
| cert_file = None | -(StrOpt) Optional PEM-formatted certificate chain file. | -
| endpoint_type = publicURL | -(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| insecure = False | -(BoolOpt) If set, then the server's certificate will not be verified. | -
| key_file = None | -(StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | +Description | +
|---|---|
| [clients_neutron] | +|
| ca_file = None | +(StrOpt) Optional CA cert file to use in SSL connections. | +
| cert_file = None | +(StrOpt) Optional PEM-formatted certificate chain file. | +
| endpoint_type = publicURL | +(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | +
| insecure = False | +(BoolOpt) If set, then the server's certificate will not be verified. | +
| key_file = None | +(StrOpt) Optional PEM-formatted file that contains the private key. | +
| Configuration option = Default value | -Description | -
|---|---|
| [clients_nova] | -|
| ca_file = None | -(StrOpt) Optional CA cert file to use in SSL connections. | -
| cert_file = None | -(StrOpt) Optional PEM-formatted certificate chain file. | -
| endpoint_type = publicURL | -(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| insecure = False | -(BoolOpt) If set, then the server's certificate will not be verified. | -
| key_file = None | -(StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | +Description | +
|---|---|
| [clients_nova] | +|
| ca_file = None | +(StrOpt) Optional CA cert file to use in SSL connections. | +
| cert_file = None | +(StrOpt) Optional PEM-formatted certificate chain file. | +
| endpoint_type = publicURL | +(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | +
| http_log_debug = False | +(BoolOpt) Allow client's debug log output. | +
| insecure = False | +(BoolOpt) If set, then the server's certificate will not be verified. | +
| key_file = None | +(StrOpt) Optional PEM-formatted file that contains the private key. | +
| Configuration option = Default value | -Description | -
|---|---|
| [clients_swift] | -|
| ca_file = None | -(StrOpt) Optional CA cert file to use in SSL connections. | -
| cert_file = None | -(StrOpt) Optional PEM-formatted certificate chain file. | -
| endpoint_type = publicURL | -(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| insecure = False | -(BoolOpt) If set, then the server's certificate will not be verified. | -
| key_file = None | -(StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | +Description | +
|---|---|
| [clients_swift] | +|
| ca_file = None | +(StrOpt) Optional CA cert file to use in SSL connections. | +
| cert_file = None | +(StrOpt) Optional PEM-formatted certificate chain file. | +
| endpoint_type = publicURL | +(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | +
| insecure = False | +(BoolOpt) If set, then the server's certificate will not be verified. | +
| key_file = None | +(StrOpt) Optional PEM-formatted file that contains the private key. | +
| Configuration option = Default value | -Description | -
|---|---|
| [clients_trove] | -|
| ca_file = None | -(StrOpt) Optional CA cert file to use in SSL connections. | -
| cert_file = None | -(StrOpt) Optional PEM-formatted certificate chain file. | -
| endpoint_type = publicURL | -(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | -
| insecure = False | -(BoolOpt) If set, then the server's certificate will not be verified. | -
| key_file = None | -(StrOpt) Optional PEM-formatted file that contains the private key. | -
| Configuration option = Default value | +Description | +
|---|---|
| [clients_trove] | +|
| ca_file = None | +(StrOpt) Optional CA cert file to use in SSL connections. | +
| cert_file = None | +(StrOpt) Optional PEM-formatted certificate chain file. | +
| endpoint_type = publicURL | +(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. | +
| insecure = False | +(BoolOpt) If set, then the server's certificate will not be verified. | +
| key_file = None | +(StrOpt) Optional PEM-formatted file that contains the private key. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| heat_watch_server_url = | -(StrOpt) URL of the Heat CloudWatch server. | -
| [heat_api_cloudwatch] | -|
| backlog = 4096 | -(IntOpt) Number of backlog requests to configure the socket with. | -
| bind_host = 0.0.0.0 | -(StrOpt) Address to bind the server. Useful when selecting a particular network interface. | -
| bind_port = 8003 | -(IntOpt) The port on which the server will listen. | -
| cert_file = None | -(StrOpt) Location of the SSL certificate file to use for SSL mode. | -
| key_file = None | -(StrOpt) Location of the SSL key file to use for enabling SSL mode. | -
| max_header_line = 16384 | -(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs.) | -
| workers = 0 | -(IntOpt) Number of workers for Heat service. | -
| [ssl] | -|
| ca_file = None | -(StrOpt) CA certificate file to use to verify connecting clients | -
| cert_file = None | -(StrOpt) Certificate file to use when starting the server securely | -
| key_file = None | -(StrOpt) Private key file to use when starting the server securely | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| heat_watch_server_url = | +(StrOpt) URL of the Heat CloudWatch server. | +
| [heat_api_cloudwatch] | +|
| backlog = 4096 | +(IntOpt) Number of backlog requests to configure the socket with. | +
| bind_host = 0.0.0.0 | +(StrOpt) Address to bind the server. Useful when selecting a particular network interface. | +
| bind_port = 8003 | +(IntOpt) The port on which the server will listen. | +
| cert_file = None | +(StrOpt) Location of the SSL certificate file to use for SSL mode. | +
| key_file = None | +(StrOpt) Location of the SSL key file to use for enabling SSL mode. | +
| max_header_line = 16384 | +(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs.) | +
| workers = 0 | +(IntOpt) Number of workers for Heat service. | +
| [ssl] | +|
| ca_file = None | +(StrOpt) CA certificate file to use to verify connecting clients. | +
| cert_file = None | +(StrOpt) Certificate file to use when starting the server securely. | +
| key_file = None | +(StrOpt) Private key file to use when starting the server securely. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| deferred_auth_method = password | -(StrOpt) Select deferred auth method, stored password or trusts. | -
| environment_dir = /etc/heat/environment.d | -(StrOpt) The directory to search for environment files. | -
| event_purge_batch_size = 10 | -(IntOpt) Controls how many events will be pruned whenever a stack's events exceed max_events_per_stack. Set this lower to keep more events at the expense of more frequent purges. | -
| instance_driver = heat.engine.nova | -(StrOpt) Driver to use for controlling instances. | -
| instance_user = ec2-user | -(StrOpt) The default user for new instances. This option is deprecated and will be removed in the Juno release. If it's empty, Heat will use the default user set up with your cloud image (for OS::Nova::Server) or 'ec2-user' (for AWS::EC2::Instance). | -
| keystone_backend = heat.common.heat_keystoneclient.KeystoneClientV3 | -(StrOpt) Fully qualified class name to use as a keystone backend. | -
| periodic_interval = 60 | -(IntOpt) Seconds between running periodic tasks. | -
| plugin_dirs = /usr/lib64/heat, /usr/lib/heat | -(ListOpt) List of directories to search for plug-ins. | -
| [revision] | -|
| heat_revision = unknown | -(StrOpt) Heat build revision. If you would prefer to manage your build revision separately, you can move this section to a different file and add it as another config option. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| deferred_auth_method = password | +(StrOpt) Select deferred auth method, stored password or trusts. | +
| environment_dir = /etc/heat/environment.d | +(StrOpt) The directory to search for environment files. | +
| event_purge_batch_size = 10 | +(IntOpt) Controls how many events will be pruned whenever a stack's events exceed max_events_per_stack. Set this lower to keep more events at the expense of more frequent purges. | +
| instance_driver = heat.engine.nova | +(StrOpt) Driver to use for controlling instances. | +
| instance_user = ec2-user | +(StrOpt) The default user for new instances. This option is deprecated and will be removed in the Juno release. If it's empty, Heat will use the default user set up with your cloud image (for OS::Nova::Server) or 'ec2-user' (for AWS::EC2::Instance). | +
| keystone_backend = heat.common.heat_keystoneclient.KeystoneClientV3 | +(StrOpt) Fully qualified class name to use as a keystone backend. | +
| periodic_interval = 60 | +(IntOpt) Seconds between running periodic tasks. | +
| plugin_dirs = /usr/lib64/heat, /usr/lib/heat | +(ListOpt) List of directories to search for plug-ins. | +
| [revision] | +|
| heat_revision = unknown | +(StrOpt) Heat build revision. If you would prefer to manage your build revision separately, you can move this section to a different file and add it as another config option. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| auth_encryption_key = notgood but just long enough i think | -(StrOpt) Encryption key used for authentication info in database. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| auth_encryption_key = notgood but just long enough i think | +(StrOpt) Encryption key used for authentication info in database. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| db_backend = sqlalchemy | -(StrOpt) The backend to use for db. | -
| sqlite_db = heat.sqlite | -(StrOpt) the filename to use with sqlite | -
| sqlite_synchronous = True | -(BoolOpt) If true, use synchronous mode for sqlite | -
| [database] | -|
| backend = sqlalchemy | -(StrOpt) The backend to use for db | -
| connection = sqlite:////usr/lib/python/site-packages/heat/openstack/common/db/$sqlite_db | -(StrOpt) The SQLAlchemy connection string used to connect to the database | -
| connection_debug = 0 | -(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything | -
| connection_trace = False | -(BoolOpt) Add python stack traces to SQL as comment strings | -
| idle_timeout = 3600 | -(IntOpt) timeout before idle sql connections are reaped | -
| max_overflow = None | -(IntOpt) If set, use this value for max_overflow with sqlalchemy | -
| max_pool_size = None | -(IntOpt) Maximum number of SQL connections to keep open in a pool | -
| max_retries = 10 | -(IntOpt) maximum db connection retries during startup. (setting -1 implies an infinite retry count) | -
| min_pool_size = 1 | -(IntOpt) Minimum number of SQL connections to keep open in a pool | -
| pool_timeout = None | -(IntOpt) If set, use this value for pool_timeout with sqlalchemy | -
| retry_interval = 10 | -(IntOpt) interval between retries of opening a sql connection | -
| slave_connection = | -(StrOpt) The SQLAlchemy connection string used to connect to the slave database | -
| Configuration option = Default value | +Description | +
|---|---|
| [database] | +|
| backend = sqlalchemy | +(StrOpt) The backend to use for db | +
| connection = None | +(StrOpt) The SQLAlchemy connection string used to connect to the database | +
| connection_debug = 0 | +(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything | +
| connection_trace = False | +(BoolOpt) Add python stack traces to SQL as comment strings | +
| db_inc_retry_interval = True | +(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval | +
| db_max_retries = 20 | +(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count) | +
| db_max_retry_interval = 10 | +(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled | +
| db_retry_interval = 1 | +(IntOpt) seconds between db connection retries | +
| idle_timeout = 3600 | +(IntOpt) Timeout before idle sql connections are reaped | +
| max_overflow = None | +(IntOpt) If set, use this value for max_overflow with sqlalchemy | +
| max_pool_size = None | +(IntOpt) Maximum number of SQL connections to keep open in a pool | +
| max_retries = 10 | +(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count) | +
| min_pool_size = 1 | +(IntOpt) Minimum number of SQL connections to keep open in a pool | +
| mysql_sql_mode = TRADITIONAL | +(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | +
| pool_timeout = None | +(IntOpt) If set, use this value for pool_timeout with sqlalchemy | +
| retry_interval = 10 | +(IntOpt) Interval between retries of opening a sql connection | +
| sqlite_db = heat.sqlite | +(StrOpt) The file name to use with SQLite | +
| sqlite_synchronous = True | +(BoolOpt) If True, SQLite uses synchronous mode | +
| use_db_reconnect = False | +(BoolOpt) Enable the experimental use of database reconnect on connection lost | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| backdoor_port = None | -(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. | -
| debug = False | -(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | -
| disable_process_locking = False | -(BoolOpt) Whether to disable inter-process locks | -
| fatal_deprecations = False | -(BoolOpt) make deprecations fatal | -
| lock_path = None | -(StrOpt) Directory to use for lock files. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| backdoor_port = None | +(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. | +
| debug = False | +(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | +
| disable_process_locking = False | +(BoolOpt) Enables or disables inter-process locks. | +
| fatal_deprecations = False | +(BoolOpt) Enables or disables fatal status of deprecations. | +
| lock_path = None | +(StrOpt) Directory to use for lock files. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| loadbalancer_template = None | -(StrOpt) Custom template for the built-in loadbalancer nested stack. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| loadbalancer_template = None | +(StrOpt) Custom template for the built-in loadbalancer nested stack. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN | -(ListOpt) list of logger=LEVEL pairs | -
| instance_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance is passed with the log message, format it like this | -
| instance_uuid_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance UUID is passed with the log message, format it like this | -
| log_config_append = None | -(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files. | -
| log_date_format = %Y-%m-%d %H:%M:%S | -(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s | -
| log_dir = None | -(StrOpt) (Optional) The base directory used for relative --log-file paths | -
| log_file = None | -(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | -
| log_format = None | -(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | -
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | -(StrOpt) format string to use for log messages with context | -
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | -(StrOpt) data to append to log format when level is DEBUG | -
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | -(StrOpt) format string to use for log messages without context | -
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -(StrOpt) prefix each line of exception output with this format | -
| syslog_log_facility = LOG_USER | -(StrOpt) syslog facility to receive log lines | -
| use_stderr = True | -(BoolOpt) Log output to standard error | -
| use_syslog = False | -(BoolOpt) Use syslog for logging. | -
| verbose = False | -(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| 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 | +(ListOpt) List of logger=LEVEL pairs. | +
| instance_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance that is passed with the log message. | +
| instance_uuid_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance UUID that is passed with the log message. | +
| log_config_append = None | +(StrOpt) 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. | +
| log_date_format = %Y-%m-%d %H:%M:%S | +(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . | +
| log_dir = None | +(StrOpt) (Optional) The base directory used for relative --log-file paths. | +
| log_file = None | +(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | +
| log_format = None | +(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | +
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages with context. | +
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | +(StrOpt) Data to append to log format when level is DEBUG. | +
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages without context. | +
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | +(StrOpt) Prefix each line of exception output with this format. | +
| syslog_log_facility = LOG_USER | +(StrOpt) Syslog facility to receive log lines. | +
| use_stderr = True | +(BoolOpt) Log output to standard error. | +
| use_syslog = False | +(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424. | +
| use_syslog_rfc_format = False | +(BoolOpt) (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 I, and will be removed in J. | +
| verbose = False | +(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| heat_metadata_server_url = | -(StrOpt) URL of the Heat metadata server. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| heat_metadata_server_url = | +(StrOpt) URL of the Heat metadata server. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| onready = None | -(StrOpt) onready allows you to send a notification when the heat processes are ready to serve. This is either a module with the notify() method or a shell command. To enable notifications with systemd, one may use the 'systemd-notify --ready' shell command or the 'heat.common.systemd' notification module. | -
| publish_errors = False | -(BoolOpt) publish error events | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| onready = None | +(StrOpt) onready allows you to send a notification when the heat processes are ready to serve. This is either a module with the notify() method or a shell command. To enable notifications with systemd, one may use the 'systemd-notify --ready' shell command or the 'heat.common.systemd' notification module. | +
| publish_errors = False | +(BoolOpt) Enables or disables publication of error events. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| qpid_heartbeat = 60 | -(IntOpt) Seconds between connection keepalive heartbeats | -
| qpid_hostname = localhost | -(StrOpt) Qpid broker hostname | -
| qpid_hosts = $qpid_hostname:$qpid_port | -(ListOpt) Qpid HA cluster host:port pairs | -
| qpid_password = | -(StrOpt) Password for qpid connection | -
| qpid_port = 5672 | -(IntOpt) Qpid broker port | -
| qpid_protocol = tcp | -(StrOpt) Transport to use, either 'tcp' or 'ssl' | -
| qpid_sasl_mechanisms = | -(StrOpt) Space separated list of SASL mechanisms to use for auth | -
| qpid_tcp_nodelay = True | -(BoolOpt) Disable Nagle algorithm | -
| qpid_topology_version = 1 | -(IntOpt) 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. | -
| qpid_username = | -(StrOpt) Username for qpid connection | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| qpid_heartbeat = 60 | +(IntOpt) Seconds between connection keepalive heartbeats. | +
| qpid_hostname = localhost | +(StrOpt) Qpid broker hostname. | +
| qpid_hosts = $qpid_hostname:$qpid_port | +(ListOpt) Qpid HA cluster host:port pairs. | +
| qpid_password = | +(StrOpt) Password for Qpid connection. | +
| qpid_port = 5672 | +(IntOpt) Qpid broker port. | +
| qpid_protocol = tcp | +(StrOpt) Transport to use, either 'tcp' or 'ssl'. | +
| qpid_sasl_mechanisms = | +(StrOpt) Space separated list of SASL mechanisms to use for auth. | +
| qpid_tcp_nodelay = True | +(BoolOpt) Whether to disable the Nagle algorithm. | +
| qpid_topology_version = 1 | +(IntOpt) 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. | +
| qpid_username = | +(StrOpt) Username for Qpid connection. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| max_events_per_stack = 1000 | -(IntOpt) Maximum events that will be available per stack. Older events will be deleted when this is reached. Set to 0 for unlimited events per stack. | -
| max_nested_stack_depth = 3 | -(IntOpt) Maximum depth allowed when using nested stacks. | -
| max_resources_per_stack = 1000 | -(IntOpt) Maximum resources allowed per top-level stack. | -
| max_stacks_per_tenant = 100 | -(IntOpt) Maximum number of stacks any one tenant may have active at one time. | -
| max_template_size = 524288 | -(IntOpt) Maximum raw byte size of any template. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| max_events_per_stack = 1000 | +(IntOpt) Maximum events that will be available per stack. Older events will be deleted when this is reached. Set to 0 for unlimited events per stack. | +
| max_nested_stack_depth = 3 | +(IntOpt) Maximum depth allowed when using nested stacks. | +
| max_resources_per_stack = 1000 | +(IntOpt) Maximum resources allowed per top-level stack. | +
| max_stacks_per_tenant = 100 | +(IntOpt) Maximum number of stacks any one tenant may have active at one time. | +
| max_template_size = 524288 | +(IntOpt) Maximum raw byte size of any template. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| kombu_ssl_ca_certs = | -(StrOpt) SSL certification authority file (valid only if SSL enabled) | -
| kombu_ssl_certfile = | -(StrOpt) SSL cert file (valid only if SSL enabled) | -
| kombu_ssl_keyfile = | -(StrOpt) SSL key file (valid only if SSL enabled) | -
| kombu_ssl_version = | -(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions | -
| rabbit_ha_queues = False | -(BoolOpt) use H/A queues in RabbitMQ (x-ha-policy: all).You need to wipe RabbitMQ database when changing this option. | -
| rabbit_host = localhost | -(StrOpt) The RabbitMQ broker address where a single node is used | -
| rabbit_hosts = $rabbit_host:$rabbit_port | -(ListOpt) RabbitMQ HA cluster host:port pairs | -
| rabbit_max_retries = 0 | -(IntOpt) maximum retries with trying to connect to RabbitMQ (the default of 0 implies an infinite retry count) | -
| rabbit_password = guest | -(StrOpt) the RabbitMQ password | -
| rabbit_port = 5672 | -(IntOpt) The RabbitMQ broker port where a single node is used | -
| rabbit_retry_backoff = 2 | -(IntOpt) how long to backoff for between retries when connecting to RabbitMQ | -
| rabbit_retry_interval = 1 | -(IntOpt) how frequently to retry connecting with RabbitMQ | -
| rabbit_use_ssl = False | -(BoolOpt) connect over SSL for RabbitMQ | -
| rabbit_userid = guest | -(StrOpt) the RabbitMQ userid | -
| rabbit_virtual_host = / | -(StrOpt) the RabbitMQ virtual host | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| kombu_reconnect_delay = 1.0 | +(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | +
| kombu_ssl_ca_certs = | +(StrOpt) SSL certification authority file (valid only if SSL enabled). | +
| kombu_ssl_certfile = | +(StrOpt) SSL cert file (valid only if SSL enabled). | +
| kombu_ssl_keyfile = | +(StrOpt) SSL key file (valid only if SSL enabled). | +
| kombu_ssl_version = | +(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions. | +
| rabbit_ha_queues = False | +(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | +
| rabbit_host = localhost | +(StrOpt) The RabbitMQ broker address where a single node is used. | +
| rabbit_hosts = $rabbit_host:$rabbit_port | +(ListOpt) RabbitMQ HA cluster host:port pairs. | +
| rabbit_login_method = AMQPLAIN | +(StrOpt) the RabbitMQ login method | +
| rabbit_max_retries = 0 | +(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | +
| rabbit_password = guest | +(StrOpt) The RabbitMQ password. | +
| rabbit_port = 5672 | +(IntOpt) The RabbitMQ broker port where a single node is used. | +
| rabbit_retry_backoff = 2 | +(IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | +
| rabbit_retry_interval = 1 | +(IntOpt) How frequently to retry connecting with RabbitMQ. | +
| rabbit_use_ssl = False | +(BoolOpt) Connect over SSL for RabbitMQ. | +
| rabbit_userid = guest | +(StrOpt) The RabbitMQ userid. | +
| rabbit_virtual_host = / | +(StrOpt) The RabbitMQ virtual host. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| host = oslo | -(StrOpt) Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. | -
| [matchmaker_redis] | -|
| host = 127.0.0.1 | -(StrOpt) Host to locate redis | -
| password = None | -(StrOpt) Password for Redis server. (optional) | -
| port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| host = oslo | +(StrOpt) Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions | -(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call. | -
| engine_life_check_timeout = 2 | -(IntOpt) RPC timeout for the engine liveness check that is used for stack locking. | -
| matchmaker_heartbeat_freq = 300 | -(IntOpt) Heartbeat frequency | -
| matchmaker_heartbeat_ttl = 600 | -(IntOpt) Heartbeat time-to-live. | -
| rpc_backend = heat.openstack.common.rpc.impl_kombu | -(StrOpt) The messaging module to use, defaults to kombu. | -
| rpc_cast_timeout = 30 | -(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool | -
| rpc_response_timeout = 60 | -(IntOpt) Seconds to wait for a response from call or multicall | -
| rpc_thread_pool_size = 64 | -(IntOpt) Size of RPC thread pool | -
| [matchmaker_ring] | -|
| ringfile = /etc/oslo/matchmaker_ring.json | -(StrOpt) Matchmaker ring file (JSON) | -
| [rpc_notifier2] | -|
| topics = notifications | -(ListOpt) AMQP topic(s) used for OpenStack notifications | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions | +(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call. | +
| engine_life_check_timeout = 2 | +(IntOpt) RPC timeout for the engine liveness check that is used for stack locking. | +
| matchmaker_heartbeat_freq = 300 | +(IntOpt) Heartbeat frequency. | +
| matchmaker_heartbeat_ttl = 600 | +(IntOpt) Heartbeat time-to-live. | +
| password = None | +(StrOpt) Password for Redis server (optional). | +
| port = 6379 | +(IntOpt) Use this port to connect to redis host. | +
| rpc_backend = heat.openstack.common.rpc.impl_kombu | +(StrOpt) The messaging module to use, defaults to kombu. | +
| rpc_cast_timeout = 30 | +(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | +
| rpc_conn_pool_size = 30 | +(IntOpt) Size of RPC connection pool | +
| rpc_response_timeout = 60 | +(IntOpt) Seconds to wait for a response from call or multicall | +
| rpc_thread_pool_size = 64 | +(IntOpt) Size of RPC thread pool | +
| transport_url = None | +(StrOpt) 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. | +
| [matchmaker_ring] | +|
| ringfile = /etc/oslo/matchmaker_ring.json | +(StrOpt) Matchmaker ring file (JSON). | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| heat_waitcondition_server_url = | -(StrOpt) URL of the Heat waitcondition server. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| heat_waitcondition_server_url = | +(StrOpt) URL of the Heat waitcondition server. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| rpc_zmq_bind_address = * | -(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| rpc_zmq_contexts = 1 | -(IntOpt) Number of ZeroMQ contexts, defaults to 1 | -
| rpc_zmq_host = oslo | -(StrOpt) 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 | -(StrOpt) Directory for holding IPC sockets | -
| rpc_zmq_matchmaker = heat.openstack.common.rpc.matchmaker.MatchMakerLocalhost | -(StrOpt) MatchMaker driver | -
| rpc_zmq_port = 9501 | -(IntOpt) ZeroMQ receiver listening port | -
| rpc_zmq_topic_backlog = None | -(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| rpc_zmq_bind_address = * | +(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | +
| rpc_zmq_contexts = 1 | +(IntOpt) Number of ZeroMQ contexts, defaults to 1. | +
| rpc_zmq_host = oslo | +(StrOpt) 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 | +(StrOpt) Directory for holding IPC sockets. | +
| rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost | +(StrOpt) MatchMaker driver. | +
| rpc_zmq_port = 9501 | +(IntOpt) ZeroMQ receiver listening port. | +
| rpc_zmq_topic_backlog = None | +(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| amqp_auto_delete = False | -(BoolOpt) Auto-delete queues in amqp. | -
| amqp_durable_queues = False | -(BoolOpt) Use durable queues in amqp. | -
| control_exchange = openstack | -(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| default_publisher_id = None | -(StrOpt) Default publisher_id for outgoing notifications | -
| notification_driver = [] | -(MultiStrOpt) Driver or drivers to handle sending notifications. | -
| notification_topics = notifications | -(ListOpt) AMQP topic used for OpenStack notifications. | -
| rpc_backend = rabbit | -(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| rpc_cast_timeout = 30 | -(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| rpc_response_timeout = 60 | -(IntOpt) Seconds to wait for a response from a call. | -
| rpc_thread_pool_size = 64 | -(IntOpt) Size of RPC greenthread pool. | -
| transport_url = None | -(StrOpt) 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. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| amqp_auto_delete = False | +(BoolOpt) Auto-delete queues in amqp. | +
| amqp_durable_queues = False | +(BoolOpt) Use durable queues in amqp. | +
| control_exchange = openstack | +(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid | +
| default_publisher_id = None | +(StrOpt) Default publisher_id for outgoing notifications | +
| notification_driver = [] | +(MultiStrOpt) Driver or drivers to handle sending notifications. | +
| notification_topics = notifications | +(ListOpt) AMQP topic used for OpenStack notifications. | +
| rpc_backend = keystone.openstack.common.rpc.impl_kombu | +(StrOpt) The messaging module to use, defaults to kombu. | +
| rpc_cast_timeout = 30 | +(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | +
| rpc_conn_pool_size = 30 | +(IntOpt) Size of RPC connection pool | +
| rpc_response_timeout = 60 | +(IntOpt) Seconds to wait for a response from call or multicall | +
| rpc_thread_pool_size = 64 | +(IntOpt) Size of RPC thread pool | +
| transport_url = None | +(StrOpt) 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. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| admin_bind_host = 0.0.0.0 | -(StrOpt) The IP Address of the network interface to for the admin service to listen on. | -
| admin_endpoint = None | -(StrOpt) The base admin endpoint URL for keystone that are advertised to clients (NOTE: this does NOT affect how keystone listens for connections). Defaults to the base host URL of the request. Eg a request to http://server:35357/v2.0/users will default to http://server:35357. You should only need to set this value if the base URL contains a path (eg /prefix/v2.0) or the endpoint should be found on a different server. | -
| admin_port = 35357 | -(IntOpt) The port number which the admin service listens on. | -
| admin_token = ADMIN | -(StrOpt) A "shared secret" that can be used to bootstrap Keystone. This "token" does not represent a user, and carries no explicit authorization. To disable in production (highly recommended), remove AdminTokenAuthMiddleware from your paste application pipelines (for example, in keystone-paste.ini). | -
| compute_port = 8774 | -(IntOpt) The port which the OpenStack Compute service listens on. | -
| domain_id_immutable = True | -(BoolOpt) Set this to false if you want to enable the ability for user, group and project entities to be moved between domains by updating their domain_id. Allowing such movement is not recommended if the scope of a domain admin is being restricted by use of an appropriate policy file (see policy.v3cloudsample as an example). | -
| list_limit = None | -(IntOpt) The maximum number of entities that will be returned in a collection can be set with list_limit, with no limit set by default. This global limit may be then overridden for a specific driver, by specifying a list_limit in the appropriate section (e.g. [assignment]). | -
| max_param_size = 64 | -(IntOpt) limit the sizes of user & tenant ID/names. | -
| max_request_body_size = 114688 | -(IntOpt) enforced by optional sizelimit middleware (keystone.middleware:RequestBodySizeLimiter). | -
| max_token_size = 8192 | -(IntOpt) similar to max_param_size, but provides an exception for token values. | -
| member_role_id = 9fe2ff9ee4384b1894a90878d3e92bab | -(StrOpt) During a SQL upgrade member_role_id will be used to create a new role that will replace records in the user_tenant_membership table with explicit role grants. After migration, the member_role_id will be used in the API add_user_to_project. | -
| member_role_name = _member_ | -(StrOpt) During a SQL upgrade member_role_id will be used to create a new role that will replace records in the user_tenant_membership table with explicit role grants. After migration, member_role_name will be ignored. | -
| public_bind_host = 0.0.0.0 | -(StrOpt) The IP Address of the network interface to for the public service to listen on. | -
| public_endpoint = None | -(StrOpt) The base public endpoint URL for keystone that are advertised to clients (NOTE: this does NOT affect how keystone listens for connections). Defaults to the base host URL of the request. Eg a request to http://server:5000/v2.0/users will default to http://server:5000. You should only need to set this value if the base URL contains a path (eg /prefix/v2.0) or the endpoint should be found on a different server. | -
| public_port = 5000 | -(IntOpt) The port number which the public service listens on. | -
| tcp_keepalive = False | -(BoolOpt) Set this to True if you want to enable TCP_KEEPALIVE on server sockets i.e. sockets used by the keystone wsgi server for client connections. | -
| tcp_keepidle = 600 | -(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Only applies if tcp_keepalive is True. Not supported on OS X. | -
| [endpoint_filter] | -|
| driver = keystone.contrib.endpoint_filter.backends.sql.EndpointFilter | -(StrOpt) Keystone Endpoint Filter backend driver | -
| return_all_endpoints_if_no_filter = True | -(BoolOpt) Toggle to return all active endpoints if no filter exists. | -
| [paste_deploy] | -|
| config_file = keystone-paste.ini | -(StrOpt) Name of the paste configuration file that defines the available pipelines. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| admin_bind_host = 0.0.0.0 | +(StrOpt) The IP address of the network interface for the admin service to listen on. | +
| admin_endpoint = None | +(StrOpt) The base admin endpoint URL for Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:35357/v2.0/users will default to http://server:35357. You should only need to set this value if the base URL contains a path (e.g. /prefix/v2.0) or the endpoint should be found on a different server. | +
| admin_port = 35357 | +(IntOpt) The port number which the admin service listens on. | +
| admin_token = ADMIN | +(StrOpt) A "shared secret" that can be used to bootstrap Keystone. This "token" does not represent a user, and carries no explicit authorization. To disable in production (highly recommended), remove AdminTokenAuthMiddleware from your paste application pipelines (for example, in keystone-paste.ini). | +
| admin_workers = 1 | +(IntOpt) The number of worker processes to serve the admin WSGI application | +
| compute_port = 8774 | +(IntOpt) The port which the OpenStack Compute service listens on. | +
| domain_id_immutable = True | +(BoolOpt) Set this to false if you want to enable the ability for user, group and project entities to be moved between domains by updating their domain_id. Allowing such movement is not recommended if the scope of a domain admin is being restricted by use of an appropriate policy file (see policy.v3cloudsample as an example). | +
| list_limit = None | +(IntOpt) The maximum number of entities that will be returned in a collection, with no limit set by default. This global limit may be then overridden for a specific driver, by specifying a list_limit in the appropriate section (e.g. [assignment]). | +
| max_param_size = 64 | +(IntOpt) Limit the sizes of user & project ID/names. | +
| max_request_body_size = 114688 | +(IntOpt) Enforced by optional sizelimit middleware (keystone.middleware:RequestBodySizeLimiter). | +
| max_token_size = 8192 | +(IntOpt) Similar to max_param_size, but provides an exception for token values. | +
| member_role_id = 9fe2ff9ee4384b1894a90878d3e92bab | +(StrOpt) During a SQL upgrade member_role_id will be used to create a new role that will replace records in the assignment table with explicit role grants. After migration, the member_role_id will be used in the API add_user_to_project. | +
| member_role_name = _member_ | +(StrOpt) During a SQL upgrade member_role_name will be used to create a new role that will replace records in the assignment table with explicit role grants. After migration, member_role_name will be ignored. | +
| public_bind_host = 0.0.0.0 | +(StrOpt) The IP address of the network interface for the public service to listen on. | +
| public_endpoint = None | +(StrOpt) The base public endpoint URL for Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:5000/v2.0/users will default to http://server:5000. You should only need to set this value if the base URL contains a path (e.g. /prefix/v2.0) or the endpoint should be found on a different server. | +
| public_port = 5000 | +(IntOpt) The port number which the public service listens on. | +
| public_workers = 1 | +(IntOpt) The number of worker processes to serve the public WSGI application | +
| strict_password_check = False | +(BoolOpt) If set to true, strict password length checking is performed for password manipulation. If a password exceeds the maximum length, the operation will fail with an HTTP 403 Forbidden error. If set to false, passwords are automatically truncated to the maximum length. | +
| tcp_keepalive = False | +(BoolOpt) Set this to true if you want to enable TCP_KEEPALIVE on server sockets, i.e. sockets used by the Keystone wsgi server for client connections. | +
| tcp_keepidle = 600 | +(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Only applies if tcp_keepalive is true. Not supported on OS X. | +
| [endpoint_filter] | +|
| driver = keystone.contrib.endpoint_filter.backends.sql.EndpointFilter | +(StrOpt) Endpoint Filter backend driver | +
| return_all_endpoints_if_no_filter = True | +(BoolOpt) Toggle to return all active endpoints if no filter exists. | +
| [paste_deploy] | +|
| config_file = keystone-paste.ini | +(StrOpt) Name of the paste configuration file that defines the available pipelines. | +
| Configuration option = Default value | -Description | -
|---|---|
| [assignment] | -|
| cache_time = None | -(IntOpt) TTL (in seconds) to cache assignment data. This has no effect unless global caching is enabled. | -
| caching = True | -(BoolOpt) Toggle for assignment caching. This has no effect unless global caching is enabled. | -
| driver = None | -(StrOpt) Keystone Assignment backend driver. | -
| list_limit = None | -(IntOpt) Maximum number of entities that will be returned in an assignment collection. | -
| Configuration option = Default value | +Description | +
|---|---|
| [assignment] | +|
| cache_time = None | +(IntOpt) TTL (in seconds) to cache assignment data. This has no effect unless global caching is enabled. | +
| caching = True | +(BoolOpt) Toggle for assignment caching. This has no effect unless global caching is enabled. | +
| driver = None | +(StrOpt) Assignment backend driver. | +
| list_limit = None | +(IntOpt) Maximum number of entities that will be returned in an assignment collection. | +
| Configuration option = Default value | -Description | -
|---|---|
| [auth] | -|
| external = keystone.auth.plugins.external.DefaultDomain | -(StrOpt) The external (REMOTE_USER) auth plugin module. | -
| methods = external, password, token | -(ListOpt) Default auth methods. | -
| password = keystone.auth.plugins.password.Password | -(StrOpt) The password auth plugin module. | -
| token = keystone.auth.plugins.token.Token | -(StrOpt) The token auth plugin module. | -
| Configuration option = Default value | +Description | +
|---|---|
| [auth] | +|
| external = keystone.auth.plugins.external.DefaultDomain | +(StrOpt) The external (REMOTE_USER) auth plugin module. | +
| methods = external, password, token | +(ListOpt) Default auth methods. | +
| password = keystone.auth.plugins.password.Password | +(StrOpt) The password auth plugin module. | +
| token = keystone.auth.plugins.token.Token | +(StrOpt) The token auth plugin module. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| memcached_servers = None | -(ListOpt) Memcached servers or None for in process cache. | -
| [keystone_authtoken] | -|
| admin_password = None | -(StrOpt) Keystone account password | -
| admin_tenant_name = admin | -(StrOpt) Keystone service account tenant name to validate user tokens | -
| admin_token = None | -(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. | -
| admin_user = None | -(StrOpt) Keystone account username | -
| auth_admin_prefix = | -(StrOpt) Prefix to prepend at the beginning of the path | -
| auth_host = 127.0.0.1 | -(StrOpt) Host providing the admin Identity API endpoint | -
| auth_port = 35357 | -(IntOpt) Port of the admin Identity API endpoint | -
| auth_protocol = https | -(StrOpt) Protocol of the admin Identity API endpoint(http or https) | -
| auth_uri = None | -(StrOpt) Complete public Identity API endpoint | -
| auth_version = None | -(StrOpt) API version of the admin Identity API endpoint | -
| cache = None | -(StrOpt) Env key for the swift cache | -
| cafile = None | -(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| certfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| delay_auth_decision = False | -(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | -
| enforce_token_bind = permissive | -(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| http_connect_timeout = None | -(BoolOpt) Request timeout value for communicating with Identity API server. | -
| http_request_max_retries = 3 | -(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| include_service_catalog = True | -(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| insecure = False | -(BoolOpt) Verify HTTPS connections. | -
| keyfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| memcache_secret_key = None | -(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | -
| memcache_security_strategy = None | -(StrOpt) (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. | -
| memcached_servers = None | -(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| revocation_cache_time = 300 | -(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| signing_dir = None | -(StrOpt) Directory used to cache files related to PKI tokens | -
| token_cache_time = 300 | -(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| memcached_servers = None | +(ListOpt) Memcached servers or None for in process cache. | +
| [keystone_authtoken] | +|
| admin_password = None | +(StrOpt) Keystone account password | +
| admin_tenant_name = admin | +(StrOpt) Keystone service account tenant name to validate user tokens | +
| admin_token = None | +(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | +
| admin_user = None | +(StrOpt) Keystone account username | +
| auth_admin_prefix = | +(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | +
| auth_host = 127.0.0.1 | +(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_port = 35357 | +(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_protocol = https | +(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | +
| auth_uri = None | +(StrOpt) Complete public Identity API endpoint | +
| auth_version = None | +(StrOpt) API version of the admin Identity API endpoint | +
| cache = None | +(StrOpt) Env key for the swift cache | +
| cafile = None | +(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | +
| certfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| check_revocations_for_cached = False | +(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server. | +
| delay_auth_decision = False | +(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | +
| enforce_token_bind = permissive | +(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | +
| hash_algorithms = md5 | +(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | +
| http_connect_timeout = None | +(BoolOpt) Request timeout value for communicating with Identity API server. | +
| http_request_max_retries = 3 | +(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | +
| identity_uri = None | +(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | +
| include_service_catalog = True | +(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | +
| insecure = False | +(BoolOpt) Verify HTTPS connections. | +
| keyfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| memcache_secret_key = None | +(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | +
| memcache_security_strategy = None | +(StrOpt) (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. | +
| memcached_servers = None | +(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | +
| revocation_cache_time = 10 | +(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | +
| signing_dir = None | +(StrOpt) Directory used to cache files related to PKI tokens | +
| token_cache_time = 300 | +(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | +
| Configuration option = Default value | -Description | -
|---|---|
| [cache] | -|
| backend = keystone.common.cache.noop | -(StrOpt) Dogpile.cache backend module. It is recommended that Memcache (dogpile.cache.memcache) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. | -
| backend_argument = [] | -(MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: "<argname>:<value>". | -
| config_prefix = cache.keystone | -(StrOpt) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. | -
| debug_cache_backend = False | -(BoolOpt) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls) This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to False. | -
| enabled = False | -(BoolOpt) Global toggle for all caching using the should_cache_fn mechanism. | -
| expiration_time = 600 | -(IntOpt) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. | -
| proxies = | -(ListOpt) Proxy Classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. Comma delimited list e.g. my.dogpile.proxy.Class, my.dogpile.proxyClass2. | -
| use_key_mangler = True | -(BoolOpt) Use a key-mangling function (sha1) to ensure fixed length cache-keys. This is toggle-able for debugging purposes, it is highly recommended to always leave this set to True. | -
| Configuration option = Default value | +Description | +
|---|---|
| [cache] | +|
| backend = keystone.common.cache.noop | +(StrOpt) Dogpile.cache backend module. It is recommended that Memcache (dogpile.cache.memcached) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. | +
| backend_argument = [] | +(MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: "<argname>:<value>". | +
| config_prefix = cache.keystone | +(StrOpt) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. | +
| debug_cache_backend = False | +(BoolOpt) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. | +
| enabled = False | +(BoolOpt) Global toggle for all caching using the should_cache_fn mechanism. | +
| expiration_time = 600 | +(IntOpt) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. | +
| proxies = | +(ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. | +
| use_key_mangler = True | +(BoolOpt) Use a key-mangling function (sha1) to ensure fixed length cache-keys. This is toggle-able for debugging purposes, it is highly recommended to always leave this set to true. | +
| Configuration option = Default value | -Description | -
|---|---|
| [catalog] | -|
| driver = keystone.catalog.backends.sql.Catalog | -(StrOpt) Keystone catalog backend driver. | -
| list_limit = None | -(IntOpt) Maximum number of entities that will be returned in a catalog collection. | -
| template_file = default_catalog.templates | -(StrOpt) Catalog template file name for use with the template catalog backend. | -
| Configuration option = Default value | +Description | +
|---|---|
| [catalog] | +|
| driver = keystone.catalog.backends.sql.Catalog | +(StrOpt) Catalog backend driver. | +
| list_limit = None | +(IntOpt) Maximum number of entities that will be returned in a catalog collection. | +
| template_file = default_catalog.templates | +(StrOpt) Catalog template file name for use with the template catalog backend. | +
| Configuration option = Default value | -Description | -
|---|---|
| [credential] | -|
| driver = keystone.credential.backends.sql.Credential | -(StrOpt) Keystone Credential backend driver. | -
| Configuration option = Default value | +Description | +
|---|---|
| [credential] | +|
| driver = keystone.credential.backends.sql.Credential | +(StrOpt) Credential backend driver. | +
| Configuration option = Default value | -Description | -
|---|---|
| [database] | -|
| backend = sqlalchemy | -(StrOpt) The backend to use for db | -
| connection = None | -(StrOpt) The SQLAlchemy connection string used to connect to the database | -
| connection_debug = 0 | -(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything | -
| connection_trace = False | -(BoolOpt) Add python stack traces to SQL as comment strings | -
| db_inc_retry_interval = True | -(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval | -
| db_max_retries = 20 | -(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count) | -
| db_max_retry_interval = 10 | -(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled | -
| db_retry_interval = 1 | -(IntOpt) seconds between db connection retries | -
| idle_timeout = 3600 | -(IntOpt) Timeout before idle sql connections are reaped | -
| max_overflow = None | -(IntOpt) If set, use this value for max_overflow with sqlalchemy | -
| max_pool_size = None | -(IntOpt) Maximum number of SQL connections to keep open in a pool | -
| max_retries = 10 | -(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count) | -
| min_pool_size = 1 | -(IntOpt) Minimum number of SQL connections to keep open in a pool | -
| mysql_sql_mode = TRADITIONAL | -(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | -
| pool_timeout = None | -(IntOpt) If set, use this value for pool_timeout with sqlalchemy | -
| retry_interval = 10 | -(IntOpt) Interval between retries of opening a sql connection | -
| sqlite_db = keystone.sqlite | -(StrOpt) The file name to use with SQLite | -
| sqlite_synchronous = True | -(BoolOpt) If True, SQLite uses synchronous mode | -
| use_db_reconnect = False | -(BoolOpt) Enable the experimental use of database reconnect on connection lost | -
| Configuration option = Default value | +Description | +
|---|---|
| [database] | +|
| backend = sqlalchemy | +(StrOpt) The back end to use for the database. | +
| connection = None | +(StrOpt) The SQLAlchemy connection string to use to connect to the database. | +
| connection_debug = 0 | +(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. | +
| connection_trace = False | +(BoolOpt) Add Python stack traces to SQL as comment strings. | +
| db_inc_retry_interval = True | +(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval. | +
| db_max_retries = 20 | +(IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count. | +
| db_max_retry_interval = 10 | +(IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries. | +
| db_retry_interval = 1 | +(IntOpt) Seconds between database connection retries. | +
| idle_timeout = 3600 | +(IntOpt) Timeout before idle SQL connections are reaped. | +
| max_overflow = None | +(IntOpt) If set, use this value for max_overflow with SQLAlchemy. | +
| max_pool_size = None | +(IntOpt) Maximum number of SQL connections to keep open in a pool. | +
| max_retries = 10 | +(IntOpt) Maximum db connection retries during startup. Set to -1 to specify an infinite retry count. | +
| min_pool_size = 1 | +(IntOpt) Minimum number of SQL connections to keep open in a pool. | +
| mysql_sql_mode = TRADITIONAL | +(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | +
| pool_timeout = None | +(IntOpt) If set, use this value for pool_timeout with SQLAlchemy. | +
| retry_interval = 10 | +(IntOpt) Interval between retries of opening a SQL connection. | +
| slave_connection = None | +(StrOpt) The SQLAlchemy connection string to use to connect to the slave database. | +
| sqlite_db = oslo.sqlite | +(StrOpt) The file name to use with SQLite. | +
| sqlite_synchronous = True | +(BoolOpt) If True, SQLite uses synchronous mode. | +
| use_db_reconnect = False | +(BoolOpt) Enable the experimental use of database reconnect on connection lost. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| backdoor_port = None | -(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. | -
| debug = False | -(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | -
| disable_process_locking = False | -(BoolOpt) Whether to disable inter-process locks | -
| fatal_deprecations = False | -(BoolOpt) Make deprecations fatal | -
| publish_errors = False | -(BoolOpt) Publish error events | -
| pydev_debug_host = None | -(StrOpt) Host to connect to for remote debugger. | -
| pydev_debug_port = None | -(IntOpt) Port to connect to for remote debugger. | -
| standard_threads = False | -(BoolOpt) Do not monkey-patch threading system modules. | -
| [audit] | -|
| namespace = openstack | -(StrOpt) namespace prefix for generated id | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| backdoor_port = None | +(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. | +
| debug = False | +(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | +
| disable_process_locking = False | +(BoolOpt) Enables or disables inter-process locks. | +
| fatal_deprecations = False | +(BoolOpt) Enables or disables fatal status of deprecations. | +
| publish_errors = False | +(BoolOpt) Enables or disables publication of error events. | +
| pydev_debug_host = None | +(StrOpt) Host to connect to for remote debugger. | +
| pydev_debug_port = None | +(IntOpt) Port to connect to for remote debugger. | +
| standard_threads = False | +(BoolOpt) Do not monkey-patch threading system modules. | +
| [audit] | +|
| namespace = openstack | +(StrOpt) namespace prefix for generated id | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| keystone_ec2_cafile = None | -(StrOpt) A PEM encoded certificate authority to use when verifying HTTPS connections. Defaults to the system CAs. | -
| keystone_ec2_certfile = None | -(StrOpt) Client certificate key filename. Required if EC2 server requires client certificate. | -
| keystone_ec2_insecure = False | -(BoolOpt) Disable SSL certificate verification. | -
| keystone_ec2_keyfile = None | -(StrOpt) Required if EC2 server requires client certificate. | -
| keystone_ec2_url = http://localhost:5000/v2.0/ec2tokens | -(StrOpt) URL to get token from ec2 request. | -
| [ec2] | -|
| driver = keystone.contrib.ec2.backends.kvs.Ec2 | -(StrOpt) Keystone EC2Credential backend driver. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| keystone_ec2_cafile = None | +(StrOpt) A PEM encoded certificate authority to use when verifying HTTPS connections. Defaults to the system CAs. | +
| keystone_ec2_certfile = None | +(StrOpt) Client certificate key filename. Required if EC2 server requires client certificate. | +
| keystone_ec2_insecure = False | +(BoolOpt) Disable SSL certificate verification. | +
| keystone_ec2_keyfile = None | +(StrOpt) Required if EC2 server requires client certificate. | +
| keystone_ec2_url = http://localhost:5000/v2.0/ec2tokens | +(StrOpt) URL to get token from ec2 request. | +
| [ec2] | +|
| driver = keystone.contrib.ec2.backends.kvs.Ec2 | +(StrOpt) EC2Credential backend driver. | +
| Configuration option = Default value | -Description | -
|---|---|
| [federation] | -|
| assertion_prefix = | -(StrOpt) Value to be used when filtering assertion parameters from the environment. | -
| driver = keystone.contrib.federation.backends.sql.Federation | -(StrOpt) Keystone Federation backend driver. | -
| Configuration option = Default value | +Description | +
|---|---|
| [federation] | +|
| assertion_prefix = | +(StrOpt) Value to be used when filtering assertion parameters from the environment. | +
| driver = keystone.contrib.federation.backends.sql.Federation | +(StrOpt) Federation backend driver. | +
| Configuration option = Default value | -Description | -
|---|---|
| [identity] | -|
| default_domain_id = default | -(StrOpt) This references the domain to use for all Identity API v2 requests (which are not aware of domains). A domain with this ID will be created for you by keystone-manage db_sync in migration 008. The domain referenced by this ID cannot be deleted on the v3 API, to prevent accidentally breaking the v2 API. There is nothing special about this domain, other than the fact that it must exist to order to maintain support for your v2 clients. | -
| domain_config_dir = /etc/keystone/domains | -(StrOpt) Path for Keystone to locate the domain specificidentity configuration files if domain_specific_drivers_enabled is set to true. | -
| domain_specific_drivers_enabled = False | -(BoolOpt) A subset (or all) of domains can have their own identity driver, each with their own partial configuration file in a domain configuration directory. Only values specific to the domain need to be placed in the domain specific configuration file. This feature is disabled by default; set to True to enable. | -
| driver = keystone.identity.backends.sql.Identity | -(StrOpt) Keystone Identity backend driver. | -
| list_limit = None | -(IntOpt) Maximum number of entities that will be returned in an identity collection. | -
| max_password_length = 4096 | -(IntOpt) Maximum supported length for user passwords; decrease to improve performance. | -
| Configuration option = Default value | +Description | +
|---|---|
| [identity] | +|
| default_domain_id = default | +(StrOpt) This references the domain to use for all Identity API v2 requests (which are not aware of domains). A domain with this ID will be created for you by keystone-manage db_sync in migration 008. The domain referenced by this ID cannot be deleted on the v3 API, to prevent accidentally breaking the v2 API. There is nothing special about this domain, other than the fact that it must exist to order to maintain support for your v2 clients. | +
| domain_config_dir = /etc/keystone/domains | +(StrOpt) Path for Keystone to locate the domain specific identity configuration files if domain_specific_drivers_enabled is set to true. | +
| domain_specific_drivers_enabled = False | +(BoolOpt) A subset (or all) of domains can have their own identity driver, each with their own partial configuration file in a domain configuration directory. Only values specific to the domain need to be placed in the domain specific configuration file. This feature is disabled by default; set to true to enable. | +
| driver = keystone.identity.backends.sql.Identity | +(StrOpt) Identity backend driver. | +
| list_limit = None | +(IntOpt) Maximum number of entities that will be returned in an identity collection. | +
| max_password_length = 4096 | +(IntOpt) Maximum supported length for user passwords; decrease to improve performance. | +
| Configuration option = Default value | -Description | -
|---|---|
| [kvs] | -|
| backends = | -(ListOpt) Extra dogpile.cache backend modules to register with the dogpile.cache library. | -
| config_prefix = keystone.kvs | -(StrOpt) Prefix for building the configuration dictionary for the KVS region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. | -
| default_lock_timeout = 5 | -(IntOpt) Default lock timeout for distributed locking. | -
| enable_key_mangler = True | -(BoolOpt) Toggle to disable using a key-mangling function to ensure fixed length keys. This is toggle-able for debugging purposes, it is highly recommended to always leave this set to True. | -
| Configuration option = Default value | +Description | +
|---|---|
| [kvs] | +|
| backends = | +(ListOpt) Extra dogpile.cache backend modules to register with the dogpile.cache library. | +
| config_prefix = keystone.kvs | +(StrOpt) Prefix for building the configuration dictionary for the KVS region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. | +
| default_lock_timeout = 5 | +(IntOpt) Default lock timeout for distributed locking. | +
| enable_key_mangler = True | +(BoolOpt) Toggle to disable using a key-mangling function to ensure fixed length keys. This is toggle-able for debugging purposes, it is highly recommended to always leave this set to true. | +
| Configuration option = Default value | -Description | -
|---|---|
| [ldap] | -|
| alias_dereferencing = default | -(StrOpt) The LDAP dereferencing option for queries. This can be either "never", "searching", "always", "finding" or "default". The "default" option falls back to using default dereferencing configured by your ldap.conf. | -
| allow_subtree_delete = False | -(BoolOpt) allow deleting subtrees. | -
| chase_referrals = None | -(BoolOpt) Override the system's default referral chasing behavior for queries. | -
| dumb_member = cn=dumb,dc=nonexistent | -(StrOpt) DN of the "dummy member" to use when "use_dumb_member" is enabled. | -
| group_additional_attribute_mapping = | -(ListOpt) Additional attribute mappings for groups. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. | -
| group_allow_create = True | -(BoolOpt) Allow group creation in LDAP backend. | -
| group_allow_delete = True | -(BoolOpt) Allow group deletion in LDAP backend. | -
| group_allow_update = True | -(BoolOpt) Allow group update in LDAP backend. | -
| group_attribute_ignore = | -(ListOpt) List of attributes stripped off the group on update. | -
| group_desc_attribute = description | -(StrOpt) LDAP attribute mapped to group description. | -
| group_filter = None | -(StrOpt) LDAP search filter for groups. | -
| group_id_attribute = cn | -(StrOpt) LDAP attribute mapped to group id. | -
| group_member_attribute = member | -(StrOpt) LDAP attribute mapped to show group membership. | -
| group_name_attribute = ou | -(StrOpt) LDAP attribute mapped to group name. | -
| group_objectclass = groupOfNames | -(StrOpt) LDAP objectClass for groups. | -
| group_tree_dn = None | -(StrOpt) Search base for groups. | -
| page_size = 0 | -(IntOpt) Maximum results per page; a value of zero ("0") disables paging. | -
| password = None | -(StrOpt) Password for the BindDN to query the LDAP server. | -
| query_scope = one | -(StrOpt) The LDAP scope for queries, this can be either "one" (onelevel/singleLevel) or "sub" (subtree/wholeSubtree). | -
| role_additional_attribute_mapping = | -(ListOpt) Additional attribute mappings for roles. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. | -
| role_allow_create = True | -(BoolOpt) Allow role creation in LDAP backend. | -
| role_allow_delete = True | -(BoolOpt) Allow role deletion in LDAP backend. | -
| role_allow_update = True | -(BoolOpt) Allow role update in LDAP backend. | -
| role_attribute_ignore = | -(ListOpt) List of attributes stripped off the role on update. | -
| role_filter = None | -(StrOpt) LDAP search filter for roles. | -
| role_id_attribute = cn | -(StrOpt) LDAP attribute mapped to role id. | -
| role_member_attribute = roleOccupant | -(StrOpt) LDAP attribute mapped to role membership. | -
| role_name_attribute = ou | -(StrOpt) LDAP attribute mapped to role name. | -
| role_objectclass = organizationalRole | -(StrOpt) LDAP objectClass for roles. | -
| role_tree_dn = None | -(StrOpt) Search base for roles. | -
| suffix = cn=example,cn=com | -(StrOpt) LDAP server suffix | -
| tenant_additional_attribute_mapping = | -(ListOpt) Additional attribute mappings for projects. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. | -
| tenant_allow_create = True | -(BoolOpt) Allow tenant creation in LDAP backend. | -
| tenant_allow_delete = True | -(BoolOpt) Allow tenant deletion in LDAP backend. | -
| tenant_allow_update = True | -(BoolOpt) Allow tenant update in LDAP backend. | -
| tenant_attribute_ignore = | -(ListOpt) List of attributes stripped off the project on update. | -
| tenant_desc_attribute = description | -(StrOpt) LDAP attribute mapped to project description. | -
| tenant_domain_id_attribute = businessCategory | -(StrOpt) LDAP attribute mapped to project domain_id. | -
| tenant_enabled_attribute = enabled | -(StrOpt) LDAP attribute mapped to project enabled. | -
| tenant_enabled_emulation = False | -(BoolOpt) If True, Keystone uses an alternative method to determine if a project is enabled or not by checking if they are a member of the "tenant_enabled_emulation_dn" group. | -
| tenant_enabled_emulation_dn = None | -(StrOpt) DN of the group entry to hold enabled projects when using enabled emulation. | -
| tenant_filter = None | -(StrOpt) LDAP search filter for projects. | -
| tenant_id_attribute = cn | -(StrOpt) LDAP attribute mapped to project id. | -
| tenant_member_attribute = member | -(StrOpt) LDAP attribute mapped to project membership for user. | -
| tenant_name_attribute = ou | -(StrOpt) LDAP attribute mapped to project name. | -
| tenant_objectclass = groupOfNames | -(StrOpt) LDAP objectClass for projects. | -
| tenant_tree_dn = None | -(StrOpt) Search base for projects | -
| tls_cacertdir = None | -(StrOpt) CA certificate directory path for communicating with LDAP servers. | -
| tls_cacertfile = None | -(StrOpt) CA certificate file path for communicating with LDAP servers. | -
| tls_req_cert = demand | -(StrOpt) valid options for tls_req_cert are demand, never, and allow. | -
| url = ldap://localhost | -(StrOpt) URL for connecting to the LDAP server. | -
| use_dumb_member = False | -(BoolOpt) If true, will add a dummy member to groups. This is required if the objectclass for groups requires the "member" attribute. | -
| use_tls = False | -(BoolOpt) Enable TLS for communicating with LDAP servers. | -
| user = None | -(StrOpt) User BindDN to query the LDAP server. | -
| user_additional_attribute_mapping = | -(ListOpt) List of additional LDAP attributes used for mapping Additional attribute mappings for users. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. | -
| user_allow_create = True | -(BoolOpt) Allow user creation in LDAP backend. | -
| user_allow_delete = True | -(BoolOpt) Allow user deletion in LDAP backend. | -
| user_allow_update = True | -(BoolOpt) Allow user updates in LDAP backend. | -
| user_attribute_ignore = default_project_id, tenants | -(ListOpt) List of attributes stripped off the user on update. | -
| user_default_project_id_attribute = None | -(StrOpt) LDAP attribute mapped to default_project_id for users. | -
| user_enabled_attribute = enabled | -(StrOpt) LDAP attribute mapped to user enabled flag. | -
| user_enabled_default = True | -(StrOpt) Default value to enable users. This should match an appropriate int value if the LDAP server uses non-boolean (bitmask) values to indicate if a user is enabled or disabled. If this is not set to "True"the typical value is "512". This is typically used when "user_enabled_attribute = userAccountControl". | -
| user_enabled_emulation = False | -(BoolOpt) If True, Keystone uses an alternative method to determine if a user is enabled or not by checking if they are a member of the "user_enabled_emulation_dn" group. | -
| user_enabled_emulation_dn = None | -(StrOpt) DN of the group entry to hold enabled users when using enabled emulation. | -
| user_enabled_mask = 0 | -(IntOpt) Bitmask integer to indicate the bit that the enabled value is stored in if the LDAP server represents "enabled" as a bit on an integer rather than a boolean. A value of "0" indicates the mask is not used. If this is not set to "0" the typical value is "2". This is typically used when "user_enabled_attribute = userAccountControl". | -
| user_filter = None | -(StrOpt) LDAP search filter for users. | -
| user_id_attribute = cn | -(StrOpt) LDAP attribute mapped to user id. | -
| user_mail_attribute = email | -(StrOpt) LDAP attribute mapped to user email. | -
| user_name_attribute = sn | -(StrOpt) LDAP attribute mapped to user name. | -
| user_objectclass = inetOrgPerson | -(StrOpt) LDAP objectClass for users. | -
| user_pass_attribute = userPassword | -(StrOpt) LDAP attribute mapped to password. | -
| user_tree_dn = None | -(StrOpt) Search base for users. | -
| Configuration option = Default value | +Description | +
|---|---|
| [ldap] | +|
| alias_dereferencing = default | +(StrOpt) The LDAP dereferencing option for queries. This can be either "never", "searching", "always", "finding" or "default". The "default" option falls back to using default dereferencing configured by your ldap.conf. | +
| allow_subtree_delete = False | +(BoolOpt) Delete subtrees using the subtree delete control. Only enable this option if your LDAP server supports subtree deletion. | +
| chase_referrals = None | +(BoolOpt) Override the system's default referral chasing behavior for queries. | +
| debug_level = None | +(IntOpt) Sets the LDAP debugging level for LDAP calls. A value of 0 means that debugging is not enabled. This value is a bitmask, consult your LDAP documentation for possible values. | +
| dumb_member = cn=dumb,dc=nonexistent | +(StrOpt) DN of the "dummy member" to use when "use_dumb_member" is enabled. | +
| group_additional_attribute_mapping = | +(ListOpt) Additional attribute mappings for groups. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. | +
| group_allow_create = True | +(BoolOpt) Allow group creation in LDAP backend. | +
| group_allow_delete = True | +(BoolOpt) Allow group deletion in LDAP backend. | +
| group_allow_update = True | +(BoolOpt) Allow group update in LDAP backend. | +
| group_attribute_ignore = | +(ListOpt) List of attributes stripped off the group on update. | +
| group_desc_attribute = description | +(StrOpt) LDAP attribute mapped to group description. | +
| group_filter = None | +(StrOpt) LDAP search filter for groups. | +
| group_id_attribute = cn | +(StrOpt) LDAP attribute mapped to group id. | +
| group_member_attribute = member | +(StrOpt) LDAP attribute mapped to show group membership. | +
| group_name_attribute = ou | +(StrOpt) LDAP attribute mapped to group name. | +
| group_objectclass = groupOfNames | +(StrOpt) LDAP objectclass for groups. | +
| group_tree_dn = None | +(StrOpt) Search base for groups. | +
| page_size = 0 | +(IntOpt) Maximum results per page; a value of zero ("0") disables paging. | +
| password = None | +(StrOpt) Password for the BindDN to query the LDAP server. | +
| project_additional_attribute_mapping = | +(ListOpt) Additional attribute mappings for projects. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. | +
| project_allow_create = True | +(BoolOpt) Allow project creation in LDAP backend. | +
| project_allow_delete = True | +(BoolOpt) Allow project deletion in LDAP backend. | +
| project_allow_update = True | +(BoolOpt) Allow project update in LDAP backend. | +
| project_attribute_ignore = | +(ListOpt) List of attributes stripped off the project on update. | +
| project_desc_attribute = description | +(StrOpt) LDAP attribute mapped to project description. | +
| project_domain_id_attribute = businessCategory | +(StrOpt) LDAP attribute mapped to project domain_id. | +
| project_enabled_attribute = enabled | +(StrOpt) LDAP attribute mapped to project enabled. | +
| project_enabled_emulation = False | +(BoolOpt) If true, Keystone uses an alternative method to determine if a project is enabled or not by checking if they are a member of the "project_enabled_emulation_dn" group. | +
| project_enabled_emulation_dn = None | +(StrOpt) DN of the group entry to hold enabled projects when using enabled emulation. | +
| project_filter = None | +(StrOpt) LDAP search filter for projects. | +
| project_id_attribute = cn | +(StrOpt) LDAP attribute mapped to project id. | +
| project_member_attribute = member | +(StrOpt) LDAP attribute mapped to project membership for user. | +
| project_name_attribute = ou | +(StrOpt) LDAP attribute mapped to project name. | +
| project_objectclass = groupOfNames | +(StrOpt) LDAP objectclass for projects. | +
| project_tree_dn = None | +(StrOpt) Search base for projects | +
| query_scope = one | +(StrOpt) The LDAP scope for queries, this can be either "one" (onelevel/singleLevel) or "sub" (subtree/wholeSubtree). | +
| role_additional_attribute_mapping = | +(ListOpt) Additional attribute mappings for roles. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. | +
| role_allow_create = True | +(BoolOpt) Allow role creation in LDAP backend. | +
| role_allow_delete = True | +(BoolOpt) Allow role deletion in LDAP backend. | +
| role_allow_update = True | +(BoolOpt) Allow role update in LDAP backend. | +
| role_attribute_ignore = | +(ListOpt) List of attributes stripped off the role on update. | +
| role_filter = None | +(StrOpt) LDAP search filter for roles. | +
| role_id_attribute = cn | +(StrOpt) LDAP attribute mapped to role id. | +
| role_member_attribute = roleOccupant | +(StrOpt) LDAP attribute mapped to role membership. | +
| role_name_attribute = ou | +(StrOpt) LDAP attribute mapped to role name. | +
| role_objectclass = organizationalRole | +(StrOpt) LDAP objectclass for roles. | +
| role_tree_dn = None | +(StrOpt) Search base for roles. | +
| suffix = cn=example,cn=com | +(StrOpt) LDAP server suffix | +
| tls_cacertdir = None | +(StrOpt) CA certificate directory path for communicating with LDAP servers. | +
| tls_cacertfile = None | +(StrOpt) CA certificate file path for communicating with LDAP servers. | +
| tls_req_cert = demand | +(StrOpt) Valid options for tls_req_cert are demand, never, and allow. | +
| url = ldap://localhost | +(StrOpt) URL for connecting to the LDAP server. | +
| use_dumb_member = False | +(BoolOpt) If true, will add a dummy member to groups. This is required if the objectclass for groups requires the "member" attribute. | +
| use_tls = False | +(BoolOpt) Enable TLS for communicating with LDAP servers. | +
| user = None | +(StrOpt) User BindDN to query the LDAP server. | +
| user_additional_attribute_mapping = | +(ListOpt) List of additional LDAP attributes used for mapping additional attribute mappings for users. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. | +
| user_allow_create = True | +(BoolOpt) Allow user creation in LDAP backend. | +
| user_allow_delete = True | +(BoolOpt) Allow user deletion in LDAP backend. | +
| user_allow_update = True | +(BoolOpt) Allow user updates in LDAP backend. | +
| user_attribute_ignore = default_project_id, tenants | +(ListOpt) List of attributes stripped off the user on update. | +
| user_default_project_id_attribute = None | +(StrOpt) LDAP attribute mapped to default_project_id for users. | +
| user_enabled_attribute = enabled | +(StrOpt) LDAP attribute mapped to user enabled flag. | +
| user_enabled_default = True | +(StrOpt) Default value to enable users. This should match an appropriate int value if the LDAP server uses non-boolean (bitmask) values to indicate if a user is enabled or disabled. If this is not set to "True" the typical value is "512". This is typically used when "user_enabled_attribute = userAccountControl". | +
| user_enabled_emulation = False | +(BoolOpt) If true, Keystone uses an alternative method to determine if a user is enabled or not by checking if they are a member of the "user_enabled_emulation_dn" group. | +
| user_enabled_emulation_dn = None | +(StrOpt) DN of the group entry to hold enabled users when using enabled emulation. | +
| user_enabled_mask = 0 | +(IntOpt) Bitmask integer to indicate the bit that the enabled value is stored in if the LDAP server represents "enabled" as a bit on an integer rather than a boolean. A value of "0" indicates the mask is not used. If this is not set to "0" the typical value is "2". This is typically used when "user_enabled_attribute = userAccountControl". | +
| user_filter = None | +(StrOpt) LDAP search filter for users. | +
| user_id_attribute = cn | +(StrOpt) LDAP attribute mapped to user id. | +
| user_mail_attribute = email | +(StrOpt) LDAP attribute mapped to user email. | +
| user_name_attribute = sn | +(StrOpt) LDAP attribute mapped to user name. | +
| user_objectclass = inetOrgPerson | +(StrOpt) LDAP objectclass for users. | +
| user_pass_attribute = userPassword | +(StrOpt) LDAP attribute mapped to password. | +
| user_tree_dn = None | +(StrOpt) Search base for users. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN | -(ListOpt) List of logger=LEVEL pairs | -
| instance_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance is passed with the log message, format it like this | -
| instance_uuid_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance UUID is passed with the log message, format it like this | -
| log_config_append = None | -(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files. | -
| log_date_format = %Y-%m-%d %H:%M:%S | -(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s | -
| log_dir = None | -(StrOpt) (Optional) The base directory used for relative --log-file paths | -
| log_file = None | -(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | -
| log_format = None | -(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | -
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | -(StrOpt) Format string to use for log messages with context | -
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | -(StrOpt) Data to append to log format when level is DEBUG | -
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | -(StrOpt) Format string to use for log messages without context | -
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -(StrOpt) Prefix each line of exception output with this format | -
| syslog_log_facility = LOG_USER | -(StrOpt) Syslog facility to receive log lines | -
| use_stderr = True | -(BoolOpt) Log output to standard error | -
| use_syslog = False | -(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424 | -
| use_syslog_rfc_format = False | -(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J. | -
| verbose = False | -(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| 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 | +(ListOpt) List of logger=LEVEL pairs. | +
| instance_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance that is passed with the log message. | +
| instance_uuid_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance UUID that is passed with the log message. | +
| log_config_append = None | +(StrOpt) 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. | +
| log_date_format = %Y-%m-%d %H:%M:%S | +(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . | +
| log_dir = None | +(StrOpt) (Optional) The base directory used for relative --log-file paths. | +
| log_file = None | +(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | +
| log_format = None | +(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | +
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages with context. | +
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | +(StrOpt) Data to append to log format when level is DEBUG. | +
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages without context. | +
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | +(StrOpt) Prefix each line of exception output with this format. | +
| syslog_log_facility = LOG_USER | +(StrOpt) Syslog facility to receive log lines. | +
| use_stderr = True | +(BoolOpt) Log output to standard error. | +
| use_syslog = False | +(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will chang in J to honor RFC5424. | +
| use_syslog_rfc_format = False | +(BoolOpt) (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 I, and will be removed in J. | +
| verbose = False | +(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | +
| Configuration option = Default value | -Description | -
|---|---|
| [memcache] | -|
| max_compare_and_set_retry = 16 | -(IntOpt) Number of compare-and-set attempts to make when using compare-and-set in the token memcache back end. | -
| servers = localhost:11211 | -(ListOpt) Memcache servers in the format of "host:port" | -
| Configuration option = Default value | +Description | +
|---|---|
| [memcache] | +|
| max_compare_and_set_retry = 16 | +(IntOpt) Number of compare-and-set attempts to make when using compare-and-set in the token memcache back end. | +
| servers = localhost:11211 | +(ListOpt) Memcache servers in the format of "host:port". | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| lock_path = None | -(StrOpt) Directory to use for lock files. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| lock_path = None | +(StrOpt) Directory to use for lock files. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| onready = None | -(StrOpt) onready allows you to send a notification when the process is ready to serve For example, to have it notify using systemd, one could set shell command: "onready = systemd-notify --ready" or a module with notify() method: "onready = keystone.common.systemd". | -
| Configuration option = Default value | -Description | -
|---|---|
| [oauth1] | -|
| access_token_duration = 86400 | -(IntOpt) Duration (in seconds) for the OAuth Access Token. | -
| driver = keystone.contrib.oauth1.backends.sql.OAuth1 | -(StrOpt) Keystone Credential backend driver. | -
| request_token_duration = 28800 | -(IntOpt) Duration (in seconds) for the OAuth Request Token. | -
| Configuration option = Default value | +Description | +
|---|---|
| [oauth1] | +|
| access_token_duration = 86400 | +(IntOpt) Duration (in seconds) for the OAuth Access Token. | +
| driver = keystone.contrib.oauth1.backends.sql.OAuth1 | +(StrOpt) Credential backend driver. | +
| request_token_duration = 28800 | +(IntOpt) Duration (in seconds) for the OAuth Request Token. | +
| Configuration option = Default value | -Description | -
|---|---|
| [os_inherit] | -|
| enabled = False | -(BoolOpt) role-assignment inheritance to projects from owning domain can be optionally enabled. | -
| Configuration option = Default value | +Description | +
|---|---|
| [os_inherit] | +|
| enabled = False | +(BoolOpt) role-assignment inheritance to projects from owning domain can be optionally enabled. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| policy_default_rule = default | -(StrOpt) Rule enforced when requested rule is not found | -
| policy_file = policy.json | -(StrOpt) JSON file containing policy | -
| [policy] | -|
| driver = keystone.policy.backends.sql.Policy | -(StrOpt) Keystone Policy backend driver. | -
| list_limit = None | -(IntOpt) Maximum number of entities that will be returned in a policy collection. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| policy_default_rule = default | +(StrOpt) Default rule. Enforced when a requested rule is not found. | +
| policy_file = policy.json | +(StrOpt) The JSON file that defines policies. | +
| [policy] | +|
| driver = keystone.policy.backends.sql.Policy | +(StrOpt) Policy backend driver. | +
| list_limit = None | +(IntOpt) Maximum number of entities that will be returned in a policy collection. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| qpid_heartbeat = 60 | -(IntOpt) Seconds between connection keepalive heartbeats. | -
| qpid_hostname = localhost | -(StrOpt) Qpid broker hostname. | -
| qpid_hosts = $qpid_hostname:$qpid_port | -(ListOpt) Qpid HA cluster host:port pairs. | -
| qpid_password = | -(StrOpt) Password for Qpid connection. | -
| qpid_port = 5672 | -(IntOpt) Qpid broker port. | -
| qpid_protocol = tcp | -(StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| qpid_sasl_mechanisms = | -(StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| qpid_tcp_nodelay = True | -(BoolOpt) Whether to disable the Nagle algorithm. | -
| qpid_topology_version = 1 | -(IntOpt) 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. | -
| qpid_username = | -(StrOpt) Username for Qpid connection. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| qpid_heartbeat = 60 | +(IntOpt) Seconds between connection keepalive heartbeats. | +
| qpid_hostname = localhost | +(StrOpt) Qpid broker hostname. | +
| qpid_hosts = $qpid_hostname:$qpid_port | +(ListOpt) Qpid HA cluster host:port pairs. | +
| qpid_password = | +(StrOpt) Password for Qpid connection. | +
| qpid_port = 5672 | +(IntOpt) Qpid broker port. | +
| qpid_protocol = tcp | +(StrOpt) Transport to use, either 'tcp' or 'ssl'. | +
| qpid_sasl_mechanisms = | +(StrOpt) Space separated list of SASL mechanisms to use for auth. | +
| qpid_tcp_nodelay = True | +(BoolOpt) Whether to disable the Nagle algorithm. | +
| qpid_topology_version = 1 | +(IntOpt) 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. | +
| qpid_username = | +(StrOpt) Username for Qpid connection. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| fake_rabbit = False | -(BoolOpt) If passed, use a fake RabbitMQ provider. | -
| kombu_reconnect_delay = 1.0 | -(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| kombu_ssl_ca_certs = | -(StrOpt) SSL certification authority file (valid only if SSL enabled). | -
| kombu_ssl_certfile = | -(StrOpt) SSL cert file (valid only if SSL enabled). | -
| kombu_ssl_keyfile = | -(StrOpt) SSL key file (valid only if SSL enabled). | -
| kombu_ssl_version = | -(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions. | -
| rabbit_ha_queues = False | -(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| rabbit_host = localhost | -(StrOpt) The RabbitMQ broker address where a single node is used. | -
| rabbit_hosts = $rabbit_host:$rabbit_port | -(ListOpt) RabbitMQ HA cluster host:port pairs. | -
| rabbit_login_method = AMQPLAIN | -(StrOpt) the RabbitMQ login method | -
| rabbit_max_retries = 0 | -(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| rabbit_password = guest | -(StrOpt) The RabbitMQ password. | -
| rabbit_port = 5672 | -(IntOpt) The RabbitMQ broker port where a single node is used. | -
| rabbit_retry_backoff = 2 | -(IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| rabbit_retry_interval = 1 | -(IntOpt) How frequently to retry connecting with RabbitMQ. | -
| rabbit_use_ssl = False | -(BoolOpt) Connect over SSL for RabbitMQ. | -
| rabbit_userid = guest | -(StrOpt) The RabbitMQ userid. | -
| rabbit_virtual_host = / | -(StrOpt) The RabbitMQ virtual host. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| fake_rabbit = False | +(BoolOpt) If passed, use a fake RabbitMQ provider | +
| kombu_reconnect_delay = 1.0 | +(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | +
| kombu_ssl_ca_certs = | +(StrOpt) SSL certification authority file (valid only if SSL enabled). | +
| kombu_ssl_certfile = | +(StrOpt) SSL cert file (valid only if SSL enabled). | +
| kombu_ssl_keyfile = | +(StrOpt) SSL key file (valid only if SSL enabled). | +
| kombu_ssl_version = | +(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions. | +
| rabbit_ha_queues = False | +(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | +
| rabbit_host = localhost | +(StrOpt) The RabbitMQ broker address where a single node is used. | +
| rabbit_hosts = $rabbit_host:$rabbit_port | +(ListOpt) RabbitMQ HA cluster host:port pairs. | +
| rabbit_login_method = AMQPLAIN | +(StrOpt) the RabbitMQ login method | +
| rabbit_max_retries = 0 | +(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | +
| rabbit_password = guest | +(StrOpt) The RabbitMQ password. | +
| rabbit_port = 5672 | +(IntOpt) The RabbitMQ broker port where a single node is used. | +
| rabbit_retry_backoff = 2 | +(IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | +
| rabbit_retry_interval = 1 | +(IntOpt) How frequently to retry connecting with RabbitMQ. | +
| rabbit_use_ssl = False | +(BoolOpt) Connect over SSL for RabbitMQ. | +
| rabbit_userid = guest | +(StrOpt) The RabbitMQ userid. | +
| rabbit_virtual_host = / | +(StrOpt) The RabbitMQ virtual host. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| host = 127.0.0.1 | -(StrOpt) Host to locate redis. | -
| matchmaker_heartbeat_freq = 300 | -(IntOpt) Heartbeat frequency. | -
| matchmaker_heartbeat_ttl = 600 | -(IntOpt) Heartbeat time-to-live. | -
| password = None | -(StrOpt) Password for Redis server (optional). | -
| port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| [matchmaker_ring] | -|
| ringfile = /etc/oslo/matchmaker_ring.json | -(StrOpt) Matchmaker ring file (JSON). | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| host = 127.0.0.1 | +(StrOpt) Host to locate redis. | +
| matchmaker_heartbeat_freq = 300 | +(IntOpt) Heartbeat frequency. | +
| matchmaker_heartbeat_ttl = 600 | +(IntOpt) Heartbeat time-to-live. | +
| password = None | +(StrOpt) Password for Redis server (optional). | +
| port = 6379 | +(IntOpt) Use this port to connect to redis host. | +
| [matchmaker_ring] | +|
| ringfile = /etc/oslo/matchmaker_ring.json | +(StrOpt) Matchmaker ring file (JSON). | +
| Configuration option = Default value | -Description | -
|---|---|
| [revoke] | -|
| caching = True | -(BoolOpt) Toggle for revocation event cacheing. This has no effect unless global caching is enabled. | -
| driver = keystone.contrib.revoke.backends.kvs.Revoke | -(StrOpt) An implementation of the backend for persisting revocation events. | -
| expiration_buffer = 1800 | -(IntOpt) This value (calculated in seconds) is added to token expiration before a revocation event may be removed from the backend. | -
| Configuration option = Default value | +Description | +
|---|---|
| [revoke] | +|
| caching = True | +(BoolOpt) Toggle for revocation event cacheing. This has no effect unless global caching is enabled. | +
| driver = keystone.contrib.revoke.backends.kvs.Revoke | +(StrOpt) An implementation of the backend for persisting revocation events. | +
| expiration_buffer = 1800 | +(IntOpt) This value (calculated in seconds) is added to token expiration before a revocation event may be removed from the backend. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions | -(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| allowed_rpc_exception_modules = keystone.openstack.common.exception, nova.exception, cinder.exception, exceptions | +(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| crypt_strength = 40000 | -(IntOpt) The value passed as the keyword "rounds" to passlib encrypt method. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| crypt_strength = 40000 | +(IntOpt) The value passed as the keyword "rounds" to passlib's encrypt method. | +
| Configuration option = Default value | -Description | -
|---|---|
| [signing] | -|
| ca_certs = /etc/keystone/ssl/certs/ca.pem | -(StrOpt) Path of the CA for token signing. | -
| ca_key = /etc/keystone/ssl/private/cakey.pem | -(StrOpt) Path of the CA Key for token signing. | -
| cert_subject = /C=US/ST=Unset/L=Unset/O=Unset/CN=www.example.com | -(StrOpt) Certificate Subject (auto generated certificate) for token signing. | -
| certfile = /etc/keystone/ssl/certs/signing_cert.pem | -(StrOpt) Path of the certfile for token signing. | -
| key_size = 2048 | -(IntOpt) Key Size (in bits) for token signing cert (auto generated certificate). | -
| keyfile = /etc/keystone/ssl/private/signing_key.pem | -(StrOpt) Path of the keyfile for token signing. | -
| token_format = None | -(StrOpt) Deprecated in favor of provider in the [token] section. | -
| valid_days = 3650 | -(IntOpt) Day the token signing cert is valid for (auto generated certificate). | -
| [ssl] | -|
| ca_certs = /etc/keystone/ssl/certs/ca.pem | -(StrOpt) Path of the ca cert file for SSL. | -
| ca_key = /etc/keystone/ssl/private/cakey.pem | -(StrOpt) Path of the CA key file for SSL. | -
| cert_required = False | -(BoolOpt) Require client certificate. | -
| cert_subject = /C=US/ST=Unset/L=Unset/O=Unset/CN=localhost | -(StrOpt) SSL Certificate Subject (auto generated certificate). | -
| certfile = /etc/keystone/ssl/certs/keystone.pem | -(StrOpt) Path of the certfile for SSL. | -
| enable = False | -(BoolOpt) Toggle for SSL support on the keystone eventlet servers. | -
| key_size = 1024 | -(IntOpt) SSL Key Length (in bits) (auto generated certificate). | -
| keyfile = /etc/keystone/ssl/private/keystonekey.pem | -(StrOpt) Path of the keyfile for SSL. | -
| valid_days = 3650 | -(IntOpt) Days the certificate is valid for once signed (auto generated certificate). | -
| Configuration option = Default value | +Description | +
|---|---|
| [signing] | +|
| ca_certs = /etc/keystone/ssl/certs/ca.pem | +(StrOpt) Path of the CA for token signing. | +
| ca_key = /etc/keystone/ssl/private/cakey.pem | +(StrOpt) Path of the CA key for token signing. | +
| cert_subject = /C=US/ST=Unset/L=Unset/O=Unset/CN=www.example.com | +(StrOpt) Certificate subject (auto generated certificate) for token signing. | +
| certfile = /etc/keystone/ssl/certs/signing_cert.pem | +(StrOpt) Path of the certfile for token signing. For non-production environments, you may be interested in using `keystone-manage pki_setup` to generate self-signed certificates. | +
| key_size = 2048 | +(IntOpt) Key size (in bits) for token signing cert (auto generated certificate). | +
| keyfile = /etc/keystone/ssl/private/signing_key.pem | +(StrOpt) Path of the keyfile for token signing. | +
| token_format = None | +(StrOpt) Deprecated in favor of provider in the [token] section. | +
| valid_days = 3650 | +(IntOpt) Days the token signing cert is valid for (auto generated certificate). | +
| [ssl] | +|
| ca_certs = /etc/keystone/ssl/certs/ca.pem | +(StrOpt) Path of the ca cert file for SSL. | +
| ca_key = /etc/keystone/ssl/private/cakey.pem | +(StrOpt) Path of the CA key file for SSL. | +
| cert_required = False | +(BoolOpt) Require client certificate. | +
| cert_subject = /C=US/ST=Unset/L=Unset/O=Unset/CN=localhost | +(StrOpt) SSL certificate subject (auto generated certificate). | +
| certfile = /etc/keystone/ssl/certs/keystone.pem | +(StrOpt) Path of the certfile for SSL. For non-production environments, you may be interested in using `keystone-manage ssl_setup` to generate self-signed certificates. | +
| enable = False | +(BoolOpt) Toggle for SSL support on the Keystone eventlet servers. | +
| key_size = 1024 | +(IntOpt) SSL key length (in bits) (auto generated certificate). | +
| keyfile = /etc/keystone/ssl/private/keystonekey.pem | +(StrOpt) Path of the keyfile for SSL. | +
| valid_days = 3650 | +(IntOpt) Days the certificate is valid for once signed (auto generated certificate). | +
| Configuration option = Default value | -Description | -
|---|---|
| [stats] | -|
| driver = keystone.contrib.stats.backends.kvs.Stats | -(StrOpt) Keystone stats backend driver. | -
| Configuration option = Default value | +Description | +
|---|---|
| [stats] | +|
| driver = keystone.contrib.stats.backends.kvs.Stats | +(StrOpt) Stats backend driver. | +
| Configuration option = Default value | -Description | -
|---|---|
| [token] | -|
| bind = | -(ListOpt) External auth mechanisms that should add bind information to token e.g. kerberos, x509. | -
| cache_time = None | -(IntOpt) Time to cache tokens (in seconds). This has no effect unless global and token caching are enabled. | -
| caching = True | -(BoolOpt) Toggle for token system cacheing. This has no effect unless global caching is enabled. | -
| driver = keystone.token.backends.sql.Token | -(StrOpt) Keystone Token persistence backend driver. | -
| enforce_token_bind = permissive | -(StrOpt) Enforcement policy on tokens presented to keystone with bind information. One of disabled, permissive, strict, required or a specifically required bind mode e.g. kerberos or x509 to require binding to that authentication. | -
| expiration = 3600 | -(IntOpt) Amount of time a token should remain valid (in seconds). | -
| provider = None | -(StrOpt) Controls the token construction, validation, and revocation operations. Core providers are "keystone.token.providers.[pki|uuid].Provider". | -
| revocation_cache_time = 3600 | -(IntOpt) Time to cache the revocation list and the revocation events if revoke extension is enabled (in seconds). This has no effect unless global and token caching are enabled. | -
| revoke_by_id = True | -(BoolOpt) Revoke token by token identifier. Setting revoke_by_id to True enables various forms of enumerating tokens, e.g. `list tokens for user`. These enumerations are processed to determine the list of tokens to revoke. Only disable if you are switching to using the Revoke extension with a backend other than KVS, which stores events in memory. | -
| Configuration option = Default value | +Description | +
|---|---|
| [token] | +|
| bind = | +(ListOpt) External auth mechanisms that should add bind information to token, e.g., kerberos,x509. | +
| cache_time = None | +(IntOpt) Time to cache tokens (in seconds). This has no effect unless global and token caching are enabled. | +
| caching = True | +(BoolOpt) Toggle for token system cacheing. This has no effect unless global caching is enabled. | +
| driver = keystone.token.backends.sql.Token | +(StrOpt) Token persistence backend driver. | +
| enforce_token_bind = permissive | +(StrOpt) Enforcement policy on tokens presented to Keystone with bind information. One of disabled, permissive, strict, required or a specifically required bind mode, e.g., kerberos or x509 to require binding to that authentication. | +
| expiration = 3600 | +(IntOpt) Amount of time a token should remain valid (in seconds). | +
| hash_algorithm = md5 | +(StrOpt) The hash algorithm to use for PKI tokens. This can be set to any algorithm that hashlib supports. WARNING: Before changing this value, the auth_token middleware must be configured with the hash_algorithms, otherwise token revocation will not be processed correctly. | +
| provider = None | +(StrOpt) Controls the token construction, validation, and revocation operations. Core providers are "keystone.token.providers.[pkiz|pki|uuid].Provider". The default provider is pkiz. | +
| revocation_cache_time = 3600 | +(IntOpt) Time to cache the revocation list and the revocation events if revoke extension is enabled (in seconds). This has no effect unless global and token caching are enabled. | +
| revoke_by_id = True | +(BoolOpt) Revoke token by token identifier. Setting revoke_by_id to true enables various forms of enumerating tokens, e.g. `list tokens for user`. These enumerations are processed to determine the list of tokens to revoke. Only disable if you are switching to using the Revoke extension with a backend other than KVS, which stores events in memory. | +
| Configuration option = Default value | -Description | -
|---|---|
| [trust] | -|
| driver = keystone.trust.backends.sql.Trust | -(StrOpt) Keystone Trust backend driver. | -
| enabled = True | -(BoolOpt) delegation and impersonation features can be optionally disabled. | -
| Configuration option = Default value | +Description | +
|---|---|
| [trust] | +|
| driver = keystone.trust.backends.sql.Trust | +(StrOpt) Trust backend driver. | +
| enabled = True | +(BoolOpt) Delegation and impersonation features can be optionally disabled. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| rpc_zmq_bind_address = * | -(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| rpc_zmq_contexts = 1 | -(IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| rpc_zmq_host = oslo | -(StrOpt) 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 | -(StrOpt) Directory for holding IPC sockets. | -
| rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost | -(StrOpt) MatchMaker driver. | -
| rpc_zmq_port = 9501 | -(IntOpt) ZeroMQ receiver listening port. | -
| rpc_zmq_topic_backlog = None | -(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| rpc_zmq_bind_address = * | +(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | +
| rpc_zmq_contexts = 1 | +(IntOpt) Number of ZeroMQ contexts, defaults to 1. | +
| rpc_zmq_host = oslo | +(StrOpt) 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 | +(StrOpt) Directory for holding IPC sockets. | +
| rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost | +(StrOpt) MatchMaker driver. | +
| rpc_zmq_port = 9501 | +(IntOpt) ZeroMQ receiver listening port. | +
| rpc_zmq_topic_backlog = None | +(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| external_pids = $state_path/external/pids | -(StrOpt) Location to store child pid files | -
| network_device_mtu = None | -(IntOpt) MTU setting for device. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| external_pids = $state_path/external/pids | +(StrOpt) Location to store child pid files | +
| network_device_mtu = None | +(IntOpt) MTU setting for device. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| allow_bulk = True | -(BoolOpt) Allow the usage of the bulk API | -
| allow_pagination = False | -(BoolOpt) Allow the usage of the pagination | -
| allow_sorting = False | -(BoolOpt) Allow the usage of the sorting | -
| api_extensions_path = | -(StrOpt) The path for API extensions | -
| api_paste_config = api-paste.ini | -(StrOpt) The API paste config file to use | -
| max_header_line = 16384 | -(IntOpt) Max header line to accommodate large tokens | -
| max_request_body_size = 114688 | -(IntOpt) the maximum body size per each request(bytes) | -
| pagination_max_limit = -1 | -(StrOpt) The maximum number of items returned in a single response, value was 'infinite' or negative integer means no limit | -
| run_external_periodic_tasks = True | -(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here? | -
| service_plugins = | -(ListOpt) The service plugins Neutron will use | -
| [service_providers] | -|
| service_provider = [] | -(MultiStrOpt) Defines providers for advanced services using the format: <service_type>:<name>:<driver>[:default] | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| allow_bulk = True | +(BoolOpt) Allow the usage of the bulk API | +
| allow_pagination = False | +(BoolOpt) Allow the usage of the pagination | +
| allow_sorting = False | +(BoolOpt) Allow the usage of the sorting | +
| api_extensions_path = | +(StrOpt) The path for API extensions | +
| api_paste_config = api-paste.ini | +(StrOpt) The API paste config file to use | +
| max_header_line = 16384 | +(IntOpt) Max header line to accommodate large tokens | +
| max_request_body_size = 114688 | +(IntOpt) the maximum body size per each request(bytes) | +
| pagination_max_limit = -1 | +(StrOpt) The maximum number of items returned in a single response, value was 'infinite' or negative integer means no limit | +
| run_external_periodic_tasks = True | +(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here? | +
| service_plugins = | +(ListOpt) The service plugins Neutron will use | +
| [service_providers] | +|
| service_provider = [] | +(MultiStrOpt) Defines providers for advanced services using the format: <service_type>:<name>:<driver>[:default] | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| memcached_servers = None | -(ListOpt) Memcached servers or None for in process cache. | -
| [keystone_authtoken] | -|
| admin_password = None | -(StrOpt) Keystone account password | -
| admin_tenant_name = admin | -(StrOpt) Keystone service account tenant name to validate user tokens | -
| admin_token = None | -(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. | -
| admin_user = None | -(StrOpt) Keystone account username | -
| auth_admin_prefix = | -(StrOpt) Prefix to prepend at the beginning of the path | -
| auth_host = 127.0.0.1 | -(StrOpt) Host providing the admin Identity API endpoint | -
| auth_port = 35357 | -(IntOpt) Port of the admin Identity API endpoint | -
| auth_protocol = https | -(StrOpt) Protocol of the admin Identity API endpoint(http or https) | -
| auth_uri = None | -(StrOpt) Complete public Identity API endpoint | -
| auth_version = None | -(StrOpt) API version of the admin Identity API endpoint | -
| cache = None | -(StrOpt) Env key for the swift cache | -
| cafile = None | -(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| certfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| delay_auth_decision = False | -(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | -
| enforce_token_bind = permissive | -(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| http_connect_timeout = None | -(BoolOpt) Request timeout value for communicating with Identity API server. | -
| http_request_max_retries = 3 | -(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| include_service_catalog = True | -(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| insecure = False | -(BoolOpt) Verify HTTPS connections. | -
| keyfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| memcache_secret_key = None | -(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | -
| memcache_security_strategy = None | -(StrOpt) (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. | -
| memcached_servers = None | -(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| revocation_cache_time = 300 | -(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| signing_dir = None | -(StrOpt) Directory used to cache files related to PKI tokens | -
| token_cache_time = 300 | -(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| memcached_servers = None | +(ListOpt) Memcached servers or None for in process cache. | +
| [keystone_authtoken] | +|
| admin_password = None | +(StrOpt) Keystone account password | +
| admin_tenant_name = admin | +(StrOpt) Keystone service account tenant name to validate user tokens | +
| admin_token = None | +(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | +
| admin_user = None | +(StrOpt) Keystone account username | +
| auth_admin_prefix = | +(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | +
| auth_host = 127.0.0.1 | +(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_port = 35357 | +(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_protocol = https | +(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | +
| auth_uri = None | +(StrOpt) Complete public Identity API endpoint | +
| auth_version = None | +(StrOpt) API version of the admin Identity API endpoint | +
| cache = None | +(StrOpt) Env key for the swift cache | +
| cafile = None | +(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | +
| certfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| check_revocations_for_cached = False | +(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server. | +
| delay_auth_decision = False | +(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | +
| enforce_token_bind = permissive | +(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | +
| hash_algorithms = md5 | +(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | +
| http_connect_timeout = None | +(BoolOpt) Request timeout value for communicating with Identity API server. | +
| http_request_max_retries = 3 | +(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | +
| identity_uri = None | +(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | +
| include_service_catalog = True | +(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | +
| insecure = False | +(BoolOpt) Verify HTTPS connections. | +
| keyfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| memcache_secret_key = None | +(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | +
| memcache_security_strategy = None | +(StrOpt) (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. | +
| memcached_servers = None | +(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | +
| revocation_cache_time = 10 | +(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | +
| signing_dir = None | +(StrOpt) Directory used to cache files related to PKI tokens | +
| token_cache_time = 300 | +(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | +
| Configuration option = Default value | -Description | -
|---|---|
| [NOVA] | -|
| node_override_vif_802.1qbg = | -(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbg | -
| node_override_vif_802.1qbh = | -(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbh | -
| node_override_vif_binding_failed = | -(ListOpt) Nova compute nodes to manually set VIF type to binding_failed | -
| node_override_vif_bridge = | -(ListOpt) Nova compute nodes to manually set VIF type to bridge | -
| node_override_vif_hostdev = | -(ListOpt) Nova compute nodes to manually set VIF type to hostdev | -
| node_override_vif_hyperv = | -(ListOpt) Nova compute nodes to manually set VIF type to hyperv | -
| node_override_vif_ivs = | -(ListOpt) Nova compute nodes to manually set VIF type to ivs | -
| node_override_vif_midonet = | -(ListOpt) Nova compute nodes to manually set VIF type to midonet | -
| node_override_vif_mlnx_direct = | -(ListOpt) Nova compute nodes to manually set VIF type to mlnx_direct | -
| node_override_vif_other = | -(ListOpt) Nova compute nodes to manually set VIF type to other | -
| node_override_vif_ovs = | -(ListOpt) Nova compute nodes to manually set VIF type to ovs | -
| node_override_vif_unbound = | -(ListOpt) Nova compute nodes to manually set VIF type to unbound | -
| vif_type = ovs | -(StrOpt) Virtual interface type to configure on Nova compute nodes | -
| vif_types = unbound, binding_failed, ovs, ivs, bridge, 802.1qbg, 802.1qbh, hyperv, midonet, mlnx_direct, hostdev, other | -(ListOpt) List of allowed vif_type values. | -
| [RESTPROXY] | -|
| add_meta_server_route = True | -(BoolOpt) Flag to decide if a route to the metadata server should be injected into the VM | -
| auto_sync_on_failure = True | -(BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, the plugin automatically triggers a full data synchronization to the controller. | -
| cache_connections = True | -(BoolOpt) Re-use HTTP/HTTPS connections to the controller. | -
| consistency_interval = 60 | -(IntOpt) Time between verifications that the backend controller database is consistent with Neutron | -
| neutron_id = neutron-oslo | -(StrOpt) User defined identifier for this Neutron deployment | -
| no_ssl_validation = False | -(BoolOpt) Disables SSL certificate validation for controllers | -
| server_auth = None | -(StrOpt) The username and password for authenticating against the Big Switch or Floodlight controller. | -
| server_ssl = True | -(BoolOpt) If True, Use SSL when connecting to the Big Switch or Floodlight controller. | -
| server_timeout = 10 | -(IntOpt) Maximum number of seconds to wait for proxy request to connect and complete. | -
| servers = localhost:8800 | -(ListOpt) A comma separated list of Big Switch or Floodlight servers and port numbers. The plugin proxies the requests to the Big Switch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover. | -
| ssl_cert_directory = /etc/neutron/plugins/bigswitch/ssl | -(StrOpt) Directory containing ca_certs and host_certs certificate directories. | -
| ssl_sticky = True | -(BoolOpt) Trust and store the first certificate received for each controller address and use it to validate future connections to that address. | -
| sync_data = False | -(BoolOpt) Sync data on connect | -
| thread_pool_size = 4 | -(IntOpt) Maximum number of threads to spawn to handle large volumes of port creations. | -
| [RESTPROXYAGENT] | -|
| integration_bridge = br-int | -(StrOpt) Name of integration bridge on compute nodes used for security group insertion. | -
| polling_interval = 5 | -(IntOpt) Seconds between agent checks for port changes | -
| virtual_switch_type = ovs | -(StrOpt) Virtual switch type. | -
| [ROUTER] | -|
| max_router_rules = 200 | -(IntOpt) Maximum number of router rules | -
| tenant_default_router_rule = ['*:any:any:permit'] | -(MultiStrOpt) The default router rules installed in new tenant routers. Repeat the config option for each rule. Format is <tenant>:<source>:<destination>:<action> Use an * to specify default for all tenants. | -
| Configuration option = Default value | +Description | +
|---|---|
| [NOVA] | +|
| node_override_vif_802.1qbg = | +(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbg | +
| node_override_vif_802.1qbh = | +(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbh | +
| node_override_vif_binding_failed = | +(ListOpt) Nova compute nodes to manually set VIF type to binding_failed | +
| node_override_vif_bridge = | +(ListOpt) Nova compute nodes to manually set VIF type to bridge | +
| node_override_vif_hostdev = | +(ListOpt) Nova compute nodes to manually set VIF type to hostdev | +
| node_override_vif_hyperv = | +(ListOpt) Nova compute nodes to manually set VIF type to hyperv | +
| node_override_vif_ivs = | +(ListOpt) Nova compute nodes to manually set VIF type to ivs | +
| node_override_vif_midonet = | +(ListOpt) Nova compute nodes to manually set VIF type to midonet | +
| node_override_vif_mlnx_direct = | +(ListOpt) Nova compute nodes to manually set VIF type to mlnx_direct | +
| node_override_vif_other = | +(ListOpt) Nova compute nodes to manually set VIF type to other | +
| node_override_vif_ovs = | +(ListOpt) Nova compute nodes to manually set VIF type to ovs | +
| node_override_vif_unbound = | +(ListOpt) Nova compute nodes to manually set VIF type to unbound | +
| vif_type = ovs | +(StrOpt) Virtual interface type to configure on Nova compute nodes | +
| vif_types = unbound, binding_failed, ovs, ivs, bridge, 802.1qbg, 802.1qbh, hyperv, midonet, mlnx_direct, hostdev, other | +(ListOpt) List of allowed vif_type values. | +
| [RESTPROXY] | +|
| add_meta_server_route = True | +(BoolOpt) Flag to decide if a route to the metadata server should be injected into the VM | +
| auto_sync_on_failure = True | +(BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, the plugin automatically triggers a full data synchronization to the controller. | +
| cache_connections = True | +(BoolOpt) Re-use HTTP/HTTPS connections to the controller. | +
| consistency_interval = 60 | +(IntOpt) Time between verifications that the backend controller database is consistent with Neutron. (0 to disable) | +
| neutron_id = neutron-oslo | +(StrOpt) User defined identifier for this Neutron deployment | +
| no_ssl_validation = False | +(BoolOpt) Disables SSL certificate validation for controllers | +
| server_auth = None | +(StrOpt) The username and password for authenticating against the Big Switch or Floodlight controller. | +
| server_ssl = True | +(BoolOpt) If True, Use SSL when connecting to the Big Switch or Floodlight controller. | +
| server_timeout = 10 | +(IntOpt) Maximum number of seconds to wait for proxy request to connect and complete. | +
| servers = localhost:8800 | +(ListOpt) A comma separated list of Big Switch or Floodlight servers and port numbers. The plugin proxies the requests to the Big Switch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover. | +
| ssl_cert_directory = /etc/neutron/plugins/bigswitch/ssl | +(StrOpt) Directory containing ca_certs and host_certs certificate directories. | +
| ssl_sticky = True | +(BoolOpt) Trust and store the first certificate received for each controller address and use it to validate future connections to that address. | +
| sync_data = False | +(BoolOpt) Sync data on connect | +
| thread_pool_size = 4 | +(IntOpt) Maximum number of threads to spawn to handle large volumes of port creations. | +
| [RESTPROXYAGENT] | +|
| integration_bridge = br-int | +(StrOpt) Name of integration bridge on compute nodes used for security group insertion. | +
| polling_interval = 5 | +(IntOpt) Seconds between agent checks for port changes | +
| virtual_switch_type = ovs | +(StrOpt) Virtual switch type. | +
| [ROUTER] | +|
| max_router_rules = 200 | +(IntOpt) Maximum number of router rules | +
| tenant_default_router_rule = ['*:any:any:permit'] | +(MultiStrOpt) The default router rules installed in new tenant routers. Repeat the config option for each rule. Format is <tenant>:<source>:<destination>:<action> Use an * to specify default for all tenants. | +
| Configuration option = Default value | -Description | -
|---|---|
| [PHYSICAL_INTERFACE] | -|
| physical_interface = eth0 | -(StrOpt) The network interface to use when creatinga port | -
| [SWITCH] | -|
| address = | -(StrOpt) The address of the host to SSH to | -
| ostype = NOS | -(StrOpt) Currently unused | -
| password = | -(StrOpt) The SSH password to use | -
| username = | -(StrOpt) The SSH username to use | -
| Configuration option = Default value | +Description | +
|---|---|
| [PHYSICAL_INTERFACE] | +|
| physical_interface = eth0 | +(StrOpt) The network interface to use when creatinga port | +
| [SWITCH] | +|
| address = | +(StrOpt) The address of the host to SSH to | +
| ostype = NOS | +(StrOpt) Currently unused | +
| password = | +(StrOpt) The SSH password to use | +
| username = | +(StrOpt) The SSH username to use | +
| Configuration option = Default value | -Description | -
|---|---|
| [audit] | -|
| api_audit_map = api_audit_map.conf | -(StrOpt) File containing mapping for api paths and service endpoints | -
| namespace = openstack | -(StrOpt) namespace prefix for generated id | -
| Configuration option = Default value | -Description | -
|---|---|
| [CISCO] | -|
| model_class = neutron.plugins.cisco.models.virt_phy_sw_v2.VirtualPhysicalSwitchModelV2 | -(StrOpt) Model Class | -
| nexus_driver = neutron.plugins.cisco.test.nexus.fake_nexus_driver.CiscoNEXUSFakeDriver | -(StrOpt) Nexus Driver Name | -
| nexus_l3_enable = False | -(BoolOpt) Enable L3 support on the Nexus switches | -
| provider_vlan_auto_create = True | -(BoolOpt) Provider VLANs are automatically created as needed on the Nexus switch | -
| provider_vlan_auto_trunk = True | -(BoolOpt) Provider VLANs are automatically trunked as needed on the ports of the Nexus switch | -
| provider_vlan_name_prefix = p- | -(StrOpt) VLAN Name prefix for provider vlans | -
| svi_round_robin = False | -(BoolOpt) Distribute SVI interfaces over all switches | -
| vlan_name_prefix = q- | -(StrOpt) VLAN Name prefix | -
| [CISCO_N1K] | -|
| bridge_mappings = | -(StrOpt) N1K Bridge Mappings | -
| default_network_profile = default_network_profile | -(StrOpt) N1K default network profile | -
| default_policy_profile = service_profile | -(StrOpt) N1K default policy profile | -
| enable_tunneling = True | -(BoolOpt) N1K Enable Tunneling | -
| integration_bridge = br-int | -(StrOpt) N1K Integration Bridge | -
| network_node_policy_profile = dhcp_pp | -(StrOpt) N1K policy profile for network node | -
| network_vlan_ranges = vlan:1:4095 | -(StrOpt) N1K Network VLAN Ranges | -
| poll_duration = 10 | -(StrOpt) N1K Policy profile polling duration in seconds | -
| tenant_network_type = local | -(StrOpt) N1K Tenant Network Type | -
| tunnel_bridge = br-tun | -(StrOpt) N1K Tunnel Bridge | -
| vxlan_id_ranges = 5000:10000 | -(StrOpt) N1K VXLAN ID Ranges | -
| [CISCO_PLUGINS] | -|
| nexus_plugin = neutron.plugins.cisco.nexus.cisco_nexus_plugin_v2.NexusPlugin | -(StrOpt) Nexus Switch to use | -
| vswitch_plugin = neutron.plugins.openvswitch.ovs_neutron_plugin.OVSNeutronPluginV2 | -(StrOpt) Virtual Switch to use | -
| [cisco_csr_ipsec] | -|
| status_check_interval = 60 | -(IntOpt) Status check interval for Cisco CSR IPSec connections | -
| [ml2_cisco] | -|
| svi_round_robin = False | -(BoolOpt) Distribute SVI interfaces over all switches | -
| vlan_name_prefix = q- | -(StrOpt) VLAN Name prefix | -
| Configuration option = Default value | +Description | +
|---|---|
| [CISCO] | +|
| model_class = neutron.plugins.cisco.models.virt_phy_sw_v2.VirtualPhysicalSwitchModelV2 | +(StrOpt) Model Class | +
| nexus_driver = neutron.plugins.cisco.test.nexus.fake_nexus_driver.CiscoNEXUSFakeDriver | +(StrOpt) Nexus Driver Name | +
| nexus_l3_enable = False | +(BoolOpt) Enable L3 support on the Nexus switches | +
| provider_vlan_auto_create = True | +(BoolOpt) Provider VLANs are automatically created as needed on the Nexus switch | +
| provider_vlan_auto_trunk = True | +(BoolOpt) Provider VLANs are automatically trunked as needed on the ports of the Nexus switch | +
| provider_vlan_name_prefix = p- | +(StrOpt) VLAN Name prefix for provider vlans | +
| svi_round_robin = False | +(BoolOpt) Distribute SVI interfaces over all switches | +
| vlan_name_prefix = q- | +(StrOpt) VLAN Name prefix | +
| [CISCO_N1K] | +|
| bridge_mappings = | +(StrOpt) N1K Bridge Mappings | +
| default_network_profile = default_network_profile | +(StrOpt) N1K default network profile | +
| default_policy_profile = service_profile | +(StrOpt) N1K default policy profile | +
| enable_tunneling = True | +(BoolOpt) N1K Enable Tunneling | +
| http_pool_size = 4 | +(IntOpt) Number of threads to use to make HTTP requests | +
| integration_bridge = br-int | +(StrOpt) N1K Integration Bridge | +
| network_node_policy_profile = dhcp_pp | +(StrOpt) N1K policy profile for network node | +
| network_vlan_ranges = vlan:1:4095 | +(StrOpt) N1K Network VLAN Ranges | +
| poll_duration = 10 | +(IntOpt) N1K Policy profile polling duration in seconds | +
| tenant_network_type = local | +(StrOpt) N1K Tenant Network Type | +
| tunnel_bridge = br-tun | +(StrOpt) N1K Tunnel Bridge | +
| vxlan_id_ranges = 5000:10000 | +(StrOpt) N1K VXLAN ID Ranges | +
| [CISCO_PLUGINS] | +|
| nexus_plugin = neutron.plugins.cisco.nexus.cisco_nexus_plugin_v2.NexusPlugin | +(StrOpt) Nexus Switch to use | +
| vswitch_plugin = neutron.plugins.openvswitch.ovs_neutron_plugin.OVSNeutronPluginV2 | +(StrOpt) Virtual Switch to use | +
| [cisco_csr_ipsec] | +|
| status_check_interval = 60 | +(IntOpt) Status check interval for Cisco CSR IPSec connections | +
| [ml2_cisco] | +|
| svi_round_robin = False | +(BoolOpt) Distribute SVI interfaces over all switches | +
| vlan_name_prefix = q- | +(StrOpt) VLAN Name prefix | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| admin_password = None | -(StrOpt) Admin password | -
| admin_tenant_name = None | -(StrOpt) Admin tenant name | -
| admin_user = None | -(StrOpt) Admin username | -
| agent_down_time = 75 | -(IntOpt) Seconds to regard the agent is down; should be at least twice report_interval, to be sure the agent is down for good. | -
| allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions | -(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call. | -
| api_workers = 0 | -(IntOpt) Number of separate worker processes for service | -
| auth_ca_cert = None | -(StrOpt) Certificate Authority public key (CA cert) file for ssl | -
| auth_insecure = False | -(BoolOpt) Turn off verification of the certificate for ssl | -
| auth_region = None | -(StrOpt) Authentication region | -
| auth_strategy = keystone | -(StrOpt) The type of authentication to use | -
| auth_url = None | -(StrOpt) Authentication URL | -
| base_mac = fa:16:3e:00:00:00 | -(StrOpt) The base MAC address Neutron will use for VIFs | -
| bind_host = 0.0.0.0 | -(StrOpt) The host IP to bind to | -
| bind_port = 9696 | -(IntOpt) The port to bind to | -
| ca_certs = None | -(StrOpt) CA certificates | -
| core_plugin = None | -(StrOpt) The core plugin Neutron will use | -
| ctl_cert = None | -(StrOpt) controller certificate | -
| ctl_privkey = None | -(StrOpt) controller private key | -
| dhcp_agent_notification = True | -(BoolOpt) Allow sending resource operation notification to DHCP agent | -
| dhcp_agents_per_network = 1 | -(IntOpt) Number of DHCP agents scheduled to host a network. | -
| dhcp_confs = $state_path/dhcp | -(StrOpt) Location to store DHCP server config files | -
| dhcp_delete_namespaces = False | -(BoolOpt) Delete namespace after removing a dhcp server. | -
| dhcp_domain = openstacklocal | -(StrOpt) Domain to use for building the hostnames | -
| dhcp_driver = neutron.agent.linux.dhcp.Dnsmasq | -(StrOpt) The driver used to manage the DHCP server. | -
| dhcp_lease_duration = 86400 | -(IntOpt) DHCP lease duration | -
| disable_process_locking = False | -(BoolOpt) Whether to disable inter-process locks | -
| endpoint_type = adminURL | -(StrOpt) Network service endpoint type to pull from the keystone catalog | -
| force_gateway_on_subnet = False | -(BoolOpt) Ensure that configured gateway is on subnet | -
| interface_driver = None | -(StrOpt) The driver used to manage the virtual interface. | -
| ip_lib_force_root = False | -(BoolOpt) Force ip_lib calls to use the root helper | -
| lock_path = None | -(StrOpt) Directory to use for lock files. | -
| mac_generation_retries = 16 | -(IntOpt) How many times Neutron will retry MAC generation | -
| max_dns_nameservers = 5 | -(IntOpt) Maximum number of DNS nameservers | -
| max_fixed_ips_per_port = 5 | -(IntOpt) Maximum number of fixed ips per port | -
| max_subnet_host_routes = 20 | -(IntOpt) Maximum number of host routes per subnet | -
| periodic_fuzzy_delay = 5 | -(IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) | -
| periodic_interval = 40 | -(IntOpt) Seconds between running periodic tasks | -
| report_interval = 300 | -(IntOpt) Interval between two metering reports | -
| root_helper = sudo | -(StrOpt) Root helper application. | -
| state_path = /var/lib/neutron | -(StrOpt) Where to store Neutron state files. This directory must be writable by the agent. | -
| [AGENT] | -|
| root_helper = sudo | -(StrOpt) Root helper application. | -
| [PROXY] | -|
| admin_password = None | -(StrOpt) Admin password | -
| admin_tenant_name = None | -(StrOpt) Admin tenant name | -
| admin_user = None | -(StrOpt) Admin user | -
| auth_region = None | -(StrOpt) Authentication region | -
| auth_strategy = keystone | -(StrOpt) The type of authentication to use | -
| auth_url = None | -(StrOpt) Authentication URL | -
| [heleos] | -|
| admin_password = None | -(StrOpt) ESM admin password. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| admin_password = None | +(StrOpt) Admin password | +
| admin_tenant_name = None | +(StrOpt) Admin tenant name | +
| admin_user = None | +(StrOpt) Admin username | +
| agent_down_time = 75 | +(IntOpt) Seconds to regard the agent is down; should be at least twice report_interval, to be sure the agent is down for good. | +
| allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions | +(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call. | +
| api_workers = 0 | +(IntOpt) Number of separate worker processes for service | +
| auth_ca_cert = None | +(StrOpt) Certificate Authority public key (CA cert) file for ssl | +
| auth_insecure = False | +(BoolOpt) Turn off verification of the certificate for ssl | +
| auth_region = None | +(StrOpt) Authentication region | +
| auth_strategy = keystone | +(StrOpt) The type of authentication to use | +
| auth_url = None | +(StrOpt) Authentication URL | +
| base_mac = fa:16:3e:00:00:00 | +(StrOpt) The base MAC address Neutron will use for VIFs | +
| bind_host = 0.0.0.0 | +(StrOpt) The host IP to bind to | +
| bind_port = 9696 | +(IntOpt) The port to bind to | +
| ca_certs = None | +(StrOpt) CA certificates | +
| core_plugin = None | +(StrOpt) The core plugin Neutron will use | +
| ctl_cert = None | +(StrOpt) controller certificate | +
| ctl_privkey = None | +(StrOpt) controller private key | +
| dhcp_agent_notification = True | +(BoolOpt) Allow sending resource operation notification to DHCP agent | +
| dhcp_agents_per_network = 1 | +(IntOpt) Number of DHCP agents scheduled to host a network. | +
| dhcp_confs = $state_path/dhcp | +(StrOpt) Location to store DHCP server config files | +
| dhcp_delete_namespaces = False | +(BoolOpt) Delete namespace after removing a dhcp server. | +
| dhcp_domain = openstacklocal | +(StrOpt) Domain to use for building the hostnames | +
| dhcp_driver = neutron.agent.linux.dhcp.Dnsmasq | +(StrOpt) The driver used to manage the DHCP server. | +
| dhcp_lease_duration = 86400 | +(IntOpt) DHCP lease duration (in seconds). Use -1 to tell dnsmasq to use infinite lease times. | +
| disable_process_locking = False | +(BoolOpt) Whether to disable inter-process locks | +
| endpoint_type = adminURL | +(StrOpt) Network service endpoint type to pull from the keystone catalog | +
| force_gateway_on_subnet = False | +(BoolOpt) Ensure that configured gateway is on subnet | +
| interface_driver = None | +(StrOpt) The driver used to manage the virtual interface. | +
| ip_lib_force_root = False | +(BoolOpt) Force ip_lib calls to use the root helper | +
| lock_path = None | +(StrOpt) Directory to use for lock files. | +
| mac_generation_retries = 16 | +(IntOpt) How many times Neutron will retry MAC generation | +
| max_dns_nameservers = 5 | +(IntOpt) Maximum number of DNS nameservers | +
| max_fixed_ips_per_port = 5 | +(IntOpt) Maximum number of fixed ips per port | +
| max_subnet_host_routes = 20 | +(IntOpt) Maximum number of host routes per subnet | +
| periodic_fuzzy_delay = 5 | +(IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) | +
| periodic_interval = 40 | +(IntOpt) Seconds between running periodic tasks | +
| report_interval = 300 | +(IntOpt) Interval between two metering reports | +
| root_helper = sudo | +(StrOpt) Root helper application. | +
| state_path = /var/lib/neutron | +(StrOpt) Where to store Neutron state files. This directory must be writable by the agent. | +
| [AGENT] | +|
| root_helper = sudo | +(StrOpt) Root helper application. | +
| [PROXY] | +|
| admin_password = None | +(StrOpt) Admin password | +
| admin_tenant_name = None | +(StrOpt) Admin tenant name | +
| admin_user = None | +(StrOpt) Admin user | +
| auth_region = None | +(StrOpt) Authentication region | +
| auth_strategy = keystone | +(StrOpt) The type of authentication to use | +
| auth_url = None | +(StrOpt) Authentication URL | +
| [heleos] | +|
| admin_password = None | +(StrOpt) ESM admin password. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| notify_nova_on_port_data_changes = True | -(BoolOpt) Send notification to nova when port data (fixed_ips/floatingip) changes so nova can update its cache. | -
| notify_nova_on_port_status_changes = True | -(BoolOpt) Send notification to nova when port status changes | -
| nova_admin_auth_url = http://localhost:5000/v2.0 | -(StrOpt) Authorization URL for connecting to nova in admin context | -
| nova_admin_password = None | -(StrOpt) Password for connection to nova in admin context | -
| nova_admin_tenant_id = None | -(StrOpt) The uuid of the admin nova tenant | -
| nova_admin_username = None | -(StrOpt) Username for connecting to nova in admin context | -
| nova_region_name = None | -(StrOpt) Name of nova region to use. Useful if keystone manages more than one region. | -
| nova_url = http://127.0.0.1:8774 | -(StrOpt) URL for connection to nova | -
| send_events_interval = 2 | -(IntOpt) Number of seconds between sending events to nova if there are any events to send. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| notify_nova_on_port_data_changes = True | +(BoolOpt) Send notification to nova when port data (fixed_ips/floatingip) changes so nova can update its cache. | +
| notify_nova_on_port_status_changes = True | +(BoolOpt) Send notification to nova when port status changes | +
| nova_admin_auth_url = http://localhost:5000/v2.0 | +(StrOpt) Authorization URL for connecting to nova in admin context | +
| nova_admin_password = None | +(StrOpt) Password for connection to nova in admin context | +
| nova_admin_tenant_id = None | +(StrOpt) The uuid of the admin nova tenant | +
| nova_admin_username = None | +(StrOpt) Username for connecting to nova in admin context | +
| nova_api_insecure = False | +(BoolOpt) If True, ignore any SSL validation issues | +
| nova_ca_certificates_file = None | +(StrOpt) CA file for novaclient to verify server certificates | +
| nova_client_cert = | +(StrOpt) Client certificate for nova metadata api server. | +
| nova_client_priv_key = | +(StrOpt) Private key of client certificate. | +
| nova_region_name = None | +(StrOpt) Name of nova region to use. Useful if keystone manages more than one region. | +
| nova_url = http://127.0.0.1:8774/v2 | +(StrOpt) URL for connection to nova | +
| send_events_interval = 2 | +(IntOpt) Number of seconds between sending events to nova if there are any events to send. | +
| Configuration option = Default value | +Description | +
|---|---|
| [database] | +|
| backend = sqlalchemy | +(StrOpt) The backend to use for db | +
| connection = sqlite:// | +(StrOpt) The SQLAlchemy connection string used to connect to the database | +
| connection_debug = 0 | +(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything | +
| connection_trace = False | +(BoolOpt) Add python stack traces to SQL as comment strings | +
| db_inc_retry_interval = True | +(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval | +
| db_max_retries = 20 | +(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count) | +
| db_max_retry_interval = 10 | +(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled | +
| db_retry_interval = 1 | +(IntOpt) seconds between db connection retries | +
| idle_timeout = 3600 | +(IntOpt) Timeout before idle sql connections are reaped | +
| max_overflow = 20 | +(IntOpt) If set, use this value for max_overflow with sqlalchemy | +
| max_pool_size = 10 | +(IntOpt) Maximum number of SQL connections to keep open in a pool | +
| max_retries = 10 | +(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count) | +
| min_pool_size = 1 | +(IntOpt) Minimum number of SQL connections to keep open in a pool | +
| mysql_sql_mode = TRADITIONAL | +(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | +
| pool_timeout = 10 | +(IntOpt) If set, use this value for pool_timeout with sqlalchemy | +
| retry_interval = 10 | +(IntOpt) Interval between retries of opening a sql connection | +
| sqlite_db = | +(StrOpt) The file name to use with SQLite | +
| sqlite_synchronous = True | +(BoolOpt) If True, SQLite uses synchronous mode | +
| use_db_reconnect = False | +(BoolOpt) Enable the experimental use of database reconnect on connection lost | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| sqlite_db = | -(StrOpt) The file name to use with SQLite | -
| sqlite_synchronous = True | -(BoolOpt) If True, SQLite uses synchronous mode | -
| [database] | -|
| backend = sqlalchemy | -(StrOpt) The backend to use for db | -
| connection = sqlite:// | -(StrOpt) The SQLAlchemy connection string used to connect to the database | -
| connection_debug = 0 | -(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything | -
| connection_trace = False | -(BoolOpt) Add python stack traces to SQL as comment strings | -
| db_inc_retry_interval = True | -(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval | -
| db_max_retries = 20 | -(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count) | -
| db_max_retry_interval = 10 | -(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled | -
| db_retry_interval = 1 | -(IntOpt) seconds between db connection retries | -
| idle_timeout = 3600 | -(IntOpt) Timeout before idle sql connections are reaped | -
| max_overflow = 20 | -(IntOpt) If set, use this value for max_overflow with sqlalchemy | -
| max_pool_size = 10 | -(IntOpt) Maximum number of SQL connections to keep open in a pool | -
| max_retries = 10 | -(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count) | -
| min_pool_size = 1 | -(IntOpt) Minimum number of SQL connections to keep open in a pool | -
| pool_timeout = 10 | -(IntOpt) If set, use this value for pool_timeout with sqlalchemy | -
| retry_interval = 10 | -(IntOpt) Interval between retries of opening a sql connection | -
| slave_connection = | -(StrOpt) The SQLAlchemy connection string used to connect to the slave database | -
| use_db_reconnect = False | -(BoolOpt) Enable the experimental use of database reconnect on connection lost | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| dnsmasq_config_file = | -(StrOpt) Override the default dnsmasq settings with this file | -
| dnsmasq_dns_servers = None | -(ListOpt) Comma-separated list of the DNS servers which will be used as forwarders. | -
| dnsmasq_lease_max = 16777216 | -(IntOpt) Limit number of leases to prevent a denial-of-service. | -
| enable_isolated_metadata = False | -(BoolOpt) Support Metadata requests on isolated networks. | -
| enable_metadata_network = False | -(BoolOpt) Allows for serving metadata requests from a dedicated network. Requires enable_isolated_metadata = True | -
| num_sync_threads = 4 | -(IntOpt) Number of threads to use during sync process. | -
| resync_interval = 5 | -(IntOpt) Interval to resync. | -
| use_namespaces = True | -(BoolOpt) Allow overlapping IP. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| dnsmasq_config_file = | +(StrOpt) Override the default dnsmasq settings with this file | +
| dnsmasq_dns_servers = None | +(ListOpt) Comma-separated list of the DNS servers which will be used as forwarders. | +
| dnsmasq_lease_max = 16777216 | +(IntOpt) Limit number of leases to prevent a denial-of-service. | +
| enable_isolated_metadata = False | +(BoolOpt) Support Metadata requests on isolated networks. | +
| enable_metadata_network = False | +(BoolOpt) Allows for serving metadata requests from a dedicated network. Requires enable_isolated_metadata = True | +
| num_sync_threads = 4 | +(IntOpt) Number of threads to use during sync process. | +
| resync_interval = 5 | +(IntOpt) Interval to resync. | +
| use_namespaces = True | +(BoolOpt) Allow overlapping IP. | +
| Configuration option = Default value | -Description | -
|---|---|
| [heleos] | -|
| admin_username = admin | -(StrOpt) ESM admin username. | -
| async_requests = True | -(BoolOpt) Define if the requests have run asynchronously or not | -
| dummy_utif_id = None | -(StrOpt) Dummy user traffic Security Zone id | -
| esm_mgmt = None | -(StrOpt) ESM management root address | -
| inband_id = None | -(StrOpt) In band Security Zone id | -
| mgmt_id = None | -(StrOpt) Management Security Zone id | -
| oob_id = None | -(StrOpt) Out of band Security Zone id | -
| resource_pool_id = default | -(StrOpt) Shared resource pool id | -
| router_image = None | -(StrOpt) Router image id (Embrane FW/VPN) | -
| Configuration option = Default value | +Description | +
|---|---|
| [heleos] | +|
| admin_username = admin | +(StrOpt) ESM admin username. | +
| async_requests = True | +(BoolOpt) Define if the requests have run asynchronously or not | +
| dummy_utif_id = None | +(StrOpt) Dummy user traffic Security Zone id | +
| esm_mgmt = None | +(StrOpt) ESM management root address | +
| inband_id = None | +(StrOpt) In band Security Zone id | +
| mgmt_id = None | +(StrOpt) Management Security Zone id | +
| oob_id = None | +(StrOpt) Out of band Security Zone id | +
| resource_pool_id = default | +(StrOpt) Shared resource pool id | +
| router_image = None | +(StrOpt) Router image id (Embrane FW/VPN) | +
| Configuration option = Default value | -Description | -
|---|---|
| [heleoslb] | -|
| admin_password = None | -(StrOpt) ESM admin password. | -
| admin_username = None | -(StrOpt) ESM admin username. | -
| async_requests = None | -(BoolOpt) Define if the requests have run asynchronously or not | -
| dummy_utif_id = None | -(StrOpt) Dummy user traffic Security Zone id for LBs | -
| esm_mgmt = None | -(StrOpt) ESM management root address | -
| inband_id = None | -(StrOpt) In band Security Zone id for LBs | -
| lb_flavor = small | -(StrOpt) choose LB image flavor to use, accepted values: small, medium | -
| lb_image = None | -(StrOpt) Load Balancer image id (Embrane LB) | -
| mgmt_id = None | -(StrOpt) Management Security Zone id for LBs | -
| oob_id = None | -(StrOpt) Out of band Security Zone id for LBs | -
| resource_pool_id = None | -(StrOpt) Shared resource pool id | -
| sync_interval = 60 | -(IntOpt) resource synchronization interval in seconds | -
| Configuration option = Default value | +Description | +
|---|---|
| [heleoslb] | +|
| admin_password = None | +(StrOpt) ESM admin password. | +
| admin_username = None | +(StrOpt) ESM admin username. | +
| async_requests = None | +(BoolOpt) Define if the requests have run asynchronously or not | +
| dummy_utif_id = None | +(StrOpt) Dummy user traffic Security Zone id for LBs | +
| esm_mgmt = None | +(StrOpt) ESM management root address | +
| inband_id = None | +(StrOpt) In band Security Zone id for LBs | +
| lb_flavor = small | +(StrOpt) choose LB image flavor to use, accepted values: small, medium | +
| lb_image = None | +(StrOpt) Load Balancer image id (Embrane LB) | +
| mgmt_id = None | +(StrOpt) Management Security Zone id for LBs | +
| oob_id = None | +(StrOpt) Out of band Security Zone id for LBs | +
| resource_pool_id = None | +(StrOpt) Shared resource pool id | +
| sync_interval = 60 | +(IntOpt) resource synchronization interval in seconds | +
| Configuration option = Default value | -Description | -
|---|---|
| [fwaas] | -|
| enabled = False | -(BoolOpt) Enable FWaaS | -
| Configuration option = Default value | +Description | +
|---|---|
| [fwaas] | +|
| enabled = False | +(BoolOpt) Enable FWaaS | +
| Configuration option = Default value | -Description | -
|---|---|
| [AGENT] | -|
| enable_metrics_collection = False | -(BoolOpt) Enables metrics collections for switch ports by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above | -
| local_network_vswitch = private | -(StrOpt) Private vswitch name used for local networks | -
| metrics_max_retries = 100 | -(IntOpt) Specifies the maximum number of retries to enable Hyper-V's port metrics collection. The agent will try to enable the feature once every polling_interval period for at most metrics_max_retries or until it succeedes. | -
| physical_network_vswitch_mappings = | -(ListOpt) List of <physical_network>:<vswitch> where the physical networks can be expressed with wildcards, e.g.: ."*:external" | -
| polling_interval = 2 | -(IntOpt) The number of seconds the agent will wait between polling for local device changes. | -
| [HYPERV] | -|
| network_vlan_ranges = | -(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> | -
| tenant_network_type = local | -(StrOpt) Network type for tenant networks (local, flat, vlan or none) | -
| [hyperv] | -|
| force_hyperv_utils_v1 = False | -(BoolOpt) Force V1 WMI utility classes | -
| Configuration option = Default value | +Description | +
|---|---|
| [AGENT] | +|
| enable_metrics_collection = False | +(BoolOpt) Enables metrics collections for switch ports by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above | +
| local_network_vswitch = private | +(StrOpt) Private vswitch name used for local networks | +
| metrics_max_retries = 100 | +(IntOpt) Specifies the maximum number of retries to enable Hyper-V's port metrics collection. The agent will try to enable the feature once every polling_interval period for at most metrics_max_retries or until it succeedes. | +
| physical_network_vswitch_mappings = | +(ListOpt) List of <physical_network>:<vswitch> where the physical networks can be expressed with wildcards, e.g.: ."*:external" | +
| polling_interval = 2 | +(IntOpt) The number of seconds the agent will wait between polling for local device changes. | +
| [HYPERV] | +|
| network_vlan_ranges = | +(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> | +
| tenant_network_type = local | +(StrOpt) Network type for tenant networks (local, flat, vlan or none) | +
| [hyperv] | +|
| force_hyperv_utils_v1 = False | +(BoolOpt) Force V1 WMI utility classes | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| kombu_ssl_ca_certs = | -(StrOpt) SSL certification authority file (valid only if SSL enabled) | -
| kombu_ssl_certfile = | -(StrOpt) SSL cert file (valid only if SSL enabled) | -
| kombu_ssl_keyfile = | -(StrOpt) SSL key file (valid only if SSL enabled) | -
| kombu_ssl_version = | -(StrOpt) If SSL is enabled, the SSL version to use. Valid values are TLSv1, SSLv23 and SSLv3. SSLv2 might be available on some distributions. | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| enable_metadata_proxy = True | -(BoolOpt) Allow running metadata proxy. | -
| external_network_bridge = br-ex | -(StrOpt) Name of bridge used for external network traffic. | -
| gateway_external_network_id = | -(StrOpt) UUID of external network for routers implemented by the agents. | -
| handle_internal_only_routers = True | -(BoolOpt) Agent should implement routers with no gateway | -
| router_id = | -(StrOpt) If namespaces is disabled, the l3 agent can only configure a router that has the matching router ID. | -
| send_arp_for_ha = 0 | -(IntOpt) Send this many gratuitous ARPs for HA setup, if less than or equal to 0, the feature is disabled | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| enable_metadata_proxy = True | +(BoolOpt) Allow running metadata proxy. | +
| external_network_bridge = br-ex | +(StrOpt) Name of bridge used for external network traffic. | +
| gateway_external_network_id = | +(StrOpt) UUID of external network for routers implemented by the agents. | +
| handle_internal_only_routers = True | +(BoolOpt) Agent should implement routers with no gateway | +
| router_id = | +(StrOpt) If namespaces is disabled, the l3 agent can only configure a router that has the matching router ID. | +
| send_arp_for_ha = 3 | +(IntOpt) Send this many gratuitous ARPs for HA setup, if less than or equal to 0, the feature is disabled | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| device_driver = ['neutron.services.loadbalancer.drivers.haproxy.namespace_driver.HaproxyNSDriver'] | -(MultiStrOpt) Drivers used to manage loadbalancing devices | -
| loadbalancer_pool_scheduler_driver = neutron.services.loadbalancer.agent_scheduler.ChanceScheduler | -(StrOpt) Driver to use for scheduling pool to a default loadbalancer agent | -
| [haproxy] | -|
| loadbalancer_state_path = $state_path/lbaas | -(StrOpt) Location to store config and state files | -
| user_group = nogroup | -(StrOpt) The user group | -
| [netscaler_driver] | -|
| netscaler_ncc_password = None | -(StrOpt) Password to login to the NetScaler Control Center Server. | -
| netscaler_ncc_uri = None | -(StrOpt) The URL to reach the NetScaler Control Center Server. | -
| netscaler_ncc_username = None | -(StrOpt) Username to login to the NetScaler Control Center Server. | -
| [radware] | -|
| actions_to_skip = setup_l2_l3 | -(ListOpt) List of actions that we dont want to push to the completion queue | -
| l2_l3_ctor_params = {'ha_ip_pool_name': 'default', 'allocate_ha_vrrp': True, 'ha_network_name': 'HA-Network', 'service': '_REPLACE_', 'allocate_ha_ips': True} | -(DictOpt) l2_l3 workflow constructor params | -
| l2_l3_setup_params = {'data_ip_address': '192.168.200.99', 'data_port': 1, 'gateway': '192.168.200.1', 'ha_port': 2, 'data_ip_mask': '255.255.255.0'} | -(DictOpt) l2_l3 workflow setup params | -
| l2_l3_workflow_name = openstack_l2_l3 | -(StrOpt) l2_l3 workflow name | -
| l4_action_name = BaseCreate | -(StrOpt) l4 workflow action name | -
| l4_workflow_name = openstack_l4 | -(StrOpt) l4 workflow name | -
| service_adc_type = VA | -(StrOpt) Service ADC type | -
| service_adc_version = | -(StrOpt) Service ADC version | -
| service_cache = 20 | -(IntOpt) service cache | -
| service_compression_throughput = 100 | -(IntOpt) service compression throughtput | -
| service_ha_pair = False | -(BoolOpt) service HA pair | -
| service_isl_vlan = -1 | -(IntOpt) A required VLAN for the interswitch link to use | -
| service_resource_pool_ids = | -(ListOpt) Resource pool ids | -
| service_session_mirroring_enabled = False | -(BoolOpt) Support an Alteon interswitch link for stateful session failover | -
| service_ssl_throughput = 100 | -(IntOpt) service ssl throughtput | -
| service_throughput = 1000 | -(IntOpt) service throughtput | -
| vdirect_address = None | -(StrOpt) vdirect server IP address | -
| vdirect_password = radware | -(StrOpt) vdirect user password | -
| vdirect_user = vDirect | -(StrOpt) vdirect user name | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| device_driver = ['neutron.services.loadbalancer.drivers.haproxy.namespace_driver.HaproxyNSDriver'] | +(MultiStrOpt) Drivers used to manage loadbalancing devices | +
| loadbalancer_pool_scheduler_driver = neutron.services.loadbalancer.agent_scheduler.ChanceScheduler | +(StrOpt) Driver to use for scheduling pool to a default loadbalancer agent | +
| Configuration option = Default value | +Description | +
|---|---|
| [haproxy] | +|
| loadbalancer_state_path = $state_path/lbaas | +(StrOpt) Location to store config and state files | +
| send_gratuitous_arp = 3 | +(IntOpt) When delete and re-add the same vip, send this many gratuitous ARPs to flush the ARP cache in the Router. Set it below or equal to 0 to disable this feature. | +
| user_group = nogroup | +(StrOpt) The user group | +
| Configuration option = Default value | +Description | +
|---|---|
| [netscaler_driver] | +|
| netscaler_ncc_password = None | +(StrOpt) Password to login to the NetScaler Control Center Server. | +
| netscaler_ncc_uri = None | +(StrOpt) The URL to reach the NetScaler Control Center Server. | +
| netscaler_ncc_username = None | +(StrOpt) Username to login to the NetScaler Control Center Server. | +
| Configuration option = Default value | +Description | +
|---|---|
| [radware] | +|
| actions_to_skip = setup_l2_l3 | +(ListOpt) List of actions that are not pushed to the completion queue. | +
| ha_secondary_address = None | +(StrOpt) IP address of secondary vDirect server. | +
| l2_l3_ctor_params = {'ha_network_name': 'HA-Network', 'service': '_REPLACE_', 'ha_ip_pool_name': 'default', 'twoleg_enabled': '_REPLACE_', 'allocate_ha_ips': True, 'allocate_ha_vrrp': True} | +(DictOpt) Parameter for l2_l3 workflow constructor. | +
| l2_l3_setup_params = {'data_ip_address': '192.168.200.99', 'data_port': 1, 'gateway': '192.168.200.1', 'ha_port': 2, 'data_ip_mask': '255.255.255.0'} | +(DictOpt) Parameter for l2_l3 workflow setup. | +
| l2_l3_workflow_name = openstack_l2_l3 | +(StrOpt) Name of l2_l3 workflow. Default: openstack_l2_l3. | +
| l4_action_name = BaseCreate | +(StrOpt) Name of the l4 workflow action. Default: BaseCreate. | +
| l4_workflow_name = openstack_l4 | +(StrOpt) Name of l4 workflow. Default: openstack_l4. | +
| service_adc_type = VA | +(StrOpt) Service ADC type. Default: VA. | +
| service_adc_version = | +(StrOpt) Service ADC version. | +
| service_cache = 20 | +(IntOpt) Size of service cache. Default: 20. | +
| service_compression_throughput = 100 | +(IntOpt) Service compression throughput. Default: 100. | +
| service_ha_pair = False | +(BoolOpt) Enables or disables the Service HA pair. Default: False. | +
| service_isl_vlan = -1 | +(IntOpt) A required VLAN for the interswitch link to use. | +
| service_resource_pool_ids = | +(ListOpt) Resource pool IDs. | +
| service_session_mirroring_enabled = False | +(BoolOpt) Enable or disable Alteon interswitch link for stateful session failover. Default: False. | +
| service_ssl_throughput = 100 | +(IntOpt) Service SSL throughput. Default: 100. | +
| service_throughput = 1000 | +(IntOpt) Service throughput. Default: 1000. | +
| vdirect_address = None | +(StrOpt) IP address of vDirect server. | +
| vdirect_password = radware | +(StrOpt) vDirect user password. | +
| vdirect_user = vDirect | +(StrOpt) vDirect user name. | +
| Configuration option = Default value | -Description | -
|---|---|
| [LINUX_BRIDGE] | -|
| physical_interface_mappings = | -(ListOpt) List of <physical_network>:<physical_interface> | -
| [VLANS] | -|
| network_vlan_ranges = | -(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> | -
| tenant_network_type = local | -(StrOpt) Network type for tenant networks (local, vlan, or none) | -
| [VXLAN] | -|
| enable_vxlan = False | -(BoolOpt) Enable VXLAN on the agent. Can be enabled when agent is managed by ml2 plugin using linuxbridge mechanism driver | -
| l2_population = False | -(BoolOpt) Extension to use alongside ml2 plugin's l2population mechanism driver. It enables the plugin to populate VXLAN forwarding table. | -
| local_ip = | -(StrOpt) Local IP address of the VXLAN endpoints. | -
| tos = None | -(IntOpt) TOS for vxlan interface protocol packets. | -
| ttl = None | -(IntOpt) TTL for vxlan interface protocol packets. | -
| vxlan_group = 224.0.0.1 | -(StrOpt) Multicast group for vxlan interface. | -
| Configuration option = Default value | +Description | +
|---|---|
| [LINUX_BRIDGE] | +|
| physical_interface_mappings = | +(ListOpt) List of <physical_network>:<physical_interface> | +
| [VLANS] | +|
| network_vlan_ranges = | +(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> | +
| tenant_network_type = local | +(StrOpt) Network type for tenant networks (local, vlan, or none) | +
| [VXLAN] | +|
| enable_vxlan = False | +(BoolOpt) Enable VXLAN on the agent. Can be enabled when agent is managed by ml2 plugin using linuxbridge mechanism driver | +
| l2_population = False | +(BoolOpt) Extension to use alongside ml2 plugin's l2population mechanism driver. It enables the plugin to populate VXLAN forwarding table. | +
| local_ip = | +(StrOpt) Local IP address of the VXLAN endpoints. | +
| tos = None | +(IntOpt) TOS for vxlan interface protocol packets. | +
| ttl = None | +(IntOpt) TTL for vxlan interface protocol packets. | +
| vxlan_group = 224.0.0.1 | +(StrOpt) Multicast group for vxlan interface. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| debug = False | -(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | -
| default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN | -(ListOpt) list of logger=LEVEL pairs | -
| fatal_deprecations = False | -(BoolOpt) make deprecations fatal | -
| instance_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance is passed with the log message, format it like this | -
| instance_uuid_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance UUID is passed with the log message, format it like this | -
| log_config_append = None | -(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files. | -
| log_date_format = %Y-%m-%d %H:%M:%S | -(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s | -
| log_dir = None | -(StrOpt) (Optional) The base directory used for relative --log-file paths | -
| log_file = None | -(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | -
| log_format = None | -(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | -
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | -(StrOpt) format string to use for log messages with context | -
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | -(StrOpt) data to append to log format when level is DEBUG | -
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | -(StrOpt) format string to use for log messages without context | -
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -(StrOpt) prefix each line of exception output with this format | -
| publish_errors = False | -(BoolOpt) publish error events | -
| syslog_log_facility = LOG_USER | -(StrOpt) syslog facility to receive log lines | -
| use_ssl = False | -(BoolOpt) Enable SSL on the API server | -
| use_stderr = True | -(BoolOpt) Log output to standard error | -
| use_syslog = False | -(BoolOpt) Use syslog for logging. | -
| verbose = False | -(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| debug = False | +(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | +
| default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN | +(ListOpt) List of logger=LEVEL pairs. | +
| fatal_deprecations = False | +(BoolOpt) Enables or disables fatal status of deprecations. | +
| instance_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance that is passed with the log message. | +
| instance_uuid_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance UUID that is passed with the log message. | +
| log_config_append = None | +(StrOpt) 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. | +
| log_date_format = %Y-%m-%d %H:%M:%S | +(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . | +
| log_dir = None | +(StrOpt) (Optional) The base directory used for relative --log-file paths. | +
| log_file = None | +(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | +
| log_format = None | +(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | +
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages with context. | +
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | +(StrOpt) Data to append to log format when level is DEBUG. | +
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages without context. | +
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | +(StrOpt) Prefix each line of exception output with this format. | +
| publish_errors = False | +(BoolOpt) Enables or disables publication of error events. | +
| syslog_log_facility = LOG_USER | +(StrOpt) Syslog facility to receive log lines. | +
| use_ssl = False | +(BoolOpt) Enable SSL on the API server | +
| use_stderr = True | +(BoolOpt) Log output to standard error. | +
| use_syslog = False | +(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424. | +
| use_syslog_rfc_format = False | +(BoolOpt) (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 I, and will be removed in J. | +
| verbose = False | +(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | +
| Configuration option = Default value | -Description | -
|---|---|
| [META] | -|
| default_flavor = | -(StrOpt) Default flavor to use | -
| default_l3_flavor = | -(StrOpt) Default L3 flavor to use | -
| extension_map = | -(StrOpt) A list of extensions, per plugin, to load. | -
| l3_plugin_list = | -(StrOpt) List of L3 plugins to load | -
| plugin_list = | -(StrOpt) List of plugins to load | -
| rpc_flavor = | -(StrOpt) Flavor of which plugin handles RPC | -
| supported_extension_aliases = | -(StrOpt) Supported extension aliases | -
| Configuration option = Default value | +Description | +
|---|---|
| [META] | +|
| default_flavor = | +(StrOpt) Default flavor to use, when flavor:network is not specified at network creation. | +
| default_l3_flavor = | +(StrOpt) Default L3 flavor to use, when flavor:router is not specified at router creation. Ignored if 'l3_plugin_list' is blank. | +
| extension_map = | +(StrOpt) Comma separated list of method:flavor to select specific plugin for a method. This has priority over method search order based on 'plugin_list'. | +
| l3_plugin_list = | +(StrOpt) Comma separated list of flavor:neutron_plugin for L3 service plugins to load. This is intended for specifying L2 plugins which support L3 functions. If you use a router service plugin, set this blank. | +
| plugin_list = | +(StrOpt) Comma separated list of flavor:neutron_plugin for plugins to load. Extension method is searched in the list order and the first one is used. | +
| rpc_flavor = | +(StrOpt) Specifies flavor for plugin to handle 'q-plugin' RPC requests. | +
| supported_extension_aliases = | +(StrOpt) Comma separated list of supported extension aliases. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| meta_flavor_driver_mappings = None | -(StrOpt) Mapping between flavor and LinuxInterfaceDriver | -
| metadata_backlog = 128 | -(IntOpt) Number of backlog requests to configure the metadata server socket with | -
| metadata_port = 9697 | -(IntOpt) TCP Port used by Neutron metadata namespace proxy. | -
| metadata_proxy_shared_secret = | -(StrOpt) Shared secret to sign instance-id request | -
| metadata_proxy_socket = $state_path/metadata_proxy | -(StrOpt) Location of Metadata Proxy UNIX domain socket | -
| metadata_workers = 0 | -(IntOpt) Number of separate worker processes for metadata server | -
| nova_metadata_ip = 127.0.0.1 | -(StrOpt) IP address used by Nova metadata server. | -
| nova_metadata_port = 8775 | -(IntOpt) TCP Port used by Nova metadata server. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| meta_flavor_driver_mappings = None | +(StrOpt) Mapping between flavor and LinuxInterfaceDriver | +
| metadata_backlog = 4096 | +(IntOpt) Number of backlog requests to configure the metadata server socket with | +
| metadata_port = 9697 | +(IntOpt) TCP Port used by Neutron metadata namespace proxy. | +
| metadata_proxy_shared_secret = | +(StrOpt) Shared secret to sign instance-id request | +
| metadata_proxy_socket = $state_path/metadata_proxy | +(StrOpt) Location of Metadata Proxy UNIX domain socket | +
| metadata_workers = 2 | +(IntOpt) Number of separate worker processes for metadata server | +
| nova_metadata_insecure = False | +(BoolOpt) Allow to perform insecure SSL (https) requests to nova metadata | +
| nova_metadata_ip = 127.0.0.1 | +(StrOpt) IP address used by Nova metadata server. | +
| nova_metadata_port = 8775 | +(IntOpt) TCP Port used by Nova metadata server. | +
| nova_metadata_protocol = http | +(StrOpt) Protocol to access nova metadata, http or https | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| driver = neutron.services.metering.drivers.noop.noop_driver.NoopMeteringDriver | -(StrOpt) Metering driver | -
| measure_interval = 30 | -(IntOpt) Interval between two metering measures | -
| [AGENT] | -|
| report_interval = 30 | -(FloatOpt) Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| driver = neutron.services.metering.drivers.noop.noop_driver.NoopMeteringDriver | +(StrOpt) Metering driver | +
| measure_interval = 30 | +(IntOpt) Interval between two metering measures | +
| [AGENT] | +|
| report_interval = 30 | +(FloatOpt) Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time. | +
| Configuration option = Default value | -Description | -
|---|---|
| [MIDONET] | -|
| midonet_host_uuid_path = /etc/midolman/host_uuid.properties | -(StrOpt) Path to midonet host uuid file | -
| midonet_uri = http://localhost:8080/midonet-api | -(StrOpt) MidoNet API server URI. | -
| mode = dev | -(StrOpt) Operational mode. Internal dev use only. | -
| password = passw0rd | -(StrOpt) MidoNet admin password. | -
| project_id = 77777777-7777-7777-7777-777777777777 | -(StrOpt) ID of the project that MidoNet admin userbelongs to. | -
| provider_router_id = None | -(StrOpt) Virtual provider router ID. | -
| username = admin | -(StrOpt) MidoNet admin username. | -
| Configuration option = Default value | +Description | +
|---|---|
| [MIDONET] | +|
| midonet_host_uuid_path = /etc/midolman/host_uuid.properties | +(StrOpt) Path to midonet host uuid file | +
| midonet_uri = http://localhost:8080/midonet-api | +(StrOpt) MidoNet API server URI. | +
| mode = dev | +(StrOpt) Operational mode. Internal dev use only. | +
| password = passw0rd | +(StrOpt) MidoNet admin password. | +
| project_id = 77777777-7777-7777-7777-777777777777 | +(StrOpt) ID of the project that MidoNet admin userbelongs to. | +
| provider_router_id = None | +(StrOpt) Virtual provider router ID. | +
| username = admin | +(StrOpt) MidoNet admin username. | +
| Configuration option = Default value | -Description | -
|---|---|
| [ml2] | -|
| mechanism_drivers = | -(ListOpt) An ordered list of networking mechanism driver entrypoints to be loaded from the neutron.ml2.mechanism_drivers namespace. | -
| tenant_network_types = local | -(ListOpt) Ordered list of network_types to allocate as tenant networks. | -
| type_drivers = local, flat, vlan, gre, vxlan | -(ListOpt) List of network type driver entrypoints to be loaded from the neutron.ml2.type_drivers namespace. | -
| Configuration option = Default value | +Description | +
|---|---|
| [ml2] | +|
| mechanism_drivers = | +(ListOpt) An ordered list of networking mechanism driver entrypoints to be loaded from the neutron.ml2.mechanism_drivers namespace. | +
| tenant_network_types = local | +(ListOpt) Ordered list of network_types to allocate as tenant networks. | +
| type_drivers = local, flat, vlan, gre, vxlan | +(ListOpt) List of network type driver entrypoints to be loaded from the neutron.ml2.type_drivers namespace. | +
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_arista] | -|
| eapi_host = | -(StrOpt) Arista EOS IP address. This is required field.If not set, all communications to Arista EOSwill fail | -
| eapi_password = | -(StrOpt) Password for Arista EOS. This is required field.if not set, all communications to Arista EOSwill fail | -
| eapi_username = | -(StrOpt) Username for Arista EOS. This is required field.if not set, all communications to Arista EOSwill fail | -
| region_name = RegionOne | -(StrOpt) Defines Region Name that is assigned to this OpenStackController. This is useful when multipleOpenStack/Neutron controllers are managing the sameArista HW clusters. Note that this name must match withthe region name registered (or known) to keystoneservice. Authentication with Keysotne is performed byEOS. This is optional. If not set, a value of"RegionOne" is assumed | -
| sync_interval = 180 | -(IntOpt) Sync interval in seconds between Neutron plugin andEOS. This interval defines how often thesynchronization is performed. This is an optionalfield. If not set, a value of 180 seconds is assumed | -
| use_fqdn = True | -(BoolOpt) Defines if hostnames are sent to Arista EOS as FQDNs("node1.domain.com") or as short names ("node1").This is optional. If not set, a value of "True"is assumed. | -
| Configuration option = Default value | +Description | +
|---|---|
| [ml2_arista] | +|
| eapi_host = | +(StrOpt) Arista EOS IP address. This is required field. If not set, all communications to Arista EOSwill fail. | +
| eapi_password = | +(StrOpt) Password for Arista EOS. This is required field. If not set, all communications to Arista EOS will fail. | +
| eapi_username = | +(StrOpt) Username for Arista EOS. This is required field. If not set, all communications to Arista EOSwill fail. | +
| region_name = RegionOne | +(StrOpt) Defines Region Name that is assigned to this OpenStack Controller. This is useful when multiple OpenStack/Neutron controllers are managing the same Arista HW clusters. Note that this name must match with the region name registered (or known) to keystone service. Authentication with Keysotne is performed by EOS. This is optional. If not set, a value of "RegionOne" is assumed. | +
| sync_interval = 180 | +(IntOpt) Sync interval in seconds between Neutron plugin and EOS. This interval defines how often the synchronization is performed. This is an optional field. If not set, a value of 180 seconds is assumed. | +
| use_fqdn = True | +(BoolOpt) Defines if hostnames are sent to Arista EOS as FQDNs ("node1.domain.com") or as short names ("node1"). This is optional. If not set, a value of "True" is assumed. | +
| Configuration option = Default value | -Description | -
|---|---|
| [NOVA] | -|
| node_override_vif_802.1qbg = | -(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbg | -
| node_override_vif_802.1qbh = | -(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbh | -
| node_override_vif_binding_failed = | -(ListOpt) Nova compute nodes to manually set VIF type to binding_failed | -
| node_override_vif_bridge = | -(ListOpt) Nova compute nodes to manually set VIF type to bridge | -
| node_override_vif_hostdev = | -(ListOpt) Nova compute nodes to manually set VIF type to hostdev | -
| node_override_vif_hyperv = | -(ListOpt) Nova compute nodes to manually set VIF type to hyperv | -
| node_override_vif_ivs = | -(ListOpt) Nova compute nodes to manually set VIF type to ivs | -
| node_override_vif_midonet = | -(ListOpt) Nova compute nodes to manually set VIF type to midonet | -
| node_override_vif_mlnx_direct = | -(ListOpt) Nova compute nodes to manually set VIF type to mlnx_direct | -
| node_override_vif_other = | -(ListOpt) Nova compute nodes to manually set VIF type to other | -
| node_override_vif_ovs = | -(ListOpt) Nova compute nodes to manually set VIF type to ovs | -
| node_override_vif_unbound = | -(ListOpt) Nova compute nodes to manually set VIF type to unbound | -
| vif_type = ovs | -(StrOpt) Virtual interface type to configure on Nova compute nodes | -
| vif_types = unbound, binding_failed, ovs, ivs, bridge, 802.1qbg, 802.1qbh, hyperv, midonet, mlnx_direct, hostdev, other | -(ListOpt) List of allowed vif_type values. | -
| [RESTPROXY] | -|
| add_meta_server_route = True | -(BoolOpt) Flag to decide if a route to the metadata server should be injected into the VM | -
| auto_sync_on_failure = True | -(BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, the plugin automatically triggers a full data synchronization to the controller. | -
| cache_connections = True | -(BoolOpt) Re-use HTTP/HTTPS connections to the controller. | -
| consistency_interval = 60 | -(IntOpt) Time between verifications that the backend controller database is consistent with Neutron | -
| neutron_id = neutron-oslo | -(StrOpt) User defined identifier for this Neutron deployment | -
| no_ssl_validation = False | -(BoolOpt) Disables SSL certificate validation for controllers | -
| server_auth = None | -(StrOpt) The username and password for authenticating against the Big Switch or Floodlight controller. | -
| server_ssl = True | -(BoolOpt) If True, Use SSL when connecting to the Big Switch or Floodlight controller. | -
| server_timeout = 10 | -(IntOpt) Maximum number of seconds to wait for proxy request to connect and complete. | -
| servers = localhost:8800 | -(ListOpt) A comma separated list of Big Switch or Floodlight servers and port numbers. The plugin proxies the requests to the Big Switch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover. | -
| ssl_cert_directory = /etc/neutron/plugins/bigswitch/ssl | -(StrOpt) Directory containing ca_certs and host_certs certificate directories. | -
| ssl_sticky = True | -(BoolOpt) Trust and store the first certificate received for each controller address and use it to validate future connections to that address. | -
| sync_data = False | -(BoolOpt) Sync data on connect | -
| thread_pool_size = 4 | -(IntOpt) Maximum number of threads to spawn to handle large volumes of port creations. | -
| [RESTPROXYAGENT] | -|
| integration_bridge = br-int | -(StrOpt) Name of integration bridge on compute nodes used for security group insertion. | -
| polling_interval = 5 | -(IntOpt) Seconds between agent checks for port changes | -
| virtual_switch_type = ovs | -(StrOpt) Virtual switch type. | -
| [ROUTER] | -|
| max_router_rules = 200 | -(IntOpt) Maximum number of router rules | -
| tenant_default_router_rule = ['*:any:any:permit'] | -(MultiStrOpt) The default router rules installed in new tenant routers. Repeat the config option for each rule. Format is <tenant>:<source>:<destination>:<action> Use an * to specify default for all tenants. | -
| Configuration option = Default value | +Description | +
|---|---|
| [NOVA] | +|
| node_override_vif_802.1qbg = | +(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbg | +
| node_override_vif_802.1qbh = | +(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbh | +
| node_override_vif_binding_failed = | +(ListOpt) Nova compute nodes to manually set VIF type to binding_failed | +
| node_override_vif_bridge = | +(ListOpt) Nova compute nodes to manually set VIF type to bridge | +
| node_override_vif_hostdev = | +(ListOpt) Nova compute nodes to manually set VIF type to hostdev | +
| node_override_vif_hyperv = | +(ListOpt) Nova compute nodes to manually set VIF type to hyperv | +
| node_override_vif_ivs = | +(ListOpt) Nova compute nodes to manually set VIF type to ivs | +
| node_override_vif_midonet = | +(ListOpt) Nova compute nodes to manually set VIF type to midonet | +
| node_override_vif_mlnx_direct = | +(ListOpt) Nova compute nodes to manually set VIF type to mlnx_direct | +
| node_override_vif_other = | +(ListOpt) Nova compute nodes to manually set VIF type to other | +
| node_override_vif_ovs = | +(ListOpt) Nova compute nodes to manually set VIF type to ovs | +
| node_override_vif_unbound = | +(ListOpt) Nova compute nodes to manually set VIF type to unbound | +
| vif_type = ovs | +(StrOpt) Virtual interface type to configure on Nova compute nodes | +
| vif_types = unbound, binding_failed, ovs, ivs, bridge, 802.1qbg, 802.1qbh, hyperv, midonet, mlnx_direct, hostdev, other | +(ListOpt) List of allowed vif_type values. | +
| [RESTPROXY] | +|
| add_meta_server_route = True | +(BoolOpt) Flag to decide if a route to the metadata server should be injected into the VM | +
| auto_sync_on_failure = True | +(BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, the plugin automatically triggers a full data synchronization to the controller. | +
| cache_connections = True | +(BoolOpt) Re-use HTTP/HTTPS connections to the controller. | +
| consistency_interval = 60 | +(IntOpt) Time between verifications that the backend controller database is consistent with Neutron. (0 to disable) | +
| neutron_id = neutron-oslo | +(StrOpt) User defined identifier for this Neutron deployment | +
| no_ssl_validation = False | +(BoolOpt) Disables SSL certificate validation for controllers | +
| server_auth = None | +(StrOpt) The username and password for authenticating against the Big Switch or Floodlight controller. | +
| server_ssl = True | +(BoolOpt) If True, Use SSL when connecting to the Big Switch or Floodlight controller. | +
| server_timeout = 10 | +(IntOpt) Maximum number of seconds to wait for proxy request to connect and complete. | +
| servers = localhost:8800 | +(ListOpt) A comma separated list of Big Switch or Floodlight servers and port numbers. The plugin proxies the requests to the Big Switch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover. | +
| ssl_cert_directory = /etc/neutron/plugins/bigswitch/ssl | +(StrOpt) Directory containing ca_certs and host_certs certificate directories. | +
| ssl_sticky = True | +(BoolOpt) Trust and store the first certificate received for each controller address and use it to validate future connections to that address. | +
| sync_data = False | +(BoolOpt) Sync data on connect | +
| thread_pool_size = 4 | +(IntOpt) Maximum number of threads to spawn to handle large volumes of port creations. | +
| [RESTPROXYAGENT] | +|
| integration_bridge = br-int | +(StrOpt) Name of integration bridge on compute nodes used for security group insertion. | +
| polling_interval = 5 | +(IntOpt) Seconds between agent checks for port changes | +
| virtual_switch_type = ovs | +(StrOpt) Virtual switch type. | +
| [ROUTER] | +|
| max_router_rules = 200 | +(IntOpt) Maximum number of router rules | +
| tenant_default_router_rule = ['*:any:any:permit'] | +(MultiStrOpt) The default router rules installed in new tenant routers. Repeat the config option for each rule. Format is <tenant>:<source>:<destination>:<action> Use an * to specify default for all tenants. | +
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_brocade] | -|
| address = | -(StrOpt) The address of the host to SSH to | -
| ostype = NOS | -(StrOpt) Unused | -
| password = password | -(StrOpt) The SSH password to use | -
| physical_networks = | -(StrOpt) Allowed physical networks | -
| username = admin | -(StrOpt) The SSH username to use | -
| Configuration option = Default value | +Description | +
|---|---|
| [ml2_brocade] | +|
| address = | +(StrOpt) The address of the host to SSH to | +
| ostype = NOS | +(StrOpt) Unused | +
| password = password | +(StrOpt) The SSH password to use | +
| physical_networks = | +(StrOpt) Allowed physical networks | +
| username = admin | +(StrOpt) The SSH username to use | +
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_cisco] | -|
| managed_physical_network = None | -(StrOpt) The physical network managed by the switches. | -
| Configuration option = Default value | +Description | +
|---|---|
| [ml2_cisco] | +|
| managed_physical_network = None | +(StrOpt) The physical network managed by the switches. | +
| Configuration option = Default value | +Description | +
|---|---|
| [ml2_cisco_apic] | +|
| apic_clear_node_profiles = False | +(BoolOpt) Clear the node profiles on the APIC at startup (mainly used for testing) | +
| apic_entity_profile = openstack_entity | +(StrOpt) Name of the entity profile to be created | +
| apic_function_profile = openstack_function | +(StrOpt) Name of the function profile to be created | +
| apic_host = None | +(StrOpt) Host name or IP Address of the APIC controller | +
| apic_node_profile = openstack_profile | +(StrOpt) Name of the node profile to be created | +
| apic_password = None | +(StrOpt) Password for the APIC controller | +
| apic_port = None | +(StrOpt) Communication port for the APIC controller | +
| apic_username = None | +(StrOpt) Username for the APIC controller | +
| apic_vlan_ns_name = openstack_ns | +(StrOpt) Name for the vlan namespace to be used for openstack | +
| apic_vlan_range = 2:4093 | +(StrOpt) Range of VLAN's to be used for Openstack | +
| apic_vmm_domain = openstack | +(StrOpt) Name for the VMM domain to be created for Openstack | +
| apic_vmm_provider = VMware | +(StrOpt) Name for the VMM domain provider | +
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_type_flat] | -|
| flat_networks = | -(ListOpt) List of physical_network names with which flat networks can be created. Use * to allow flat networks with arbitrary physical_network names. | -
| Configuration option = Default value | +Description | +
|---|---|
| [ml2_type_flat] | +|
| flat_networks = | +(ListOpt) List of physical_network names with which flat networks can be created. Use * to allow flat networks with arbitrary physical_network names. | +
| Configuration option = Default value | +Description | +
|---|---|
| [ml2_fslsdn] | +|
| crd_api_insecure = False | +(BoolOpt) If set, ignore any SSL validation issues | +
| crd_auth_strategy = keystone | +(StrOpt) Auth strategy for connecting to neutron in admin context | +
| crd_auth_url = http://127.0.0.1:5000/v2.0/ | +(StrOpt) CRD Auth URL | +
| crd_ca_certificates_file = None | +(StrOpt) Location of ca certificates file to use for CRD client requests. | +
| crd_password = password | +(StrOpt) CRD Service Password | +
| crd_region_name = RegionOne | +(StrOpt) Region name for connecting to CRD Service in admin context | +
| crd_tenant_name = service | +(StrOpt) CRD Tenant Name | +
| crd_url = http://127.0.0.1:9797 | +(StrOpt) URL for connecting to CRD service | +
| crd_url_timeout = 30 | +(IntOpt) Timeout value for connecting to CRD service in seconds | +
| crd_user_name = crd | +(StrOpt) CRD service Username | +
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_type_gre] | -|
| tunnel_id_ranges = | -(ListOpt) Comma-separated list of <tun_min>:<tun_max> tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation | -
| Configuration option = Default value | +Description | +
|---|---|
| [ml2_type_gre] | +|
| tunnel_id_ranges = | +(ListOpt) Comma-separated list of <tun_min>:<tun_max> tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation | +
| Configuration option = Default value | -Description | -
|---|---|
| [l2pop] | -|
| agent_boot_time = 180 | -(IntOpt) Delay within which agent is expected to update existing ports whent it restarts | -
| Configuration option = Default value | +Description | +
|---|---|
| [l2pop] | +|
| agent_boot_time = 180 | +(IntOpt) Delay within which agent is expected to update existing ports whent it restarts | +
| Configuration option = Default value | -Description | -
|---|---|
| [ESWITCH] | -|
| apply_profile_patch = False | -(BoolOpt) Enable server compatibility with old nova | -
| vnic_type = mlnx_direct | -(StrOpt) Type of VM network interface: mlnx_direct or hostdev | -
| Configuration option = Default value | +Description | +
|---|---|
| [ESWITCH] | +|
| apply_profile_patch = False | +(BoolOpt) Enable server compatibility with old nova | +
| vnic_type = mlnx_direct | +(StrOpt) Type of VM network interface: mlnx_direct or hostdev | +
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_ncs] | -|
| password = None | -(StrOpt) HTTP password for authentication | -
| timeout = 10 | -(IntOpt) HTTP timeout in seconds. | -
| url = None | -(StrOpt) HTTP URL of Tail-f NCS REST interface. | -
| username = None | -(StrOpt) HTTP username for authentication | -
| Configuration option = Default value | +Description | +
|---|---|
| [ml2_ncs] | +|
| password = None | +(StrOpt) HTTP password for authentication | +
| timeout = 10 | +(IntOpt) HTTP timeout in seconds. | +
| url = None | +(StrOpt) HTTP URL of Tail-f NCS REST interface. | +
| username = None | +(StrOpt) HTTP username for authentication | +
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_odl] | -|
| password = None | -(StrOpt) HTTP password for authentication | -
| session_timeout = 30 | -(IntOpt) Tomcat session timeout in minutes. | -
| timeout = 10 | -(IntOpt) HTTP timeout in seconds. | -
| url = None | -(StrOpt) HTTP URL of OpenDaylight REST interface. | -
| username = None | -(StrOpt) HTTP username for authentication | -
| Configuration option = Default value | +Description | +
|---|---|
| [ml2_odl] | +|
| password = None | +(StrOpt) HTTP password for authentication | +
| session_timeout = 30 | +(IntOpt) Tomcat session timeout in minutes. | +
| timeout = 10 | +(IntOpt) HTTP timeout in seconds. | +
| url = None | +(StrOpt) HTTP URL of OpenDaylight REST interface. | +
| username = None | +(StrOpt) HTTP username for authentication | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| ofp_listen_host = | -(StrOpt) openflow listen host | -
| ofp_ssl_listen_port = 6633 | -(IntOpt) openflow ssl listen port | -
| ofp_tcp_listen_port = 6633 | -(IntOpt) openflow tcp listen port | -
| [AGENT] | -|
| get_datapath_retry_times = 60 | -(IntOpt) Number of seconds to retry acquiring an Open vSwitch datapath | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| ofp_listen_host = | +(StrOpt) openflow listen host | +
| ofp_ssl_listen_port = 6633 | +(IntOpt) openflow ssl listen port | +
| ofp_tcp_listen_port = 6633 | +(IntOpt) openflow tcp listen port | +
| [AGENT] | +|
| dont_fragment = True | +(BoolOpt) Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel | +
| get_datapath_retry_times = 60 | +(IntOpt) Number of seconds to retry acquiring an Open vSwitch datapath | +
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_type_vlan] | -|
| network_vlan_ranges = | -(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks. | -
| Configuration option = Default value | +Description | +
|---|---|
| [ml2_type_vlan] | +|
| network_vlan_ranges = | +(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks. | +
| Configuration option = Default value | -Description | -
|---|---|
| [ml2_type_vxlan] | -|
| vni_ranges = | -(ListOpt) Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation | -
| vxlan_group = None | -(StrOpt) Multicast group for VXLAN. If unset, disables VXLAN multicast mode. | -
| Configuration option = Default value | +Description | +
|---|---|
| [ml2_type_vxlan] | +|
| vni_ranges = | +(ListOpt) Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation | +
| vxlan_group = None | +(StrOpt) Multicast group for VXLAN. If unset, disables VXLAN multicast mode. | +
| Configuration option = Default value | -Description | -
|---|---|
| [ESWITCH] | -|
| backoff_rate = 2 | -(IntOpt) backoff rate multiplier for waiting period between retries for request to daemon, i.e. value of 2 will double the request timeout each retry | -
| daemon_endpoint = tcp://127.0.0.1:60001 | -(StrOpt) eswitch daemon end point | -
| physical_interface_mappings = | -(ListOpt) List of <physical_network>:<physical_interface> | -
| request_timeout = 3000 | -(IntOpt) The number of milliseconds the agent will wait for response on request to daemon. | -
| [MLNX] | -|
| network_vlan_ranges = default:1:1000 | -(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> | -
| physical_network_type = eth | -(StrOpt) Physical network type for provider network (eth or ib) | -
| physical_network_type_mappings = | -(ListOpt) List of <physical_network>:<physical_network_type> with physical_network_type is either eth or ib | -
| tenant_network_type = vlan | -(StrOpt) Network type for tenant networks (local, vlan, or none) | -
| Configuration option = Default value | +Description | +
|---|---|
| [ESWITCH] | +|
| backoff_rate = 2 | +(IntOpt) backoff rate multiplier for waiting period between retries for request to daemon, i.e. value of 2 will double the request timeout each retry | +
| daemon_endpoint = tcp://127.0.0.1:60001 | +(StrOpt) eswitch daemon end point | +
| physical_interface_mappings = | +(ListOpt) List of <physical_network>:<physical_interface> | +
| request_timeout = 3000 | +(IntOpt) The number of milliseconds the agent will wait for response on request to daemon. | +
| [MLNX] | +|
| network_vlan_ranges = default:1:1000 | +(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> | +
| physical_network_type = eth | +(StrOpt) Physical network type for provider network (eth or ib) | +
| physical_network_type_mappings = | +(ListOpt) List of <physical_network>:<physical_network_type> with physical_network_type is either eth or ib | +
| tenant_network_type = vlan | +(StrOpt) Network type for tenant networks (local, vlan, or none) | +
| Configuration option = Default value | -Description | -
|---|---|
| [OFC] | -|
| api_max_attempts = 3 | -(IntOpt) Maximum attempts per OFC API request.NEC plugin retries API request to OFC when OFC returns ServiceUnavailable (503).The value must be greater than 0. | -
| cert_file = None | -(StrOpt) Certificate file | -
| driver = trema | -(StrOpt) Driver to use | -
| enable_packet_filter = True | -(BoolOpt) Enable packet filter | -
| host = 127.0.0.1 | -(StrOpt) Host to connect to | -
| insecure_ssl = False | -(BoolOpt) Disable SSL certificate verification | -
| key_file = None | -(StrOpt) Key file | -
| path_prefix = | -(StrOpt) Base URL of OFC REST API. It is prepended to each API request. | -
| port = 8888 | -(StrOpt) Port to connect to | -
| use_ssl = False | -(BoolOpt) Use SSL to connect | -
| [PROVIDER] | -|
| default_router_provider = l3-agent | -(StrOpt) Default router provider to use. | -
| router_providers = l3-agent, openflow | -(ListOpt) List of enabled router providers. | -
| [fwaas] | -|
| driver = | -(StrOpt) Name of the FWaaS Driver | -
| Configuration option = Default value | +Description | +
|---|---|
| [OFC] | +|
| api_max_attempts = 3 | +(IntOpt) Maximum attempts per OFC API request.NEC plugin retries API request to OFC when OFC returns ServiceUnavailable (503).The value must be greater than 0. | +
| cert_file = None | +(StrOpt) Certificate file | +
| driver = trema | +(StrOpt) Driver to use | +
| enable_packet_filter = True | +(BoolOpt) Enable packet filter | +
| host = 127.0.0.1 | +(StrOpt) Host to connect to | +
| insecure_ssl = False | +(BoolOpt) Disable SSL certificate verification | +
| key_file = None | +(StrOpt) Key file | +
| path_prefix = | +(StrOpt) Base URL of OFC REST API. It is prepended to each API request. | +
| port = 8888 | +(StrOpt) Port to connect to | +
| use_ssl = False | +(BoolOpt) Use SSL to connect | +
| [PROVIDER] | +|
| default_router_provider = l3-agent | +(StrOpt) Default router provider to use. | +
| router_providers = l3-agent, openflow | +(ListOpt) List of enabled router providers. | +
| [fwaas] | +|
| driver = | +(StrOpt) Name of the FWaaS Driver | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| default_notification_level = INFO | -(StrOpt) Default notification level for outgoing notifications | -
| default_publisher_id = $host | -(StrOpt) Default publisher_id for outgoing notifications | -
| notification_driver = [] | -(MultiStrOpt) Driver or drivers to handle sending notifications | -
| notification_topics = notifications | -(ListOpt) AMQP topic used for openstack notifications | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| notification_driver = [] | +(MultiStrOpt) Driver or drivers to handle sending notifications. | +
| notification_topics = notifications | +(ListOpt) AMQP topic used for OpenStack notifications. | +
| Configuration option = Default value | -Description | -
|---|---|
| [RESTPROXY] | -|
| auth_resource = | -(StrOpt) Nuage provided uri for initial authorization to access VSD | -
| base_uri = / | -(StrOpt) Nuage provided base uri to reach out to VSD | -
| default_floatingip_quota = 254 | -(IntOpt) Per Net Partition quota of floating ips | -
| default_net_partition_name = OpenStackDefaultNetPartition | -(StrOpt) Default Network partition in which VSD will orchestrate network resources using openstack | -
| organization = system | -(StrOpt) Organization name in which VSD will orchestrate network resources using openstack | -
| server = localhost:8800 | -(StrOpt) IP Address and Port of Nuage's VSD server | -
| serverauth = username:password | -(StrOpt) Username and password for authentication | -
| serverssl = False | -(BoolOpt) Boolean for SSL connection with VSD server | -
| Configuration option = Default value | +Description | +
|---|---|
| [RESTPROXY] | +|
| auth_resource = | +(StrOpt) Nuage provided uri for initial authorization to access VSD | +
| base_uri = / | +(StrOpt) Nuage provided base uri to reach out to VSD | +
| default_floatingip_quota = 254 | +(IntOpt) Per Net Partition quota of floating ips | +
| default_net_partition_name = OpenStackDefaultNetPartition | +(StrOpt) Default Network partition in which VSD will orchestrate network resources using openstack | +
| organization = system | +(StrOpt) Organization name in which VSD will orchestrate network resources using openstack | +
| server = localhost:8800 | +(StrOpt) IP Address and Port of Nuage's VSD server | +
| serverauth = username:password | +(StrOpt) Username and password for authentication | +
| serverssl = False | +(BoolOpt) Boolean for SSL connection with VSD server | +
| Configuration option = Default value | -Description | -
|---|---|
| [AGENT] | -|
| integration_bridge = br-int | -(StrOpt) integration bridge | -
| [nvsd] | -|
| nvsd_ip = 127.0.0.1 | -(StrOpt) NVSD Controller IP address | -
| nvsd_passwd = oc123 | -(StrOpt) NVSD Controller password | -
| nvsd_port = 8082 | -(IntOpt) NVSD Controller Port number | -
| nvsd_retries = 0 | -(IntOpt) Number of login retries to NVSD controller | -
| nvsd_user = ocplugin | -(StrOpt) NVSD Controller username | -
| request_timeout = 30 | -(IntOpt) NVSD controller REST API request timeout in seconds | -
| Configuration option = Default value | +Description | +
|---|---|
| [AGENT] | +|
| integration_bridge = br-int | +(StrOpt) integration bridge | +
| [nvsd] | +|
| nvsd_ip = 127.0.0.1 | +(StrOpt) NVSD Controller IP address | +
| nvsd_passwd = oc123 | +(StrOpt) NVSD Controller password | +
| nvsd_port = 8082 | +(IntOpt) NVSD Controller Port number | +
| nvsd_retries = 0 | +(IntOpt) Number of login retries to NVSD controller | +
| nvsd_user = ocplugin | +(StrOpt) NVSD Controller username | +
| request_timeout = 30 | +(IntOpt) NVSD controller REST API request timeout in seconds | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| ovs_integration_bridge = br-int | -(StrOpt) Name of Open vSwitch bridge to use | -
| ovs_use_veth = False | -(BoolOpt) Uses veth for an interface or not | -
| ovs_vsctl_timeout = 10 | -(IntOpt) Timeout in seconds for ovs-vsctl commands | -
| [AGENT] | -|
| l2_population = False | -(BoolOpt) Use ml2 l2population mechanism driver to learn remote mac and IPs and improve tunnel scalability | -
| minimize_polling = True | -(BoolOpt) Minimize polling by monitoring ovsdb for interface changes. | -
| ovsdb_monitor_respawn_interval = 30 | -(IntOpt) The number of seconds to wait before respawning the ovsdb monitor after losing communication with it | -
| tunnel_types = | -(ListOpt) Network types supported by the agent (gre and/or vxlan) | -
| veth_mtu = None | -(IntOpt) MTU size of veth interfaces | -
| vxlan_udp_port = 4789 | -(IntOpt) The UDP port to use for VXLAN tunnels. | -
| [CISCO_N1K] | -|
| local_ip = 10.0.0.3 | -(StrOpt) N1K Local IP | -
| [OVS] | -|
| bridge_mappings = | -(ListOpt) List of <physical_network>:<bridge> | -
| enable_tunneling = False | -(BoolOpt) Enable tunneling support | -
| int_peer_patch_port = patch-tun | -(StrOpt) Peer patch port in integration bridge for tunnel bridge | -
| integration_bridge = br-int | -(StrOpt) Integration bridge to use | -
| local_ip = | -(StrOpt) Local IP address of GRE tunnel endpoints. | -
| network_vlan_ranges = | -(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> | -
| tenant_network_type = local | -(StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none) | -
| tun_peer_patch_port = patch-int | -(StrOpt) Peer patch port in tunnel bridge for integration bridge | -
| tunnel_bridge = br-tun | -(StrOpt) Tunnel bridge to use | -
| tunnel_id_ranges = | -(ListOpt) List of <tun_min>:<tun_max> | -
| tunnel_type = | -(StrOpt) The type of tunnels to use when utilizing tunnels, either 'gre' or 'vxlan' | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| ovs_integration_bridge = br-int | +(StrOpt) Name of Open vSwitch bridge to use | +
| ovs_use_veth = False | +(BoolOpt) Uses veth for an interface or not | +
| ovs_vsctl_timeout = 10 | +(IntOpt) Timeout in seconds for ovs-vsctl commands | +
| [AGENT] | +|
| arp_responder = False | +(BoolOpt) Enable local ARP responder if it is supported | +
| dont_fragment = True | +(BoolOpt) Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel | +
| l2_population = False | +(BoolOpt) Use ml2 l2population mechanism driver to learn remote mac and IPs and improve tunnel scalability | +
| minimize_polling = True | +(BoolOpt) Minimize polling by monitoring ovsdb for interface changes. | +
| ovsdb_monitor_respawn_interval = 30 | +(IntOpt) The number of seconds to wait before respawning the ovsdb monitor after losing communication with it | +
| tunnel_types = | +(ListOpt) Network types supported by the agent (gre and/or vxlan) | +
| veth_mtu = None | +(IntOpt) MTU size of veth interfaces | +
| vxlan_udp_port = 4789 | +(IntOpt) The UDP port to use for VXLAN tunnels. | +
| [CISCO_N1K] | +|
| local_ip = 10.0.0.3 | +(StrOpt) N1K Local IP | +
| [OVS] | +|
| bridge_mappings = | +(ListOpt) List of <physical_network>:<bridge> | +
| enable_tunneling = False | +(BoolOpt) Enable tunneling support | +
| int_peer_patch_port = patch-tun | +(StrOpt) Peer patch port in integration bridge for tunnel bridge | +
| integration_bridge = br-int | +(StrOpt) Integration bridge to use | +
| local_ip = | +(StrOpt) Local IP address of GRE tunnel endpoints. | +
| network_vlan_ranges = | +(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> | +
| tenant_network_type = local | +(StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none) | +
| tun_peer_patch_port = patch-int | +(StrOpt) Peer patch port in tunnel bridge for integration bridge | +
| tunnel_bridge = br-tun | +(StrOpt) Tunnel bridge to use | +
| tunnel_id_ranges = | +(ListOpt) List of <tun_min>:<tun_max> | +
| tunnel_type = | +(StrOpt) The type of tunnels to use when utilizing tunnels, either 'gre' or 'vxlan' | +
| use_veth_interconnection = False | +(BoolOpt) Use veths instead of patch ports to interconnect the integration bridge to physical bridges | +
| Configuration option = Default value | -Description | -
|---|---|
| [plumgriddirector] | -|
| director_server = localhost | -(StrOpt) PLUMgrid Director server to connect to | -
| director_server_port = 8080 | -(StrOpt) PLUMgrid Director server port to connect to | -
| password = password | -(StrOpt) PLUMgrid Director admin password | -
| servertimeout = 5 | -(IntOpt) PLUMgrid Director server timeout | -
| username = username | -(StrOpt) PLUMgrid Director admin username | -
| Configuration option = Default value | +Description | +
|---|---|
| [plumgriddirector] | +|
| director_server = localhost | +(StrOpt) PLUMgrid Director server to connect to | +
| director_server_port = 8080 | +(StrOpt) PLUMgrid Director server port to connect to | +
| driver = neutron.plugins.plumgrid.drivers.plumlib.Plumlib | +(StrOpt) PLUMgrid Driver | +
| password = password | +(StrOpt) PLUMgrid Director admin password | +
| servertimeout = 5 | +(IntOpt) PLUMgrid Director server timeout | +
| username = username | +(StrOpt) PLUMgrid Director admin username | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| allow_overlapping_ips = False | -(BoolOpt) Allow overlapping IP support in Neutron | -
| policy_file = policy.json | -(StrOpt) The policy file to use | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| allow_overlapping_ips = False | +(BoolOpt) Allow overlapping IP support in Neutron | +
| policy_file = policy.json | +(StrOpt) The policy file to use | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| qpid_heartbeat = 60 | -(IntOpt) Seconds between connection keepalive heartbeats | -
| qpid_hostname = localhost | -(StrOpt) Qpid broker hostname | -
| qpid_hosts = $qpid_hostname:$qpid_port | -(ListOpt) Qpid HA cluster host:port pairs | -
| qpid_password = | -(StrOpt) Password for qpid connection | -
| qpid_port = 5672 | -(IntOpt) Qpid broker port | -
| qpid_protocol = tcp | -(StrOpt) Transport to use, either 'tcp' or 'ssl' | -
| qpid_sasl_mechanisms = | -(StrOpt) Space separated list of SASL mechanisms to use for auth | -
| qpid_tcp_nodelay = True | -(BoolOpt) Disable Nagle algorithm | -
| qpid_topology_version = 1 | -(IntOpt) 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. | -
| qpid_username = | -(StrOpt) Username for qpid connection | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| qpid_heartbeat = 60 | +(IntOpt) Seconds between connection keepalive heartbeats. | +
| qpid_hostname = localhost | +(StrOpt) Qpid broker hostname. | +
| qpid_hosts = $qpid_hostname:$qpid_port | +(ListOpt) Qpid HA cluster host:port pairs. | +
| qpid_password = | +(StrOpt) Password for Qpid connection. | +
| qpid_port = 5672 | +(IntOpt) Qpid broker port. | +
| qpid_protocol = tcp | +(StrOpt) Transport to use, either 'tcp' or 'ssl'. | +
| qpid_sasl_mechanisms = | +(StrOpt) Space separated list of SASL mechanisms to use for auth. | +
| qpid_tcp_nodelay = True | +(BoolOpt) Whether to disable the Nagle algorithm. | +
| qpid_topology_version = 1 | +(IntOpt) 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. | +
| qpid_username = | +(StrOpt) Username for Qpid connection. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| max_routes = 30 | -(IntOpt) Maximum number of routes | -
| [QUOTAS] | -|
| default_quota = -1 | -(IntOpt) Default number of resource allowed per tenant. A negative value means unlimited. | -
| quota_driver = neutron.db.quota_db.DbQuotaDriver | -(StrOpt) Default driver to use for quota checks | -
| quota_firewall = 1 | -(IntOpt) Number of firewalls allowed per tenant. A negative value means unlimited. | -
| quota_firewall_policy = 1 | -(IntOpt) Number of firewall policies allowed per tenant. A negative value means unlimited. | -
| quota_firewall_rule = -1 | -(IntOpt) Number of firewall rules allowed per tenant. A negative value means unlimited. | -
| quota_floatingip = 50 | -(IntOpt) Number of floating IPs allowed per tenant. A negative value means unlimited. | -
| quota_health_monitor = -1 | -(IntOpt) Number of health monitors allowed per tenant. A negative value means unlimited. | -
| quota_items = network, subnet, port | -(ListOpt) Resource name(s) that are supported in quota features | -
| quota_member = -1 | -(IntOpt) Number of pool members allowed per tenant. A negative value means unlimited. | -
| quota_network = 10 | -(IntOpt) Number of networks allowed per tenant.A negative value means unlimited. | -
| quota_network_gateway = 5 | -(IntOpt) Number of network gateways allowed per tenant, -1 for unlimited | -
| quota_packet_filter = 100 | -(IntOpt) Number of packet_filters allowed per tenant, -1 for unlimited | -
| quota_pool = 10 | -(IntOpt) Number of pools allowed per tenant. A negative value means unlimited. | -
| quota_port = 50 | -(IntOpt) Number of ports allowed per tenant. A negative value means unlimited. | -
| quota_router = 10 | -(IntOpt) Number of routers allowed per tenant. A negative value means unlimited. | -
| quota_security_group = 10 | -(IntOpt) Number of security groups allowed per tenant. A negative value means unlimited. | -
| quota_security_group_rule = 100 | -(IntOpt) Number of security rules allowed per tenant. A negative value means unlimited. | -
| quota_subnet = 10 | -(IntOpt) Number of subnets allowed per tenant, A negative value means unlimited. | -
| quota_vip = 10 | -(IntOpt) Number of vips allowed per tenant. A negative value means unlimited. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| max_routes = 30 | +(IntOpt) Maximum number of routes | +
| [QUOTAS] | +|
| default_quota = -1 | +(IntOpt) Default number of resource allowed per tenant. A negative value means unlimited. | +
| quota_driver = neutron.db.quota_db.DbQuotaDriver | +(StrOpt) Default driver to use for quota checks | +
| quota_firewall = 1 | +(IntOpt) Number of firewalls allowed per tenant. A negative value means unlimited. | +
| quota_firewall_policy = 1 | +(IntOpt) Number of firewall policies allowed per tenant. A negative value means unlimited. | +
| quota_firewall_rule = -1 | +(IntOpt) Number of firewall rules allowed per tenant. A negative value means unlimited. | +
| quota_floatingip = 50 | +(IntOpt) Number of floating IPs allowed per tenant. A negative value means unlimited. | +
| quota_health_monitor = -1 | +(IntOpt) Number of health monitors allowed per tenant. A negative value means unlimited. | +
| quota_items = network, subnet, port | +(ListOpt) Resource name(s) that are supported in quota features | +
| quota_member = -1 | +(IntOpt) Number of pool members allowed per tenant. A negative value means unlimited. | +
| quota_network = 10 | +(IntOpt) Number of networks allowed per tenant.A negative value means unlimited. | +
| quota_network_gateway = 5 | +(IntOpt) Number of network gateways allowed per tenant, -1 for unlimited | +
| quota_packet_filter = 100 | +(IntOpt) Number of packet_filters allowed per tenant, -1 for unlimited | +
| quota_pool = 10 | +(IntOpt) Number of pools allowed per tenant. A negative value means unlimited. | +
| quota_port = 50 | +(IntOpt) Number of ports allowed per tenant. A negative value means unlimited. | +
| quota_router = 10 | +(IntOpt) Number of routers allowed per tenant. A negative value means unlimited. | +
| quota_security_group = 10 | +(IntOpt) Number of security groups allowed per tenant. A negative value means unlimited. | +
| quota_security_group_rule = 100 | +(IntOpt) Number of security rules allowed per tenant. A negative value means unlimited. | +
| quota_subnet = 10 | +(IntOpt) Number of subnets allowed per tenant, A negative value means unlimited. | +
| quota_vip = 10 | +(IntOpt) Number of vips allowed per tenant. A negative value means unlimited. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| rabbit_ha_queues = False | -(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| rabbit_host = localhost | -(StrOpt) The RabbitMQ broker address where a single node is used | -
| rabbit_hosts = $rabbit_host:$rabbit_port | -(ListOpt) RabbitMQ HA cluster host:port pairs | -
| rabbit_max_retries = 0 | -(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count) | -
| rabbit_password = guest | -(StrOpt) The RabbitMQ password | -
| rabbit_port = 5672 | -(IntOpt) The RabbitMQ broker port where a single node is used | -
| rabbit_retry_backoff = 2 | -(IntOpt) How long to backoff for between retries when connecting to RabbitMQ | -
| rabbit_retry_interval = 1 | -(IntOpt) How frequently to retry connecting with RabbitMQ | -
| rabbit_use_ssl = False | -(BoolOpt) Connect over SSL for RabbitMQ | -
| rabbit_userid = guest | -(StrOpt) The RabbitMQ userid | -
| rabbit_virtual_host = / | -(StrOpt) The RabbitMQ virtual host | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| kombu_reconnect_delay = 1.0 | +(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | +
| kombu_ssl_ca_certs = | +(StrOpt) SSL certification authority file (valid only if SSL enabled). | +
| kombu_ssl_certfile = | +(StrOpt) SSL cert file (valid only if SSL enabled). | +
| kombu_ssl_keyfile = | +(StrOpt) SSL key file (valid only if SSL enabled). | +
| kombu_ssl_version = | +(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions. | +
| rabbit_ha_queues = False | +(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | +
| rabbit_host = localhost | +(StrOpt) The RabbitMQ broker address where a single node is used. | +
| rabbit_hosts = $rabbit_host:$rabbit_port | +(ListOpt) RabbitMQ HA cluster host:port pairs. | +
| rabbit_login_method = AMQPLAIN | +(StrOpt) the RabbitMQ login method | +
| rabbit_max_retries = 0 | +(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | +
| rabbit_password = guest | +(StrOpt) The RabbitMQ password. | +
| rabbit_port = 5672 | +(IntOpt) The RabbitMQ broker port where a single node is used. | +
| rabbit_retry_backoff = 2 | +(IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | +
| rabbit_retry_interval = 1 | +(IntOpt) How frequently to retry connecting with RabbitMQ. | +
| rabbit_use_ssl = False | +(BoolOpt) Connect over SSL for RabbitMQ. | +
| rabbit_userid = guest | +(StrOpt) The RabbitMQ userid. | +
| rabbit_virtual_host = / | +(StrOpt) The RabbitMQ virtual host. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| host = oslo | -(StrOpt) The hostname Neutron is running on | -
| [matchmaker_redis] | -|
| host = 127.0.0.1 | -(StrOpt) Host to locate redis | -
| password = None | -(StrOpt) Password for Redis server. (optional) | -
| port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| host = oslo | +(StrOpt) The hostname Neutron is running on | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| filters_path = /etc/neutron/rootwrap.d,/usr/share/neutron/rootwrap,/etc/quantum/rootwrap.d,/usr/share/quantum/rootwrap | -List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root ! | -
| exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin | -List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root ! | -
| use_syslog = False | -Enable logging to syslog Default value is False | -
| syslog_log_facility = syslog | -Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog' | -
| syslog_log_level = ERROR | -Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts | -
| [xenapi] | -|
| xenapi_connection_url = <None> | -XenAPI configuration is only required by the L2 agent if it is to target a XenServer/XCP compute host's dom0. | -
| xenapi_connection_username = root | -No help text available for this option. | -
| xenapi_connection_password = <None> | -No help text available for this option. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| filters_path = /etc/neutron/rootwrap.d,/usr/share/neutron/rootwrap | +List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root ! | +
| exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin | +List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root ! | +
| use_syslog = False | +Enable logging to syslog Default value is False | +
| syslog_log_facility = syslog | +Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog' | +
| syslog_log_level = ERROR | +Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts | +
| [xenapi] | +|
| xenapi_connection_url = <None> | +XenAPI configuration is only required by the L2 agent if it is to target a XenServer/XCP compute host's dom0. | +
| xenapi_connection_username = root | +No help text available for this option. | +
| xenapi_connection_password = <None> | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| amqp_auto_delete = False | -(BoolOpt) Auto-delete queues in amqp. | -
| amqp_durable_queues = False | -(BoolOpt) Use durable queues in amqp. | -
| control_exchange = neutron | -(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid | -
| matchmaker_heartbeat_freq = 300 | -(IntOpt) Heartbeat frequency | -
| matchmaker_heartbeat_ttl = 600 | -(IntOpt) Heartbeat time-to-live. | -
| rpc_backend = neutron.openstack.common.rpc.impl_kombu | -(StrOpt) The messaging module to use, defaults to kombu. | -
| rpc_cast_timeout = 30 | -(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool | -
| rpc_response_timeout = 60 | -(IntOpt) Seconds to wait for a response from call or multicall | -
| rpc_thread_pool_size = 64 | -(IntOpt) Size of RPC thread pool | -
| rpc_workers = 0 | -(IntOpt) Number of RPC worker processes for service | -
| [AGENT] | -|
| rpc_support_old_agents = False | -(BoolOpt) Enable server RPC compatibility with old agents | -
| [matchmaker_ring] | -|
| ringfile = /etc/oslo/matchmaker_ring.json | -(StrOpt) Matchmaker ring file (JSON) | -
| [rpc_notifier2] | -|
| topics = notifications | -(ListOpt) AMQP topic(s) used for openstack notifications | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| amqp_auto_delete = False | +(BoolOpt) Auto-delete queues in amqp. | +
| amqp_durable_queues = False | +(BoolOpt) Use durable queues in amqp. | +
| control_exchange = openstack | +(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid | +
| matchmaker_heartbeat_freq = 300 | +(IntOpt) Heartbeat frequency. | +
| matchmaker_heartbeat_ttl = 600 | +(IntOpt) Heartbeat time-to-live. | +
| password = None | +(StrOpt) Password for Redis server (optional). | +
| port = 6379 | +(IntOpt) Use this port to connect to redis host. | +
| rpc_backend = neutron.openstack.common.rpc.impl_kombu | +(StrOpt) The messaging module to use, defaults to kombu. | +
| rpc_cast_timeout = 30 | +(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | +
| rpc_conn_pool_size = 30 | +(IntOpt) Size of RPC connection pool | +
| rpc_response_timeout = 60 | +(IntOpt) Seconds to wait for a response from call or multicall | +
| rpc_thread_pool_size = 64 | +(IntOpt) Size of RPC thread pool | +
| rpc_workers = 0 | +(IntOpt) Number of RPC worker processes for service | +
| transport_url = None | +(StrOpt) 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. | +
| [AGENT] | +|
| rpc_support_old_agents = False | +(BoolOpt) Enable server RPC compatibility with old agents | +
| [matchmaker_ring] | +|
| ringfile = /etc/oslo/matchmaker_ring.json | +(StrOpt) Matchmaker ring file (JSON). | +
| Configuration option = Default value | -Description | -
|---|---|
| [OVS] | -|
| openflow_rest_api = 127.0.0.1:8080 | -(StrOpt) OpenFlow REST API location | -
| ovsdb_interface = None | -(StrOpt) OVSDB interface to connect to | -
| ovsdb_ip = None | -(StrOpt) OVSDB IP to connect to | -
| ovsdb_port = 6634 | -(IntOpt) OVSDB port to connect to | -
| tunnel_interface = None | -(StrOpt) Tunnel interface to use | -
| tunnel_ip = None | -(StrOpt) Tunnel IP to use | -
| tunnel_key_max = 16777215 | -(IntOpt) Maximum tunnel ID to use | -
| tunnel_key_min = 1 | -(IntOpt) Minimum tunnel ID to use | -
| Configuration option = Default value | +Description | +
|---|---|
| [OVS] | +|
| openflow_rest_api = 127.0.0.1:8080 | +(StrOpt) OpenFlow REST API location | +
| ovsdb_interface = None | +(StrOpt) OVSDB interface to connect to | +
| ovsdb_ip = None | +(StrOpt) OVSDB IP to connect to | +
| ovsdb_port = 6634 | +(IntOpt) OVSDB port to connect to | +
| tunnel_interface = None | +(StrOpt) Tunnel interface to use | +
| tunnel_ip = None | +(StrOpt) Tunnel IP to use | +
| tunnel_key_max = 16777215 | +(IntOpt) Maximum tunnel ID to use | +
| tunnel_key_min = 1 | +(IntOpt) Minimum tunnel ID to use | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| network_auto_schedule = True | -(BoolOpt) Allow auto scheduling networks to DHCP agent. | -
| network_scheduler_driver = neutron.scheduler.dhcp_agent_scheduler.ChanceScheduler | -(StrOpt) Driver to use for scheduling network to DHCP agent | -
| router_auto_schedule = True | -(BoolOpt) Allow auto scheduling of routers to L3 agent. | -
| router_delete_namespaces = False | -(BoolOpt) Delete namespace after removing a router. | -
| router_scheduler_driver = neutron.scheduler.l3_agent_scheduler.ChanceScheduler | -(StrOpt) Driver to use for scheduling router to a default L3 agent | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| network_auto_schedule = True | +(BoolOpt) Allow auto scheduling networks to DHCP agent. | +
| network_scheduler_driver = neutron.scheduler.dhcp_agent_scheduler.ChanceScheduler | +(StrOpt) Driver to use for scheduling network to DHCP agent | +
| router_auto_schedule = True | +(BoolOpt) Allow auto scheduling of routers to L3 agent. | +
| router_delete_namespaces = False | +(BoolOpt) Delete namespace after removing a router. | +
| router_scheduler_driver = neutron.scheduler.l3_agent_scheduler.ChanceScheduler | +(StrOpt) Driver to use for scheduling router to a default L3 agent | +
| Configuration option = Default value | -Description | -
|---|---|
| [SDNVE] | -|
| base_url = /one/nb/v2/ | -(StrOpt) Base URL for SDN-VE controller REST API | -
| controller_ips = 127.0.0.1 | -(ListOpt) List of IP addresses of SDN-VE controller(s) | -
| default_tenant_type = OF | -(StrOpt) Tenant type: OF (default) and OVERLAY | -
| format = json | -(StrOpt) SDN-VE request/response format | -
| info = sdnve_info_string | -(StrOpt) SDN-VE RPC subject | -
| integration_bridge = None | -(StrOpt) Integration bridge to use | -
| interface_mappings = | -(ListOpt) List of <physical_network_name>:<interface_name> | -
| of_signature = SDNVE-OF | -(StrOpt) The string in tenant description that indicates the tenant is a OF tenant | -
| out_of_band = True | -(BoolOpt) Indicating if controller is out of band or not | -
| overlay_signature = SDNVE-OVERLAY | -(StrOpt) The string in tenant description that indicates the tenant is a OVERLAY tenant | -
| password = admin | -(StrOpt) SDN-VE administrator password | -
| port = 8443 | -(StrOpt) SDN-VE controller port number | -
| reset_bridge = True | -(BoolOpt) Reset the integration bridge before use | -
| use_fake_controller = False | -(BoolOpt) If set to True uses a fake controller. | -
| userid = admin | -(StrOpt) SDN-VE administrator user id | -
| [SDNVE_AGENT] | -|
| polling_interval = 2 | -(IntOpt) Agent polling interval if necessary | -
| root_helper = sudo | -(StrOpt) Using root helper | -
| rpc = True | -(BoolOpt) Whether using rpc | -
| Configuration option = Default value | +Description | +
|---|---|
| [SDNVE] | +|
| base_url = /one/nb/v2/ | +(StrOpt) Base URL for SDN-VE controller REST API | +
| controller_ips = 127.0.0.1 | +(ListOpt) List of IP addresses of SDN-VE controller(s) | +
| default_tenant_type = OVERLAY | +(StrOpt) Tenant type: OVERLAY (default) or OF | +
| format = json | +(StrOpt) SDN-VE request/response format | +
| info = sdnve_info_string | +(StrOpt) SDN-VE RPC subject | +
| integration_bridge = None | +(StrOpt) Integration bridge to use | +
| interface_mappings = | +(ListOpt) List of <physical_network_name>:<interface_name> | +
| of_signature = SDNVE-OF | +(StrOpt) The string in tenant description that indicates the tenant is a OF tenant | +
| out_of_band = True | +(BoolOpt) Indicating if controller is out of band or not | +
| overlay_signature = SDNVE-OVERLAY | +(StrOpt) The string in tenant description that indicates the tenant is a OVERLAY tenant | +
| password = admin | +(StrOpt) SDN-VE administrator password | +
| port = 8443 | +(StrOpt) SDN-VE controller port number | +
| reset_bridge = True | +(BoolOpt) Reset the integration bridge before use | +
| use_fake_controller = False | +(BoolOpt) If set to True uses a fake controller. | +
| userid = admin | +(StrOpt) SDN-VE administrator user id | +
| [SDNVE_AGENT] | +|
| polling_interval = 2 | +(IntOpt) Agent polling interval if necessary | +
| root_helper = sudo | +(StrOpt) Using root helper | +
| rpc = True | +(BoolOpt) Whether using rpc | +
| Configuration option = Default value | -Description | -
|---|---|
| [SECURITYGROUP] | -|
| enable_security_group = True | -(BoolOpt) Controls whether the neutron security group API is enabled in the server. It should be false when using no security groups or using the nova security group API. | -
| firewall_driver = None | -(StrOpt) Driver for security groups firewall in the L2 agent | -
| Configuration option = Default value | +Description | +
|---|---|
| [SECURITYGROUP] | +|
| enable_security_group = True | +(BoolOpt) Controls whether the neutron security group API is enabled in the server. It should be false when using no security groups or using the nova security group API. | +
| firewall_driver = None | +(StrOpt) Driver for security groups firewall in the L2 agent | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| ssl_ca_file = None | -(StrOpt) CA certificate file to use to verify connecting clients | -
| ssl_cert_file = None | -(StrOpt) Certificate file to use when starting the server securely | -
| ssl_key_file = None | -(StrOpt) Private key file to use when starting the server securely | -
| [ssl] | -|
| ca_file = None | -(StrOpt) CA certificate file to use to verify connecting clients | -
| cert_file = None | -(StrOpt) Certificate file to use when starting the server securely | -
| key_file = None | -(StrOpt) Private key file to use when starting the server securely | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| ssl_ca_file = None | +(StrOpt) CA certificate file to use to verify connecting clients | +
| ssl_cert_file = None | +(StrOpt) Certificate file to use when starting the server securely | +
| ssl_key_file = None | +(StrOpt) Private key file to use when starting the server securely | +
| [ssl] | +|
| ca_file = None | +(StrOpt) CA certificate file to use to verify connecting clients | +
| cert_file = None | +(StrOpt) Certificate file to use when starting the server securely | +
| key_file = None | +(StrOpt) Private key file to use when starting the server securely | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| backdoor_port = None | -(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. | -
| fake_rabbit = False | -(BoolOpt) If passed, use a fake RabbitMQ provider | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| backdoor_port = None | +(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. | +
| fake_rabbit = False | +(BoolOpt) If passed, use a fake RabbitMQ provider | +
| Configuration option = Default value | -Description | -
|---|---|
| [vArmour] | -|
| director = localhost | -(StrOpt) vArmour director ip | -
| director_port = 443 | -(StrOpt) vArmour director port | -
| password = varmour | -(StrOpt) vArmour director password | -
| username = varmour | -(StrOpt) vArmour director username | -
| Configuration option = Default value | +Description | +
|---|---|
| [vArmour] | +|
| director = localhost | +(StrOpt) vArmour director ip | +
| director_port = 443 | +(StrOpt) vArmour director port | +
| password = varmour | +(StrOpt) vArmour director password | +
| username = varmour | +(StrOpt) vArmour director username | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| default_interface_name = breth0 | -(StrOpt) Name of the interface on a L2 Gateway transport nodewhich should be used by default when setting up a network connection | -
| default_l2_gw_service_uuid = None | -(StrOpt) Unique identifier of the NSX L2 Gateway service which will be used by default for network gateways | -
| default_l3_gw_service_uuid = None | -(StrOpt) Unique identifier of the NSX L3 Gateway service which will be used for implementing routers and floating IPs | -
| default_service_cluster_uuid = None | -(StrOpt) Unique identifier of the Service Cluster which will be used by logical services like dhcp and metadata | -
| default_tz_uuid = None | -(StrOpt) This is uuid of the default NSX Transport zone that will be used for creating tunneled isolated "Neutron" networks. It needs to be created in NSX before starting Neutron with the nsx plugin. | -
| http_timeout = 10 | -(IntOpt) Time before aborting a request | -
| nsx_controllers = None | -(ListOpt) Lists the NSX controllers in this cluster | -
| nsx_password = admin | -(StrOpt) Password for NSX controllers in this cluster | -
| nsx_user = admin | -(StrOpt) User name for NSX controllers in this cluster | -
| redirects = 2 | -(IntOpt) Number of times a redirect should be followed | -
| req_timeout = 30 | -(IntOpt) Total time limit for a cluster request | -
| retries = 2 | -(IntOpt) Number of time a request should be retried | -
| [ESWITCH] | -|
| retries = 3 | -(IntOpt) The number of retries the agent will send request to daemon before giving up | -
| [NSX] | -|
| agent_mode = agent | -(StrOpt) The mode used to implement DHCP/metadata services. | -
| concurrent_connections = 10 | -(IntOpt) Maximum concurrent connections to each NSX controller. | -
| default_transport_type = stt | -(StrOpt) The default network tranport type to use (stt, gre, bridge, ipsec_gre, or ipsec_stt) | -
| max_lp_per_bridged_ls = 5000 | -(IntOpt) Maximum number of ports of a logical switch on a bridged transport zone (default 5000) | -
| max_lp_per_overlay_ls = 256 | -(IntOpt) Maximum number of ports of a logical switch on an overlay transport zone (default 256) | -
| metadata_mode = access_network | -(StrOpt) If set to access_network this enables a dedicated connection to the metadata proxy for metadata server access via Neutron router. If set to dhcp_host_route this enables host route injection via the dhcp agent. This option is only useful if running on a host that does not support namespaces otherwise access_network should be used. | -
| nsx_gen_timeout = -1 | -(IntOpt) Number of seconds a generation id should be valid for (default -1 meaning do not time out) | -
| replication_mode = service | -(StrOpt) The default option leverages service nodes to perform packet replication though one could set to this to 'source' to perform replication locally. This is useful if one does not want to deploy a service node(s). | -
| [NSX_DHCP] | -|
| default_lease_time = 43200 | -(IntOpt) Default DHCP lease time | -
| domain_name = openstacklocal | -(StrOpt) Domain to use for building the hostnames | -
| extra_domain_name_servers = | -(ListOpt) Comma separated list of additional domain name servers | -
| [NSX_LSN] | -|
| sync_on_missing_data = False | -(BoolOpt) Pull LSN information from NSX in case it is missing from the local data store. This is useful to rebuild the local store in case of server recovery. | -
| [NSX_METADATA] | -|
| metadata_server_address = 127.0.0.1 | -(StrOpt) IP address used by Metadata server. | -
| metadata_server_port = 8775 | -(IntOpt) TCP Port used by Metadata server. | -
| metadata_shared_secret = | -(StrOpt) Shared secret to sign instance-id request | -
| [NSX_SYNC] | -|
| always_read_status = False | -(BoolOpt) Always read operational status from backend on show operations. Enabling this option might slow down the system. | -
| max_random_sync_delay = 0 | -(IntOpt) Maximum value for the additional random delay in seconds between runs of the state synchronization task | -
| min_chunk_size = 500 | -(IntOpt) Minimum number of resources to be retrieved from NSX during state synchronization | -
| min_sync_req_delay = 1 | -(IntOpt) Minimum delay, in seconds, between two state synchronization queries to NSX. It must not exceed state_sync_interval | -
| state_sync_interval = 10 | -(IntOpt) Interval in seconds between runs of the state synchronization task. Set it to 0 to disable it | -
| [vcns] | -|
| datacenter_moid = None | -(StrOpt) Optional parameter identifying the ID of datacenter to deploy NSX Edges | -
| datastore_id = None | -(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges | -
| deployment_container_id = None | -(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges | -
| external_network = None | -(StrOpt) Network ID for physical network connectivity | -
| manager_uri = None | -(StrOpt) uri for vsm | -
| password = default | -(StrOpt) Password for vsm | -
| resource_pool_id = None | -(StrOpt) Optional parameter identifying the ID of resource to deploy NSX Edges | -
| task_status_check_interval = 2000 | -(IntOpt) Task status check interval | -
| user = admin | -(StrOpt) User name for vsm | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| default_interface_name = breth0 | +(StrOpt) Name of the interface on a L2 Gateway transport nodewhich should be used by default when setting up a network connection | +
| default_l2_gw_service_uuid = None | +(StrOpt) Unique identifier of the NSX L2 Gateway service which will be used by default for network gateways | +
| default_l3_gw_service_uuid = None | +(StrOpt) Unique identifier of the NSX L3 Gateway service which will be used for implementing routers and floating IPs | +
| default_service_cluster_uuid = None | +(StrOpt) Unique identifier of the Service Cluster which will be used by logical services like dhcp and metadata | +
| default_tz_uuid = None | +(StrOpt) This is uuid of the default NSX Transport zone that will be used for creating tunneled isolated "Neutron" networks. It needs to be created in NSX before starting Neutron with the nsx plugin. | +
| http_timeout = 30 | +(IntOpt) Time before aborting a request | +
| nsx_controllers = None | +(ListOpt) Lists the NSX controllers in this cluster | +
| nsx_password = admin | +(StrOpt) Password for NSX controllers in this cluster | +
| nsx_user = admin | +(StrOpt) User name for NSX controllers in this cluster | +
| redirects = 2 | +(IntOpt) Number of times a redirect should be followed | +
| req_timeout = 30 | +(IntOpt) Total time limit for a cluster request | +
| retries = 2 | +(IntOpt) Number of time a request should be retried | +
| [ESWITCH] | +|
| retries = 3 | +(IntOpt) The number of retries the agent will send request to daemon before giving up | +
| [NSX] | +|
| agent_mode = agent | +(StrOpt) The mode used to implement DHCP/metadata services. | +
| concurrent_connections = 10 | +(IntOpt) Maximum concurrent connections to each NSX controller. | +
| default_transport_type = stt | +(StrOpt) The default network tranport type to use (stt, gre, bridge, ipsec_gre, or ipsec_stt) | +
| max_lp_per_bridged_ls = 5000 | +(IntOpt) Maximum number of ports of a logical switch on a bridged transport zone (default 5000) | +
| max_lp_per_overlay_ls = 256 | +(IntOpt) Maximum number of ports of a logical switch on an overlay transport zone (default 256) | +
| metadata_mode = access_network | +(StrOpt) If set to access_network this enables a dedicated connection to the metadata proxy for metadata server access via Neutron router. If set to dhcp_host_route this enables host route injection via the dhcp agent. This option is only useful if running on a host that does not support namespaces otherwise access_network should be used. | +
| nsx_gen_timeout = -1 | +(IntOpt) Number of seconds a generation id should be valid for (default -1 meaning do not time out) | +
| replication_mode = service | +(StrOpt) The default option leverages service nodes to perform packet replication though one could set to this to 'source' to perform replication locally. This is useful if one does not want to deploy a service node(s). | +
| [NSX_DHCP] | +|
| default_lease_time = 43200 | +(IntOpt) Default DHCP lease time | +
| domain_name = openstacklocal | +(StrOpt) Domain to use for building the hostnames | +
| extra_domain_name_servers = | +(ListOpt) Comma separated list of additional domain name servers | +
| [NSX_LSN] | +|
| sync_on_missing_data = False | +(BoolOpt) Pull LSN information from NSX in case it is missing from the local data store. This is useful to rebuild the local store in case of server recovery. | +
| [NSX_METADATA] | +|
| metadata_server_address = 127.0.0.1 | +(StrOpt) IP address used by Metadata server. | +
| metadata_server_port = 8775 | +(IntOpt) TCP Port used by Metadata server. | +
| metadata_shared_secret = | +(StrOpt) Shared secret to sign instance-id request | +
| [NSX_SYNC] | +|
| always_read_status = False | +(BoolOpt) Always read operational status from backend on show operations. Enabling this option might slow down the system. | +
| max_random_sync_delay = 0 | +(IntOpt) Maximum value for the additional random delay in seconds between runs of the state synchronization task | +
| min_chunk_size = 500 | +(IntOpt) Minimum number of resources to be retrieved from NSX during state synchronization | +
| min_sync_req_delay = 1 | +(IntOpt) Minimum delay, in seconds, between two state synchronization queries to NSX. It must not exceed state_sync_interval | +
| state_sync_interval = 10 | +(IntOpt) Interval in seconds between runs of the state synchronization task. Set it to 0 to disable it | +
| [vcns] | +|
| datacenter_moid = None | +(StrOpt) Optional parameter identifying the ID of datacenter to deploy NSX Edges | +
| datastore_id = None | +(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges | +
| deployment_container_id = None | +(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges | +
| external_network = None | +(StrOpt) Network ID for physical network connectivity | +
| manager_uri = None | +(StrOpt) uri for vsm | +
| password = default | +(StrOpt) Password for vsm | +
| resource_pool_id = None | +(StrOpt) Optional parameter identifying the ID of resource to deploy NSX Edges | +
| task_status_check_interval = 2000 | +(IntOpt) Task status check interval | +
| user = admin | +(StrOpt) User name for vsm | +
| Configuration option = Default value | -Description | -
|---|---|
| [ipsec] | -|
| config_base_dir = $state_path/ipsec | -(StrOpt) Location to store ipsec server config files | -
| ipsec_status_check_interval = 60 | -(IntOpt) Interval for checking ipsec status | -
| [openswan] | -|
| ipsec_config_template = /usr/lib/python/site-packages/neutron/services/vpn/device_drivers/template/openswan/ipsec.conf.template | -(StrOpt) Template file for ipsec configuration | -
| ipsec_secret_template = /usr/lib/python/site-packages/neutron/services/vpn/device_drivers/template/openswan/ipsec.secret.template | -(StrOpt) Template file for ipsec secret configuration | -
| [vpnagent] | -|
| vpn_device_driver = ['neutron.services.vpn.device_drivers.ipsec.OpenSwanDriver'] | -(MultiStrOpt) The vpn device drivers Neutron will use | -
| Configuration option = Default value | +Description | +
|---|---|
| [ipsec] | +|
| config_base_dir = $state_path/ipsec | +(StrOpt) Location to store ipsec server config files | +
| ipsec_status_check_interval = 60 | +(IntOpt) Interval for checking ipsec status | +
| [openswan] | +|
| ipsec_config_template = /usr/lib/python/site-packages/neutron/services/vpn/device_drivers/template/openswan/ipsec.conf.template | +(StrOpt) Template file for ipsec configuration | +
| ipsec_secret_template = /usr/lib/python/site-packages/neutron/services/vpn/device_drivers/template/openswan/ipsec.secret.template | +(StrOpt) Template file for ipsec secret configuration | +
| [vpnagent] | +|
| vpn_device_driver = ['neutron.services.vpn.device_drivers.ipsec.OpenSwanDriver'] | +(MultiStrOpt) The vpn device drivers Neutron will use | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| backlog = 4096 | -(IntOpt) Number of backlog requests to configure the socket with | -
| retry_until_window = 30 | -(IntOpt) Number of seconds to keep retrying to listen | -
| tcp_keepidle = 600 | -(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| backlog = 4096 | +(IntOpt) Number of backlog requests to configure the socket with | +
| retry_until_window = 30 | +(IntOpt) Number of seconds to keep retrying to listen | +
| tcp_keepidle = 600 | +(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| rpc_zmq_bind_address = * | -(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| rpc_zmq_contexts = 1 | -(IntOpt) Number of ZeroMQ contexts, defaults to 1 | -
| rpc_zmq_host = oslo | -(StrOpt) 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 | -(StrOpt) Directory for holding IPC sockets | -
| rpc_zmq_matchmaker = neutron.openstack.common.rpc.matchmaker.MatchMakerLocalhost | -(StrOpt) MatchMaker driver | -
| rpc_zmq_port = 9501 | -(IntOpt) ZeroMQ receiver listening port | -
| rpc_zmq_topic_backlog = None | -(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| rpc_zmq_bind_address = * | +(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | +
| rpc_zmq_contexts = 1 | +(IntOpt) Number of ZeroMQ contexts, defaults to 1. | +
| rpc_zmq_host = oslo | +(StrOpt) 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 | +(StrOpt) Directory for holding IPC sockets. | +
| rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost | +(StrOpt) MatchMaker driver. | +
| rpc_zmq_port = 9501 | +(IntOpt) ZeroMQ receiver listening port. | +
| rpc_zmq_topic_backlog = None | +(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| api_rate_limit = False | -(BoolOpt) Whether to use per-user rate limiting for the api. This option is only used by v2 api. Rate limiting is removed from v3 api. | -
| enable_new_services = True | -(BoolOpt) Services to be added to the available pool on create | -
| enabled_apis = ec2, osapi_compute, metadata | -(ListOpt) A list of APIs to enable by default | -
| enabled_ssl_apis = | -(ListOpt) A list of APIs with enabled SSL | -
| instance_name_template = instance-%08x | -(StrOpt) Template string to be used to generate instance names | -
| max_header_line = 16384 | -(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). | -
| multi_instance_display_name_template = %(name)s-%(uuid)s | -(StrOpt) When creating multiple instances with a single request using the os-multiple-create API extension, this template will be used to build the display name for each instance. The benefit is that the instances end up with different hostnames. To restore legacy behavior of every instance having the same name, set this option to "%(name)s". Valid keys for the template are: name, uuid, count. | -
| non_inheritable_image_properties = cache_in_nova, bittorrent | -(ListOpt) These are image properties which a snapshot should not inherit from an instance | -
| null_kernel = nokernel | -(StrOpt) Kernel image that indicates not to use a kernel, but to use a raw disk image instead | -
| osapi_compute_ext_list = | -(ListOpt) Specify list of extensions to load when using osapi_compute_extension option with nova.api.openstack.compute.contrib.select_extensions | -
| osapi_compute_extension = ['nova.api.openstack.compute.contrib.standard_extensions'] | -(MultiStrOpt) osapi compute extension to load | -
| osapi_compute_link_prefix = None | -(StrOpt) Base URL that will be presented to users in links to the OpenStack Compute API | -
| osapi_compute_listen = 0.0.0.0 | -(StrOpt) The IP address on which the OpenStack API will listen. | -
| osapi_compute_listen_port = 8774 | -(IntOpt) The port on which the OpenStack API will listen. | -
| osapi_compute_workers = None | -(IntOpt) Number of workers for OpenStack API service. The default will be the number of CPUs available. | -
| osapi_hide_server_address_states = building | -(ListOpt) List of instance states that should hide network info | -
| servicegroup_driver = db | -(StrOpt) The driver for servicegroup service (valid options are: db, zk, mc) | -
| snapshot_name_template = snapshot-%s | -(StrOpt) Template string to be used to generate snapshot names | -
| use_forwarded_for = False | -(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| api_rate_limit = False | +(BoolOpt) Whether to use per-user rate limiting for the api. This option is only used by v2 api. Rate limiting is removed from v3 api. | +
| enable_new_services = True | +(BoolOpt) Services to be added to the available pool on create | +
| enabled_apis = ec2, osapi_compute, metadata | +(ListOpt) A list of APIs to enable by default | +
| enabled_ssl_apis = | +(ListOpt) A list of APIs with enabled SSL | +
| instance_name_template = instance-%08x | +(StrOpt) Template string to be used to generate instance names | +
| max_header_line = 16384 | +(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). | +
| multi_instance_display_name_template = %(name)s-%(uuid)s | +(StrOpt) When creating multiple instances with a single request using the os-multiple-create API extension, this template will be used to build the display name for each instance. The benefit is that the instances end up with different hostnames. To restore legacy behavior of every instance having the same name, set this option to "%(name)s". Valid keys for the template are: name, uuid, count. | +
| non_inheritable_image_properties = cache_in_nova, bittorrent | +(ListOpt) These are image properties which a snapshot should not inherit from an instance | +
| null_kernel = nokernel | +(StrOpt) Kernel image that indicates not to use a kernel, but to use a raw disk image instead | +
| osapi_compute_ext_list = | +(ListOpt) Specify list of extensions to load when using osapi_compute_extension option with nova.api.openstack.compute.contrib.select_extensions | +
| osapi_compute_extension = ['nova.api.openstack.compute.contrib.standard_extensions'] | +(MultiStrOpt) osapi compute extension to load | +
| osapi_compute_link_prefix = None | +(StrOpt) Base URL that will be presented to users in links to the OpenStack Compute API | +
| osapi_compute_listen = 0.0.0.0 | +(StrOpt) The IP address on which the OpenStack API will listen. | +
| osapi_compute_listen_port = 8774 | +(IntOpt) The port on which the OpenStack API will listen. | +
| osapi_compute_workers = None | +(IntOpt) Number of workers for OpenStack API service. The default will be the number of CPUs available. | +
| osapi_hide_server_address_states = building | +(ListOpt) List of instance states that should hide network info | +
| servicegroup_driver = db | +(StrOpt) The driver for servicegroup service (valid options are: db, zk, mc) | +
| snapshot_name_template = snapshot-%s | +(StrOpt) Template string to be used to generate snapshot names | +
| use_forwarded_for = False | +(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. | +
| Configuration option = Default value | -Description | -
|---|---|
| [osapi_v3] | -|
| enabled = False | -(BoolOpt) Whether the V3 API is enabled or not | -
| extensions_blacklist = | -(ListOpt) A list of v3 API extensions to never load. Specify the extension aliases here. | -
| extensions_whitelist = | -(ListOpt) If the list is not empty then a v3 API extension will only be loaded if it exists in this list. Specify the extension aliases here. | -
| Configuration option = Default value | +Description | +
|---|---|
| [osapi_v3] | +|
| enabled = False | +(BoolOpt) Whether the V3 API is enabled or not | +
| extensions_blacklist = | +(ListOpt) A list of v3 API extensions to never load. Specify the extension aliases here. | +
| extensions_whitelist = | +(ListOpt) If the list is not empty then a v3 API extension will only be loaded if it exists in this list. Specify the extension aliases here. | +
| Configuration option = Default value | -Description | -
|---|---|
| [keystone_authtoken] | -|
| admin_password = None | -(StrOpt) Keystone account password | -
| admin_tenant_name = admin | -(StrOpt) Keystone service account tenant name to validate user tokens | -
| admin_token = None | -(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. | -
| admin_user = None | -(StrOpt) Keystone account username | -
| auth_admin_prefix = | -(StrOpt) Prefix to prepend at the beginning of the path | -
| auth_host = 127.0.0.1 | -(StrOpt) Host providing the admin Identity API endpoint | -
| auth_port = 35357 | -(IntOpt) Port of the admin Identity API endpoint | -
| auth_protocol = https | -(StrOpt) Protocol of the admin Identity API endpoint(http or https) | -
| auth_uri = None | -(StrOpt) Complete public Identity API endpoint | -
| auth_version = None | -(StrOpt) API version of the admin Identity API endpoint | -
| cache = None | -(StrOpt) Env key for the swift cache | -
| cafile = None | -(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| certfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| delay_auth_decision = False | -(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | -
| enforce_token_bind = permissive | -(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| http_connect_timeout = None | -(BoolOpt) Request timeout value for communicating with Identity API server. | -
| http_request_max_retries = 3 | -(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| include_service_catalog = True | -(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| insecure = False | -(BoolOpt) Verify HTTPS connections. | -
| keyfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| memcache_secret_key = None | -(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | -
| memcache_security_strategy = None | -(StrOpt) (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. | -
| memcached_servers = None | -(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| revocation_cache_time = 300 | -(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| signing_dir = None | -(StrOpt) Directory used to cache files related to PKI tokens | -
| token_cache_time = 300 | -(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | +Description | +
|---|---|
| [keystone_authtoken] | +|
| admin_password = None | +(StrOpt) Keystone account password | +
| admin_tenant_name = admin | +(StrOpt) Keystone service account tenant name to validate user tokens | +
| admin_token = None | +(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | +
| admin_user = None | +(StrOpt) Keystone account username | +
| auth_admin_prefix = | +(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | +
| auth_host = 127.0.0.1 | +(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_port = 35357 | +(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_protocol = https | +(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | +
| auth_uri = None | +(StrOpt) Complete public Identity API endpoint | +
| auth_version = None | +(StrOpt) API version of the admin Identity API endpoint | +
| cache = None | +(StrOpt) Env key for the swift cache | +
| cafile = None | +(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | +
| certfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| check_revocations_for_cached = False | +(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server. | +
| delay_auth_decision = False | +(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | +
| enforce_token_bind = permissive | +(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | +
| hash_algorithms = md5 | +(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | +
| http_connect_timeout = None | +(BoolOpt) Request timeout value for communicating with Identity API server. | +
| http_request_max_retries = 3 | +(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | +
| identity_uri = None | +(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | +
| include_service_catalog = True | +(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | +
| insecure = False | +(BoolOpt) Verify HTTPS connections. | +
| keyfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| memcache_secret_key = None | +(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | +
| memcache_security_strategy = None | +(StrOpt) (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. | +
| memcached_servers = None | +(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | +
| revocation_cache_time = 10 | +(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | +
| signing_dir = None | +(StrOpt) Directory used to cache files related to PKI tokens | +
| token_cache_time = 300 | +(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| auth_strategy = noauth | -(StrOpt) The strategy to use for auth: noauth or keystone. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| auth_strategy = keystone | +(StrOpt) The strategy to use for auth: noauth or keystone. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| default_availability_zone = nova | -(StrOpt) Default compute node availability_zone | -
| default_schedule_zone = None | -(StrOpt) Availability zone to use when user doesn't specify one | -
| internal_service_availability_zone = internal | -(StrOpt) The availability_zone to show internal services under | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| default_availability_zone = nova | +(StrOpt) Default compute node availability_zone | +
| default_schedule_zone = None | +(StrOpt) Availability zone to use when user doesn't specify one | +
| internal_service_availability_zone = internal | +(StrOpt) The availability_zone to show internal services under | +
| Configuration option = Default value | -Description | -
|---|---|
| [baremetal] | -|
| db_backend = sqlalchemy | -(StrOpt) The backend to use for bare-metal database | -
| deploy_kernel = None | -(StrOpt) Default kernel image ID used in deployment phase | -
| deploy_ramdisk = None | -(StrOpt) Default ramdisk image ID used in deployment phase | -
| driver = nova.virt.baremetal.pxe.PXE | -(StrOpt) Baremetal driver back-end (pxe or tilera) | -
| flavor_extra_specs = | -(ListOpt) A list of additional capabilities corresponding to flavor_extra_specs for this compute host to advertise. Valid entries are name=value, pairs For example, "key1:val1, key2:val2" | -
| ipmi_power_retry = 10 | -(IntOpt) Maximal number of retries for IPMI operations | -
| net_config_template = $pybasedir/nova/virt/baremetal/net-dhcp.ubuntu.template | -(StrOpt) Template file for injected network config | -
| power_manager = nova.virt.baremetal.ipmi.IPMI | -(StrOpt) Baremetal power management method | -
| pxe_append_params = nofb nomodeset vga=normal | -(StrOpt) Additional append parameters for baremetal PXE boot | -
| pxe_bootfile_name = pxelinux.0 | -(StrOpt) This gets passed to Neutron as the bootfile dhcp parameter. | -
| pxe_config_template = $pybasedir/nova/virt/baremetal/pxe_config.template | -(StrOpt) Template file for PXE configuration | -
| pxe_deploy_timeout = 0 | -(IntOpt) Timeout for PXE deployments. Default: 0 (unlimited) | -
| pxe_network_config = False | -(BoolOpt) If set, pass the network configuration details to the initramfs via cmdline. | -
| sql_connection = sqlite:///$state_path/baremetal_nova.sqlite | -(StrOpt) The SQLAlchemy connection string used to connect to the bare-metal database | -
| terminal = shellinaboxd | -(StrOpt) Path to baremetal terminal program | -
| terminal_cert_dir = None | -(StrOpt) Path to baremetal terminal SSL cert(PEM) | -
| terminal_pid_dir = $state_path/baremetal/console | -(StrOpt) Path to directory stores pidfiles of baremetal_terminal | -
| tftp_root = /tftpboot | -(StrOpt) Baremetal compute node's tftp root path | -
| use_file_injection = False | -(BoolOpt) If True, enable file injection for network info, files and admin password | -
| use_unsafe_iscsi = False | -(BoolOpt) Do not set this out of dev/test environments. If a node does not have a fixed PXE IP address, volumes are exported with globally opened ACL | -
| vif_driver = nova.virt.baremetal.vif_driver.BareMetalVIFDriver | -(StrOpt) Baremetal VIF driver. | -
| virtual_power_host_key = None | -(StrOpt) The ssh key for virtual power host_user | -
| virtual_power_host_pass = | -(StrOpt) Password for virtual power host_user | -
| virtual_power_host_user = | -(StrOpt) User to execute virtual power commands as | -
| virtual_power_ssh_host = | -(StrOpt) IP or name to virtual power host | -
| virtual_power_ssh_port = 22 | -(IntOpt) Port to use for ssh to virtual power host | -
| virtual_power_type = virsh | -(StrOpt) Base command to use for virtual power(vbox, virsh) | -
| [xenserver] | -|
| vif_driver = nova.virt.xenapi.vif.XenAPIBridgeDriver | -(StrOpt) The XenAPI VIF driver using XenServer Network APIs. | -
| Configuration option = Default value | +Description | +
|---|---|
| [baremetal] | +|
| db_backend = sqlalchemy | +(StrOpt) The backend to use for bare-metal database | +
| deploy_kernel = None | +(StrOpt) Default kernel image ID used in deployment phase | +
| deploy_ramdisk = None | +(StrOpt) Default ramdisk image ID used in deployment phase | +
| driver = nova.virt.baremetal.pxe.PXE | +(StrOpt) Baremetal driver back-end (pxe or tilera) | +
| flavor_extra_specs = | +(ListOpt) A list of additional capabilities corresponding to flavor_extra_specs for this compute host to advertise. Valid entries are name=value, pairs For example, "key1:val1, key2:val2" | +
| ipmi_power_retry = 10 | +(IntOpt) Maximal number of retries for IPMI operations | +
| net_config_template = $pybasedir/nova/virt/baremetal/net-dhcp.ubuntu.template | +(StrOpt) Template file for injected network config | +
| power_manager = nova.virt.baremetal.ipmi.IPMI | +(StrOpt) Baremetal power management method | +
| pxe_append_params = nofb nomodeset vga=normal | +(StrOpt) Additional append parameters for baremetal PXE boot | +
| pxe_bootfile_name = pxelinux.0 | +(StrOpt) This gets passed to Neutron as the bootfile dhcp parameter. | +
| pxe_config_template = $pybasedir/nova/virt/baremetal/pxe_config.template | +(StrOpt) Template file for PXE configuration | +
| pxe_deploy_timeout = 0 | +(IntOpt) Timeout for PXE deployments. Default: 0 (unlimited) | +
| pxe_network_config = False | +(BoolOpt) If set, pass the network configuration details to the initramfs via cmdline. | +
| sql_connection = sqlite:///$state_path/baremetal_nova.sqlite | +(StrOpt) The SQLAlchemy connection string used to connect to the bare-metal database | +
| terminal = shellinaboxd | +(StrOpt) Path to baremetal terminal program | +
| terminal_cert_dir = None | +(StrOpt) Path to baremetal terminal SSL cert(PEM) | +
| terminal_pid_dir = $state_path/baremetal/console | +(StrOpt) Path to directory stores pidfiles of baremetal_terminal | +
| tftp_root = /tftpboot | +(StrOpt) Baremetal compute node's tftp root path | +
| use_file_injection = False | +(BoolOpt) If True, enable file injection for network info, files and admin password | +
| use_unsafe_iscsi = False | +(BoolOpt) Do not set this out of dev/test environments. If a node does not have a fixed PXE IP address, volumes are exported with globally opened ACL | +
| vif_driver = nova.virt.baremetal.vif_driver.BareMetalVIFDriver | +(StrOpt) Baremetal VIF driver. | +
| virtual_power_host_key = None | +(StrOpt) The ssh key for virtual power host_user | +
| virtual_power_host_pass = | +(StrOpt) Password for virtual power host_user | +
| virtual_power_host_user = | +(StrOpt) User to execute virtual power commands as | +
| virtual_power_ssh_host = | +(StrOpt) IP or name to virtual power host | +
| virtual_power_ssh_port = 22 | +(IntOpt) Port to use for ssh to virtual power host | +
| virtual_power_type = virsh | +(StrOpt) Base command to use for virtual power(vbox, virsh) | +
| [xenserver] | +|
| vif_driver = nova.virt.xenapi.vif.XenAPIBridgeDriver | +(StrOpt) The XenAPI VIF driver using XenServer Network APIs. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| ca_file = cacert.pem | -(StrOpt) Filename of root CA | -
| ca_path = $state_path/CA | -(StrOpt) Where we keep our root CA | -
| cert_manager = nova.cert.manager.CertManager | -(StrOpt) Full class name for the Manager for cert | -
| cert_topic = cert | -(StrOpt) The topic cert nodes listen on | -
| crl_file = crl.pem | -(StrOpt) Filename of root Certificate Revocation List | -
| key_file = private/cakey.pem | -(StrOpt) Filename of private key | -
| keys_path = $state_path/keys | -(StrOpt) Where we keep our keys | -
| project_cert_subject = /C=US/ST=California/O=OpenStack/OU=NovaDev/CN=project-ca-%.16s-%s | -(StrOpt) Subject for certificate for projects, %s for project, timestamp | -
| use_project_ca = False | -(BoolOpt) Should we use a CA for each project? | -
| user_cert_subject = /C=US/ST=California/O=OpenStack/OU=NovaDev/CN=%.16s-%.16s-%s | -(StrOpt) Subject for certificate for users, %s for project, user, timestamp | -
| [ssl] | -|
| ca_file = None | -(StrOpt) CA certificate file to use to verify connecting clients. | -
| cert_file = None | -(StrOpt) Certificate file to use when starting the server securely. | -
| key_file = None | -(StrOpt) Private key file to use when starting the server securely. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| ca_file = cacert.pem | +(StrOpt) Filename of root CA | +
| ca_path = $state_path/CA | +(StrOpt) Where we keep our root CA | +
| cert_manager = nova.cert.manager.CertManager | +(StrOpt) Full class name for the Manager for cert | +
| cert_topic = cert | +(StrOpt) The topic cert nodes listen on | +
| crl_file = crl.pem | +(StrOpt) Filename of root Certificate Revocation List | +
| key_file = private/cakey.pem | +(StrOpt) Filename of private key | +
| keys_path = $state_path/keys | +(StrOpt) Where we keep our keys | +
| project_cert_subject = /C=US/ST=California/O=OpenStack/OU=NovaDev/CN=project-ca-%.16s-%s | +(StrOpt) Subject for certificate for projects, %s for project, timestamp | +
| use_project_ca = False | +(BoolOpt) Should we use a CA for each project? | +
| user_cert_subject = /C=US/ST=California/O=OpenStack/OU=NovaDev/CN=%.16s-%.16s-%s | +(StrOpt) Subject for certificate for users, %s for project, user, timestamp | +
| [ssl] | +|
| ca_file = None | +(StrOpt) CA certificate file to use to verify connecting clients. | +
| cert_file = None | +(StrOpt) Certificate file to use when starting the server securely. | +
| key_file = None | +(StrOpt) Private key file to use when starting the server securely. | +
| Configuration option = Default value | -Description | -
|---|---|
| [cells] | -|
| call_timeout = 60 | -(IntOpt) Seconds to wait for response from a call to a cell. | -
| capabilities = hypervisor=xenserver;kvm, os=linux;windows | -(ListOpt) Key/Multi-value list with the capabilities of the cell | -
| cell_type = compute | -(StrOpt) Type of cell: api or compute | -
| cells_config = None | -(StrOpt) Configuration file from which to read cells configuration. If given, overrides reading cells from the database. | -
| driver = nova.cells.rpc_driver.CellsRPCDriver | -(StrOpt) Cells communication driver to use | -
| enable = False | -(BoolOpt) Enable cell functionality | -
| instance_update_num_instances = 1 | -(IntOpt) Number of instances to update per periodic task run | -
| instance_updated_at_threshold = 3600 | -(IntOpt) Number of seconds after an instance was updated or deleted to continue to update cells | -
| manager = nova.cells.manager.CellsManager | -(StrOpt) Manager for cells | -
| max_hop_count = 10 | -(IntOpt) Maximum number of hops for cells routing. | -
| mute_child_interval = 300 | -(IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute. | -
| mute_weight_multiplier = -10.0 | -(FloatOpt) Multiplier used to weigh mute children. (The value should be negative.) | -
| mute_weight_value = 1000.0 | -(FloatOpt) Weight value assigned to mute children. (The value should be positive.) | -
| name = nova | -(StrOpt) Name of this cell | -
| offset_weight_multiplier = 1.0 | -(FloatOpt) Multiplier used to weigh offset weigher. | -
| reserve_percent = 10.0 | -(FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization | -
| topic = cells | -(StrOpt) The topic cells nodes listen on | -
| Configuration option = Default value | +Description | +
|---|---|
| [cells] | +|
| call_timeout = 60 | +(IntOpt) Seconds to wait for response from a call to a cell. | +
| capabilities = hypervisor=xenserver;kvm, os=linux;windows | +(ListOpt) Key/Multi-value list with the capabilities of the cell | +
| cell_type = compute | +(StrOpt) Type of cell: api or compute | +
| cells_config = None | +(StrOpt) Configuration file from which to read cells configuration. If given, overrides reading cells from the database. | +
| db_check_interval = 60 | +(IntOpt) Interval, in seconds, for getting fresh cell information from the database. | +
| driver = nova.cells.rpc_driver.CellsRPCDriver | +(StrOpt) Cells communication driver to use | +
| enable = False | +(BoolOpt) Enable cell functionality | +
| instance_update_num_instances = 1 | +(IntOpt) Number of instances to update per periodic task run | +
| instance_updated_at_threshold = 3600 | +(IntOpt) Number of seconds after an instance was updated or deleted to continue to update cells | +
| manager = nova.cells.manager.CellsManager | +(StrOpt) Manager for cells | +
| max_hop_count = 10 | +(IntOpt) Maximum number of hops for cells routing. | +
| mute_child_interval = 300 | +(IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute. | +
| mute_weight_multiplier = -10.0 | +(FloatOpt) Multiplier used to weigh mute children. (The value should be negative.) | +
| mute_weight_value = 1000.0 | +(FloatOpt) Weight value assigned to mute children. (The value should be positive.) | +
| name = nova | +(StrOpt) Name of this cell | +
| offset_weight_multiplier = 1.0 | +(FloatOpt) Multiplier used to weigh offset weigher. | +
| reserve_percent = 10.0 | +(FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization | +
| topic = cells | +(StrOpt) The topic cells nodes listen on | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| bindir = /usr/local/bin | -(StrOpt) Directory where nova binaries are installed | -
| compute_topic = compute | -(StrOpt) The topic compute nodes listen on | -
| console_topic = console | -(StrOpt) The topic console proxy nodes listen on | -
| consoleauth_topic = consoleauth | -(StrOpt) The topic console auth proxy nodes listen on | -
| disable_process_locking = False | -(BoolOpt) Whether to disable inter-process locks | -
| host = oslo | -(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address | -
| lock_path = None | -(StrOpt) Directory to use for lock files. | -
| memcached_servers = None | -(ListOpt) Memcached servers or None for in process cache. | -
| my_ip = 10.0.0.1 | -(StrOpt) IP address of this host | -
| notification_driver = [] | -(MultiStrOpt) Driver or drivers to handle sending notifications. | -
| notification_topics = notifications | -(ListOpt) AMQP topic used for OpenStack notifications. | -
| notify_api_faults = False | -(BoolOpt) If set, send api.fault notifications on caught exceptions in the API service. | -
| notify_on_state_change = None | -(StrOpt) If set, send compute.instance.update notifications on instance state changes. Valid values are None for no notifications, "vm_state" for notifications on VM state changes, or "vm_and_task_state" for notifications on VM and task state changes. | -
| port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| pybasedir = /usr/lib/python/site-packages | -(StrOpt) Directory where the nova python module is installed | -
| report_interval = 10 | -(IntOpt) Seconds between nodes reporting state to datastore | -
| rootwrap_config = /etc/nova/rootwrap.conf | -(StrOpt) Path to the rootwrap configuration file to use for running commands as root | -
| service_down_time = 60 | -(IntOpt) Maximum time since last check-in for up service | -
| state_path = $pybasedir | -(StrOpt) Top-level directory for maintaining nova's state | -
| tempdir = None | -(StrOpt) Explicitly specify the temporary working directory | -
| transport_url = None | -(StrOpt) 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. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| bindir = /usr/local/local/bin | +(StrOpt) Directory where nova binaries are installed | +
| compute_topic = compute | +(StrOpt) The topic compute nodes listen on | +
| console_topic = console | +(StrOpt) The topic console proxy nodes listen on | +
| consoleauth_topic = consoleauth | +(StrOpt) The topic console auth proxy nodes listen on | +
| disable_process_locking = False | +(BoolOpt) Whether to disable inter-process locks | +
| host = oslo | +(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address | +
| lock_path = None | +(StrOpt) Directory to use for lock files. | +
| memcached_servers = None | +(ListOpt) Memcached servers or None for in process cache. | +
| my_ip = 10.0.0.1 | +(StrOpt) IP address of this host | +
| notification_driver = [] | +(MultiStrOpt) Driver or drivers to handle sending notifications. | +
| notification_topics = notifications | +(ListOpt) AMQP topic used for OpenStack notifications. | +
| notify_api_faults = False | +(BoolOpt) If set, send api.fault notifications on caught exceptions in the API service. | +
| notify_on_state_change = None | +(StrOpt) If set, send compute.instance.update notifications on instance state changes. Valid values are None for no notifications, "vm_state" for notifications on VM state changes, or "vm_and_task_state" for notifications on VM and task state changes. | +
| port = 6379 | +(IntOpt) Use this port to connect to redis host. | +
| pybasedir = /usr/lib/python/site-packages/sources/nova | +(StrOpt) Directory where the nova python module is installed | +
| report_interval = 10 | +(IntOpt) Seconds between nodes reporting state to datastore | +
| rootwrap_config = /etc/nova/rootwrap.conf | +(StrOpt) Path to the rootwrap configuration file to use for running commands as root | +
| service_down_time = 60 | +(IntOpt) Maximum time since last check-in for up service | +
| state_path = $pybasedir | +(StrOpt) Top-level directory for maintaining nova's state | +
| tempdir = None | +(StrOpt) Explicitly specify the temporary working directory | +
| transport_url = None | +(StrOpt) 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. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| compute_available_monitors = ['nova.compute.monitors.all_monitors'] | -(MultiStrOpt) Monitor classes available to the compute which may be specified more than once. | -
| compute_driver = None | -(StrOpt) Driver to use for controlling virtualization. Options include: libvirt.LibvirtDriver, xenapi.XenAPIDriver, fake.FakeDriver, baremetal.BareMetalDriver, vmwareapi.VMwareESXDriver, vmwareapi.VMwareVCDriver | -
| compute_manager = nova.compute.manager.ComputeManager | -(StrOpt) Full class name for the Manager for compute | -
| compute_monitors = | -(ListOpt) A list of monitors that can be used for getting compute metrics. | -
| compute_stats_class = nova.compute.stats.Stats | -(StrOpt) Class that will manage stats for the local compute host | -
| console_host = oslo | -(StrOpt) Console proxy host to use to connect to instances on this host. | -
| console_manager = nova.console.manager.ConsoleProxyManager | -(StrOpt) Full class name for the Manager for console proxy | -
| default_flavor = m1.small | -(StrOpt) Default flavor to use for the EC2 API only. The Nova API does not support a default flavor. | -
| default_notification_level = INFO | -(StrOpt) Default notification level for outgoing notifications | -
| default_publisher_id = None | -(StrOpt) Default publisher_id for outgoing notifications | -
| enable_instance_password = True | -(BoolOpt) Enables returning of the instance password by the relevant server API calls such as create, rebuild or rescue, If the hypervisor does not support password injection then the password returned will not be correct | -
| heal_instance_info_cache_interval = 60 | -(IntOpt) Number of seconds between instance info_cache self healing updates | -
| image_cache_manager_interval = 2400 | -(IntOpt) Number of seconds to wait between runs of the image cache manager | -
| image_cache_subdirectory_name = _base | -(StrOpt) Where cached images are stored under $instances_path. This is NOT the full path - just a folder name. For per-compute-host cached images, set to _base_$my_ip | -
| image_handlers = download | -(ListOpt) Specifies which image handler extension names to use for handling images. The first extension in the list which can handle the image with a suitable location will be used. | -
| instance_build_timeout = 0 | -(IntOpt) Amount of time in seconds an instance can be in BUILD before going into ERROR status.Set to 0 to disable. | -
| instance_delete_interval = 300 | -(IntOpt) Interval in seconds for retrying failed instance file deletes | -
| instance_usage_audit = False | -(BoolOpt) Generate periodic compute.instance.exists notifications | -
| instance_usage_audit_period = month | -(StrOpt) Time period to generate instance usages for. Time period must be hour, day, month or year | -
| instances_path = $state_path/instances | -(StrOpt) Where instances are stored on disk | -
| maximum_instance_delete_attempts = 5 | -(IntOpt) The number of times to attempt to reap an instance's files. | -
| reboot_timeout = 0 | -(IntOpt) Automatically hard reboot an instance if it has been stuck in a rebooting state longer than N seconds. Set to 0 to disable. | -
| reclaim_instance_interval = 0 | -(IntOpt) Interval in seconds for reclaiming deleted instances | -
| resize_confirm_window = 0 | -(IntOpt) Automatically confirm resizes after N seconds. Set to 0 to disable. | -
| resume_guests_state_on_host_boot = False | -(BoolOpt) Whether to start guests that were running before the host rebooted | -
| running_deleted_instance_action = reap | -(StrOpt) Action to take if a running deleted instance is detected.Valid options are 'noop', 'log', 'shutdown', or 'reap'. Set to 'noop' to take no action. | -
| running_deleted_instance_poll_interval = 1800 | -(IntOpt) Number of seconds to wait between runs of the cleanup task. | -
| running_deleted_instance_timeout = 0 | -(IntOpt) Number of seconds after being deleted when a running instance should be considered eligible for cleanup. | -
| shelved_offload_time = 0 | -(IntOpt) Time in seconds before a shelved instance is eligible for removing from a host. -1 never offload, 0 offload when shelved | -
| shelved_poll_interval = 3600 | -(IntOpt) Interval in seconds for polling shelved instances to offload | -
| sync_power_state_interval = 600 | -(IntOpt) Interval to sync power states between the database and the hypervisor | -
| vif_plugging_is_fatal = True | -(BoolOpt) Fail instance boot if vif plugging fails | -
| vif_plugging_timeout = 300 | -(IntOpt) Number of seconds to wait for neutron vif plugging events to arrive before continuing or failing (see vif_plugging_is_fatal). If this is set to zero and vif_plugging_is_fatal is False, events should not be expected to arrive at all. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| compute_available_monitors = ['nova.compute.monitors.all_monitors'] | +(MultiStrOpt) Monitor classes available to the compute which may be specified more than once. | +
| compute_driver = None | +(StrOpt) Driver to use for controlling virtualization. Options include: libvirt.LibvirtDriver, xenapi.XenAPIDriver, fake.FakeDriver, baremetal.BareMetalDriver, vmwareapi.VMwareVCDriver | +
| compute_manager = nova.compute.manager.ComputeManager | +(StrOpt) Full class name for the Manager for compute | +
| compute_monitors = | +(ListOpt) A list of monitors that can be used for getting compute metrics. | +
| compute_stats_class = nova.compute.stats.Stats | +(StrOpt) Class that will manage stats for the local compute host | +
| console_host = oslo | +(StrOpt) Console proxy host to use to connect to instances on this host. | +
| console_manager = nova.console.manager.ConsoleProxyManager | +(StrOpt) Full class name for the Manager for console proxy | +
| default_flavor = m1.small | +(StrOpt) Default flavor to use for the EC2 API only. The Nova API does not support a default flavor. | +
| default_notification_level = INFO | +(StrOpt) Default notification level for outgoing notifications | +
| default_publisher_id = None | +(StrOpt) Default publisher_id for outgoing notifications | +
| enable_instance_password = True | +(BoolOpt) Enables returning of the instance password by the relevant server API calls such as create, rebuild or rescue, If the hypervisor does not support password injection then the password returned will not be correct | +
| heal_instance_info_cache_interval = 60 | +(IntOpt) Number of seconds between instance info_cache self healing updates | +
| image_cache_manager_interval = 2400 | +(IntOpt) Number of seconds to wait between runs of the image cache manager. Set to -1 to disable. Setting this to 0 will disable, but this will change in the K release to mean "run at the default rate". | +
| image_cache_subdirectory_name = _base | +(StrOpt) Where cached images are stored under $instances_path. This is NOT the full path - just a folder name. For per-compute-host cached images, set to _base_$my_ip | +
| instance_build_timeout = 0 | +(IntOpt) Amount of time in seconds an instance can be in BUILD before going into ERROR status.Set to 0 to disable. | +
| instance_delete_interval = 300 | +(IntOpt) Interval in seconds for retrying failed instance file deletes | +
| instance_usage_audit = False | +(BoolOpt) Generate periodic compute.instance.exists notifications | +
| instance_usage_audit_period = month | +(StrOpt) Time period to generate instance usages for. Time period must be hour, day, month or year | +
| instances_path = $state_path/instances | +(StrOpt) Where instances are stored on disk | +
| maximum_instance_delete_attempts = 5 | +(IntOpt) The number of times to attempt to reap an instance's files. | +
| reboot_timeout = 0 | +(IntOpt) Automatically hard reboot an instance if it has been stuck in a rebooting state longer than N seconds. Set to 0 to disable. | +
| reclaim_instance_interval = 0 | +(IntOpt) Interval in seconds for reclaiming deleted instances | +
| resize_confirm_window = 0 | +(IntOpt) Automatically confirm resizes after N seconds. Set to 0 to disable. | +
| resume_guests_state_on_host_boot = False | +(BoolOpt) Whether to start guests that were running before the host rebooted | +
| running_deleted_instance_action = reap | +(StrOpt) Action to take if a running deleted instance is detected.Valid options are 'noop', 'log', 'shutdown', or 'reap'. Set to 'noop' to take no action. | +
| running_deleted_instance_poll_interval = 1800 | +(IntOpt) Number of seconds to wait between runs of the cleanup task. | +
| running_deleted_instance_timeout = 0 | +(IntOpt) Number of seconds after being deleted when a running instance should be considered eligible for cleanup. | +
| shelved_offload_time = 0 | +(IntOpt) Time in seconds before a shelved instance is eligible for removing from a host. -1 never offload, 0 offload when shelved | +
| shelved_poll_interval = 3600 | +(IntOpt) Interval in seconds for polling shelved instances to offload. Set to -1 to disable.Setting this to 0 will disable, but this will change in Juno to mean "run at the default rate". | +
| sync_power_state_interval = 600 | +(IntOpt) Interval to sync power states between the database and the hypervisor. Set to -1 to disable. Setting this to 0 will disable, but this will change in Juno to mean "run at the default rate". | +
| vif_plugging_is_fatal = True | +(BoolOpt) Fail instance boot if vif plugging fails | +
| vif_plugging_timeout = 300 | +(IntOpt) Number of seconds to wait for neutron vif plugging events to arrive before continuing or failing (see vif_plugging_is_fatal). If this is set to zero and vif_plugging_is_fatal is False, events should not be expected to arrive at all. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| migrate_max_retries = -1 | -(IntOpt) Number of times to retry live-migration before failing. If == -1, try until out of hosts. If == 0, only try once, no retries. | -
| [conductor] | -|
| manager = nova.conductor.manager.ConductorManager | -(StrOpt) Full class name for the Manager for conductor | -
| topic = conductor | -(StrOpt) The topic on which conductor nodes listen | -
| use_local = False | -(BoolOpt) Perform nova-conductor operations locally | -
| workers = None | -(IntOpt) Number of workers for OpenStack Conductor service. The default will be the number of CPUs available. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| migrate_max_retries = -1 | +(IntOpt) Number of times to retry live-migration before failing. If == -1, try until out of hosts. If == 0, only try once, no retries. | +
| [conductor] | +|
| manager = nova.conductor.manager.ConductorManager | +(StrOpt) Full class name for the Manager for conductor | +
| topic = conductor | +(StrOpt) The topic on which conductor nodes listen | +
| use_local = False | +(BoolOpt) Perform nova-conductor operations locally | +
| workers = None | +(IntOpt) Number of workers for OpenStack Conductor service. The default will be the number of CPUs available. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| config_drive_format = iso9660 | -(StrOpt) Config drive format. One of iso9660 (default) or vfat | -
| config_drive_skip_versions = 1.0 2007-01-19 2007-03-01 2007-08-29 2007-10-10 2007-12-15 2008-02-01 2008-09-01 | -(StrOpt) List of metadata versions to skip placing into the config drive | -
| config_drive_tempdir = None | -(StrOpt) Where to put temporary files associated with config drive creation | -
| force_config_drive = None | -(StrOpt) Set to force injection to take place on a config drive (if set, valid options are: always) | -
| mkisofs_cmd = genisoimage | -(StrOpt) Name and optionally path of the tool used for ISO image creation | -
| [hyperv] | -|
| config_drive_cdrom = False | -(BoolOpt) Attaches the Config Drive image as a cdrom drive instead of a disk drive | -
| config_drive_inject_password = False | -(BoolOpt) Sets the admin password in the config drive image | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| config_drive_format = iso9660 | +(StrOpt) Config drive format. One of iso9660 (default) or vfat | +
| config_drive_skip_versions = 1.0 2007-01-19 2007-03-01 2007-08-29 2007-10-10 2007-12-15 2008-02-01 2008-09-01 | +(StrOpt) List of metadata versions to skip placing into the config drive | +
| config_drive_tempdir = None | +(StrOpt) Where to put temporary files associated with config drive creation | +
| force_config_drive = None | +(StrOpt) Set to force injection to take place on a config drive (if set, valid options are: always) | +
| mkisofs_cmd = genisoimage | +(StrOpt) Name and optionally path of the tool used for ISO image creation | +
| [hyperv] | +|
| config_drive_cdrom = False | +(BoolOpt) Attaches the Config Drive image as a cdrom drive instead of a disk drive | +
| config_drive_inject_password = False | +(BoolOpt) Sets the admin password in the config drive image | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| console_public_hostname = oslo | -(StrOpt) Publicly visible name for this console host | -
| console_token_ttl = 600 | -(IntOpt) How many seconds before deleting tokens | -
| consoleauth_manager = nova.consoleauth.manager.ConsoleAuthManager | -(StrOpt) Manager for console auth | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| console_public_hostname = oslo | +(StrOpt) Publicly visible name for this console host | +
| console_token_ttl = 600 | +(IntOpt) How many seconds before deleting tokens | +
| consoleauth_manager = nova.consoleauth.manager.ConsoleAuthManager | +(StrOpt) Manager for console auth | +
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| db_driver = nova.db | +(StrOpt) The driver to use for database access | +
| [database] | +|
| backend = sqlalchemy | +(StrOpt) The backend to use for db | +
| connection = None | +(StrOpt) The SQLAlchemy connection string used to connect to the database | +
| connection_debug = 0 | +(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything | +
| connection_trace = False | +(BoolOpt) Add python stack traces to SQL as comment strings | +
| db_inc_retry_interval = True | +(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval | +
| db_max_retries = 20 | +(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count) | +
| db_max_retry_interval = 10 | +(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled | +
| db_retry_interval = 1 | +(IntOpt) seconds between db connection retries | +
| idle_timeout = 3600 | +(IntOpt) Timeout before idle sql connections are reaped | +
| max_overflow = None | +(IntOpt) If set, use this value for max_overflow with sqlalchemy | +
| max_pool_size = None | +(IntOpt) Maximum number of SQL connections to keep open in a pool | +
| max_retries = 10 | +(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count) | +
| min_pool_size = 1 | +(IntOpt) Minimum number of SQL connections to keep open in a pool | +
| mysql_sql_mode = TRADITIONAL | +(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= | +
| pool_timeout = None | +(IntOpt) If set, use this value for pool_timeout with sqlalchemy | +
| retry_interval = 10 | +(IntOpt) Interval between retries of opening a sql connection | +
| slave_connection = None | +(StrOpt) The SQLAlchemy connection string used to connect to the slave database | +
| sqlite_db = nova.sqlite | +(StrOpt) The file name to use with SQLite | +
| sqlite_synchronous = True | +(BoolOpt) If True, SQLite uses synchronous mode | +
| use_db_reconnect = False | +(BoolOpt) Enable the experimental use of database reconnect on connection lost | +
| use_tpool = False | +(BoolOpt) Enable the experimental use of thread pooling for all DB API calls | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| db_driver = nova.db | -(StrOpt) The driver to use for database access | -
| [cells] | -|
| db_check_interval = 60 | -(IntOpt) Interval, in seconds, for getting fresh cell information from the database. | -
| [database] | -|
| backend = sqlalchemy | -(StrOpt) The backend to use for db | -
| connection = None | -(StrOpt) The SQLAlchemy connection string used to connect to the database | -
| connection_debug = 0 | -(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything | -
| connection_trace = False | -(BoolOpt) Add python stack traces to SQL as comment strings | -
| db_inc_retry_interval = True | -(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval | -
| db_max_retries = 20 | -(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count) | -
| db_max_retry_interval = 10 | -(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled | -
| db_retry_interval = 1 | -(IntOpt) seconds between db connection retries | -
| idle_timeout = 3600 | -(IntOpt) Timeout before idle sql connections are reaped | -
| max_overflow = None | -(IntOpt) If set, use this value for max_overflow with sqlalchemy | -
| max_pool_size = None | -(IntOpt) Maximum number of SQL connections to keep open in a pool | -
| max_retries = 10 | -(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count) | -
| min_pool_size = 1 | -(IntOpt) Minimum number of SQL connections to keep open in a pool | -
| mysql_sql_mode = None | -(StrOpt) The SQL mode to be used for MySQL sessions (default is empty, meaning do not override any server-side SQL mode setting) | -
| pool_timeout = None | -(IntOpt) If set, use this value for pool_timeout with sqlalchemy | -
| retry_interval = 10 | -(IntOpt) Interval between retries of opening a sql connection | -
| slave_connection = None | -(StrOpt) The SQLAlchemy connection string used to connect to the slave database | -
| sqlite_db = nova.sqlite | -(StrOpt) The file name to use with SQLite | -
| sqlite_synchronous = True | -(BoolOpt) If True, SQLite uses synchronous mode | -
| use_db_reconnect = False | -(BoolOpt) Enable the experimental use of database reconnect on connection lost | -
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| ec2_dmz_host = $my_ip | -(StrOpt) The internal IP address of the EC2 API server | -
| ec2_host = $my_ip | -(StrOpt) The IP address of the EC2 API server | -
| ec2_listen = 0.0.0.0 | -(StrOpt) The IP address on which the EC2 API will listen. | -
| ec2_listen_port = 8773 | -(IntOpt) The port on which the EC2 API will listen. | -
| ec2_path = /services/Cloud | -(StrOpt) The path prefix used to call the ec2 API server | -
| ec2_port = 8773 | -(IntOpt) The port of the EC2 API server | -
| ec2_private_dns_show_ip = False | -(BoolOpt) Return the IP address as private dns hostname in describe instances | -
| ec2_scheme = http | -(StrOpt) The protocol to use when connecting to the EC2 API server (http, https) | -
| ec2_strict_validation = True | -(BoolOpt) Validate security group names according to EC2 specification | -
| ec2_timestamp_expiry = 300 | -(IntOpt) Time in seconds before ec2 timestamp expires | -
| ec2_workers = None | -(IntOpt) Number of workers for EC2 API service. The default will be equal to the number of CPUs available. | -
| keystone_ec2_url = http://localhost:5000/v2.0/ec2tokens | -(StrOpt) URL to get token from ec2 request. | -
| lockout_attempts = 5 | -(IntOpt) Number of failed auths before lockout. | -
| lockout_minutes = 15 | -(IntOpt) Number of minutes to lockout if triggered. | -
| lockout_window = 15 | -(IntOpt) Number of minutes for lockout window. | -
| region_list = | -(ListOpt) List of region=fqdn pairs separated by commas | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| ec2_dmz_host = $my_ip | +(StrOpt) The internal IP address of the EC2 API server | +
| ec2_host = $my_ip | +(StrOpt) The IP address of the EC2 API server | +
| ec2_listen = 0.0.0.0 | +(StrOpt) The IP address on which the EC2 API will listen. | +
| ec2_listen_port = 8773 | +(IntOpt) The port on which the EC2 API will listen. | +
| ec2_path = /services/Cloud | +(StrOpt) The path prefix used to call the ec2 API server | +
| ec2_port = 8773 | +(IntOpt) The port of the EC2 API server | +
| ec2_private_dns_show_ip = False | +(BoolOpt) Return the IP address as private dns hostname in describe instances | +
| ec2_scheme = http | +(StrOpt) The protocol to use when connecting to the EC2 API server (http, https) | +
| ec2_strict_validation = True | +(BoolOpt) Validate security group names according to EC2 specification | +
| ec2_timestamp_expiry = 300 | +(IntOpt) Time in seconds before ec2 timestamp expires | +
| ec2_workers = None | +(IntOpt) Number of workers for EC2 API service. The default will be equal to the number of CPUs available. | +
| keystone_ec2_url = http://localhost:5000/v2.0/ec2tokens | +(StrOpt) URL to get token from ec2 request. | +
| lockout_attempts = 5 | +(IntOpt) Number of failed auths before lockout. | +
| lockout_minutes = 15 | +(IntOpt) Number of minutes to lockout if triggered. | +
| lockout_window = 15 | +(IntOpt) Number of minutes for lockout window. | +
| region_list = | +(ListOpt) List of region=fqdn pairs separated by commas | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| fping_path = /usr/sbin/fping | -(StrOpt) Full path to fping. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| fping_path = /usr/sbin/fping | +(StrOpt) Full path to fping. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| allowed_direct_url_schemes = | -(ListOpt) A list of url scheme that can be downloaded directly via the direct_url. Currently supported schemes: [file]. | -
| glance_api_insecure = False | -(BoolOpt) Allow to perform insecure SSL (https) requests to glance | -
| glance_api_servers = $glance_host:$glance_port | -(ListOpt) A list of the glance api servers available to nova. Prefix with https:// for ssl-based glance api servers. ([hostname|ip]:port) | -
| glance_host = $my_ip | -(StrOpt) Default glance hostname or IP address | -
| glance_num_retries = 0 | -(IntOpt) Number of retries when downloading an image from glance | -
| glance_port = 9292 | -(IntOpt) Default glance port | -
| glance_protocol = http | -(StrOpt) Default protocol to use when connecting to glance. Set to https for SSL. | -
| osapi_glance_link_prefix = None | -(StrOpt) Base URL that will be presented to users in links to glance resources | -
| [image_file_url] | -|
| filesystems = | -(ListOpt) List of file systems that are configured in this file in the image_file_url:<list entry name> sections | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| osapi_glance_link_prefix = None | +(StrOpt) Base URL that will be presented to users in links to glance resources | +
| [glance] | +|
| allowed_direct_url_schemes = | +(ListOpt) A list of url scheme that can be downloaded directly via the direct_url. Currently supported schemes: [file]. | +
| api_insecure = False | +(BoolOpt) Allow to perform insecure SSL (https) requests to glance | +
| api_servers = None | +(ListOpt) A list of the glance api servers available to nova. Prefix with https:// for ssl-based glance api servers. ([hostname|ip]:port) | +
| host = $my_ip | +(StrOpt) Default glance hostname or IP address | +
| num_retries = 0 | +(IntOpt) Number of retries when downloading an image from glance | +
| port = 9292 | +(IntOpt) Default glance port | +
| protocol = http | +(StrOpt) Default protocol to use when connecting to glance. Set to https for SSL. | +
| [image_file_url] | +|
| filesystems = | +(ListOpt) List of file systems that are configured in this file in the image_file_url:<list entry name> sections | +
| Configuration option = Default value | -Description | -
|---|---|
| [hyperv] | -|
| dynamic_memory_ratio = 1.0 | -(FloatOpt) Enables dynamic memory allocation (ballooning) when set to a value greater than 1. The value expresses the ratio between the total RAM assigned to an instance and its startup RAM amount. For example a ratio of 2.0 for an instance with 1024MB of RAM implies 512MB of RAM allocated at startup | -
| enable_instance_metrics_collection = False | -(BoolOpt) Enables metrics collections for an instance by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above | -
| force_hyperv_utils_v1 = False | -(BoolOpt) Force V1 WMI utility classes | -
| instances_path_share = | -(StrOpt) The name of a Windows share name mapped to the "instances_path" dir and used by the resize feature to copy files to the target host. If left blank, an administrative share will be used, looking for the same "instances_path" used locally | -
| limit_cpu_features = False | -(BoolOpt) Required for live migration among hosts with different CPU features | -
| mounted_disk_query_retry_count = 10 | -(IntOpt) The number of times to retry checking for a disk mounted via iSCSI. | -
| mounted_disk_query_retry_interval = 5 | -(IntOpt) Interval between checks for a mounted iSCSI disk, in seconds. | -
| qemu_img_cmd = qemu-img.exe | -(StrOpt) Path of qemu-img command which is used to convert between different image types | -
| vswitch_name = None | -(StrOpt) External virtual switch Name, if not provided, the first external virtual switch is used | -
| Configuration option = Default value | +Description | +
|---|---|
| [hyperv] | +|
| dynamic_memory_ratio = 1.0 | +(FloatOpt) Enables dynamic memory allocation (ballooning) when set to a value greater than 1. The value expresses the ratio between the total RAM assigned to an instance and its startup RAM amount. For example a ratio of 2.0 for an instance with 1024MB of RAM implies 512MB of RAM allocated at startup | +
| enable_instance_metrics_collection = False | +(BoolOpt) Enables metrics collections for an instance by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above | +
| force_hyperv_utils_v1 = False | +(BoolOpt) Force V1 WMI utility classes | +
| instances_path_share = | +(StrOpt) The name of a Windows share name mapped to the "instances_path" dir and used by the resize feature to copy files to the target host. If left blank, an administrative share will be used, looking for the same "instances_path" used locally | +
| limit_cpu_features = False | +(BoolOpt) Required for live migration among hosts with different CPU features | +
| mounted_disk_query_retry_count = 10 | +(IntOpt) The number of times to retry checking for a disk mounted via iSCSI. | +
| mounted_disk_query_retry_interval = 5 | +(IntOpt) Interval between checks for a mounted iSCSI disk, in seconds. | +
| qemu_img_cmd = qemu-img.exe | +(StrOpt) Path of qemu-img command which is used to convert between different image types | +
| vswitch_name = None | +(StrOpt) External virtual switch Name, if not provided, the first external virtual switch is used | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| default_ephemeral_format = None | -(StrOpt) The default format an ephemeral_volume will be formatted with on creation. | -
| force_raw_images = True | -(BoolOpt) Force backing images to raw format | -
| preallocate_images = none | -(StrOpt) VM image preallocation mode: "none" => no storage provisioning is done up front, "space" => storage is fully allocated at instance start | -
| rescue_timeout = 0 | -(IntOpt) Automatically unrescue an instance after N seconds. Set to 0 to disable. | -
| timeout_nbd = 10 | -(IntOpt) Amount of time, in seconds, to wait for NBD device start up. | -
| use_cow_images = True | -(BoolOpt) Whether to use cow images | -
| vcpu_pin_set = None | -(StrOpt) Defines which pcpus that instance vcpus can use. For example, "4-12,^8,15" | -
| virt_mkfs = [] | -(MultiStrOpt) Name of the mkfs commands for ephemeral device. The format is <os_type>=<mkfs command> | -
| [libvirt] | -|
| block_migration_flag = VIR_MIGRATE_UNDEFINE_SOURCE, VIR_MIGRATE_PEER2PEER, VIR_MIGRATE_NON_SHARED_INC | -(StrOpt) Migration flags to be set for block migration | -
| disk_cachemodes = | -(ListOpt) Specific cachemodes to use for different disk types e.g: file=directsync,block=none | -
| images_rbd_ceph_conf = | -(StrOpt) Path to the ceph configuration file to use | -
| images_rbd_pool = rbd | -(StrOpt) The RADOS pool in which rbd volumes are stored | -
| images_type = default | -(StrOpt) VM Images format. Acceptable values are: raw, qcow2, lvm, rbd, default. If default is specified, then use_cow_images flag is used instead of this one. | -
| images_volume_group = None | -(StrOpt) LVM Volume Group that is used for VM images, when you specify images_type=lvm. | -
| inject_key = False | -(BoolOpt) Inject the ssh public key at boot time | -
| inject_partition = -2 | -(IntOpt) The partition to inject to : -2 => disable, -1 => inspect (libguestfs only), 0 => not partitioned, >0 => partition number | -
| inject_password = False | -(BoolOpt) Inject the admin password at boot time, without an agent. | -
| iscsi_use_multipath = False | -(BoolOpt) Use multipath connection of the iSCSI volume | -
| iser_use_multipath = False | -(BoolOpt) Use multipath connection of the iSER volume | -
| rescue_image_id = None | -(StrOpt) Rescue ami image | -
| rescue_kernel_id = None | -(StrOpt) Rescue aki image | -
| rescue_ramdisk_id = None | -(StrOpt) Rescue ari image | -
| snapshot_compression = False | -(BoolOpt) Compress snapshot images when possible. This currently applies exclusively to qcow2 images | -
| snapshot_image_format = None | -(StrOpt) Snapshot image format (valid options are : raw, qcow2, vmdk, vdi). Defaults to same as source image | -
| sparse_logical_volumes = False | -(BoolOpt) Create sparse logical volumes (with virtualsize) if this flag is set to True. | -
| use_usb_tablet = True | -(BoolOpt) Sync virtual and real mouse cursors in Windows VMs | -
| use_virtio_for_bridges = True | -(BoolOpt) Use virtio for bridge interfaces with KVM/QEMU | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| default_ephemeral_format = None | +(StrOpt) The default format an ephemeral_volume will be formatted with on creation. | +
| force_raw_images = True | +(BoolOpt) Force backing images to raw format | +
| preallocate_images = none | +(StrOpt) VM image preallocation mode: "none" => no storage provisioning is done up front, "space" => storage is fully allocated at instance start | +
| rescue_timeout = 0 | +(IntOpt) Automatically unrescue an instance after N seconds. Set to 0 to disable. | +
| timeout_nbd = 10 | +(IntOpt) Amount of time, in seconds, to wait for NBD device start up. | +
| use_cow_images = True | +(BoolOpt) Whether to use cow images | +
| vcpu_pin_set = None | +(StrOpt) Defines which pcpus that instance vcpus can use. For example, "4-12,^8,15" | +
| virt_mkfs = [] | +(MultiStrOpt) Name of the mkfs commands for ephemeral device. The format is <os_type>=<mkfs command> | +
| [libvirt] | +|
| block_migration_flag = VIR_MIGRATE_UNDEFINE_SOURCE, VIR_MIGRATE_PEER2PEER, VIR_MIGRATE_NON_SHARED_INC | +(StrOpt) Migration flags to be set for block migration | +
| disk_cachemodes = | +(ListOpt) Specific cachemodes to use for different disk types e.g: file=directsync,block=none | +
| images_rbd_ceph_conf = | +(StrOpt) Path to the ceph configuration file to use | +
| images_rbd_pool = rbd | +(StrOpt) The RADOS pool in which rbd volumes are stored | +
| images_type = default | +(StrOpt) VM Images format. Acceptable values are: raw, qcow2, lvm, rbd, default. If default is specified, then use_cow_images flag is used instead of this one. | +
| images_volume_group = None | +(StrOpt) LVM Volume Group that is used for VM images, when you specify images_type=lvm. | +
| inject_key = False | +(BoolOpt) Inject the ssh public key at boot time | +
| inject_partition = -2 | +(IntOpt) The partition to inject to : -2 => disable, -1 => inspect (libguestfs only), 0 => not partitioned, >0 => partition number | +
| inject_password = False | +(BoolOpt) Inject the admin password at boot time, without an agent. | +
| iscsi_use_multipath = False | +(BoolOpt) Use multipath connection of the iSCSI volume | +
| iser_use_multipath = False | +(BoolOpt) Use multipath connection of the iSER volume | +
| rescue_image_id = None | +(StrOpt) Rescue ami image. This will not be used if an image id is provided by the user. | +
| rescue_kernel_id = None | +(StrOpt) Rescue aki image | +
| rescue_ramdisk_id = None | +(StrOpt) Rescue ari image | +
| snapshot_compression = False | +(BoolOpt) Compress snapshot images when possible. This currently applies exclusively to qcow2 images | +
| snapshot_image_format = None | +(StrOpt) Snapshot image format (valid options are : raw, qcow2, vmdk, vdi). Defaults to same as source image | +
| sparse_logical_volumes = False | +(BoolOpt) Create sparse logical volumes (with virtualsize) if this flag is set to True. | +
| use_usb_tablet = True | +(BoolOpt) Sync virtual and real mouse cursors in Windows VMs | +
| use_virtio_for_bridges = True | +(BoolOpt) Use virtio for bridge interfaces with KVM/QEMU | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| fixed_range_v6 = fd00::/48 | -(StrOpt) Fixed IPv6 address block | -
| gateway_v6 = None | -(StrOpt) Default IPv6 gateway | -
| ipv6_backend = rfc2462 | -(StrOpt) Backend to use for IPv6 generation | -
| use_ipv6 = False | -(BoolOpt) Use IPv6 | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| fixed_range_v6 = fd00::/48 | +(StrOpt) Fixed IPv6 address block | +
| gateway_v6 = None | +(StrOpt) Default IPv6 gateway | +
| ipv6_backend = rfc2462 | +(StrOpt) Backend to use for IPv6 generation | +
| use_ipv6 = False | +(BoolOpt) Use IPv6 | +
| Configuration option = Default value | -Description | -
|---|---|
| [keymgr] | -|
| api_class = nova.keymgr.conf_key_mgr.ConfKeyManager | -(StrOpt) The full class name of the key manager API class | -
| fixed_key = None | -(StrOpt) Fixed key returned by key manager, specified in hex | -
| Configuration option = Default value | +Description | +
|---|---|
| [keymgr] | +|
| api_class = nova.keymgr.conf_key_mgr.ConfKeyManager | +(StrOpt) The full class name of the key manager API class | +
| fixed_key = None | +(StrOpt) Fixed key returned by key manager, specified in hex | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| kombu_reconnect_delay = 1.0 | -(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| kombu_ssl_ca_certs = | -(StrOpt) SSL certification authority file (valid only if SSL enabled). | -
| kombu_ssl_certfile = | -(StrOpt) SSL cert file (valid only if SSL enabled). | -
| kombu_ssl_keyfile = | -(StrOpt) SSL key file (valid only if SSL enabled). | -
| kombu_ssl_version = | -(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| kombu_reconnect_delay = 1.0 | +(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | +
| kombu_ssl_ca_certs = | +(StrOpt) SSL certification authority file (valid only if SSL enabled). | +
| kombu_ssl_certfile = | +(StrOpt) SSL cert file (valid only if SSL enabled). | +
| kombu_ssl_keyfile = | +(StrOpt) SSL key file (valid only if SSL enabled). | +
| kombu_ssl_version = | +(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| ldap_dns_base_dn = ou=hosts,dc=example,dc=org | -(StrOpt) Base DN for DNS entries in LDAP | -
| ldap_dns_password = password | -(StrOpt) Password for LDAP DNS | -
| ldap_dns_servers = ['dns.example.org'] | -(MultiStrOpt) DNS Servers for LDAP DNS driver | -
| ldap_dns_soa_expiry = 86400 | -(StrOpt) Expiry interval (in seconds) for LDAP DNS driver Statement of Authority | -
| ldap_dns_soa_hostmaster = hostmaster@example.org | -(StrOpt) Hostmaster for LDAP DNS driver Statement of Authority | -
| ldap_dns_soa_minimum = 7200 | -(StrOpt) Minimum interval (in seconds) for LDAP DNS driver Statement of Authority | -
| ldap_dns_soa_refresh = 1800 | -(StrOpt) Refresh interval (in seconds) for LDAP DNS driver Statement of Authority | -
| ldap_dns_soa_retry = 3600 | -(StrOpt) Retry interval (in seconds) for LDAP DNS driver Statement of Authority | -
| ldap_dns_url = ldap://ldap.example.com:389 | -(StrOpt) URL for LDAP server which will store DNS entries | -
| ldap_dns_user = uid=admin,ou=people,dc=example,dc=org | -(StrOpt) User for LDAP DNS | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| ldap_dns_base_dn = ou=hosts,dc=example,dc=org | +(StrOpt) Base DN for DNS entries in LDAP | +
| ldap_dns_password = password | +(StrOpt) Password for LDAP DNS | +
| ldap_dns_servers = ['dns.example.org'] | +(MultiStrOpt) DNS Servers for LDAP DNS driver | +
| ldap_dns_soa_expiry = 86400 | +(StrOpt) Expiry interval (in seconds) for LDAP DNS driver Statement of Authority | +
| ldap_dns_soa_hostmaster = hostmaster@example.org | +(StrOpt) Hostmaster for LDAP DNS driver Statement of Authority | +
| ldap_dns_soa_minimum = 7200 | +(StrOpt) Minimum interval (in seconds) for LDAP DNS driver Statement of Authority | +
| ldap_dns_soa_refresh = 1800 | +(StrOpt) Refresh interval (in seconds) for LDAP DNS driver Statement of Authority | +
| ldap_dns_soa_retry = 3600 | +(StrOpt) Retry interval (in seconds) for LDAP DNS driver Statement of Authority | +
| ldap_dns_url = ldap://ldap.example.com:389 | +(StrOpt) URL for LDAP server which will store DNS entries | +
| ldap_dns_user = uid=admin,ou=people,dc=example,dc=org | +(StrOpt) User for LDAP DNS | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| remove_unused_base_images = True | -(BoolOpt) Should unused base images be removed? | -
| remove_unused_original_minimum_age_seconds = 86400 | -(IntOpt) Unused unresized base images younger than this will not be removed | -
| [libvirt] | -|
| checksum_base_images = False | -(BoolOpt) Write a checksum for files in _base to disk | -
| checksum_interval_seconds = 3600 | -(IntOpt) How frequently to checksum base images | -
| connection_uri = | -(StrOpt) Override the default libvirt URI (which is dependent on virt_type) | -
| cpu_mode = None | -(StrOpt) Set to "host-model" to clone the host CPU feature flags; to "host-passthrough" to use the host CPU model exactly; to "custom" to use a named CPU model; to "none" to not set any CPU model. If virt_type="kvm|qemu", it will default to "host-model", otherwise it will default to "none" | -
| cpu_model = None | -(StrOpt) Set to a named libvirt CPU model (see names listed in /usr/share/libvirt/cpu_map.xml). Only has effect if cpu_mode="custom" and virt_type="kvm|qemu" | -
| disk_prefix = None | -(StrOpt) Override the default disk prefix for the devices attached to a server, which is dependent on virt_type. (valid options are: sd, xvd, uvd, vd) | -
| image_info_filename_pattern = $instances_path/$image_cache_subdirectory_name/%(image)s.info | -(StrOpt) Allows image information files to be stored in non-standard locations | -
| remove_unused_kernels = False | -(BoolOpt) Should unused kernel images be removed? This is only safe to enable if all compute nodes have been updated to support this option. This will be enabled by default in future. | -
| remove_unused_resized_minimum_age_seconds = 3600 | -(IntOpt) Unused resized base images younger than this will not be removed | -
| rng_dev_path = None | -(StrOpt) A path to a device that will be used as source of entropy on the host. Permitted options are: /dev/random or /dev/hwrng | -
| snapshots_directory = $instances_path/snapshots | -(StrOpt) Location where libvirt driver will store snapshots before uploading them to image service | -
| vif_driver = nova.virt.libvirt.vif.LibvirtGenericVIFDriver | -(StrOpt) DEPRECATED. The libvirt VIF driver to configure the VIFs.This option is deprecated and will be removed in the Juno release. | -
| virt_type = kvm | -(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen) | -
| volume_clear = zero | -(StrOpt) Method used to wipe old volumes (valid options are: none, zero, shred) | -
| volume_clear_size = 0 | -(IntOpt) Size in MiB to wipe at start of old volumes. 0 => all | -
| volume_drivers = iscsi=nova.virt.libvirt.volume.LibvirtISCSIVolumeDriver, iser=nova.virt.libvirt.volume.LibvirtISERVolumeDriver, local=nova.virt.libvirt.volume.LibvirtVolumeDriver, fake=nova.virt.libvirt.volume.LibvirtFakeVolumeDriver, rbd=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, sheepdog=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, nfs=nova.virt.libvirt.volume.LibvirtNFSVolumeDriver, aoe=nova.virt.libvirt.volume.LibvirtAOEVolumeDriver, glusterfs=nova.virt.libvirt.volume.LibvirtGlusterfsVolumeDriver, fibre_channel=nova.virt.libvirt.volume.LibvirtFibreChannelVolumeDriver, scality=nova.virt.libvirt.volume.LibvirtScalityVolumeDriver | -(ListOpt) Libvirt handlers for remote volumes. | -
| wait_soft_reboot_seconds = 120 | -(IntOpt) Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| remove_unused_base_images = True | +(BoolOpt) Should unused base images be removed? | +
| remove_unused_original_minimum_age_seconds = 86400 | +(IntOpt) Unused unresized base images younger than this will not be removed | +
| [libvirt] | +|
| checksum_base_images = False | +(BoolOpt) Write a checksum for files in _base to disk | +
| checksum_interval_seconds = 3600 | +(IntOpt) How frequently to checksum base images | +
| connection_uri = | +(StrOpt) Override the default libvirt URI (which is dependent on virt_type) | +
| cpu_mode = None | +(StrOpt) Set to "host-model" to clone the host CPU feature flags; to "host-passthrough" to use the host CPU model exactly; to "custom" to use a named CPU model; to "none" to not set any CPU model. If virt_type="kvm|qemu", it will default to "host-model", otherwise it will default to "none" | +
| cpu_model = None | +(StrOpt) Set to a named libvirt CPU model (see names listed in /usr/share/libvirt/cpu_map.xml). Only has effect if cpu_mode="custom" and virt_type="kvm|qemu" | +
| disk_prefix = None | +(StrOpt) Override the default disk prefix for the devices attached to a server, which is dependent on virt_type. (valid options are: sd, xvd, uvd, vd) | +
| image_info_filename_pattern = $instances_path/$image_cache_subdirectory_name/%(image)s.info | +(StrOpt) Allows image information files to be stored in non-standard locations | +
| remove_unused_kernels = False | +(BoolOpt) Should unused kernel images be removed? This is only safe to enable if all compute nodes have been updated to support this option. This will be enabled by default in future. | +
| remove_unused_resized_minimum_age_seconds = 3600 | +(IntOpt) Unused resized base images younger than this will not be removed | +
| rng_dev_path = None | +(StrOpt) A path to a device that will be used as source of entropy on the host. Permitted options are: /dev/random or /dev/hwrng | +
| snapshots_directory = $instances_path/snapshots | +(StrOpt) Location where libvirt driver will store snapshots before uploading them to image service | +
| vif_driver = nova.virt.libvirt.vif.LibvirtGenericVIFDriver | +(StrOpt) DEPRECATED. The libvirt VIF driver to configure the VIFs.This option is deprecated and will be removed in the Juno release. | +
| virt_type = kvm | +(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen) | +
| volume_clear = zero | +(StrOpt) Method used to wipe old volumes (valid options are: none, zero, shred) | +
| volume_clear_size = 0 | +(IntOpt) Size in MiB to wipe at start of old volumes. 0 => all | +
| volume_drivers = iscsi=nova.virt.libvirt.volume.LibvirtISCSIVolumeDriver, iser=nova.virt.libvirt.volume.LibvirtISERVolumeDriver, local=nova.virt.libvirt.volume.LibvirtVolumeDriver, fake=nova.virt.libvirt.volume.LibvirtFakeVolumeDriver, rbd=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, sheepdog=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, nfs=nova.virt.libvirt.volume.LibvirtNFSVolumeDriver, aoe=nova.virt.libvirt.volume.LibvirtAOEVolumeDriver, glusterfs=nova.virt.libvirt.volume.LibvirtGlusterfsVolumeDriver, fibre_channel=nova.virt.libvirt.volume.LibvirtFibreChannelVolumeDriver, scality=nova.virt.libvirt.volume.LibvirtScalityVolumeDriver | +(ListOpt) Libvirt handlers for remote volumes. | +
| wait_soft_reboot_seconds = 120 | +(IntOpt) Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| live_migration_retry_count = 30 | -(IntOpt) Number of 1 second retries needed in live_migration | -
| [libvirt] | -|
| live_migration_bandwidth = 0 | -(IntOpt) Maximum bandwidth to be used during migration, in Mbps | -
| live_migration_flag = VIR_MIGRATE_UNDEFINE_SOURCE, VIR_MIGRATE_PEER2PEER | -(StrOpt) Migration flags to be set for live migration | -
| live_migration_uri = qemu+tcp://%s/system | -(StrOpt) Migration target URI (any included "%s" is replaced with the migration target hostname) | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| live_migration_retry_count = 30 | +(IntOpt) Number of 1 second retries needed in live_migration | +
| [libvirt] | +|
| live_migration_bandwidth = 0 | +(IntOpt) Maximum bandwidth to be used during migration, in Mbps | +
| live_migration_flag = VIR_MIGRATE_UNDEFINE_SOURCE, VIR_MIGRATE_PEER2PEER | +(StrOpt) Migration flags to be set for live migration | +
| live_migration_uri = qemu+tcp://%s/system | +(StrOpt) Migration target URI (any included "%s" is replaced with the migration target hostname) | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| debug = False | -(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | -
| default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN | -(ListOpt) list of logger=LEVEL pairs | -
| fatal_deprecations = False | -(BoolOpt) make deprecations fatal | -
| fatal_exception_format_errors = False | -(BoolOpt) Make exception message format errors fatal | -
| instance_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance is passed with the log message, format it like this | -
| instance_uuid_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance UUID is passed with the log message, format it like this | -
| log_config_append = None | -(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files. | -
| log_date_format = %Y-%m-%d %H:%M:%S | -(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s | -
| log_dir = None | -(StrOpt) (Optional) The base directory used for relative --log-file paths | -
| log_file = None | -(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | -
| log_format = None | -(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | -
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user)s %(tenant)s] %(instance)s%(message)s | -(StrOpt) format string to use for log messages with context | -
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | -(StrOpt) data to append to log format when level is DEBUG | -
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | -(StrOpt) format string to use for log messages without context | -
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -(StrOpt) prefix each line of exception output with this format | -
| publish_errors = False | -(BoolOpt) publish error events | -
| syslog_log_facility = LOG_USER | -(StrOpt) syslog facility to receive log lines | -
| use_stderr = True | -(BoolOpt) Log output to standard error | -
| use_syslog = False | -(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424 | -
| use_syslog_rfc_format = False | -(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J. | -
| verbose = False | -(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| debug = False | +(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | +
| default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN | +(ListOpt) List of logger=LEVEL pairs. | +
| fatal_deprecations = False | +(BoolOpt) Enables or disables fatal status of deprecations. | +
| fatal_exception_format_errors = False | +(BoolOpt) Make exception message format errors fatal | +
| instance_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance that is passed with the log message. | +
| instance_uuid_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance UUID that is passed with the log message. | +
| log_config_append = None | +(StrOpt) 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. | +
| log_date_format = %Y-%m-%d %H:%M:%S | +(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . | +
| log_dir = None | +(StrOpt) (Optional) The base directory used for relative --log-file paths. | +
| log_file = None | +(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | +
| log_format = None | +(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | +
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages with context. | +
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | +(StrOpt) Data to append to log format when level is DEBUG. | +
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages without context. | +
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | +(StrOpt) Prefix each line of exception output with this format. | +
| publish_errors = False | +(BoolOpt) Enables or disables publication of error events. | +
| syslog_log_facility = LOG_USER | +(StrOpt) Syslog facility to receive log lines. | +
| use_stderr = True | +(BoolOpt) Log output to standard error. | +
| use_syslog = False | +(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424. | +
| use_syslog_rfc_format = False | +(BoolOpt) (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 I, and will be removed in J. | +
| verbose = False | +(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| metadata_host = $my_ip | -(StrOpt) The IP address for the metadata API server | -
| metadata_listen = 0.0.0.0 | -(StrOpt) The IP address on which the metadata API will listen. | -
| metadata_listen_port = 8775 | -(IntOpt) The port on which the metadata API will listen. | -
| metadata_manager = nova.api.manager.MetadataManager | -(StrOpt) OpenStack metadata service manager | -
| metadata_port = 8775 | -(IntOpt) The port for the metadata API port | -
| metadata_workers = None | -(IntOpt) Number of workers for metadata service. The default will be the number of CPUs available. | -
| vendordata_driver = nova.api.metadata.vendordata_json.JsonFileVendorData | -(StrOpt) Driver to use for vendor data | -
| vendordata_jsonfile_path = None | -(StrOpt) File to load json formatted vendor data from | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| metadata_host = $my_ip | +(StrOpt) The IP address for the metadata API server | +
| metadata_listen = 0.0.0.0 | +(StrOpt) The IP address on which the metadata API will listen. | +
| metadata_listen_port = 8775 | +(IntOpt) The port on which the metadata API will listen. | +
| metadata_manager = nova.api.manager.MetadataManager | +(StrOpt) OpenStack metadata service manager | +
| metadata_port = 8775 | +(IntOpt) The port for the metadata API port | +
| metadata_workers = None | +(IntOpt) Number of workers for metadata service. The default will be the number of CPUs available. | +
| vendordata_driver = nova.api.metadata.vendordata_json.JsonFileVendorData | +(StrOpt) Driver to use for vendor data | +
| vendordata_jsonfile_path = None | +(StrOpt) File to load json formatted vendor data from | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| allow_same_net_traffic = True | -(BoolOpt) Whether to allow network traffic from same network | -
| auto_assign_floating_ip = False | -(BoolOpt) Autoassigning floating IP to VM | -
| cnt_vpn_clients = 0 | -(IntOpt) Number of addresses reserved for vpn clients | -
| create_unique_mac_address_attempts = 5 | -(IntOpt) Number of attempts to create unique mac address | -
| default_access_ip_network_name = None | -(StrOpt) Name of network to use to set access IPs for instances | -
| default_floating_pool = nova | -(StrOpt) Default pool for floating IPs | -
| defer_iptables_apply = False | -(BoolOpt) Whether to batch up the application of IPTables rules during a host restart and apply all at the end of the init phase | -
| dhcp_domain = novalocal | -(StrOpt) Domain to use for building the hostnames | -
| dhcp_lease_time = 120 | -(IntOpt) Lifetime of a DHCP lease in seconds | -
| dhcpbridge = $bindir/nova-dhcpbridge | -(StrOpt) Location of nova-dhcpbridge | -
| dhcpbridge_flagfile = ['/etc/nova/nova-dhcpbridge.conf'] | -(MultiStrOpt) Location of flagfiles for dhcpbridge | -
| dns_server = [] | -(MultiStrOpt) If set, uses specific DNS server for dnsmasq. Can be specified multiple times. | -
| dns_update_periodic_interval = -1 | -(IntOpt) Number of seconds to wait between runs of updates to DNS entries. | -
| dnsmasq_config_file = | -(StrOpt) Override the default dnsmasq settings with this file | -
| firewall_driver = None | -(StrOpt) Firewall driver (defaults to hypervisor specific iptables driver) | -
| fixed_ip_disassociate_timeout = 600 | -(IntOpt) Seconds after which a deallocated IP is disassociated | -
| flat_injected = False | -(BoolOpt) Whether to attempt to inject network setup into guest | -
| flat_interface = None | -(StrOpt) FlatDhcp will bridge into this interface if set | -
| flat_network_bridge = None | -(StrOpt) Bridge for simple network instances | -
| flat_network_dns = 8.8.4.4 | -(StrOpt) DNS server for simple network | -
| floating_ip_dns_manager = nova.network.noop_dns_driver.NoopDNSDriver | -(StrOpt) Full class name for the DNS Manager for floating IPs | -
| force_dhcp_release = True | -(BoolOpt) If True, send a dhcp release on instance termination | -
| force_snat_range = [] | -(MultiStrOpt) Traffic to this range will always be snatted to the fallback ip, even if it would normally be bridged out of the node. Can be specified multiple times. | -
| forward_bridge_interface = ['all'] | -(MultiStrOpt) An interface that bridges can forward to. If this is set to all then all traffic will be forwarded. Can be specified multiple times. | -
| gateway = None | -(StrOpt) Default IPv4 gateway | -
| injected_network_template = $pybasedir/nova/virt/interfaces.template | -(StrOpt) Template file for injected network | -
| instance_dns_domain = | -(StrOpt) Full class name for the DNS Zone for instance IPs | -
| instance_dns_manager = nova.network.noop_dns_driver.NoopDNSDriver | -(StrOpt) Full class name for the DNS Manager for instance IPs | -
| iptables_bottom_regex = | -(StrOpt) Regular expression to match iptables rule that should always be on the bottom. | -
| iptables_drop_action = DROP | -(StrOpt) The table that iptables to jump to when a packet is to be dropped. | -
| iptables_top_regex = | -(StrOpt) Regular expression to match iptables rule that should always be on the top. | -
| l3_lib = nova.network.l3.LinuxNetL3 | -(StrOpt) Indicates underlying L3 management library | -
| linuxnet_interface_driver = nova.network.linux_net.LinuxBridgeInterfaceDriver | -(StrOpt) Driver used to create ethernet devices. | -
| linuxnet_ovs_integration_bridge = br-int | -(StrOpt) Name of Open vSwitch bridge used with linuxnet | -
| multi_host = False | -(BoolOpt) Default value for multi_host in networks. Also, if set, some rpc network calls will be sent directly to host. | -
| network_allocate_retries = 0 | -(IntOpt) Number of times to retry network allocation on failures | -
| network_api_class = nova.network.api.API | -(StrOpt) The full class name of the network API class to use | -
| network_device_mtu = None | -(IntOpt) MTU setting for network interface | -
| network_driver = nova.network.linux_net | -(StrOpt) Driver to use for network creation | -
| network_manager = nova.network.manager.VlanManager | -(StrOpt) Full class name for the Manager for network | -
| network_size = 256 | -(IntOpt) Number of addresses in each private subnet | -
| network_topic = network | -(StrOpt) The topic network nodes listen on | -
| networks_path = $state_path/networks | -(StrOpt) Location to keep network config files | -
| num_networks = 1 | -(IntOpt) Number of networks to support | -
| ovs_vsctl_timeout = 120 | -(IntOpt) Amount of time, in seconds, that ovs_vsctl should wait for a response from the database. 0 is to wait forever. | -
| public_interface = eth0 | -(StrOpt) Interface for public IP addresses | -
| routing_source_ip = $my_ip | -(StrOpt) Public IP of network host | -
| security_group_api = nova | -(StrOpt) The full class name of the security API class | -
| send_arp_for_ha = False | -(BoolOpt) Send gratuitous ARPs for HA setup | -
| send_arp_for_ha_count = 3 | -(IntOpt) Send this many gratuitous ARPs for HA setup | -
| share_dhcp_address = False | -(BoolOpt) If True in multi_host mode, all compute hosts share the same dhcp address. The same IP address used for DHCP will be added on each nova-network node which is only visible to the vms on the same host. | -
| teardown_unused_network_gateway = False | -(BoolOpt) If True, unused gateway devices (VLAN and bridge) are deleted in VLAN network mode with multi hosted networks | -
| update_dns_entries = False | -(BoolOpt) If True, when a DNS entry must be updated, it sends a fanout cast to all network hosts to update their DNS entries in multi host mode | -
| use_network_dns_servers = False | -(BoolOpt) If set, uses the dns1 and dns2 from the network ref. as dns servers. | -
| use_neutron_default_nets = False | -(StrOpt) Control for checking for default networks | -
| use_single_default_gateway = False | -(BoolOpt) Use single default gateway. Only first nic of vm will get default gateway from dhcp server | -
| vlan_interface = None | -(StrOpt) VLANs will bridge into this interface if set | -
| vlan_start = 100 | -(IntOpt) First VLAN for private networks | -
| [vmware] | -|
| vlan_interface = vmnic0 | -(StrOpt) Physical ethernet adapter name for vlan networking | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| allow_same_net_traffic = True | +(BoolOpt) Whether to allow network traffic from same network | +
| auto_assign_floating_ip = False | +(BoolOpt) Autoassigning floating IP to VM | +
| cnt_vpn_clients = 0 | +(IntOpt) Number of addresses reserved for vpn clients | +
| create_unique_mac_address_attempts = 5 | +(IntOpt) Number of attempts to create unique mac address | +
| default_access_ip_network_name = None | +(StrOpt) Name of network to use to set access IPs for instances | +
| default_floating_pool = nova | +(StrOpt) Default pool for floating IPs | +
| defer_iptables_apply = False | +(BoolOpt) Whether to batch up the application of IPTables rules during a host restart and apply all at the end of the init phase | +
| dhcp_domain = novalocal | +(StrOpt) Domain to use for building the hostnames | +
| dhcp_lease_time = 86400 | +(IntOpt) Lifetime of a DHCP lease in seconds | +
| dhcpbridge = $bindir/nova-dhcpbridge | +(StrOpt) Location of nova-dhcpbridge | +
| dhcpbridge_flagfile = ['/etc/nova/nova-dhcpbridge.conf'] | +(MultiStrOpt) Location of flagfiles for dhcpbridge | +
| dns_server = [] | +(MultiStrOpt) If set, uses specific DNS server for dnsmasq. Can be specified multiple times. | +
| dns_update_periodic_interval = -1 | +(IntOpt) Number of seconds to wait between runs of updates to DNS entries. | +
| dnsmasq_config_file = | +(StrOpt) Override the default dnsmasq settings with this file | +
| firewall_driver = None | +(StrOpt) Firewall driver (defaults to hypervisor specific iptables driver) | +
| fixed_ip_disassociate_timeout = 600 | +(IntOpt) Seconds after which a deallocated IP is disassociated | +
| flat_injected = False | +(BoolOpt) Whether to attempt to inject network setup into guest | +
| flat_interface = None | +(StrOpt) FlatDhcp will bridge into this interface if set | +
| flat_network_bridge = None | +(StrOpt) Bridge for simple network instances | +
| flat_network_dns = 8.8.4.4 | +(StrOpt) DNS server for simple network | +
| floating_ip_dns_manager = nova.network.noop_dns_driver.NoopDNSDriver | +(StrOpt) Full class name for the DNS Manager for floating IPs | +
| force_dhcp_release = True | +(BoolOpt) If True, send a dhcp release on instance termination | +
| force_snat_range = [] | +(MultiStrOpt) Traffic to this range will always be snatted to the fallback ip, even if it would normally be bridged out of the node. Can be specified multiple times. | +
| forward_bridge_interface = ['all'] | +(MultiStrOpt) An interface that bridges can forward to. If this is set to all then all traffic will be forwarded. Can be specified multiple times. | +
| gateway = None | +(StrOpt) Default IPv4 gateway | +
| injected_network_template = $pybasedir/nova/virt/interfaces.template | +(StrOpt) Template file for injected network | +
| instance_dns_domain = | +(StrOpt) Full class name for the DNS Zone for instance IPs | +
| instance_dns_manager = nova.network.noop_dns_driver.NoopDNSDriver | +(StrOpt) Full class name for the DNS Manager for instance IPs | +
| iptables_bottom_regex = | +(StrOpt) Regular expression to match iptables rule that should always be on the bottom. | +
| iptables_drop_action = DROP | +(StrOpt) The table that iptables to jump to when a packet is to be dropped. | +
| iptables_top_regex = | +(StrOpt) Regular expression to match iptables rule that should always be on the top. | +
| l3_lib = nova.network.l3.LinuxNetL3 | +(StrOpt) Indicates underlying L3 management library | +
| linuxnet_interface_driver = nova.network.linux_net.LinuxBridgeInterfaceDriver | +(StrOpt) Driver used to create ethernet devices. | +
| linuxnet_ovs_integration_bridge = br-int | +(StrOpt) Name of Open vSwitch bridge used with linuxnet | +
| multi_host = False | +(BoolOpt) Default value for multi_host in networks. Also, if set, some rpc network calls will be sent directly to host. | +
| network_allocate_retries = 0 | +(IntOpt) Number of times to retry network allocation on failures | +
| network_api_class = nova.network.api.API | +(StrOpt) The full class name of the network API class to use | +
| network_device_mtu = None | +(IntOpt) MTU setting for network interface | +
| network_driver = nova.network.linux_net | +(StrOpt) Driver to use for network creation | +
| network_manager = nova.network.manager.VlanManager | +(StrOpt) Full class name for the Manager for network | +
| network_size = 256 | +(IntOpt) Number of addresses in each private subnet | +
| network_topic = network | +(StrOpt) The topic network nodes listen on | +
| networks_path = $state_path/networks | +(StrOpt) Location to keep network config files | +
| num_networks = 1 | +(IntOpt) Number of networks to support | +
| ovs_vsctl_timeout = 120 | +(IntOpt) Amount of time, in seconds, that ovs_vsctl should wait for a response from the database. 0 is to wait forever. | +
| public_interface = eth0 | +(StrOpt) Interface for public IP addresses | +
| routing_source_ip = $my_ip | +(StrOpt) Public IP of network host | +
| security_group_api = nova | +(StrOpt) The full class name of the security API class | +
| send_arp_for_ha = False | +(BoolOpt) Send gratuitous ARPs for HA setup | +
| send_arp_for_ha_count = 3 | +(IntOpt) Send this many gratuitous ARPs for HA setup | +
| share_dhcp_address = False | +(BoolOpt) DEPRECATED: THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK. If True in multi_host mode, all compute hosts share the same dhcp address. The same IP address used for DHCP will be added on each nova-network node which is only visible to the vms on the same host. | +
| teardown_unused_network_gateway = False | +(BoolOpt) If True, unused gateway devices (VLAN and bridge) are deleted in VLAN network mode with multi hosted networks | +
| update_dns_entries = False | +(BoolOpt) If True, when a DNS entry must be updated, it sends a fanout cast to all network hosts to update their DNS entries in multi host mode | +
| use_network_dns_servers = False | +(BoolOpt) If set, uses the dns1 and dns2 from the network ref. as dns servers. | +
| use_neutron_default_nets = False | +(StrOpt) Control for checking for default networks | +
| use_single_default_gateway = False | +(BoolOpt) Use single default gateway. Only first nic of vm will get default gateway from dhcp server | +
| vlan_interface = None | +(StrOpt) VLANs will bridge into this interface if set | +
| vlan_start = 100 | +(IntOpt) First VLAN for private networks | +
| [vmware] | +|
| vlan_interface = vmnic0 | +(StrOpt) Physical ethernet adapter name for vlan networking | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| neutron_admin_auth_url = http://localhost:5000/v2.0 | -(StrOpt) Authorization URL for connecting to neutron in admin context | -
| neutron_admin_password = None | -(StrOpt) Password for connecting to neutron in admin context | -
| neutron_admin_tenant_id = None | -(StrOpt) Tenant id for connecting to neutron in admin context | -
| neutron_admin_tenant_name = None | -(StrOpt) Tenant name for connecting to neutron in admin context. This option is mutually exclusive with neutron_admin_tenant_id. Note that with Keystone V3 tenant names are only unique within a domain. | -
| neutron_admin_username = None | -(StrOpt) Username for connecting to neutron in admin context | -
| neutron_api_insecure = False | -(BoolOpt) If set, ignore any SSL validation issues | -
| neutron_auth_strategy = keystone | -(StrOpt) Authorization strategy for connecting to neutron in admin context | -
| neutron_ca_certificates_file = None | -(StrOpt) Location of CA certificates file to use for neutron client requests. | -
| neutron_default_tenant_id = default | -(StrOpt) Default tenant id when creating neutron networks | -
| neutron_extension_sync_interval = 600 | -(IntOpt) Number of seconds before querying neutron for extensions | -
| neutron_metadata_proxy_shared_secret = | -(StrOpt) Shared secret to validate proxies Neutron metadata requests | -
| neutron_ovs_bridge = br-int | -(StrOpt) Name of Integration Bridge used by Open vSwitch | -
| neutron_region_name = None | -(StrOpt) Region name for connecting to neutron in admin context | -
| neutron_url = http://127.0.0.1:9696 | -(StrOpt) URL for connecting to neutron | -
| neutron_url_timeout = 30 | -(IntOpt) Timeout value for connecting to neutron in seconds | -
| service_neutron_metadata_proxy = False | -(BoolOpt) Set flag to indicate Neutron will proxy metadata requests and resolve instance ids. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| neutron_default_tenant_id = default | +(StrOpt) Default tenant id when creating neutron networks | +
| neutron_metadata_proxy_shared_secret = | +(StrOpt) Shared secret to validate proxies Neutron metadata requests | +
| service_neutron_metadata_proxy = False | +(BoolOpt) Set flag to indicate Neutron will proxy metadata requests and resolve instance ids. | +
| [neutron] | +|
| admin_auth_url = http://localhost:5000/v2.0 | +(StrOpt) Authorization URL for connecting to neutron in admin context | +
| admin_password = None | +(StrOpt) Password for connecting to neutron in admin context | +
| admin_tenant_id = None | +(StrOpt) Tenant id for connecting to neutron in admin context | +
| admin_tenant_name = None | +(StrOpt) Tenant name for connecting to neutron in admin context. This option is mutually exclusive with admin_tenant_id. Note that with Keystone V3 tenant names are only unique within a domain. | +
| admin_username = None | +(StrOpt) Username for connecting to neutron in admin context | +
| api_insecure = False | +(BoolOpt) If set, ignore any SSL validation issues | +
| auth_strategy = keystone | +(StrOpt) Authorization strategy for connecting to neutron in admin context | +
| ca_certificates_file = None | +(StrOpt) Location of CA certificates file to use for neutron client requests. | +
| extension_sync_interval = 600 | +(IntOpt) Number of seconds before querying neutron for extensions | +
| ovs_bridge = br-int | +(StrOpt) Name of Integration Bridge used by Open vSwitch | +
| region_name = None | +(StrOpt) Region name for connecting to neutron in admin context | +
| url = http://127.0.0.1:9696 | +(StrOpt) URL for connecting to neutron | +
| url_timeout = 30 | +(IntOpt) Timeout value for connecting to neutron in seconds | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| pci_alias = [] | -(MultiStrOpt) An alias for a PCI passthrough device requirement. This allows users to specify the alias in the extra_spec for a flavor, without needing to repeat all the PCI property requirements. For example: pci_alias = { "name": "QuicAssist", "product_id": "0443", "vendor_id": "8086", "device_type": "ACCEL" } defines an alias for the Intel QuickAssist card. (multi valued) | -
| pci_passthrough_whitelist = [] | -(MultiStrOpt) White list of PCI devices available to VMs. For example: pci_passthrough_whitelist = [{"vendor_id": "8086", "product_id": "0443"}] | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| pci_alias = [] | +(MultiStrOpt) An alias for a PCI passthrough device requirement. This allows users to specify the alias in the extra_spec for a flavor, without needing to repeat all the PCI property requirements. For example: pci_alias = { "name": "QuicAssist", "product_id": "0443", "vendor_id": "8086", "device_type": "ACCEL" } defines an alias for the Intel QuickAssist card. (multi valued) | +
| pci_passthrough_whitelist = [] | +(MultiStrOpt) White list of PCI devices available to VMs. For example: pci_passthrough_whitelist = [{"vendor_id": "8086", "product_id": "0443"}] | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| periodic_enable = True | -(BoolOpt) Enable periodic tasks | -
| periodic_fuzzy_delay = 60 | -(IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) | -
| run_external_periodic_tasks = True | -(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here? | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| periodic_enable = True | +(BoolOpt) Enable periodic tasks | +
| periodic_fuzzy_delay = 60 | +(IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) | +
| run_external_periodic_tasks = True | +(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here? | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| allow_instance_snapshots = True | -(BoolOpt) Permit instance snapshot operations. | -
| allow_migrate_to_same_host = False | -(BoolOpt) Allow migrate machine to the same host. Useful when testing in single-host environments. | -
| allow_resize_to_same_host = False | -(BoolOpt) Allow destination machine to match source for resize. Useful when testing in single-host environments. | -
| max_age = 0 | -(IntOpt) Number of seconds between subsequent usage refreshes | -
| max_local_block_devices = 3 | -(IntOpt) Maximum number of devices that will result in a local image being created on the hypervisor node. Setting this to 0 means nova will allow only boot from volume. A negative number means unlimited. | -
| osapi_compute_unique_server_name_scope = | -(StrOpt) When set, compute API will consider duplicate hostnames invalid within the specified scope, regardless of case. Should be empty, "project" or "global". | -
| osapi_max_limit = 1000 | -(IntOpt) The maximum number of items returned in a single response from a collection resource | -
| osapi_max_request_body_size = 114688 | -(IntOpt) The maximum body size per each osapi request(bytes) | -
| password_length = 12 | -(IntOpt) Length of generated instance admin passwords | -
| policy_default_rule = default | -(StrOpt) Rule checked when requested rule is not found | -
| policy_file = policy.json | -(StrOpt) JSON file representing policy | -
| reservation_expire = 86400 | -(IntOpt) Number of seconds until a reservation expires | -
| resize_fs_using_block_device = False | -(BoolOpt) Attempt to resize the filesystem by accessing the image over a block device. This is done by the host and may not be necessary if the image contains a recent version of cloud-init. Possible mechanisms require the nbd driver (for qcow and raw), or loop (for raw). | -
| until_refresh = 0 | -(IntOpt) Count of reservations until usage is refreshed | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| allow_instance_snapshots = True | +(BoolOpt) Permit instance snapshot operations. | +
| allow_migrate_to_same_host = False | +(BoolOpt) Allow migrate machine to the same host. Useful when testing in single-host environments. | +
| allow_resize_to_same_host = False | +(BoolOpt) Allow destination machine to match source for resize. Useful when testing in single-host environments. | +
| max_age = 0 | +(IntOpt) Number of seconds between subsequent usage refreshes | +
| max_local_block_devices = 3 | +(IntOpt) Maximum number of devices that will result in a local image being created on the hypervisor node. Setting this to 0 means nova will allow only boot from volume. A negative number means unlimited. | +
| osapi_compute_unique_server_name_scope = | +(StrOpt) When set, compute API will consider duplicate hostnames invalid within the specified scope, regardless of case. Should be empty, "project" or "global". | +
| osapi_max_limit = 1000 | +(IntOpt) The maximum number of items returned in a single response from a collection resource | +
| osapi_max_request_body_size = 114688 | +(IntOpt) The maximum body size per each osapi request(bytes) | +
| password_length = 12 | +(IntOpt) Length of generated instance admin passwords | +
| policy_default_rule = default | +(StrOpt) Default rule. Enforced when a requested rule is not found. | +
| policy_file = policy.json | +(StrOpt) The JSON file that defines policies. | +
| reservation_expire = 86400 | +(IntOpt) Number of seconds until a reservation expires | +
| resize_fs_using_block_device = False | +(BoolOpt) Attempt to resize the filesystem by accessing the image over a block device. This is done by the host and may not be necessary if the image contains a recent version of cloud-init. Possible mechanisms require the nbd driver (for qcow and raw), or loop (for raw). | +
| until_refresh = 0 | +(IntOpt) Count of reservations until usage is refreshed | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| qpid_heartbeat = 60 | -(IntOpt) Seconds between connection keepalive heartbeats. | -
| qpid_hostname = localhost | -(StrOpt) Qpid broker hostname. | -
| qpid_hosts = $qpid_hostname:$qpid_port | -(ListOpt) Qpid HA cluster host:port pairs. | -
| qpid_password = | -(StrOpt) Password for Qpid connection. | -
| qpid_port = 5672 | -(IntOpt) Qpid broker port. | -
| qpid_protocol = tcp | -(StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| qpid_sasl_mechanisms = | -(StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| qpid_tcp_nodelay = True | -(BoolOpt) Whether to disable the Nagle algorithm. | -
| qpid_topology_version = 1 | -(IntOpt) 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. | -
| qpid_username = | -(StrOpt) Username for Qpid connection. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| qpid_heartbeat = 60 | +(IntOpt) Seconds between connection keepalive heartbeats. | +
| qpid_hostname = localhost | +(StrOpt) Qpid broker hostname. | +
| qpid_hosts = $qpid_hostname:$qpid_port | +(ListOpt) Qpid HA cluster host:port pairs. | +
| qpid_password = | +(StrOpt) Password for Qpid connection. | +
| qpid_port = 5672 | +(IntOpt) Qpid broker port. | +
| qpid_protocol = tcp | +(StrOpt) Transport to use, either 'tcp' or 'ssl'. | +
| qpid_sasl_mechanisms = | +(StrOpt) Space separated list of SASL mechanisms to use for auth. | +
| qpid_tcp_nodelay = True | +(BoolOpt) Whether to disable the Nagle algorithm. | +
| qpid_topology_version = 1 | +(IntOpt) 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. | +
| qpid_username = | +(StrOpt) Username for Qpid connection. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| bandwidth_poll_interval = 600 | -(IntOpt) Interval to pull network bandwidth usage info. Not supported on all hypervisors. Set to 0 to disable. | -
| enable_network_quota = False | -(BoolOpt) Enables or disables quota checking for tenant networks | -
| quota_cores = 20 | -(IntOpt) Number of instance cores allowed per project | -
| quota_driver = nova.quota.DbQuotaDriver | -(StrOpt) Default driver to use for quota checks | -
| quota_fixed_ips = -1 | -(IntOpt) Number of fixed IPs allowed per project (this should be at least the number of instances allowed) | -
| quota_floating_ips = 10 | -(IntOpt) Number of floating IPs allowed per project | -
| quota_injected_file_content_bytes = 10240 | -(IntOpt) Number of bytes allowed per injected file | -
| quota_injected_file_path_bytes = 255 | -(IntOpt) Number of bytes allowed per injected file path | -
| quota_injected_files = 5 | -(IntOpt) Number of injected files allowed | -
| quota_instances = 10 | -(IntOpt) Number of instances allowed per project | -
| quota_key_pairs = 100 | -(IntOpt) Number of key pairs per user | -
| quota_metadata_items = 128 | -(IntOpt) Number of metadata items allowed per instance | -
| quota_ram = 51200 | -(IntOpt) Megabytes of instance RAM allowed per project | -
| quota_security_group_rules = 20 | -(IntOpt) Number of security rules per security group | -
| quota_security_groups = 10 | -(IntOpt) Number of security groups per project | -
| [cells] | -|
| bandwidth_update_interval = 600 | -(IntOpt) Seconds between bandwidth updates for cells. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| bandwidth_poll_interval = 600 | +(IntOpt) Interval to pull network bandwidth usage info. Not supported on all hypervisors. Set to -1 to disable. Setting this to 0 will disable, but this will change in the K release to mean "run at the default rate". | +
| enable_network_quota = False | +(BoolOpt) Enables or disables quota checking for tenant networks | +
| quota_cores = 20 | +(IntOpt) Number of instance cores allowed per project | +
| quota_driver = nova.quota.DbQuotaDriver | +(StrOpt) Default driver to use for quota checks | +
| quota_fixed_ips = -1 | +(IntOpt) Number of fixed IPs allowed per project (this should be at least the number of instances allowed) | +
| quota_floating_ips = 10 | +(IntOpt) Number of floating IPs allowed per project | +
| quota_injected_file_content_bytes = 10240 | +(IntOpt) Number of bytes allowed per injected file | +
| quota_injected_file_path_length = 255 | +(IntOpt) Length of injected file path | +
| quota_injected_files = 5 | +(IntOpt) Number of injected files allowed | +
| quota_instances = 10 | +(IntOpt) Number of instances allowed per project | +
| quota_key_pairs = 100 | +(IntOpt) Number of key pairs per user | +
| quota_metadata_items = 128 | +(IntOpt) Number of metadata items allowed per instance | +
| quota_ram = 51200 | +(IntOpt) Megabytes of instance RAM allowed per project | +
| quota_security_group_rules = 20 | +(IntOpt) Number of security rules per security group | +
| quota_security_groups = 10 | +(IntOpt) Number of security groups per project | +
| [cells] | +|
| bandwidth_update_interval = 600 | +(IntOpt) Seconds between bandwidth updates for cells. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| rabbit_ha_queues = False | -(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| rabbit_host = localhost | -(StrOpt) The RabbitMQ broker address where a single node is used. | -
| rabbit_hosts = $rabbit_host:$rabbit_port | -(ListOpt) RabbitMQ HA cluster host:port pairs. | -
| rabbit_login_method = AMQPLAIN | -(StrOpt) the RabbitMQ login method | -
| rabbit_max_retries = 0 | -(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| rabbit_password = guest | -(StrOpt) The RabbitMQ password. | -
| rabbit_port = 5672 | -(IntOpt) The RabbitMQ broker port where a single node is used. | -
| rabbit_retry_backoff = 2 | -(IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| rabbit_retry_interval = 1 | -(IntOpt) How frequently to retry connecting with RabbitMQ. | -
| rabbit_use_ssl = False | -(BoolOpt) Connect over SSL for RabbitMQ. | -
| rabbit_userid = guest | -(StrOpt) The RabbitMQ userid. | -
| rabbit_virtual_host = / | -(StrOpt) The RabbitMQ virtual host. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| rabbit_ha_queues = False | +(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | +
| rabbit_host = localhost | +(StrOpt) The RabbitMQ broker address where a single node is used. | +
| rabbit_hosts = $rabbit_host:$rabbit_port | +(ListOpt) RabbitMQ HA cluster host:port pairs. | +
| rabbit_login_method = AMQPLAIN | +(StrOpt) the RabbitMQ login method | +
| rabbit_max_retries = 0 | +(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | +
| rabbit_password = guest | +(StrOpt) The RabbitMQ password. | +
| rabbit_port = 5672 | +(IntOpt) The RabbitMQ broker port where a single node is used. | +
| rabbit_retry_backoff = 2 | +(IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | +
| rabbit_retry_interval = 1 | +(IntOpt) How frequently to retry connecting with RabbitMQ. | +
| rabbit_use_ssl = False | +(BoolOpt) Connect over SSL for RabbitMQ. | +
| rabbit_userid = guest | +(StrOpt) The RabbitMQ userid. | +
| rabbit_virtual_host = / | +(StrOpt) The RabbitMQ virtual host. | +
| Configuration option = Default value | -Description | -
|---|---|
| [rdp] | -|
| enabled = False | -(BoolOpt) Enable RDP related features | -
| html5_proxy_base_url = http://127.0.0.1:6083/ | -(StrOpt) Location of RDP html5 console proxy, in the form "http://127.0.0.1:6083/" | -
| Configuration option = Default value | +Description | +
|---|---|
| [rdp] | +|
| enabled = False | +(BoolOpt) Enable RDP related features | +
| html5_proxy_base_url = http://127.0.0.1:6083/ | +(StrOpt) Location of RDP html5 console proxy, in the form "http://127.0.0.1:6083/" | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| password = None | -(StrOpt) Password for Redis server (optional). | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| password = None | +(StrOpt) Password for Redis server (optional). | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| filters_path = /etc/nova/rootwrap.d,/usr/share/nova/rootwrap | -List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root ! | -
| exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin | -List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root ! | -
| use_syslog = False | -Enable logging to syslog Default value is False | -
| syslog_log_facility = syslog | -Which syslog facility to use. Valid values include auth, authpriv, syslog, user0, user1... Default value is 'syslog' | -
| syslog_log_level = ERROR | -Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| filters_path = /etc/nova/rootwrap.d,/usr/share/nova/rootwrap | +List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root ! | +
| exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin | +List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root ! | +
| use_syslog = False | +Enable logging to syslog Default value is False | +
| syslog_log_facility = syslog | +Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog' | +
| syslog_log_level = ERROR | +Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| amqp_auto_delete = False | -(BoolOpt) Auto-delete queues in amqp. | -
| amqp_durable_queues = False | -(BoolOpt) Use durable queues in amqp. | -
| control_exchange = openstack | -(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| matchmaker_heartbeat_freq = 300 | -(IntOpt) Heartbeat frequency. | -
| matchmaker_heartbeat_ttl = 600 | -(IntOpt) Heartbeat time-to-live. | -
| rpc_backend = rabbit | -(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| rpc_cast_timeout = 30 | -(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| rpc_response_timeout = 60 | -(IntOpt) Seconds to wait for a response from a call. | -
| rpc_thread_pool_size = 64 | -(IntOpt) Size of RPC greenthread pool. | -
| [cells] | -|
| rpc_driver_queue_base = cells.intercell | -(StrOpt) Base queue name to use when communicating between cells. Various topics by message type will be appended to this. | -
| [matchmaker_ring] | -|
| ringfile = /etc/oslo/matchmaker_ring.json | -(StrOpt) Matchmaker ring file (JSON). | -
| [upgrade_levels] | -|
| baseapi = None | -(StrOpt) Set a version cap for messages sent to the base api in any service | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| amqp_auto_delete = False | +(BoolOpt) Auto-delete queues in amqp. | +
| amqp_durable_queues = False | +(BoolOpt) Use durable queues in amqp. | +
| control_exchange = openstack | +(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid | +
| matchmaker_heartbeat_freq = 300 | +(IntOpt) Heartbeat frequency. | +
| matchmaker_heartbeat_ttl = 600 | +(IntOpt) Heartbeat time-to-live. | +
| rpc_backend = nova.openstack.common.rpc.impl_kombu | +(StrOpt) The messaging module to use, defaults to kombu. | +
| rpc_cast_timeout = 30 | +(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | +
| rpc_conn_pool_size = 30 | +(IntOpt) Size of RPC connection pool | +
| rpc_response_timeout = 60 | +(IntOpt) Seconds to wait for a response from call or multicall | +
| rpc_thread_pool_size = 64 | +(IntOpt) Size of RPC thread pool | +
| [cells] | +|
| rpc_driver_queue_base = cells.intercell | +(StrOpt) Base queue name to use when communicating between cells. Various topics by message type will be appended to this. | +
| [matchmaker_ring] | +|
| ringfile = /etc/oslo/matchmaker_ring.json | +(StrOpt) Matchmaker ring file (JSON). | +
| [upgrade_levels] | +|
| baseapi = None | +(StrOpt) Set a version cap for messages sent to the base api in any service | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| amqp_auto_delete = False | -(BoolOpt) Auto-delete queues in amqp. | -
| amqp_durable_queues = False | -(BoolOpt) Use durable queues in amqp. | -
| control_exchange = openstack | -(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. | -
| kombu_reconnect_delay = 1.0 | -(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | -
| kombu_ssl_ca_certs = | -(StrOpt) SSL certification authority file (valid only if SSL enabled). | -
| kombu_ssl_certfile = | -(StrOpt) SSL cert file (valid only if SSL enabled). | -
| kombu_ssl_keyfile = | -(StrOpt) SSL key file (valid only if SSL enabled). | -
| kombu_ssl_version = | -(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions. | -
| matchmaker_heartbeat_freq = 300 | -(IntOpt) Heartbeat frequency. | -
| matchmaker_heartbeat_ttl = 600 | -(IntOpt) Heartbeat time-to-live. | -
| qpid_heartbeat = 60 | -(IntOpt) Seconds between connection keepalive heartbeats. | -
| qpid_hostname = localhost | -(StrOpt) Qpid broker hostname. | -
| qpid_hosts = $qpid_hostname:$qpid_port | -(ListOpt) Qpid HA cluster host:port pairs. | -
| qpid_password = | -(StrOpt) Password for Qpid connection. | -
| qpid_port = 5672 | -(IntOpt) Qpid broker port. | -
| qpid_protocol = tcp | -(StrOpt) Transport to use, either 'tcp' or 'ssl'. | -
| qpid_sasl_mechanisms = | -(StrOpt) Space separated list of SASL mechanisms to use for auth. | -
| qpid_tcp_nodelay = True | -(BoolOpt) Whether to disable the Nagle algorithm. | -
| qpid_topology_version = 1 | -(IntOpt) 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. | -
| qpid_username = | -(StrOpt) Username for Qpid connection. | -
| rabbit_ha_queues = False | -(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | -
| rabbit_host = localhost | -(StrOpt) The RabbitMQ broker address where a single node is used. | -
| rabbit_hosts = $rabbit_host:$rabbit_port | -(ListOpt) RabbitMQ HA cluster host:port pairs. | -
| rabbit_login_method = AMQPLAIN | -(StrOpt) the RabbitMQ login method | -
| rabbit_max_retries = 0 | -(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | -
| rabbit_password = guest | -(StrOpt) The RabbitMQ password. | -
| rabbit_port = 5672 | -(IntOpt) The RabbitMQ broker port where a single node is used. | -
| rabbit_retry_backoff = 2 | -(IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | -
| rabbit_retry_interval = 1 | -(IntOpt) How frequently to retry connecting with RabbitMQ. | -
| rabbit_use_ssl = False | -(BoolOpt) Connect over SSL for RabbitMQ. | -
| rabbit_userid = guest | -(StrOpt) The RabbitMQ userid. | -
| rabbit_virtual_host = / | -(StrOpt) The RabbitMQ virtual host. | -
| rpc_backend = rabbit | -(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. | -
| rpc_cast_timeout = 30 | -(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool. | -
| rpc_response_timeout = 60 | -(IntOpt) Seconds to wait for a response from a call. | -
| rpc_thread_pool_size = 64 | -(IntOpt) Size of RPC greenthread pool. | -
| rpc_zmq_bind_address = * | -(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| rpc_zmq_contexts = 1 | -(IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| rpc_zmq_host = oslo | -(StrOpt) 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 | -(StrOpt) Directory for holding IPC sockets. | -
| rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost | -(StrOpt) MatchMaker driver. | -
| rpc_zmq_port = 9501 | -(IntOpt) ZeroMQ receiver listening port. | -
| rpc_zmq_topic_backlog = None | -(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| [cells] | -|
| rpc_driver_queue_base = cells.intercell | -(StrOpt) Base queue name to use when communicating between cells. Various topics by message type will be appended to this. | -
| [matchmaker_ring] | -|
| ringfile = /etc/oslo/matchmaker_ring.json | -(StrOpt) Matchmaker ring file (JSON). | -
| [upgrade_levels] | -|
| baseapi = None | -(StrOpt) Set a version cap for messages sent to the base api in any service | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| amqp_auto_delete = False | +(BoolOpt) Auto-delete queues in amqp. | +
| amqp_durable_queues = False | +(BoolOpt) Use durable queues in amqp. | +
| control_exchange = openstack | +(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid | +
| kombu_reconnect_delay = 1.0 | +(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. | +
| kombu_ssl_ca_certs = | +(StrOpt) SSL certification authority file (valid only if SSL enabled). | +
| kombu_ssl_certfile = | +(StrOpt) SSL cert file (valid only if SSL enabled). | +
| kombu_ssl_keyfile = | +(StrOpt) SSL key file (valid only if SSL enabled). | +
| kombu_ssl_version = | +(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions. | +
| matchmaker_heartbeat_freq = 300 | +(IntOpt) Heartbeat frequency. | +
| matchmaker_heartbeat_ttl = 600 | +(IntOpt) Heartbeat time-to-live. | +
| qpid_heartbeat = 60 | +(IntOpt) Seconds between connection keepalive heartbeats. | +
| qpid_hostname = localhost | +(StrOpt) Qpid broker hostname. | +
| qpid_hosts = $qpid_hostname:$qpid_port | +(ListOpt) Qpid HA cluster host:port pairs. | +
| qpid_password = | +(StrOpt) Password for Qpid connection. | +
| qpid_port = 5672 | +(IntOpt) Qpid broker port. | +
| qpid_protocol = tcp | +(StrOpt) Transport to use, either 'tcp' or 'ssl'. | +
| qpid_sasl_mechanisms = | +(StrOpt) Space separated list of SASL mechanisms to use for auth. | +
| qpid_tcp_nodelay = True | +(BoolOpt) Whether to disable the Nagle algorithm. | +
| qpid_topology_version = 1 | +(IntOpt) 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. | +
| qpid_username = | +(StrOpt) Username for Qpid connection. | +
| rabbit_ha_queues = False | +(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. | +
| rabbit_host = localhost | +(StrOpt) The RabbitMQ broker address where a single node is used. | +
| rabbit_hosts = $rabbit_host:$rabbit_port | +(ListOpt) RabbitMQ HA cluster host:port pairs. | +
| rabbit_login_method = AMQPLAIN | +(StrOpt) the RabbitMQ login method | +
| rabbit_max_retries = 0 | +(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). | +
| rabbit_password = guest | +(StrOpt) The RabbitMQ password. | +
| rabbit_port = 5672 | +(IntOpt) The RabbitMQ broker port where a single node is used. | +
| rabbit_retry_backoff = 2 | +(IntOpt) How long to backoff for between retries when connecting to RabbitMQ. | +
| rabbit_retry_interval = 1 | +(IntOpt) How frequently to retry connecting with RabbitMQ. | +
| rabbit_use_ssl = False | +(BoolOpt) Connect over SSL for RabbitMQ. | +
| rabbit_userid = guest | +(StrOpt) The RabbitMQ userid. | +
| rabbit_virtual_host = / | +(StrOpt) The RabbitMQ virtual host. | +
| rpc_backend = nova.openstack.common.rpc.impl_kombu | +(StrOpt) The messaging module to use, defaults to kombu. | +
| rpc_cast_timeout = 30 | +(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | +
| rpc_conn_pool_size = 30 | +(IntOpt) Size of RPC connection pool | +
| rpc_response_timeout = 60 | +(IntOpt) Seconds to wait for a response from call or multicall | +
| rpc_thread_pool_size = 64 | +(IntOpt) Size of RPC thread pool | +
| rpc_zmq_bind_address = * | +(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | +
| rpc_zmq_contexts = 1 | +(IntOpt) Number of ZeroMQ contexts, defaults to 1. | +
| rpc_zmq_host = oslo | +(StrOpt) 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 | +(StrOpt) Directory for holding IPC sockets. | +
| rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost | +(StrOpt) MatchMaker driver. | +
| rpc_zmq_port = 9501 | +(IntOpt) ZeroMQ receiver listening port. | +
| rpc_zmq_topic_backlog = None | +(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | +
| [cells] | +|
| rpc_driver_queue_base = cells.intercell | +(StrOpt) Base queue name to use when communicating between cells. Various topics by message type will be appended to this. | +
| [matchmaker_ring] | +|
| ringfile = /etc/oslo/matchmaker_ring.json | +(StrOpt) Matchmaker ring file (JSON). | +
| [upgrade_levels] | +|
| baseapi = None | +(StrOpt) Set a version cap for messages sent to the base api in any service | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| buckets_path = $state_path/buckets | -(StrOpt) Path to S3 buckets | -
| image_decryption_dir = /tmp | -(StrOpt) Parent directory for tempdir used for image decryption | -
| s3_access_key = notchecked | -(StrOpt) Access key to use for S3 server for images | -
| s3_affix_tenant = False | -(BoolOpt) Whether to affix the tenant id to the access key when downloading from S3 | -
| s3_host = $my_ip | -(StrOpt) Hostname or IP for OpenStack to use when accessing the S3 api | -
| s3_listen = 0.0.0.0 | -(StrOpt) IP address for S3 API to listen | -
| s3_listen_port = 3333 | -(IntOpt) Port for S3 API to listen | -
| s3_port = 3333 | -(IntOpt) Port used when accessing the S3 api | -
| s3_secret_key = notchecked | -(StrOpt) Secret key to use for S3 server for images | -
| s3_use_ssl = False | -(BoolOpt) Whether to use SSL when talking to S3 | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| buckets_path = $state_path/buckets | +(StrOpt) Path to S3 buckets | +
| image_decryption_dir = /tmp | +(StrOpt) Parent directory for tempdir used for image decryption | +
| s3_access_key = notchecked | +(StrOpt) Access key to use for S3 server for images | +
| s3_affix_tenant = False | +(BoolOpt) Whether to affix the tenant id to the access key when downloading from S3 | +
| s3_host = $my_ip | +(StrOpt) Hostname or IP for OpenStack to use when accessing the S3 api | +
| s3_listen = 0.0.0.0 | +(StrOpt) IP address for S3 API to listen | +
| s3_listen_port = 3333 | +(IntOpt) Port for S3 API to listen | +
| s3_port = 3333 | +(IntOpt) Port used when accessing the S3 api | +
| s3_secret_key = notchecked | +(StrOpt) Secret key to use for S3 server for images | +
| s3_use_ssl = False | +(BoolOpt) Whether to use SSL when talking to S3 | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| aggregate_image_properties_isolation_namespace = None | -(StrOpt) Force the filter to consider only keys matching the given namespace. | -
| aggregate_image_properties_isolation_separator = . | -(StrOpt) The separator used between the namespace and keys | -
| cpu_allocation_ratio = 16.0 | -(FloatOpt) Virtual CPU to physical CPU allocation ratio which affects all CPU filters. This configuration specifies a global ratio for CoreFilter. For AggregateCoreFilter, it will fall back to this configuration value if no per-aggregate setting found. | -
| disk_allocation_ratio = 1.0 | -(FloatOpt) Virtual disk to physical disk allocation ratio | -
| isolated_hosts = | -(ListOpt) Host reserved for specific images | -
| isolated_images = | -(ListOpt) Images to run on isolated host | -
| max_instances_per_host = 50 | -(IntOpt) Ignore hosts that have too many instances | -
| max_io_ops_per_host = 8 | -(IntOpt) Ignore hosts that have too many builds/resizes/snaps/migrations | -
| ram_allocation_ratio = 1.5 | -(FloatOpt) Virtual ram to physical ram allocation ratio which affects all ram filters. This configuration specifies a global ratio for RamFilter. For AggregateRamFilter, it will fall back to this configuration value if no per-aggregate setting found. | -
| ram_weight_multiplier = 1.0 | -(FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread. | -
| reserved_host_disk_mb = 0 | -(IntOpt) Amount of disk in MB to reserve for the host | -
| reserved_host_memory_mb = 512 | -(IntOpt) Amount of memory in MB to reserve for the host | -
| restrict_isolated_hosts_to_isolated_images = True | -(BoolOpt) Whether to force isolated hosts to run only isolated images | -
| scheduler_available_filters = ['nova.scheduler.filters.all_filters'] | -(MultiStrOpt) Filter classes available to the scheduler which may be specified more than once. An entry of "nova.scheduler.filters.standard_filters" maps to all filters included with nova. | -
| scheduler_default_filters = RetryFilter, AvailabilityZoneFilter, RamFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ServerGroupAntiAffinityFilter, ServerGroupAffinityFilter | -(ListOpt) Which filter class names to use for filtering hosts when not specified in the request. | -
| scheduler_driver = nova.scheduler.filter_scheduler.FilterScheduler | -(StrOpt) Default driver to use for the scheduler | -
| scheduler_driver_task_period = 60 | -(IntOpt) How often (in seconds) to run periodic tasks in the scheduler driver of your choice. Please note this is likely to interact with the value of service_down_time, but exactly how they interact will depend on your choice of scheduler driver. | -
| scheduler_host_manager = nova.scheduler.host_manager.HostManager | -(StrOpt) The scheduler host manager class to use | -
| scheduler_host_subset_size = 1 | -(IntOpt) New instances will be scheduled on a host chosen randomly from a subset of the N best hosts. This property defines the subset size that a host is chosen from. A value of 1 chooses the first host returned by the weighing functions. This value must be at least 1. Any value less than 1 will be ignored, and 1 will be used instead | -
| scheduler_json_config_location = | -(StrOpt) Absolute path to scheduler configuration JSON file. | -
| scheduler_manager = nova.scheduler.manager.SchedulerManager | -(StrOpt) Full class name for the Manager for scheduler | -
| scheduler_max_attempts = 3 | -(IntOpt) Maximum number of attempts to schedule an instance | -
| scheduler_topic = scheduler | -(StrOpt) The topic scheduler nodes listen on | -
| scheduler_weight_classes = nova.scheduler.weights.all_weighers | -(ListOpt) Which weight class names to use for weighing hosts | -
| [cells] | -|
| ram_weight_multiplier = 10.0 | -(FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread. | -
| scheduler_filter_classes = nova.cells.filters.all_filters | -(ListOpt) Filter classes the cells scheduler should use. An entry of "nova.cells.filters.all_filters" maps to all cells filters included with nova. | -
| scheduler_retries = 10 | -(IntOpt) How many retries when no cells are available. | -
| scheduler_retry_delay = 2 | -(IntOpt) How often to retry in seconds when no cells are available. | -
| scheduler_weight_classes = nova.cells.weights.all_weighers | -(ListOpt) Weigher classes the cells scheduler should use. An entry of "nova.cells.weights.all_weighers" maps to all cell weighers included with nova. | -
| [metrics] | -|
| required = True | -(BoolOpt) How to treat the unavailable metrics. When a metric is NOT available for a host, if it is set to be True, it would raise an exception, so it is recommended to use the scheduler filter MetricFilter to filter out those hosts. If it is set to be False, the unavailable metric would be treated as a negative factor in weighing process, the returned value would be set by the option weight_of_unavailable. | -
| weight_multiplier = 1.0 | -(FloatOpt) Multiplier used for weighing metrics. | -
| weight_of_unavailable = -10000.0 | -(FloatOpt) The final weight value to be returned if required is set to False and any one of the metrics set by weight_setting is unavailable. | -
| weight_setting = | -(ListOpt) How the metrics are going to be weighed. This should be in the form of "<name1>=<ratio1>, <name2>=<ratio2>, ...", where <nameX> is one of the metrics to be weighed, and <ratioX> is the corresponding ratio. So for "name1=1.0, name2=-1.0" The final weight would be name1.value * 1.0 + name2.value * -1.0. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| aggregate_image_properties_isolation_namespace = None | +(StrOpt) Force the filter to consider only keys matching the given namespace. | +
| aggregate_image_properties_isolation_separator = . | +(StrOpt) The separator used between the namespace and keys | +
| cpu_allocation_ratio = 16.0 | +(FloatOpt) Virtual CPU to physical CPU allocation ratio which affects all CPU filters. This configuration specifies a global ratio for CoreFilter. For AggregateCoreFilter, it will fall back to this configuration value if no per-aggregate setting found. | +
| disk_allocation_ratio = 1.0 | +(FloatOpt) Virtual disk to physical disk allocation ratio | +
| isolated_hosts = | +(ListOpt) Host reserved for specific images | +
| isolated_images = | +(ListOpt) Images to run on isolated host | +
| max_instances_per_host = 50 | +(IntOpt) Ignore hosts that have too many instances | +
| max_io_ops_per_host = 8 | +(IntOpt) Tells filters to ignore hosts that have this many or more instances currently in build, resize, snapshot, migrate, rescue or unshelve task states | +
| ram_allocation_ratio = 1.5 | +(FloatOpt) Virtual ram to physical ram allocation ratio which affects all ram filters. This configuration specifies a global ratio for RamFilter. For AggregateRamFilter, it will fall back to this configuration value if no per-aggregate setting found. | +
| ram_weight_multiplier = 1.0 | +(FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread. | +
| reserved_host_disk_mb = 0 | +(IntOpt) Amount of disk in MB to reserve for the host | +
| reserved_host_memory_mb = 512 | +(IntOpt) Amount of memory in MB to reserve for the host | +
| restrict_isolated_hosts_to_isolated_images = True | +(BoolOpt) Whether to force isolated hosts to run only isolated images | +
| scheduler_available_filters = ['nova.scheduler.filters.all_filters'] | +(MultiStrOpt) Filter classes available to the scheduler which may be specified more than once. An entry of "nova.scheduler.filters.standard_filters" maps to all filters included with nova. | +
| scheduler_default_filters = RetryFilter, AvailabilityZoneFilter, RamFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ServerGroupAntiAffinityFilter, ServerGroupAffinityFilter | +(ListOpt) Which filter class names to use for filtering hosts when not specified in the request. | +
| scheduler_driver = nova.scheduler.filter_scheduler.FilterScheduler | +(StrOpt) Default driver to use for the scheduler | +
| scheduler_driver_task_period = 60 | +(IntOpt) How often (in seconds) to run periodic tasks in the scheduler driver of your choice. Please note this is likely to interact with the value of service_down_time, but exactly how they interact will depend on your choice of scheduler driver. | +
| scheduler_host_manager = nova.scheduler.host_manager.HostManager | +(StrOpt) The scheduler host manager class to use | +
| scheduler_host_subset_size = 1 | +(IntOpt) New instances will be scheduled on a host chosen randomly from a subset of the N best hosts. This property defines the subset size that a host is chosen from. A value of 1 chooses the first host returned by the weighing functions. This value must be at least 1. Any value less than 1 will be ignored, and 1 will be used instead | +
| scheduler_json_config_location = | +(StrOpt) Absolute path to scheduler configuration JSON file. | +
| scheduler_manager = nova.scheduler.manager.SchedulerManager | +(StrOpt) Full class name for the Manager for scheduler | +
| scheduler_max_attempts = 3 | +(IntOpt) Maximum number of attempts to schedule an instance | +
| scheduler_topic = scheduler | +(StrOpt) The topic scheduler nodes listen on | +
| scheduler_weight_classes = nova.scheduler.weights.all_weighers | +(ListOpt) Which weight class names to use for weighing hosts | +
| [cells] | +|
| ram_weight_multiplier = 10.0 | +(FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread. | +
| scheduler_filter_classes = nova.cells.filters.all_filters | +(ListOpt) Filter classes the cells scheduler should use. An entry of "nova.cells.filters.all_filters" maps to all cells filters included with nova. | +
| scheduler_retries = 10 | +(IntOpt) How many retries when no cells are available. | +
| scheduler_retry_delay = 2 | +(IntOpt) How often to retry in seconds when no cells are available. | +
| scheduler_weight_classes = nova.cells.weights.all_weighers | +(ListOpt) Weigher classes the cells scheduler should use. An entry of "nova.cells.weights.all_weighers" maps to all cell weighers included with nova. | +
| [metrics] | +|
| required = True | +(BoolOpt) How to treat the unavailable metrics. When a metric is NOT available for a host, if it is set to be True, it would raise an exception, so it is recommended to use the scheduler filter MetricFilter to filter out those hosts. If it is set to be False, the unavailable metric would be treated as a negative factor in weighing process, the returned value would be set by the option weight_of_unavailable. | +
| weight_multiplier = 1.0 | +(FloatOpt) Multiplier used for weighing metrics. | +
| weight_of_unavailable = -10000.0 | +(FloatOpt) The final weight value to be returned if required is set to False and any one of the metrics set by weight_setting is unavailable. | +
| weight_setting = | +(ListOpt) How the metrics are going to be weighed. This should be in the form of "<name1>=<ratio1>, <name2>=<ratio2>, ...", where <nameX> is one of the metrics to be weighed, and <ratioX> is the corresponding ratio. So for "name1=1.0, name2=-1.0" The final weight would be name1.value * 1.0 + name2.value * -1.0. | +
| Configuration option = Default value | -Description | -
|---|---|
| [spice] | -|
| agent_enabled = True | -(BoolOpt) Enable spice guest agent support | -
| enabled = False | -(BoolOpt) Enable spice related features | -
| html5proxy_base_url = http://127.0.0.1:6082/spice_auto.html | -(StrOpt) Location of spice HTML5 console proxy, in the form "http://127.0.0.1:6082/spice_auto.html" | -
| keymap = en-us | -(StrOpt) Keymap for spice | -
| server_listen = 127.0.0.1 | -(StrOpt) IP address on which instance spice server should listen | -
| server_proxyclient_address = 127.0.0.1 | -(StrOpt) The address to which proxy clients (like nova-spicehtml5proxy) should connect | -
| Configuration option = Default value | +Description | +
|---|---|
| [spice] | +|
| agent_enabled = True | +(BoolOpt) Enable spice guest agent support | +
| enabled = False | +(BoolOpt) Enable spice related features | +
| html5proxy_base_url = http://127.0.0.1:6082/spice_auto.html | +(StrOpt) Location of spice HTML5 console proxy, in the form "http://127.0.0.1:6082/spice_auto.html" | +
| keymap = en-us | +(StrOpt) Keymap for spice | +
| server_listen = 127.0.0.1 | +(StrOpt) IP address on which instance spice server should listen | +
| server_proxyclient_address = 127.0.0.1 | +(StrOpt) The address to which proxy clients (like nova-spicehtml5proxy) should connect | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions | -(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call. | -
| backdoor_port = None | -(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port> and <start>:<end>, where 0 results in listening on a random tcp port number, <port> results in listening on the specified port number and not enabling backdoorif it is in use and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. | -
| fake_call = False | -(BoolOpt) If True, skip using the queue and make local calls | -
| fake_network = False | -(BoolOpt) If passed, use fake network devices and addresses | -
| fake_rabbit = False | -(BoolOpt) If passed, use a fake RabbitMQ provider. | -
| monkey_patch = False | -(BoolOpt) Whether to log monkey patching | -
| monkey_patch_modules = nova.api.ec2.cloud:nova.notifications.notify_decorator, nova.compute.api:nova.notifications.notify_decorator | -(ListOpt) List of modules/decorators to monkey patch | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions | +(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call. | +
| backdoor_port = None | +(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. | +
| fake_call = False | +(BoolOpt) If True, skip using the queue and make local calls | +
| fake_network = False | +(BoolOpt) If passed, use fake network devices and addresses | +
| fake_rabbit = False | +(BoolOpt) If passed, use a fake RabbitMQ provider | +
| monkey_patch = False | +(BoolOpt) Whether to log monkey patching | +
| monkey_patch_modules = nova.api.ec2.cloud:nova.notifications.notify_decorator, nova.compute.api:nova.notifications.notify_decorator | +(ListOpt) List of modules/decorators to monkey patch | +
| Configuration option = Default value | -Description | -
|---|---|
| [baremetal] | -|
| tile_pdu_ip = 10.0.100.1 | -(StrOpt) IP address of tilera pdu | -
| tile_pdu_mgr = /tftpboot/pdu_mgr | -(StrOpt) Management script for tilera pdu | -
| tile_pdu_off = 2 | -(IntOpt) Power status of tilera PDU is OFF | -
| tile_pdu_on = 1 | -(IntOpt) Power status of tilera PDU is ON | -
| tile_pdu_status = 9 | -(IntOpt) Power status of tilera PDU | -
| tile_power_wait = 9 | -(IntOpt) Wait time in seconds until check the result after tilera power operations | -
| Configuration option = Default value | +Description | +
|---|---|
| [baremetal] | +|
| tile_pdu_ip = 10.0.100.1 | +(StrOpt) IP address of tilera pdu | +
| tile_pdu_mgr = /tftpboot/pdu_mgr | +(StrOpt) Management script for tilera pdu | +
| tile_pdu_off = 2 | +(IntOpt) Power status of tilera PDU is OFF | +
| tile_pdu_on = 1 | +(IntOpt) Power status of tilera PDU is ON | +
| tile_pdu_status = 9 | +(IntOpt) Power status of tilera PDU | +
| tile_power_wait = 9 | +(IntOpt) Wait time in seconds until check the result after tilera power operations | +
| Configuration option = Default value | -Description | -
|---|---|
| [trusted_computing] | -|
| attestation_api_url = /OpenAttestationWebServices/V1.0 | -(StrOpt) Attestation web API URL | -
| attestation_auth_blob = None | -(StrOpt) Attestation authorization blob - must change | -
| attestation_auth_timeout = 60 | -(IntOpt) Attestation status cache valid period length | -
| attestation_port = 8443 | -(StrOpt) Attestation server port | -
| attestation_server = None | -(StrOpt) Attestation server HTTP | -
| attestation_server_ca_file = None | -(StrOpt) Attestation server Cert file for Identity verification | -
| Configuration option = Default value | +Description | +
|---|---|
| [trusted_computing] | +|
| attestation_api_url = /OpenAttestationWebServices/V1.0 | +(StrOpt) Attestation web API URL | +
| attestation_auth_blob = None | +(StrOpt) Attestation authorization blob - must change | +
| attestation_auth_timeout = 60 | +(IntOpt) Attestation status cache valid period length | +
| attestation_port = 8443 | +(StrOpt) Attestation server port | +
| attestation_server = None | +(StrOpt) Attestation server HTTP | +
| attestation_server_ca_file = None | +(StrOpt) Attestation server Cert file for Identity verification | +
| Configuration option = Default value | -Description | -
|---|---|
| [cells] | -|
| scheduler = nova.cells.scheduler.CellsScheduler | -(StrOpt) Cells scheduler to use | -
| [upgrade_levels] | -|
| cells = None | -(StrOpt) Set a version cap for messages sent to local cells services | -
| cert = None | -(StrOpt) Set a version cap for messages sent to cert services | -
| compute = None | -(StrOpt) Set a version cap for messages sent to compute services. If you plan to do a live upgrade from havana to icehouse, you should set this option to "icehouse-compat" before beginning the live upgrade procedure. | -
| conductor = None | -(StrOpt) Set a version cap for messages sent to conductor services | -
| console = None | -(StrOpt) Set a version cap for messages sent to console services | -
| consoleauth = None | -(StrOpt) Set a version cap for messages sent to consoleauth services | -
| intercell = None | -(StrOpt) Set a version cap for messages sent between cells services | -
| network = None | -(StrOpt) Set a version cap for messages sent to network services | -
| scheduler = None | -(StrOpt) Set a version cap for messages sent to scheduler services | -
| Configuration option = Default value | +Description | +
|---|---|
| [cells] | +|
| scheduler = nova.cells.scheduler.CellsScheduler | +(StrOpt) Cells scheduler to use | +
| [upgrade_levels] | +|
| cells = None | +(StrOpt) Set a version cap for messages sent to local cells services | +
| cert = None | +(StrOpt) Set a version cap for messages sent to cert services | +
| compute = None | +(StrOpt) Set a version cap for messages sent to compute services. If you plan to do a live upgrade from havana to icehouse, you should set this option to "icehouse-compat" before beginning the live upgrade procedure. | +
| conductor = None | +(StrOpt) Set a version cap for messages sent to conductor services | +
| console = None | +(StrOpt) Set a version cap for messages sent to console services | +
| consoleauth = None | +(StrOpt) Set a version cap for messages sent to consoleauth services | +
| intercell = None | +(StrOpt) Set a version cap for messages sent between cells services | +
| network = None | +(StrOpt) Set a version cap for messages sent to network services | +
| scheduler = None | +(StrOpt) Set a version cap for messages sent to scheduler services | +
| Configuration option = Default value | -Description | -
|---|---|
| [vmware] | -|
| api_retry_count = 10 | -(IntOpt) The number of times we retry on failures, e.g., socket error, etc. | -
| cluster_name = None | -(MultiStrOpt) Name of a VMware Cluster ComputeResource. Used only if compute_driver is vmwareapi.VMwareVCDriver. | -
| datastore_regex = None | -(StrOpt) Regex to match the name of a datastore. | -
| host_ip = None | -(StrOpt) Hostname or IP address for connection to VMware ESX/VC host. | -
| host_password = None | -(StrOpt) Password for connection to VMware ESX/VC host. | -
| host_username = None | -(StrOpt) Username for connection to VMware ESX/VC host. | -
| integration_bridge = br-int | -(StrOpt) Name of Integration Bridge | -
| maximum_objects = 100 | -(IntOpt) The maximum number of ObjectContent data objects that should be returned in a single result. A positive value will cause the operation to suspend the retrieval when the count of objects reaches the specified maximum. The server may still limit the count to something less than the configured value. Any remaining objects may be retrieved with additional requests. | -
| task_poll_interval = 0.5 | -(FloatOpt) The interval used for polling of remote tasks. | -
| use_linked_clone = True | -(BoolOpt) Whether to use linked clone | -
| wsdl_location = None | -(StrOpt) Optional VIM Service WSDL Location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds | -
| Configuration option = Default value | +Description | +
|---|---|
| [vmware] | +|
| api_retry_count = 10 | +(IntOpt) The number of times we retry on failures, e.g., socket error, etc. | +
| cluster_name = None | +(MultiStrOpt) Name of a VMware Cluster ComputeResource. Used only if compute_driver is vmwareapi.VMwareVCDriver. | +
| datastore_regex = None | +(StrOpt) Regex to match the name of a datastore. | +
| host_ip = None | +(StrOpt) Hostname or IP address for connection to VMware ESX/VC host. | +
| host_password = None | +(StrOpt) Password for connection to VMware ESX/VC host. | +
| host_port = 443 | +(IntOpt) Port for connection to VMware ESX/VC host. | +
| host_username = None | +(StrOpt) Username for connection to VMware ESX/VC host. | +
| integration_bridge = br-int | +(StrOpt) Name of Integration Bridge | +
| maximum_objects = 100 | +(IntOpt) The maximum number of ObjectContent data objects that should be returned in a single result. A positive value will cause the operation to suspend the retrieval when the count of objects reaches the specified maximum. The server may still limit the count to something less than the configured value. Any remaining objects may be retrieved with additional requests. | +
| task_poll_interval = 0.5 | +(FloatOpt) The interval used for polling of remote tasks. | +
| use_linked_clone = True | +(BoolOpt) Whether to use linked clone | +
| wsdl_location = None | +(StrOpt) Optional VIM Service WSDL Location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| novncproxy_base_url = http://127.0.0.1:6080/vnc_auto.html | -(StrOpt) Location of VNC console proxy, in the form "http://127.0.0.1:6080/vnc_auto.html" | -
| vnc_enabled = True | -(BoolOpt) Enable VNC related features | -
| vnc_keymap = en-us | -(StrOpt) Keymap for VNC | -
| vncserver_listen = 127.0.0.1 | -(StrOpt) IP address on which instance vncservers should listen | -
| vncserver_proxyclient_address = 127.0.0.1 | -(StrOpt) The address to which proxy clients (like nova-xvpvncproxy) should connect | -
| [vmware] | -|
| vnc_port = 5900 | -(IntOpt) VNC starting port | -
| vnc_port_total = 10000 | -(IntOpt) Total number of VNC ports | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| novncproxy_base_url = http://127.0.0.1:6080/vnc_auto.html | +(StrOpt) Location of VNC console proxy, in the form "http://127.0.0.1:6080/vnc_auto.html" | +
| vnc_enabled = True | +(BoolOpt) Enable VNC related features | +
| vnc_keymap = en-us | +(StrOpt) Keymap for VNC | +
| vncserver_listen = 127.0.0.1 | +(StrOpt) IP address on which instance vncservers should listen | +
| vncserver_proxyclient_address = 127.0.0.1 | +(StrOpt) The address to which proxy clients (like nova-xvpvncproxy) should connect | +
| [vmware] | +|
| vnc_port = 5900 | +(IntOpt) VNC starting port | +
| vnc_port_total = 10000 | +(IntOpt) Total number of VNC ports | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| cinder_api_insecure = False | -(BoolOpt) Allow to perform insecure SSL requests to cinder | -
| cinder_ca_certificates_file = None | -(StrOpt) Location of ca certificates file to use for cinder client requests. | -
| cinder_catalog_info = volume:cinder:publicURL | -(StrOpt) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> | -
| cinder_cross_az_attach = True | -(BoolOpt) Allow attach between instance and volume in different availability zones. | -
| cinder_endpoint_template = None | -(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s | -
| cinder_http_retries = 3 | -(IntOpt) Number of cinderclient retries on failed http calls | -
| os_region_name = None | -(StrOpt) Region name of this node | -
| volume_api_class = nova.volume.cinder.API | -(StrOpt) The full class name of the volume API class to use | -
| volume_usage_poll_interval = 0 | -(IntOpt) Interval in seconds for gathering volume usages | -
| [baremetal] | -|
| iscsi_iqn_prefix = iqn.2010-10.org.openstack.baremetal | -(StrOpt) The iSCSI IQN prefix used in baremetal volume connections. | -
| volume_driver = nova.virt.baremetal.volume_driver.LibvirtVolumeDriver | -(StrOpt) Baremetal volume driver. | -
| [hyperv] | -|
| force_volumeutils_v1 = False | -(BoolOpt) Force V1 volume utility class | -
| volume_attach_retry_count = 10 | -(IntOpt) The number of times to retry to attach a volume | -
| volume_attach_retry_interval = 5 | -(IntOpt) Interval between volume attachment attempts, in seconds | -
| [libvirt] | -|
| glusterfs_mount_point_base = $state_path/mnt | -(StrOpt) Directory where the glusterfs volume is mounted on the compute node | -
| nfs_mount_options = None | -(StrOpt) Mount options passedf to the NFS client. See section of the nfs man page for details | -
| nfs_mount_point_base = $state_path/mnt | -(StrOpt) Directory where the NFS volume is mounted on the compute node | -
| num_aoe_discover_tries = 3 | -(IntOpt) Number of times to rediscover AoE target to find volume | -
| num_iscsi_scan_tries = 5 | -(IntOpt) Number of times to rescan iSCSI target to find volume | -
| num_iser_scan_tries = 5 | -(IntOpt) Number of times to rescan iSER target to find volume | -
| qemu_allowed_storage_drivers = | -(ListOpt) Protocols listed here will be accessed directly from QEMU. Currently supported protocols: [gluster] | -
| rbd_secret_uuid = None | -(StrOpt) The libvirt UUID of the secret for the rbd_uservolumes | -
| rbd_user = None | -(StrOpt) The RADOS client name for accessing rbd volumes | -
| scality_sofs_config = None | -(StrOpt) Path or URL to Scality SOFS configuration file | -
| scality_sofs_mount_point = $state_path/scality | -(StrOpt) Base dir where Scality SOFS shall be mounted | -
| [xenserver] | -|
| block_device_creation_timeout = 10 | -(IntOpt) Time to wait for a block device to be created | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| cinder_api_insecure = False | +(BoolOpt) Allow to perform insecure SSL requests to cinder | +
| cinder_ca_certificates_file = None | +(StrOpt) Location of ca certificates file to use for cinder client requests. | +
| cinder_catalog_info = volume:cinder:publicURL | +(StrOpt) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> | +
| cinder_cross_az_attach = True | +(BoolOpt) Allow attach between instance and volume in different availability zones. | +
| cinder_endpoint_template = None | +(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s | +
| cinder_http_retries = 3 | +(IntOpt) Number of cinderclient retries on failed http calls | +
| cinder_http_timeout = None | +(IntOpt) HTTP inactivity timeout (in seconds) | +
| os_region_name = None | +(StrOpt) Region name of this node | +
| volume_api_class = nova.volume.cinder.API | +(StrOpt) The full class name of the volume API class to use | +
| volume_usage_poll_interval = 0 | +(IntOpt) Interval in seconds for gathering volume usages | +
| [baremetal] | +|
| iscsi_iqn_prefix = iqn.2010-10.org.openstack.baremetal | +(StrOpt) The iSCSI IQN prefix used in baremetal volume connections. | +
| volume_driver = nova.virt.baremetal.volume_driver.LibvirtVolumeDriver | +(StrOpt) Baremetal volume driver. | +
| [hyperv] | +|
| force_volumeutils_v1 = False | +(BoolOpt) Force V1 volume utility class | +
| volume_attach_retry_count = 10 | +(IntOpt) The number of times to retry to attach a volume | +
| volume_attach_retry_interval = 5 | +(IntOpt) Interval between volume attachment attempts, in seconds | +
| [libvirt] | +|
| glusterfs_mount_point_base = $state_path/mnt | +(StrOpt) Directory where the glusterfs volume is mounted on the compute node | +
| nfs_mount_options = None | +(StrOpt) Mount options passedf to the NFS client. See section of the nfs man page for details | +
| nfs_mount_point_base = $state_path/mnt | +(StrOpt) Directory where the NFS volume is mounted on the compute node | +
| num_aoe_discover_tries = 3 | +(IntOpt) Number of times to rediscover AoE target to find volume | +
| num_iscsi_scan_tries = 5 | +(IntOpt) Number of times to rescan iSCSI target to find volume | +
| num_iser_scan_tries = 5 | +(IntOpt) Number of times to rescan iSER target to find volume | +
| qemu_allowed_storage_drivers = | +(ListOpt) Protocols listed here will be accessed directly from QEMU. Currently supported protocols: [gluster] | +
| rbd_secret_uuid = None | +(StrOpt) The libvirt UUID of the secret for the rbd_uservolumes | +
| rbd_user = None | +(StrOpt) The RADOS client name for accessing rbd volumes | +
| scality_sofs_config = None | +(StrOpt) Path or URL to Scality SOFS configuration file | +
| scality_sofs_mount_point = $state_path/scality | +(StrOpt) Base dir where Scality SOFS shall be mounted | +
| [xenserver] | +|
| block_device_creation_timeout = 10 | +(IntOpt) Time to wait for a block device to be created | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| boot_script_template = $pybasedir/nova/cloudpipe/bootscript.template | -(StrOpt) Template for cloudpipe instance boot script | -
| dmz_cidr = | -(ListOpt) A list of dmz range that should be accepted | -
| dmz_mask = 255.255.255.0 | -(StrOpt) Netmask to push into openvpn config | -
| dmz_net = 10.0.0.0 | -(StrOpt) Network to push into openvpn config | -
| vpn_flavor = m1.tiny | -(StrOpt) Flavor for vpn instances | -
| vpn_image_id = 0 | -(StrOpt) Image ID used when starting up a cloudpipe vpn server | -
| vpn_ip = $my_ip | -(StrOpt) Public IP for the cloudpipe VPN servers | -
| vpn_key_suffix = -vpn | -(StrOpt) Suffix to add to project name for vpn key and secgroups | -
| vpn_start = 1000 | -(IntOpt) First Vpn port for private networks | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| boot_script_template = $pybasedir/nova/cloudpipe/bootscript.template | +(StrOpt) Template for cloudpipe instance boot script | +
| dmz_cidr = | +(ListOpt) A list of dmz range that should be accepted | +
| dmz_mask = 255.255.255.0 | +(StrOpt) Netmask to push into openvpn config | +
| dmz_net = 10.0.0.0 | +(StrOpt) Network to push into openvpn config | +
| vpn_flavor = m1.tiny | +(StrOpt) Flavor for vpn instances | +
| vpn_image_id = 0 | +(StrOpt) Image ID used when starting up a cloudpipe vpn server | +
| vpn_ip = $my_ip | +(StrOpt) Public IP for the cloudpipe VPN servers | +
| vpn_key_suffix = -vpn | +(StrOpt) Suffix to add to project name for vpn key and secgroups | +
| vpn_start = 1000 | +(IntOpt) First Vpn port for private networks | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| api_paste_config = api-paste.ini | -(StrOpt) File name for the paste.deploy config for nova-api | -
| ssl_ca_file = None | -(StrOpt) CA certificate file to use to verify connecting clients | -
| ssl_cert_file = None | -(StrOpt) SSL certificate of API server | -
| ssl_key_file = None | -(StrOpt) SSL private key of API server | -
| tcp_keepidle = 600 | -(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. | -
| wsgi_default_pool_size = 1000 | -(IntOpt) Size of the pool of greenthreads used by wsgi | -
| wsgi_log_format = %(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f | -(StrOpt) A python format string that is used as the template to generate log lines. The following values can be formatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| api_paste_config = api-paste.ini | +(StrOpt) File name for the paste.deploy config for nova-api | +
| ssl_ca_file = None | +(StrOpt) CA certificate file to use to verify connecting clients | +
| ssl_cert_file = None | +(StrOpt) SSL certificate of API server | +
| ssl_key_file = None | +(StrOpt) SSL private key of API server | +
| tcp_keepidle = 600 | +(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. | +
| wsgi_default_pool_size = 1000 | +(IntOpt) Size of the pool of greenthreads used by wsgi | +
| wsgi_log_format = %(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f | +(StrOpt) A python format string that is used as the template to generate log lines. The following values can be formatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| console_driver = nova.console.xvp.XVPConsoleProxy | -(StrOpt) Driver to use for the console proxy | -
| console_vmrc_error_retries = 10 | -(IntOpt) Number of retries for retrieving VMRC information | -
| console_vmrc_port = 443 | -(IntOpt) Port for VMware VMRC connections | -
| console_xvp_conf = /etc/xvp.conf | -(StrOpt) Generated XVP conf file | -
| console_xvp_conf_template = $pybasedir/nova/console/xvp.conf.template | -(StrOpt) XVP conf template | -
| console_xvp_log = /var/log/xvp.log | -(StrOpt) XVP log file | -
| console_xvp_multiplex_port = 5900 | -(IntOpt) Port for XVP to multiplex VNC connections on | -
| console_xvp_pid = /var/run/xvp.pid | -(StrOpt) XVP master process pid file | -
| stub_compute = False | -(BoolOpt) Stub calls to compute worker for tests | -
| [libvirt] | -|
| xen_hvmloader_path = /usr/lib/xen/boot/hvmloader | -(StrOpt) Location where the Xen hvmloader is kept | -
| [xenserver] | -|
| agent_path = usr/sbin/xe-update-networking | -(StrOpt) Specifies the path in which the XenAPI guest agent should be located. If the agent is present, network configuration is not injected into the image. Used if compute_driver=xenapi.XenAPIDriver and flat_injected=True | -
| agent_resetnetwork_timeout = 60 | -(IntOpt) Number of seconds to wait for agent reply to resetnetwork request | -
| agent_timeout = 30 | -(IntOpt) Number of seconds to wait for agent reply | -
| agent_version_timeout = 300 | -(IntOpt) Number of seconds to wait for agent to be fully operational | -
| cache_images = all | -(StrOpt) Cache glance images locally. `all` will cache all images, `some` will only cache images that have the image_property `cache_in_nova=True`, and `none` turns off caching entirely | -
| check_host = True | -(BoolOpt) Ensure compute service is running on host XenAPI connects to. | -
| connection_concurrent = 5 | -(IntOpt) Maximum number of concurrent XenAPI connections. Used only if compute_driver=xenapi.XenAPIDriver | -
| connection_password = None | -(StrOpt) Password for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver | -
| connection_url = None | -(StrOpt) URL for connection to XenServer/Xen Cloud Platform. A special value of unix://local can be used to connect to the local unix socket. Required if compute_driver=xenapi.XenAPIDriver | -
| connection_username = root | -(StrOpt) Username for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver | -
| default_os_type = linux | -(StrOpt) Default OS type | -
| disable_agent = False | -(BoolOpt) Disables the use of the XenAPI agent in any image regardless of what image properties are present. | -
| image_compression_level = None | -(IntOpt) Compression level for images, e.g., 9 for gzip -9. Range is 1-9, 9 being most compressed but most CPU intensive on dom0. | -
| image_upload_handler = nova.virt.xenapi.image.glance.GlanceStore | -(StrOpt) Dom0 plugin driver used to handle image uploads. | -
| introduce_vdi_retry_wait = 20 | -(IntOpt) Number of seconds to wait for an SR to settle if the VDI does not exist when first introduced | -
| ipxe_boot_menu_url = None | -(StrOpt) URL to the iPXE boot menu | -
| ipxe_mkisofs_cmd = mkisofs | -(StrOpt) Name and optionally path of the tool used for ISO image creation | -
| ipxe_network_name = None | -(StrOpt) Name of network to use for booting iPXE ISOs | -
| iqn_prefix = iqn.2010-10.org.openstack | -(StrOpt) IQN Prefix | -
| login_timeout = 10 | -(IntOpt) Timeout in seconds for XenAPI login. | -
| max_kernel_ramdisk_size = 16777216 | -(IntOpt) Maximum size in bytes of kernel or ramdisk images | -
| num_vbd_unplug_retries = 10 | -(IntOpt) Maximum number of retries to unplug VBD | -
| ovs_integration_bridge = xapi1 | -(StrOpt) Name of Integration Bridge used by Open vSwitch | -
| remap_vbd_dev = False | -(BoolOpt) Used to enable the remapping of VBD dev (Works around an issue in Ubuntu Maverick) | -
| remap_vbd_dev_prefix = sd | -(StrOpt) Specify prefix to remap VBD dev to (ex. /dev/xvdb -> /dev/sdb) | -
| running_timeout = 60 | -(IntOpt) Number of seconds to wait for instance to go to running state | -
| sparse_copy = True | -(BoolOpt) Whether to use sparse_copy for copying data on a resize down (False will use standard dd). This speeds up resizes down considerably since large runs of zeros won't have to be rsynced | -
| sr_base_path = /var/run/sr-mount | -(StrOpt) Base path to the storage repository | -
| sr_matching_filter = default-sr:true | -(StrOpt) Filter for finding the SR to be used to install guest instances on. To use the Local Storage in default XenServer/XCP installations set this flag to other-config:i18n-key=local-storage. To select an SR with a different matching criteria, you could set it to other-config:my_favorite_sr=true. On the other hand, to fall back on the Default SR, as displayed by XenCenter, set this flag to: default-sr:true | -
| target_host = None | -(StrOpt) The iSCSI Target Host | -
| target_port = 3260 | -(StrOpt) The iSCSI Target Port, default is port 3260 | -
| torrent_base_url = None | -(StrOpt) Base URL for torrent files. | -
| torrent_download_stall_cutoff = 600 | -(IntOpt) Number of seconds a download can remain at the same progress percentage w/o being considered a stall | -
| torrent_images = none | -(StrOpt) Whether or not to download images via Bit Torrent (all|some|none). | -
| torrent_listen_port_end = 6891 | -(IntOpt) End of port range to listen on | -
| torrent_listen_port_start = 6881 | -(IntOpt) Beginning of port range to listen on | -
| torrent_max_last_accessed = 86400 | -(IntOpt) Cached torrent files not accessed within this number of seconds can be reaped | -
| torrent_max_seeder_processes_per_host = 1 | -(IntOpt) Maximum number of seeder processes to run concurrently within a given dom0. (-1 = no limit) | -
| torrent_seed_chance = 1.0 | -(FloatOpt) Probability that peer will become a seeder. (1.0 = 100%) | -
| torrent_seed_duration = 3600 | -(IntOpt) Number of seconds after downloading an image via BitTorrent that it should be seeded for other peers. | -
| use_agent_default = False | -(BoolOpt) Determines if the XenAPI agent should be used when the image used does not contain a hint to declare if the agent is present or not. The hint is a glance property "xenapi_use_agent" that has the value "True" or "False". Note that waiting for the agent when it is not present will significantly increase server boot times. | -
| use_join_force = True | -(BoolOpt) To use for hosts with different CPUs | -
| vhd_coalesce_max_attempts = 20 | -(IntOpt) Max number of times to poll for VHD to coalesce. Used only if compute_driver=xenapi.XenAPIDriver | -
| vhd_coalesce_poll_interval = 5.0 | -(FloatOpt) The interval used for polling of coalescing vhds. Used only if compute_driver=xenapi.XenAPIDriver | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| console_driver = nova.console.xvp.XVPConsoleProxy | +(StrOpt) Driver to use for the console proxy | +
| console_vmrc_error_retries = 10 | +(IntOpt) Number of retries for retrieving VMRC information | +
| console_vmrc_port = 443 | +(IntOpt) Port for VMware VMRC connections | +
| console_xvp_conf = /etc/xvp.conf | +(StrOpt) Generated XVP conf file | +
| console_xvp_conf_template = $pybasedir/nova/console/xvp.conf.template | +(StrOpt) XVP conf template | +
| console_xvp_log = /var/log/xvp.log | +(StrOpt) XVP log file | +
| console_xvp_multiplex_port = 5900 | +(IntOpt) Port for XVP to multiplex VNC connections on | +
| console_xvp_pid = /var/run/xvp.pid | +(StrOpt) XVP master process pid file | +
| stub_compute = False | +(BoolOpt) Stub calls to compute worker for tests | +
| [libvirt] | +|
| xen_hvmloader_path = /usr/lib/xen/boot/hvmloader | +(StrOpt) Location where the Xen hvmloader is kept | +
| [xenserver] | +|
| agent_path = usr/sbin/xe-update-networking | +(StrOpt) Specifies the path in which the XenAPI guest agent should be located. If the agent is present, network configuration is not injected into the image. Used if compute_driver=xenapi.XenAPIDriver and flat_injected=True | +
| agent_resetnetwork_timeout = 60 | +(IntOpt) Number of seconds to wait for agent reply to resetnetwork request | +
| agent_timeout = 30 | +(IntOpt) Number of seconds to wait for agent reply | +
| agent_version_timeout = 300 | +(IntOpt) Number of seconds to wait for agent to be fully operational | +
| cache_images = all | +(StrOpt) Cache glance images locally. `all` will cache all images, `some` will only cache images that have the image_property `cache_in_nova=True`, and `none` turns off caching entirely | +
| check_host = True | +(BoolOpt) Ensure compute service is running on host XenAPI connects to. | +
| connection_concurrent = 5 | +(IntOpt) Maximum number of concurrent XenAPI connections. Used only if compute_driver=xenapi.XenAPIDriver | +
| connection_password = None | +(StrOpt) Password for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver | +
| connection_url = None | +(StrOpt) URL for connection to XenServer/Xen Cloud Platform. A special value of unix://local can be used to connect to the local unix socket. Required if compute_driver=xenapi.XenAPIDriver | +
| connection_username = root | +(StrOpt) Username for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver | +
| default_os_type = linux | +(StrOpt) Default OS type | +
| disable_agent = False | +(BoolOpt) Disables the use of the XenAPI agent in any image regardless of what image properties are present. | +
| image_compression_level = None | +(IntOpt) Compression level for images, e.g., 9 for gzip -9. Range is 1-9, 9 being most compressed but most CPU intensive on dom0. | +
| image_upload_handler = nova.virt.xenapi.image.glance.GlanceStore | +(StrOpt) Dom0 plugin driver used to handle image uploads. | +
| introduce_vdi_retry_wait = 20 | +(IntOpt) Number of seconds to wait for an SR to settle if the VDI does not exist when first introduced | +
| ipxe_boot_menu_url = None | +(StrOpt) URL to the iPXE boot menu | +
| ipxe_mkisofs_cmd = mkisofs | +(StrOpt) Name and optionally path of the tool used for ISO image creation | +
| ipxe_network_name = None | +(StrOpt) Name of network to use for booting iPXE ISOs | +
| iqn_prefix = iqn.2010-10.org.openstack | +(StrOpt) IQN Prefix | +
| login_timeout = 10 | +(IntOpt) Timeout in seconds for XenAPI login. | +
| max_kernel_ramdisk_size = 16777216 | +(IntOpt) Maximum size in bytes of kernel or ramdisk images | +
| num_vbd_unplug_retries = 10 | +(IntOpt) Maximum number of retries to unplug VBD | +
| ovs_integration_bridge = xapi1 | +(StrOpt) Name of Integration Bridge used by Open vSwitch | +
| remap_vbd_dev = False | +(BoolOpt) Used to enable the remapping of VBD dev (Works around an issue in Ubuntu Maverick) | +
| remap_vbd_dev_prefix = sd | +(StrOpt) Specify prefix to remap VBD dev to (ex. /dev/xvdb -> /dev/sdb) | +
| running_timeout = 60 | +(IntOpt) Number of seconds to wait for instance to go to running state | +
| sparse_copy = True | +(BoolOpt) Whether to use sparse_copy for copying data on a resize down (False will use standard dd). This speeds up resizes down considerably since large runs of zeros won't have to be rsynced | +
| sr_base_path = /var/run/sr-mount | +(StrOpt) Base path to the storage repository | +
| sr_matching_filter = default-sr:true | +(StrOpt) Filter for finding the SR to be used to install guest instances on. To use the Local Storage in default XenServer/XCP installations set this flag to other-config:i18n-key=local-storage. To select an SR with a different matching criteria, you could set it to other-config:my_favorite_sr=true. On the other hand, to fall back on the Default SR, as displayed by XenCenter, set this flag to: default-sr:true | +
| target_host = None | +(StrOpt) The iSCSI Target Host | +
| target_port = 3260 | +(StrOpt) The iSCSI Target Port, default is port 3260 | +
| torrent_base_url = None | +(StrOpt) Base URL for torrent files. | +
| torrent_download_stall_cutoff = 600 | +(IntOpt) Number of seconds a download can remain at the same progress percentage w/o being considered a stall | +
| torrent_images = none | +(StrOpt) Whether or not to download images via Bit Torrent (all|some|none). | +
| torrent_listen_port_end = 6891 | +(IntOpt) End of port range to listen on | +
| torrent_listen_port_start = 6881 | +(IntOpt) Beginning of port range to listen on | +
| torrent_max_last_accessed = 86400 | +(IntOpt) Cached torrent files not accessed within this number of seconds can be reaped | +
| torrent_max_seeder_processes_per_host = 1 | +(IntOpt) Maximum number of seeder processes to run concurrently within a given dom0. (-1 = no limit) | +
| torrent_seed_chance = 1.0 | +(FloatOpt) Probability that peer will become a seeder. (1.0 = 100%) | +
| torrent_seed_duration = 3600 | +(IntOpt) Number of seconds after downloading an image via BitTorrent that it should be seeded for other peers. | +
| use_agent_default = False | +(BoolOpt) Determines if the XenAPI agent should be used when the image used does not contain a hint to declare if the agent is present or not. The hint is a glance property "xenapi_use_agent" that has the value "True" or "False". Note that waiting for the agent when it is not present will significantly increase server boot times. | +
| use_join_force = True | +(BoolOpt) To use for hosts with different CPUs | +
| vhd_coalesce_max_attempts = 20 | +(IntOpt) Max number of times to poll for VHD to coalesce. Used only if compute_driver=xenapi.XenAPIDriver | +
| vhd_coalesce_poll_interval = 5.0 | +(FloatOpt) The interval used for polling of coalescing vhds. Used only if compute_driver=xenapi.XenAPIDriver | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| xvpvncproxy_base_url = http://127.0.0.1:6081/console | -(StrOpt) Location of nova xvp VNC console proxy, in the form "http://127.0.0.1:6081/console" | -
| xvpvncproxy_host = 0.0.0.0 | -(StrOpt) Address that the XCP VNC proxy should bind to | -
| xvpvncproxy_port = 6081 | -(IntOpt) Port that the XCP VNC proxy should bind to | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| xvpvncproxy_base_url = http://127.0.0.1:6081/console | +(StrOpt) Location of nova xvp VNC console proxy, in the form "http://127.0.0.1:6081/console" | +
| xvpvncproxy_host = 0.0.0.0 | +(StrOpt) Address that the XCP VNC proxy should bind to | +
| xvpvncproxy_port = 6081 | +(IntOpt) Port that the XCP VNC proxy should bind to | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| rpc_zmq_bind_address = * | -(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| rpc_zmq_contexts = 1 | -(IntOpt) Number of ZeroMQ contexts, defaults to 1. | -
| rpc_zmq_host = oslo | -(StrOpt) 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 | -(StrOpt) Directory for holding IPC sockets. | -
| rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost | -(StrOpt) MatchMaker driver. | -
| rpc_zmq_port = 9501 | -(IntOpt) ZeroMQ receiver listening port. | -
| rpc_zmq_topic_backlog = None | -(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| rpc_zmq_bind_address = * | +(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | +
| rpc_zmq_contexts = 1 | +(IntOpt) Number of ZeroMQ contexts, defaults to 1. | +
| rpc_zmq_host = oslo | +(StrOpt) 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 | +(StrOpt) Directory for holding IPC sockets. | +
| rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost | +(StrOpt) MatchMaker driver. | +
| rpc_zmq_port = 9501 | +(IntOpt) ZeroMQ receiver listening port. | +
| rpc_zmq_topic_backlog = None | +(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | +
| Configuration option = Default value | -Description | -
|---|---|
| [zookeeper] | -|
| address = None | -(StrOpt) The ZooKeeper addresses for servicegroup service in the format of host1:port,host2:port,host3:port | -
| recv_timeout = 4000 | -(IntOpt) The recv_timeout parameter for the zk session | -
| sg_prefix = /servicegroups | -(StrOpt) The prefix used in ZooKeeper to store ephemeral nodes | -
| sg_retry_interval = 5 | -(IntOpt) Number of seconds to wait until retrying to join the session | -
| Configuration option = Default value | +Description | +
|---|---|
| [zookeeper] | +|
| address = None | +(StrOpt) The ZooKeeper addresses for servicegroup service in the format of host1:port,host2:port,host3:port | +
| recv_timeout = 4000 | +(IntOpt) The recv_timeout parameter for the zk session | +
| sg_prefix = /servicegroups | +(StrOpt) The prefix used in ZooKeeper to store ephemeral nodes | +
| sg_retry_interval = 5 | +(IntOpt) Number of seconds to wait until retrying to join the session | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| bind_ip = 0.0.0.0 | IP Address for server to bind to | -
| bind_port = 6002 | Port for server to bind to | -
| bind_timeout = 30 | Seconds to attempt bind before giving up | -
| backlog = 4096 | Maximum number of allowed pending TCP connections | -
| user = swift | User to run as | -
| swift_dir = /etc/swift | Swift configuration directory | -
| devices = /srv/node | Parent directory of where devices are mounted | -
| mount_check = true | Whether or not check if the devices are mounted to prevent accidentally writing to the root device | -
| disable_fallocate = false | Disable "fast fail" fallocate checks if the underlying filesystem does not support it. | -
| workers = auto | a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | -
| max_clients = 1024 | Maximum number of clients one worker can process simultaneously + |
| backlog = 4096 | +Maximum number of allowed pending TCP connections | +
| bind_ip = 0.0.0.0 | +IP Address for server to bind to | +
| bind_port = 6002 | +Port for server to bind to | +
| bind_timeout = 30 | +Seconds to attempt bind before giving up | +
| db_preallocation = off | +If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#account`. replication passes account can be reclaimed | +
| devices = /srv/node | +Parent directory of where devices are mounted | +
| disable_fallocate = false | +Disable "fast fail" fallocate checks if the underlying filesystem does not support it. | +
| eventlet_debug = false | +If true, turn on debug logging for eventlet | +
| fallocate_reserve = 0 | +You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`. | +
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_custom_handlers = | +Comma-separated list of functions to call to setup custom log handlers. | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_level = INFO | +Logging level | +
| log_max_line_length = 0 | +Caps the length of log lines to the value given; no limit if set to 0, the default. | +
| log_name = swift | +Label used when logging | +
| log_statsd_default_sample_rate = 1.0 | +Defines the probability of sending a sample for any given event or + timing measurement. | +
| log_statsd_host = localhost | +If not set, the StatsD feature is disabled. | +
| log_statsd_metric_prefix = | +Value will be prepended to every metric sent to the StatsD server. | +
| log_statsd_port = 8125 | +Port value for the StatsD server. | +
| log_statsd_sample_rate_factor = 1.0 | +Not recommended to set this to a value less than 1.0, if frequency + of logging is too high, tune the + log_statsd_default_sample_rate instead. | +
| log_udp_host = | +If not set, the UDB receiver for syslog is disabled. | +
| log_udp_port = 514 | +Port value for UDB receiver, if enabled. | +
| max_clients = 1024 | +Maximum number of clients one worker can process simultaneously Lowering the number of clients handled per worker, and raising the number of workers can lessen the impact that a CPU intensive, or blocking, request can have on other requests served by the same @@ -53,55 +117,23 @@ worker. If the maximum number of clients is set to one, then a given worker will not perform another call while processing, allowing other workers a chance to process it. | -
| log_name = swift | Label used when logging | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| log_custom_handlers = | Comma-separated list of functions to call to setup custom log handlers. | -
| log_udp_host = | If not set, the UDB receiver for syslog is disabled. | -
| log_udp_port = 514 | Port value for UDB receiver, if enabled. | -
| log_statsd_host = localhost | If not set, the StatsD feature is disabled. | -
| log_statsd_port = 8125 | Port value for the StatsD server. | -
| log_statsd_default_sample_rate = 1.0 | Defines the probability of sending a sample for any given event or - timing measurement. | -
| log_statsd_sample_rate_factor = 1.0 | Not recommended to set this to a value less than 1.0, if frequency - of logging is too high, tune the - log_statsd_default_sample_rate instead. | -
| log_statsd_metric_prefix = | Value will be prepended to every metric sent to the StatsD server. | -
| db_preallocation = off | If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#account`. replication passes account can be reclaimed | -
| eventlet_debug = false | If true, turn on debug logging for eventlet | -
| fallocate_reserve = 0 | You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`. | -
| mount_check = true | +Whether or not check if the devices are mounted to prevent accidentally writing to the root device | +
| swift_dir = /etc/swift | +Swift configuration directory | +
| user = swift | +User to run as | +
| workers = auto | +a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| log_name = account-auditor | Label used when logging | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| interval = 1800 | Minimum time for a pass to take | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| accounts_per_second = 200 | Maximum accounts audited per second. Should be tuned according to individual system specs. 0 is unlimited. | -
| recon_cache_path = /var/cache/swift | Directory where stats for a few items will be stored | -
| accounts_per_second = 200 | +Maximum accounts audited per second. Should be tuned according to individual system specs. 0 is unlimited. | +
| interval = 1800 | +Minimum time for a pass to take | +
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_level = INFO | +Logging level | +
| log_name = account-auditor | +Label used when logging | +
| recon_cache_path = /var/cache/swift | +Directory where stats for a few items will be stored | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| log_name = account-reaper | Label used when logging | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| concurrency = 25 | Number of replication workers to spawn | -
| interval = 3600 | Minimum time for a pass to take | -
| node_timeout = 10 | Request timeout to external services | -
| conn_timeout = 0.5 | Connection timeout to external services | -
| delay_reaping = 0 | Normally, the reaper begins deleting account information for deleted accounts immediately; you can set this to delay its work however. The value is in seconds, 2592000 = 30 days, for example. bind to giving up worker can process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | -
| reap_warn_after = 2592000 | No help text available for this option. | -
| concurrency = 25 | +Number of replication workers to spawn | +
| conn_timeout = 0.5 | +Connection timeout to external services | +
| delay_reaping = 0 | +Normally, the reaper begins deleting account information for deleted accounts immediately; you can set this to delay its work however. The value is in seconds, 2592000 = 30 days, for example. bind to giving up worker can process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | +
| interval = 3600 | +Minimum time for a pass to take | +
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_level = INFO | +Logging level | +
| log_name = account-reaper | +Label used when logging | +
| node_timeout = 10 | +Request timeout to external services | +
| reap_warn_after = 2592000 | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| log_name = account-replicator | Label used when logging | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| vm_test_mode = no | Indicates that you are using a VM environment | -
| per_diff = 1000 | Limit number of items to get per diff | -
| max_diffs = 100 | Caps how long the replicator spends trying to sync a database per pass | -
| concurrency = 8 | Number of replication workers to spawn | -
| interval = 30 | Minimum time for a pass to take | -
| error_suppression_interval = 60 | Time in seconds that must elapse since the last error for a node to be considered no longer error limited | -
| error_suppression_limit = 10 | Error count to consider a node error limited | -
| node_timeout = 10 | Request timeout to external services | -
| conn_timeout = 0.5 | Connection timeout to external services | -
| reclaim_age = 604800 | Time elapsed in seconds before an object can be reclaimed | -
| run_pause = 30 | Time in seconds to wait between replication passes | -
| recon_cache_path = /var/cache/swift | Directory where stats for a few items will be stored | -
| concurrency = 8 | +Number of replication workers to spawn | +
| conn_timeout = 0.5 | +Connection timeout to external services | +
| error_suppression_interval = 60 | +Time in seconds that must elapse since the last error for a node to be considered no longer error limited | +
| error_suppression_limit = 10 | +Error count to consider a node error limited | +
| interval = 30 | +Minimum time for a pass to take | +
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_level = INFO | +Logging level | +
| log_name = account-replicator | +Label used when logging | +
| max_diffs = 100 | +Caps how long the replicator spends trying to sync a database per pass | +
| node_timeout = 10 | +Request timeout to external services | +
| per_diff = 1000 | +Limit number of items to get per diff | +
| reclaim_age = 604800 | +Time elapsed in seconds before an object can be reclaimed | +
| recon_cache_path = /var/cache/swift | +Directory where stats for a few items will be stored | +
| run_pause = 30 | +Time in seconds to wait between replication passes | +
| vm_test_mode = no | +Indicates that you are using a VM environment | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#account | Entry point of paste.deploy in the server | -
| set log_name = account-server | Label to use when logging | -
| set log_facility = LOG_LOCAL0 | Syslog log facility | -
| set log_level = INFO | Log level | -
| set log_requests = true | Whether or not to log requests | -
| set log_address = /dev/log | Location where syslog sends the logs to | -
| auto_create_account_prefix = . | Prefix to use when automatically creating accounts | -
| replication_server = false | If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request. | -
| auto_create_account_prefix = . | +Prefix to use when automatically creating accounts | +
| replication_server = false | +If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request. | +
| set log_address = /dev/log | +Location where syslog sends the logs to | +
| set log_facility = LOG_LOCAL0 | +Syslog log facility | +
| set log_level = INFO | +Log level | +
| set log_name = account-server | +Label to use when logging | +
| set log_requests = true | +Whether or not to log requests | +
| use = egg:swift#account | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#healthcheck | Entry point of paste.deploy in the server | -
| disable_path = | No help text available for this option. | -
| disable_path = | +No help text available for this option. | +
| use = egg:swift#healthcheck | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#recon | Entry point of paste.deploy in the server | -
| recon_cache_path = /var/cache/swift | Directory where stats for a few items will be stored | -
| recon_cache_path = /var/cache/swift | +Directory where stats for a few items will be stored | +
| use = egg:swift#recon | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | +Description | +
|---|---|
| dump_interval = 5.0 | +No help text available for this option. | +
| dump_timestamp = false | +No help text available for this option. | +
| flush_at_shutdown = false | +No help text available for this option. | +
| log_filename_prefix = /tmp/log/swift/profile/default.profile | +No help text available for this option. | +
| path = /__profile__ | +No help text available for this option. | +
| profile_module = eventlet.green.profile | +No help text available for this option. | +
| unwind = false | +No help text available for this option. | +
| use = egg:swift#xprofile | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| pipeline = healthcheck recon account-server | No help text available for this option. | -
| pipeline = healthcheck recon account-server | +No help text available for this option. | +
| Configuration option = Default value | +Description | +
|---|---|
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_custom_handlers = | +Comma-separated list of functions to call to setup custom log handlers. | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_level = INFO | +Logging level | +
| log_name = swift | +Label used when logging | +
| log_statsd_default_sample_rate = 1.0 | +Defines the probability of sending a sample for any given event or + timing measurement. | +
| log_statsd_host = localhost | +If not set, the StatsD feature is disabled. | +
| log_statsd_metric_prefix = | +Value will be prepended to every metric sent to the StatsD server. | +
| log_statsd_port = 8125 | +Port value for the StatsD server. | +
| log_statsd_sample_rate_factor = 1.0 | +Not recommended to set this to a value less than 1.0, if frequency + of logging is too high, tune the + log_statsd_default_sample_rate instead. | +
| log_udp_host = | +If not set, the UDB receiver for syslog is disabled. | +
| log_udp_port = 514 | +Port value for UDB receiver, if enabled. | +
| swift_dir = /etc/swift | +Swift configuration directory | +
| user = swift | +User to run as | +
| Configuration option = Default value | +Description | +
|---|---|
| use = egg:swift#proxy | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | +Description | +
|---|---|
| interval = 300 | +Minimum time for a pass to take | +
| reclaim_age = 604800 | +Time elapsed in seconds before an object can be reclaimed | +
| request_tries = 3 | +No help text available for this option. | +
| Configuration option = Default value | +Description | +
|---|---|
| use = egg:swift#memcache | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | +Description | +
|---|---|
| use = egg:swift#catch_errors | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | +Description | +
|---|---|
| use = egg:swift#proxy_logging | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | +Description | +
|---|---|
| pipeline = catch_errors proxy-logging cache proxy-server | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| bind_ip = 0.0.0.0 | IP Address for server to bind to | -
| bind_port = 6001 | Port for server to bind to | -
| bind_timeout = 30 | Seconds to attempt bind before giving up | -
| backlog = 4096 | Maximum number of allowed pending TCP connections | -
| user = swift | User to run as | -
| swift_dir = /etc/swift | Swift configuration directory | -
| devices = /srv/node | Parent directory of where devices are mounted | -
| mount_check = true | Whether or not check if the devices are mounted to prevent accidentally writing to the root device | -
| disable_fallocate = false | Disable "fast fail" fallocate checks if the underlying filesystem does not support it. | -
| workers = auto | a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | -
| max_clients = 1024 | Maximum number of clients one worker can process simultaneously + |
| allowed_sync_hosts = 127.0.0.1 | +No help text available for this option. | +
| backlog = 4096 | +Maximum number of allowed pending TCP connections | +
| bind_ip = 0.0.0.0 | +IP Address for server to bind to | +
| bind_port = 6001 | +Port for server to bind to | +
| bind_timeout = 30 | +Seconds to attempt bind before giving up | +
| db_preallocation = off | +If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#account`. replication passes account can be reclaimed | +
| devices = /srv/node | +Parent directory of where devices are mounted | +
| disable_fallocate = false | +Disable "fast fail" fallocate checks if the underlying filesystem does not support it. | +
| eventlet_debug = false | +If true, turn on debug logging for eventlet | +
| fallocate_reserve = 0 | +You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`. | +
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_custom_handlers = | +Comma-separated list of functions to call to setup custom log handlers. | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_level = INFO | +Logging level | +
| log_max_line_length = 0 | +Caps the length of log lines to the value given; no limit if set to 0, the default. | +
| log_name = swift | +Label used when logging | +
| log_statsd_default_sample_rate = 1.0 | +Defines the probability of sending a sample for any given event or + timing measurement. | +
| log_statsd_host = localhost | +If not set, the StatsD feature is disabled. | +
| log_statsd_metric_prefix = | +Value will be prepended to every metric sent to the StatsD server. | +
| log_statsd_port = 8125 | +Port value for the StatsD server. | +
| log_statsd_sample_rate_factor = 1.0 | +Not recommended to set this to a value less than 1.0, if frequency + of logging is too high, tune the + log_statsd_default_sample_rate instead. | +
| log_udp_host = | +If not set, the UDB receiver for syslog is disabled. | +
| log_udp_port = 514 | +Port value for UDB receiver, if enabled. | +
| max_clients = 1024 | +Maximum number of clients one worker can process simultaneously Lowering the number of clients handled per worker, and raising the number of workers can lessen the impact that a CPU intensive, or blocking, request can have on other requests served by the same @@ -53,58 +121,23 @@ worker. If the maximum number of clients is set to one, then a given worker will not perform another call while processing, allowing other workers a chance to process it. | -
| allowed_sync_hosts = 127.0.0.1 | No help text available for this option. | -
| log_name = swift | Label used when logging | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| log_custom_handlers = | Comma-separated list of functions to call to setup custom log handlers. | -
| log_udp_host = | If not set, the UDB receiver for syslog is disabled. | -
| log_udp_port = 514 | Port value for UDB receiver, if enabled. | -
| log_statsd_host = localhost | If not set, the StatsD feature is disabled. | -
| log_statsd_port = 8125 | Port value for the StatsD server. | -
| log_statsd_default_sample_rate = 1.0 | Defines the probability of sending a sample for any given event or - timing measurement. | -
| log_statsd_sample_rate_factor = 1.0 | Not recommended to set this to a value less than 1.0, if frequency - of logging is too high, tune the - log_statsd_default_sample_rate instead. | -
| log_statsd_metric_prefix = | Value will be prepended to every metric sent to the StatsD server. | -
| db_preallocation = off | If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#account`. replication passes account can be reclaimed | -
| eventlet_debug = false | If true, turn on debug logging for eventlet | -
| fallocate_reserve = 0 | You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`. | -
| mount_check = true | +Whether or not check if the devices are mounted to prevent accidentally writing to the root device | +
| swift_dir = /etc/swift | +Swift configuration directory | +
| user = swift | +User to run as | +
| workers = auto | +a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#container | Entry point of paste.deploy in the server | -
| set log_name = container-server | Label to use when logging | -
| set log_facility = LOG_LOCAL0 | Syslog log facility | -
| set log_level = INFO | Log level | -
| set log_requests = true | Whether or not to log requests | -
| set log_address = /dev/log | Location where syslog sends the logs to | -
| node_timeout = 3 | Request timeout to external services | -
| conn_timeout = 0.5 | Connection timeout to external services | -
| allow_versions = false | Enable/Disable object versioning feature | -
| auto_create_account_prefix = . | Prefix to use when automatically creating accounts | -
| replication_server = false | If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request. | -
| allow_versions = false | +Enable/Disable object versioning feature | +
| auto_create_account_prefix = . | +Prefix to use when automatically creating accounts | +
| conn_timeout = 0.5 | +Connection timeout to external services | +
| node_timeout = 3 | +Request timeout to external services | +
| replication_server = false | +If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request. | +
| set log_address = /dev/log | +Location where syslog sends the logs to | +
| set log_facility = LOG_LOCAL0 | +Syslog log facility | +
| set log_level = INFO | +Log level | +
| set log_name = container-server | +Label to use when logging | +
| set log_requests = true | +Whether or not to log requests | +
| use = egg:swift#container | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| log_name = container-auditor | Label used when logging | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| interval = 1800 | Minimum time for a pass to take | -
| containers_per_second = 200 | Maximum containers audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | -
| recon_cache_path = /var/cache/swift | Directory where stats for a few items will be stored | -
| containers_per_second = 200 | +Maximum containers audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | +
| interval = 1800 | +Minimum time for a pass to take | +
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_level = INFO | +Logging level | +
| log_name = container-auditor | +Label used when logging | +
| recon_cache_path = /var/cache/swift | +Directory where stats for a few items will be stored | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| log_name = container-replicator | Label used when logging | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| vm_test_mode = no | Indicates that you are using a VM environment | -
| per_diff = 1000 | Limit number of items to get per diff | -
| max_diffs = 100 | Caps how long the replicator spends trying to sync a database per pass | -
| concurrency = 8 | Number of replication workers to spawn | -
| interval = 30 | Minimum time for a pass to take | -
| node_timeout = 10 | Request timeout to external services | -
| conn_timeout = 0.5 | Connection timeout to external services | -
| reclaim_age = 604800 | Time elapsed in seconds before an object can be reclaimed | -
| run_pause = 30 | Time in seconds to wait between replication passes | -
| recon_cache_path = /var/cache/swift | Directory where stats for a few items will be stored | -
| concurrency = 8 | +Number of replication workers to spawn | +
| conn_timeout = 0.5 | +Connection timeout to external services | +
| interval = 30 | +Minimum time for a pass to take | +
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_level = INFO | +Logging level | +
| log_name = container-replicator | +Label used when logging | +
| max_diffs = 100 | +Caps how long the replicator spends trying to sync a database per pass | +
| node_timeout = 10 | +Request timeout to external services | +
| per_diff = 1000 | +Limit number of items to get per diff | +
| reclaim_age = 604800 | +Time elapsed in seconds before an object can be reclaimed | +
| recon_cache_path = /var/cache/swift | +Directory where stats for a few items will be stored | +
| run_pause = 30 | +Time in seconds to wait between replication passes | +
| vm_test_mode = no | +Indicates that you are using a VM environment | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| log_name = container-sync | Label used when logging | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| sync_proxy = http://10.1.1.1:8888,http://10.1.1.2:8888 | If you need to use an HTTP proxy, set it here. Defaults to no proxy. | -
| interval = 300 | Minimum time for a pass to take | -
| container_time = 60 | Maximum amount of time to spend syncing each container | -
| container_time = 60 | +Maximum amount of time to spend syncing each container | +
| interval = 300 | +Minimum time for a pass to take | +
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_level = INFO | +Logging level | +
| log_name = container-sync | +Label used when logging | +
| sync_proxy = http://10.1.1.1:8888,http://10.1.1.2:8888 | +If you need to use an HTTP proxy, set it here. Defaults to no proxy. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| log_name = container-updater | Label used when logging | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| interval = 300 | Minimum time for a pass to take | -
| concurrency = 4 | Number of replication workers to spawn | -
| node_timeout = 3 | Request timeout to external services | -
| conn_timeout = 0.5 | Connection timeout to external services | -
| slowdown = 0.01 | Time in seconds to wait between objects | -
| account_suppression_time = 60 | Seconds to suppress updating an account that has generated an + |
| account_suppression_time = 60 | +Seconds to suppress updating an account that has generated an error (timeout, not yet found, etc.) | -
| recon_cache_path = /var/cache/swift | Directory where stats for a few items will be stored | -
| concurrency = 4 | +Number of replication workers to spawn | +
| conn_timeout = 0.5 | +Connection timeout to external services | +
| interval = 300 | +Minimum time for a pass to take | +
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_level = INFO | +Logging level | +
| log_name = container-updater | +Label used when logging | +
| node_timeout = 3 | +Request timeout to external services | +
| recon_cache_path = /var/cache/swift | +Directory where stats for a few items will be stored | +
| slowdown = 0.01 | +Time in seconds to wait between objects | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#healthcheck | Entry point of paste.deploy in the server | -
| disable_path = | No help text available for this option. | -
| disable_path = | +No help text available for this option. | +
| use = egg:swift#healthcheck | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#recon | Entry point of paste.deploy in the server | -
| recon_cache_path = /var/cache/swift | Directory where stats for a few items will be stored | -
| recon_cache_path = /var/cache/swift | +Directory where stats for a few items will be stored | +
| use = egg:swift#recon | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | +Description | +
|---|---|
| dump_interval = 5.0 | +No help text available for this option. | +
| dump_timestamp = false | +No help text available for this option. | +
| flush_at_shutdown = false | +No help text available for this option. | +
| log_filename_prefix = /tmp/log/swift/profile/default.profile | +No help text available for this option. | +
| path = /__profile__ | +No help text available for this option. | +
| profile_module = eventlet.green.profile | +No help text available for this option. | +
| unwind = false | +No help text available for this option. | +
| use = egg:swift#xprofile | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| pipeline = healthcheck recon container-server | No help text available for this option. | -
| pipeline = healthcheck recon container-server | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| mtime_check_interval = 300 | No help text available for this option. | -
| mtime_check_interval = 300 | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| key = realm1key | No help text available for this option. | -
| key2 = realm1key2 | No help text available for this option. | -
| cluster_name1 = https://host1/v1/ | No help text available for this option. | -
| cluster_name2 = https://host2/v1/ | No help text available for this option. | -
| cluster_name1 = https://host1/v1/ | +No help text available for this option. | +
| cluster_name2 = https://host2/v1/ | +No help text available for this option. | +
| key = realm1key | +No help text available for this option. | +
| key2 = realm1key2 | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| key = realm2key | No help text available for this option. | -
| key2 = realm2key2 | No help text available for this option. | -
| cluster_name3 = https://host3/v1/ | No help text available for this option. | -
| cluster_name4 = https://host4/v1/ | No help text available for this option. | -
| cluster_name3 = https://host3/v1/ | +No help text available for this option. | +
| cluster_name4 = https://host4/v1/ | +No help text available for this option. | +
| key = realm2key | +No help text available for this option. | +
| key2 = realm2key2 | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| auth_url = http://localhost:8080/auth/v1.0 | Endpoint for auth server, such as keystone | -
| auth_user = test:tester | Default user for dispersion in this context | -
| auth_key = testing | No help text available for this option. | -
| auth_url = http://localhost:5000/v2.0/ | Endpoint for auth server, such as keystone | -
| auth_user = tenant:user | Default user for dispersion in this context | -
| auth_key = password | No help text available for this option. | -
| auth_version = 2.0 | Indicates which version of auth | -
| endpoint_type = publicURL | Indicates whether endpoint for auth is public or internal | -
| keystone_api_insecure = no | Allow accessing insecure keystone server. The keystone's certificate will not be verified. | -
| swift_dir = /etc/swift | Swift configuration directory | -
| dispersion_coverage = 1.0 | No help text available for this option. | -
| retries = 5 | No help text available for this option. | -
| concurrency = 25 | Number of replication workers to spawn | -
| container_populate = yes | No help text available for this option. | -
| object_populate = yes | No help text available for this option. | -
| container_report = yes | No help text available for this option. | -
| object_report = yes | No help text available for this option. | -
| dump_json = no | No help text available for this option. | -
| auth_key = testing | +No help text available for this option. | +
| auth_url = http://localhost:8080/auth/v1.0 | +Endpoint for auth server, such as keystone | +
| auth_user = test:tester | +Default user for dispersion in this context | +
| auth_version = 2.0 | +Indicates which version of auth | +
| concurrency = 25 | +Number of replication workers to spawn | +
| container_populate = yes | +No help text available for this option. | +
| container_report = yes | +No help text available for this option. | +
| dispersion_coverage = 1.0 | +No help text available for this option. | +
| dump_json = no | +No help text available for this option. | +
| endpoint_type = publicURL | +Indicates whether endpoint for auth is public or internal | +
| keystone_api_insecure = no | +Allow accessing insecure keystone server. The keystone's certificate will not be verified. | +
| object_populate = yes | +No help text available for this option. | +
| object_report = yes | +No help text available for this option. | +
| retries = 5 | +No help text available for this option. | +
| swift_dir = /etc/swift | +Swift configuration directory | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| device_dir = /srv/node | Directory devices are mounted under | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| minutes = 60 | Number of minutes to look back in `/var/log/kern.log` | -
| error_limit = 1 | Number of errors to find before a device is unmounted | -
| log_file_pattern = /var/log/kern* | Location of the log file with globbing pattern to check against device errors locate device blocks with errors in the log file | -
| regex_pattern_1 = \berror\b.*\b(dm-[0-9]{1,2}\d?)\b | No help text available for this option. | -
| device_dir = /srv/node | +Directory devices are mounted under | +
| error_limit = 1 | +Number of errors to find before a device is unmounted | +
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_file_pattern = /var/log/kern* | +Location of the log file with globbing pattern to check against device errors locate device blocks with errors in the log file | +
| log_level = INFO | +Logging level | +
| log_max_line_length = 0 | +Caps the length of log lines to the value given; no limit if set to 0, the default. | +
| minutes = 60 | +Number of minutes to look back in `/var/log/kern.log` | +
| regex_pattern_1 = \berror\b.*\b(dm-[0-9]{1,2}\d?)\b | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| memcache_servers = 127.0.0.1:11211 | Comma separated list of memcached servers ip:port services | -
| memcache_serialization_support = 2 | No help text available for this option. | -
| memcache_max_connections = 2 | Max number of connections to each memcached server per worker services | -
| memcache_max_connections = 2 | +Max number of connections to each memcached server per worker services | +
| memcache_serialization_support = 2 | +No help text available for this option. | +
| memcache_servers = 127.0.0.1:11211 | +Comma separated list of memcached servers ip:port services | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| swift_dir = /etc/swift | Swift configuration directory | -
| user = swift | User to run as | -
| log_name = swift | Label used when logging | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| log_custom_handlers = | Comma-separated list of functions to call to setup custom log handlers. | -
| log_udp_host = | If not set, the UDB receiver for syslog is disabled. | -
| log_udp_port = 514 | Port value for UDB receiver, if enabled. | -
| log_statsd_host = localhost | If not set, the StatsD feature is disabled. | -
| log_statsd_port = 8125 | Port value for the StatsD server. | -
| log_statsd_default_sample_rate = 1.0 | Defines the probability of sending a sample for any given event or + |
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_custom_handlers = | +Comma-separated list of functions to call to setup custom log handlers. | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_level = INFO | +Logging level | +
| log_max_line_length = 0 | +Caps the length of log lines to the value given; no limit if set to 0, the default. | +
| log_name = swift | +Label used when logging | +
| log_statsd_default_sample_rate = 1.0 | +Defines the probability of sending a sample for any given event or timing measurement. | -
| log_statsd_sample_rate_factor = 1.0 | Not recommended to set this to a value less than 1.0, if frequency + |
| log_statsd_host = localhost | +If not set, the StatsD feature is disabled. | +
| log_statsd_metric_prefix = | +Value will be prepended to every metric sent to the StatsD server. | +
| log_statsd_port = 8125 | +Port value for the StatsD server. | +
| log_statsd_sample_rate_factor = 1.0 | +Not recommended to set this to a value less than 1.0, if frequency of logging is too high, tune the log_statsd_default_sample_rate instead. | -
| log_statsd_metric_prefix = | Value will be prepended to every metric sent to the StatsD server. | -
| log_udp_host = | +If not set, the UDB receiver for syslog is disabled. | +
| log_udp_port = 514 | +Port value for UDB receiver, if enabled. | +
| swift_dir = /etc/swift | +Swift configuration directory | +
| user = swift | +User to run as | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#proxy | Entry point of paste.deploy in the server | -
| use = egg:swift#proxy | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#memcache | Entry point of paste.deploy in the server | -
| use = egg:swift#memcache | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#catch_errors | Entry point of paste.deploy in the server | -
| use = egg:swift#catch_errors | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| interval = 300 | Minimum time for a pass to take | -
| auto_create_account_prefix = . | Prefix to use when automatically creating accounts | -
| expiring_objects_account_name = expiring_objects | No help text available for this option. | -
| report_interval = 300 | No help text available for this option. | -
| concurrency = 1 | Number of replication workers to spawn | -
| processes = 0 | No help text available for this option. | -
| process = 0 | (it will actually accept(2) N + 1). Setting this to one (1) will + |
| auto_create_account_prefix = . | +Prefix to use when automatically creating accounts | +
| concurrency = 1 | +Number of replication workers to spawn | +
| expiring_objects_account_name = expiring_objects | +No help text available for this option. | +
| interval = 300 | +Minimum time for a pass to take | +
| process = 0 | +(it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. | -
| processes = 0 | +No help text available for this option. | +
| reclaim_age = 604800 | +Time elapsed in seconds before an object can be reclaimed | +
| report_interval = 300 | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| pipeline = catch_errors cache proxy-server | No help text available for this option. | -
| pipeline = catch_errors cache proxy-server | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| bind_ip = 0.0.0.0 | IP Address for server to bind to | -
| bind_port = 6000 | Port for server to bind to | -
| bind_timeout = 30 | Seconds to attempt bind before giving up | -
| backlog = 4096 | Maximum number of allowed pending TCP connections | -
| user = swift | User to run as | -
| swift_dir = /etc/swift | Swift configuration directory | -
| devices = /srv/node | Parent directory of where devices are mounted | -
| mount_check = true | Whether or not check if the devices are mounted to prevent accidentally writing to the root device | -
| disable_fallocate = false | Disable "fast fail" fallocate checks if the underlying filesystem does not support it. | -
| expiring_objects_container_divisor = 86400 | No help text available for this option. | -
| expiring_objects_account_name = expiring_objects | No help text available for this option. | -
| workers = auto | a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | -
| max_clients = 1024 | Maximum number of clients one worker can process simultaneously + |
| backlog = 4096 | +Maximum number of allowed pending TCP connections | +
| bind_ip = 0.0.0.0 | +IP Address for server to bind to | +
| bind_port = 6000 | +Port for server to bind to | +
| bind_timeout = 30 | +Seconds to attempt bind before giving up | +
| client_timeout = 60 | +Timeout to read one chunk from a client external services | +
| conn_timeout = 0.5 | +Connection timeout to external services | +
| devices = /srv/node | +Parent directory of where devices are mounted | +
| disable_fallocate = false | +Disable "fast fail" fallocate checks if the underlying filesystem does not support it. | +
| disk_chunk_size = 65536 | +Size of chunks to read/write to disk | +
| eventlet_debug = false | +If true, turn on debug logging for eventlet | +
| expiring_objects_account_name = expiring_objects | +No help text available for this option. | +
| expiring_objects_container_divisor = 86400 | +No help text available for this option. | +
| fallocate_reserve = 0 | +You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`. | +
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_custom_handlers = | +Comma-separated list of functions to call to setup custom log handlers. | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_level = INFO | +Logging level | +
| log_max_line_length = 0 | +Caps the length of log lines to the value given; no limit if set to 0, the default. | +
| log_name = swift | +Label used when logging | +
| log_statsd_default_sample_rate = 1.0 | +Defines the probability of sending a sample for any given event or + timing measurement. | +
| log_statsd_host = localhost | +If not set, the StatsD feature is disabled. | +
| log_statsd_metric_prefix = | +Value will be prepended to every metric sent to the StatsD server. | +
| log_statsd_port = 8125 | +Port value for the StatsD server. | +
| log_statsd_sample_rate_factor = 1.0 | +Not recommended to set this to a value less than 1.0, if frequency + of logging is too high, tune the + log_statsd_default_sample_rate instead. | +
| log_udp_host = | +If not set, the UDB receiver for syslog is disabled. | +
| log_udp_port = 514 | +Port value for UDB receiver, if enabled. | +
| max_clients = 1024 | +Maximum number of clients one worker can process simultaneously Lowering the number of clients handled per worker, and raising the number of workers can lessen the impact that a CPU intensive, or blocking, request can have on other requests served by the same @@ -59,67 +133,31 @@ worker. If the maximum number of clients is set to one, then a given worker will not perform another call while processing, allowing other workers a chance to process it. | -
| log_name = swift | Label used when logging | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| log_custom_handlers = | Comma-separated list of functions to call to setup custom log handlers. | -
| log_udp_host = | If not set, the UDB receiver for syslog is disabled. | -
| log_udp_port = 514 | Port value for UDB receiver, if enabled. | -
| log_statsd_host = localhost | If not set, the StatsD feature is disabled. | -
| log_statsd_port = 8125 | Port value for the StatsD server. | -
| log_statsd_default_sample_rate = 1.0 | Defines the probability of sending a sample for any given event or - timing measurement. | -
| log_statsd_sample_rate_factor = 1.0 | Not recommended to set this to a value less than 1.0, if frequency - of logging is too high, tune the - log_statsd_default_sample_rate instead. | -
| log_statsd_metric_prefix = | Value will be prepended to every metric sent to the StatsD server. | -
| eventlet_debug = false | If true, turn on debug logging for eventlet | -
| fallocate_reserve = 0 | You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`. | -
| conn_timeout = 0.5 | Connection timeout to external services | -
| node_timeout = 3 | Request timeout to external services | -
| client_timeout = 60 | Timeout to read one chunk from a client external services | -
| network_chunk_size = 65536 | Size of chunks to read/write over the network | -
| disk_chunk_size = 65536 | Size of chunks to read/write to disk | -
| mount_check = true | +Whether or not check if the devices are mounted to prevent accidentally writing to the root device | +
| network_chunk_size = 65536 | +Size of chunks to read/write over the network | +
| node_timeout = 3 | +Request timeout to external services | +
| swift_dir = /etc/swift | +Swift configuration directory | +
| user = swift | +User to run as | +
| workers = auto | +a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#object | Entry point of paste.deploy in the server | -
| set log_name = object-server | Label to use when logging | -
| set log_facility = LOG_LOCAL0 | Syslog log facility | -
| set log_level = INFO | Log level | -
| set log_requests = true | Whether or not to log requests | -
| set log_address = /dev/log | Location where syslog sends the logs to | -
| max_upload_time = 86400 | Maximum time allowed to upload an object | -
| slow = 0 | If > 0, Minimum time in seconds for a PUT or DELETE request to complete | -
| keep_cache_size = 5424880 | Largest object size to keep in buffer cache | -
| keep_cache_private = false | Allow non-public objects to stay in kernel's buffer cache | -
| mb_per_sync = 512 | On PUT requests, sync file every n MB | -
| allowed_headers = Content-Disposition, Content-Encoding, X-Delete-At, X-Object-Manifest, X-Static-Large-Object | Comma-separated list of headers that can be set in metadata of an object | -
| auto_create_account_prefix = . | Prefix to use when automatically creating accounts | -
| threads_per_disk = 0 | Size of the per-disk thread pool used for performing disk I/O. The default of 0 means to not use a per-disk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk. | -
| replication_server = false | If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request. | -
| replication_concurrency = 4 | Set to restrict the number of concurrent incoming REPLICATION requests; set to 0 for unlimited | -
| replication_one_per_device = True | Restricts incoming REPLICATION requests to one per device, replication_currency above allowing. This can help control I/O to each device, but you may wish to set this to False to allow multiple REPLICATION requests (up to the above replication_concurrency setting) per device. | -
| replication_lock_timeout = 15 | Number of seconds to wait for an existing replication device lock before giving up. | -
| replication_failure_threshold = 100 | The number of subrequest failures before the replication_failure_ratio is checked | -
| replication_failure_ratio = 1.0 | If the value of failures / successes of REPLICATION subrequests exceeds this ratio, the overall REPLICATION request will be aborted | -
| allowed_headers = Content-Disposition, Content-Encoding, X-Delete-At, X-Object-Manifest, X-Static-Large-Object | +Comma-separated list of headers that can be set in metadata of an object | +
| auto_create_account_prefix = . | +Prefix to use when automatically creating accounts | +
| keep_cache_private = false | +Allow non-public objects to stay in kernel's buffer cache | +
| keep_cache_size = 5424880 | +Largest object size to keep in buffer cache | +
| max_upload_time = 86400 | +Maximum time allowed to upload an object | +
| mb_per_sync = 512 | +On PUT requests, sync file every n MB | +
| replication_concurrency = 4 | +Set to restrict the number of concurrent incoming REPLICATION requests; set to 0 for unlimited | +
| replication_failure_ratio = 1.0 | +If the value of failures / successes of REPLICATION subrequests exceeds this ratio, the overall REPLICATION request will be aborted | +
| replication_failure_threshold = 100 | +The number of subrequest failures before the replication_failure_ratio is checked | +
| replication_lock_timeout = 15 | +Number of seconds to wait for an existing replication device lock before giving up. | +
| replication_one_per_device = True | +Restricts incoming REPLICATION requests to one per device, replication_currency above allowing. This can help control I/O to each device, but you may wish to set this to False to allow multiple REPLICATION requests (up to the above replication_concurrency setting) per device. | +
| replication_server = false | +If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request. | +
| set log_address = /dev/log | +Location where syslog sends the logs to | +
| set log_facility = LOG_LOCAL0 | +Syslog log facility | +
| set log_level = INFO | +Log level | +
| set log_name = object-server | +Label to use when logging | +
| set log_requests = true | +Whether or not to log requests | +
| slow = 0 | +If > 0, Minimum time in seconds for a PUT or DELETE request to complete | +
| threads_per_disk = 0 | +Size of the per-disk thread pool used for performing disk I/O. The default of 0 means to not use a per-disk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk. | +
| use = egg:swift#object | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#healthcheck | Entry point of paste.deploy in the server | -
| disable_path = | No help text available for this option. | -
| disable_path = | +No help text available for this option. | +
| use = egg:swift#healthcheck | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#recon | Entry point of paste.deploy in the server | -
| recon_cache_path = /var/cache/swift | Directory where stats for a few items will be stored | -
| recon_lock_path = /var/lock | No help text available for this option. | -
| recon_cache_path = /var/cache/swift | +Directory where stats for a few items will be stored | +
| recon_lock_path = /var/lock | +No help text available for this option. | +
| use = egg:swift#recon | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | +Description | +
|---|---|
| dump_interval = 5.0 | +No help text available for this option. | +
| dump_timestamp = false | +No help text available for this option. | +
| flush_at_shutdown = false | +No help text available for this option. | +
| log_filename_prefix = /tmp/log/swift/profile/default.profile | +No help text available for this option. | +
| path = /__profile__ | +No help text available for this option. | +
| profile_module = eventlet.green.profile | +No help text available for this option. | +
| unwind = false | +No help text available for this option. | +
| use = egg:swift#xprofile | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| log_name = object-auditor | Label used when logging | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| files_per_second = 20 | Maximum files audited per second. Should be tuned according to individual system specs. 0 is unlimited. | -
| bytes_per_second = 10000000 | Maximum bytes audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. container server. For most cases, this should be `egg:swift#container`. | -
| log_time = 3600 | Frequency of status logs in seconds. | -
| zero_byte_files_per_second = 50 | Maximum zero byte files audited per second. | -
| recon_cache_path = /var/cache/swift | Directory where stats for a few items will be stored | -
| object_size_stats = | No help text available for this option. | -
| bytes_per_second = 10000000 | +Maximum bytes audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. container server. For most cases, this should be `egg:swift#container`. | +
| files_per_second = 20 | +Maximum files audited per second. Should be tuned according to individual system specs. 0 is unlimited. | +
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_level = INFO | +Logging level | +
| log_name = object-auditor | +Label used when logging | +
| log_time = 3600 | +Frequency of status logs in seconds. | +
| object_size_stats = | +No help text available for this option. | +
| recon_cache_path = /var/cache/swift | +Directory where stats for a few items will be stored | +
| zero_byte_files_per_second = 50 | +Maximum zero byte files audited per second. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| log_name = object-replicator | Label used when logging | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| vm_test_mode = no | Indicates that you are using a VM environment | -
| daemonize = on | Whether or not to run replication as a daemon | -
| run_pause = 30 | Time in seconds to wait between replication passes | -
| concurrency = 1 | Number of replication workers to spawn | -
| stats_interval = 300 | Interval in seconds between logging replication statistics | -
| sync_method = rsync | No help text available for this option. | -
| rsync_timeout = 900 | Max duration (seconds) of a partition rsync | -
| rsync_bwlimit = 0 | No help text available for this option. | -
| rsync_io_timeout = 30 | Passed to rsync for a max duration (seconds) of an I/O op | -
| node_timeout = <whatever's in the DEFAULT section or 10> | Request timeout to external services | -
| http_timeout = 60 | Maximum duration for an HTTP request | -
| lockup_timeout = 1800 | Attempts to kill all workers if nothing replications for lockup_timeout seconds | -
| reclaim_age = 604800 | Time elapsed in seconds before an object can be reclaimed | -
| ring_check_interval = 15 | How often (in seconds) to check the ring | -
| recon_cache_path = /var/cache/swift | Directory where stats for a few items will be stored | -
| rsync_error_log_line_length = 0 | No help text available for this option. | -
| handoffs_first = False | If set to True, partitions that are not supposed to be on the node will be replicated first. The default setting should not be changed, except for extreme situations. | -
| handoff_delete = auto | By default handoff partitions will be removed when it has successfully replicated to all the canonical nodes. If set to an integer n, it will remove the partition if it is successfully replicated to n nodes. The default setting should not be changed, except for extremem situations. This uses what's set here, or what's set in the DEFAULT section, or 10 (though other sections use 3 as the final default). | -
| concurrency = 1 | +Number of replication workers to spawn | +
| daemonize = on | +Whether or not to run replication as a daemon | +
| handoff_delete = auto | +By default handoff partitions will be removed when it has successfully replicated to all the canonical nodes. If set to an integer n, it will remove the partition if it is successfully replicated to n nodes. The default setting should not be changed, except for extremem situations. This uses what's set here, or what's set in the DEFAULT section, or 10 (though other sections use 3 as the final default). | +
| handoffs_first = False | +If set to True, partitions that are not supposed to be on the node will be replicated first. The default setting should not be changed, except for extreme situations. | +
| http_timeout = 60 | +Maximum duration for an HTTP request | +
| lockup_timeout = 1800 | +Attempts to kill all workers if nothing replications for lockup_timeout seconds | +
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_level = INFO | +Logging level | +
| log_name = object-replicator | +Label used when logging | +
| node_timeout = <whatever's in the DEFAULT section or 10> | +Request timeout to external services | +
| reclaim_age = 604800 | +Time elapsed in seconds before an object can be reclaimed | +
| recon_cache_path = /var/cache/swift | +Directory where stats for a few items will be stored | +
| ring_check_interval = 15 | +How often (in seconds) to check the ring | +
| rsync_bwlimit = 0 | +No help text available for this option. | +
| rsync_error_log_line_length = 0 | +No help text available for this option. | +
| rsync_io_timeout = 30 | +Passed to rsync for a max duration (seconds) of an I/O op | +
| rsync_timeout = 900 | +Max duration (seconds) of a partition rsync | +
| run_pause = 30 | +Time in seconds to wait between replication passes | +
| stats_interval = 300 | +Interval in seconds between logging replication statistics | +
| sync_method = rsync | +No help text available for this option. | +
| vm_test_mode = no | +Indicates that you are using a VM environment | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| log_name = object-updater | Label used when logging | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| interval = 300 | Minimum time for a pass to take | -
| concurrency = 1 | Number of replication workers to spawn | -
| node_timeout = <whatever's in the DEFAULT section or 10> | Request timeout to external services | -
| slowdown = 0.01 | Time in seconds to wait between objects | -
| recon_cache_path = /var/cache/swift | Directory where stats for a few items will be stored | -
| concurrency = 1 | +Number of replication workers to spawn | +
| interval = 300 | +Minimum time for a pass to take | +
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_level = INFO | +Logging level | +
| log_name = object-updater | +Label used when logging | +
| node_timeout = <whatever's in the DEFAULT section or 10> | +Request timeout to external services | +
| recon_cache_path = /var/cache/swift | +Directory where stats for a few items will be stored | +
| slowdown = 0.01 | +Time in seconds to wait between objects | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| pipeline = healthcheck recon object-server | No help text available for this option. | -
| pipeline = healthcheck recon object-server | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| bind_ip = 0.0.0.0 | IP Address for server to bind to | -
| bind_port = 80 | Port for server to bind to | -
| bind_timeout = 30 | Seconds to attempt bind before giving up | -
| backlog = 4096 | Maximum number of allowed pending TCP connections | -
| swift_dir = /etc/swift | Swift configuration directory | -
| user = swift | User to run as | -
| expose_info = true | Enables exposing configuration settings via HTTP GET /info. | -
| admin_key = secret_admin_key | to use for admin calls that are HMAC signed. Default is empty, which will disable admin calls to /info. the proxy server. For most cases, this should be `egg:swift#proxy`. request whenever it has to failover to a handoff node | -
| disallowed_sections = container_quotas, tempurl | No help text available for this option. | -
| workers = auto | a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | -
| max_clients = 1024 | Maximum number of clients one worker can process simultaneously + |
| admin_key = secret_admin_key | +to use for admin calls that are HMAC signed. Default is empty, which will disable admin calls to /info. the proxy server. For most cases, this should be `egg:swift#proxy`. request whenever it has to failover to a handoff node | +
| backlog = 4096 | +Maximum number of allowed pending TCP connections | +
| bind_ip = 0.0.0.0 | +IP Address for server to bind to | +
| bind_port = 80 | +Port for server to bind to | +
| bind_timeout = 30 | +Seconds to attempt bind before giving up | +
| cert_file = /etc/swift/proxy.crt | +to the ssl .crt. This should be enabled for testing purposes only. | +
| client_timeout = 60 | +Timeout to read one chunk from a client external services | +
| cors_allow_origin = | +is a list of hosts that are included with any CORS request by default and returned with the Access-Control-Allow-Origin header in addition to what the container has set. to call to setup custom log handlers. for eventlet the proxy server. For most cases, this should be `egg:swift#proxy`. request whenever it has to failover to a handoff node | +
| disallowed_sections = container_quotas, tempurl, bulk_delete.max_failed_deletes | +No help text available for this option. | +
| eventlet_debug = false | +If true, turn on debug logging for eventlet | +
| expiring_objects_account_name = expiring_objects | +No help text available for this option. | +
| expiring_objects_container_divisor = 86400 | +No help text available for this option. | +
| expose_info = true | +Enables exposing configuration settings via HTTP GET /info. | +
| key_file = /etc/swift/proxy.key | +to the ssl .key. This should be enabled for testing purposes only. | +
| log_address = /dev/log | +Location where syslog sends the logs to | +
| log_custom_handlers = | +Comma-separated list of functions to call to setup custom log handlers. | +
| log_facility = LOG_LOCAL0 | +Syslog log facility | +
| log_headers = false | +No help text available for this option. | +
| log_level = INFO | +Logging level | +
| log_max_line_length = 0 | +Caps the length of log lines to the value given; no limit if set to 0, the default. | +
| log_name = swift | +Label used when logging | +
| log_statsd_default_sample_rate = 1.0 | +Defines the probability of sending a sample for any given event or + timing measurement. | +
| log_statsd_host = localhost | +If not set, the StatsD feature is disabled. | +
| log_statsd_metric_prefix = | +Value will be prepended to every metric sent to the StatsD server. | +
| log_statsd_port = 8125 | +Port value for the StatsD server. | +
| log_statsd_sample_rate_factor = 1.0 | +Not recommended to set this to a value less than 1.0, if frequency + of logging is too high, tune the + log_statsd_default_sample_rate instead. | +
| log_udp_host = | +If not set, the UDB receiver for syslog is disabled. | +
| log_udp_port = 514 | +Port value for UDB receiver, if enabled. | +
| max_clients = 1024 | +Maximum number of clients one worker can process simultaneously Lowering the number of clients handled per worker, and raising the number of workers can lessen the impact that a CPU intensive, or blocking, request can have on other requests served by the same @@ -53,73 +141,23 @@ worker. If the maximum number of clients is set to one, then a given worker will not perform another call while processing, allowing other workers a chance to process it. | -
| cert_file = /etc/swift/proxy.crt | to the ssl .crt. This should be enabled for testing purposes only. | -
| key_file = /etc/swift/proxy.key | to the ssl .key. This should be enabled for testing purposes only. | -
| expiring_objects_container_divisor = 86400 | No help text available for this option. | -
| expiring_objects_account_name = expiring_objects | No help text available for this option. | -
| log_name = swift | Label used when logging | -
| log_facility = LOG_LOCAL0 | Syslog log facility | -
| log_level = INFO | Logging level | -
| log_headers = false | No help text available for this option. | -
| log_address = /dev/log | Location where syslog sends the logs to | -
| trans_id_suffix = | No help text available for this option. | -
| log_custom_handlers = | Comma-separated list of functions to call to setup custom log handlers. | -
| log_udp_host = | If not set, the UDB receiver for syslog is disabled. | -
| log_udp_port = 514 | Port value for UDB receiver, if enabled. | -
| log_statsd_host = localhost | If not set, the StatsD feature is disabled. | -
| log_statsd_port = 8125 | Port value for the StatsD server. | -
| log_statsd_default_sample_rate = 1.0 | Defines the probability of sending a sample for any given event or - timing measurement. | -
| log_statsd_sample_rate_factor = 1.0 | Not recommended to set this to a value less than 1.0, if frequency - of logging is too high, tune the - log_statsd_default_sample_rate instead. | -
| log_statsd_metric_prefix = | Value will be prepended to every metric sent to the StatsD server. | -
| cors_allow_origin = | is a list of hosts that are included with any CORS request by default and returned with the Access-Control-Allow-Origin header in addition to what the container has set. to call to setup custom log handlers. for eventlet the proxy server. For most cases, this should be `egg:swift#proxy`. request whenever it has to failover to a handoff node | -
| client_timeout = 60 | Timeout to read one chunk from a client external services | -
| eventlet_debug = false | If true, turn on debug logging for eventlet | -
| swift_dir = /etc/swift | +Swift configuration directory | +
| trans_id_suffix = | +No help text available for this option. | +
| user = swift | +User to run as | +
| workers = auto | +a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#proxy | Entry point of paste.deploy in the server | -
| set log_name = proxy-server | Label to use when logging | -
| set log_facility = LOG_LOCAL0 | Syslog log facility | -
| set log_level = INFO | Log level | -
| set log_address = /dev/log | Location where syslog sends the logs to | -
| log_handoffs = true | No help text available for this option. | -
| recheck_account_existence = 60 | Cache timeout in seconds to send memcached for account existence | -
| recheck_container_existence = 60 | Cache timeout in seconds to send memcached for container existence | -
| object_chunk_size = 8192 | Chunk size to read from object servers | -
| client_chunk_size = 8192 | Chunk size to read from clients | -
| node_timeout = 10 | Request timeout to external services | -
| recoverable_node_timeout = node_timeout | Request timeout to external services for requests that, on failure, can be recovered from. For example, object GET. from a client external services | -
| conn_timeout = 0.5 | Connection timeout to external services | -
| post_quorum_timeout = 0.5 | No help text available for this option. | -
| error_suppression_interval = 60 | Time in seconds that must elapse since the last error for a node to be considered no longer error limited | -
| error_suppression_limit = 10 | Error count to consider a node error limited | -
| allow_account_management = false | Whether account PUTs and DELETEs are even callable | -
| object_post_as_copy = true | Set object_post_as_copy = false to turn on fast posts where only the metadata changes are stored anew and the original data file is kept in place. This makes for quicker posts; but since the container metadata isn't updated in this mode, features like container sync won't be able to sync posts. | -
| account_autocreate = false | If set to 'true' authorized accounts that do not yet exist within the Swift cluster will be automatically created. | -
| max_containers_per_account = 0 | If set to a positive value, trying to create a container when the account already has at least this maximum containers will result in a 403 Forbidden. Note: This is a soft limit, meaning a user might exceed the cap for recheck_account_existence before the 403s kick in. | -
| max_containers_whitelist = | is a comma separated list of account names that ignore the max_containers_per_account cap. | -
| deny_host_headers = | No help text available for this option. | -
| auto_create_account_prefix = . | Prefix to use when automatically creating accounts | -
| put_queue_depth = 10 | No help text available for this option. | -
| sorting_method = shuffle | No help text available for this option. | -
| timing_expiry = 300 | No help text available for this option. | -
| max_large_object_get_time = 86400 | No help text available for this option. | -
| request_node_count = 2 * replicas | * replicas Set to the number of nodes to contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. conf file for values will only be shown to the list of swift_owners. The exact default definition of a swift_owner is headers> up to the auth system in use, but usually indicates administrative responsibilities. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request | -
| read_affinity = r1z1=100, r1z2=200, r2=300 | No help text available for this option. | -
| read_affinity = | No help text available for this option. | -
| write_affinity = r1, r2 | No help text available for this option. | -
| write_affinity = | No help text available for this option. | -
| write_affinity_node_count = 2 * replicas | No help text available for this option. | -
| swift_owner_headers = x-container-read, x-container-write, x-container-sync-key, x-container-sync-to, x-account-meta-temp-url-key, x-account-meta-temp-url-key-2, x-account-access-control | the sample These are the headers whose conf file for values will only be shown to the list of swift_owners. The exact default definition of a swift_owner is headers> up to the auth system in use, but usually indicates administrative responsibilities. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request | -
| account_autocreate = false | +If set to 'true' authorized accounts that do not yet exist within the Swift cluster will be automatically created. | +
| allow_account_management = false | +Whether account PUTs and DELETEs are even callable | +
| auto_create_account_prefix = . | +Prefix to use when automatically creating accounts | +
| client_chunk_size = 8192 | +Chunk size to read from clients | +
| conn_timeout = 0.5 | +Connection timeout to external services | +
| deny_host_headers = | +No help text available for this option. | +
| error_suppression_interval = 60 | +Time in seconds that must elapse since the last error for a node to be considered no longer error limited | +
| error_suppression_limit = 10 | +Error count to consider a node error limited | +
| log_handoffs = true | +No help text available for this option. | +
| max_containers_per_account = 0 | +If set to a positive value, trying to create a container when the account already has at least this maximum containers will result in a 403 Forbidden. Note: This is a soft limit, meaning a user might exceed the cap for recheck_account_existence before the 403s kick in. | +
| max_containers_whitelist = | +is a comma separated list of account names that ignore the max_containers_per_account cap. | +
| max_large_object_get_time = 86400 | +No help text available for this option. | +
| node_timeout = 10 | +Request timeout to external services | +
| object_chunk_size = 8192 | +Chunk size to read from object servers | +
| object_post_as_copy = true | +Set object_post_as_copy = false to turn on fast posts where only the metadata changes are stored anew and the original data file is kept in place. This makes for quicker posts; but since the container metadata isn't updated in this mode, features like container sync won't be able to sync posts. | +
| post_quorum_timeout = 0.5 | +No help text available for this option. | +
| put_queue_depth = 10 | +No help text available for this option. | +
| read_affinity = r1z1=100, r1z2=200, r2=300 | +No help text available for this option. | +
| recheck_account_existence = 60 | +Cache timeout in seconds to send memcached for account existence | +
| recheck_container_existence = 60 | +Cache timeout in seconds to send memcached for container existence | +
| recoverable_node_timeout = node_timeout | +Request timeout to external services for requests that, on failure, can be recovered from. For example, object GET. from a client external services | +
| request_node_count = 2 * replicas | +* replicas Set to the number of nodes to contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. conf file for values will only be shown to the list of swift_owners. The exact default definition of a swift_owner is headers> up to the auth system in use, but usually indicates administrative responsibilities. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request | +
| set log_address = /dev/log | +Location where syslog sends the logs to | +
| set log_facility = LOG_LOCAL0 | +Syslog log facility | +
| set log_level = INFO | +Log level | +
| set log_name = proxy-server | +Label to use when logging | +
| sorting_method = shuffle | +No help text available for this option. | +
| swift_owner_headers = x-container-read, x-container-write, x-container-sync-key, x-container-sync-to, x-account-meta-temp-url-key, x-account-meta-temp-url-key-2, x-account-access-control | +the sample These are the headers whose conf file for values will only be shown to the list of swift_owners. The exact default definition of a swift_owner is headers> up to the auth system in use, but usually indicates administrative responsibilities. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request | +
| timing_expiry = 300 | +No help text available for this option. | +
| use = egg:swift#proxy | +Entry point of paste.deploy in the server | +
| write_affinity = r1, r2 | +No help text available for this option. | +
| write_affinity_node_count = 2 * replicas | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#account_quotas | Entry point of paste.deploy in the server | -
| use = egg:swift#account_quotas | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| auth_host = keystonehost | No help text available for this option. | -
| auth_port = 35357 | No help text available for this option. | -
| auth_protocol = http | No help text available for this option. | -
| auth_uri = http://keystonehost:5000/ | No help text available for this option. | -
| admin_tenant_name = service | No help text available for this option. | -
| admin_user = swift | No help text available for this option. | -
| admin_password = password | No help text available for this option. | -
| delay_auth_decision = 1 | No help text available for this option. | -
| cache = swift.cache | No help text available for this option. | -
| include_service_catalog = False | No help text available for this option. | -
| admin_password = password | +No help text available for this option. | +
| admin_tenant_name = service | +No help text available for this option. | +
| admin_user = swift | +No help text available for this option. | +
| auth_host = keystonehost | +No help text available for this option. | +
| auth_port = 35357 | +No help text available for this option. | +
| auth_protocol = http | +No help text available for this option. | +
| auth_uri = http://keystonehost:5000/ | +No help text available for this option. | +
| cache = swift.cache | +No help text available for this option. | +
| delay_auth_decision = 1 | +No help text available for this option. | +
| include_service_catalog = False | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#bulk | Entry point of paste.deploy in the server | -
| max_containers_per_extraction = 10000 | No help text available for this option. | -
| max_failed_extractions = 1000 | No help text available for this option. | -
| max_deletes_per_request = 10000 | No help text available for this option. | -
| max_failed_deletes = 1000 | No help text available for this option. | -
| yield_frequency = 10 | No help text available for this option. | -
| delete_container_retry_count = 0 | No help text available for this option. | -
| delete_container_retry_count = 0 | +No help text available for this option. | +
| max_containers_per_extraction = 10000 | +No help text available for this option. | +
| max_deletes_per_request = 10000 | +No help text available for this option. | +
| max_failed_deletes = 1000 | +No help text available for this option. | +
| max_failed_extractions = 1000 | +No help text available for this option. | +
| use = egg:swift#bulk | +Entry point of paste.deploy in the server | +
| yield_frequency = 10 | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#memcache | Entry point of paste.deploy in the server | -
| set log_name = cache | Label to use when logging | -
| set log_facility = LOG_LOCAL0 | Syslog log facility | -
| set log_level = INFO | Log level | -
| set log_headers = false | If True, log headers in each request | -
| set log_address = /dev/log | Location where syslog sends the logs to | -
| memcache_servers = 127.0.0.1:11211 | Comma separated list of memcached servers ip:port services | -
| memcache_serialization_support = 2 | No help text available for this option. | -
| memcache_max_connections = 2 | Max number of connections to each memcached server per worker services | -
| memcache_max_connections = 2 | +Max number of connections to each memcached server per worker services | +
| memcache_serialization_support = 2 | +No help text available for this option. | +
| memcache_servers = 127.0.0.1:11211 | +Comma separated list of memcached servers ip:port services | +
| set log_address = /dev/log | +Location where syslog sends the logs to | +
| set log_facility = LOG_LOCAL0 | +Syslog log facility | +
| set log_headers = false | +If True, log headers in each request | +
| set log_level = INFO | +Log level | +
| set log_name = cache | +Label to use when logging | +
| use = egg:swift#memcache | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#catch_errors | Entry point of paste.deploy in the server | -
| set log_name = catch_errors | Label to use when logging | -
| set log_facility = LOG_LOCAL0 | Syslog log facility | -
| set log_level = INFO | Log level | -
| set log_headers = false | If True, log headers in each request | -
| set log_address = /dev/log | Location where syslog sends the logs to | -
| set log_address = /dev/log | +Location where syslog sends the logs to | +
| set log_facility = LOG_LOCAL0 | +Syslog log facility | +
| set log_headers = false | +If True, log headers in each request | +
| set log_level = INFO | +Log level | +
| set log_name = catch_errors | +Label to use when logging | +
| use = egg:swift#catch_errors | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#cname_lookup | Entry point of paste.deploy in the server | -
| set log_name = cname_lookup | Label to use when logging | -
| set log_facility = LOG_LOCAL0 | Syslog log facility | -
| set log_level = INFO | Log level | -
| set log_headers = false | If True, log headers in each request | -
| set log_address = /dev/log | Location where syslog sends the logs to | -
| storage_domain = example.com | Domain that matches your cloud. Multiple domains can be specified using a comma-separated + |
| lookup_depth = 1 | +Because CNAMES can be recursive, specifies the number of levels through which to search. | +
| set log_address = /dev/log | +Location where syslog sends the logs to | +
| set log_facility = LOG_LOCAL0 | +Syslog log facility | +
| set log_headers = false | +If True, log headers in each request | +
| set log_level = INFO | +Log level | +
| set log_name = cname_lookup | +Label to use when logging | +
| storage_domain = example.com | +Domain that matches your cloud. Multiple domains can be specified using a comma-separated list. | -
| lookup_depth = 1 | Because CNAMES can be recursive, specifies the number of levels through which to search. | -
| use = egg:swift#cname_lookup | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#container_quotas | Entry point of paste.deploy in the server | -
| use = egg:swift#container_quotas | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#container_sync | Entry point of paste.deploy in the server | -
| allow_full_urls = true | No help text available for this option. | -
| allow_full_urls = true | +No help text available for this option. | +
| current = //REALM/CLUSTER | +No help text available for this option. | +
| use = egg:swift#container_sync | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#dlo | Entry point of paste.deploy in the server | -
| rate_limit_after_segment = 10 | Rate limit the download of large object segments after this segment is downloaded. | -
| rate_limit_segments_per_sec = 1 | Rate limit large object downloads at this rate. contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request | -
| max_get_time = 86400 | No help text available for this option. | -
| max_get_time = 86400 | +No help text available for this option. | +
| rate_limit_after_segment = 10 | +Rate limit the download of large object segments after this segment is downloaded. | +
| rate_limit_segments_per_sec = 1 | +Rate limit large object downloads at this rate. contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request | +
| use = egg:swift#dlo | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#domain_remap | Entry point of paste.deploy in the server | -
| set log_name = domain_remap | Label to use when logging | -
| set log_facility = LOG_LOCAL0 | Syslog log facility | -
| set log_level = INFO | Log level | -
| set log_headers = false | If True, log headers in each request | -
| set log_address = /dev/log | Location where syslog sends the logs to | -
| storage_domain = example.com | Domain that matches your cloud. Multiple domains can be specified using a comma-separated + |
| path_root = v1 | +Root path | +
| reseller_prefixes = AUTH | +Reseller prefix | +
| set log_address = /dev/log | +Location where syslog sends the logs to | +
| set log_facility = LOG_LOCAL0 | +Syslog log facility | +
| set log_headers = false | +If True, log headers in each request | +
| set log_level = INFO | +Log level | +
| set log_name = domain_remap | +Label to use when logging | +
| storage_domain = example.com | +Domain that matches your cloud. Multiple domains can be specified using a comma-separated list. | -
| path_root = v1 | Root path | -
| reseller_prefixes = AUTH | Reseller prefix | -
| use = egg:swift#domain_remap | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#formpost | Entry point of paste.deploy in the server | -
| use = egg:swift#formpost | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#gatekeeper | Entry point of paste.deploy in the server | -
| set log_name = gatekeeper | Label to use when logging | -
| set log_facility = LOG_LOCAL0 | Syslog log facility | -
| set log_level = INFO | Log level | -
| set log_headers = false | If True, log headers in each request | -
| set log_address = /dev/log | Location where syslog sends the logs to | -
| set log_address = /dev/log | +Location where syslog sends the logs to | +
| set log_facility = LOG_LOCAL0 | +Syslog log facility | +
| set log_headers = false | +If True, log headers in each request | +
| set log_level = INFO | +Log level | +
| set log_name = gatekeeper | +Label to use when logging | +
| use = egg:swift#gatekeeper | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#healthcheck | Entry point of paste.deploy in the server | -
| disable_path = | No help text available for this option. | -
| disable_path = | +No help text available for this option. | +
| use = egg:swift#healthcheck | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#keystoneauth | Entry point of paste.deploy in the server | -
| operator_roles = admin, swiftoperator | No help text available for this option. | -
| reseller_admin_role = ResellerAdmin | No help text available for this option. | -
| operator_roles = admin, swiftoperator | +No help text available for this option. | +
| reseller_admin_role = ResellerAdmin | +No help text available for this option. | +
| use = egg:swift#keystoneauth | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#list_endpoints | Entry point of paste.deploy in the server | -
| list_endpoints_path = /endpoints/ | No help text available for this option. | -
| list_endpoints_path = /endpoints/ | +No help text available for this option. | +
| use = egg:swift#list_endpoints | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#name_check | Entry point of paste.deploy in the server | -
| forbidden_chars = '"`<> | Characters that are not allowed in a name | -
| maximum_length = 255 | Maximum length of a name | -
| forbidden_regexp = /\./|/\.\./|/\.$|/\.\.$ | Substrings to forbid, using regular expression syntax | -
| forbidden_chars = '"`<> | +Characters that are not allowed in a name | +
| forbidden_regexp = /\./|/\.\./|/\.$|/\.\.$ | +Substrings to forbid, using regular expression syntax | +
| maximum_length = 255 | +Maximum length of a name | +
| use = egg:swift#name_check | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#proxy_logging | Entry point of paste.deploy in the server | -
| access_log_name = swift | No help text available for this option. | -
| access_log_facility = LOG_LOCAL0 | No help text available for this option. | -
| access_log_level = INFO | No help text available for this option. | -
| access_log_address = /dev/log | No help text available for this option. | -
| access_log_udp_host = | No help text available for this option. | -
| access_log_udp_port = 514 | No help text available for this option. | -
| access_log_statsd_host = localhost | No help text available for this option. | -
| access_log_statsd_port = 8125 | No help text available for this option. | -
| access_log_statsd_default_sample_rate = 1.0 | No help text available for this option. | -
| access_log_statsd_sample_rate_factor = 1.0 | No help text available for this option. | -
| access_log_statsd_metric_prefix = | No help text available for this option. | -
| access_log_headers = false | No help text available for this option. | -
| access_log_headers_only = | If access_log_headers is True and access_log_headers_only is set only + |
| access_log_address = /dev/log | +No help text available for this option. | +
| access_log_facility = LOG_LOCAL0 | +No help text available for this option. | +
| access_log_headers = false | +No help text available for this option. | +
| access_log_headers_only = | +If access_log_headers is True and access_log_headers_only is set only these headers are logged. Multiple headers can be defined as comma separated list like this: access_log_headers_only = Host, X-Object-Meta-Mtime | -
| logged with access_log_headers = True. | No help text available for this option. | -
| reveal_sensitive_prefix = 8192 | + |
| access_log_level = INFO | +No help text available for this option. | +
| access_log_name = swift | +No help text available for this option. | +
| access_log_statsd_default_sample_rate = 1.0 | +No help text available for this option. | +
| access_log_statsd_host = localhost | +No help text available for this option. | +
| access_log_statsd_metric_prefix = | +No help text available for this option. | +
| access_log_statsd_port = 8125 | +No help text available for this option. | +
| access_log_statsd_sample_rate_factor = 1.0 | +No help text available for this option. | +
| access_log_udp_host = | +No help text available for this option. | +
| access_log_udp_port = 514 | +No help text available for this option. | +
| log_statsd_valid_http_methods = GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS | +No help text available for this option. | +
| logged with access_log_headers = True. | +No help text available for this option. | +
| reveal_sensitive_prefix = 16 | +The X-Auth-Token is sensitive data. If revealed to an unauthorised person, they can now make requests against an account until the token expires. Set reveal_sensitive_prefix to the number of characters of the token that are logged. For example reveal_sensitive_prefix = 12 so only first 12 characters of the token are logged. Or, set to 0 to completely remove the token. | -
| log_statsd_valid_http_methods = GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS | No help text available for this option. | -
| use = egg:swift#proxy_logging | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#ratelimit | Entry point of paste.deploy in the server | -
| set log_name = ratelimit | Label to use when logging | -
| set log_facility = LOG_LOCAL0 | Syslog log facility | -
| set log_level = INFO | Log level | -
| set log_headers = false | If True, log headers in each request | -
| set log_address = /dev/log | Location where syslog sends the logs to | -
| clock_accuracy = 1000 | Represents how accurate the proxy servers' system clocks are with each other. 1000 means that all the proxies' clock are accurate to each other within 1 millisecond. No ratelimit should be higher than the clock accuracy. | -
| max_sleep_time_seconds = 60 | App will immediately return a 498 response if the necessary sleep time ever exceeds the given max_sleep_time_seconds. | -
| log_sleep_time_seconds = 0 | To allow visibility into rate limiting set this value > 0 and all sleeps greater than the number will be logged. | -
| rate_buffer_seconds = 5 | Number of seconds the rate counter can drop and be allowed to catch up (at a faster than listed rate). A larger number will result in larger spikes in rate but better average accuracy. | -
| account_ratelimit = 0 | If set, will limit PUT and DELETE requests to /account_name/container_name. Number is in requests per second. | -
| account_whitelist = a,b | Comma separated lists of account names that will not be rate limited. | -
| account_blacklist = c,d | Comma separated lists of account names that will not be allowed. Returns a 497 response. r: for containers of size x, limit requests per second to r. Will limit PUT, DELETE, and POST requests to /a/c/o. container_listing_ratelimit_x = r: for containers of size x, limit listing requests per second to r. Will limit GET requests to /a/c. | -
| with container_limit_x = r | No help text available for this option. | -
| container_ratelimit_0 = 100 | No help text available for this option. | -
| container_ratelimit_10 = 50 | No help text available for this option. | -
| container_ratelimit_50 = 20 | No help text available for this option. | -
| container_listing_ratelimit_0 = 100 | No help text available for this option. | -
| container_listing_ratelimit_10 = 50 | No help text available for this option. | -
| container_listing_ratelimit_50 = 20 | No help text available for this option. | -
| account_blacklist = c,d | +Comma separated lists of account names that will not be allowed. Returns a 497 response. r: for containers of size x, limit requests per second to r. Will limit PUT, DELETE, and POST requests to /a/c/o. container_listing_ratelimit_x = r: for containers of size x, limit listing requests per second to r. Will limit GET requests to /a/c. | +
| account_ratelimit = 0 | +If set, will limit PUT and DELETE requests to /account_name/container_name. Number is in requests per second. | +
| account_whitelist = a,b | +Comma separated lists of account names that will not be rate limited. | +
| clock_accuracy = 1000 | +Represents how accurate the proxy servers' system clocks are with each other. 1000 means that all the proxies' clock are accurate to each other within 1 millisecond. No ratelimit should be higher than the clock accuracy. | +
| container_listing_ratelimit_0 = 100 | +No help text available for this option. | +
| container_listing_ratelimit_10 = 50 | +No help text available for this option. | +
| container_listing_ratelimit_50 = 20 | +No help text available for this option. | +
| container_ratelimit_0 = 100 | +No help text available for this option. | +
| container_ratelimit_10 = 50 | +No help text available for this option. | +
| container_ratelimit_50 = 20 | +No help text available for this option. | +
| log_sleep_time_seconds = 0 | +To allow visibility into rate limiting set this value > 0 and all sleeps greater than the number will be logged. | +
| max_sleep_time_seconds = 60 | +App will immediately return a 498 response if the necessary sleep time ever exceeds the given max_sleep_time_seconds. | +
| rate_buffer_seconds = 5 | +Number of seconds the rate counter can drop and be allowed to catch up (at a faster than listed rate). A larger number will result in larger spikes in rate but better average accuracy. | +
| set log_address = /dev/log | +Location where syslog sends the logs to | +
| set log_facility = LOG_LOCAL0 | +Syslog log facility | +
| set log_headers = false | +If True, log headers in each request | +
| set log_level = INFO | +Log level | +
| set log_name = ratelimit | +Label to use when logging | +
| use = egg:swift#ratelimit | +Entry point of paste.deploy in the server | +
| with container_limit_x = r | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#slo | Entry point of paste.deploy in the server | -
| max_manifest_segments = 1000 | No help text available for this option. | -
| max_manifest_size = 2097152 | No help text available for this option. | -
| min_segment_size = 1048576 | No help text available for this option. | -
| rate_limit_after_segment = 10 | Rate limit the download of large object segments after this segment is downloaded. | -
| rate_limit_segments_per_sec = 0 | Rate limit large object downloads at this rate. contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request | -
| max_get_time = 86400 | No help text available for this option. | -
| max_get_time = 86400 | +No help text available for this option. | +
| max_manifest_segments = 1000 | +No help text available for this option. | +
| max_manifest_size = 2097152 | +No help text available for this option. | +
| min_segment_size = 1048576 | +No help text available for this option. | +
| rate_limit_after_segment = 10 | +Rate limit the download of large object segments after this segment is downloaded. | +
| rate_limit_segments_per_sec = 0 | +Rate limit large object downloads at this rate. contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request | +
| use = egg:swift#slo | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#staticweb | Entry point of paste.deploy in the server | -
| use = egg:swift#staticweb | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#tempauth | Entry point of paste.deploy in the server | -
| set log_name = tempauth | Label to use when logging | -
| set log_facility = LOG_LOCAL0 | Syslog log facility | -
| set log_level = INFO | Log level | -
| set log_headers = false | If True, log headers in each request | -
| set log_address = /dev/log | Location where syslog sends the logs to | -
| reseller_prefix = AUTH | The naming scope for the auth service. Swift | -
| auth_prefix = /auth/ | The HTTP request path prefix for the auth service. Swift itself reserves anything beginning with the letter `v`. | -
| token_life = 86400 | The number of seconds a token is valid. | -
| allow_overrides = true | No help text available for this option. | -
| storage_url_scheme = default | Scheme to return with storage urls: http, https, or default (chooses based on what the server is running as) This can be useful with an SSL load balancer in front of a non-SSL server. | -
| user_admin_admin = admin .admin .reseller_admin | No help text available for this option. | -
| user_test_tester = testing .admin | No help text available for this option. | -
| user_test2_tester2 = testing2 .admin | No help text available for this option. | -
| user_test_tester3 = testing3 | No help text available for this option. | -
| allow_overrides = true | +No help text available for this option. | +
| auth_prefix = /auth/ | +The HTTP request path prefix for the auth service. Swift itself reserves anything beginning with the letter `v`. | +
| reseller_prefix = AUTH | +The naming scope for the auth service. Swift | +
| set log_address = /dev/log | +Location where syslog sends the logs to | +
| set log_facility = LOG_LOCAL0 | +Syslog log facility | +
| set log_headers = false | +If True, log headers in each request | +
| set log_level = INFO | +Log level | +
| set log_name = tempauth | +Label to use when logging | +
| storage_url_scheme = default | +Scheme to return with storage urls: http, https, or default (chooses based on what the server is running as) This can be useful with an SSL load balancer in front of a non-SSL server. | +
| token_life = 86400 | +The number of seconds a token is valid. | +
| use = egg:swift#tempauth | +Entry point of paste.deploy in the server | +
| user_admin_admin = admin .admin .reseller_admin | +No help text available for this option. | +
| user_test2_tester2 = testing2 .admin | +No help text available for this option. | +
| user_test_tester = testing .admin | +No help text available for this option. | +
| user_test_tester3 = testing3 | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| use = egg:swift#tempurl | Entry point of paste.deploy in the server | -
| methods = GET HEAD PUT | HTTP methods allowed with Temporary URLs | -
| incoming_remove_headers = x-timestamp | Headers to remove from incoming requests. Simply a whitespace delimited list of header names and - names can optionally end with '*' to indicate a prefix match. | -
| incoming_allow_headers = | Headers allowed as exceptions to incoming_remove_headers. Simply a whitespace + |
| incoming_allow_headers = | +Headers allowed as exceptions to incoming_remove_headers. Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match. | -
| outgoing_remove_headers = x-object-meta-* | Headers to remove from outgoing responses. Simply a whitespace delimited list of + |
| incoming_remove_headers = x-timestamp | +Headers to remove from incoming requests. Simply a whitespace delimited list of header names and + names can optionally end with '*' to indicate a prefix match. | +
| methods = GET HEAD PUT | +HTTP methods allowed with Temporary URLs | +
| outgoing_allow_headers = x-object-meta-public-* | +Headers allowed as exceptions to outgoing_allow_headers. Simply a whitespace delimited list of + header names and names can optionally end with '*' to indicate a prefix match. | +
| outgoing_remove_headers = x-object-meta-* | +Headers to remove from outgoing responses. Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match. | -
| outgoing_allow_headers = x-object-meta-public-* | Headers allowed as exceptions to outgoing_allow_headers. Simply a whitespace delimited list of - header names and names can optionally end with '*' to indicate a prefix match. | -
| use = egg:swift#tempurl | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | +Description | +
|---|---|
| dump_interval = 5.0 | +No help text available for this option. | +
| dump_timestamp = false | +No help text available for this option. | +
| flush_at_shutdown = false | +No help text available for this option. | +
| log_filename_prefix = /tmp/log/swift/profile/default.profile | +No help text available for this option. | +
| path = /__profile__ | +No help text available for this option. | +
| profile_module = eventlet.green.profile | +No help text available for this option. | +
| unwind = false | +No help text available for this option. | +
| use = egg:swift#xprofile | +Entry point of paste.deploy in the server | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| pipeline = catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk tempurl slo dlo ratelimit tempauth container-quotas account-quotas proxy-logging proxy-server | No help text available for this option. | -
| pipeline = catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk tempurl ratelimit tempauth container-quotas account-quotas slo dlo proxy-logging proxy-server | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| max connections = 2 | No help text available for this option. | -
| path = /srv/node | No help text available for this option. | -
| read only = false | No help text available for this option. | -
| lock file = /var/lock/account.lock | No help text available for this option. | -
| lock file = /var/lock/account.lock | +No help text available for this option. | +
| max connections = 2 | +No help text available for this option. | +
| path = /srv/node | +No help text available for this option. | +
| read only = false | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| max connections = 4 | No help text available for this option. | -
| path = /srv/node | No help text available for this option. | -
| read only = false | No help text available for this option. | -
| lock file = /var/lock/container.lock | No help text available for this option. | -
| lock file = /var/lock/container.lock | +No help text available for this option. | +
| max connections = 4 | +No help text available for this option. | +
| path = /srv/node | +No help text available for this option. | +
| read only = false | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| max connections = 8 | No help text available for this option. | -
| path = /srv/node | No help text available for this option. | -
| read only = false | No help text available for this option. | -
| lock file = /var/lock/object.lock | No help text available for this option. | -
| lock file = /var/lock/object.lock | +No help text available for this option. | +
| max connections = 8 | +No help text available for this option. | +
| path = /srv/node | +No help text available for this option. | +
| read only = false | +No help text available for this option. | +
| Configuration option = Default value | +Description | +
|---|---|
| default = yes | +0 means to not use a per-disk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk. | +
| name = Policy-0 | +No help text available for this option. | +
| Configuration option = Default value | +Description | +
|---|---|
| name = silver | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| max_file_size = 5368709122 | The largest normal object that can be - saved in the cluster. This is also the - limit on the size of each segment of a - large object when using the large object - manifest support. This value is set in - bytes. Setting it to lower than 1MiB will - cause some tests to fail. It is STRONGLY - recommended to leave this value at the - default (5 * 2**30 + 2). | -
| max_meta_name_length = 128 | The maximum number of bytes in the utf8 - encoding of the name portion of a metadata - header. | -
| max_meta_value_length = 256 | The max number of bytes in the utf8 - encoding of a metadata value. | -
| max_meta_count = 90 | The maximum number of metadata keys that can - be stored on a single account, container, - or object. | -
| max_meta_overall_size = 4096 | The maximum number of bytes in the utf8 - encoding of the metadata (keys + - values). | -
| max_header_size = 8192 | The maximum number of bytes in the utf8 - encoding of each header. | -
| max_object_name_length = 1024 | The maximum number of bytes in the utf8 - encoding of an object name. | -
| container_listing_limit = 10000 | The default (and maximum) number of items - returned for a container listing - request. | -
| account_listing_limit = 10000 | The default (and maximum) number of items - returned for an account listing request. | -
| max_account_name_length = 256 | The maximum number of bytes in the utf8 - encoding of an account name. | -
| max_container_name_length = 256 | The maximum number of bytes in the utf8 - encoding of a container name. | -
| account_listing_limit = 10000 | +No help text available for this option. | +
| container_listing_limit = 10000 | +No help text available for this option. | +
| max_account_name_length = 256 | +No help text available for this option. | +
| max_container_name_length = 256 | +No help text available for this option. | +
| max_file_size = 5368709122 | +No help text available for this option. | +
| max_header_size = 8192 | +No help text available for this option. | +
| max_meta_count = 90 | +No help text available for this option. | +
| max_meta_name_length = 128 | +No help text available for this option. | +
| max_meta_overall_size = 4096 | +No help text available for this option. | +
| max_meta_value_length = 256 | +No help text available for this option. | +
| max_object_name_length = 1024 | +No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| Configuration option = Default value | +Description | +
| swift_hash_path_suffix = changeme | - A suffix used by hash_path to offer a bit more security when generating hashes for - paths. It simply appends this value to all paths; if someone knows this suffix, - it's easier for them to guess the hash a path will end up with. - New installations are advised to set this parameter to a random secret, - which would not be disclosed ouside the organization. - The same secret needs to be used by all swift servers of the same cluster. - - Existing installations should set this parameter to an empty string. | -
| swift_hash_path_prefix = changeme | + |
| swift_hash_path_prefix = changeme | +A prefix used by hash_path to offer a bit more security when generating hashes for paths. It simply appends this value to all paths; if someone knows this suffix, it's easier for them to guess the hash a path will end up with. @@ -35,7 +27,19 @@ The same secret needs to be used by all swift servers of the same cluster. Existing installations should set this parameter to an empty string. | -
| swift_hash_path_suffix = changeme | ++ A suffix used by hash_path to offer a bit more security when generating hashes for + paths. It simply appends this value to all paths; if someone knows this suffix, + it's easier for them to guess the hash a path will end up with. + New installations are advised to set this parameter to a random secret, + which would not be disclosed ouside the organization. + The same secret needs to be used by all swift servers of the same cluster. + + Existing installations should set this parameter to an empty string. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| amqp_auto_delete = False | -(BoolOpt) Auto-delete queues in amqp. | -
| amqp_durable_queues = False | -(BoolOpt) Use durable queues in amqp. | -
| conductor_queue = trove-conductor | -(StrOpt) No help text available for this option. | -
| control_exchange = openstack | -(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid | -
| fake_rabbit = False | -(BoolOpt) If passed, use a fake RabbitMQ provider | -
| kombu_ssl_ca_certs = | -(StrOpt) SSL certification authority file (valid only if SSL enabled) | -
| kombu_ssl_certfile = | -(StrOpt) SSL cert file (valid only if SSL enabled) | -
| kombu_ssl_keyfile = | -(StrOpt) SSL key file (valid only if SSL enabled) | -
| kombu_ssl_version = | -(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions | -
| notification_driver = [] | -(MultiStrOpt) Driver or drivers to handle sending notifications | -
| notification_service_id = {'couchbase': 'fa62fe68-74d9-4779-a24e-36f19602c415', 'mongodb': 'c8c907af-7375-456f-b929-b637ff9209ee', 'cassandra': '459a230d-4e97-4344-9067-2a54a310b0ed', 'redis': 'b216ffc5-1947-456c-a4cf-70f94c05f7d0', 'mysql': '2f3ff068-2bfb-4f70-9a9d-a6bb65bc084b'} | -(DictOpt) Unique ID to tag notification events. | -
| notification_topics = notifications | -(ListOpt) AMQP topic used for openstack notifications | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| amqp_auto_delete = False | +(BoolOpt) Auto-delete queues in amqp. | +
| amqp_durable_queues = False | +(BoolOpt) Use durable queues in amqp. | +
| conductor_queue = trove-conductor | +(StrOpt) No help text available for this option. | +
| control_exchange = openstack | +(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid | +
| fake_rabbit = False | +(BoolOpt) If passed, use a fake RabbitMQ provider | +
| kombu_ssl_ca_certs = | +(StrOpt) SSL certification authority file (valid only if SSL enabled) | +
| kombu_ssl_certfile = | +(StrOpt) SSL cert file (valid only if SSL enabled) | +
| kombu_ssl_keyfile = | +(StrOpt) SSL key file (valid only if SSL enabled) | +
| kombu_ssl_version = | +(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions | +
| notification_driver = [] | +(MultiStrOpt) Driver or drivers to handle sending notifications | +
| notification_service_id = {'couchbase': 'fa62fe68-74d9-4779-a24e-36f19602c415', 'mongodb': 'c8c907af-7375-456f-b929-b637ff9209ee', 'cassandra': '459a230d-4e97-4344-9067-2a54a310b0ed', 'redis': 'b216ffc5-1947-456c-a4cf-70f94c05f7d0', 'mysql': '2f3ff068-2bfb-4f70-9a9d-a6bb65bc084b'} | +(DictOpt) Unique ID to tag notification events. | +
| notification_topics = notifications | +(ListOpt) AMQP topic used for openstack notifications | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| admin_roles = admin | -(ListOpt) No help text available for this option. | -
| api_extensions_path = trove/extensions/routes | -(StrOpt) Path to extensions. | -
| api_paste_config = api-paste.ini | -(StrOpt) File name for the paste.deploy config for trove-api. | -
| bind_port = 8779 | -(IntOpt) No help text available for this option. | -
| db_api_implementation = trove.db.sqlalchemy.api | -(StrOpt) No help text available for this option. | -
| hostname_require_ipv4 = True | -(BoolOpt) Require user hostnames to be IPv4 addresses. | -
| http_delete_rate = 200 | -(IntOpt) No help text available for this option. | -
| http_get_rate = 200 | -(IntOpt) No help text available for this option. | -
| http_post_rate = 200 | -(IntOpt) No help text available for this option. | -
| http_put_rate = 200 | -(IntOpt) No help text available for this option. | -
| instances_page_size = 20 | -(IntOpt) No help text available for this option. | -
| max_header_line = 16384 | -(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs | -
| region = LOCAL_DEV | -(StrOpt) The region this service is located. | -
| tcp_keepidle = 600 | -(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. | -
| trove_api_workers = None | -(IntOpt) No help text available for this option. | -
| trove_auth_url = http://0.0.0.0:5000/v2.0 | -(StrOpt) No help text available for this option. | -
| trove_conductor_workers = 1 | -(IntOpt) No help text available for this option. | -
| trove_security_group_name_prefix = SecGroup | -(StrOpt) No help text available for this option. | -
| trove_security_group_rule_cidr = 0.0.0.0/0 | -(StrOpt) No help text available for this option. | -
| trove_security_groups_support = True | -(BoolOpt) No help text available for this option. | -
| users_page_size = 20 | -(IntOpt) No help text available for this option. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| admin_roles = admin | +(ListOpt) No help text available for this option. | +
| api_extensions_path = $pybasedir/extensions/routes | +(StrOpt) Path to extensions. | +
| api_paste_config = api-paste.ini | +(StrOpt) File name for the paste.deploy config for trove-api. | +
| bind_port = 8779 | +(IntOpt) No help text available for this option. | +
| db_api_implementation = trove.db.sqlalchemy.api | +(StrOpt) No help text available for this option. | +
| hostname_require_ipv4 = True | +(BoolOpt) Require user hostnames to be IPv4 addresses. | +
| http_delete_rate = 200 | +(IntOpt) No help text available for this option. | +
| http_get_rate = 200 | +(IntOpt) No help text available for this option. | +
| http_mgmt_post_rate = 200 | +(IntOpt) No help text available for this option. | +
| http_post_rate = 200 | +(IntOpt) No help text available for this option. | +
| http_put_rate = 200 | +(IntOpt) No help text available for this option. | +
| instances_page_size = 20 | +(IntOpt) No help text available for this option. | +
| max_header_line = 16384 | +(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). | +
| os_region_name = None | +(StrOpt) Region name of this node. Used when searching catalog. | +
| region = LOCAL_DEV | +(StrOpt) The region this service is located. | +
| tcp_keepidle = 600 | +(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. | +
| trove_api_workers = None | +(IntOpt) No help text available for this option. | +
| trove_auth_url = http://0.0.0.0:5000/v2.0 | +(StrOpt) No help text available for this option. | +
| trove_conductor_workers = 1 | +(IntOpt) No help text available for this option. | +
| trove_security_group_name_prefix = SecGroup | +(StrOpt) No help text available for this option. | +
| trove_security_group_rule_cidr = 0.0.0.0/0 | +(StrOpt) No help text available for this option. | +
| trove_security_groups_support = True | +(BoolOpt) No help text available for this option. | +
| users_page_size = 20 | +(IntOpt) No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| memcached_servers = None | -(ListOpt) Memcached servers or None for in process cache. | -
| [keystone_authtoken] | -|
| admin_password = None | -(StrOpt) Keystone account password | -
| admin_tenant_name = admin | -(StrOpt) Keystone service account tenant name to validate user tokens | -
| admin_token = None | -(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. | -
| admin_user = None | -(StrOpt) Keystone account username | -
| auth_admin_prefix = | -(StrOpt) Prefix to prepend at the beginning of the path | -
| auth_host = 127.0.0.1 | -(StrOpt) Host providing the admin Identity API endpoint | -
| auth_port = 35357 | -(IntOpt) Port of the admin Identity API endpoint | -
| auth_protocol = https | -(StrOpt) Protocol of the admin Identity API endpoint(http or https) | -
| auth_uri = None | -(StrOpt) Complete public Identity API endpoint | -
| auth_version = None | -(StrOpt) API version of the admin Identity API endpoint | -
| cache = None | -(StrOpt) Env key for the swift cache | -
| cafile = None | -(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | -
| certfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| delay_auth_decision = False | -(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | -
| enforce_token_bind = permissive | -(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | -
| http_connect_timeout = None | -(BoolOpt) Request timeout value for communicating with Identity API server. | -
| http_request_max_retries = 3 | -(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | -
| include_service_catalog = True | -(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | -
| insecure = False | -(BoolOpt) Verify HTTPS connections. | -
| keyfile = None | -(StrOpt) Required if Keystone server requires client certificate | -
| memcache_secret_key = None | -(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | -
| memcache_security_strategy = None | -(StrOpt) (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. | -
| memcached_servers = None | -(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | -
| revocation_cache_time = 300 | -(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | -
| signing_dir = None | -(StrOpt) Directory used to cache files related to PKI tokens | -
| token_cache_time = 300 | -(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| memcached_servers = None | +(ListOpt) Memcached servers or None for in process cache. | +
| [keystone_authtoken] | +|
| admin_password = None | +(StrOpt) Keystone account password | +
| admin_tenant_name = admin | +(StrOpt) Keystone service account tenant name to validate user tokens | +
| admin_token = None | +(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | +
| admin_user = None | +(StrOpt) Keystone account username | +
| auth_admin_prefix = | +(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | +
| auth_host = 127.0.0.1 | +(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_port = 35357 | +(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_protocol = https | +(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | +
| auth_uri = None | +(StrOpt) Complete public Identity API endpoint | +
| auth_version = None | +(StrOpt) API version of the admin Identity API endpoint | +
| cache = None | +(StrOpt) Env key for the swift cache | +
| cafile = None | +(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | +
| certfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| check_revocations_for_cached = False | +(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server. | +
| delay_auth_decision = False | +(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | +
| enforce_token_bind = permissive | +(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | +
| hash_algorithms = md5 | +(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | +
| http_connect_timeout = None | +(BoolOpt) Request timeout value for communicating with Identity API server. | +
| http_request_max_retries = 3 | +(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | +
| identity_uri = None | +(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | +
| include_service_catalog = True | +(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | +
| insecure = False | +(BoolOpt) Verify HTTPS connections. | +
| keyfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| memcache_secret_key = None | +(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | +
| memcache_security_strategy = None | +(StrOpt) (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. | +
| memcached_servers = None | +(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | +
| revocation_cache_time = 10 | +(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | +
| signing_dir = None | +(StrOpt) Directory used to cache files related to PKI tokens | +
| token_cache_time = 300 | +(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| backup_aes_cbc_key = default_aes_cbc_key | -(StrOpt) Default OpenSSL aes_cbc key. | -
| backup_chunk_size = 65536 | -(IntOpt) Chunk size to stream to swift container. This should be in multiples of 128 bytes, since this is the size of an md5 digest block allowing the process to update the file checksum during streaming. See: http://stackoverflow.com/questions/1131220/ | -
| backup_incremental_strategy = {'InnoBackupEx': 'InnoBackupExIncremental'} | -(DictOpt) Incremental Backup Runner Based off of the default strategy. For strategies that do not implement an incremental the runner will use the default full backup. | -
| backup_namespace = trove.guestagent.strategies.backup.mysql_impl | -(StrOpt) Namespace to load backup strategies from. | -
| backup_runner = trove.guestagent.backup.backup_types.InnoBackupEx | -(StrOpt) No help text available for this option. | -
| backup_runner_options = {} | -(DictOpt) Additional options to be passed to the backup runner. | -
| backup_segment_max_size = 2147483648 | -(IntOpt) Maximum size of each segment of the backup file. | -
| backup_strategy = InnoBackupEx | -(StrOpt) Default strategy to perform backups. | -
| backup_swift_container = database_backups | -(StrOpt) No help text available for this option. | -
| backup_use_gzip_compression = True | -(BoolOpt) Compress backups using gzip. | -
| backup_use_openssl_encryption = True | -(BoolOpt) Encrypt backups using OpenSSL. | -
| backup_use_snet = False | -(BoolOpt) Send backup files over snet. | -
| backups_page_size = 20 | -(IntOpt) No help text available for this option. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| backup_aes_cbc_key = default_aes_cbc_key | +(StrOpt) Default OpenSSL aes_cbc key. | +
| backup_chunk_size = 65536 | +(IntOpt) Chunk size to stream to swift container. This should be in multiples of 128 bytes, since this is the size of an md5 digest block allowing the process to update the file checksum during streaming. See: http://stackoverflow.com/questions/1131220/ | +
| backup_incremental_strategy = {'InnoBackupEx': 'InnoBackupExIncremental'} | +(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. | +
| backup_namespace = trove.guestagent.strategies.backup.mysql_impl | +(StrOpt) Namespace to load backup strategies from. | +
| backup_runner = trove.guestagent.backup.backup_types.InnoBackupEx | +(StrOpt) No help text available for this option. | +
| backup_runner_options = {} | +(DictOpt) Additional options to be passed to the backup runner. | +
| backup_segment_max_size = 2147483648 | +(IntOpt) Maximum size of each segment of the backup file. | +
| backup_strategy = InnoBackupEx | +(StrOpt) Default strategy to perform backups. | +
| backup_swift_container = database_backups | +(StrOpt) No help text available for this option. | +
| backup_use_gzip_compression = True | +(BoolOpt) Compress backups using gzip. | +
| backup_use_openssl_encryption = True | +(BoolOpt) Encrypt backups using OpenSSL. | +
| backup_use_snet = False | +(BoolOpt) Send backup files over snet. | +
| backups_page_size = 20 | +(IntOpt) No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| configurations_page_size = 20 | -(IntOpt) No help text available for this option. | -
| databases_page_size = 20 | -(IntOpt) No help text available for this option. | -
| default_datastore = None | -(StrOpt) The default datastore id or name to use if one is not provided by the user. If the default value is None, the field becomes required in the instance-create request. | -
| default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN | -(ListOpt) list of logger=LEVEL pairs | -
| default_neutron_networks = | -(ListOpt) List of network IDs which should be attached to instance when networks are not specified in API call. | -
| default_notification_level = INFO | -(StrOpt) Default notification level for outgoing notifications | -
| default_password_length = 36 | -(IntOpt) No help text available for this option. | -
| default_publisher_id = $host | -(StrOpt) Default publisher_id for outgoing notifications | -
| expected_filetype_suffixes = json | -(ListOpt) Filetype endings not to be reattached to an id by the utils method correct_id_with_req. | -
| lock_path = None | -(StrOpt) Directory to use for lock files. | -
| pybasedir = /usr/lib/python/site-packages/trove | -(StrOpt) Directory where the trove python module is installed. | -
| pydev_path = None | -(StrOpt) Set path to pydevd library, used if pydevd is not found in python sys.path. | -
| taskmanager_queue = taskmanager | -(StrOpt) No help text available for this option. | -
| template_path = /etc/trove/templates/ | -(StrOpt) Path which leads to datastore templates. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| configurations_page_size = 20 | +(IntOpt) No help text available for this option. | +
| databases_page_size = 20 | +(IntOpt) No help text available for this option. | +
| default_datastore = None | +(StrOpt) The default datastore id or name to use if one is not provided by the user. If the default value is None, the field becomes required in the instance-create request. | +
| default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN | +(ListOpt) list of logger=LEVEL pairs | +
| default_neutron_networks = | +(ListOpt) List of network IDs which should be attached to instance when networks are not specified in API call. | +
| default_notification_level = INFO | +(StrOpt) Default notification level for outgoing notifications | +
| default_password_length = 36 | +(IntOpt) No help text available for this option. | +
| default_publisher_id = $host | +(StrOpt) Default publisher_id for outgoing notifications | +
| expected_filetype_suffixes = json | +(ListOpt) Filetype endings not to be reattached to an ID by the utils method correct_id_with_req. | +
| lock_path = None | +(StrOpt) Directory to use for lock files. | +
| pybasedir = /usr/lib/python/site-packages/sources/trove/trove | +(StrOpt) Directory where the trove python module is installed. | +
| pydev_path = None | +(StrOpt) Set path to pydevd library, used if pydevd is not found in python sys.path. | +
| taskmanager_queue = taskmanager | +(StrOpt) No help text available for this option. | +
| template_path = /etc/trove/templates/ | +(StrOpt) Path which leads to datastore templates. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| ip_regex = None | -(StrOpt) No help text available for this option. | -
| nova_compute_url = http://localhost:8774/v2 | -(StrOpt) No help text available for this option. | -
| root_grant = ALL | -(ListOpt) No help text available for this option. | -
| root_grant_option = True | -(BoolOpt) No help text available for this option. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| ip_regex = None | +(StrOpt) No help text available for this option. | +
| nova_compute_service_type = compute | +(StrOpt) Service type to use when searching catalog. | +
| nova_compute_url = None | +(StrOpt) URL without the tenant segment. | +
| root_grant = ALL | +(ListOpt) No help text available for this option. | +
| root_grant_option = True | +(BoolOpt) No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| sql_connection = sqlite:///trove_test.sqlite | -(StrOpt) SQL Connection. | -
| sql_idle_timeout = 3600 | -(IntOpt) No help text available for this option. | -
| sql_query_log = False | -(BoolOpt) No help text available for this option. | -
| sql_query_logging = False | -(BoolOpt) Allow insecure logging while executing queries through SQLAlchemy. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| sql_connection = sqlite:///trove_test.sqlite | +(StrOpt) SQL Connection. | +
| sql_idle_timeout = 3600 | +(IntOpt) No help text available for this option. | +
| sql_query_log = False | +(BoolOpt) No help text available for this option. | +
| sql_query_logging = False | +(BoolOpt) Allow insecure logging while executing queries through SQLAlchemy. | +
| Configuration option = Default value | -Description | -
|---|---|
| [cassandra] | -|
| backup_strategy = None | -(StrOpt) Default strategy to perform backups. | -
| mount_point = /var/lib/cassandra | -(StrOpt) Filesystem path for mounting volumes if volume support is enabled | -
| tcp_ports = 7000, 7001, 9042, 9160 | -(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True) | -
| udp_ports = | -(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True) | -
| usage_timeout = 600 | -(IntOpt) Timeout to wait for a guest to become active. | -
| Configuration option = Default value | +Description | +
|---|---|
| [cassandra] | +|
| backup_strategy = None | +(StrOpt) Default strategy to perform backups. | +
| mount_point = /var/lib/cassandra | +(StrOpt) Filesystem path for mounting volumes if volume support is enabled. | +
| tcp_ports = 7000, 7001, 9042, 9160 | +(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | +
| udp_ports = | +(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | +
| usage_timeout = 600 | +(IntOpt) Timeout to wait for a guest to become active. | +
| Configuration option = Default value | -Description | -
|---|---|
| [couchbase] | -|
| backup_strategy = None | -(StrOpt) Default strategy to perform backups. | -
| mount_point = /var/lib/couchbase | -(StrOpt) Filesystem path for mounting volumes if volume support is enabled | -
| tcp_ports = 8091, 8092, 4369, 11209-11211, 21100-21199 | -(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True) | -
| udp_ports = | -(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True) | -
| usage_timeout = 450 | -(IntOpt) Timeout to wait for a guest to become active. | -
| Configuration option = Default value | +Description | +
|---|---|
| [couchbase] | +|
| backup_strategy = None | +(StrOpt) Default strategy to perform backups. | +
| mount_point = /var/lib/couchbase | +(StrOpt) Filesystem path for mounting volumes if volume support is enabled. | +
| root_on_create = True | +(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. | +
| tcp_ports = 8091, 8092, 4369, 11209-11211, 21100-21199 | +(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | +
| udp_ports = | +(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | +
| usage_timeout = 450 | +(IntOpt) Timeout to wait for a guest to become active. | +
| Configuration option = Default value | -Description | -
|---|---|
| [mongodb] | -|
| backup_strategy = None | -(StrOpt) Default strategy to perform backups. | -
| mount_point = /var/lib/mongodb | -(StrOpt) Filesystem path for mounting volumes if volume support is enabled | -
| tcp_ports = 2500, 27017 | -(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True) | -
| udp_ports = | -(ListOpt) List of UPD ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True) | -
| usage_timeout = 450 | -(IntOpt) Timeout to wait for a guest to become active. | -
| Configuration option = Default value | +Description | +
|---|---|
| [mongodb] | +|
| backup_strategy = None | +(StrOpt) Default strategy to perform backups. | +
| mount_point = /var/lib/mongodb | +(StrOpt) Filesystem path for mounting volumes if volume support is enabled. | +
| tcp_ports = 2500, 27017 | +(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | +
| udp_ports = | +(ListOpt) List of UPD ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | +
| usage_timeout = 450 | +(IntOpt) Timeout to wait for a guest to become active. | +
| Configuration option = Default value | -Description | -
|---|---|
| [mysql] | -|
| backup_strategy = InnoBackupEx | -(StrOpt) Default strategy to perform backups. | -
| mount_point = /var/lib/mysql | -(StrOpt) Filesystem path for mounting volumes if volume support is enabled | -
| root_on_create = False | -(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. | -
| tcp_ports = 3306 | -(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True) | -
| udp_ports = | -(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True) | -
| usage_timeout = 400 | -(IntOpt) Timeout to wait for a guest to become active. | -
| Configuration option = Default value | +Description | +
|---|---|
| [mysql] | +|
| backup_strategy = InnoBackupEx | +(StrOpt) Default strategy to perform backups. | +
| mount_point = /var/lib/mysql | +(StrOpt) Filesystem path for mounting volumes if volume support is enabled. | +
| root_on_create = False | +(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. | +
| tcp_ports = 3306 | +(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | +
| udp_ports = | +(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | +
| usage_timeout = 400 | +(IntOpt) Timeout to wait for a guest to become active. | +
| Configuration option = Default value | -Description | -
|---|---|
| [percona] | -|
| backup_strategy = InnoBackupEx | -(StrOpt) Default strategy to perform backups. | -
| mount_point = /var/lib/mysql | -(StrOpt) Filesystem path for mounting volumes if volume support is enabled | -
| root_on_create = False | -(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. | -
| tcp_ports = 3306 | -(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True) | -
| udp_ports = | -(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True) | -
| usage_timeout = 450 | -(IntOpt) Timeout to wait for a guest to become active. | -
| Configuration option = Default value | +Description | +
|---|---|
| [percona] | +|
| backup_strategy = InnoBackupEx | +(StrOpt) Default strategy to perform backups. | +
| mount_point = /var/lib/mysql | +(StrOpt) Filesystem path for mounting volumes if volume support is enabled. | +
| root_on_create = False | +(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. | +
| tcp_ports = 3306 | +(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | +
| udp_ports = | +(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | +
| usage_timeout = 450 | +(IntOpt) Timeout to wait for a guest to become active. | +
| Configuration option = Default value | -Description | -
|---|---|
| [redis] | -|
| backup_strategy = None | -(StrOpt) Default strategy to perform backups. | -
| mount_point = /var/lib/redis | -(StrOpt) Filesystem path for mounting volumes if volume support is enabled | -
| tcp_ports = 6379 | -(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True) | -
| udp_ports = | -(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True) | -
| usage_timeout = 450 | -(IntOpt) Timeout to wait for a guest to become active. | -
| Configuration option = Default value | +Description | +
|---|---|
| [redis] | +|
| backup_strategy = None | +(StrOpt) Default strategy to perform backups. | +
| mount_point = /var/lib/redis | +(StrOpt) Filesystem path for mounting volumes if volume support is enabled. | +
| tcp_ports = 6379 | +(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | +
| udp_ports = | +(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). | +
| usage_timeout = 450 | +(IntOpt) Timeout to wait for a guest to become active. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| backdoor_port = None | -(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. | -
| backlog = 4096 | -(IntOpt) Number of backlog requests to configure the socket with | -
| debug = False | -(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | -
| disable_process_locking = False | -(BoolOpt) Whether to disable inter-process locks | -
| fatal_deprecations = False | -(BoolOpt) make deprecations fatal | -
| pydev_debug = disabled | -(StrOpt) Enable or disable pydev remote debugging. If value is 'auto' tries to connect to remote debugger server, but in case of error continues running with debugging disabled. | -
| pydev_debug_host = None | -(StrOpt) Pydev debug server host (localhost by default). | -
| pydev_debug_port = None | -(IntOpt) Pydev debug server port (5678 by default). | -
| remote_cinder_client = trove.common.remote.cinder_client | -(StrOpt) No help text available for this option. | -
| remote_dns_client = trove.common.remote.dns_client | -(StrOpt) No help text available for this option. | -
| remote_guest_client = trove.common.remote.guest_client | -(StrOpt) No help text available for this option. | -
| remote_heat_client = trove.common.remote.heat_client | -(StrOpt) No help text available for this option. | -
| remote_nova_client = trove.common.remote.nova_client | -(StrOpt) No help text available for this option. | -
| remote_swift_client = trove.common.remote.swift_client | -(StrOpt) No help text available for this option. | -
| verbose = False | -(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| backdoor_port = None | +(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. | +
| backlog = 4096 | +(IntOpt) Number of backlog requests to configure the socket with | +
| debug = False | +(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | +
| disable_process_locking = False | +(BoolOpt) Whether to disable inter-process locks | +
| fatal_deprecations = False | +(BoolOpt) make deprecations fatal | +
| pydev_debug = disabled | +(StrOpt) Enable or disable pydev remote debugging. If value is 'auto' tries to connect to remote debugger server, but in case of error continues running with debugging disabled. | +
| pydev_debug_host = None | +(StrOpt) Pydev debug server host (localhost by default). | +
| pydev_debug_port = None | +(IntOpt) Pydev debug server port (5678 by default). | +
| remote_cinder_client = trove.common.remote.cinder_client | +(StrOpt) No help text available for this option. | +
| remote_dns_client = trove.common.remote.dns_client | +(StrOpt) No help text available for this option. | +
| remote_guest_client = trove.common.remote.guest_client | +(StrOpt) No help text available for this option. | +
| remote_heat_client = trove.common.remote.heat_client | +(StrOpt) No help text available for this option. | +
| remote_nova_client = trove.common.remote.nova_client | +(StrOpt) No help text available for this option. | +
| remote_swift_client = trove.common.remote.swift_client | +(StrOpt) No help text available for this option. | +
| verbose = False | +(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| dns_account_id = | -(StrOpt) No help text available for this option. | -
| dns_auth_url = | -(StrOpt) No help text available for this option. | -
| dns_domain_id = | -(StrOpt) No help text available for this option. | -
| dns_domain_name = | -(StrOpt) No help text available for this option. | -
| dns_driver = trove.dns.driver.DnsDriver | -(StrOpt) No help text available for this option. | -
| dns_endpoint_url = 0.0.0.0 | -(StrOpt) No help text available for this option. | -
| dns_hostname = | -(StrOpt) No help text available for this option. | -
| dns_instance_entry_factory = trove.dns.driver.DnsInstanceEntryFactory | -(StrOpt) No help text available for this option. | -
| dns_management_base_url = | -(StrOpt) No help text available for this option. | -
| dns_passkey = | -(StrOpt) No help text available for this option. | -
| dns_region = | -(StrOpt) No help text available for this option. | -
| dns_service_type = | -(StrOpt) No help text available for this option. | -
| dns_time_out = 120 | -(IntOpt) No help text available for this option. | -
| dns_ttl = 300 | -(IntOpt) No help text available for this option. | -
| dns_username = | -(StrOpt) No help text available for this option. | -
| trove_dns_support = False | -(BoolOpt) No help text available for this option. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| dns_account_id = | +(StrOpt) No help text available for this option. | +
| dns_auth_url = | +(StrOpt) No help text available for this option. | +
| dns_domain_id = | +(StrOpt) No help text available for this option. | +
| dns_domain_name = | +(StrOpt) No help text available for this option. | +
| dns_driver = trove.dns.driver.DnsDriver | +(StrOpt) No help text available for this option. | +
| dns_endpoint_url = 0.0.0.0 | +(StrOpt) No help text available for this option. | +
| dns_hostname = | +(StrOpt) No help text available for this option. | +
| dns_instance_entry_factory = trove.dns.driver.DnsInstanceEntryFactory | +(StrOpt) No help text available for this option. | +
| dns_management_base_url = | +(StrOpt) No help text available for this option. | +
| dns_passkey = | +(StrOpt) No help text available for this option. | +
| dns_region = | +(StrOpt) No help text available for this option. | +
| dns_service_type = | +(StrOpt) No help text available for this option. | +
| dns_time_out = 120 | +(IntOpt) No help text available for this option. | +
| dns_ttl = 300 | +(IntOpt) No help text available for this option. | +
| dns_username = | +(StrOpt) No help text available for this option. | +
| trove_dns_support = False | +(BoolOpt) No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| agent_call_high_timeout = 60 | -(IntOpt) No help text available for this option. | -
| agent_call_low_timeout = 5 | -(IntOpt) No help text available for this option. | -
| agent_heartbeat_time = 10 | -(IntOpt) No help text available for this option. | -
| guest_config = $pybasedir/etc/trove/trove-guestagent.conf.sample | -(StrOpt) Path to guestagent config file. | -
| guest_id = None | -(StrOpt) No help text available for this option. | -
| ignore_dbs = lost+found, mysql, information_schema | -(ListOpt) No help text available for this option. | -
| ignore_users = os_admin, root | -(ListOpt) No help text available for this option. | -
| mount_options = defaults,noatime | -(StrOpt) No help text available for this option. | -
| restore_namespace = trove.guestagent.strategies.restore.mysql_impl | -(StrOpt) Namespace to load restore strategies from. | -
| storage_namespace = trove.guestagent.strategies.storage.swift | -(StrOpt) Namespace to load the default storage strategy from. | -
| storage_strategy = SwiftStorage | -(StrOpt) Default strategy to store backups. | -
| usage_sleep_time = 5 | -(IntOpt) Time to sleep during the check active guest. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| agent_call_high_timeout = 60 | +(IntOpt) No help text available for this option. | +
| agent_call_low_timeout = 5 | +(IntOpt) No help text available for this option. | +
| agent_heartbeat_time = 10 | +(IntOpt) No help text available for this option. | +
| guest_config = $pybasedir/etc/trove/trove-guestagent.conf.sample | +(StrOpt) Path to guestagent config file. | +
| guest_id = None | +(StrOpt) No help text available for this option. | +
| ignore_dbs = lost+found, mysql, information_schema | +(ListOpt) No help text available for this option. | +
| ignore_users = os_admin, root | +(ListOpt) No help text available for this option. | +
| mount_options = defaults,noatime | +(StrOpt) No help text available for this option. | +
| restore_namespace = trove.guestagent.strategies.restore.mysql_impl | +(StrOpt) Namespace to load restore strategies from. | +
| storage_namespace = trove.guestagent.strategies.storage.swift | +(StrOpt) Namespace to load the default storage strategy from. | +
| storage_strategy = SwiftStorage | +(StrOpt) Default strategy to store backups. | +
| usage_sleep_time = 5 | +(IntOpt) Time to sleep during the check active guest. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| heat_time_out = 60 | -(IntOpt) No help text available for this option. | -
| heat_url = http://localhost:8004/v1 | -(StrOpt) No help text available for this option. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| heat_service_type = orchestration | +(StrOpt) Service type to use when searching catalog. | +
| heat_time_out = 60 | +(IntOpt) No help text available for this option. | +
| heat_url = None | +(StrOpt) URL without the tenant segment. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| format_options = -m 5 | -(StrOpt) No help text available for this option. | -
| instance_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance is passed with the log message, format it like this | -
| instance_uuid_format = "[instance: %(uuid)s] " | -(StrOpt) If an instance UUID is passed with the log message, format it like this | -
| log_config_append = None | -(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files. | -
| log_date_format = %Y-%m-%d %H:%M:%S | -(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s | -
| log_dir = None | -(StrOpt) (Optional) The base directory used for relative --log-file paths | -
| log_file = None | -(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | -
| log_format = None | -(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | -
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | -(StrOpt) format string to use for log messages with context | -
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | -(StrOpt) data to append to log format when level is DEBUG | -
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | -(StrOpt) format string to use for log messages without context | -
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | -(StrOpt) prefix each line of exception output with this format | -
| network_label_regex = ^private$ | -(StrOpt) No help text available for this option. | -
| publish_errors = False | -(BoolOpt) publish error events | -
| syslog_log_facility = LOG_USER | -(StrOpt) syslog facility to receive log lines | -
| use_stderr = True | -(BoolOpt) Log output to standard error | -
| use_syslog = False | -(BoolOpt) Use syslog for logging. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| format_options = -m 5 | +(StrOpt) No help text available for this option. | +
| instance_format = "[instance: %(uuid)s] " | +(StrOpt) If an instance is passed with the log message, format it like this | +
| instance_uuid_format = "[instance: %(uuid)s] " | +(StrOpt) If an instance UUID is passed with the log message, format it like this | +
| log_config_append = None | +(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files. | +
| log_date_format = %Y-%m-%d %H:%M:%S | +(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s | +
| log_dir = None | +(StrOpt) (Optional) The base directory used for relative --log-file paths | +
| log_file = None | +(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | +
| log_format = None | +(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | +
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | +(StrOpt) format string to use for log messages with context | +
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | +(StrOpt) data to append to log format when level is DEBUG | +
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | +(StrOpt) format string to use for log messages without context | +
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | +(StrOpt) prefix each line of exception output with this format | +
| network_label_regex = ^private$ | +(StrOpt) No help text available for this option. | +
| publish_errors = False | +(BoolOpt) publish error events | +
| syslog_log_facility = LOG_USER | +(StrOpt) syslog facility to receive log lines | +
| use_stderr = True | +(BoolOpt) Log output to standard error | +
| use_syslog = False | +(BoolOpt) Use syslog for logging. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| nova_proxy_admin_pass = | -(StrOpt) Admin password used to connect to nova, | -
| nova_proxy_admin_tenant_name = | -(StrOpt) Admin tenant used to connect to nova. | -
| nova_proxy_admin_user = | -(StrOpt) Admin username used to connect to nova. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| nova_proxy_admin_pass = | +(StrOpt) Admin password used to connect to nova, | +
| nova_proxy_admin_tenant_name = | +(StrOpt) Admin tenant used to connect to nova. | +
| nova_proxy_admin_user = | +(StrOpt) Admin username used to connect to nova. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| qpid_heartbeat = 60 | -(IntOpt) Seconds between connection keepalive heartbeats | -
| qpid_hostname = localhost | -(StrOpt) Qpid broker hostname | -
| qpid_hosts = $qpid_hostname:$qpid_port | -(ListOpt) Qpid HA cluster host:port pairs | -
| qpid_password = | -(StrOpt) Password for qpid connection | -
| qpid_port = 5672 | -(IntOpt) Qpid broker port | -
| qpid_protocol = tcp | -(StrOpt) Transport to use, either 'tcp' or 'ssl' | -
| qpid_sasl_mechanisms = | -(StrOpt) Space separated list of SASL mechanisms to use for auth | -
| qpid_tcp_nodelay = True | -(BoolOpt) Disable Nagle algorithm | -
| qpid_username = | -(StrOpt) Username for qpid connection | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| qpid_heartbeat = 60 | +(IntOpt) Seconds between connection keepalive heartbeats | +
| qpid_hostname = localhost | +(StrOpt) Qpid broker hostname | +
| qpid_hosts = $qpid_hostname:$qpid_port | +(ListOpt) Qpid HA cluster host:port pairs | +
| qpid_password = | +(StrOpt) Password for qpid connection | +
| qpid_port = 5672 | +(IntOpt) Qpid broker port | +
| qpid_protocol = tcp | +(StrOpt) Transport to use, either 'tcp' or 'ssl' | +
| qpid_sasl_mechanisms = | +(StrOpt) Space separated list of SASL mechanisms to use for auth | +
| qpid_tcp_nodelay = True | +(BoolOpt) Disable Nagle algorithm | +
| qpid_username = | +(StrOpt) Username for qpid connection | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| max_accepted_volume_size = 5 | -(IntOpt) Default maximum volume size for an instance. | -
| max_backups_per_user = 50 | -(IntOpt) Default maximum number of backups created by a tenant. | -
| max_instances_per_user = 5 | -(IntOpt) Default maximum number of instances per tenant. | -
| max_volumes_per_user = 20 | -(IntOpt) Default maximum volume capacity (in GB) spanning across all trove volumes per tenant | -
| quota_driver = trove.quota.quota.DbQuotaDriver | -(StrOpt) Default driver to use for quota checks. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| max_accepted_volume_size = 5 | +(IntOpt) Default maximum volume size for an instance. | +
| max_backups_per_user = 50 | +(IntOpt) Default maximum number of backups created by a tenant. | +
| max_instances_per_user = 5 | +(IntOpt) Default maximum number of instances per tenant. | +
| max_volumes_per_user = 20 | +(IntOpt) Default maximum volume capacity (in GB) spanning across all trove volumes per tenant. | +
| quota_driver = trove.quota.quota.DbQuotaDriver | +(StrOpt) Default driver to use for quota checks. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| rabbit_ha_queues = False | -(BoolOpt) use H/A queues in RabbitMQ (x-ha-policy: all).You need to wipe RabbitMQ database when changing this option. | -
| rabbit_host = localhost | -(StrOpt) The RabbitMQ broker address where a single node is used | -
| rabbit_hosts = $rabbit_host:$rabbit_port | -(ListOpt) RabbitMQ HA cluster host:port pairs | -
| rabbit_max_retries = 0 | -(IntOpt) maximum retries with trying to connect to RabbitMQ (the default of 0 implies an infinite retry count) | -
| rabbit_password = guest | -(StrOpt) the RabbitMQ password | -
| rabbit_port = 5672 | -(IntOpt) The RabbitMQ broker port where a single node is used | -
| rabbit_retry_backoff = 2 | -(IntOpt) how long to backoff for between retries when connecting to RabbitMQ | -
| rabbit_retry_interval = 1 | -(IntOpt) how frequently to retry connecting with RabbitMQ | -
| rabbit_use_ssl = False | -(BoolOpt) connect over SSL for RabbitMQ | -
| rabbit_userid = guest | -(StrOpt) the RabbitMQ userid | -
| rabbit_virtual_host = / | -(StrOpt) the RabbitMQ virtual host | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| rabbit_ha_queues = False | +(BoolOpt) use H/A queues in RabbitMQ (x-ha-policy: all).You need to wipe RabbitMQ database when changing this option. | +
| rabbit_host = localhost | +(StrOpt) The RabbitMQ broker address where a single node is used | +
| rabbit_hosts = $rabbit_host:$rabbit_port | +(ListOpt) RabbitMQ HA cluster host:port pairs | +
| rabbit_max_retries = 0 | +(IntOpt) maximum retries with trying to connect to RabbitMQ (the default of 0 implies an infinite retry count) | +
| rabbit_password = guest | +(StrOpt) the RabbitMQ password | +
| rabbit_port = 5672 | +(IntOpt) The RabbitMQ broker port where a single node is used | +
| rabbit_retry_backoff = 2 | +(IntOpt) how long to backoff for between retries when connecting to RabbitMQ | +
| rabbit_retry_interval = 1 | +(IntOpt) how frequently to retry connecting with RabbitMQ | +
| rabbit_use_ssl = False | +(BoolOpt) connect over SSL for RabbitMQ | +
| rabbit_userid = guest | +(StrOpt) the RabbitMQ userid | +
| rabbit_virtual_host = / | +(StrOpt) the RabbitMQ virtual host | +
| Configuration option = Default value | -Description | -
|---|---|
| [matchmaker_redis] | -|
| host = 127.0.0.1 | -(StrOpt) Host to locate redis | -
| password = None | -(StrOpt) Password for Redis server. (optional) | -
| port = 6379 | -(IntOpt) Use this port to connect to redis host. | -
| [matchmaker_ring] | -|
| ringfile = /etc/oslo/matchmaker_ring.json | -(StrOpt) Matchmaker ring file (JSON) | -
| Configuration option = Default value | +Description | +
|---|---|
| [matchmaker_redis] | +|
| host = 127.0.0.1 | +(StrOpt) Host to locate redis | +
| password = None | +(StrOpt) Password for Redis server. (optional) | +
| port = 6379 | +(IntOpt) Use this port to connect to redis host. | +
| [matchmaker_ring] | +|
| ringfile = /etc/oslo/matchmaker_ring.json | +(StrOpt) Matchmaker ring file (JSON) | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions | -(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call. | -
| host = 0.0.0.0 | -(StrOpt) No help text available for this option. | -
| matchmaker_heartbeat_freq = 300 | -(IntOpt) Heartbeat frequency | -
| matchmaker_heartbeat_ttl = 600 | -(IntOpt) Heartbeat time-to-live. | -
| num_tries = 3 | -(IntOpt) No help text available for this option. | -
| periodic_interval = 60 | -(IntOpt) No help text available for this option. | -
| report_interval = 10 | -(IntOpt) The interval in seconds which periodic tasks are run. | -
| rpc_backend = trove.openstack.common.rpc.impl_kombu | -(StrOpt) The messaging module to use, defaults to kombu. | -
| rpc_cast_timeout = 30 | -(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | -
| rpc_conn_pool_size = 30 | -(IntOpt) Size of RPC connection pool | -
| rpc_response_timeout = 60 | -(IntOpt) Seconds to wait for a response from call or multicall | -
| rpc_thread_pool_size = 64 | -(IntOpt) Size of RPC thread pool | -
| [rpc_notifier2] | -|
| topics = notifications | -(ListOpt) AMQP topic(s) used for openstack notifications | -
| [secure_messages] | -|
| enabled = True | -(BoolOpt) Whether Secure Messaging (Signing) is enabled, defaults to enabled | -
| encrypt = False | -(BoolOpt) Whether Secure Messaging (Encryption) is enabled, defaults to not enabled | -
| enforced = False | -(BoolOpt) Whether Secure Messaging (Signing) is enforced, defaults to not enforced | -
| kds_endpoint = None | -(StrOpt) KDS endpoint (ex: http://kds.example.com:35357/v3) | -
| secret_key = None | -(MultiStrOpt) A list of keys: (ex: name:<base64 encoded key>), ignored if secret_keys_file is set | -
| secret_keys_file = None | -(StrOpt) Path to the file containing the keys, takes precedence over secret_key | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions | +(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call. | +
| host = 0.0.0.0 | +(StrOpt) No help text available for this option. | +
| matchmaker_heartbeat_freq = 300 | +(IntOpt) Heartbeat frequency | +
| matchmaker_heartbeat_ttl = 600 | +(IntOpt) Heartbeat time-to-live. | +
| num_tries = 3 | +(IntOpt) No help text available for this option. | +
| periodic_interval = 60 | +(IntOpt) No help text available for this option. | +
| report_interval = 10 | +(IntOpt) The interval in seconds which periodic tasks are run. | +
| rpc_backend = trove.openstack.common.rpc.impl_kombu | +(StrOpt) The messaging module to use, defaults to kombu. | +
| rpc_cast_timeout = 30 | +(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. | +
| rpc_conn_pool_size = 30 | +(IntOpt) Size of RPC connection pool | +
| rpc_response_timeout = 60 | +(IntOpt) Seconds to wait for a response from call or multicall | +
| rpc_thread_pool_size = 64 | +(IntOpt) Size of RPC thread pool | +
| [rpc_notifier2] | +|
| topics = notifications | +(ListOpt) AMQP topic(s) used for openstack notifications | +
| [secure_messages] | +|
| enabled = True | +(BoolOpt) Whether Secure Messaging (Signing) is enabled, defaults to enabled | +
| encrypt = False | +(BoolOpt) Whether Secure Messaging (Encryption) is enabled, defaults to not enabled | +
| enforced = False | +(BoolOpt) Whether Secure Messaging (Signing) is enforced, defaults to not enforced | +
| kds_endpoint = None | +(StrOpt) KDS endpoint (ex: http://kds.example.com:35357/v3) | +
| secret_key = None | +(MultiStrOpt) A list of keys: (ex: name:<base64 encoded key>), ignored if secret_keys_file is set | +
| secret_keys_file = None | +(StrOpt) Path to the file containing the keys, takes precedence over secret_key | +
| Configuration option = Default value | -Description | -
|---|---|
| [ssl] | -|
| ca_file = None | -(StrOpt) CA certificate file to use to verify connecting clients | -
| cert_file = None | -(StrOpt) Certificate file to use when starting the server securely | -
| key_file = None | -(StrOpt) Private key file to use when starting the server securely | -
| Configuration option = Default value | +Description | +
|---|---|
| [ssl] | +|
| ca_file = None | +(StrOpt) CA certificate file to use to verify connecting clients | +
| cert_file = None | +(StrOpt) Certificate file to use when starting the server securely | +
| key_file = None | +(StrOpt) Private key file to use when starting the server securely | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| swift_url = http://localhost:8080/v1/AUTH_ | -(StrOpt) No help text available for this option. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| swift_service_type = object-store | +(StrOpt) Service type to use when searching catalog. | +
| swift_url = None | +(StrOpt) URL ending in AUTH_. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| cloudinit_location = /etc/trove/cloudinit | -(StrOpt) Path to folder with cloudinit scripts. | -
| datastore_manager = None | -(StrOpt) Manager class in guestagent, setup by taskmanager on instance provision. | -
| datastore_registry_ext = {} | -(DictOpt) Extension for default datastore managers. Allows to use custom managers for each of datastore supported in trove. | -
| exists_notification_ticks = 360 | -(IntOpt) Number of report_intervals to wait between pushing events (see report_interval). | -
| exists_notification_transformer = None | -(StrOpt) Transformer for exists notifications. | -
| reboot_time_out = 120 | -(IntOpt) No help text available for this option. | -
| resize_time_out = 600 | -(IntOpt) No help text available for this option. | -
| revert_time_out = 600 | -(IntOpt) No help text available for this option. | -
| server_delete_time_out = 60 | -(IntOpt) No help text available for this option. | -
| state_change_wait_time = 180 | -(IntOpt) No help text available for this option. | -
| update_status_on_fail = False | -(BoolOpt) If instance fails to become active, taskmanager updates statuses, service status = FAILED_TIMEOUT_GUESTAGENT, instance task status = BUILDING_ERROR_TIMEOUT_GA. | -
| usage_sleep_time = 5 | -(IntOpt) Time to sleep during the check active guest. | -
| use_heat = False | -(BoolOpt) No help text available for this option. | -
| use_nova_server_volume = False | -(BoolOpt) No help text available for this option. | -
| verify_swift_checksum_on_restore = True | -(BoolOpt) Enable verification of swift checksum before starting restore; makes sure the checksum of original backup matches checksum of the swift backup file. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| cloudinit_location = /etc/trove/cloudinit | +(StrOpt) Path to folder with cloudinit scripts. | +
| datastore_manager = None | +(StrOpt) Manager class in guestagent, setup by taskmanager on instance provision. | +
| datastore_registry_ext = {} | +(DictOpt) Extension for default datastore managers. Allows to use custom managers for each of datastore supported in trove. | +
| exists_notification_ticks = 360 | +(IntOpt) Number of report_intervals to wait between pushing events (see report_interval). | +
| exists_notification_transformer = None | +(StrOpt) Transformer for exists notifications. | +
| reboot_time_out = 120 | +(IntOpt) No help text available for this option. | +
| resize_time_out = 600 | +(IntOpt) No help text available for this option. | +
| revert_time_out = 600 | +(IntOpt) No help text available for this option. | +
| server_delete_time_out = 60 | +(IntOpt) No help text available for this option. | +
| state_change_wait_time = 180 | +(IntOpt) No help text available for this option. | +
| update_status_on_fail = False | +(BoolOpt) If instance fails to become active, taskmanager updates statuses, service status = FAILED_TIMEOUT_GUESTAGENT, instance task status = BUILDING_ERROR_TIMEOUT_GA. | +
| usage_sleep_time = 5 | +(IntOpt) Time to sleep during the check active guest. | +
| use_heat = False | +(BoolOpt) No help text available for this option. | +
| use_nova_server_volume = False | +(BoolOpt) No help text available for this option. | +
| verify_swift_checksum_on_restore = True | +(BoolOpt) Enable verification of swift checksum before starting restore; makes sure the checksum of original backup matches checksum of the swift backup file. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| block_device_mapping = vdb | -(StrOpt) No help text available for this option. | -
| cinder_url = http://localhost:8776/v2 | -(StrOpt) No help text available for this option. | -
| device_path = /dev/vdb | -(StrOpt) No help text available for this option. | -
| trove_volume_support = True | -(BoolOpt) Whether to provision a cinder volume for datadir. | -
| volume_format_timeout = 120 | -(IntOpt) No help text available for this option. | -
| volume_fstype = ext3 | -(StrOpt) No help text available for this option. | -
| volume_time_out = 60 | -(IntOpt) No help text available for this option. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| block_device_mapping = vdb | +(StrOpt) No help text available for this option. | +
| cinder_service_type = volumev2 | +(StrOpt) Service type to use when searching catalog. | +
| cinder_url = None | +(StrOpt) URL without the tenant segment. | +
| device_path = /dev/vdb | +(StrOpt) No help text available for this option. | +
| trove_volume_support = True | +(BoolOpt) Whether to provision a cinder volume for datadir. | +
| volume_format_timeout = 120 | +(IntOpt) No help text available for this option. | +
| volume_fstype = ext3 | +(StrOpt) No help text available for this option. | +
| volume_time_out = 60 | +(IntOpt) No help text available for this option. | +
| Configuration option = Default value | -Description | -
|---|---|
| [DEFAULT] | -|
| rpc_zmq_bind_address = * | -(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | -
| rpc_zmq_contexts = 1 | -(IntOpt) Number of ZeroMQ contexts, defaults to 1 | -
| rpc_zmq_host = oslo | -(StrOpt) 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 | -(StrOpt) Directory for holding IPC sockets | -
| rpc_zmq_matchmaker = trove.openstack.common.rpc.matchmaker.MatchMakerLocalhost | -(StrOpt) MatchMaker driver | -
| rpc_zmq_port = 9501 | -(IntOpt) ZeroMQ receiver listening port | -
| rpc_zmq_topic_backlog = None | -(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | -
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| rpc_zmq_bind_address = * | +(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. | +
| rpc_zmq_contexts = 1 | +(IntOpt) Number of ZeroMQ contexts, defaults to 1 | +
| rpc_zmq_host = oslo | +(StrOpt) 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 | +(StrOpt) Directory for holding IPC sockets | +
| rpc_zmq_matchmaker = trove.openstack.common.rpc.matchmaker.MatchMakerLocalhost | +(StrOpt) MatchMaker driver | +
| rpc_zmq_port = 9501 | +(IntOpt) ZeroMQ receiver listening port | +
| rpc_zmq_topic_backlog = None | +(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. | +