openstack/openstack-manuals
Code Issues Proposed changes

config-ref: update the new/deprecated options tables

Browse Source 
This patch includes options discovered by the recent autohelp.py
updates, and additional deprecated options discovered with
https://review.openstack.org/#/c/181650/

Change-Id: I6a525c70ebd3ee7a0f91dc831d39a93f1bce16fd
Closes-Bug: #1433367
This commit is contained in:
Gauvain Pocentek 2015-05-09 17:18:15 +02:00
parent 396ba7cee8
commit c96a5ab946
9 changed files with 368 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/common/tables/ceilometer-conf-changes.xml
View File

@ -316,6 +316,10 @@
<td>[oslo_messaging_rabbit] rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>[oslo_middleware] max_request_body_size = 114688</td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
<tr>
<td>[oslo_policy] policy_default_rule = default</td>
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
@ -389,13 +393,33 @@
<td>New Option</td>
</tr>
</thead>
<tr>
<td>[alarm] evaluation_service</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] log_format</td>
<td>None</td>
</tr>
<tr>
<td>[database] time_to_live</td>
<td>[database] metering_time_to_live</td>
</tr>
<tr>
<td>[DEFAULT] database_connection</td>
<td>None</td>
</tr>
<tr>
<td>[publisher] metering_secret</td>
<td>[publisher] telemetry_secret</td>
</tr>
<tr>
<td>[alarm] partition_rpc_topic</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] use_syslog</td>
<td>None</td>
</tr>
</table>
</section>

32
doc/common/tables/cinder-conf-changes.xml
View File

@ -584,6 +584,10 @@
<td>[oslo_messaging_rabbit] rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>[oslo_middleware] max_request_body_size = 114688</td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
</table>
<table>
<caption>New default values</caption>
@ -658,14 +662,38 @@
<td>New Option</td>
</tr>
</thead>
<tr>
<td>[DEFAULT] log-format</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] use-syslog</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] use_syslog</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] osapi_max_request_body_size</td>
<td>[oslo_middleware] max_request_body_size</td>
</tr>
<tr>
<td>[DEFAULT] eqlx_chap_password</td>
<td>[DEFAULT] chap_password</td>
</tr>
<tr>
<td>[DEFAULT] datera_api_token</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] eqlx_use_chap</td>
<td>[DEFAULT] use_chap_auth</td>
</tr>
<tr>
<td>[DEFAULT] enable_v1_api</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] db_backend</td>
<td>[database] backend</td>
@ -678,5 +706,9 @@
<td>[DEFAULT] eqlx_chap_login</td>
<td>[DEFAULT] chap_username</td>
</tr>
<tr>
<td>[DEFAULT] log_format</td>
<td>None</td>
</tr>
</table>
</section>

24
doc/common/tables/glance-conf-changes.xml
View File

@ -523,9 +523,33 @@
<td>New Option</td>
</tr>
</thead>
<tr>
<td>[DEFAULT] log-format</td>
<td>None</td>
</tr>
<tr>
<td>[glance_store] vmware_datacenter_path</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] log_format</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] use-syslog</td>
<td>None</td>
</tr>
<tr>
<td>[task] eventlet_executor_pool_size</td>
<td>[taskflow_executor] max_workers</td>
</tr>
<tr>
<td>[glance_store] vmware_datastore_name</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] use_syslog</td>
<td>None</td>
</tr>
</table>
</section>

27
doc/common/tables/heat-conf-changes.xml
View File

@ -300,6 +300,10 @@
<td>[oslo_messaging_rabbit] rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>[oslo_middleware] max_request_body_size = 114688</td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
<tr>
<td>[profiler] profiler_enabled = False</td>
<td>(BoolOpt) If False fully disable profiling feature.</td>
@ -362,4 +366,27 @@
<td></td>
</tr>
</table>
<table>
<caption>Deprecated options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Deprecated option</td>
<td>New Option</td>
</tr>
</thead>
<tr>
<td>[DEFAULT] log-format</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] use-syslog</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] list_notifier_drivers</td>
<td>None</td>
</tr>
</table>
</section>

16
doc/common/tables/keystone-conf-changes.xml
View File

