Files
openstack-manuals/doc/common/tables/neutron-conf-changes.xml
Gauvain Pocentek 51245ab2c9 Updated tables for new/deprecated options
Closes-Bug: #1417725
Change-Id: I8de8746fe1f37983f16f244c79962f4e75b7b34b
2015-03-04 11:50:26 +00:00

367 lines
14 KiB
XML

<?xml version='1.0' encoding='UTF-8'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="neutron-conf-changes-kilo">
<!-- 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. -->
<title>New, updated and deprecated options in Kilo for OpenStack Networking</title>
<table>
<caption>New options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Option = default value</td>
<td>(Type) Help string</td>
</tr>
</thead>
<tr>
<td>[DEFAULT] allow_automatic_dhcp_failover = True</td>
<td>(BoolOpt) Automatically remove networks from offline DHCP agents.</td>
</tr>
<tr>
<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] dhcp_broadcast_reply = False</td>
<td>(BoolOpt) Use broadcast in DHCP replies</td>
</tr>
<tr>
<td>[DEFAULT] metadata_access_mark = 0x1</td>
<td>(StrOpt) Iptables mangle mark used to mark metadata valid requests</td>
</tr>
<tr>
<td>[DEFAULT] metadata_proxy_group = </td>
<td>(StrOpt) Group (gid or name) running metadata proxy after its initialization (if empty: L3 agent effective group)</td>
</tr>
<tr>
<td>[DEFAULT] metadata_proxy_user = </td>
<td>(StrOpt) User (uid or name) running metadata proxy after its initialization (if empty: L3 agent effective user)</td>
</tr>
<tr>
<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] policy_default_rule = default</td>
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
</tr>
<tr>
<td>[DEFAULT] policy_dirs = ['policy.d']</td>
<td>(MultiStrOpt) Directories where policy configuration files are stored.</td>
</tr>
<tr>
<td>[AGENT] check_child_processes_action = respawn</td>
<td>(StrOpt) Action to be executed when a child process dies</td>
</tr>
<tr>
<td>[AGENT] check_child_processes_interval = 0</td>
<td>(IntOpt) Interval between checks of child process liveness (seconds), use 0 to disable</td>
</tr>
<tr>
<td>[AGENT] comment_iptables_rules = True</td>
<td>(BoolOpt) Add comments to iptables rules.</td>
</tr>
<tr>
<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>[CISCO_N1K] restrict_network_profiles = True</td>
<td>(BoolOpt) Restrict tenants from accessing network profiles belonging to some other tenant</td>
</tr>
<tr>
<td>[OFC] support_packet_filter_on_ofc_router = True</td>
<td>(BoolOpt) Support packet filter on OFC router interface.</td>
</tr>
<tr>
<td>[nova] auth_plugin = None</td>
<td>(StrOpt) Name of the plugin to load</td>
</tr>
<tr>
<td>[nova] auth_section = None</td>
<td>(StrOpt) Config Section from which to load plugin specific options</td>
</tr>
<tr>
<td>[nova] cafile = None</td>
<td>(StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.</td>
</tr>
<tr>
<td>[nova] certfile = None</td>
<td>(StrOpt) PEM encoded client certificate cert file</td>
</tr>
<tr>
<td>[nova] insecure = False</td>
<td>(BoolOpt) Verify HTTPS connections.</td>
</tr>
<tr>
<td>[nova] keyfile = None</td>
<td>(StrOpt) PEM encoded client certificate key file</td>
</tr>
<tr>
<td>[nova] region_name = None</td>
<td>(StrOpt) Name of nova region to use. Useful if keystone manages more than one region.</td>
</tr>
<tr>
<td>[nova] timeout = None</td>
<td>(IntOpt) Timeout value for http requests</td>
</tr>
<tr>
<td>[oslo_concurrency] disable_process_locking = False</td>
<td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr>
<tr>
<td>[oslo_concurrency] lock_path = None</td>
<td>(StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set.</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] allow_insecure_clients = False</td>
<td>(BoolOpt) Accept clients using either SSL or plain TCP</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] broadcast_prefix = broadcast</td>
<td>(StrOpt) address prefix used when broadcasting to all servers</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] container_name = None</td>
<td>(StrOpt) Name for the AMQP container</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] group_request_prefix = unicast</td>
<td>(StrOpt) address prefix when sending to any server in group</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] idle_timeout = 0</td>
<td>(IntOpt) Timeout for inactive connections (in seconds)</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] server_request_prefix = exclusive</td>
<td>(StrOpt) address prefix used when sending to a specific server</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] ssl_ca_file = </td>
<td>(StrOpt) CA certificate PEM file for verifing server certificate</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] ssl_cert_file = </td>
<td>(StrOpt) Identifying certificate PEM file to present to clients</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] ssl_key_file = </td>
<td>(StrOpt) Private key PEM file used to sign cert_file certificate</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] ssl_key_password = None</td>
<td>(StrOpt) Password for decrypting ssl_key_file (if encrypted)</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] trace = False</td>
<td>(BoolOpt) Debug: dump AMQP frames to stdout</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] amqp_auto_delete = False</td>
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] amqp_durable_queues = False</td>
<td>(BoolOpt) Use durable queues in AMQP.</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] qpid_heartbeat = 60</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] qpid_hostname = localhost</td>
<td>(StrOpt) Qpid broker hostname.</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] qpid_hosts = $qpid_hostname:$qpid_port</td>
<td>(ListOpt) Qpid HA cluster host:port pairs.</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] qpid_password = </td>
<td>(StrOpt) Password for Qpid connection.</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] qpid_port = 5672</td>
<td>(IntOpt) Qpid broker port.</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] qpid_protocol = tcp</td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] qpid_receiver_capacity = 1</td>
<td>(IntOpt) The number of prefetched messages held by receiver.</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] qpid_sasl_mechanisms = </td>
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] qpid_tcp_nodelay = True</td>
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] qpid_topology_version = 1</td>
<td>(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.</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] qpid_username = </td>
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] amqp_auto_delete = False</td>
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] amqp_durable_queues = False</td>
<td>(BoolOpt) Use durable queues in AMQP.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] fake_rabbit = False</td>
<td>(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] kombu_reconnect_delay = 1.0</td>
<td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] kombu_ssl_ca_certs = </td>
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] kombu_ssl_certfile = </td>
<td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] kombu_ssl_keyfile = </td>
<td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] kombu_ssl_version = </td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] rabbit_ha_queues = False</td>
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] rabbit_host = localhost</td>
<td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] rabbit_hosts = $rabbit_host:$rabbit_port</td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] rabbit_login_method = AMQPLAIN</td>
<td>(StrOpt) The RabbitMQ login method.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] rabbit_max_retries = 0</td>
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] rabbit_password = guest</td>
<td>(StrOpt) The RabbitMQ password.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] rabbit_port = 5672</td>
<td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] rabbit_retry_backoff = 2</td>
<td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] rabbit_retry_interval = 1</td>
<td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] rabbit_use_ssl = False</td>
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] rabbit_userid = guest</td>
<td>(StrOpt) The RabbitMQ userid.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] rabbit_virtual_host = /</td>
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
</table>
<table>
<caption>New default values</caption>
<col width="33%"/>
<col width="33%"/>
<col width="33%"/>
<thead>
<tr>
<td>Option</td>
<td>Previous default value</td>
<td>New default value</td>
</tr>
</thead>
<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>
<td>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN</td>
</tr>
<tr>
<td>[DEFAULT] rpc_zmq_matchmaker</td>
<td>oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
<td>oslo_messaging._drivers.matchmaker.MatchMakerLocalhost</td>
</tr>
<tr>
<td>[OVS] local_ip</td>
<td></td>
<td>None</td>
</tr>
<tr>
<td>[OVS] ovsdb_interface</td>
<td>None</td>
<td>vsctl</td>
</tr>
<tr>
<td>[VXLAN] local_ip</td>
<td></td>
<td>None</td>
</tr>
<tr>
<td>[ml2_sriov] supported_pci_vendor_devs</td>
<td>15b3:1004, 8086:10c9</td>
<td>15b3:1004, 8086:10ca</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] nova_region_name</td>
<td>[nova] region_name</td>
</tr>
<tr>
<td>[DEFAULT] nova_ca_certificates_file</td>
<td>[nova] cafile</td>
</tr>
<tr>
<td>[DEFAULT] nova_api_insecure</td>
<td>[nova] insecure</td>
</tr>
</table>
</section>