openstack
/
openstack-manuals
Code Issues Proposed changes

[config-ref] update the conf changes tables 

For a few tables which I got the error on generating,
I will update the following patch.

Change-Id: I1f5c6b70704182924b96e6705a893356bd31410f
This commit is contained in:
KATO Tomoyuki 2016-09-29 15:44:16 +09:00
parent 5886794a1b
commit f1e0934114
16 changed files with 1065 additions and 1080 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/config-reference/source/application-catalog.rst
View File

@ -7,6 +7,7 @@ Application Catalog service
application-catalog/api.rst
application-catalog/config-options.rst
tables/conf-changes/murano.rst
This chapter describes the Application Catalog service configuration options.

5
doc/config-reference/source/clustering.rst
View File

@ -2,6 +2,11 @@
Clustering service
==================
.. toctree::
:maxdepth: 1
tables/conf-changes/senlin.rst
The Clustering service implements clustering services and libraries for
managing groups of homogeneous objects exposed by other OpenStack services.
The configuration file for this service is ``/etc/senlin/senlin.conf``.

1
doc/config-reference/source/message.rst
View File

@ -15,6 +15,7 @@ Message service
message/zaqar-pooling.rst
message/logs.rst
message/zaqar-cache.rst
tables/conf-changes/zaqar.rst
The Message service is multi-tenant, fast, reliable, and scalable. It allows
developers to share data between distributed application components performing

50
doc/config-reference/source/tables/conf-changes/aodh.rst
View File

@ -1,4 +1,4 @@
New, updated, and deprecated options in Mitaka for Alarming
New, updated, and deprecated options in Newton for Alarming
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
@ -12,25 +12,37 @@ New, updated, and deprecated options in Mitaka for Alarming
* - Option = default value
- (Type) Help string
* - ``[DEFAULT] ipc_protocol = queue``
- (StrOpt) The protocol used to communicate between evaluator and notifier services.
* - ``[DEFAULT] notifier_topic = alarming``
- (StrOpt) The topic that aodh uses for alarm notifier messages.
* - ``[service_credentials] interface = public``
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.
* - ``[service_credentials] region_name = None``
- (StrOpt) Region name to use for OpenStack service endpoints.
* - ``[DEFAULT] additional_ingestion_lag = 0``
- (IntOpt) The number of seconds to extend the evaluation windows to compensate the reporting/ingestion lag.
* - ``[DEFAULT] rest_notifier_ca_bundle_certificate_path = None``
- (StrOpt) SSL CA_BUNDLE certificate for REST notifier
* - ``[api] alarm_max_actions = -1``
- (IntOpt) Maximum count of actions for each state of an alarm, non-positive number means no limit.
* - ``[api] enable_combination_alarms = False``
- (BoolOpt) Enable deprecated combination alarms.
* - ``[api] project_alarm_quota = None``
- (IntOpt) Maximum number of alarms defined for a project.
* - ``[api] user_alarm_quota = None``
- (IntOpt) Maximum number of alarms defined for a user.
* - ``[evaluator] workers = 1``
- (IntOpt) Number of workers for evaluator service. default value is 1.
* - ``[listener] batch_size = 1``
- (IntOpt) Number of notification messages to wait before dispatching them.
* - ``[listener] batch_timeout = None``
- (IntOpt) Number of seconds to wait before dispatching samples when batch_size is not reached (None means indefinitely).
* - ``[listener] event_alarm_topic = alarm.all``
- (StrOpt) The topic that aodh uses for event alarm evaluation.
* - ``[listener] workers = 1``
- (IntOpt) Number of workers for listener service. default value is 1.
* - ``[notifier] batch_size = 1``
- (IntOpt) Number of notification messages to wait before dispatching them.
* - ``[notifier] batch_timeout = None``
- (IntOpt) Number of seconds to wait before dispatching samples when batch_size is not reached (None means indefinitely).
* - ``[notifier] workers = 1``
- (IntOpt) Number of workers for notifier service. default value is 1.
* - ``[service_types] zaqar = messaging``
- (StrOpt) Message queue service type.
.. list-table:: New default values
:header-rows: 1
:class: config-ref-table
* - Option
- Previous default value
- New default value
* - ``[DEFAULT] gnocchi_url``
- ``http://localhost:8041``
- ``None``
.. list-table:: Deprecated options
:header-rows: 1

80
doc/config-reference/source/tables/conf-changes/ceilometer.rst
View File

@ -1,4 +1,4 @@
New, updated, and deprecated options in Mitaka for Telemetry
New, updated, and deprecated options in Newton for Telemetry
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
@ -12,44 +12,24 @@ New, updated, and deprecated options in Mitaka for Telemetry
* - Option = default value
- (Type) Help string
* - ``[DEFAULT] event_dispatchers = ['database']``
- (MultiStrOpt) Dispatchers to process event data.
* - ``[DEFAULT] meter_dispatchers = ['database']``
- (MultiStrOpt) Dispatchers to process metering data.
* - ``[collector] batch_size = 1``
- (IntOpt) Number of notification messages to wait before dispatching them
* - ``[collector] batch_timeout = None``
- (IntOpt) Number of seconds to wait before dispatching sampleswhen batch_size is not reached (None means indefinitely)
* - ``[compute] resource_update_interval = 0``
- (IntOpt) New instances will be discovered periodically based on this option (in seconds). By default, the agent discovers instances according to pipeline polling interval. If option is greater than 0, the instance list to poll will be updated based on this option's interval. Measurements relating to the instances will match intervals defined in pipeline.
* - ``[hyperv] force_volumeutils_v1 = False``
- (BoolOpt) DEPRECATED: Force V1 volume utility class
* - ``[notification] batch_size = 1``
- (IntOpt) Number of notification messages to wait before publishing them
* - ``[notification] batch_timeout = None``
- (IntOpt) Number of seconds to wait before publishing sampleswhen batch_size is not reached (None means indefinitely)
* - ``[service_credentials] auth_section = None``
- (Opt) Config Section from which to load plugin specific options
* - ``[service_credentials] auth_type = None``
- (Opt) Authentication type to load
* - ``[service_credentials] cafile = None``
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
* - ``[service_credentials] certfile = None``
- (StrOpt) PEM encoded client certificate cert file
* - ``[service_credentials] interface = public``
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.
* - ``[service_credentials] keyfile = None``
- (StrOpt) PEM encoded client certificate key file
* - ``[service_credentials] region_name = None``
- (StrOpt) Region name to use for OpenStack service endpoints.
* - ``[service_credentials] timeout = None``
- (IntOpt) Timeout value for http requests
* - ``[service_types] neutron_lbaas_version = v2``
- (StrOpt) Neutron load balancer version.
* - ``[storage] max_retries = 10``
- (IntOpt) Maximum number of connection retries during startup. Set to -1 to specify an infinite retry count.
* - ``[storage] retry_interval = 10``
- (IntOpt) Interval (in seconds) between retries of connection.
* - ``[api] panko_is_enabled = None``
- (BoolOpt) Set True to redirect events URLs to Panko. Default autodetection by querying keystone.
* - ``[api] panko_url = None``
- (StrOpt) The endpoint of Panko to redirect events URLs to Panko API. Default autodetection by querying keystone.
* - ``[coordination] max_retry_interval = 30``
- (IntOpt) Maximum number of seconds between retry to join partitioning group
* - ``[coordination] retry_backoff = 1``
- (IntOpt) Retry backoff factor when retrying to connect withcoordination backend
* - ``[database] sql_expire_samples_only = False``
- (BoolOpt) Indicates if expirer expires only samples. If set true, expired samples will be deleted, but residual resource and meter definition data will remain.
* - ``[dispatcher_http] verify_ssl = None``
- (StrOpt) The path to a server certificate or directory if the system CAs are not used or if a self-signed certificate is used. Set to False to ignore SSL cert verification.
* - ``[hardware] readonly_user_auth_proto = None``
- (StrOpt) SNMPd v3 authentication algorithm of all the nodes running in the cloud
* - ``[hardware] readonly_user_priv_password = None``
- (StrOpt) SNMPd v3 encryption password of all the nodes running in the cloud.
* - ``[hardware] readonly_user_priv_proto = None``
- (StrOpt) SNMPd v3 encryption algorithm of all the nodes running in the cloud
.. list-table:: New default values
:header-rows: 1
@ -58,12 +38,18 @@ New, updated, and deprecated options in Mitaka for Telemetry
* - Option
- Previous default value
- New default value
* - ``[dispatcher_gnocchi] archive_policy``
- ``low``
- ``None``
* - ``[dispatcher_gnocchi] url``
- ``http://localhost:8041``
* - ``[DEFAULT] event_dispatchers``
- ``['database']``
- ``[]``
* - ``[DEFAULT] host``
- ``localhost``
- ``<your_hostname>``
* - ``[notification] batch_size``
- ``1``
- ``100``
* - ``[notification] batch_timeout``
- ``None``
- ``5``
.. list-table:: Deprecated options
:header-rows: 1
@ -71,12 +57,6 @@ New, updated, and deprecated options in Mitaka for Telemetry
* - Deprecated option
- New Option
* - ``[DEFAULT] database_connection``
- ``None``
* - ``[DEFAULT] dispatcher``
- ``[DEFAULT] meter_dispatchers``
* - ``[DEFAULT] dispatcher``
- ``[DEFAULT] event_dispatchers``
* - ``[DEFAULT] use_syslog``
- ``None``
* - ``[hyperv] force_volumeutils_v1``

643
doc/config-reference/source/tables/conf-changes/cinder.rst
View File