@ -352,6 +352,10 @@
<td>[oslo_messaging_rabbit] rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>[oslo_middleware] max_request_body_size = 114688</td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
<tr>
<td>[oslo_policy] policy_default_rule = default</td>
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
@ -469,6 +473,14 @@
<td>[DEFAULT] admin_bind_host</td>
<td>[eventlet_server] admin_bind_host</td>
</tr>
<tr>
<td>[DEFAULT] log-format</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] use-syslog</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] admin_workers</td>
<td>[eventlet_server] admin_workers</td>
@ -485,6 +497,10 @@
<td>[assignment] caching</td>
<td>[resource] caching</td>
</tr>
<tr>
<td>[DEFAULT] max_request_body_size</td>
<td>[oslo_middleware] max_request_body_size</td>
</tr>
<tr>
<td>[assignment] cache_time</td>
<td>[resource] cache_time</td>

195
doc/common/tables/neutron-conf-changes.xml
View File

@ -21,8 +21,8 @@
<td>(BoolOpt) Automatically remove networks from offline DHCP agents.</td>
</tr>
<tr>
<td>[DEFAULT] default_device_name = Switch1</td>
<td>(StrOpt) default_device_name of the l2 gateway</td>
<td>[DEFAULT] conn_idle_timeout = 900</td>
<td>(IntOpt) Reconnect connection to nsx if not used within this amount of time.</td>
</tr>
<tr>
<td>[DEFAULT] default_ipv4_subnet_pool = None</td>
@ -52,10 +52,6 @@
<td>[DEFAULT] ipv6_gateway = </td>
<td>(StrOpt) With IPv6, the network used for the external gateway does not need to have an associated subnet, since the automatically assigned link-local address (LLA) can be used. However, an IPv6 gateway address is needed for use as the next-hop for the default route. If no IPv6 gateway address is configured here, (and only then) the neutron router will be configured to get its default route from router advertisements (RAs) from the upstream router; in which case the upstream router must also be configured to send these RAs. The ipv6_gateway, when configured, should be the LLA of the interface on the upstream router. If a next-hop using a global unique address (GUA) is desired, it needs to be done via a subnet allocated to the network and not through this parameter.</td>
</tr>
<tr>
<td>[DEFAULT] l2gw_callback_class = networking_l2gw.services.l2gateway.ovsdb.data.L2GatewayOVSDBCallbacks</td>
<td>(StrOpt) L2 gateway plugin callback class where theRPCs from the agent are going to get invoked</td>
</tr>
<tr>
<td>[DEFAULT] log-config-append = None</td>
<td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
@ -100,10 +96,6 @@
<td>[DEFAULT] nova_admin_tenant_name = None</td>
<td>(StrOpt) The name of the admin nova tenant. Deprecated in favour of an auth plugin in [nova].</td>
</tr>
<tr>
<td>[DEFAULT] periodic_monitoring_interval = 5</td>
<td>(IntOpt) Periodic interval at which the plugin checks for the monitoring L2 gateway agent</td>
</tr>
<tr>
<td>[DEFAULT] policy_default_rule = default</td>
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
@ -112,10 +104,6 @@
<td>[DEFAULT] policy_dirs = ['policy.d']</td>
<td>(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.</td>
</tr>
<tr>
<td>[DEFAULT] quota_l2_gateway = 5</td>
<td>(IntOpt) Number of l2 gateways allowed per tenant, -1 for unlimited</td>
</tr>
<tr>
<td>[DEFAULT] syslog-log-facility = LOG_USER</td>
<td>(StrOpt) Syslog facility to receive log lines.</td>
@ -156,6 +144,10 @@
<td>[AGENT] use_helper_for_ns_read = True</td>
<td>(BoolOpt) Use the root helper to read the namespaces from the operating system.</td>
</tr>
<tr>
<td>[MIDONET] client = midonet.neutron.client.api.MidonetApiClient</td>
<td>(StrOpt) MidoNet client used to access MidoNet data storage.</td>
</tr>
<tr>
<td>[MIDONET] cluster_ip = localhost</td>
<td>(StrOpt) IP that the cluster service can be reached on</td>
@ -168,10 +160,6 @@
<td>[MIDONET] tunnel_protocol = vxlan</td>
<td>(StrOpt) Tunnel protocol used by Midonet</td>
</tr>
<tr>
<td>[MIDONET] use_cluster = False</td>
<td>(BoolOpt) Use the midonet plugin that interacts with the tasks-based architecture, rather than the plugin that interacts with the HTTP based architecture.</td>
</tr>
<tr>
<td>[OFC] support_packet_filter_on_ofc_router = True</td>
<td>(BoolOpt) Support packet filter on OFC router interface.</td>
@ -188,10 +176,18 @@
<td>[OVSVAPP] bridge_mappings = </td>
<td>(ListOpt) Bridge mappings.</td>
</tr>
<tr>
<td>[OVSVAPP] dont_fragment = True</td>
<td>(IntOpt) Do not fragment.</td>
</tr>
<tr>
<td>[OVSVAPP] integration_bridge = br-int</td>
<td>(StrOpt) Integration Bridge.</td>
</tr>
<tr>
<td>[OVSVAPP] local_ip = </td>
<td>(StrOpt) Local IP address of VXLAN tunnel endpoint.</td>
</tr>
<tr>
<td>[OVSVAPP] network_manager = networking_vsphere.drivers.manager.VcenterManager</td>
<td>(StrOpt) Driver Manager implementation for NetworkDriver.</td>
@ -206,12 +202,24 @@
</tr>
<tr>
<td>[OVSVAPP] tenant_network_type = vlan</td>
<td>(StrOpt) Network type for tenant networks - vlan.</td>
<td>(StrOpt) Network type for tenant networks</td>
</tr>
<tr>
<td>[OVSVAPP] tunnel_bridge = br-tun</td>
<td>(StrOpt) Tunnel Bridge for tunneling.</td>
</tr>
<tr>
<td>[OVSVAPP] tunnel_types = vxlan</td>
<td>(ListOpt) Tunnel network types supported by the OVSvApp Agent.</td>
</tr>
<tr>
<td>[OVSVAPP] veth_mtu = 1500</td>
<td>(IntOpt) MTU size of veth interfaces.</td>
</tr>
<tr>
<td>[OVSVAPP] vxlan_udp_port = 4789</td>
<td>(IntOpt) The UDP port to use for VXLAN tunnels.</td>
</tr>
<tr>
<td>[SECURITYGROUP] defer_apply = True</td>
<td>(BoolOpt) Enable defer_apply on security bridge.</td>
@ -472,6 +480,106 @@
<td>[nova] timeout = None</td>
<td>(IntOpt) Timeout value for http requests</td>
</tr>
<tr>
<td>[nsx_v3] default_edge_cluster_uuid = None</td>
<td>(StrOpt) Default edge cluster identifier</td>
</tr>
<tr>
<td>[nsxv] backup_edge_pool = service:large:4:10, service:compact:4:10, vdr:large:4:10</td>
<td>(ListOpt) Defines edge pool using the format: &lt;edge_type&gt;:[edge_size]:&lt;min_edges&gt;:&lt;max_edges&gt;.edge_type: service,vdr. edge_size: compact, large, xlarge, quadlarge and default is large.</td>
</tr>
<tr>
<td>[nsxv] cluster_moid = </td>
<td>(ListOpt) Parameter listing the IDs of the clusters which are used by OpenStack.</td>
</tr>
<tr>
<td>[nsxv] datacenter_moid = None</td>
<td>(StrOpt) Optional parameter identifying the ID of datacenter to deploy NSX Edges</td>
</tr>
<tr>
<td>[nsxv] datastore_id = None</td>
<td>(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges</td>
</tr>
<tr>
<td>[nsxv] deployment_container_id = None</td>
<td>(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges</td>
</tr>
<tr>
<td>[nsxv] dvs_id = None</td>
<td>(StrOpt) DVS ID for VLANs</td>
</tr>
<tr>
<td>[nsxv] external_network = None</td>
<td>(StrOpt) Network ID for physical network connectivity</td>
</tr>
<tr>
<td>[nsxv] manager_uri = None</td>
<td>(StrOpt) uri for vsm</td>
</tr>
<tr>
<td>[nsxv] maximum_tunnels_per_vnic = 20</td>
<td>(IntOpt) Maximum number of sub interfaces supported per vnic in edge. The value should be in 1-110.</td>
</tr>
<tr>
<td>[nsxv] metadata_shared_secret = None</td>
<td>(StrOpt) Shared secret to sign metadata requests</td>
</tr>
<tr>
<td>[nsxv] mgt_net_default_gateway = None</td>
<td>(StrOpt) Management network default gateway for metadata proxy</td>
</tr>
<tr>
<td>[nsxv] mgt_net_moid = None</td>
<td>(StrOpt) Network ID for management network connectivity</td>
</tr>
<tr>
<td>[nsxv] mgt_net_proxy_ips = None</td>
<td>(ListOpt) Management network IP address for metadata proxy</td>
</tr>
<tr>
<td>[nsxv] mgt_net_proxy_netmask = None</td>
<td>(StrOpt) Management network netmask for metadata proxy</td>
</tr>
<tr>
<td>[nsxv] nova_metadata_ips = None</td>
<td>(ListOpt) IP addresses used by Nova metadata service</td>
</tr>
<tr>
<td>[nsxv] nova_metadata_port = 8775</td>
<td>(IntOpt) TCP Port used by Nova metadata server</td>
</tr>
<tr>
<td>[nsxv] password = default</td>
<td>(StrOpt) Password for vsm</td>
</tr>
<tr>
<td>[nsxv] resource_pool_id = None</td>
<td>(StrOpt) Optional parameter identifying the ID of resource to deploy NSX Edges</td>
</tr>
<tr>
<td>[nsxv] retries = 10</td>
<td>(IntOpt) Maximum number of API retries on endpoint.</td>
</tr>
<tr>
<td>[nsxv] spoofguard_enabled = True</td>
<td>(BoolOpt) If True then plugin will use NSXV spoofguard component for port-security feature.</td>
</tr>
<tr>
<td>[nsxv] task_status_check_interval = 2000</td>
<td>(IntOpt) Task status check interval</td>
</tr>
<tr>
<td>[nsxv] tenant_router_types = shared, distributed, exclusive</td>
<td>(ListOpt) Ordered list of router_types to allocate as tenant routers.</td>
</tr>
<tr>
<td>[nsxv] user = admin</td>
<td>(StrOpt) User name for vsm</td>
</tr>
<tr>
<td>[nsxv] vdn_scope_id = None</td>
<td>(StrOpt) Network scope ID for VXLAN virtual wires</td>
</tr>
<tr>
<td>[oslo_concurrency] disable_process_locking = False</td>
<td>(BoolOpt) Enables or disables inter-process locks.</td>
@ -673,28 +781,8 @@
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>[ovsdb] l2_gw_agent_ca_cert_base_path = None</td>
<td>(StrOpt) Trusted issuer CA cert</td>
</tr>
<tr>
<td>[ovsdb] l2_gw_agent_cert_base_path = None</td>
<td>(StrOpt) L2 gateway agent public certificate</td>
</tr>
<tr>
<td>[ovsdb] l2_gw_agent_priv_key_base_path = None</td>
<td>(StrOpt) L2 gateway agent private key</td>
</tr>
<tr>
<td>[ovsdb] max_connection_retries = 10</td>
<td>(IntOpt) Maximum number of retries to open a socket with the OVSDB server</td>
</tr>
<tr>
<td>[ovsdb] ovsdb_hosts = host1:127.0.0.1:6632</td>
<td>(StrOpt) OVSDB server name:host/IP:port</td>
</tr>
<tr>
<td>[ovsdb] periodic_interval = 20</td>
<td>(IntOpt) Seconds between periodic task runs</td>
<td>[oslo_middleware] max_request_body_size = 114688</td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
</table>
<table>
@ -709,11 +797,6 @@
<td>New default value</td>
</tr>
</thead>
<tr>
<td>[DEFAULT] default_interface_name</td>
<td>breth0</td>
<td>FortyGigE1/0/1</td>
</tr>
<tr>
<td>[DEFAULT] default_log_levels</td>
<td>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
@ -795,10 +878,26 @@
<td>New Option</td>
</tr>
</thead>
<tr>
<td>[DEFAULT] use-syslog</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] use_syslog</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] max_request_body_size</td>
<td>[oslo_middleware] max_request_body_size</td>
</tr>
<tr>
<td>[DEFAULT] nova_api_insecure</td>
<td>[nova] insecure</td>
</tr>
<tr>
<td>[DEFAULT] log-format</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] nova_ca_certificates_file</td>
<td>[nova] cafile</td>
@ -807,5 +906,9 @@
<td>[DEFAULT] nova_region_name</td>
<td>[nova] region_name</td>
</tr>
<tr>
<td>[DEFAULT] log_format</td>
<td>None</td>
</tr>
</table>
</section>

