openstack/openstack-manuals
Code Issues Proposed changes

[config-ref] update for new/updated/deprecated options

Browse Source 
Change-Id: I321c8da17097ed136565d6b8e585ab043a49057a
This commit is contained in:
Gauvain Pocentek
2016-03-20 18:36:39 +01:00
parent 1aa55cbe62
commit e392124d34
13 changed files with 1131 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
doc/config-reference/source/tables/conf-changes/aodh.rst Normal file
View File

@@ -0,0 +1,43 @@
New, updated, and deprecated options in Mitaka for Alarming
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
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] 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.``
.. 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
:class: config-ref-table
* - Deprecated option
- New Option
* - ``[DEFAULT] use_syslog``
- ``None``

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

@@ -16,6 +16,40 @@ New, updated, and deprecated options in Mitaka for Telemetry
- ``(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.``
.. list-table:: New default values
:header-rows: 1
@@ -27,6 +61,9 @@ New, updated, and deprecated options in Mitaka for Telemetry
* - ``[dispatcher_gnocchi] archive_policy``
- ``low``
- ``None``
* - ``[dispatcher_gnocchi] url``
- ``http://localhost:8041``
- ``None``
.. list-table:: Deprecated options
:header-rows: 1
@@ -42,4 +79,6 @@ New, updated, and deprecated options in Mitaka for Telemetry
- ``[DEFAULT] event_dispatchers``
* - ``[DEFAULT] use_syslog``
- ``None``
* - ``[hyperv] force_volumeutils_v1``
- ``None``

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

@@ -1,5 +1,5 @@
New, updated, and deprecated options in Mitaka for OpenStack Block Storage
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
New, updated, and deprecated options in Mitaka for Block Storage
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
Warning: Do not edit this file. It is automatically generated and your
@@ -12,16 +12,74 @@ New, updated, and deprecated options in Mitaka for OpenStack 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] 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``
@@ -37,23 +95,197 @@ New, updated, and deprecated options in Mitaka for OpenStack Block Storage
* - ``[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``
- ``(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.``
- ``(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 = device_target_id:<required>,managed_backend_name:<host@backend_name>,key1:value1,key2:value2...``
- ``(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-'.``
- ``(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.``
.. list-table:: New default values
:header-rows: 1
@@ -62,9 +294,27 @@ New, updated, and deprecated options in Mitaka for OpenStack Block Storage
* - Option
- Previous default value
- New default value
* - ``[DEFAULT] datera_api_version``
- ``1``
- ``2``
* - ``[DEFAULT] datera_num_replicas``
- ``3``
- ``1``
* - ``[DEFAULT] glance_api_servers``
- ``$glance_host:$glance_port``
- ``None``
* - ``[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``
.. list-table:: Deprecated options
:header-rows: 1
@@ -72,10 +322,10 @@ New, updated, and deprecated options in Mitaka for OpenStack Block Storage
* - Deprecated option
- New Option
* - ``[DEFAULT] datera_api_token``
- ``None``
* - ``[DEFAULT] enable_v1_api``
- ``None``
* - ``[DEFAULT] enable_v2_api``
- ``None``
* - ``[DEFAULT] eqlx_chap_login``
- ``[DEFAULT] chap_username``
* - ``[DEFAULT] eqlx_chap_password``
@@ -104,8 +354,60 @@ New, updated, and deprecated options in Mitaka for OpenStack Block Storage
- ``[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] 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``

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

@@ -1,5 +1,5 @@
New, updated, and deprecated options in Mitaka for OpenStack Image service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
New, updated, and deprecated options in Mitaka for Image service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
Warning: Do not edit this file. It is automatically generated and your
@@ -12,48 +12,8 @@ New, updated, and deprecated options in Mitaka for OpenStack Image service
* - Option = default value
- (Type) Help string
* - ``[glance_store] default_swift_reference = ref1``
- ``(StrOpt) The reference to the default swift account/backing store parameters to use for adding new images.``
* - ``[glance_store] swift_store_admin_tenants =``
- ``(ListOpt) A list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode.``
* - ``[glance_store] swift_store_auth_address = None``
- ``(StrOpt) The address where the Swift authentication service is listening. (deprecated - use "auth_address" in swift_store_config_file)``
* - ``[glance_store] swift_store_auth_insecure = False``
- ``(BoolOpt) If True, swiftclient won't check for a valid SSL certificate when authenticating.``
* - ``[glance_store] swift_store_auth_version = 2``
- ``(StrOpt) Version of the authentication service to use. Valid versions are 2 and 3 for keystone and 1 (deprecated) for swauth and rackspace. (deprecated - use "auth_version" in swift_store_config_file)``
* - ``[glance_store] swift_store_cacert = None``
- ``(StrOpt) A string giving the CA certificate file to use in SSL connections for verifying certs.``
* - ``[glance_store] swift_store_config_file = None``
- ``(StrOpt) The config file that has the swift account(s)configs.``
* - ``[glance_store] swift_store_container = glance``
- ``(StrOpt) Container within the account that the account should use for storing images in Swift when using single container mode. In multiple container mode, this will be the prefix for all containers.``
* - ``[glance_store] swift_store_create_container_on_put = False``
- ``(BoolOpt) A boolean value that determines if we create the container if it does not exist.``
* - ``[glance_store] swift_store_endpoint = None``
- ``(StrOpt) If set, the configured endpoint will be used. If None, the storage url from the auth response will be used.``
* - ``[glance_store] swift_store_endpoint_type = publicURL``
- ``(StrOpt) A string giving the endpoint type of the swift service to use (publicURL, adminURL or internalURL). This setting is only used if swift_store_auth_version is 2.``
* - ``[glance_store] swift_store_key = None``
- ``(StrOpt) Auth key for the user authenticating against the Swift authentication service. (deprecated - use "key" in swift_store_config_file)``
* - ``[glance_store] swift_store_large_object_chunk_size = 200``
- ``(IntOpt) The amount of data written to a temporary disk buffer during the process of chunking the image file.``
* - ``[glance_store] swift_store_large_object_size = 5120``
- ``(IntOpt) The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift.``
* - ``[glance_store] swift_store_multi_tenant = False``
- ``(BoolOpt) If set to True, enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts.``
* - ``[glance_store] swift_store_multiple_containers_seed = 0``
- ``(IntOpt) When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a single-tenant store will use multiple containers to store images, and this value will determine how many containers are created.Used only when swift_store_multi_tenant is disabled. The total number of containers that will be used is equal to 16^N, so if this config option is set to 2, then 16^2=256 containers will be used to store images.``
* - ``[glance_store] swift_store_region = None``
- ``(StrOpt) The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints.``
* - ``[glance_store] swift_store_retry_get_count = 0``
- ``(IntOpt) The number of times a Swift download will be retried before the request fails.``
* - ``[glance_store] swift_store_service_type = object-store``
- ``(StrOpt) A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is 2.``
* - ``[glance_store] swift_store_ssl_compression = True``
- ``(BoolOpt) If set to False, disables SSL layer compression of https swift requests. Setting to False may improve performance for images which are already in a compressed format, eg qcow2.``
* - ``[glance_store] swift_store_user = None``
- ``(StrOpt) The user to authenticate against the Swift authentication service (deprecated - use "user" in swift_store_config_file)``
* - ``[profiler] hmac_keys = SECRET_KEY``
- ``(StrOpt) Secret key to use to sign Glance API and Glance Registry services tracing messages.``
.. list-table:: New default values
:header-rows: 1
@@ -65,6 +25,12 @@ New, updated, and deprecated options in Mitaka for OpenStack Image service
* - ``[DEFAULT] allowed_rpc_exception_modules``
- ``glance.common.exception, exceptions``
- ``glance.common.exception, builtins, exceptions``
* - ``[DEFAULT] workers``
- ``4``
- ``None``
* - ``[image_format] container_formats``
- ``ami, ari, aki, bare, ovf, ova``
- ``ami, ari, aki, bare, ovf, ova, docker``
.. list-table:: Deprecated options
:header-rows: 1
@@ -74,8 +40,4 @@ New, updated, and deprecated options in Mitaka for OpenStack Image service
- New Option
* - ``[DEFAULT] use_syslog``
- ``None``
* - ``[glance_store] vmware_datacenter_path``
- ``None``
* - ``[glance_store] vmware_datastore_name``
- ``None``

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

@@ -12,13 +12,44 @@ 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 to use to sign tracing messages.``
- ``(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.``
.. list-table:: New default values
:header-rows: 1
:class: config-ref-table
* - 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``
.. list-table:: Deprecated options
:header-rows: 1
@@ -28,4 +59,6 @@ New, updated, and deprecated options in Mitaka for Orchestration
- New Option
* - ``[DEFAULT] use_syslog``
- ``None``
* - ``[profiler] profiler_enabled``
- ``[profiler] enabled``

42
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 Mitaka for Bare Metal service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
@@ -12,12 +12,48 @@ 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``
@@ -31,7 +67,9 @@ New, updated, and deprecated options in Mitaka for Bare metal service
* - ``[oneview] username = None``
- ``(StrOpt) OneView username to be used``
* - ``[pxe] ip_version = 4``
- ``(StrOpt) The IP version that will be used for PXE booting. Can be either 4 or 6. Defaults to 4. EXPERIMENTAL``
- ``(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``

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

@@ -1,5 +1,5 @@
New, updated, and deprecated options in Mitaka for OpenStack Identity
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
New, updated, and deprecated options in Mitaka for Identity service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
Warning: Do not edit this file. It is automatically generated and your
@@ -12,10 +12,28 @@ New, updated, and deprecated options in Mitaka for OpenStack Identity
* - Option = default value
- (Type) Help string
* - ``[ldap] project_enabled_emulation_use_group_config = False``
- ``(BoolOpt) Use the "group_member_attribute" and "group_objectclass" settings to determine membership in the emulated enabled group.``
* - ``[ldap] user_enabled_emulation_use_group_config = False``
- ``(BoolOpt) Use the "group_member_attribute" and "group_objectclass" settings to determine membership in the emulated enabled group.``
* - ``[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
@@ -24,12 +42,27 @@ New, updated, and deprecated options in Mitaka for OpenStack Identity
* - 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

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

@@ -12,8 +12,42 @@ 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``
- ``(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``
@@ -22,6 +56,8 @@ New, updated, and deprecated options in Mitaka for Shared File Systems service
- ``(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 =``
@@ -32,9 +68,141 @@ New, updated, and deprecated options in Mitaka for Shared File Systems service
- ``(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``
.. list-table:: New default values
:header-rows: 1
:class: config-ref-table
* - 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] 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``
.. list-table:: Deprecated options
:header-rows: 1
@@ -42,8 +210,18 @@ 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``
@@ -66,6 +244,14 @@ New, updated, and deprecated options in Mitaka for Shared File Systems service
- ``[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] sql_idle_timeout``
- ``[database] idle_timeout``
* - ``[DEFAULT] sql_max_retries``

104
doc/config-reference/source/tables/conf-changes/neutron.rst
View File

@@ -1,5 +1,5 @@
New, updated, and deprecated options in Mitaka for OpenStack Networking
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
New, updated, and deprecated options in Mitaka for Networking
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
Warning: Do not edit this file. It is automatically generated and your
@@ -12,60 +12,72 @@ New, updated, and deprecated options in Mitaka for OpenStack Networking
* - Option = default value
- (Type) Help string
* - ``[DEFAULT] bgp_drscheduler_driver = neutron.services.bgp.scheduler.bgp_dragent_scheduler.ChanceScheduler``
- ``(StrOpt) Driver used for scheduling BGP speakers to BGP DrAgent``
* - ``[DEFAULT] default_availability_zones =``
- ``(ListOpt) Default value of availability zone hints. The availability zone aware schedulers use this when the resources availability_zone_hints is empty. Multiple availability zones can be specified by a comma separated string. This value can be empty. In this case, even if availability_zone_hints for a resource is empty, availability zone is considered for high availability while scheduling the resource.``
* - ``[DEFAULT] dnsmasq_local_resolv = False``
- ``(BoolOpt) Enables the dnsmasq service to provide name resolution for instances via DNS resolvers on the host running the DHCP agent. Effectively removes the '--no-resolv' option from the dnsmasq process arguments. Adding custom DNS resolvers to the 'dnsmasq_dns_servers' option disables this feature.``
* - ``[DEFAULT] external_dns_driver = None``
- ``(StrOpt) Driver for external DNS integration.``
* - ``[DEFAULT] global_physnet_mtu = 1500``
- ``(IntOpt) MTU of the underlying physical network. Neutron uses this value to calculate MTU for all virtual network components. For flat and VLAN networks, neutron uses this value without modification. For overlay networks such as VXLAN, neutron automatically subtracts the overlay protocol overhead from this value. Defaults to 1500, the standard value for Ethernet.``
* - ``[DEFAULT] ipv6_pd_enabled = False``
- ``(BoolOpt) Enables IPv6 Prefix Delegation for automatic subnet CIDR allocation. Set to True to enable IPv6 Prefix Delegation for subnet allocation in a PD-capable environment. Users making subnet creation requests for IPv6 subnets without providing a CIDR or subnetpool ID will be given a CIDR via the Prefix Delegation mechanism. Note that enabling PD will override the behavior of the default IPv6 subnetpool.``
* - ``[DEFAULT] notification_driver = []``
- ``(MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop``
* - ``[DEFAULT] notification_topics = notifications``
- ``(ListOpt) AMQP topic used for OpenStack notifications.``
* - ``[DEFAULT] notification_transport_url = None``
- ``(StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.``
* - ``[DEFAULT] max_rtr_adv_interval = 100``
- ``(IntOpt) MaxRtrAdvInterval setting for radvd.conf``
* - ``[DEFAULT] min_rtr_adv_interval = 30``
- ``(IntOpt) MinRtrAdvInterval setting for radvd.conf``
* - ``[DEFAULT] rpc_state_report_workers = 1``
- ``(IntOpt) Number of RPC worker processes dedicated to state reports queue``
* - ``[DEFAULT] wsgi_default_pool_size = 1000``
* - ``[DEFAULT] web_framework = legacy``
- ``(StrOpt) This will choose the web framework in which to run the Neutron API server. 'pecan' is a new experiemental rewrite of the API server.``
* - ``[DEFAULT] wsgi_default_pool_size = 100``
- ``(IntOpt) Size of the pool of greenthreads used by wsgi``
* - ``[DEFAULT] wsgi_log_format = %(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f``
- ``(StrOpt) A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.``
* - ``[AGENT] availability_zone = nova``
- ``(StrOpt) Availability zone of this node``
* - ``[BGP] bgp_router_id = None``
- ``(StrOpt) 32-bit BGP identifier, typically an IPv4 address owned by the system running the BGP DrAgent.``
* - ``[BGP] bgp_speaker_driver = None``
- ``(StrOpt) BGP speaker driver class to be instantiated.``
* - ``[OVS] ovsdb_connection = tcp:127.0.0.1:6640``
- ``(StrOpt) The connection string for the native OVSDB backend. Requires the native ovsdb_interface to be enabled.``
* - ``[OVS] vhostuser_socket_dir = /var/run/openvswitch``
- ``(StrOpt) OVS vhost-user socket directory.``
* - ``[QOS] kernel_hz = 250``
- ``(IntOpt) Value of host kernel tick rate (hz) for calculating minimum burst value in bandwidth limit rules for a port with QoS. See kernel configuration file for HZ value and tc-tbf manual for more information.``
* - ``[QOS] tbf_latency = 50``
- ``(IntOpt) Value of latency (ms) for calculating size of queue for a port with QoS. See tc-tbf manual for more information.``
* - ``[VXLAN] arp_responder = False``
- ``(BoolOpt) Enable local ARP responder which provides local responses instead of performing ARP broadcast into the overlay. Enabling local ARP responder is not fullycompatible with the allowed-address-pairs extension.``
* - ``[designate] admin_auth_url = None``
- ``(StrOpt) Authorization URL for connecting to designate in admin context``
* - ``[designate] admin_password = None``
- ``(StrOpt) Password for connecting to designate in admin context``
* - ``[designate] admin_tenant_id = None``
- ``(StrOpt) Tenant id for connecting to designate in admin context``
* - ``[designate] admin_tenant_name = None``
- ``(StrOpt) Tenant name for connecting to designate in admin context``
* - ``[designate] admin_username = None``
- ``(StrOpt) Username for connecting to designate in admin context``
* - ``[designate] allow_reverse_dns_lookup = True``
- ``(BoolOpt) Allow the creation of PTR records``
* - ``[designate] ipv4_ptr_zone_prefix_size = 24``
- ``(IntOpt) Number of bits in an ipv4 PTR zone that will be considered network prefix. It has to align to byte boundary. Minimum value is 8. Maximum value is 24. As a consequence, range of values is 8, 16 and 24``
* - ``[designate] ipv6_ptr_zone_prefix_size = 120``
- ``(IntOpt) Number of bits in an ipv6 PTR zone that will be considered network prefix. It has to align to nyble boundary. Minimum value is 4. Maximum value is 124. As a consequence, range of values is 4, 8, 12, 16,..., 124``
* - ``[designate] ptr_zone_email =``
- ``(StrOpt) The email address to be used when creating PTR zones. If not specified, the email address will be admin@<dns_domain>``
* - ``[designate] url = None``
- ``(StrOpt) URL for connecting to designate``
* - ``[macvtap] physical_interface_mappings =``
- ``(ListOpt) Comma-separated list of <physical_network>:<physical_interface> tuples mapping physical network names to the agent's node-specific physical network interfaces to be used for flat and VLAN networks. All physical networks listed in network_vlan_ranges on the server should have mappings to appropriate interfaces on each agent.``
* - ``[nova] auth_type = None``
- ``(Opt) Authentication type to load``
* - ``[oslo_messaging_qpid] amqp_auto_delete = False``
- ``(BoolOpt) Auto-delete queues in AMQP.``
* - ``[oslo_messaging_qpid] amqp_durable_queues = False``
- ``(BoolOpt) Use durable queues in AMQP.``
* - ``[oslo_messaging_qpid] qpid_heartbeat = 60``
- ``(IntOpt) Seconds between connection keepalive heartbeats.``
* - ``[oslo_messaging_qpid] qpid_hostname = localhost``
- ``(StrOpt) Qpid broker hostname.``
* - ``[oslo_messaging_qpid] qpid_hosts = $qpid_hostname:$qpid_port``
- ``(ListOpt) Qpid HA cluster host:port pairs.``
* - ``[oslo_messaging_qpid] qpid_password =``
- ``(StrOpt) Password for Qpid connection.``
* - ``[oslo_messaging_qpid] qpid_port = 5672``
- ``(IntOpt) Qpid broker port.``
* - ``[oslo_messaging_qpid] qpid_protocol = tcp``
- ``(StrOpt) Transport to use, either 'tcp' or 'ssl'.``
* - ``[oslo_messaging_qpid] qpid_receiver_capacity = 1``
- ``(IntOpt) The number of prefetched messages held by receiver.``
* - ``[oslo_messaging_qpid] qpid_sasl_mechanisms =``
- ``(StrOpt) Space separated list of SASL mechanisms to use for auth.``
* - ``[oslo_messaging_qpid] qpid_tcp_nodelay = True``
- ``(BoolOpt) Whether to disable the Nagle algorithm.``
* - ``[oslo_messaging_qpid] qpid_topology_version = 1``
- ``(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.``
* - ``[oslo_messaging_qpid] qpid_username =``
- ``(StrOpt) Username for Qpid connection.``
* - ``[oslo_messaging_qpid] send_single_reply = False``
- ``(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.``
* - ``[oslo_messaging_rabbit] kombu_reconnect_timeout = 60``
- ``(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout.``
* - ``[nova] endpoint_type = public``
- ``(StrOpt) Type of the nova endpoint to use. This endpoint will be looked up in the keystone catalog and should be one of public, internal or admin.``
.. list-table:: New default values
:header-rows: 1
@@ -74,12 +86,18 @@ New, updated, and deprecated options in Mitaka for OpenStack Networking
* - Option
- Previous default value
- New default value
* - ``[DEFAULT] advertise_mtu``
- ``False``
- ``True``
* - ``[DEFAULT] host``
- ``localhost``
- ``example.domain``
* - ``[DEFAULT] zmq_use_broker``
- ``False``
- ``True``
* - ``[AGENT] veth_mtu``
- ``None``
- ``9000``
* - ``[ml2] path_mtu``
- ``0``
- ``1500``
* - ``[ml2_type_flat] flat_networks``
-
- ``*``
@@ -92,4 +110,6 @@ New, updated, and deprecated options in Mitaka for OpenStack Networking
- New Option
* - ``[DEFAULT] use_syslog``
- ``None``
* - ``[ml2] segment_mtu``
- ``[DEFAULT] global_physnet_mtu``

152
doc/config-reference/source/tables/conf-changes/nova.rst
View File

@@ -1,5 +1,5 @@
New, updated, and deprecated options in Mitaka for OpenStack Compute
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
New, updated, and deprecated options in Mitaka for Compute
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
Warning: Do not edit this file. It is automatically generated and your
@@ -12,8 +12,70 @@ New, updated, and deprecated options in Mitaka for OpenStack Compute
* - Option = default value
- (Type) Help string
* - ``[DEFAULT] disk_weight_multiplier = 1.0``
- ``(FloatOpt) Multiplier used for weighing free disk space. Negative numbers mean to stack vs spread.``
* - ``[DEFAULT] notification_format = both``
- ``(StrOpt) Specifies which notification format shall be used by nova.``
* - ``[DEFAULT] soft_affinity_weight_multiplier = 1.0``
- ``(FloatOpt) Multiplier used for weighing hosts for group soft-affinity. Only a positive value is meaningful. Negative means that the behavior will change to the opposite, which is soft-anti-affinity.``
* - ``[DEFAULT] soft_anti_affinity_weight_multiplier = 1.0``
- ``(FloatOpt) Multiplier used for weighing hosts for group soft-anti-affinity. Only a positive value is meaningful. Negative means that the behavior will change to the opposite, which is soft-affinity.``
* - ``[DEFAULT] use_neutron = False``
- ``(BoolOpt) Whether to use Neutron or Nova Network as the back end for networking. Defaults to False (indicating Nova network). Set to True to use neutron.``
* - ``[cache] backend = dogpile.cache.null``
- ``(StrOpt) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend.``
* - ``[cache] backend_argument = []``
- ``(MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: "<argname>:<value>".``
* - ``[cache] config_prefix = cache.oslo``
- ``(StrOpt) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name.``
* - ``[cache] debug_cache_backend = False``
- ``(BoolOpt) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false.``
* - ``[cache] enabled = False``
- ``(BoolOpt) Global toggle for caching.``
* - ``[cache] expiration_time = 600``
- ``(IntOpt) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it.``
* - ``[cache] memcache_dead_retry = 300``
- ``(IntOpt) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).``
* - ``[cache] memcache_pool_connection_get_timeout = 10``
- ``(IntOpt) Number of seconds that an operation will wait to get a memcache client connection.``
* - ``[cache] memcache_pool_maxsize = 10``
- ``(IntOpt) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only).``
* - ``[cache] memcache_pool_unused_timeout = 60``
- ``(IntOpt) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only).``
* - ``[cache] memcache_servers = localhost:11211``
- ``(ListOpt) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).``
* - ``[cache] memcache_socket_timeout = 3``
- ``(IntOpt) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).``
* - ``[cache] proxies =``
- ``(ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior.``
* - ``[cells] instance_update_sync_database_limit = 100``
- ``(IntOpt) Number of instances to pull from the database at one time for a sync. If there are more instances to update the results will be paged through``
- ``(IntOpt) Instance update sync database limit Number of instances to pull from the database at one time for a sync. If there are more instances to update the results will be paged through. Possible values: * Number of instances. Services which consume this: * nova-cells Related options: * None``
* - ``[glance] verify_glance_signatures = False``
- ``(BoolOpt) Require Nova to perform signature verification on each image downloaded from Glance.``
* - ``[libvirt] live_migration_inbound_addr = None``
- ``(StrOpt) Live migration target ip or hostname (if this option is set to None, which is the default, the hostname of the migration target compute node will be used)``
* - ``[libvirt] live_migration_tunnelled = None``
- ``(BoolOpt) Whether to use tunnelled migration, where migration data is transported over the libvirtd connection. If True, we use the VIR_MIGRATE_TUNNELLED migration flag, avoiding the need to configure the network to allow direct hypervisor to hypervisor communication. If False, use the native transport. If not set, Nova will choose a sensible default based on, for example the availability of native encryption support in the hypervisor.``
* - ``[libvirt] realtime_scheduler_priority = 1``
- ``(IntOpt) In a realtime host context vCPUs for guest will run in that scheduling priority. Priority depends on the host kernel (usually 1-99)``
* - ``[neutron] auth_type = None``
- ``(Opt) Authentication type to load``
* - ``[osapi_v21] project_id_regex = None``
- ``(StrOpt) DEPRECATED: The validation regex for project_ids used in urls. This defaults to [0-9a-f\-]+ if not set, which matches normal uuids created by keystone.``
* - ``[oslo_policy] policy_default_rule = default``
- ``(StrOpt) Default rule. Enforced when a requested rule is not found.``
* - ``[oslo_policy] policy_dirs = ['policy.d']``
- ``(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.``
* - ``[oslo_policy] policy_file = policy.json``
- ``(StrOpt) The JSON file that defines policies.``
* - ``[vnc] novncproxy_host = 0.0.0.0``
- ``(StrOpt) IP address that the noVNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. noVNC provides VNC support through a websocket-based client. This option sets the private address to which the noVNC console proxy service should bind to. Possible values: * An IP address Services which consume this: * ``nova-compute`` Related options: * novncproxy_port * novncproxy_base_url``
* - ``[vnc] novncproxy_port = 6080``
- ``(IntOpt) Port that the noVNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. noVNC provides VNC support through a websocket-based client. This option sets the private port to which the noVNC console proxy service should bind to. Possible values: * A port number Services which consume this: * ``nova-compute`` Related options: * novncproxy_host * novncproxy_base_url``
* - ``[vnc] xvpvncproxy_host = 0.0.0.0``
- ``(StrOpt) IP address that the XVP VNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. Xen provides the Xenserver VNC Proxy, or XVP, as an alternative to the websocket-based noVNC proxy used by Libvirt. In contrast to noVNC, XVP clients are Java-based. This option sets the private address to which the XVP VNC console proxy service should bind to. Possible values: * An IP address Services which consume this: * ``nova-compute`` Related options: * xvpvncproxy_port * xvpvncproxy_base_url``
* - ``[vnc] xvpvncproxy_port = 6081``
- ``(IntOpt) Port that the XVP VNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. Xen provides the Xenserver VNC Proxy, or XVP, as an alternative to the websocket-based noVNC proxy used by Libvirt. In contrast to noVNC, XVP clients are Java-based. This option sets the private port to which the XVP VNC console proxy service should bind to. Possible values: * A port number Services which consume this: * ``nova-compute`` Related options: * xvpvncproxy_host * xvpvncproxy_base_url``
.. list-table:: New default values
:header-rows: 1
@@ -24,10 +86,28 @@ New, updated, and deprecated options in Mitaka for OpenStack Compute
- New default value
* - ``[DEFAULT] compute_resources``
- ``vcpu``
- `` ``
-
* - ``[DEFAULT] disk_allocation_ratio``
- ``1.0``
- ``0.0``
* - ``[DEFAULT] enabled_apis``
- ``ec2, osapi_compute, metadata``
- ``osapi_compute, metadata``
* - ``[DEFAULT] force_config_drive``
- ``None``
- ``False``
* - ``[DEFAULT] monkey_patch_modules``
- ``nova.api.ec2.cloud:nova.notifications.notify_decorator, nova.compute.api:nova.notifications.notify_decorator``
- ``nova.compute.api:nova.notifications.notify_decorator``
* - ``[DEFAULT] scheduler_driver``
- ``nova.scheduler.filter_scheduler.FilterScheduler``
- ``filter_scheduler``
* - ``[DEFAULT] scheduler_host_manager``
- ``nova.scheduler.host_manager.HostManager``
- ``host_manager``
* - ``[libvirt] live_migration_uri``
- ``qemu+tcp://%s/system``
- ``None``
* - ``[vmware] integration_bridge``
- ``br-int``
- ``None``
@@ -38,52 +118,76 @@ New, updated, and deprecated options in Mitaka for OpenStack Compute
* - Deprecated option
- New Option
* - ``[DEFAULT] cert_manager``
- ``None``
* - ``[DEFAULT] compute_available_monitors``
- ``None``
* - ``[DEFAULT] compute_manager``
- ``None``
* - ``[DEFAULT] compute_resources``
- ``None``
* - ``[DEFAULT] compute_stats_class``
- ``None``
* - ``[DEFAULT] console_manager``
- ``None``
* - ``[DEFAULT] consoleauth_manager``
- ``None``
* - ``[DEFAULT] db_driver``
- ``None``
* - ``[DEFAULT] memcached_servers``
- ``None``
* - ``[DEFAULT] metadata_manager``
- ``None``
* - ``[DEFAULT] network_api_class``
- ``None``
* - ``[DEFAULT] network_device_mtu``
- ``None``
* - ``[DEFAULT] osapi_compute_ext_list``
- ``None``
* - ``[DEFAULT] scheduler_manager``
- ``None``
* - ``[DEFAULT] security_group_api``
- ``None``
* - ``[DEFAULT] share_dhcp_address``
- ``None``
* - ``[DEFAULT] ssl_ca_file``
- ``[ssl] ca_file``
* - ``[DEFAULT] ssl_cert_file``
- ``[ssl] cert_file``
* - ``[DEFAULT] ssl_key_file``
- ``[ssl] key_file``
* - ``[DEFAULT] use_syslog``
- ``None``
* - ``[DEFAULT] vendordata_driver``
- ``None``
* - ``[DEFAULT] volume_api_class``
- ``None``
* - ``[cells] manager``
- ``None``
* - ``[conductor] manager``
- ``None``
* - ``[conductor] use_local``
- ``None``
* - ``[glance] host``
- ``None``
* - ``[glance] port``
- ``None``
* - ``[glance] protocol``
- ``None``
* - ``[hyperv] force_volumeutils_v1``
- ``None``
* - ``[ironic] admin_auth_token``
- ``None``
* - ``[ironic] api_version``
- ``None``
* - ``[ironic] client_log_level``
- ``None``
* - ``[libvirt] remove_unused_kernels``
- ``None``
* - ``[neutron] admin_auth_url``
- ``None``
* - ``[neutron] admin_password``
- ``None``
* - ``[neutron] admin_tenant_id``
- ``None``
* - ``[neutron] admin_tenant_name``
- ``None``
* - ``[neutron] admin_user_id``
- ``None``
* - ``[neutron] admin_username``
- ``None``
* - ``[neutron] auth_strategy``
- ``None``
* - ``[osapi_v21] enabled``
- ``None``
* - ``[osapi_v21] extensions_blacklist``
- ``None``
* - ``[osapi_v21] extensions_whitelist``
- ``None``
* - ``[osapi_v21] project_id_regex``
- ``None``
* - ``[serial_console] listen``
- ``None``
* - ``[workarounds] destroy_after_evacuate``
- ``None``

39
doc/config-reference/source/tables/conf-changes/sahara.rst
View File

@@ -6,6 +6,36 @@ New, updated, and deprecated options in Mitaka for Data Processing 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] coordinator_heartbeat_interval = 1``
- ``(IntOpt) Interval size between heartbeat execution in seconds. Heartbeats are executed to make sure that connection to the coordination server is active.``
* - ``[DEFAULT] hash_ring_replicas_count = 40``
- ``(IntOpt) Number of points that belongs to each member on a hash ring. The larger number leads to a better distribution.``
* - ``[DEFAULT] periodic_coordinator_backend_url = None``
- ``(StrOpt) The backend URL to use for distributed periodic tasks coordination.``
* - ``[DEFAULT] periodic_workers_number = 1``
- ``(IntOpt) Number of threads to run periodic tasks.``
* - ``[DEFAULT] use_barbican_key_manager = False``
- ``(BoolOpt) Enable the usage of the OpenStack Key Management service provided by barbican.``
* - ``[castellan] barbican_api_endpoint = None``
- ``(StrOpt) The endpoint to use for connecting to the barbican api controller. By default, castellan will use the URL from the service catalog.``
* - ``[castellan] barbican_api_version = v1``
- ``(StrOpt) Version of the barbican API, for example: "v1"``
* - ``[cluster_verifications] verification_enable = True``
- ``(BoolOpt) Option to enable verifications for all clusters``
* - ``[cluster_verifications] verification_periodic_interval = 600``
- ``(IntOpt) Interval between two consecutive periodic tasks forverifications, in seconds.``
* - ``[oslo_messaging_notifications] enable = False``
- ``(BoolOpt) Enables sending notifications to Ceilometer``
* - ``[oslo_messaging_notifications] level = INFO``
- ``(StrOpt) Notification level for outgoing notifications``
* - ``[oslo_messaging_notifications] publisher_id = None``
- ``(StrOpt) Notification publisher_id for outgoing notifications``
.. list-table:: New default values
:header-rows: 1
@@ -17,6 +47,9 @@ New, updated, and deprecated options in Mitaka for Data Processing service
* - ``[DEFAULT] api_workers``
- ``0``
- ``1``
* - ``[DEFAULT] plugins``
- ``vanilla, hdp, spark, cdh``
- ``vanilla, spark, cdh, ambari``
.. list-table:: Deprecated options
:header-rows: 1
@@ -24,6 +57,12 @@ New, updated, and deprecated options in Mitaka for Data Processing service
* - Deprecated option
- New Option
* - ``[DEFAULT] enable_notifications``
- ``[oslo_messaging_notifications] enable``
* - ``[DEFAULT] notification_level``
- ``[oslo_messaging_notifications] level``
* - ``[DEFAULT] notification_publisher_id``
- ``[oslo_messaging_notifications] publisher_id``
* - ``[DEFAULT] use_syslog``
- ``None``

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

@@ -12,16 +12,44 @@ 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] nova_client_version = 2``
- ``(IntOpt) The version of of the compute service client.``
* - ``[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``
@@ -29,7 +57,7 @@ New, updated, and deprecated options in Mitaka for Database service
* - ``[cors] allow_methods = GET, POST, PUT, DELETE, OPTIONS``
- ``(ListOpt) Indicate which methods can be used during the actual request.``
* - ``[cors] allowed_origin = None``
- ``(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.``
- ``(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``
@@ -41,29 +69,119 @@ New, updated, and deprecated options in Mitaka for Database service
* - ``[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``
- ``(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.``
- ``(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.``
- ``(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``
.. list-table:: New default values
:header-rows: 1
@@ -75,9 +193,81 @@ New, updated, and deprecated options in Mitaka for Database service
* - ``[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``
* - ``[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``
* - ``[mongodb] root_controller``
- ``trove.extensions.common.service.DefaultRootController``
- ``trove.extensions.mongodb.service.MongoDBRootController``
* - ``[mongodb] tcp_ports``
- ``2500, 27017``
- ``2500, 27017, 27019``
* - ``[mysql] 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``
.. list-table:: Deprecated options
:header-rows: 1
@@ -85,6 +275,8 @@ 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``
@@ -94,9 +286,11 @@ New, updated, and deprecated options in Mitaka for Database service
* - ``[DEFAULT] ignore_users``
- ``[percona] ignore_users``
* - ``[DEFAULT] ignore_users``
- ``[mysql] 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``

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

@@ -8,6 +8,7 @@ Telemetry
telemetry/alarming_service_config_opts.rst
telemetry/logs.rst
telemetry/sample-configuration-files.rst
tables/conf-changes/aodh.rst
tables/conf-changes/ceilometer.rst
The Telemetry service collects measurements within OpenStack. Its