@ -1,4 +1,4 @@
New, updated, and deprecated options in Mitaka for Block Storage
New, updated, and deprecated options in Newton for Block Storage
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
@ -12,280 +12,268 @@ New, updated, and deprecated options in Mitaka for Block Storage
* - Option = default value
- (Type) Help string
* - ``[DEFAULT] backup_gcs_block_size = 32768``
- (IntOpt) The size in bytes that changes are tracked for incremental backups. backup_gcs_object_size has to be multiple of backup_gcs_block_size.
* - ``[DEFAULT] backup_gcs_bucket = None``
- (StrOpt) The GCS bucket to use.
* - ``[DEFAULT] backup_gcs_bucket_location = US``
- (StrOpt) Location of GCS bucket.
* - ``[DEFAULT] backup_gcs_credential_file = None``
- (StrOpt) Absolute path of GCS service account credential file.
* - ``[DEFAULT] backup_gcs_enable_progress_timer = True``
- (BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the GCS backend storage. The default value is True to enable the timer.
* - ``[DEFAULT] backup_gcs_num_retries = 3``
- (IntOpt) Number of times to retry.
* - ``[DEFAULT] backup_gcs_object_size = 52428800``
- (IntOpt) The size in bytes of GCS backup objects.
* - ``[DEFAULT] backup_gcs_project_id = None``
- (StrOpt) Owner project id for GCS bucket.
* - ``[DEFAULT] backup_gcs_reader_chunk_size = 2097152``
- (IntOpt) GCS object will be downloaded in chunks of bytes.
* - ``[DEFAULT] backup_gcs_retry_error_codes = 429``
- (ListOpt) List of GCS error codes.
* - ``[DEFAULT] backup_gcs_storage_class = NEARLINE``
- (StrOpt) Storage class of GCS bucket.
* - ``[DEFAULT] backup_gcs_user_agent = gcscinder``
- (StrOpt) Http user-agent string for gcs api.
* - ``[DEFAULT] backup_gcs_writer_chunk_size = 2097152``
- (IntOpt) GCS object will be uploaded in chunks of bytes. Pass in a value of -1 if the file is to be uploaded as a single chunk.
* - ``[DEFAULT] backup_swift_auth_insecure = False``
- (BoolOpt) Bypass verification of server certificate when making SSL connection to Swift.
* - ``[DEFAULT] backup_swift_auth_url = None``
- (StrOpt) The URL of the Keystone endpoint
* - ``[DEFAULT] backup_use_same_host = False``
- (BoolOpt) Backup services use same backend.
* - ``[DEFAULT] cb_update_file_system = compression, sync, noofcopies, readonly``
- (ListOpt) These values will be used for CloudByte storage's updateFileSystem API call.
* - ``[DEFAULT] cb_update_qos_group = iops, latency, graceallowed``
- (ListOpt) These values will be used for CloudByte storage's updateQosGroup API call.
* - ``[DEFAULT] cinder_eternus_config_file = /etc/cinder/cinder_fujitsu_eternus_dx.xml``
- (StrOpt) config file for cinder eternus_dx volume driver
* - ``[DEFAULT] clone_check_timeout = 3600``
- (IntOpt) How long we check whether a clone is finished before we give up
* - ``[DEFAULT] coho_rpc_port = 2049``
- (IntOpt) RPC port to connect to Coha Data MicroArray
* - ``[DEFAULT] disco_client = 127.0.0.1``
- (IPOpt) The IP of DMS client socket server
* - ``[DEFAULT] disco_client_port = 9898``
- (PortOpt) The port to connect DMS client socket server
* - ``[DEFAULT] disco_wsdl_path = /etc/cinder/DISCOService.wsdl``
- (StrOpt) Path to the wsdl file to communicate with DISCO request manager
* - ``[DEFAULT] drbdmanage_devs_on_controller = True``
- (BoolOpt) If set, the c-vol node will receive a useable /dev/drbdX device, even if the actual data is stored on other nodes only. This is useful for debugging, maintenance, and to be able to do the iSCSI export from the c-vol node.
* - ``[DEFAULT] drbdmanage_resize_plugin = drbdmanage.plugins.plugins.wait_for.WaitForVolumeSize``
- (StrOpt) Volume resize completion wait plugin.
* - ``[DEFAULT] drbdmanage_resize_policy = {"timeout": "60"}``
- (StrOpt) Volume resize completion wait policy.
* - ``[DEFAULT] drbdmanage_resource_plugin = drbdmanage.plugins.plugins.wait_for.WaitForResource``
- (StrOpt) Resource deployment completion wait plugin.
* - ``[DEFAULT] drbdmanage_resource_policy = {"ratio": "0.51", "timeout": "60"}``
- (StrOpt) Resource deployment completion wait policy.
* - ``[DEFAULT] drbdmanage_snapshot_plugin = drbdmanage.plugins.plugins.wait_for.WaitForSnapshot``
- (StrOpt) Snapshot completion wait plugin.
* - ``[DEFAULT] drbdmanage_snapshot_policy = {"count": "1", "timeout": "60"}``
- (StrOpt) Snapshot completion wait policy.
* - ``[DEFAULT] driver_ssl_cert_path = None``
- (StrOpt) Can be used to specify a non default path to a CA_BUNDLE file or directory with certificates of trusted CAs, which will be used to validate the backend
* - ``[DEFAULT] enable_v3_api = True``
- (BoolOpt) Deploy v3 of the Cinder API.
* - ``[DEFAULT] additional_retry_list =``
- (StrOpt) FSS additional retry list, separate by ;
* - ``[DEFAULT] backup_swift_project = None``
- (StrOpt) Swift project/account name. Required when connecting to an auth 3.0 system
* - ``[DEFAULT] backup_swift_project_domain = None``
- (StrOpt) Swift project domain name. Required when connecting to an auth 3.0 system
* - ``[DEFAULT] backup_swift_user_domain = None``
- (StrOpt) Swift user domain name. Required when connecting to an auth 3.0 system
* - ``[DEFAULT] backup_use_temp_snapshot = False``
- (BoolOpt) If this is set to True, the backup_use_temp_snapshot path will be used during the backup. Otherwise, it will use backup_use_temp_volume path.
* - ``[DEFAULT] chap = disabled``
- (StrOpt) CHAP authentication mode, effective only for iscsi (disabled|enabled)
* - ``[DEFAULT] clone_volume_timeout = 680``
- (IntOpt) Create clone volume timeout.
* - ``[DEFAULT] cluster = None``
- (StrOpt) Name of this cluster. Used to group volume hosts that share the same backend configurations to work in HA Active-Active mode. Active-Active is not yet supported.
* - ``[DEFAULT] connection_type = iscsi``
- (StrOpt) Connection type to the IBM Storage Array
* - ``[DEFAULT] coprhd_emulate_snapshot = False``
- (BoolOpt) True | False to indicate if the storage array in CoprHD is VMAX or VPLEX
* - ``[DEFAULT] coprhd_hostname = None``
- (StrOpt) Hostname for the CoprHD Instance
* - ``[DEFAULT] coprhd_password = None``
- (StrOpt) Password for accessing the CoprHD Instance
* - ``[DEFAULT] coprhd_port = 4443``
- (PortOpt) Port for the CoprHD Instance
* - ``[DEFAULT] coprhd_project = None``
- (StrOpt) Project to utilize within the CoprHD Instance
* - ``[DEFAULT] coprhd_scaleio_rest_gateway_host = None``
- (StrOpt) Rest Gateway IP or FQDN for Scaleio
* - ``[DEFAULT] coprhd_scaleio_rest_gateway_port = 4984``
- (PortOpt) Rest Gateway Port for Scaleio
* - ``[DEFAULT] coprhd_scaleio_rest_server_password = None``
- (StrOpt) Rest Gateway Password
* - ``[DEFAULT] coprhd_scaleio_rest_server_username = None``
- (StrOpt) Username for Rest Gateway
* - ``[DEFAULT] coprhd_tenant = None``
- (StrOpt) Tenant to utilize within the CoprHD Instance
* - ``[DEFAULT] coprhd_username = None``
- (StrOpt) Username for accessing the CoprHD Instance
* - ``[DEFAULT] coprhd_varray = None``
- (StrOpt) Virtual Array to utilize within the CoprHD Instance
* - ``[DEFAULT] datera_503_interval = 5``
- (IntOpt) Interval between 503 retries
* - ``[DEFAULT] datera_503_timeout = 120``
- (IntOpt) Timeout for HTTP 503 retry messages
* - ``[DEFAULT] datera_acl_allow_all = False``
- (BoolOpt) True to set acl 'allow_all' on volumes created
* - ``[DEFAULT] datera_debug = False``
- (BoolOpt) True to set function arg and return logging
* - ``[DEFAULT] datera_debug_replica_count_override = False``
- (BoolOpt) ONLY FOR DEBUG/TESTING PURPOSES True to set replica_count to 1
* - ``[DEFAULT] default_group_type = None``
- (StrOpt) Default group type to use
* - ``[DEFAULT] dell_server_os = Red Hat Linux 6.x``
- (StrOpt) Server OS type to use when creating a new server on the Storage Center.
* - ``[DEFAULT] drbdmanage_disk_options = {"c-min-rate": "4M"}``
- (StrOpt) Disk options to set on new resources. See http://www.drbd.org/en/doc/users-guide-90/re-drbdconf for all the details.
* - ``[DEFAULT] drbdmanage_net_options = {"connect-int": "4", "allow-two-primaries": "yes", "ko-count": "30", "max-buffers": "20000", "ping-timeout": "100"}``
- (StrOpt) Net options to set on new resources. See http://www.drbd.org/en/doc/users-guide-90/re-drbdconf for all the details.
* - ``[DEFAULT] drbdmanage_resource_options = {"auto-promote-timeout": "300"}``
- (StrOpt) Resource options to set on new resources. See http://www.drbd.org/en/doc/users-guide-90/re-drbdconf for all the details.
* - ``[DEFAULT] dsware_isthin = False``
- (BoolOpt) The flag of thin storage allocation.
* - ``[DEFAULT] dsware_manager =``
- (StrOpt) Fusionstorage manager ip addr for cinder-volume.
* - ``[DEFAULT] enable_unsupported_driver = False``
- (BoolOpt) Set this to True when you want to allow an unsupported driver to start. Drivers that haven't maintained a working CI system and testing are marked as unsupported until CI is working again. This also marks a driver as deprecated and may be removed in the next release.
* - ``[DEFAULT] fss_debug = False``
- (BoolOpt) Enable HTTP debugging to FSS
* - ``[DEFAULT] fss_pool =``
- (IntOpt) FSS pool id in which FalconStor volumes are stored.
* - ``[DEFAULT] fusionstorageagent =``
- (StrOpt) Fusionstorage agent ip addr range.
* - ``[DEFAULT] glance_catalog_info = image:glance:publicURL``
- (StrOpt) Info to match when looking for glance in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if glance_api_servers are not provided.
* - ``[DEFAULT] hpe3par_api_url =``
- (StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1
* - ``[DEFAULT] hpe3par_cpg = OpenStack``
- (ListOpt) List of the CPG(s) to use for volume creation
* - ``[DEFAULT] hpe3par_cpg_snap =``
- (StrOpt) The CPG to use for Snapshots for volumes. If empty the userCPG will be used.
* - ``[DEFAULT] hpe3par_debug = False``
- (BoolOpt) Enable HTTP debugging to 3PAR
* - ``[DEFAULT] hpe3par_iscsi_chap_enabled = False``
- (BoolOpt) Enable CHAP authentication for iSCSI connections.
* - ``[DEFAULT] hpe3par_iscsi_ips =``
- (ListOpt) List of target iSCSI addresses to use.
* - ``[DEFAULT] hpe3par_password =``
- (StrOpt) 3PAR password for the user specified in hpe3par_username
* - ``[DEFAULT] hpe3par_snapshot_expiration =``
- (StrOpt) The time in hours when a snapshot expires and is deleted. This must be larger than expiration
* - ``[DEFAULT] hpe3par_snapshot_retention =``
- (StrOpt) The time in hours to retain a snapshot. You can't delete it before this expires.
* - ``[DEFAULT] hpe3par_username =``
- (StrOpt) 3PAR username with the 'edit' role
* - ``[DEFAULT] hpelefthand_api_url = None``
- (StrOpt) HPE LeftHand WSAPI Server Url like https://<LeftHand ip>:8081/lhos
* - ``[DEFAULT] hpelefthand_clustername = None``
- (StrOpt) HPE LeftHand cluster name
* - ``[DEFAULT] hpelefthand_debug = False``
- (BoolOpt) Enable HTTP debugging to LeftHand
* - ``[DEFAULT] hpelefthand_iscsi_chap_enabled = False``
- (BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled)
* - ``[DEFAULT] hpelefthand_password = None``
- (StrOpt) HPE LeftHand Super user password
* - ``[DEFAULT] hpelefthand_ssh_port = 16022``
- (PortOpt) Port number of SSH service.
* - ``[DEFAULT] hpelefthand_username = None``
- (StrOpt) HPE LeftHand Super user username
* - ``[DEFAULT] hpexp_async_copy_check_interval = 10``
- (IntOpt) Interval to check copy asynchronously
* - ``[DEFAULT] hpexp_compute_target_ports = None``
- (ListOpt) Target port names of compute node for host group or iSCSI target
* - ``[DEFAULT] hpexp_copy_check_interval = 3``
- (IntOpt) Interval to check copy
* - ``[DEFAULT] hpexp_copy_speed = 3``
- (IntOpt) Copy speed of storage system
* - ``[DEFAULT] hpexp_default_copy_method = FULL``
- (StrOpt) Default copy method of storage system. There are two valid values: "FULL" specifies that a full copy; "THIN" specifies that a thin copy. Default value is "FULL"
* - ``[DEFAULT] hpexp_group_request = False``
- (BoolOpt) Request for creating host group or iSCSI target
* - ``[DEFAULT] hpexp_horcm_add_conf = True``
- (BoolOpt) Add to HORCM configuration
* - ``[DEFAULT] hpexp_horcm_name_only_discovery = False``
- (BoolOpt) Only discover a specific name of host group or iSCSI target
* - ``[DEFAULT] hpexp_horcm_numbers = 200, 201``
- (ListOpt) Instance numbers for HORCM
* - ``[DEFAULT] hpexp_horcm_resource_name = meta_resource``
- (StrOpt) Resource group name of storage system for HORCM
* - ``[DEFAULT] hpexp_horcm_user = None``
- (StrOpt) Username of storage system for HORCM
* - ``[DEFAULT] hpexp_ldev_range = None``
- (StrOpt) Logical device range of storage system
* - ``[DEFAULT] hpexp_pool = None``
- (StrOpt) Pool of storage system
* - ``[DEFAULT] hpexp_storage_cli = None``
- (StrOpt) Type of storage command line interface
* - ``[DEFAULT] hpexp_storage_id = None``
- (StrOpt) ID of storage system
* - ``[DEFAULT] hpexp_target_ports = None``
- (ListOpt) Target port names for host group or iSCSI target
* - ``[DEFAULT] hpexp_thin_pool = None``
- (StrOpt) Thin pool of storage system
* - ``[DEFAULT] hpexp_zoning_request = False``
- (BoolOpt) Request for FC Zone creating host group
* - ``[DEFAULT] hypermetro_devices = None``
- (StrOpt) The remote device hypermetro will use.
* - ``[DEFAULT] keystone_catalog_info = identity:Identity Service:publicURL``
- (StrOpt) Info to match when looking for keystone in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if backup_swift_auth_url is unset
* - ``[DEFAULT] lvm_max_over_subscription_ratio = 1.0``
- (FloatOpt) max_over_subscription_ratio setting for the LVM driver. If set, this takes precedence over the general max_over_subscription_ratio option. If None, the general option is used.
* - ``[DEFAULT] nexenta_blocksize = 4096``
- (IntOpt) Block size for datasets
* - ``[DEFAULT] nexenta_chunksize = 16384``
- (IntOpt) NexentaEdge iSCSI LUN object chunk size
* - ``[DEFAULT] nexenta_client_address =``
- (StrOpt) NexentaEdge iSCSI Gateway client address for non-VIP service
* - ``[DEFAULT] nexenta_dataset_compression = on``
- (StrOpt) Compression value for new ZFS folders.
* - ``[DEFAULT] nexenta_dataset_dedup = off``
- (StrOpt) Deduplication value for new ZFS folders.
* - ``[DEFAULT] nexenta_dataset_description =``
- (StrOpt) Human-readable description for the folder.
* - ``[DEFAULT] nexenta_host =``
- (StrOpt) IP address of Nexenta SA
* - ``[DEFAULT] nexenta_iscsi_service =``
- (StrOpt) NexentaEdge iSCSI service name
* - ``[DEFAULT] nexenta_iscsi_target_portal_port = 3260``
- (IntOpt) Nexenta target portal port
* - ``[DEFAULT] nexenta_lun_container =``
- (StrOpt) NexentaEdge logical path of bucket for LUNs
* - ``[DEFAULT] nexenta_mount_point_base = $state_path/mnt``
- (StrOpt) Base directory that contains NFS share mount points
* - ``[DEFAULT] nexenta_nms_cache_volroot = True``
- (BoolOpt) If set True cache NexentaStor appliance volroot option value.
* - ``[DEFAULT] nexenta_ns5_blocksize = 32``
- (IntOpt) Block size for datasets
* - ``[DEFAULT] nexenta_password = nexenta``
- (StrOpt) Password to connect to Nexenta SA
* - ``[DEFAULT] nexenta_rest_address =``
- (StrOpt) IP address of NexentaEdge management REST API endpoint
* - ``[DEFAULT] nexenta_rest_password = nexenta``
- (StrOpt) Password to connect to NexentaEdge
* - ``[DEFAULT] nexenta_rest_port = 8080``
- (IntOpt) HTTP port to connect to Nexenta REST API server
* - ``[DEFAULT] nexenta_rest_protocol = auto``
- (StrOpt) Use http or https for REST connection (default auto)
* - ``[DEFAULT] nexenta_rest_user = admin``
- (StrOpt) User name to connect to NexentaEdge
* - ``[DEFAULT] nexenta_rrmgr_compression = 0``
- (IntOpt) Enable stream compression, level 1..9. 1 - gives best speed; 9 - gives best compression.
* - ``[DEFAULT] nexenta_rrmgr_connections = 2``
- (IntOpt) Number of TCP connections.
* - ``[DEFAULT] nexenta_rrmgr_tcp_buf_size = 4096``
- (IntOpt) TCP Buffer size in KiloBytes.
* - ``[DEFAULT] nexenta_shares_config = /etc/cinder/nfs_shares``
- (StrOpt) File with the list of available nfs shares
* - ``[DEFAULT] nexenta_sparse = False``
- (BoolOpt) Enables or disables the creation of sparse datasets
* - ``[DEFAULT] 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.
* - ``[DEFAULT] nexenta_target_group_prefix = cinder/``
- (StrOpt) Prefix for iSCSI target groups on SA
* - ``[DEFAULT] nexenta_target_prefix = iqn.1986-03.com.sun:02:cinder-``
- (StrOpt) IQN prefix for iSCSI targets
* - ``[DEFAULT] nexenta_user = admin``
- (StrOpt) User name to connect to Nexenta SA
* - ``[DEFAULT] nexenta_volume = cinder``
- (StrOpt) SA Pool that holds all volumes
* - ``[DEFAULT] nexenta_volume_group = iscsi``
- (StrOpt) Volume group for ns5
* - ``[DEFAULT] pure_automatic_max_oversubscription_ratio = True``
- (BoolOpt) Automatically determine an oversubscription ratio based on the current total data reduction values. If used this calculated value will override the max_over_subscription_ratio config option.
* - ``[DEFAULT] pure_eradicate_on_delete = False``
- (BoolOpt) When enabled, all Pure volumes, snapshots, and protection groups will be eradicated at the time of deletion in Cinder. Data will NOT be recoverable after a delete with this set to True! When disabled, volumes and snapshots will go into pending eradication state and can be recovered.
* - ``[DEFAULT] pure_replica_interval_default = 900``
- (IntOpt) Snapshot replication interval in seconds.
* - ``[DEFAULT] pure_replica_retention_long_term_default = 7``
- (IntOpt) Retain snapshots per day on target for this time (in days.)
* - ``[DEFAULT] pure_replica_retention_long_term_per_day_default = 3``
- (IntOpt) Retain how many snapshots for each day.
* - ``[DEFAULT] pure_replica_retention_short_term_default = 14400``
- (IntOpt) Retain all snapshots on target for this time (in seconds.)
* - ``[DEFAULT] replication_device = None``
- (MultiOpt) Multi opt of dictionaries to represent a replication target device. This option may be specified multiple times in a single config section to specify multiple replication target devices. Each entry takes the standard dict config form: replication_device = target_device_id:<required>,key1:value1,key2:value2...
* - ``[DEFAULT] report_discard_supported = False``
- (BoolOpt) Report to clients of Cinder that the backend supports discard (aka. trim/unmap). This will not actually change the behavior of the backend or the client directly, it will only notify that it can be used.
* - ``[DEFAULT] restore_check_timeout = 3600``
- (IntOpt) How long we check whether a restore is finished before we give up
* - ``[DEFAULT] retry_interval = 1``
- (IntOpt) How long we wait before retrying to get an item detail
* - ``[DEFAULT] sf_enable_vag = False``
- (BoolOpt) Utilize volume access groups on a per-tenant basis.
* - ``[DEFAULT] sf_volume_prefix = UUID-``
- (StrOpt) Create SolidFire volumes with this prefix. Volume names are of the form <sf_volume_prefix><cinder-volume-id>. The default is to use a prefix of 'UUID-'.
* - ``[DEFAULT] smbfs_allocation_info_file_path = $state_path/allocation_data``
- (StrOpt) The path of the automatically generated file containing information about volume disk space allocation.
* - ``[DEFAULT] snapshot_check_timeout = 3600``
- (IntOpt) How long we check whether a snapshot is finished before we give up
* - ``[DEFAULT] storwize_san_secondary_ip = None``
- (StrOpt) Specifies secondary management IP or hostname to be used if san_ip is invalid or becomes inaccessible.
* - ``[DEFAULT] storwize_svc_flashcopy_rate = 50``
- (IntOpt) Specifies the Storwize FlashCopy copy rate to be used when creating a full volume copy. The default is rate is 50, and the valid rates are 1-100.
* - ``[DEFAULT] storwize_svc_vol_nofmtdisk = False``
- (BoolOpt) Specifies that the volume not be formatted during creation.
* - ``[DEFAULT] suppress_requests_ssl_warnings = False``
- (BoolOpt) Suppress requests library SSL certificate warnings.
* - ``[DEFAULT] tegile_default_pool = None``
- (StrOpt) Create volumes in this pool
* - ``[DEFAULT] tegile_default_project = None``
- (StrOpt) Create volumes in this project
* - ``[DEFAULT] tintri_image_cache_expiry_days = 30``
- (IntOpt) Delete unused image snapshots older than mentioned days
* - ``[DEFAULT] tintri_image_shares_config = None``
- (StrOpt) Path to image nfs shares file
* - ``[DEFAULT] volume_name_prefix = openstack-``
- (StrOpt) Prefix before volume name to differenciate DISCO volume created through openstack and the other ones
* - ``[DEFAULT] xtremio_volumes_per_glance_cache = 100``
- (IntOpt) Number of volumes created from each cached glance image
* - ``[DEFAULT] zfssa_manage_policy = loose``
- (StrOpt) Driver policy for volume manage.
* - ``[BRCD_FABRIC_EXAMPLE] fc_fabric_ssh_cert_path =``
- (StrOpt) Local SSH certificate Path.
* - ``[BRCD_FABRIC_EXAMPLE] fc_southbound_protocol = HTTP``
- (StrOpt) South bound connector for the fabric.
* - ``[BRCD_FABRIC_EXAMPLE] fc_virtual_fabric_id = None``
- (StrOpt) Virtual Fabric ID.
* - ``[coordination] backend_url = file://$state_path``
- (StrOpt) The backend URL to use for distributed coordination.
* - ``[coordination] heartbeat = 1.0``
- (FloatOpt) Number of seconds between heartbeats for distributed coordination.
* - ``[coordination] initial_reconnect_backoff = 0.1``
- (FloatOpt) Initial number of seconds to wait after failed reconnection.
* - ``[coordination] max_reconnect_backoff = 60.0``
- (FloatOpt) Maximum number of seconds between sequential reconnection retries.
* - ``[hyperv] force_volumeutils_v1 = False``
- (BoolOpt) DEPRECATED: Force V1 volume utility class
* - ``[profiler] enabled = False``
- (BoolOpt) Enables the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values: * True: Enables the feature * False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty.
* - ``[profiler] hmac_keys = SECRET_KEY``
- (StrOpt) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: <key1>[,<key2>,...<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project. Both "enabled" flag and "hmac_keys" config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources.
* - ``[DEFAULT] group_api_class = cinder.group.api.API``
- (StrOpt) The full class name of the group API class
* - ``[DEFAULT] hnas_chap_enabled = True``
- (BoolOpt) Whether the chap authentication is enabled in the iSCSI target or not.
* - ``[DEFAULT] hnas_cluster_admin_ip0 = None``
- (StrOpt) The IP of the HNAS cluster admin. Required only for HNAS multi-cluster setups.
* - ``[DEFAULT] hnas_mgmt_ip0 = None``
- (IPOpt) Management IP address of HNAS. This can be any IP in the admin address on HNAS or the SMU IP.
* - ``[DEFAULT] hnas_password = None``
- (StrOpt) HNAS password.
* - ``[DEFAULT] hnas_ssc_cmd = ssc``
- (StrOpt) Command to communicate to HNAS.
* - ``[DEFAULT] hnas_ssh_port = 22``
- (PortOpt) Port to be used for SSH authentication.
* - ``[DEFAULT] hnas_ssh_private_key = None``
- (StrOpt) Path to the SSH private key used to authenticate in HNAS SMU.
* - ``[DEFAULT] hnas_svc0_hdp = None``
- (StrOpt) Service 0 HDP
* - ``[DEFAULT] hnas_svc0_iscsi_ip = None``
- (IPOpt) Service 0 iSCSI IP
* - ``[DEFAULT] hnas_svc0_volume_type = None``
- (StrOpt) Service 0 volume type
* - ``[DEFAULT] hnas_svc1_hdp = None``
- (StrOpt) Service 1 HDP
* - ``[DEFAULT] hnas_svc1_iscsi_ip = None``
- (IPOpt) Service 1 iSCSI IP
* - ``[DEFAULT] hnas_svc1_volume_type = None``
- (StrOpt) Service 1 volume type
* - ``[DEFAULT] hnas_svc2_hdp = None``
- (StrOpt) Service 2 HDP
* - ``[DEFAULT] hnas_svc2_iscsi_ip = None``
- (IPOpt) Service 2 iSCSI IP
* - ``[DEFAULT] hnas_svc2_volume_type = None``
- (StrOpt) Service 2 volume type
* - ``[DEFAULT] hnas_svc3_hdp = None``
- (StrOpt) Service 3 HDP
* - ``[DEFAULT] hnas_svc3_iscsi_ip = None``
- (IPOpt) Service 3 iSCSI IP
* - ``[DEFAULT] hnas_svc3_volume_type = None``
- (StrOpt) Service 3 volume type
* - ``[DEFAULT] hnas_username = None``
- (StrOpt) HNAS username.
* - ``[DEFAULT] kaminario_nodedup_substring = K2-nodedup``
- (StrOpt) If volume-type name contains this substring nodedup volume will be created, otherwise dedup volume wil be created.
* - ``[DEFAULT] lvm_suppress_fd_warnings = False``
- (BoolOpt) Suppress leaked file descriptor warnings in LVM commands.
* - ``[DEFAULT] message_ttl = 2592000``
- (IntOpt) message minimum life in seconds.
* - ``[DEFAULT] metro_domain_name = None``
- (StrOpt) The remote metro device domain name.
* - ``[DEFAULT] metro_san_address = None``
- (StrOpt) The remote metro device request url.
* - ``[DEFAULT] metro_san_password = None``
- (StrOpt) The remote metro device san password.
* - ``[DEFAULT] metro_san_user = None``
- (StrOpt) The remote metro device san user.
* - ``[DEFAULT] metro_storage_pools = None``
- (StrOpt) The remote metro device pool names.
* - ``[DEFAULT] nas_host =``
- (StrOpt) IP address or Hostname of NAS system.
* - ``[DEFAULT] netapp_replication_aggregate_map = None``
- (MultiOpt) Multi opt of dictionaries to represent the aggregate mapping between source and destination back ends when using whole back end replication. For every source aggregate associated with a cinder pool (NetApp FlexVol), you would need to specify the destination aggregate on the replication target device. A replication target device is configured with the configuration option replication_device. Specify this option as many times as you have replication devices. Each entry takes the standard dict config form: netapp_replication_aggregate_map = backend_id:<name_of_replication_device_section>,src_aggr_name1:dest_aggr_name1,src_aggr_name2:dest_aggr_name2,...
* - ``[DEFAULT] netapp_snapmirror_quiesce_timeout = 3600``
- (IntOpt) The maximum time in seconds to wait for existing SnapMirror transfers to complete before aborting during a failover.
* - ``[DEFAULT] nexenta_nbd_symlinks_dir = /dev/disk/by-path``
- (StrOpt) NexentaEdge logical path of directory to store symbolic links to NBDs
* - ``[DEFAULT] osapi_volume_use_ssl = False``
- (BoolOpt) Wraps the socket in a SSL context if True is set. A certificate file and key file must be specified.
* - ``[DEFAULT] pool_id_filter =``
- (ListOpt) Pool id permit to use.
* - ``[DEFAULT] pool_type = default``
- (StrOpt) Pool type, like sata-2copy.
* - ``[DEFAULT] proxy = storage.proxy.IBMStorageProxy``
- (StrOpt) Proxy driver that connects to the IBM Storage Array
* - ``[DEFAULT] quota_groups = 10``
- (IntOpt) Number of groups allowed per project
* - ``[DEFAULT] scaleio_server_certificate_path = None``
- (StrOpt) Server certificate path
* - ``[DEFAULT] scaleio_verify_server_certificate = False``
- (BoolOpt) verify server certificate
* - ``[DEFAULT] scheduler_weight_handler = cinder.scheduler.weights.OrderedHostWeightHandler``
- (StrOpt) Which handler to use for selecting the host/pool after weighing
* - ``[DEFAULT] secondary_san_ip =``
- (StrOpt) IP address of secondary DSM controller
* - ``[DEFAULT] secondary_san_login = Admin``
- (StrOpt) Secondary DSM user name
* - ``[DEFAULT] secondary_san_password =``
- (StrOpt) Secondary DSM user password name
* - ``[DEFAULT] secondary_sc_api_port = 3033``
- (PortOpt) Secondary Dell API port
* - ``[DEFAULT] sio_max_over_subscription_ratio = 10.0``
- (FloatOpt) max_over_subscription_ratio setting for the ScaleIO driver. This replaces the general max_over_subscription_ratio which has no effect in this driver.Maximum value allowed for ScaleIO is 10.0.
* - ``[DEFAULT] storage_protocol = iscsi``
- (StrOpt) Protocol for transferring data between host and storage back-end.
* - ``[DEFAULT] synology_admin_port = 5000``
- (PortOpt) Management port for Synology storage.
* - ``[DEFAULT] synology_device_id = None``
- (StrOpt) Device id for skip one time password check for logging in Synology storage if OTP is enabled.
* - ``[DEFAULT] synology_one_time_pass = None``
- (StrOpt) One time password of administrator for logging in Synology storage if OTP is enabled.
* - ``[DEFAULT] synology_password =``
- (StrOpt) Password of administrator for logging in Synology storage.
* - ``[DEFAULT] synology_pool_name =``
- (StrOpt) Volume on Synology storage to be used for creating lun.
* - ``[DEFAULT] synology_ssl_verify = True``
- (BoolOpt) Do certificate validation or not if $driver_use_ssl is True
* - ``[DEFAULT] synology_username = admin``
- (StrOpt) Administrator of Synology storage.
* - ``[DEFAULT] violin_dedup_capable_pools =``
- (ListOpt) Storage pools capable of dedup and other luns.(Comma separated list)
* - ``[DEFAULT] violin_dedup_only_pools =``
- (ListOpt) Storage pools to be used to setup dedup luns only.(Comma separated list)
* - ``[DEFAULT] violin_iscsi_target_ips =``
- (ListOpt) Target iSCSI addresses to use.(Comma separated list)
* - ``[DEFAULT] violin_pool_allocation_method = random``
- (StrOpt) Method of choosing a storage pool for a lun.
* - ``[DEFAULT] vzstorage_default_volume_format = raw``
- (StrOpt) Default format that will be used when creating volumes if no volume format is specified.
* - ``[DEFAULT] zadara_default_snap_policy = False``
- (BoolOpt) VPSA - Attach snapshot policy for volumes
* - ``[DEFAULT] zadara_password = None``
- (StrOpt) VPSA - Password
* - ``[DEFAULT] zadara_use_iser = True``
- (BoolOpt) VPSA - Use ISER instead of iSCSI
* - ``[DEFAULT] zadara_user = None``
- (StrOpt) VPSA - Username
* - ``[DEFAULT] zadara_vol_encrypt = False``
- (BoolOpt) VPSA - Default encryption policy for volumes
* - ``[DEFAULT] zadara_vol_name_template = OS_%s``
- (StrOpt) VPSA - Default template for VPSA volume names
* - ``[DEFAULT] zadara_vpsa_host = None``
- (StrOpt) VPSA - Management Host name or IP address
* - ``[DEFAULT] zadara_vpsa_poolname = None``
- (StrOpt) VPSA - Storage Pool assigned for volumes
* - ``[DEFAULT] zadara_vpsa_port = None``
- (PortOpt) VPSA - Port number
* - ``[DEFAULT] zadara_vpsa_use_ssl = False``
- (BoolOpt) VPSA - Use SSL connection
* - ``[DEFAULT] zteAheadReadSize = 8``
- (IntOpt) Cache readahead size.
* - ``[DEFAULT] zteCachePolicy = 1``
- (IntOpt) Cache policy. 0, Write Back; 1, Write Through.
* - ``[DEFAULT] zteChunkSize = 4``
- (IntOpt) Virtual block size of pool. Unit : KB. Valid value : 4, 8, 16, 32, 64, 128, 256, 512.
* - ``[DEFAULT] zteControllerIP0 = None``
- (IPOpt) Main controller IP.
* - ``[DEFAULT] zteControllerIP1 = None``
- (IPOpt) Slave controller IP.
* - ``[DEFAULT] zteLocalIP = None``
- (IPOpt) Local IP.
* - ``[DEFAULT] ztePoolVoAllocatedPolicy = 0``
- (IntOpt) Pool volume allocated policy. 0, Auto; 1, High Performance Tier First; 2, Performance Tier First; 3, Capacity Tier First.
* - ``[DEFAULT] ztePoolVolAlarmStopAllocatedFlag = 0``
- (IntOpt) Pool volume alarm stop allocated flag.
* - ``[DEFAULT] ztePoolVolAlarmThreshold = 0``
- (IntOpt) Pool volume alarm threshold. [0, 100]
* - ``[DEFAULT] ztePoolVolInitAllocatedCapacity = 0``
- (IntOpt) Pool volume init allocated Capacity.Unit : KB.
* - ``[DEFAULT] ztePoolVolIsThin = False``
- (IntOpt) Whether it is a thin volume.
* - ``[DEFAULT] ztePoolVolMovePolicy = 0``
- (IntOpt) Pool volume move policy.0, Auto; 1, Highest Available; 2, Lowest Available; 3, No Relocation.
* - ``[DEFAULT] zteSSDCacheSwitch = 1``
- (IntOpt) SSD cache switch. 0, OFF; 1, ON.
* - ``[DEFAULT] zteStoragePool =``
- (ListOpt) Pool name list.
* - ``[DEFAULT] zteUserName = None``
- (StrOpt) User name.
* - ``[DEFAULT] zteUserPassword = None``
- (StrOpt) User password.
* - ``[barbican] auth_endpoint = http://localhost:5000/v3``
- (StrOpt) Use this endpoint to connect to Keystone
* - ``[barbican] barbican_api_version = None``
- (StrOpt) Version of the Barbican API, for example: "v1"
* - ``[barbican] barbican_endpoint = None``
- (StrOpt) Use this endpoint to connect to Barbican, for example: "http://localhost:9311/"
* - ``[barbican] number_of_retries = 60``
- (IntOpt) Number of times to retry poll for key creation completion
* - ``[barbican] retry_delay = 1``
- (IntOpt) Number of seconds to wait before retrying poll for key creation completion
* - ``[fc-zone-manager] enable_unsupported_driver = False``
- (BoolOpt) Set this to True when you want to allow an unsupported zone manager driver to start. Drivers that haven't maintained a working CI system and testing are marked as unsupported until CI is working again. This also marks a driver as deprecated and may be removed in the next release.
* - ``[key_manager] api_class = castellan.key_manager.barbican_key_manager.BarbicanKeyManager``
- (StrOpt) The full class name of the key manager API class
* - ``[key_manager] fixed_key = None``
- (StrOpt) Fixed key returned by key manager, specified in hex
.. list-table:: New default values
:header-rows: 1
@ -294,27 +282,36 @@ New, updated, and deprecated options in Mitaka for Block Storage
* - Option
- Previous default value
- New default value
* - ``[DEFAULT] datera_api_version``
- ``1``
- ``2``
* - ``[DEFAULT] backup_service_inithost_offload``
- ``False``
- ``True``
* - ``[DEFAULT] datera_num_replicas``
- ``3``
- ``1``
- ``3``
* - ``[DEFAULT] default_timeout``
- ``525600``
- ``31536000``
* - ``[DEFAULT] glance_api_servers``
- ``$glance_host:$glance_port``
- ``None``
* - ``[DEFAULT] io_port_list``
- ``*``
- ``None``
* - ``[DEFAULT] iscsi_initiators``
-
- ``None``
* - ``[DEFAULT] naviseccli_path``
-
- ``None``
* - ``[DEFAULT] nexenta_chunksize``
- ``16384``
- ``32768``
* - ``[DEFAULT] query_volume_filters``
- ``name, status, metadata, availability_zone``
- ``name, status, metadata, availability_zone, bootable``
* - ``[DEFAULT] zoning_mode``
- ``none``
- ``None``
* - ``[BRCD_FABRIC_EXAMPLE] zone_name_prefix``
- ``None``
- ``openstack``
* - ``[fc-zone-manager] brcd_sb_connector``
- ``cinder.zonemanager.drivers.brocade.brcd_fc_zone_client_cli.BrcdFCZoneClientCLI``
- ``HTTP``
- ``name, status, metadata, availability_zone, bootable, group_id``
* - ``[DEFAULT] vmware_task_poll_interval``
- ``0.5``
- ``2.0``
.. list-table:: Deprecated options
:header-rows: 1
@ -334,80 +331,12 @@ New, updated, and deprecated options in Mitaka for Block Storage
- ``[DEFAULT] use_chap_auth``
* - ``[DEFAULT] host``
- ``[DEFAULT] backend_host``
* - ``[DEFAULT] hp3par_api_url``
- ``[DEFAULT] hpe3par_api_url``
* - ``[DEFAULT] hp3par_cpg``
- ``[DEFAULT] hpe3par_cpg``
* - ``[DEFAULT] hp3par_cpg_snap``
- ``[DEFAULT] hpe3par_cpg_snap``
* - ``[DEFAULT] hp3par_debug``
- ``[DEFAULT] hpe3par_debug``
* - ``[DEFAULT] hp3par_iscsi_chap_enabled``
- ``[DEFAULT] hpe3par_iscsi_chap_enabled``
* - ``[DEFAULT] hp3par_iscsi_ips``
- ``[DEFAULT] hpe3par_iscsi_ips``
* - ``[DEFAULT] hp3par_password``
- ``[DEFAULT] hpe3par_password``
* - ``[DEFAULT] hp3par_snapshot_expiration``
- ``[DEFAULT] hpe3par_snapshot_expiration``
* - ``[DEFAULT] hp3par_snapshot_retention``
- ``[DEFAULT] hpe3par_snapshot_retention``
* - ``[DEFAULT] hp3par_username``
- ``[DEFAULT] hpe3par_username``
* - ``[DEFAULT] hplefthand_api_url``
- ``[DEFAULT] hpelefthand_api_url``
* - ``[DEFAULT] hplefthand_clustername``
- ``[DEFAULT] hpelefthand_clustername``
* - ``[DEFAULT] hplefthand_debug``
- ``[DEFAULT] hpelefthand_debug``
* - ``[DEFAULT] hplefthand_iscsi_chap_enabled``
- ``[DEFAULT] hpelefthand_iscsi_chap_enabled``
* - ``[DEFAULT] hplefthand_password``
- ``[DEFAULT] hpelefthand_password``
* - ``[DEFAULT] hplefthand_username``
- ``[DEFAULT] hpelefthand_username``
* - ``[DEFAULT] hpxp_async_copy_check_interval``
- ``[DEFAULT] hpexp_async_copy_check_interval``
* - ``[DEFAULT] hpxp_compute_target_ports``
- ``[DEFAULT] hpexp_compute_target_ports``
* - ``[DEFAULT] hpxp_copy_check_interval``
- ``[DEFAULT] hpexp_copy_check_interval``
* - ``[DEFAULT] hpxp_copy_speed``
- ``[DEFAULT] hpexp_copy_speed``
* - ``[DEFAULT] hpxp_default_copy_method``
- ``[DEFAULT] hpexp_default_copy_method``
* - ``[DEFAULT] hpxp_group_request``
- ``[DEFAULT] hpexp_group_request``
* - ``[DEFAULT] hpxp_horcm_add_conf``
- ``[DEFAULT] hpexp_horcm_add_conf``
* - ``[DEFAULT] hpxp_horcm_name_only_discovery``
- ``[DEFAULT] hpexp_horcm_name_only_discovery``
* - ``[DEFAULT] hpxp_horcm_numbers``
- ``[DEFAULT] hpexp_horcm_numbers``
* - ``[DEFAULT] hpxp_horcm_resource_name``
- ``[DEFAULT] hpexp_horcm_resource_name``
* - ``[DEFAULT] hpxp_horcm_user``
- ``[DEFAULT] hpexp_horcm_user``
* - ``[DEFAULT] hpxp_ldev_range``
- ``[DEFAULT] hpexp_ldev_range``
* - ``[DEFAULT] hpxp_pool``
- ``[DEFAULT] hpexp_pool``
* - ``[DEFAULT] hpxp_storage_cli``
- ``[DEFAULT] hpexp_storage_cli``
* - ``[DEFAULT] hpxp_storage_id``
- ``[DEFAULT] hpexp_storage_id``
* - ``[DEFAULT] hpxp_target_ports``
- ``[DEFAULT] hpexp_target_ports``
* - ``[DEFAULT] hpxp_thin_pool``
- ``[DEFAULT] hpexp_thin_pool``
* - ``[DEFAULT] hpxp_zoning_request``
- ``[DEFAULT] hpexp_zoning_request``
* - ``[DEFAULT] nas_ip``
- ``[DEFAULT] nas_host``
* - ``[DEFAULT] osapi_max_request_body_size``
- ``[oslo_middleware] max_request_body_size``
* - ``[DEFAULT] use_syslog``
- ``None``
* - ``[hyperv] force_volumeutils_v1``
- ``None``
* - ``[profiler] profiler_enabled``
- ``[profiler] enabled``

51
doc/config-reference/source/tables/conf-changes/glance.rst
View File

@ -1,4 +1,4 @@
New, updated, and deprecated options in Mitaka for Image service
New, updated, and deprecated options in Newton for Image service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
@ -12,8 +12,10 @@ New, updated, and deprecated options in Mitaka for Image service
* - Option = default value
- (Type) Help string
* - ``[profiler] hmac_keys = SECRET_KEY``
- (StrOpt) Secret key to use to sign Glance API and Glance Registry services tracing messages.
* - ``[DEFAULT] secure_proxy_ssl_header = None``
- (StrOpt) The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is "HTTP_X_FORWARDED_PROTO".
* - ``[profiler] connection_string = messaging://``
- (StrOpt) Connection string for a notifier backend. Default value is messaging:// which sets the notifier to oslo_messaging. Examples of possible values: * messaging://: use oslo_messaging driver for sending notifications.
.. list-table:: New default values
:header-rows: 1
@ -22,15 +24,42 @@ New, updated, and deprecated options in Mitaka for Image service
* - Option
- Previous default value
- New default value
* - ``[DEFAULT] allowed_rpc_exception_modules``
- ``glance.common.exception, exceptions``
- ``glance.common.exception, builtins, exceptions``
* - ``[DEFAULT] workers``
- ``4``
* - ``[DEFAULT] ca_file``
- ``None``
* - ``[image_format] container_formats``
- ``ami, ari, aki, bare, ovf, ova``
- ``ami, ari, aki, bare, ovf, ova, docker``
- ``/etc/ssl/cafile``
* - ``[DEFAULT] cert_file``
- ``None``
- ``/etc/ssl/certs``
* - ``[DEFAULT] key_file``
- ``None``
- ``/etc/ssl/key/key-file.pem``
* - ``[DEFAULT] pydev_worker_debug_host``
- ``None``
- ``localhost``
* - ``[DEFAULT] registry_client_ca_file``
- ``None``
- ``/etc/ssl/cafile/file.ca``
* - ``[DEFAULT] registry_client_cert_file``
- ``None``
- ``/etc/ssl/certs/file.crt``
* - ``[DEFAULT] registry_client_key_file``
- ``None``
- ``/etc/ssl/key/key-file.pem``
* - ``[image_format] disk_formats``
- ``ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso``
- ``ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso``
* - ``[paste_deploy] config_file``
- ``None``
- ``glance-api-paste.ini``
* - ``[paste_deploy] flavor``
- ``None``
- ``keystone``
* - ``[task] work_dir``
- ``None``
- ``/work_dir``
* - ``[taskflow_executor] conversion_format``
- ``None``
- ``raw``
.. list-table:: Deprecated options
:header-rows: 1

72
doc/config-reference/source/tables/conf-changes/heat.rst
View File

@ -1,4 +1,4 @@
New, updated, and deprecated options in Mitaka for Orchestration
New, updated, and deprecated options in Newton for Orchestration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
@ -12,24 +12,38 @@ New, updated, and deprecated options in Mitaka for Orchestration
* - Option = default value
- (Type) Help string
* - ``[DEFAULT] client_retry_limit = 2``
- (IntOpt) Number of times to retry when a client encounters an expected intermittent error. Set to 0 to disable retries.
* - ``[DEFAULT] max_interface_check_attempts = 10``
- (IntOpt) Number of times to check whether an interface has been attached or detached.
* - ``[DEFAULT] observe_on_update = False``
- (BoolOpt) On update, enables heat to collect existing resource properties from reality and converge to updated template.
* - ``[profiler] enabled = False``
- (BoolOpt) Enables the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values: * True: Enables the feature * False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty.
* - ``[profiler] hmac_keys = SECRET_KEY``
- (StrOpt) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: <key1>[,<key2>,...<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project. Both "enabled" flag and "hmac_keys" config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources.
* - ``[resource_finder_cache] caching = True``
- (BoolOpt) Toggle to enable/disable caching when Orchestration Engine looks for other OpenStack service resources using name or id. Please note that the global toggle for oslo.cache(enabled=True in [cache] group) must be enabled to use this feature.
* - ``[resource_finder_cache] expiration_time = 3600``
- (IntOpt) TTL, in seconds, for any cached item in the dogpile.cache region used for caching of OpenStack service finder functions.
* - ``[service_extension_cache] caching = True``
- (BoolOpt) Toggle to enable/disable caching when Orchestration Engine retrieves extensions from other OpenStack services. Please note that the global toggle for oslo.cache(enabled=True in [cache] group) must be enabled to use this feature.
* - ``[service_extension_cache] expiration_time = 3600``
- (IntOpt) TTL, in seconds, for any cached item in the dogpile.cache region used for caching of service extensions.
* - ``[DEFAULT] max_server_name_length = 53``
- (IntOpt) Maximum length of a server name to be used in nova.
* - ``[DEFAULT] template_dir = /etc/heat/templates``
- (StrOpt) The directory to search for template files.
* - ``[clients_aodh] ca_file = None``
- (StrOpt) Optional CA cert file to use in SSL connections.
* - ``[clients_aodh] cert_file = None``
- (StrOpt) Optional PEM-formatted certificate chain file.
* - ``[clients_aodh] endpoint_type = None``
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
* - ``[clients_aodh] insecure = None``
- (BoolOpt) If set, then the server's certificate will not be verified.
* - ``[clients_aodh] key_file = None``
- (StrOpt) Optional PEM-formatted file that contains the private key.
* - ``[clients_monasca] ca_file = None``
- (StrOpt) Optional CA cert file to use in SSL connections.
* - ``[clients_monasca] cert_file = None``
- (StrOpt) Optional PEM-formatted certificate chain file.
* - ``[clients_monasca] endpoint_type = None``
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
* - ``[clients_monasca] insecure = None``
- (BoolOpt) If set, then the server's certificate will not be verified.
* - ``[clients_monasca] key_file = None``
- (StrOpt) Optional PEM-formatted file that contains the private key.
* - ``[trustee] auth_type = None``
- (Opt) Authentication type to load
* - ``[volumes] backups_enabled = True``
- (BoolOpt) Indicate if cinder-backup service is enabled. This is a temporary workaround until cinder-backup service becomes discoverable, see LP#1334856.
* - ``[yaql] limit_iterators = 200``
- (IntOpt) The maximum number of elements in collection expression can take for its evaluation.
* - ``[yaql] memory_quota = 10000``
- (IntOpt) The maximum size of memory in bytes that expression can take for its evaluation.
.. list-table:: New default values
:header-rows: 1
@ -38,18 +52,12 @@ New, updated, and deprecated options in Mitaka for Orchestration
* - Option
- Previous default value
- New default value
* - ``[DEFAULT] heat_metadata_server_url``
-
- ``None``
* - ``[heat_api] workers``
- ``4``
- ``0``
* - ``[heat_api_cfn] workers``
- ``0``
- ``1``
* - ``[heat_api_cloudwatch] workers``
- ``0``
- ``1``
* - ``[DEFAULT] convergence_engine``
- ``False``
- ``True``
* - ``[DEFAULT] keystone_backend``
- ``heat.common.heat_keystoneclient.KeystoneClientV3``
- ``heat.engine.clients.os.keystone.heat_keystoneclient.KsClientWrapper``
.. list-table:: Deprecated options
:header-rows: 1
@ -59,6 +67,4 @@ New, updated, and deprecated options in Mitaka for Orchestration
- New Option
* - ``[DEFAULT] use_syslog``
- ``None``
* - ``[profiler] profiler_enabled``
- ``[profiler] enabled``

291
doc/config-reference/source/tables/conf-changes/ironic.rst
View File

@ -1,4 +1,4 @@
New, updated, and deprecated options in Mitaka for Bare Metal service
New, updated, and deprecated options in Newton for Bare Metal service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
@ -12,71 +12,184 @@ New, updated, and deprecated options in Mitaka for Bare Metal service
* - Option = default value
- (Type) Help string
* - ``[DEFAULT] debug_tracebacks_in_api = False``
- (BoolOpt) Return server tracebacks in the API response for any error responses. WARNING: this is insecure and should not be used in a production environment.
* - ``[DEFAULT] hash_ring_reset_interval = 180``
- (IntOpt) Interval (in seconds) between hash ring resets.
* - ``[agent] stream_raw_images = True``
- (BoolOpt) Whether the agent ramdisk should stream raw images directly onto the disk or not. By streaming raw images directly onto the disk the agent ramdisk will not spend time copying the image to a tmpfs partition (therefore consuming less memory) prior to writing it to the disk. Unless the disk where the image will be copied to is really slow, this option should be set to True. Defaults to True.
* - ``[amt] awake_interval = 60``
- (IntOpt) Time interval (in seconds) for successive awake call to AMT interface, this depends on the IdleTimeout setting on AMT interface. AMT Interface will go to sleep after 60 seconds of inactivity by default. IdleTimeout=0 means AMT will not go to sleep at all. Setting awake_interval=0 will disable awake call.
* - ``[api] api_workers = None``
- (IntOpt) Number of workers for OpenStack Ironic API service. The default is equal to the number of CPUs available if that can be determined, else a default worker count of 1 is returned.
* - ``[api] enable_ssl_api = False``
- (BoolOpt) Enable the integrated stand-alone API to service requests via HTTPS instead of HTTP. If there is a front-end service performing HTTPS offloading from the service, this option should be False; note, you will want to change public API endpoint to represent SSL termination URL with 'public_endpoint' option.
* - ``[conductor] automated_clean = True``
- (BoolOpt) Enables or disables automated cleaning. Automated cleaning is a configurable set of steps, such as erasing disk drives, that are performed on the node to ensure it is in a baseline state and ready to be deployed to. This is done after instance deletion as well as during the transition from a "manageable" to "available" state. When enabled, the particular steps performed to clean a node depend on which driver that node is managed by; see the individual driver's documentation for details. NOTE: The introduction of the cleaning operation causes instance deletion to take significantly longer. In an environment where all tenants are trusted (eg, because there is only one tenant), this option could be safely disabled.
* - ``[disk_utils] dd_block_size = 1M``
- (StrOpt) Block size to use when writing to the nodes disk.
* - ``[disk_utils] efi_system_partition_size = 200``
- (IntOpt) Size of EFI system partition in MiB when configuring UEFI systems for local boot.
* - ``[disk_utils] iscsi_verify_attempts = 3``
- (IntOpt) Maximum attempts to verify an iSCSI connection is active, sleeping 1 second between attempts.
* - ``[glance] glance_cafile = None``
- (StrOpt) Optional path to a CA certificate bundle to be used to validate the SSL certificate served by glance. It is used when glance_api_insecure is set to False.
* - ``[glance] swift_temp_url_cache_enabled = False``
- (BoolOpt) Whether to cache generated Swift temporary URLs. Setting it to true is only useful when an image caching proxy is used. Defaults to False.
* - ``[glance] swift_temp_url_expected_download_start_delay = 0``
- (IntOpt) This is the delay (in seconds) from the time of the deploy request (when the Swift temporary URL is generated) to when the IPA ramdisk starts up and URL is used for the image download. This value is used to check if the Swift temporary URL duration is large enough to let the image download begin. Also if temporary URL caching is enabled this will determine if a cached entry will still be valid when the download starts. swift_temp_url_duration value must be greater than or equal to this option's value. Defaults to 0.
* - ``[glance] temp_url_endpoint_type = swift``
- (StrOpt) Type of endpoint to use for temporary URLs. If the Glance backend is Swift, use "swift"; if it is CEPH with RADOS gateway, use "radosgw".
* - ``[iboot] reboot_delay = 5``
- (IntOpt) Time (in seconds) to sleep between when rebooting (powering off and on again).
* - ``[irmc] snmp_community = public``
- (StrOpt) SNMP community. Required for versions "v1" and "v2c"
* - ``[irmc] snmp_port = 161``
- (PortOpt) SNMP port
* - ``[irmc] snmp_security = None``
- (StrOpt) SNMP security name. Required for version "v3"
* - ``[irmc] snmp_version = v2c``
- (StrOpt) SNMP protocol version
* - ``[ironic_lib] fatal_exception_format_errors = False``
- (BoolOpt) Make exception message format errors fatal.
* - ``[ironic_lib] root_helper = sudo ironic-rootwrap /etc/ironic/rootwrap.conf``
- (StrOpt) Command that is prefixed to commands that are run as root. If not specified, no commands are run as root.
* - ``[oneview] allow_insecure_connections = False``
- (BoolOpt) Option to allow insecure connection with OneView
* - ``[oneview] manager_url = None``
- (StrOpt) URL where OneView is available
* - ``[oneview] max_polling_attempts = 12``
- (IntOpt) Max connection retries to check changes on OneView
* - ``[oneview] password = None``
- (StrOpt) OneView password to be used
* - ``[oneview] tls_cacert_file = None``
- (StrOpt) Path to CA certificate
* - ``[oneview] username = None``
- (StrOpt) OneView username to be used
* - ``[pxe] ip_version = 4``
- (StrOpt) The IP version that will be used for PXE booting. Defaults to 4. EXPERIMENTAL
* - ``[pxe] ipxe_timeout = 0``
- (IntOpt) Timeout value (in seconds) for downloading an image via iPXE. Defaults to 0 (no timeout)
* - ``[snmp] reboot_delay = 0``
- (IntOpt) Time (in seconds) to sleep between when rebooting (powering off and on again)
* - ``[ssh] get_vm_name_attempts = 3``
- (IntOpt) Number of attempts to try to get VM name used by the host that corresponds to a node's MAC address.
* - ``[ssh] get_vm_name_retry_interval = 3``
- (IntOpt) Number of seconds to wait between attempts to get VM name used by the host that corresponds to a node's MAC address.
* - ``[DEFAULT] default_network_interface = None``
- (StrOpt) Default network interface to be used for nodes that do not have network_interface field set. A complete list of network interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.network" entrypoint.
* - ``[DEFAULT] enabled_network_interfaces = flat, noop``
- (ListOpt) Specify the list of network interfaces to load during service initialization. Missing network interfaces, or network interfaces which fail to initialize, will prevent the conductor service from starting. The option default is a recommended set of production-oriented network interfaces. A complete list of network interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.network" entrypoint. This value must be the same on all ironic-conductor and ironic-api services, because it is used by ironic-api service to validate a new or updated node's network_interface value.
* - ``[DEFAULT] notification_level = None``
- (StrOpt) Specifies the minimum level for which to send notifications. If not set, no notifications will be sent. The default is for this option to be unset.
* - ``[agent] deploy_logs_collect = on_failure``
- (StrOpt) Whether Ironic should collect the deployment logs on deployment failure (on_failure), always or never.
* - ``[agent] deploy_logs_local_path = /var/log/ironic/deploy``
- (StrOpt) The path to the directory where the logs should be stored, used when the deploy_logs_storage_backend is configured to "local".
* - ``[agent] deploy_logs_storage_backend = local``
- (StrOpt) The name of the storage backend where the logs will be stored.
* - ``[agent] deploy_logs_swift_container = ironic_deploy_logs_container``
- (StrOpt) The name of the Swift container to store the logs, used when the deploy_logs_storage_backend is configured to "swift".
* - ``[agent] deploy_logs_swift_days_to_expire = 30``
- (IntOpt) Number of days before a log object is marked as expired in Swift. If None, the logs will be kept forever or until manually deleted. Used when the deploy_logs_storage_backend is configured to "swift".
* - ``[api] ramdisk_heartbeat_timeout = 300``
- (IntOpt) Maximum interval (in seconds) for agent heartbeats.
* - ``[api] restrict_lookup = True``
- (BoolOpt) Whether to restrict the lookup API to only nodes in certain states.
* - ``[audit] audit_map_file = /etc/ironic/ironic_api_audit_map.conf``
- (StrOpt) Path to audit map file for ironic-api service. Used only when API audit is enabled.
* - ``[audit] enabled = False``
- (BoolOpt) Enable auditing of API requests (for ironic-api service).
* - ``[audit] ignore_req_list = None``
- (StrOpt) Comma separated list of Ironic REST API HTTP methods to be ignored during audit. For example: auditing will not be done on any GET or POST requests if this is set to "GET,POST". It is used only when API audit is enabled.
* - ``[audit] namespace = openstack``
- (StrOpt) namespace prefix for generated id
* - ``[audit_middleware_notifications] driver = None``
- (StrOpt) The Driver to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop. If not specified, then value from oslo_messaging_notifications conf section is used.
* - ``[audit_middleware_notifications] topics = None``
- (ListOpt) List of AMQP topics used for OpenStack notifications. If not specified, then value from oslo_messaging_notifications conf section is used.
* - ``[audit_middleware_notifications] transport_url = None``
- (StrOpt) A URL representing messaging driver to use for notification. If not specified, we fall back to the same configuration used for RPC.
* - ``[deploy] continue_if_disk_secure_erase_fails = False``
- (BoolOpt) Defines what to do if an ATA secure erase operation fails during cleaning in the Ironic Python Agent. If False, the cleaning operation will fail and the node will be put in ``clean failed`` state. If True, shred will be invoked and cleaning will continue.
* - ``[deploy] erase_devices_metadata_priority = None``
- (IntOpt) Priority to run in-band clean step that erases metadata from devices, via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 99 for the GenericHardwareManager). If set to 0, will not run during cleaning.
* - ``[deploy] power_off_after_deploy_failure = True``
- (BoolOpt) Whether to power off a node after deploy failure. Defaults to True.
* - ``[deploy] shred_final_overwrite_with_zeros = True``
- (BoolOpt) Whether to write zeros to a node's block devices after writing random data. This will write zeros to the device even when deploy.shred_random_overwrite_iterations is 0. This option is only used if a device could not be ATA Secure Erased. Defaults to True.
* - ``[deploy] shred_random_overwrite_iterations = 1``
- (IntOpt) During shred, overwrite all block devices N times with random data. This is only used if a device could not be ATA Secure Erased. Defaults to 1.
* - ``[drac] query_raid_config_job_status_interval = 120``
- (IntOpt) Interval (in seconds) between periodic RAID job status checks to determine whether the asynchronous RAID configuration was successfully finished or not.
* - ``[glance] auth_section = None``
- (Opt) Config Section from which to load plugin specific options
* - ``[glance] auth_type = None``
- (Opt) Authentication type to load
* - ``[glance] cafile = None``
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
* - ``[glance] certfile = None``
- (StrOpt) PEM encoded client certificate cert file
* - ``[glance] insecure = False``
- (BoolOpt) Verify HTTPS connections.
* - ``[glance] keyfile = None``
- (StrOpt) PEM encoded client certificate key file
* - ``[glance] timeout = None``
- (IntOpt) Timeout value for http requests
* - ``[ilo] ca_file = None``
- (StrOpt) CA certificate file to validate iLO.
* - ``[ilo] default_boot_mode = auto``
- (StrOpt) Default boot mode to be used in provisioning when "boot_mode" capability is not provided in the "properties/capabilities" of the node. The default is "auto" for backward compatibility. When "auto" is specified, default boot mode will be selected based on boot mode settings on the system.
* - ``[inspector] auth_section = None``
- (Opt) Config Section from which to load plugin specific options
* - ``[inspector] auth_type = None``
- (Opt) Authentication type to load
* - ``[inspector] cafile = None``
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
* - ``[inspector] certfile = None``
- (StrOpt) PEM encoded client certificate cert file
* - ``[inspector] insecure = False``
- (BoolOpt) Verify HTTPS connections.
* - ``[inspector] keyfile = None``
- (StrOpt) PEM encoded client certificate key file
* - ``[inspector] timeout = None``
- (IntOpt) Timeout value for http requests
* - ``[iscsi] portal_port = 3260``
- (PortOpt) The port number on which the iSCSI portal listens for incoming connections.
* - ``[metrics] agent_backend = noop``
- (StrOpt) Backend for the agent ramdisk to use for metrics. Default possible backends are "noop" and "statsd".
* - ``[metrics] agent_global_prefix = None``
- (StrOpt) Prefix all metric names sent by the agent ramdisk with this value. The format of metric names is [global_prefix.][uuid.][host_name.]prefix.metric_name.
* - ``[metrics] agent_prepend_host = False``
- (BoolOpt) Prepend the hostname to all metric names sent by the agent ramdisk. The format of metric names is [global_prefix.][uuid.][host_name.]prefix.metric_name.
* - ``[metrics] agent_prepend_host_reverse = True``
- (BoolOpt) Split the prepended host value by "." and reverse it for metrics sent by the agent ramdisk (to better match the reverse hierarchical form of domain names).
* - ``[metrics] agent_prepend_uuid = False``
- (BoolOpt) Prepend the node's Ironic uuid to all metric names sent by the agent ramdisk. The format of metric names is [global_prefix.][uuid.][host_name.]prefix.metric_name.
* - ``[metrics] backend = noop``
- (StrOpt) Backend to use for the metrics system.
* - ``[metrics] global_prefix = None``
- (StrOpt) Prefix all metric names with this value. By default, there is no global prefix. The format of metric names is [global_prefix.][host_name.]prefix.metric_name.
* - ``[metrics] prepend_host = False``
- (BoolOpt) Prepend the hostname to all metric names. The format of metric names is [global_prefix.][host_name.]prefix.metric_name.
* - ``[metrics] prepend_host_reverse = True``
- (BoolOpt) Split the prepended host value by "." and reverse it (to better match the reverse hierarchical form of domain names).
* - ``[metrics_statsd] agent_statsd_host = localhost``
- (StrOpt) Host for the agent ramdisk to use with the statsd backend. This must be accessible from networks the agent is booted on.
* - ``[metrics_statsd] agent_statsd_port = 8125``
- (PortOpt) Port for the agent ramdisk to use with the statsd backend.
* - ``[metrics_statsd] statsd_host = localhost``
- (StrOpt) Host for use with the statsd backend.
* - ``[metrics_statsd] statsd_port = 8125``
- (PortOpt) Port to use with the statsd backend.
* - ``[neutron] auth_section = None``
- (Opt) Config Section from which to load plugin specific options
* - ``[neutron] auth_type = None``
- (Opt) Authentication type to load
* - ``[neutron] cafile = None``
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
* - ``[neutron] certfile = None``
- (StrOpt) PEM encoded client certificate cert file
* - ``[neutron] insecure = False``
- (BoolOpt) Verify HTTPS connections.
* - ``[neutron] keyfile = None``
- (StrOpt) PEM encoded client certificate key file
* - ``[neutron] port_setup_delay = 0``
- (IntOpt) Delay value to wait for Neutron agents to setup sufficient DHCP configuration for port.
* - ``[neutron] provisioning_network_uuid = None``
- (StrOpt) Neutron network UUID for the ramdisk to be booted into for provisioning nodes. Required for "neutron" network interface.
* - ``[neutron] timeout = None``
- (IntOpt) Timeout value for http requests
* - ``[oneview] enable_periodic_tasks = True``
- (BoolOpt) Whether to enable the periodic tasks for OneView driver be aware when OneView hardware resources are taken and released by Ironic or OneView users and proactively manage nodes in clean fail state according to Dynamic Allocation model of hardware resources allocation in OneView.
* - ``[oneview] periodic_check_interval = 300``
- (IntOpt) Period (in seconds) for periodic tasks to be executed when enable_periodic_tasks=True.
* - ``[pxe] ipxe_use_swift = False``
- (BoolOpt) Download deploy images directly from swift using temporary URLs. If set to false (default), images are downloaded to the ironic-conductor node and served over its local HTTP server. Applicable only when 'ipxe_enabled' option is set to true.
* - ``[service_catalog] auth_section = None``
- (Opt) Config Section from which to load plugin specific options
* - ``[service_catalog] auth_type = None``
- (Opt) Authentication type to load
* - ``[service_catalog] cafile = None``
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
* - ``[service_catalog] certfile = None``
- (StrOpt) PEM encoded client certificate cert file
* - ``[service_catalog] insecure = False``
- (BoolOpt) Verify HTTPS connections.
* - ``[service_catalog] keyfile = None``
- (StrOpt) PEM encoded client certificate key file
* - ``[service_catalog] timeout = None``
- (IntOpt) Timeout value for http requests
* - ``[swift] auth_section = None``
- (Opt) Config Section from which to load plugin specific options
* - ``[swift] auth_type = None``
- (Opt) Authentication type to load
* - ``[swift] cafile = None``
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
* - ``[swift] certfile = None``
- (StrOpt) PEM encoded client certificate cert file
* - ``[swift] insecure = False``
- (BoolOpt) Verify HTTPS connections.
* - ``[swift] keyfile = None``
- (StrOpt) PEM encoded client certificate key file
* - ``[swift] timeout = None``
- (IntOpt) Timeout value for http requests
.. list-table:: New default values
:header-rows: 1
:class: config-ref-table
* - Option
- Previous default value
- New default value
* - ``[DEFAULT] my_ip``
- ``10.0.0.1``
- ``127.0.0.1``
* - ``[neutron] url``
- ``http://$my_ip:9696``
- ``None``
* - ``[pxe] uefi_pxe_bootfile_name``
- ``elilo.efi``
- ``bootx64.efi``
* - ``[pxe] uefi_pxe_config_template``
- ``$pybasedir/drivers/modules/elilo_efi_pxe_config.template``
- ``$pybasedir/drivers/modules/pxe_grub_config.template``
.. list-table:: Deprecated options
:header-rows: 1
@ -86,8 +199,48 @@ New, updated, and deprecated options in Mitaka for Bare Metal service
- New Option
* - ``[DEFAULT] use_syslog``
- ``None``
* - ``[agent] agent_pxe_append_params``
- ``None``
* - ``[agent] agent_pxe_config_template``
- ``None``
* - ``[agent] heartbeat_timeout``
- ``[api] ramdisk_heartbeat_timeout``
* - ``[deploy] erase_devices_iterations``
- ``[deploy] shred_random_overwrite_iterations``
* - ``[keystone_authtoken] cafile``
- ``[glance] cafile``
* - ``[keystone_authtoken] cafile``
- ``[neutron] cafile``
* - ``[keystone_authtoken] cafile``
- ``[service_catalog] cafile``
* - ``[keystone_authtoken] cafile``
- ``[swift] cafile``
* - ``[keystone_authtoken] cafile``
- ``[inspector] cafile``
* - ``[keystone_authtoken] certfile``
- ``[service_catalog] certfile``
* - ``[keystone_authtoken] certfile``
- ``[neutron] certfile``
* - ``[keystone_authtoken] certfile``
- ``[glance] certfile``
* - ``[keystone_authtoken] certfile``
- ``[inspector] certfile``
* - ``[keystone_authtoken] certfile``
- ``[swift] certfile``
* - ``[keystone_authtoken] insecure``
- ``[glance] insecure``
* - ``[keystone_authtoken] insecure``
- ``[inspector] insecure``
* - ``[keystone_authtoken] insecure``
- ``[swift] insecure``
* - ``[keystone_authtoken] insecure``
- ``[service_catalog] insecure``
* - ``[keystone_authtoken] insecure``
- ``[neutron] insecure``
* - ``[keystone_authtoken] keyfile``
- ``[inspector] keyfile``
* - ``[keystone_authtoken] keyfile``
- ``[swift] keyfile``
* - ``[keystone_authtoken] keyfile``
- ``[neutron] keyfile``
* - ``[keystone_authtoken] keyfile``
- ``[glance] keyfile``
* - ``[keystone_authtoken] keyfile``
- ``[service_catalog] keyfile``

58
doc/config-reference/source/tables/conf-changes/keystone.rst
View File

@ -1,4 +1,4 @@
New, updated, and deprecated options in Mitaka for Identity service
New, updated, and deprecated options in Newton for Identity service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
@ -6,63 +6,7 @@ New, updated, and deprecated options in Mitaka for Identity service
changes will be overwritten. The tool to do so lives in the
openstack-doc-tools repository.
.. list-table:: New options
:header-rows: 1
:class: config-ref-table
* - Option = default value
- (Type) Help string
* - ``[DEFAULT] insecure_debug = False``
- (BoolOpt) If set to true the server will return information in the response that may allow an unauthenticated or authenticated user to get more information than normal, such as why authentication failed. This may be useful for debugging but is insecure.
* - ``[DEFAULT] notification_opt_out = []``
- (MultiStrOpt) Define the notification options to opt-out from. The value expected is: identity.<resource_type>.<operation>. This field can be set multiple times in order to add more notifications to opt-out from. For example: notification_opt_out=identity.user.created notification_opt_out=identity.authenticate.success
* - ``[assignment] prohibited_implied_role = admin``
- (ListOpt) A list of role names which are prohibited from being an implied role.
* - ``[ldap] group_members_are_ids = False``
- (BoolOpt) If the members of the group objectclass are user IDs rather than DNs, set this to true. This is the case when using posixGroup as the group objectclass and OpenDirectory.
* - ``[ldap] user_description_attribute = description``
- (StrOpt) LDAP attribute mapped to user description.
* - ``[resource] admin_project_domain_name = None``
- (StrOpt) Name of the domain that owns the `admin_project_name`. Defaults to None.
* - ``[resource] admin_project_name = None``
- (StrOpt) Special project for performing administrative operations on remote services. Tokens scoped to this project will contain the key/value `is_admin_project=true`. Defaults to None.
* - ``[resource] domain_name_url_safe = off``
- (StrOpt) Whether the names of domains are restricted from containing url reserved characters. If set to new, attempts to create or update a domain with a url unsafe name will return an error. In addition, if set to strict, attempts to scope a token using a domain name which is unsafe will return an error.
* - ``[resource] project_name_url_safe = off``
- (StrOpt) Whether the names of projects are restricted from containing url reserved characters. If set to new, attempts to create or update a project with a url unsafe name will return an error. In addition, if set to strict, attempts to scope a token using an unsafe project name will return an error.
* - ``[shadow_users] driver = sql``
- (StrOpt) Entrypoint for the shadow users backend driver in the keystone.identity.shadow_users namespace.
* - ``[token] infer_roles = True``
- (BoolOpt) Add roles to token that are not explicitly added, but that are linked implicitly to other roles.
.. list-table:: New default values
:header-rows: 1
:class: config-ref-table
* - Option
- Previous default value
- New default value
* - ``[DEFAULT] admin_token``
- ``ADMIN``
- ``None``
* - ``[DEFAULT] secure_proxy_ssl_header``
- ``None``
- ``HTTP_X_FORWARDED_PROTO``
* - ``[cache] backend``
- ``keystone.common.cache.noop``
- ``dogpile.cache.null``
* - ``[cache] config_prefix``
- ``cache.keystone``
- ``cache.oslo``
* - ``[ldap] use_auth_pool``
- ``False``
- ``True``
* - ``[ldap] use_pool``
- ``False``
- ``True``
* - ``[os_inherit] enabled``
- ``False``
- ``True``
.. list-table:: Deprecated options
:header-rows: 1

301
doc/config-reference/source/tables/conf-changes/manila.rst
View File

@ -1,4 +1,4 @@
New, updated, and deprecated options in Mitaka for Shared File Systems service
New, updated, and deprecated options in Newton for Shared File Systems service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
@ -12,174 +12,58 @@ New, updated, and deprecated options in Mitaka for Shared File Systems service
* - Option = default value
- (Type) Help string
* - ``[DEFAULT] admin_network_config_group = None``
- (StrOpt) If share driver requires to setup admin network for share, then define network plugin config options in some separate config group and set its name here. Used only with another option 'driver_handles_share_servers' set to 'True'.
* - ``[DEFAULT] admin_network_id = None``
- (StrOpt) ID of neutron network used to communicate with admin network, to create additional admin export locations on.
* - ``[DEFAULT] admin_subnet_id = None``
- (StrOpt) ID of neutron subnet used to communicate with admin network, to create additional admin export locations on. Related to 'admin_network_id'.
* - ``[DEFAULT] cephfs_auth_id = manila``
- (StrOpt) The name of the ceph auth identity to use.
* - ``[DEFAULT] cephfs_cluster_name = None``
- (StrOpt) The name of the cluster in use, if it is not the default ('ceph').
* - ``[DEFAULT] cephfs_conf_path =``
- (StrOpt) Fully qualified path to the ceph.conf file.
* - ``[DEFAULT] cephfs_enable_snapshots = False``
- (BoolOpt) Whether to enable snapshots in this driver.
* - ``[DEFAULT] data_access_wait_access_rules_timeout = 180``
- (IntOpt) Time to wait for access rules to be allowed/denied on backends when migrating a share (seconds).
* - ``[DEFAULT] data_manager = manila.data.manager.DataManager``
- (StrOpt) Full class name for the data manager.
* - ``[DEFAULT] data_node_access_cert = None``
- (StrOpt) The certificate installed in the data node in order to allow access to certificate authentication-based shares.
* - ``[DEFAULT] data_node_access_ip = None``
- (StrOpt) The IP of the node interface connected to the admin network. Used for allowing access to the mounting shares.
* - ``[DEFAULT] data_topic = manila-data``
- (StrOpt) The topic data nodes listen on.
* - ``[DEFAULT] emc_nas_pool_names = None``
- (StrOpt) EMC pool names.
* - ``[DEFAULT] hds_hnas_driver_helper = manila.share.drivers.hitachi.ssh.HNASSSHBackend``
* - ``[DEFAULT] check_hash = False``
- (BoolOpt) Chooses whether hash of each file should be checked on data copying.
* - ``[DEFAULT] container_volume_group = manila_docker_volumes``
- (StrOpt) LVM volume group to use for volumes. This volume group must be created by the cloud administrator independently from manila operations.
* - ``[DEFAULT] data_node_access_admin_user = None``
- (StrOpt) The admin user name registered in the security service in order to allow access to user authentication-based shares.
* - ``[DEFAULT] data_node_mount_options = {}``
- (DictOpt) Mount options to be included in the mount command for share protocols. Use dictionary format, example: {'nfs': '-o nfsvers=3', 'cifs': '-o user=foo,pass=bar'}
* - ``[DEFAULT] emc_interface_ports = None``
- (ListOpt) Comma separated list specifying the ports that can be used for share server interfaces. Members of the list can be Unix-style glob expressions.
* - ``[DEFAULT] emc_nas_server_pool = None``
- (StrOpt) Pool to persist the meta-data of NAS server.
* - ``[DEFAULT] filter_function = None``
- (StrOpt) String representation for an equation that will be used to filter hosts.
* - ``[DEFAULT] goodness_function = None``
- (StrOpt) String representation for an equation that will be used to determine the goodness of a host.
* - ``[DEFAULT] hitachi_hnas_allow_cifs_snapshot_while_mounted = False``
- (BoolOpt) By default, CIFS snapshots are not allowed to be taken when the share has clients connected because consistent point-in-time replica cannot be guaranteed for all files. Enabling this might cause inconsistent snapshots on CIFS shares.
* - ``[DEFAULT] hitachi_hnas_cluster_admin_ip0 = None``
- (StrOpt) The IP of the clusters admin node. Only set in HNAS multinode clusters.
* - ``[DEFAULT] hitachi_hnas_driver_helper = manila.share.drivers.hitachi.hnas.ssh.HNASSSHBackend``
- (StrOpt) Python class to be used for driver helper.
* - ``[DEFAULT] hpe3par_api_url =``
- (StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1
* - ``[DEFAULT] hpe3par_cifs_admin_access_domain = LOCAL_CLUSTER``
- (StrOpt) File system domain for the CIFS admin user.
* - ``[DEFAULT] hpe3par_cifs_admin_access_password =``
- (StrOpt) File system admin password for CIFS.
* - ``[DEFAULT] hpe3par_cifs_admin_access_username =``
- (StrOpt) File system admin user name for CIFS.
* - ``[DEFAULT] hpe3par_debug = False``
- (BoolOpt) Enable HTTP debugging to 3PAR
* - ``[DEFAULT] hpe3par_fpg = OpenStack``
- (StrOpt) The File Provisioning Group (FPG) to use
* - ``[DEFAULT] hpe3par_fstore_per_share = False``
- (BoolOpt) Use one filestore per share
* - ``[DEFAULT] hpe3par_password =``
- (StrOpt) 3PAR password for the user specified in hpe3par_username
* - ``[DEFAULT] hpe3par_require_cifs_ip = False``
- (BoolOpt) Require IP access rules for CIFS (in addition to user)
* - ``[DEFAULT] hpe3par_san_ip =``
- (StrOpt) IP address of SAN controller
* - ``[DEFAULT] hpe3par_san_login =``
- (StrOpt) Username for SAN controller
* - ``[DEFAULT] hpe3par_san_password =``
- (StrOpt) Password for SAN controller
* - ``[DEFAULT] hpe3par_san_ssh_port = 22``
- (PortOpt) SSH port to use with SAN
* - ``[DEFAULT] hpe3par_share_ip_address =``
- (StrOpt) The IP address for shares not using a share server
* - ``[DEFAULT] hpe3par_share_mount_path = /mnt/``
- (StrOpt) The path where shares will be mounted when deleting nested file trees.
* - ``[DEFAULT] hpe3par_username =``
- (StrOpt) 3PAR username with the 'edit' role
* - ``[DEFAULT] lvm_share_export_ip = None``
- (StrOpt) IP to be added to export string.
* - ``[DEFAULT] lvm_share_export_root = $state_path/mnt``
- (StrOpt) Base folder where exported shares are located.
* - ``[DEFAULT] lvm_share_helpers = CIFS=manila.share.drivers.helpers.CIFSHelperUserAccess, NFS=manila.share.drivers.helpers.NFSHelper``
- (ListOpt) Specify list of share export helpers.
* - ``[DEFAULT] lvm_share_mirrors = 0``
- (IntOpt) If set, create LVMs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space.
* - ``[DEFAULT] lvm_share_volume_group = lvm-shares``
- (StrOpt) Name for the VG that will contain exported shares.
* - ``[DEFAULT] migration_readonly_rules_support = True``
- (BoolOpt) Specify whether read only access rule mode is supported in this backend.
* - ``[DEFAULT] netapp_snapmirror_quiesce_timeout = 3600``
- (IntOpt) The maximum time in seconds to wait for existing snapmirror transfers to complete before aborting when promoting a replica.
* - ``[DEFAULT] netapp_volume_snapshot_reserve_percent = 5``
- (IntOpt) The percentage of share space set aside as reserve for snapshot usage; valid values range from 0 to 90.
* - ``[DEFAULT] replica_state_update_interval = 300``
- (IntOpt) This value, specified in seconds, determines how often the share manager will poll for the health (replica_state) of each replica instance.
* - ``[DEFAULT] replication_domain = None``
- (StrOpt) A string specifying the replication domain that the backend belongs to. This option needs to be specified the same in the configuration sections of all backends that support replication between each other. If this option is not specified in the group, it means that replication is not enabled on the backend.
* - ``[DEFAULT] share_mount_template = mount -vt %(proto)s %(export)s %(path)s``
- (StrOpt) The template for mounting shares for this backend. Must specify the executable with all necessary parameters for the protocol supported. 'proto' template element may not be required if included in the command. 'export' and 'path' template elements are required. It is advisable to separate different commands per backend.
* - ``[DEFAULT] share_unmount_template = umount -v %(path)s``
- (StrOpt) The template for unmounting shares for this backend. Must specify the executable with all necessary parameters for the protocol supported. 'path' template element is required. It is advisable to separate different commands per backend.
* - ``[DEFAULT] tegile_default_project = None``
- (StrOpt) Create shares in this project
* - ``[DEFAULT] tegile_nas_login = None``
- (StrOpt) User name for the Tegile NAS server.
* - ``[DEFAULT] tegile_nas_password = None``
- (StrOpt) Password for the Tegile NAS server.
* - ``[DEFAULT] tegile_nas_server = None``
- (StrOpt) Tegile NAS server hostname or IP address.
* - ``[DEFAULT] zfs_dataset_creation_options = None``
- (ListOpt) Define here list of options that should be applied for each dataset creation if needed. Example: compression=gzip,dedup=off. Note that, for secondary replicas option 'readonly' will be set to 'on' and for active replicas to 'off' in any way. Also, 'quota' will be equal to share size. Optional.
* - ``[DEFAULT] zfs_dataset_name_prefix = manila_share_``
- (StrOpt) Prefix to be used in each dataset name. Optional.
* - ``[DEFAULT] zfs_dataset_snapshot_name_prefix = manila_share_snapshot_``
- (StrOpt) Prefix to be used in each dataset snapshot name. Optional.
* - ``[DEFAULT] zfs_replica_snapshot_prefix = tmp_snapshot_for_replication_``
- (StrOpt) Set snapshot prefix for usage in ZFS replication. Required.
* - ``[DEFAULT] zfs_service_ip = None``
- (StrOpt) IP to be added to admin-facing export location. Required.
* - ``[DEFAULT] zfs_share_export_ip = None``
- (StrOpt) IP to be added to user-facing export location. Required.
* - ``[DEFAULT] zfs_share_helpers = NFS=manila.share.drivers.zfsonlinux.utils.NFSviaZFSHelper``
- (ListOpt) Specify list of share export helpers for ZFS storage. It should look like following: 'FOO_protocol=foo.FooClass,BAR_protocol=bar.BarClass'. Required.
* - ``[DEFAULT] zfs_ssh_private_key_path = None``
- (StrOpt) Path to SSH private key that should be used for SSH'ing ZFS storage host. Not used for replication operations. Optional.
* - ``[DEFAULT] zfs_ssh_user_password = None``
- (StrOpt) Password for user that is used for SSH'ing ZFS storage host. Not used for replication operations. They require passwordless SSH access. Optional.
* - ``[DEFAULT] zfs_ssh_username = None``
- (StrOpt) SSH user that will be used in 2 cases: 1) By manila-share service in case it is located on different host than its ZFS storage. 2) By manila-share services with other ZFS backends that perform replication. It is expected that SSH'ing will be key-based, passwordless. This user should be passwordless sudoer. Optional.
* - ``[DEFAULT] zfs_use_ssh = False``
- (BoolOpt) Remote ZFS storage hostname that should be used for SSH'ing. Optional.
* - ``[DEFAULT] zfs_zpool_list = None``
- (ListOpt) Specify list of zpools that are allowed to be used by backend. Can contain nested datasets. Examples: Without nested dataset: 'zpool_name'. With nested dataset: 'zpool_name/nested_dataset_name'. Required.
* - ``[cinder] api_insecure = False``
- (BoolOpt) Allow to perform insecure SSL requests to cinder.
* - ``[cinder] auth_section = None``
- (Opt) Config Section from which to load plugin specific options
* - ``[cinder] auth_type = None``
- (Opt) Authentication type to load
* - ``[cinder] ca_certificates_file = None``
- (StrOpt) Location of CA certificates file to use for cinder client requests.
* - ``[cinder] cafile = None``
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
* - ``[cinder] certfile = None``
- (StrOpt) PEM encoded client certificate cert file
* - ``[cinder] cross_az_attach = True``
- (BoolOpt) Allow attaching between instances and volumes in different availability zones.
* - ``[cinder] http_retries = 3``
- (IntOpt) Number of cinderclient retries on failed HTTP calls.
* - ``[cinder] insecure = False``
- (BoolOpt) Verify HTTPS connections.
* - ``[cinder] keyfile = None``
- (StrOpt) PEM encoded client certificate key file
* - ``[cinder] timeout = None``
- (IntOpt) Timeout value for http requests
* - ``[neutron] cafile = None``
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
* - ``[neutron] certfile = None``
- (StrOpt) PEM encoded client certificate cert file
* - ``[neutron] insecure = False``
- (BoolOpt) Verify HTTPS connections.
* - ``[neutron] keyfile = None``
- (StrOpt) PEM encoded client certificate key file
* - ``[neutron] timeout = None``
- (IntOpt) Timeout value for http requests
* - ``[nova] api_insecure = False``
- (BoolOpt) Allow to perform insecure SSL requests to nova.
* - ``[nova] api_microversion = 2.10``
- (StrOpt) Version of Nova API to be used.
* - ``[nova] auth_section = None``
- (Opt) Config Section from which to load plugin specific options
* - ``[nova] auth_type = None``
- (Opt) Authentication type to load
* - ``[nova] ca_certificates_file = None``
- (StrOpt) Location of CA certificates file to use for nova client requests.
* - ``[nova] cafile = None``
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
* - ``[nova] certfile = None``
- (StrOpt) PEM encoded client certificate cert file
* - ``[nova] insecure = False``
- (BoolOpt) Verify HTTPS connections.
* - ``[nova] keyfile = None``
- (StrOpt) PEM encoded client certificate key file
* - ``[nova] timeout = None``
- (IntOpt) Timeout value for http requests
* - ``[DEFAULT] hitachi_hnas_evs_id = None``
- (IntOpt) Specify which EVS this backend is assigned to.
* - ``[DEFAULT] hitachi_hnas_evs_ip = None``
- (StrOpt) Specify IP for mounting shares.
* - ``[DEFAULT] hitachi_hnas_file_system_name = None``
- (StrOpt) Specify file-system name for creating shares.
* - ``[DEFAULT] hitachi_hnas_ip = None``
- (StrOpt) HNAS management interface IP for communication between Manila controller and HNAS.
* - ``[DEFAULT] hitachi_hnas_password = None``
- (StrOpt) HNAS user password. Required only if private key is not provided.
* - ``[DEFAULT] hitachi_hnas_ssh_private_key = None``
- (StrOpt) RSA/DSA private key value used to connect into HNAS. Required only if password is not provided.
* - ``[DEFAULT] hitachi_hnas_stalled_job_timeout = 30``
- (IntOpt) The time (in seconds) to wait for stalled HNAS jobs before aborting.
* - ``[DEFAULT] hitachi_hnas_user = None``
- (StrOpt) HNAS username Base64 String in order to perform tasks such as create file-systems and network interfaces.
* - ``[DEFAULT] is_gpfs_node = False``
- (BoolOpt) True:when Manila services are running on one of the Spectrum Scale node. False:when Manila services are not running on any of the Spectrum Scale node.
* - ``[DEFAULT] migration_driver_continue_update_interval = 60``
- (IntOpt) This value, specified in seconds, determines how often the share manager will poll the driver to perform the next step of migration in the storage backend, for a migrating share.
* - ``[DEFAULT] mount_tmp_location = /tmp/``
- (StrOpt) Temporary path to create and mount shares during migration.
* - ``[DEFAULT] netapp_enabled_share_protocols = nfs3, nfs4.0``
- (ListOpt) The NFS protocol versions that will be enabled. Supported values include nfs3, nfs4.0, nfs4.1. This option only applies when the option driver_handles_share_servers is set to True.
* - ``[DEFAULT] protocol_access_mapping = {'ip': ['nfs'], 'user': ['cifs']}``
- (DictOpt) Protocol access mapping for this backend. Should be a dictionary comprised of {'access_type1': ['share_proto1', 'share_proto2'], 'access_type2': ['share_proto2', 'share_proto3']}.
* - ``[DEFAULT] zfs_migration_snapshot_prefix = tmp_snapshot_for_share_migration_``
- (StrOpt) Set snapshot prefix for usage in ZFS migration. Required.
* - ``[DEFAULT] zfssa_manage_policy = loose``
- (StrOpt) Driver policy for share manage. A strict policy checks for a schema named manila_managed, and makes sure its value is true. A loose policy does not check for the schema.
.. list-table:: New default values
:header-rows: 1
@ -188,21 +72,30 @@ New, updated, and deprecated options in Mitaka for Shared File Systems service
* - Option
- Previous default value
- New default value
* - ``[DEFAULT] migration_wait_access_rules_timeout``
- ``90``
- ``180``
* - ``[DEFAULT] osapi_share_extension``
- ``['manila.api.contrib.standard_extensions']``
- ``manila.api.contrib.standard_extensions``
* - ``[DEFAULT] emc_nas_server_container``
- ``server_2``
- ``None``
* - ``[DEFAULT] gpfs_share_helpers``
- ``KNFS=manila.share.drivers.ibm.gpfs.KNFSHelper, GNFS=manila.share.drivers.ibm.gpfs.GNFSHelper``
- ``KNFS=manila.share.drivers.ibm.gpfs.KNFSHelper, CES=manila.share.drivers.ibm.gpfs.CESHelper``
* - ``[DEFAULT] host``
- ``localhost``
- ``<your_hostname>``
* - ``[DEFAULT] hpe3par_fpg``
- ``OpenStack``
- ``None``
* - ``[DEFAULT] my_ip``
- ``10.0.0.1``
- ``<your_ip>``
* - ``[DEFAULT] scheduler_default_filters``
- ``AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter, ConsistencyGroupFilter``
- ``AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter, ConsistencyGroupFilter, ShareReplicationFilter``
* - ``[DEFAULT] scheduler_driver``
- ``manila.scheduler.filter_scheduler.FilterScheduler``
- ``manila.scheduler.drivers.filter.FilterScheduler``
* - ``[DEFAULT] share_helpers``
- ``CIFS=manila.share.drivers.generic.CIFSHelper, NFS=manila.share.drivers.generic.NFSHelper``
- ``CIFS=manila.share.drivers.helpers.CIFSHelperIPAccess, NFS=manila.share.drivers.helpers.NFSHelper``
- ``AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter, ConsistencyGroupFilter, DriverFilter, ShareReplicationFilter``
* - ``[DEFAULT] scheduler_default_weighers``
- ``CapacityWeigher``
- ``CapacityWeigher, GoodnessWeigher``
* - ``[DEFAULT] share_mount_template``
- ``mount -vt %(proto)s %(export)s %(path)s``
- ``mount -vt %(proto)s %(options)s %(export)s %(path)s``
.. list-table:: Deprecated options
:header-rows: 1
@ -210,48 +103,14 @@ New, updated, and deprecated options in Mitaka for Shared File Systems service
* - Deprecated option
- New Option
* - ``[DEFAULT] cinder_api_insecure``
- ``[cinder] api_insecure``
* - ``[DEFAULT] cinder_ca_certificates_file``
- ``[cinder] ca_certificates_file``
* - ``[DEFAULT] cinder_cross_az_attach``
- ``[cinder] cross_az_attach``
* - ``[DEFAULT] cinder_http_retries``
- ``[cinder] http_retries``
* - ``[DEFAULT] db_backend``
- ``[database] backend``
* - ``[DEFAULT] emc_nas_pool_name``
- ``[DEFAULT] emc_nas_pool_names``
* - ``[DEFAULT] hp3par_api_url``
- ``[DEFAULT] hpe3par_api_url``
* - ``[DEFAULT] hp3par_debug``
- ``[DEFAULT] hpe3par_debug``
* - ``[DEFAULT] hp3par_fpg``
- ``[DEFAULT] hpe3par_fpg``
* - ``[DEFAULT] hp3par_fstore_per_share``
- ``[DEFAULT] hpe3par_fstore_per_share``
* - ``[DEFAULT] hp3par_password``
- ``[DEFAULT] hpe3par_password``
* - ``[DEFAULT] hp3par_san_ip``
- ``[DEFAULT] hpe3par_san_ip``
* - ``[DEFAULT] hp3par_san_login``
- ``[DEFAULT] hpe3par_san_login``
* - ``[DEFAULT] hp3par_san_password``
- ``[DEFAULT] hpe3par_san_password``
* - ``[DEFAULT] hp3par_san_ssh_port``
- ``[DEFAULT] hpe3par_san_ssh_port``
* - ``[DEFAULT] hp3par_share_ip_address``
- ``[DEFAULT] hpe3par_share_ip_address``
* - ``[DEFAULT] hp3par_username``
- ``[DEFAULT] hpe3par_username``
* - ``[DEFAULT] migration_readonly_support``
- ``[DEFAULT] migration_readonly_rules_support``
* - ``[DEFAULT] nova_api_insecure``
- ``[nova] api_insecure``
* - ``[DEFAULT] nova_api_microversion``
- ``[nova] api_microversion``
* - ``[DEFAULT] nova_ca_certificates_file``
- ``[nova] ca_certificates_file``
* - ``[DEFAULT] hds_hnas_driver_helper``
- ``[DEFAULT] hitachi_hnas_driver_helper``
* - ``[DEFAULT] hpe3par_share_mount_path``
- ``[DEFAULT] hpe3par_share_mount_path``
* - ``[DEFAULT] migration_tmp_location``
- ``[DEFAULT] mount_tmp_location``
* - ``[DEFAULT] sql_idle_timeout``
- ``[database] idle_timeout``
* - ``[DEFAULT] sql_max_retries``

35
doc/config-reference/source/tables/conf-changes/murano.rst Normal file
View File

@ -0,0 +1,35 @@
New, updated, and deprecated options in Newton for Application Catalog service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
Warning: Do not edit this file. It is automatically generated and your
changes will be overwritten. The tool to do so lives in the
openstack-doc-tools repository.
.. list-table:: New options
:header-rows: 1
:class: config-ref-table
* - Option = default value
- (Type) Help string
* - ``[cfapi] packages_service = murano``
- (StrOpt) Package service which should be used by service broker
* - ``[engine] engine_workers = None``
- (IntOpt) Number of engine workers
* - ``[murano] api_workers = None``
- (IntOpt) Number of API workers
* - ``[networking] driver = None``
- (StrOpt) Network driver to use. Options are neutron or nova.If not provided, the driver will be detected.
.. list-table:: Deprecated options
:header-rows: 1
:class: config-ref-table
* - Deprecated option
- New Option
* - ``[DEFAULT] use_syslog``
- ``None``
* - ``[engine] workers``
- ``[engine] engine_workers``

71
doc/config-reference/source/tables/conf-changes/senlin.rst Normal file
View File

@ -0,0 +1,71 @@
New, updated, and deprecated options in Newton for Clustering service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
Warning: Do not edit this file. It is automatically generated and your
changes will be overwritten. The tool to do so lives in the
openstack-doc-tools repository.
.. list-table:: New options
:header-rows: 1
:class: config-ref-table
* - Option = default value
- (Type) Help string
* - ``[DEFAULT] batch_interval = 3``
- (IntOpt) Seconds to pause between scheduling two consecutive batches of node actions.
* - ``[DEFAULT] periodic_fuzzy_delay = 10``
- (IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)
* - ``[health_manager] nova_control_exchange = nova``
- (StrOpt) Exchange name for nova notifications
* - ``[oslo_versionedobjects] fatal_exception_format_errors = False``
- (BoolOpt) Make exception message format errors fatal
* - ``[senlin_api] api_paste_config = api-paste.ini``
- (StrOpt) The API paste config file to use.
* - ``[senlin_api] client_socket_timeout = 900``
- (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' indicates waiting forever.
* - ``[senlin_api] max_json_body_size = 1048576``
- (IntOpt) Maximum raw byte size of JSON request body. Should be larger than max_template_size.
* - ``[senlin_api] wsgi_keep_alive = True``
- (BoolOpt) If false, closes the client socket explicitly.
* - ``[zaqar] auth_section = None``
- (Opt) Config Section from which to load plugin specific options
* - ``[zaqar] auth_type = None``
- (Opt) Authentication type to load
* - ``[zaqar] cafile = None``
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
* - ``[zaqar] certfile = None``
- (StrOpt) PEM encoded client certificate cert file
* - ``[zaqar] insecure = False``
- (BoolOpt) Verify HTTPS connections.
* - ``[zaqar] keyfile = None``
- (StrOpt) PEM encoded client certificate key file
* - ``[zaqar] timeout = None``
- (IntOpt) Timeout value for http requests
.. list-table:: New default values
:header-rows: 1
:class: config-ref-table
* - Option
- Previous default value
- New default value
* - ``[DEFAULT] max_actions_per_batch``
- ``10``
- ``0``
* - ``[DEFAULT] periodic_interval_max``
- ``60``
- ``120``
* - ``[webhook] host``
- ``localhost``
- ``None``
.. list-table:: Deprecated options
:header-rows: 1
:class: config-ref-table
* - Deprecated option
- New Option
* - ``[DEFAULT] use_syslog``
- ``None``

2
doc/config-reference/source/tables/conf-changes/swift.rst
View File

@ -1,4 +1,4 @@
New, updated, and deprecated options in Mitaka for OpenStack Object Storage
New, updated, and deprecated options in Newton for OpenStack Object Storage
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..

409
doc/config-reference/source/tables/conf-changes/trove.rst
View File

@ -1,4 +1,4 @@
New, updated, and deprecated options in Mitaka for Database service
New, updated, and deprecated options in Newton for Database service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
@ -12,176 +12,62 @@ New, updated, and deprecated options in Mitaka for Database service
* - Option = default value
- (Type) Help string
* - ``[DEFAULT] guest_log_container_name = database_logs``
- (StrOpt) Name of container that stores guest log components.
* - ``[DEFAULT] guest_log_expiry = 2592000``
- (IntOpt) Expiry (in seconds) of objects in guest log container.
* - ``[DEFAULT] guest_log_limit = 1000000``
- (IntOpt) Maximum size of a chunk saved in guest log container.
* - ``[DEFAULT] max_backups_per_tenant = 50``
- (IntOpt) Default maximum number of backups created by a tenant.
* - ``[DEFAULT] max_instances_per_tenant = 5``
- (IntOpt) Default maximum number of instances per tenant.
* - ``[DEFAULT] max_volumes_per_tenant = 20``
- (IntOpt) Default maximum volume capacity (in GB) spanning across all Trove volumes per tenant.
* - ``[DEFAULT] module_aes_cbc_key = module_aes_cbc_key``
- (StrOpt) OpenSSL aes_cbc key for module encryption.
* - ``[DEFAULT] module_types = ping``
- (ListOpt) A list of module types supported. A module type corresponds to the name of a ModuleDriver.
* - ``[DEFAULT] modules_page_size = 20``
- (IntOpt) Page size for listing modules.
* - ``[DEFAULT] nova_client_version = 2.12``
- (StrOpt) The version of of the compute service client.
* - ``[DEFAULT] quota_notification_interval = 3600``
- (IntOpt) Seconds to wait between pushing events.
* - ``[DEFAULT] state_change_poll_time = 3``
- (IntOpt) Interval between state change poll requests (seconds).
* - ``[cassandra] api_strategy = trove.common.strategies.cluster.experimental.cassandra.api.CassandraAPIStrategy``
- (StrOpt) Class that implements datastore-specific API logic.
* - ``[cassandra] cluster_support = True``
- (BoolOpt) Enable clusters to be created and managed.
* - ``[cassandra] guest_log_exposed_logs =``
- (StrOpt) List of Guest Logs to expose for publishing.
* - ``[cassandra] guestagent_strategy = trove.common.strategies.cluster.experimental.cassandra.guestagent.CassandraGuestAgentStrategy``
- (StrOpt) Class that implements datastore-specific Guest Agent API logic.
* - ``[cassandra] ignore_dbs = system, system_auth, system_traces``
- (ListOpt) Databases to exclude when listing databases.
* - ``[cassandra] ignore_users = os_admin``
- (ListOpt) Users to exclude when listing users.
* - ``[cassandra] taskmanager_strategy = trove.common.strategies.cluster.experimental.cassandra.taskmanager.CassandraTaskManagerStrategy``
- (StrOpt) Class that implements datastore-specific task manager logic.
* - ``[cors] allow_credentials = True``
- (BoolOpt) Indicate that the actual request can include user credentials
* - ``[cors] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which header field names may be used during the actual request.
* - ``[cors] allow_methods = GET, POST, PUT, DELETE, OPTIONS``
- (ListOpt) Indicate which methods can be used during the actual request.
* - ``[cors] allowed_origin = None``
- (ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
* - ``[cors] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
* - ``[cors] max_age = 3600``
- (IntOpt) Maximum cache age of CORS preflight requests.
* - ``[cors.subdomain] allow_credentials = True``
- (BoolOpt) Indicate that the actual request can include user credentials
* - ``[cors.subdomain] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which header field names may be used during the actual request.
* - ``[cors.subdomain] allow_methods = GET, POST, PUT, DELETE, OPTIONS``
- (ListOpt) Indicate which methods can be used during the actual request.
* - ``[cors.subdomain] allowed_origin = None``
- (ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
* - ``[cors.subdomain] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
* - ``[cors.subdomain] max_age = 3600``
- (IntOpt) Maximum cache age of CORS preflight requests.
* - ``[couchbase] guest_log_exposed_logs =``
- (StrOpt) List of Guest Logs to expose for publishing.
* - ``[couchdb] guest_log_exposed_logs =``
- (StrOpt) List of Guest Logs to expose for publishing.
* - ``[couchdb] ignore_dbs = _users, _replicator``
- (ListOpt) Databases to exclude when listing databases.
* - ``[couchdb] ignore_users = os_admin, root``
- (ListOpt) Users to exclude when listing users.
* - ``[database] backend = sqlalchemy``
- (StrOpt) The back end to use for the database.
* - ``[database] connection_debug = 0``
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.
* - ``[database] connection_trace = False``
- (BoolOpt) Add Python stack traces to SQL as comment strings.
* - ``[database] db_inc_retry_interval = True``
- (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
* - ``[database] db_max_retries = 20``
- (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.
* - ``[database] db_max_retry_interval = 10``
- (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
* - ``[database] db_retry_interval = 1``
- (IntOpt) Seconds between retries of a database transaction.
* - ``[database] max_overflow = None``
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy.
* - ``[database] max_pool_size = None``
- (IntOpt) Maximum number of SQL connections to keep open in a pool.
* - ``[database] max_retries = 10``
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
* - ``[database] min_pool_size = 1``
- (IntOpt) Minimum number of SQL connections to keep open in a pool.
* - ``[database] 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=
* - ``[database] pool_timeout = None``
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy.
* - ``[database] retry_interval = 10``
- (IntOpt) Interval between retries of opening a SQL connection.
* - ``[database] slave_connection = None``
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
* - ``[database] sqlite_db = oslo.sqlite``
- (StrOpt) The file name to use with SQLite.
* - ``[database] sqlite_synchronous = True``
- (BoolOpt) If True, SQLite uses synchronous mode.
* - ``[database] use_db_reconnect = False``
- (BoolOpt) Enable the experimental use of database reconnect on connection lost.
* - ``[db2] guest_log_exposed_logs =``
- (StrOpt) List of Guest Logs to expose for publishing.
* - ``[mariadb] api_strategy = trove.common.strategies.cluster.experimental.galera_common.api.GaleraCommonAPIStrategy``
- (StrOpt) Class that implements datastore-specific API logic.
* - ``[mariadb] cluster_support = True``
- (BoolOpt) Enable clusters to be created and managed.
* - ``[mariadb] guest_log_exposed_logs = general,slow_query``
- (StrOpt) List of Guest Logs to expose for publishing.
* - ``[mariadb] guest_log_long_query_time = 1000``
- (IntOpt) The time in milliseconds that a statement must take in in order to be logged in the slow_query log.
* - ``[mariadb] guestagent_strategy = trove.common.strategies.cluster.experimental.galera_common.guestagent.GaleraCommonGuestAgentStrategy``
- (StrOpt) Class that implements datastore-specific Guest Agent API logic.
* - ``[mariadb] ignore_dbs = mysql, information_schema, performance_schema``
- (ListOpt) Databases to exclude when listing databases.
* - ``[mariadb] ignore_users = os_admin, root``
- (ListOpt) Users to exclude when listing users.
* - ``[mariadb] min_cluster_member_count = 3``
- (IntOpt) Minimum number of members in MariaDB cluster.
* - ``[mariadb] taskmanager_strategy = trove.common.strategies.cluster.experimental.galera_common.taskmanager.GaleraCommonTaskManagerStrategy``
- (StrOpt) Class that implements datastore-specific task manager logic.
* - ``[mongodb] cluster_secure = True``
- (BoolOpt) Create secure clusters. If False then the Role-Based Access Control will be disabled.
* - ``[mongodb] guest_log_exposed_logs =``
- (StrOpt) List of Guest Logs to expose for publishing.
* - ``[mysql] guest_log_exposed_logs = general,slow_query``
- (StrOpt) List of Guest Logs to expose for publishing.
* - ``[mysql] guest_log_long_query_time = 1000``
- (IntOpt) The time in milliseconds that a statement must take in in order to be logged in the slow_query log.
* - ``[mysql] ignore_dbs = mysql, information_schema, performance_schema``
- (ListOpt) Databases to exclude when listing databases.
* - ``[mysql] ignore_users = os_admin, root``
- (ListOpt) Users to exclude when listing users.
* - ``[oslo_middleware] max_request_body_size = 114688``
- (IntOpt) The maximum body size for each request, in bytes.
* - ``[oslo_middleware] secure_proxy_ssl_header = X-Forwarded-Proto``
- (StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.
* - ``[percona] guest_log_exposed_logs = general,slow_query``
- (StrOpt) List of Guest Logs to expose for publishing.
* - ``[percona] guest_log_long_query_time = 1000``
- (IntOpt) The time in milliseconds that a statement must take in in order to be logged in the slow_query log.
* - ``[percona] ignore_dbs = mysql, information_schema, performance_schema``
- (ListOpt) Databases to exclude when listing databases.
* - ``[percona] ignore_users = os_admin, root``
- (ListOpt) Users to exclude when listing users.
* - ``[postgresql] guest_log_exposed_logs = general``
- (StrOpt) List of Guest Logs to expose for publishing.
* - ``[postgresql] guest_log_long_query_time = 0``
- (IntOpt) The time in milliseconds that a statement must take in in order to be logged in the 'general' log. A value of '0' logs all statements, while '-1' turns off statement logging.
* - ``[postgresql] postgresql_port = 5432``
- (PortOpt) The TCP port the server listens on.
* - ``[profiler] hmac_keys = SECRET_KEY``
- (StrOpt) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: <key1>[,<key2>,...<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project. Both "enabled" flag and "hmac_keys" config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources.
* - ``[pxc] guest_log_exposed_logs = general,slow_query``
- (StrOpt) List of Guest Logs to expose for publishing.
* - ``[pxc] guest_log_long_query_time = 1000``
- (IntOpt) The time in milliseconds that a statement must take in in order to be logged in the slow_query log.
* - ``[pxc] ignore_dbs = mysql, information_schema, performance_schema``
- (ListOpt) Databases to exclude when listing databases.
* - ``[redis] guest_log_exposed_logs =``
- (StrOpt) List of Guest Logs to expose for publishing.
* - ``[vertica] guest_log_exposed_logs =``
- (StrOpt) List of Guest Logs to expose for publishing.
* - ``[vertica] min_ksafety = 0``
- (IntOpt) Minimum k-safety setting permitted for vertica clusters
* - ``[cassandra] default_password_length = 36``
- (IntOpt) Character length of generated passwords.
* - ``[cassandra] icmp = False``
- (BoolOpt) Whether to permit ICMP.
* - ``[cassandra] system_log_level = INFO``
- (StrOpt) Cassandra log verbosity.
* - ``[couchbase] default_password_length = 24``
- (IntOpt) Character length of generated passwords.
* - ``[couchbase] icmp = False``
- (BoolOpt) Whether to permit ICMP.
* - ``[couchdb] default_password_length = 36``
- (IntOpt) Character length of generated passwords.
* - ``[couchdb] icmp = False``
- (BoolOpt) Whether to permit ICMP.
* - ``[db2] default_password_length = 36``
- (IntOpt) Character length of generated passwords.
* - ``[db2] icmp = False``
- (BoolOpt) Whether to permit ICMP.
* - ``[mariadb] default_password_length = ${mysql.default_password_length}``
- (IntOpt) Character length of generated passwords.
* - ``[mariadb] icmp = False``
- (BoolOpt) Whether to permit ICMP.
* - ``[mongodb] default_password_length = 36``
- (IntOpt) Character length of generated passwords.
* - ``[mongodb] icmp = False``
- (BoolOpt) Whether to permit ICMP.
* - ``[mysql] default_password_length = 36``
- (IntOpt) Character length of generated passwords.
* - ``[mysql] icmp = False``
- (BoolOpt) Whether to permit ICMP.
* - ``[percona] default_password_length = ${mysql.default_password_length}``
- (IntOpt) Character length of generated passwords.
* - ``[percona] icmp = False``
- (BoolOpt) Whether to permit ICMP.
* - ``[postgresql] default_password_length = 36``
- (IntOpt) Character length of generated passwords.
* - ``[postgresql] icmp = False``
- (BoolOpt) Whether to permit ICMP.
* - ``[postgresql] replication_namespace = trove.guestagent.strategies.replication.experimental.postgresql_impl``
- (StrOpt) Namespace to load replication strategies from.
* - ``[postgresql] replication_strategy = PostgresqlReplicationStreaming``
- (StrOpt) Default strategy for replication.
* - ``[postgresql] wal_archive_location = /mnt/wal_archive``
- (StrOpt) Filesystem path storing WAL archive files when WAL-shipping based backups or replication is enabled.
* - ``[pxc] default_password_length = ${mysql.default_password_length}``
- (IntOpt) Character length of generated passwords.
* - ``[pxc] icmp = False``
- (BoolOpt) Whether to permit ICMP.
* - ``[redis] default_password_length = 36``
- (IntOpt) Character length of generated passwords.
* - ``[redis] icmp = False``
- (BoolOpt) Whether to permit ICMP.
* - ``[vertica] default_password_length = 36``
- (IntOpt) Character length of generated passwords.
* - ``[vertica] icmp = False``
- (BoolOpt) Whether to permit ICMP.
.. list-table:: New default values
:header-rows: 1
@ -190,84 +76,81 @@ New, updated, and deprecated options in Mitaka for Database service
* - Option
- Previous default value
- New default value
* - ``[DEFAULT] pydev_debug_port``
- ``None``
- ``5678``
* - ``[DEFAULT] storage_namespace``
- ``trove.guestagent.strategies.storage.swift``
- ``trove.common.strategies.storage.swift``
* - ``[cassandra] backup_namespace``
- ``None``
- ``trove.guestagent.strategies.backup.experimental.cassandra_impl``
* - ``[cassandra] backup_strategy``
- ``None``
- ``NodetoolSnapshot``
* - ``[cassandra] restore_namespace``
- ``None``
- ``trove.guestagent.strategies.restore.experimental.cassandra_impl``
* - ``[cassandra] root_controller``
- ``trove.extensions.common.service.DefaultRootController``
- ``trove.extensions.cassandra.service.CassandraRootController``
* - ``[cassandra] tcp_ports``
- ``7000, 7001, 9042, 9160``
- ``7000, 7001, 7199, 9042, 9160``
* - ``[couchbase] root_on_create``
- ``True``
- ``False``
* - ``[couchdb] backup_namespace``
- ``None``
- ``trove.guestagent.strategies.backup.experimental.couchdb_impl``
* - ``[couchdb] backup_strategy``
- ``None``
- ``CouchDBBackup``
* - ``[couchdb] restore_namespace``
- ``None``
- ``trove.guestagent.strategies.restore.experimental.couchdb_impl``
* - ``[db2] backup_namespace``
- ``None``
- ``trove.guestagent.strategies.backup.experimental.db2_impl``
* - ``[DEFAULT] agent_call_high_timeout``
- ``60``
- ``600``
* - ``[DEFAULT] agent_call_low_timeout``
- ``5``
- ``15``
* - ``[DEFAULT] dns_auth_url``
-
- ``http://0.0.0.0``
* - ``[DEFAULT] dns_endpoint_url``
- ``0.0.0.0``
- ``http://0.0.0.0``
* - ``[DEFAULT] dns_hostname``
-
- ``localhost``
* - ``[DEFAULT] dns_management_base_url``
-
- ``http://0.0.0.0``
* - ``[DEFAULT] max_accepted_volume_size``
- ``5``
- ``10``
* - ``[DEFAULT] max_instances_per_tenant``
- ``5``
- ``10``
* - ``[DEFAULT] max_volumes_per_tenant``
- ``20``
- ``40``
* - ``[DEFAULT] module_types``
- ``ping``
- ``ping, new_relic_license``
* - ``[DEFAULT] resize_time_out``
- ``600``
- ``900``
* - ``[DEFAULT] state_change_wait_time``
- ``180``
- ``600``
* - ``[DEFAULT] usage_timeout``
- ``900``
- ``1800``
* - ``[cassandra] guest_log_exposed_logs``
-
- ``system``
* - ``[db2] backup_strategy``
- ``None``
- ``DB2Backup``
* - ``[db2] restore_namespace``
- ``None``
- ``trove.guestagent.strategies.restore.experimental.db2_impl``
* - ``[mariadb] replication_namespace``
- ``trove.guestagent.strategies.replication.mysql_binlog``
- ``trove.guestagent.strategies.replication.experimental.mariadb_gtid``
* - ``[mariadb] replication_strategy``
- ``MysqlBinlogReplication``
- ``MariaDBGTIDReplication``
* - ``[mariadb] tcp_ports``
- ``3306``
- ``3306, 4444, 4567, 4568``
- ``DB2OfflineBackup``
* - ``[mariadb] backup_incremental_strategy``
- ``{'InnoBackupEx': 'InnoBackupExIncremental'}``
- ``{'MariaDBInnoBackupEx': 'MariaDBInnoBackupExIncremental'}``
* - ``[mariadb] backup_namespace``
- ``trove.guestagent.strategies.backup.mysql_impl``
- ``trove.guestagent.strategies.backup.experimental.mariadb_impl``
* - ``[mariadb] backup_strategy``
- ``InnoBackupEx``
- ``MariaDBInnoBackupEx``
* - ``[mariadb] restore_namespace``
- ``trove.guestagent.strategies.restore.mysql_impl``
- ``trove.guestagent.strategies.restore.experimental.mariadb_impl``
* - ``[mongodb] root_controller``
- ``trove.extensions.common.service.DefaultRootController``
- ``trove.extensions.mongodb.service.MongoDBRootController``
* - ``[mongodb] tcp_ports``
- ``2500, 27017``
- ``2500, 27017, 27019``
* - ``[mysql] root_controller``
* - ``[postgresql] backup_incremental_strategy``
- ``{}``
- ``{'PgBaseBackup': 'PgBaseBackupIncremental'}``
* - ``[postgresql] backup_strategy``
- ``PgDump``
- ``PgBaseBackup``
* - ``[postgresql] ignore_dbs``
- ``postgres``
- ``os_admin, postgres``
* - ``[postgresql] root_controller``
- ``trove.extensions.common.service.DefaultRootController``
- ``trove.extensions.mysql.service.MySQLRootController``
* - ``[profiler] trace_sqlalchemy``
- ``True``
- ``False``
* - ``[pxc] api_strategy``
- ``trove.common.strategies.cluster.experimental.pxc.api.PXCAPIStrategy``
- ``trove.common.strategies.cluster.experimental.galera_common.api.GaleraCommonAPIStrategy``
* - ``[pxc] guestagent_strategy``
- ``trove.common.strategies.cluster.experimental.pxc.guestagent.PXCGuestAgentStrategy``
- ``trove.common.strategies.cluster.experimental.galera_common.guestagent.GaleraCommonGuestAgentStrategy``
* - ``[pxc] root_controller``
- ``trove.extensions.common.service.DefaultRootController``
- ``trove.extensions.pxc.service.PxcRootController``
* - ``[pxc] taskmanager_strategy``
- ``trove.common.strategies.cluster.experimental.pxc.taskmanager.PXCTaskManagerStrategy``
- ``trove.common.strategies.cluster.experimental.galera_common.taskmanager.GaleraCommonTaskManagerStrategy``
* - ``[redis] device_path``
- ``None``
- ``/dev/vdb``
- ``trove.extensions.postgresql.service.PostgreSQLRootController``
.. list-table:: Deprecated options
:header-rows: 1
@ -275,28 +158,30 @@ New, updated, and deprecated options in Mitaka for Database service
* - Deprecated option
- New Option
* - ``[DEFAULT] ignore_dbs``
- ``[couchdb] ignore_dbs``
* - ``[DEFAULT] ignore_dbs``
- ``[mysql] ignore_dbs``
* - ``[DEFAULT] ignore_dbs``
- ``[mariadb] ignore_dbs``
* - ``[DEFAULT] ignore_dbs``
- ``[percona] ignore_dbs``
* - ``[DEFAULT] ignore_users``
- ``[percona] ignore_users``
* - ``[DEFAULT] ignore_users``
- ``[couchdb] ignore_users``
* - ``[DEFAULT] ignore_users``
- ``[mariadb] ignore_users``
* - ``[DEFAULT] ignore_users``
- ``[mysql] ignore_users``
* - ``[DEFAULT] max_backups_per_user``
- ``[DEFAULT] max_backups_per_tenant``
* - ``[DEFAULT] max_instances_per_user``
- ``[DEFAULT] max_instances_per_tenant``
* - ``[DEFAULT] max_volumes_per_user``
- ``[DEFAULT] max_volumes_per_tenant``
* - ``[DEFAULT] default_password_length``
- ``[couchbase] default_password_length``
* - ``[DEFAULT] default_password_length``
- ``[redis] default_password_length``
* - ``[DEFAULT] default_password_length``
- ``[cassandra] default_password_length``
* - ``[DEFAULT] default_password_length``
- ``[mysql] default_password_length``
* - ``[DEFAULT] default_password_length``
- ``[mariadb] default_password_length``
* - ``[DEFAULT] default_password_length``
- ``[postgresql] default_password_length``
* - ``[DEFAULT] default_password_length``
- ``[vertica] default_password_length``
* - ``[DEFAULT] default_password_length``
- ``[pxc] default_password_length``
* - ``[DEFAULT] default_password_length``
- ``[percona] default_password_length``
* - ``[DEFAULT] default_password_length``
- ``[mongodb] default_password_length``
* - ``[DEFAULT] default_password_length``
- ``[db2] default_password_length``
* - ``[DEFAULT] default_password_length``
- ``[couchdb] default_password_length``
* - ``[DEFAULT] use_syslog``
- ``None``

75
doc/config-reference/source/tables/conf-changes/zaqar.rst Normal file
View File

@ -0,0 +1,75 @@
New, updated, and deprecated options in Newton for Message service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
Warning: Do not edit this file. It is automatically generated and your
changes will be overwritten. The tool to do so lives in the
openstack-doc-tools repository.
.. list-table:: New options
:header-rows: 1
:class: config-ref-table
* - Option = default value
- (Type) Help string
* - ``[DEFAULT] enable_deprecated_api_versions =``
- (ListOpt) List of deprecated API versions to enable.
* - ``[notification] max_notifier_workers = 10``
- (IntOpt) The max amount of the notification workers.
* - ``[notification] require_confirmation = False``
- (BoolOpt) Whether the http/https/email subscription need to be confirmed before notification.
* - ``[trustee] auth_section = None``
- (Opt) Config Section from which to load plugin specific options
* - ``[trustee] auth_type = None``
- (Opt) Authentication type to load
* - ``[trustee] auth_url = None``
- (Opt) Authentication URL
* - ``[trustee] default_domain_id = None``
- (Opt) Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
* - ``[trustee] default_domain_name = None``
- (Opt) Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
* - ``[trustee] domain_id = None``
- (Opt) Domain ID to scope to
* - ``[trustee] domain_name = None``
- (Opt) Domain name to scope to
* - ``[trustee] password = None``
- (Opt) User's password
* - ``[trustee] project_domain_id = None``
- (Opt) Domain ID containing project
* - ``[trustee] project_domain_name = None``
- (Opt) Domain name containing project
* - ``[trustee] project_id = None``
- (Opt) Project ID to scope to
* - ``[trustee] project_name = None``
- (Opt) Project name to scope to
* - ``[trustee] trust_id = None``
- (Opt) Trust ID
* - ``[trustee] user_domain_id = None``
- (Opt) User's domain id
* - ``[trustee] user_domain_name = None``
- (Opt) User's domain name
* - ``[trustee] user_id = None``
- (Opt) User id
* - ``[trustee] username = None``
- (Opt) Username
.. list-table:: New default values
:header-rows: 1
:class: config-ref-table
* - Option
- Previous default value
- New default value
* - ``[transport] subscriber_types``
- ``http, https, mailto``
- ``http, https, mailto, trust+http, trust+https``
.. list-table:: Deprecated options
:header-rows: 1
:class: config-ref-table
* - Deprecated option
- New Option
* - ``[DEFAULT] use_syslog``
- ``None``