68
doc/common/tables/nova-conf-changes.xml
View File

@ -528,6 +528,10 @@
<td>[oslo_messaging_rabbit] rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>[oslo_middleware] max_request_body_size = 114688</td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
<tr>
<td>[serial_console] serialproxy_host = 0.0.0.0</td>
<td>(StrOpt) Host on which to listen for incoming requests</td>
@ -618,18 +622,74 @@
<td>New Option</td>
</tr>
</thead>
<tr>
<td>[DEFAULT] network_device_mtu</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] log-format</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] use-syslog</td>
<td>None</td>
</tr>
<tr>
<td>[cinder] http_timeout</td>
<td>[cinder] timeout</td>
</tr>
<tr>
<td>[DEFAULT] use_syslog</td>
<td>None</td>
</tr>
<tr>
<td>[ironic] client_log_level</td>
<td>None</td>
</tr>
<tr>
<td>[neutron] admin_username</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] osapi_max_request_body_size</td>
<td>[oslo_middleware] max_request_body_size</td>
</tr>
<tr>
<td>[neutron] ca_certificates_file</td>
<td>[neutron] cafile</td>
</tr>
<tr>
<td>[neutron] auth_strategy</td>
<td>None</td>
</tr>
<tr>
<td>[neutron] admin_user_id</td>
<td>None</td>
</tr>
<tr>
<td>[neutron] admin_tenant_id</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] log_format</td>
<td>None</td>
</tr>
<tr>
<td>[cinder] api_insecure</td>
<td>[cinder] insecure</td>
</tr>
<tr>
<td>[neutron] admin_tenant_name</td>
<td>None</td>
</tr>
<tr>
<td>[neutron] admin_password</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] share_dhcp_address</td>
<td>None</td>
</tr>
<tr>
<td>[neutron] api_insecure</td>
<td>[neutron] insecure</td>
@ -638,9 +698,17 @@
<td>[cinder] ca_certificates_file</td>
<td>[cinder] cafile</td>
</tr>
<tr>
<td>[neutron] admin_auth_url</td>
<td>None</td>
</tr>
<tr>
<td>[neutron] url_timeout</td>
<td>[neutron] timeout</td>
</tr>
<tr>
<td>[neutron] allow_duplicate_networks</td>
<td>None</td>
</tr>
</table>
</section>

20
doc/common/tables/sahara-conf-changes.xml
View File

@ -324,6 +324,10 @@
<td>[oslo_messaging_rabbit] rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>[oslo_middleware] max_request_body_size = 114688</td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
<tr>
<td>[oslo_policy] policy_default_rule = default</td>
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
@ -423,9 +427,25 @@
<td>New Option</td>
</tr>
</thead>
<tr>
<td>[DEFAULT] log-format</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] use-syslog</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] detach_volume_timeout</td>
<td>[timeouts] detach_volume_timeout</td>
</tr>
<tr>
<td>[DEFAULT] log_format</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] use_syslog</td>
<td>None</td>
</tr>
</table>
</section>

8
doc/common/tables/trove-conf-changes.xml
View File

@ -542,6 +542,10 @@
<td>New Option</td>
</tr>
</thead>
<tr>
<td>[DEFAULT] use_syslog</td>
<td>None</td>
</tr>
<tr>
<td>[rpc_notifier2] topics</td>
<td>[DEFAULT] notification_topics</td>
@ -558,5 +562,9 @@
<td>[DEFAULT] sql_idle_timeout</td>
<td>[database] idle_timeout</td>
</tr>
<tr>
<td>[DEFAULT] log_format</td>
<td>None</td>
</tr>
</table>
</section>