From 39670ef35ab37d8e7a4db483f0f8e2a453c7a07b Mon Sep 17 00:00:00 2001 From: Matthew Kassawara Date: Tue, 8 Dec 2015 15:02:50 -0700 Subject: [PATCH] [config-ref] Include neutron config files For Mitaka, neutron implements automatic generation of sample configuration files and removes static sample configuration files from the neutron source tree. Therefore, the configuration reference must include local versions of sample configuration files similar to other projects that implement automatic generation of sample configuration files. Change-Id: If92d048a837ffbd9ba8664559ddabe886f448a32 Closes-Bug: #1520722 --- .../networking/sample-configuration-files.rst | 124 +- .../samples/neutron/dhcp_agent.ini.sample | 214 +++ .../samples/neutron/l3_agent.ini.sample | 259 ++++ .../neutron/linuxbridge_agent.ini.sample | 201 +++ .../samples/neutron/metadata_agent.ini.sample | 190 +++ .../samples/neutron/metering_agent.ini.sample | 124 ++ .../samples/neutron/ml2_conf.ini.sample | 248 +++ .../samples/neutron/ml2_conf_sriov.ini.sample | 120 ++ .../samples/neutron/neutron.conf.sample | 1323 +++++++++++++++++ .../neutron/openvswitch_agent.ini.sample | 281 ++++ .../samples/neutron/sriov_agent.ini.sample | 140 ++ 11 files changed, 3200 insertions(+), 24 deletions(-) create mode 100644 doc/config-ref-rst/source/samples/neutron/dhcp_agent.ini.sample create mode 100644 doc/config-ref-rst/source/samples/neutron/l3_agent.ini.sample create mode 100644 doc/config-ref-rst/source/samples/neutron/linuxbridge_agent.ini.sample create mode 100644 doc/config-ref-rst/source/samples/neutron/metadata_agent.ini.sample create mode 100644 doc/config-ref-rst/source/samples/neutron/metering_agent.ini.sample create mode 100644 doc/config-ref-rst/source/samples/neutron/ml2_conf.ini.sample create mode 100644 doc/config-ref-rst/source/samples/neutron/ml2_conf_sriov.ini.sample create mode 100644 doc/config-ref-rst/source/samples/neutron/neutron.conf.sample create mode 100644 doc/config-ref-rst/source/samples/neutron/openvswitch_agent.ini.sample create mode 100644 doc/config-ref-rst/source/samples/neutron/sriov_agent.ini.sample diff --git a/doc/config-ref-rst/source/networking/sample-configuration-files.rst b/doc/config-ref-rst/source/networking/sample-configuration-files.rst index 9d6c570b5c..375f1fc3f7 100644 --- a/doc/config-ref-rst/source/networking/sample-configuration-files.rst +++ b/doc/config-ref-rst/source/networking/sample-configuration-files.rst @@ -2,33 +2,39 @@ Networking sample configuration files ===================================== -All the files in this section can be found in ``/etc/neutron/``. +The Networking service implements automatic generation of configuration +files. This guide contains a snapshot of common configuration files for +convenience. However, consider generating the latest configuration files +by cloning the neutron_ repository and running the +``tools/generate_config_file_samples.sh`` script. Distribution packages +should include sample configuration files for a particular release. +Generally, these files reside in the ``/etc/neutron`` directory structure. + +.. _neutron: https://git.openstack.org/cgit/openstack/neutron/ neutron.conf ~~~~~~~~~~~~ -Use the ``neutron.conf`` file to configure the majority of the OpenStack -Networking options. +The ``neutron.conf`` file contains the majority of Networking service +options common to all components. -.. remote-code-block:: ini - - https://git.openstack.org/cgit/openstack/neutron/plain/etc/neutron.conf?h=stable/liberty +.. literalinclude:: ../samples/neutron/neutron.conf.sample + :language: ini api-paste.ini ~~~~~~~~~~~~~ -Use the ``api-paste.ini`` to configure the OpenStack Networking API. +The ``api-paste.ini`` file contains configuration for the web services +gateway interface (WSGI). .. remote-code-block:: ini https://git.openstack.org/cgit/openstack/neutron/plain/etc/api-paste.ini?h=stable/liberty - policy.json ~~~~~~~~~~~ -Use the ``policy.json`` file to define additional access controls that -apply to the OpenStack Networking service. +The ``policy.json`` defines API access policy. .. remote-code-block:: json @@ -37,38 +43,108 @@ apply to the OpenStack Networking service. rootwrap.conf ~~~~~~~~~~~~~ -Use the ``rootwrap.conf`` file to define configuration values used by -the ``rootwrap`` script when the OpenStack Networking service must -escalate its privileges to those of the root user. +The ``rootwrap.conf`` file contains configuration for system utilities +that require privilege escalation to execute. .. remote-code-block:: ini https://git.openstack.org/cgit/openstack/neutron/plain/etc/rootwrap.conf?h=stable/liberty -Configuration files for plug-in agents -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Reference architecture plug-ins and agents +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Each plug-in agent that runs on an OpenStack Networking node, to perform local -networking configuration for the node's VMs and networking services, has its -own configuration file. +Although the Networking service supports other plug-ins and agents, this +guide only contains configuration files for the following reference +architecture components: + +* ML2 plug-in +* Layer-2 agents + + * Open vSwitch (OVS) + * Linux bridge + * Single-root I/O virtualization (SR-IOV) + +* DHCP agent +* Layer-3 (routing) agent +* Metadata agent +* Metering agent + +ml2_conf.ini +------------ + +The ``plugins/ml2/ml2_conf.ini`` file contains configuration for the ML2 +plug-in. + +.. literalinclude:: ../samples/neutron/ml2_conf.ini.sample + :language: ini + +ml2_conf_sriov.ini +------------------ + +The ``plugins/ml2/ml2_conf_sriov.ini`` file contains configuration for the +ML2 plug-in specific to SR-IOV. + +.. literalinclude:: ../samples/neutron/ml2_conf_sriov.ini.sample + :language: ini + +linuxbridge_agent.ini +--------------------- + +The ``plugins/ml2/linuxbridge_agent.ini`` file contains configuration for the +Linux bridge layer-2 agent. + +.. literalinclude:: ../samples/neutron/linuxbridge_agent.ini.sample + :language: ini + +openvswitch_agent.ini +--------------------- + +The ``plugins/ml2/openvswitch_agent.ini`` file contains configuration for the +Open vSwitch (OVS) layer-2 agent. + +.. literalinclude:: ../samples/neutron/openvswitch_agent.ini.sample + :language: ini + +sriov_agent.ini +--------------- + +The ``plugins/ml2/sriov_agent.ini`` file contains configuration for the +SR-IOV layer-2 agent. + +.. literalinclude:: ../samples/neutron/sriov_agent.ini.sample + :language: ini dhcp_agent.ini -------------- -.. remote-code-block:: ini +The ``dhcp_agent.ini`` file contains configuration for the DHCP agent. - https://git.openstack.org/cgit/openstack/neutron/plain/etc/dhcp_agent.ini?h=stable/liberty +.. literalinclude:: ../samples/neutron/dhcp_agent.ini.sample + :language: ini l3_agent.ini ------------ -.. remote-code-block:: ini +The ``l3_agent.ini`` file contains configuration for the Layer-3 (routing) +agent. - https://git.openstack.org/cgit/openstack/neutron/plain/etc/l3_agent.ini?h=stable/liberty +.. literalinclude:: ../samples/neutron/l3_agent.ini.sample + :language: ini metadata_agent.ini ------------------ -.. remote-code-block:: ini +The ``metadata_agent.ini`` file contains configuration for the metadata +agent. - https://git.openstack.org/cgit/openstack/neutron/plain/etc/metadata_agent.ini?h=stable/liberty +.. literalinclude:: ../samples/neutron/metadata_agent.ini.sample + :language: ini + +metering_agent.ini +------------------ + +The ``metering_agent.ini`` file contains configuration for the metering +agent. + +.. literalinclude:: ../samples/neutron/metering_agent.ini.sample + :language: ini diff --git a/doc/config-ref-rst/source/samples/neutron/dhcp_agent.ini.sample b/doc/config-ref-rst/source/samples/neutron/dhcp_agent.ini.sample new file mode 100644 index 0000000000..22e9e43d59 --- /dev/null +++ b/doc/config-ref-rst/source/samples/neutron/dhcp_agent.ini.sample @@ -0,0 +1,214 @@ +[DEFAULT] + +# +# From neutron.base.agent +# + +# Name of Open vSwitch bridge to use (string value) +#ovs_integration_bridge = br-int + +# Uses veth for an OVS interface or not. Support kernels with limited namespace +# support (e.g. RHEL 6.5) so long as ovs_use_veth is set to True. (boolean +# value) +#ovs_use_veth = false + +# MTU setting for device. (integer value) +#network_device_mtu = + +# The driver used to manage the virtual interface. (string value) +#interface_driver = + +# Timeout in seconds for ovs-vsctl commands. If the timeout expires, ovs +# commands will fail with ALARMCLOCK error. (integer value) +#ovs_vsctl_timeout = 10 + +# +# From neutron.dhcp.agent +# + +# The DHCP agent will resync its state with Neutron to recover from any +# transient notification or RPC errors. The interval is number of seconds +# between attempts. (integer value) +#resync_interval = 5 + +# The driver used to manage the DHCP server. (string value) +#dhcp_driver = neutron.agent.linux.dhcp.Dnsmasq + +# The DHCP server can assist with providing metadata support on isolated +# networks. Setting this value to True will cause the DHCP server to append +# specific host routes to the DHCP request. The metadata service will only be +# activated when the subnet does not contain any router port. The guest +# instance must be configured to request host routes via DHCP (Option 121). +# This option doesn't have any effect when force_metadata is set to True. +# (boolean value) +#enable_isolated_metadata = false + +# In some cases the Neutron router is not present to provide the metadata IP +# but the DHCP server can be used to provide this info. Setting this value will +# force the DHCP server to append specific host routes to the DHCP request. If +# this option is set, then the metadata service will be activated for all the +# networks. (boolean value) +#force_metadata = false + +# Allows for serving metadata requests coming from a dedicated metadata access +# network whose CIDR is 169.254.169.254/16 (or larger prefix), and is connected +# to a Neutron router from which the VMs send metadata:1 request. In this case +# DHCP Option 121 will not be injected in VMs, as they will be able to reach +# 169.254.169.254 through a router. This option requires +# enable_isolated_metadata = True. (boolean value) +#enable_metadata_network = false + +# Number of threads to use during sync process. Should not exceed connection +# pool size configured on server. (integer value) +#num_sync_threads = 4 + +# Location to store DHCP server config files (string value) +#dhcp_confs = $state_path/dhcp + +# Domain to use for building the hostnames.This option is deprecated. It has +# been moved to neutron.conf as dns_domain. It will removed from here in a +# future release (string value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#dhcp_domain = openstacklocal + +# Override the default dnsmasq settings with this file (string value) +#dnsmasq_config_file = + +# Comma-separated list of the DNS servers which will be used as forwarders. +# (list value) +# Deprecated group/name - [DEFAULT]/dnsmasq_dns_server +#dnsmasq_dns_servers = + +# Base log dir for dnsmasq logging. The log contains DHCP and DNS log +# information and is useful for debugging issues with either DHCP or DNS. If +# this section is null, disable dnsmasq log. (string value) +#dnsmasq_base_log_dir = + +# Limit number of leases to prevent a denial-of-service. (integer value) +#dnsmasq_lease_max = 16777216 + +# Use broadcast in DHCP replies (boolean value) +#dhcp_broadcast_reply = false + +# +# From oslo.log +# + +# Print debugging output (set logging level to DEBUG instead of default INFO +# level). (boolean value) +#debug = false + +# If set to false, will disable INFO logging level, making WARNING the default. +# (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#verbose = true + +# 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. Note that when logging +# configuration files are used then all logging configuration is set in the +# configuration file and other logging configuration options are ignored (for +# example, log_format). (string value) +# Deprecated group/name - [DEFAULT]/log_config +#log_config_append = + +# DEPRECATED. A logging.Formatter log message format string which may use any +# of the available logging.LogRecord attributes. This option is deprecated. +# Please use logging_context_format_string and logging_default_format_string +# instead. This option is ignored if log_config_append is set. (string value) +#log_format = + +# Format string for %%(asctime)s in log records. Default: %(default)s . This +# option is ignored if log_config_append is set. (string value) +#log_date_format = %Y-%m-%d %H:%M:%S + +# (Optional) Name of log file to output to. If no default is set, logging will +# go to stdout. This option is ignored if log_config_append is set. (string +# value) +# Deprecated group/name - [DEFAULT]/logfile +#log_file = + +# (Optional) The base directory used for relative --log-file paths. This option +# is ignored if log_config_append is set. (string value) +# Deprecated group/name - [DEFAULT]/logdir +#log_dir = + +# (Optional) Uses logging handler designed to watch file system. When log file +# is moved or removed this handler will open a new log file with specified path +# instantaneously. It makes sense only if log-file option is specified and +# Linux platform is used. This option is ignored if log_config_append is set. +# (boolean value) +#watch_log_file = false + +# Use syslog for logging. Existing syslog format is DEPRECATED and will be +# changed later to honor RFC5424. This option is ignored if log_config_append +# is set. (boolean value) +#use_syslog = false + +# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, +# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The +# format without the APP-NAME is deprecated in Kilo, and will be removed in +# Mitaka, along with this option. This option is ignored if log_config_append +# is set. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#use_syslog_rfc_format = true + +# Syslog facility to receive log lines. This option is ignored if +# log_config_append is set. (string value) +#syslog_log_facility = LOG_USER + +# Log output to standard error. This option is ignored if log_config_append is +# set. (boolean value) +#use_stderr = true + +# Format string to use for log messages with context. (string value) +#logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s + +# Format string to use for log messages without context. (string value) +#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s + +# Data to append to log format when level is DEBUG. (string value) +#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d + +# Prefix each line of exception output with this format. (string value) +#logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s + +# List of logger=LEVEL pairs. This option is ignored if log_config_append is +# set. (list value) +#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN + +# Enables or disables publication of error events. (boolean value) +#publish_errors = false + +# The format for an instance that is passed with the log message. (string +# value) +#instance_format = "[instance: %(uuid)s] " + +# The format for an instance UUID that is passed with the log message. (string +# value) +#instance_uuid_format = "[instance: %(uuid)s] " + +# Format string for user_identity field of the logging_context_format_string +# (string value) +#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s + +# Enables or disables fatal status of deprecations. (boolean value) +#fatal_deprecations = false + + +[AGENT] + +# +# From neutron.base.agent +# + +# Seconds between nodes reporting state to server; should be less than +# agent_down_time, best if it is half or less than agent_down_time. (floating +# point value) +#report_interval = 30 + +# Log agent heartbeats (boolean value) +#log_agent_heartbeats = false diff --git a/doc/config-ref-rst/source/samples/neutron/l3_agent.ini.sample b/doc/config-ref-rst/source/samples/neutron/l3_agent.ini.sample new file mode 100644 index 0000000000..5f37becb24 --- /dev/null +++ b/doc/config-ref-rst/source/samples/neutron/l3_agent.ini.sample @@ -0,0 +1,259 @@ +[DEFAULT] + +# +# From neutron.base.agent +# + +# Name of Open vSwitch bridge to use (string value) +#ovs_integration_bridge = br-int + +# Uses veth for an OVS interface or not. Support kernels with limited namespace +# support (e.g. RHEL 6.5) so long as ovs_use_veth is set to True. (boolean +# value) +#ovs_use_veth = false + +# MTU setting for device. (integer value) +#network_device_mtu = + +# The driver used to manage the virtual interface. (string value) +#interface_driver = + +# Timeout in seconds for ovs-vsctl commands. If the timeout expires, ovs +# commands will fail with ALARMCLOCK error. (integer value) +#ovs_vsctl_timeout = 10 + +# +# From neutron.l3.agent +# + +# The working mode for the agent. Allowed modes are: 'legacy' - this preserves +# the existing behavior where the L3 agent is deployed on a centralized +# networking node to provide L3 services like DNAT, and SNAT. Use this mode if +# you do not want to adopt DVR. 'dvr' - this mode enables DVR functionality and +# must be used for an L3 agent that runs on a compute host. 'dvr_snat' - this +# enables centralized SNAT support in conjunction with DVR. This mode must be +# used for an L3 agent running on a centralized node (or in single-host +# deployments, e.g. devstack) (string value) +# Allowed values: dvr, dvr_snat, legacy +#agent_mode = legacy + +# TCP Port used by Neutron metadata namespace proxy. (port value) +# Minimum value: 1 +# Maximum value: 65535 +#metadata_port = 9697 + +# Send this many gratuitous ARPs for HA setup, if less than or equal to 0, the +# feature is disabled (integer value) +#send_arp_for_ha = 3 + +# If non-empty, the l3 agent can only configure a router that has the matching +# router ID. (string value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#router_id = + +# Indicates that this L3 agent should also handle routers that do not have an +# external network gateway configured. This option should be True only for a +# single agent in a Neutron deployment, and may be False for all agents if all +# routers must have an external network gateway. (boolean value) +#handle_internal_only_routers = true + +# When external_network_bridge is set, each L3 agent can be associated with no +# more than one external network. This value should be set to the UUID of that +# external network. To allow L3 agent support multiple external networks, both +# the external_network_bridge and gateway_external_network_id must be left +# empty. (string value) +#gateway_external_network_id = + +# 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. (string value) +#ipv6_gateway = + +# Driver used for ipv6 prefix delegation. This needs to be an entry point +# defined in the neutron.agent.linux.pd_drivers namespace. See setup.cfg for +# entry points included with the neutron source. (string value) +#prefix_delegation_driver = dibbler + +# Allow running metadata proxy. (boolean value) +#enable_metadata_proxy = true + +# Iptables mangle mark used to mark metadata valid requests. This mark will be +# masked with 0xffff so that only the lower 16 bits will be used. (string +# value) +#metadata_access_mark = 0x1 + +# Iptables mangle mark used to mark ingress from external network. This mark +# will be masked with 0xffff so that only the lower 16 bits will be used. +# (string value) +#external_ingress_mark = 0x2 + +# Name of bridge used for external network traffic. This should be set to an +# empty value for the Linux Bridge. When this parameter is set, each L3 agent +# can be associated with no more than one external network. This option is +# deprecated and will be removed in the M release. (string value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#external_network_bridge = br-ex + +# Seconds between running periodic tasks (integer value) +#periodic_interval = 40 + +# Number of separate API worker processes for service. If not specified, the +# default is equal to the number of CPUs available for best performance. +# (integer value) +#api_workers = + +# Number of RPC worker processes for service (integer value) +#rpc_workers = 1 + +# Number of RPC worker processes dedicated to state reports queue (integer +# value) +#rpc_state_report_workers = 1 + +# Range of seconds to randomly delay when starting the periodic task scheduler +# to reduce stampeding. (Disable by setting to 0) (integer value) +#periodic_fuzzy_delay = 5 + +# Location to store keepalived/conntrackd config files (string value) +#ha_confs_path = $state_path/ha_confs + +# VRRP authentication type (string value) +# Allowed values: AH, PASS +#ha_vrrp_auth_type = PASS + +# VRRP authentication password (string value) +#ha_vrrp_auth_password = + +# The advertisement interval in seconds (integer value) +#ha_vrrp_advert_int = 2 + +# +# From oslo.log +# + +# Print debugging output (set logging level to DEBUG instead of default INFO +# level). (boolean value) +#debug = false + +# If set to false, will disable INFO logging level, making WARNING the default. +# (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#verbose = true + +# 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. Note that when logging +# configuration files are used then all logging configuration is set in the +# configuration file and other logging configuration options are ignored (for +# example, log_format). (string value) +# Deprecated group/name - [DEFAULT]/log_config +#log_config_append = + +# DEPRECATED. A logging.Formatter log message format string which may use any +# of the available logging.LogRecord attributes. This option is deprecated. +# Please use logging_context_format_string and logging_default_format_string +# instead. This option is ignored if log_config_append is set. (string value) +#log_format = + +# Format string for %%(asctime)s in log records. Default: %(default)s . This +# option is ignored if log_config_append is set. (string value) +#log_date_format = %Y-%m-%d %H:%M:%S + +# (Optional) Name of log file to output to. If no default is set, logging will +# go to stdout. This option is ignored if log_config_append is set. (string +# value) +# Deprecated group/name - [DEFAULT]/logfile +#log_file = + +# (Optional) The base directory used for relative --log-file paths. This option +# is ignored if log_config_append is set. (string value) +# Deprecated group/name - [DEFAULT]/logdir +#log_dir = + +# (Optional) Uses logging handler designed to watch file system. When log file +# is moved or removed this handler will open a new log file with specified path +# instantaneously. It makes sense only if log-file option is specified and +# Linux platform is used. This option is ignored if log_config_append is set. +# (boolean value) +#watch_log_file = false + +# Use syslog for logging. Existing syslog format is DEPRECATED and will be +# changed later to honor RFC5424. This option is ignored if log_config_append +# is set. (boolean value) +#use_syslog = false + +# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, +# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The +# format without the APP-NAME is deprecated in Kilo, and will be removed in +# Mitaka, along with this option. This option is ignored if log_config_append +# is set. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#use_syslog_rfc_format = true + +# Syslog facility to receive log lines. This option is ignored if +# log_config_append is set. (string value) +#syslog_log_facility = LOG_USER + +# Log output to standard error. This option is ignored if log_config_append is +# set. (boolean value) +#use_stderr = true + +# Format string to use for log messages with context. (string value) +#logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s + +# Format string to use for log messages without context. (string value) +#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s + +# Data to append to log format when level is DEBUG. (string value) +#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d + +# Prefix each line of exception output with this format. (string value) +#logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s + +# List of logger=LEVEL pairs. This option is ignored if log_config_append is +# set. (list value) +#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN + +# Enables or disables publication of error events. (boolean value) +#publish_errors = false + +# The format for an instance that is passed with the log message. (string +# value) +#instance_format = "[instance: %(uuid)s] " + +# The format for an instance UUID that is passed with the log message. (string +# value) +#instance_uuid_format = "[instance: %(uuid)s] " + +# Format string for user_identity field of the logging_context_format_string +# (string value) +#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s + +# Enables or disables fatal status of deprecations. (boolean value) +#fatal_deprecations = false + + +[AGENT] + +# +# From neutron.base.agent +# + +# Seconds between nodes reporting state to server; should be less than +# agent_down_time, best if it is half or less than agent_down_time. (floating +# point value) +#report_interval = 30 + +# Log agent heartbeats (boolean value) +#log_agent_heartbeats = false diff --git a/doc/config-ref-rst/source/samples/neutron/linuxbridge_agent.ini.sample b/doc/config-ref-rst/source/samples/neutron/linuxbridge_agent.ini.sample new file mode 100644 index 0000000000..6bfd2e6f76 --- /dev/null +++ b/doc/config-ref-rst/source/samples/neutron/linuxbridge_agent.ini.sample @@ -0,0 +1,201 @@ +[DEFAULT] + +# +# From oslo.log +# + +# Print debugging output (set logging level to DEBUG instead of default INFO +# level). (boolean value) +#debug = false + +# If set to false, will disable INFO logging level, making WARNING the default. +# (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#verbose = true + +# 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. Note that when logging +# configuration files are used then all logging configuration is set in the +# configuration file and other logging configuration options are ignored (for +# example, log_format). (string value) +# Deprecated group/name - [DEFAULT]/log_config +#log_config_append = + +# DEPRECATED. A logging.Formatter log message format string which may use any +# of the available logging.LogRecord attributes. This option is deprecated. +# Please use logging_context_format_string and logging_default_format_string +# instead. This option is ignored if log_config_append is set. (string value) +#log_format = + +# Format string for %%(asctime)s in log records. Default: %(default)s . This +# option is ignored if log_config_append is set. (string value) +#log_date_format = %Y-%m-%d %H:%M:%S + +# (Optional) Name of log file to output to. If no default is set, logging will +# go to stdout. This option is ignored if log_config_append is set. (string +# value) +# Deprecated group/name - [DEFAULT]/logfile +#log_file = + +# (Optional) The base directory used for relative --log-file paths. This option +# is ignored if log_config_append is set. (string value) +# Deprecated group/name - [DEFAULT]/logdir +#log_dir = + +# (Optional) Uses logging handler designed to watch file system. When log file +# is moved or removed this handler will open a new log file with specified path +# instantaneously. It makes sense only if log-file option is specified and +# Linux platform is used. This option is ignored if log_config_append is set. +# (boolean value) +#watch_log_file = false + +# Use syslog for logging. Existing syslog format is DEPRECATED and will be +# changed later to honor RFC5424. This option is ignored if log_config_append +# is set. (boolean value) +#use_syslog = false + +# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, +# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The +# format without the APP-NAME is deprecated in Kilo, and will be removed in +# Mitaka, along with this option. This option is ignored if log_config_append +# is set. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#use_syslog_rfc_format = true + +# Syslog facility to receive log lines. This option is ignored if +# log_config_append is set. (string value) +#syslog_log_facility = LOG_USER + +# Log output to standard error. This option is ignored if log_config_append is +# set. (boolean value) +#use_stderr = true + +# Format string to use for log messages with context. (string value) +#logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s + +# Format string to use for log messages without context. (string value) +#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s + +# Data to append to log format when level is DEBUG. (string value) +#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d + +# Prefix each line of exception output with this format. (string value) +#logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s + +# List of logger=LEVEL pairs. This option is ignored if log_config_append is +# set. (list value) +#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN + +# Enables or disables publication of error events. (boolean value) +#publish_errors = false + +# The format for an instance that is passed with the log message. (string +# value) +#instance_format = "[instance: %(uuid)s] " + +# The format for an instance UUID that is passed with the log message. (string +# value) +#instance_uuid_format = "[instance: %(uuid)s] " + +# Format string for user_identity field of the logging_context_format_string +# (string value) +#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s + +# Enables or disables fatal status of deprecations. (boolean value) +#fatal_deprecations = false + + +[agent] + +# +# From neutron.ml2.linuxbridge.agent +# + +# The number of seconds the agent will wait between polling for local device +# changes. (integer value) +#polling_interval = 2 + +# Set new timeout in seconds for new rpc calls after agent receives SIGTERM. If +# value is set to 0, rpc timeout won't be changed (integer value) +#quitting_rpc_timeout = 10 + +# Enable suppression of ARP responses that don't match an IP address that +# belongs to the port from which they originate. Note: This prevents the VMs +# attached to this agent from spoofing, it doesn't protect them from other +# devices which have the capability to spoof (e.g. bare metal or VMs attached +# to agents without this flag set to True). Spoofing rules will not be added to +# any ports that have port security disabled. For LinuxBridge, this requires +# ebtables. For OVS, it requires a version that supports matching ARP headers. +# (boolean value) +#prevent_arp_spoofing = true + + +[linux_bridge] + +# +# From neutron.ml2.linuxbridge.agent +# + +# Comma-separated list of : 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. (list value) +#physical_interface_mappings = + +# List of : (list value) +#bridge_mappings = + + +[securitygroup] + +# +# From neutron.ml2.linuxbridge.agent +# + +# Driver for security groups firewall in the L2 agent (string value) +#firewall_driver = + +# Controls whether the neutron security group API is enabled in the server. It +# should be false when using no security groups or using the nova security +# group API. (boolean value) +#enable_security_group = true + +# Use ipset to speed-up the iptables based security groups. Enabling ipset +# support requires that ipset is installed on L2 agent node. (boolean value) +#enable_ipset = true + + +[vxlan] + +# +# From neutron.ml2.linuxbridge.agent +# + +# Enable VXLAN on the agent. Can be enabled when agent is managed by ml2 plugin +# using linuxbridge mechanism driver (boolean value) +#enable_vxlan = true + +# TTL for vxlan interface protocol packets. (integer value) +#ttl = + +# TOS for vxlan interface protocol packets. (integer value) +#tos = + +# Multicast group(s) for vxlan interface. A range of group addresses may be +# specified by using CIDR notation. Specifying a range allows different VNIs to +# use different group addresses, reducing or eliminating spurious broadcast +# traffic to the tunnel endpoints. To reserve a unique group for each possible +# (24-bit) VNI, use a /8 such as 239.0.0.0/8. This setting must be the same on +# all the agents. (string value) +#vxlan_group = 224.0.0.1 + +# Local IP address of the VXLAN endpoints. (ip address value) +#local_ip = + +# Extension to use alongside ml2 plugin's l2population mechanism driver. It +# enables the plugin to populate VXLAN forwarding table. (boolean value) +#l2_population = false diff --git a/doc/config-ref-rst/source/samples/neutron/metadata_agent.ini.sample b/doc/config-ref-rst/source/samples/neutron/metadata_agent.ini.sample new file mode 100644 index 0000000000..667af29e7f --- /dev/null +++ b/doc/config-ref-rst/source/samples/neutron/metadata_agent.ini.sample @@ -0,0 +1,190 @@ +[DEFAULT] + +# +# From neutron.metadata.agent +# + +# Location for Metadata Proxy UNIX domain socket. (string value) +#metadata_proxy_socket = $state_path/metadata_proxy + +# User (uid or name) running metadata proxy after its initialization (if empty: +# agent effective user). (string value) +#metadata_proxy_user = + +# Group (gid or name) running metadata proxy after its initialization (if +# empty: agent effective group). (string value) +#metadata_proxy_group = + +# Certificate Authority public key (CA cert) file for ssl (string value) +#auth_ca_cert = + +# IP address used by Nova metadata server. (string value) +#nova_metadata_ip = 127.0.0.1 + +# TCP Port used by Nova metadata server. (port value) +# Minimum value: 1 +# Maximum value: 65535 +#nova_metadata_port = 8775 + +# When proxying metadata requests, Neutron signs the Instance-ID header with a +# shared secret to prevent spoofing. You may select any string for a secret, +# but it must match here and in the configuration used by the Nova Metadata +# Server. NOTE: Nova uses the same config key, but in [neutron] section. +# (string value) +#metadata_proxy_shared_secret = + +# Protocol to access nova metadata, http or https (string value) +# Allowed values: http, https +#nova_metadata_protocol = http + +# Allow to perform insecure SSL (https) requests to nova metadata (boolean +# value) +#nova_metadata_insecure = false + +# Client certificate for nova metadata api server. (string value) +#nova_client_cert = + +# Private key of client certificate. (string value) +#nova_client_priv_key = + +# Metadata Proxy UNIX domain socket mode, 4 values allowed: 'deduce': deduce +# mode from metadata_proxy_user/group values, 'user': set metadata proxy socket +# mode to 0o644, to use when metadata_proxy_user is agent effective user or +# root, 'group': set metadata proxy socket mode to 0o664, to use when +# metadata_proxy_group is agent effective group or root, 'all': set metadata +# proxy socket mode to 0o666, to use otherwise. (string value) +# Allowed values: deduce, user, group, all +#metadata_proxy_socket_mode = deduce + +# Number of separate worker processes for metadata server (defaults to half of +# the number of CPUs) (integer value) +#metadata_workers = 2 + +# Number of backlog requests to configure the metadata server socket with +# (integer value) +#metadata_backlog = 4096 + +# URL to connect to the cache back end. (string value) +#cache_url = memory:// + +# +# From oslo.log +# + +# Print debugging output (set logging level to DEBUG instead of default INFO +# level). (boolean value) +#debug = false + +# If set to false, will disable INFO logging level, making WARNING the default. +# (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#verbose = true + +# 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. Note that when logging +# configuration files are used then all logging configuration is set in the +# configuration file and other logging configuration options are ignored (for +# example, log_format). (string value) +# Deprecated group/name - [DEFAULT]/log_config +#log_config_append = + +# DEPRECATED. A logging.Formatter log message format string which may use any +# of the available logging.LogRecord attributes. This option is deprecated. +# Please use logging_context_format_string and logging_default_format_string +# instead. This option is ignored if log_config_append is set. (string value) +#log_format = + +# Format string for %%(asctime)s in log records. Default: %(default)s . This +# option is ignored if log_config_append is set. (string value) +#log_date_format = %Y-%m-%d %H:%M:%S + +# (Optional) Name of log file to output to. If no default is set, logging will +# go to stdout. This option is ignored if log_config_append is set. (string +# value) +# Deprecated group/name - [DEFAULT]/logfile +#log_file = + +# (Optional) The base directory used for relative --log-file paths. This option +# is ignored if log_config_append is set. (string value) +# Deprecated group/name - [DEFAULT]/logdir +#log_dir = + +# (Optional) Uses logging handler designed to watch file system. When log file +# is moved or removed this handler will open a new log file with specified path +# instantaneously. It makes sense only if log-file option is specified and +# Linux platform is used. This option is ignored if log_config_append is set. +# (boolean value) +#watch_log_file = false + +# Use syslog for logging. Existing syslog format is DEPRECATED and will be +# changed later to honor RFC5424. This option is ignored if log_config_append +# is set. (boolean value) +#use_syslog = false + +# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, +# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The +# format without the APP-NAME is deprecated in Kilo, and will be removed in +# Mitaka, along with this option. This option is ignored if log_config_append +# is set. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#use_syslog_rfc_format = true + +# Syslog facility to receive log lines. This option is ignored if +# log_config_append is set. (string value) +#syslog_log_facility = LOG_USER + +# Log output to standard error. This option is ignored if log_config_append is +# set. (boolean value) +#use_stderr = true + +# Format string to use for log messages with context. (string value) +#logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s + +# Format string to use for log messages without context. (string value) +#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s + +# Data to append to log format when level is DEBUG. (string value) +#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d + +# Prefix each line of exception output with this format. (string value) +#logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s + +# List of logger=LEVEL pairs. This option is ignored if log_config_append is +# set. (list value) +#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN + +# Enables or disables publication of error events. (boolean value) +#publish_errors = false + +# The format for an instance that is passed with the log message. (string +# value) +#instance_format = "[instance: %(uuid)s] " + +# The format for an instance UUID that is passed with the log message. (string +# value) +#instance_uuid_format = "[instance: %(uuid)s] " + +# Format string for user_identity field of the logging_context_format_string +# (string value) +#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s + +# Enables or disables fatal status of deprecations. (boolean value) +#fatal_deprecations = false + + +[AGENT] + +# +# From neutron.metadata.agent +# + +# Seconds between nodes reporting state to server; should be less than +# agent_down_time, best if it is half or less than agent_down_time. (floating +# point value) +#report_interval = 30 + +# Log agent heartbeats (boolean value) +#log_agent_heartbeats = false diff --git a/doc/config-ref-rst/source/samples/neutron/metering_agent.ini.sample b/doc/config-ref-rst/source/samples/neutron/metering_agent.ini.sample new file mode 100644 index 0000000000..62ccc2b3ae --- /dev/null +++ b/doc/config-ref-rst/source/samples/neutron/metering_agent.ini.sample @@ -0,0 +1,124 @@ +[DEFAULT] + +# +# From neutron.metering.agent +# + +# Metering driver (string value) +#driver = neutron.services.metering.drivers.noop.noop_driver.NoopMeteringDriver + +# Interval between two metering measures (integer value) +#measure_interval = 30 + +# Interval between two metering reports (integer value) +#report_interval = 300 + +# The driver used to manage the virtual interface. (string value) +#interface_driver = + +# +# From oslo.log +# + +# Print debugging output (set logging level to DEBUG instead of default INFO +# level). (boolean value) +#debug = false + +# If set to false, will disable INFO logging level, making WARNING the default. +# (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#verbose = true + +# 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. Note that when logging +# configuration files are used then all logging configuration is set in the +# configuration file and other logging configuration options are ignored (for +# example, log_format). (string value) +# Deprecated group/name - [DEFAULT]/log_config +#log_config_append = + +# DEPRECATED. A logging.Formatter log message format string which may use any +# of the available logging.LogRecord attributes. This option is deprecated. +# Please use logging_context_format_string and logging_default_format_string +# instead. This option is ignored if log_config_append is set. (string value) +#log_format = + +# Format string for %%(asctime)s in log records. Default: %(default)s . This +# option is ignored if log_config_append is set. (string value) +#log_date_format = %Y-%m-%d %H:%M:%S + +# (Optional) Name of log file to output to. If no default is set, logging will +# go to stdout. This option is ignored if log_config_append is set. (string +# value) +# Deprecated group/name - [DEFAULT]/logfile +#log_file = + +# (Optional) The base directory used for relative --log-file paths. This option +# is ignored if log_config_append is set. (string value) +# Deprecated group/name - [DEFAULT]/logdir +#log_dir = + +# (Optional) Uses logging handler designed to watch file system. When log file +# is moved or removed this handler will open a new log file with specified path +# instantaneously. It makes sense only if log-file option is specified and +# Linux platform is used. This option is ignored if log_config_append is set. +# (boolean value) +#watch_log_file = false + +# Use syslog for logging. Existing syslog format is DEPRECATED and will be +# changed later to honor RFC5424. This option is ignored if log_config_append +# is set. (boolean value) +#use_syslog = false + +# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, +# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The +# format without the APP-NAME is deprecated in Kilo, and will be removed in +# Mitaka, along with this option. This option is ignored if log_config_append +# is set. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#use_syslog_rfc_format = true + +# Syslog facility to receive log lines. This option is ignored if +# log_config_append is set. (string value) +#syslog_log_facility = LOG_USER + +# Log output to standard error. This option is ignored if log_config_append is +# set. (boolean value) +#use_stderr = true + +# Format string to use for log messages with context. (string value) +#logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s + +# Format string to use for log messages without context. (string value) +#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s + +# Data to append to log format when level is DEBUG. (string value) +#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d + +# Prefix each line of exception output with this format. (string value) +#logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s + +# List of logger=LEVEL pairs. This option is ignored if log_config_append is +# set. (list value) +#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN + +# Enables or disables publication of error events. (boolean value) +#publish_errors = false + +# The format for an instance that is passed with the log message. (string +# value) +#instance_format = "[instance: %(uuid)s] " + +# The format for an instance UUID that is passed with the log message. (string +# value) +#instance_uuid_format = "[instance: %(uuid)s] " + +# Format string for user_identity field of the logging_context_format_string +# (string value) +#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s + +# Enables or disables fatal status of deprecations. (boolean value) +#fatal_deprecations = false diff --git a/doc/config-ref-rst/source/samples/neutron/ml2_conf.ini.sample b/doc/config-ref-rst/source/samples/neutron/ml2_conf.ini.sample new file mode 100644 index 0000000000..4df2585155 --- /dev/null +++ b/doc/config-ref-rst/source/samples/neutron/ml2_conf.ini.sample @@ -0,0 +1,248 @@ +[DEFAULT] + +# +# From oslo.log +# + +# Print debugging output (set logging level to DEBUG instead of default INFO +# level). (boolean value) +#debug = false + +# If set to false, will disable INFO logging level, making WARNING the default. +# (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#verbose = true + +# 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. Note that when logging +# configuration files are used then all logging configuration is set in the +# configuration file and other logging configuration options are ignored (for +# example, log_format). (string value) +# Deprecated group/name - [DEFAULT]/log_config +#log_config_append = + +# DEPRECATED. A logging.Formatter log message format string which may use any +# of the available logging.LogRecord attributes. This option is deprecated. +# Please use logging_context_format_string and logging_default_format_string +# instead. This option is ignored if log_config_append is set. (string value) +#log_format = + +# Format string for %%(asctime)s in log records. Default: %(default)s . This +# option is ignored if log_config_append is set. (string value) +#log_date_format = %Y-%m-%d %H:%M:%S + +# (Optional) Name of log file to output to. If no default is set, logging will +# go to stdout. This option is ignored if log_config_append is set. (string +# value) +# Deprecated group/name - [DEFAULT]/logfile +#log_file = + +# (Optional) The base directory used for relative --log-file paths. This option +# is ignored if log_config_append is set. (string value) +# Deprecated group/name - [DEFAULT]/logdir +#log_dir = + +# (Optional) Uses logging handler designed to watch file system. When log file +# is moved or removed this handler will open a new log file with specified path +# instantaneously. It makes sense only if log-file option is specified and +# Linux platform is used. This option is ignored if log_config_append is set. +# (boolean value) +#watch_log_file = false + +# Use syslog for logging. Existing syslog format is DEPRECATED and will be +# changed later to honor RFC5424. This option is ignored if log_config_append +# is set. (boolean value) +#use_syslog = false + +# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, +# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The +# format without the APP-NAME is deprecated in Kilo, and will be removed in +# Mitaka, along with this option. This option is ignored if log_config_append +# is set. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#use_syslog_rfc_format = true + +# Syslog facility to receive log lines. This option is ignored if +# log_config_append is set. (string value) +#syslog_log_facility = LOG_USER + +# Log output to standard error. This option is ignored if log_config_append is +# set. (boolean value) +#use_stderr = true + +# Format string to use for log messages with context. (string value) +#logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s + +# Format string to use for log messages without context. (string value) +#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s + +# Data to append to log format when level is DEBUG. (string value) +#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d + +# Prefix each line of exception output with this format. (string value) +#logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s + +# List of logger=LEVEL pairs. This option is ignored if log_config_append is +# set. (list value) +#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN + +# Enables or disables publication of error events. (boolean value) +#publish_errors = false + +# The format for an instance that is passed with the log message. (string +# value) +#instance_format = "[instance: %(uuid)s] " + +# The format for an instance UUID that is passed with the log message. (string +# value) +#instance_uuid_format = "[instance: %(uuid)s] " + +# Format string for user_identity field of the logging_context_format_string +# (string value) +#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s + +# Enables or disables fatal status of deprecations. (boolean value) +#fatal_deprecations = false + + +[ml2] + +# +# From neutron.ml2 +# + +# List of network type driver entrypoints to be loaded from the +# neutron.ml2.type_drivers namespace. (list value) +#type_drivers = local,flat,vlan,gre,vxlan,geneve + +# Ordered list of network_types to allocate as tenant networks. The default +# value 'local' is useful for single-box testing but provides no connectivity +# between hosts. (list value) +#tenant_network_types = local + +# An ordered list of networking mechanism driver entrypoints to be loaded from +# the neutron.ml2.mechanism_drivers namespace. (list value) +#mechanism_drivers = + +# An ordered list of extension driver entrypoints to be loaded from the +# neutron.ml2.extension_drivers namespace. For example: extension_drivers = +# port_security,qos (list value) +#extension_drivers = + +# The maximum permissible size of an unfragmented packet travelling from and to +# addresses where encapsulated Neutron traffic is sent. Drivers calculate +# maximum viable MTU for validating tenant requests based on this value +# (typically, path_mtu - maxmum encapsulation header size). If <= 0, the path +# MTU is indeterminate and no calculation takes place. (integer value) +#path_mtu = 0 + +# The maximum permissible size of an unfragmented packet travelling a L2 +# network segment. If <= 0, the segment MTU is indeterminate and no +# calculation takes place. (integer value) +#segment_mtu = 0 + +# A list of mappings of physical networks to MTU values. The format of the +# mapping is :. This mapping allows specifying a physical +# network MTU value that differs from the default segment_mtu value. (list +# value) +#physical_network_mtus = + +# Default network type for external networks when no provider attributes are +# specified. By default it is None, which means that if provider attributes are +# not specified while creating external networks then they will have the same +# type as tenant networks. Allowed values for external_network_type config +# option depend on the network type values configured in type_drivers config +# option. (string value) +#external_network_type = + + +[ml2_type_flat] + +# +# From neutron.ml2 +# + +# List of physical_network names with which flat networks can be created. Use +# default '*' to allow flat networks with arbitrary physical_network names. Use +# an empty list to disable flat networks. (list value) +#flat_networks = * + + +[ml2_type_geneve] + +# +# From neutron.ml2 +# + +# Comma-separated list of : tuples enumerating ranges of +# Geneve VNI IDs that are available for tenant network allocation (list value) +#vni_ranges = + +# Geneve encapsulation header size is dynamic, this value is used to calculate +# the maximum MTU for the driver. This is the sum of the sizes of the outer ETH +# + IP + UDP + GENEVE header sizes. The default size for this field is 50, +# which is the size of the Geneve header without any additional option headers. +# (integer value) +#max_header_size = 50 + + +[ml2_type_gre] + +# +# From neutron.ml2 +# + +# Comma-separated list of : tuples enumerating ranges of GRE +# tunnel IDs that are available for tenant network allocation (list value) +#tunnel_id_ranges = + + +[ml2_type_vlan] + +# +# From neutron.ml2 +# + +# List of :: or +# specifying physical_network names usable for VLAN provider and tenant +# networks, as well as ranges of VLAN tags on each available for allocation to +# tenant networks. (list value) +#network_vlan_ranges = + + +[ml2_type_vxlan] + +# +# From neutron.ml2 +# + +# Comma-separated list of : tuples enumerating ranges of +# VXLAN VNI IDs that are available for tenant network allocation (list value) +#vni_ranges = + +# Multicast group for VXLAN. When configured, will enable sending all broadcast +# traffic to this multicast group. When left unconfigured, will disable +# multicast VXLAN mode. (string value) +#vxlan_group = + + +[securitygroup] + +# +# From neutron.ml2 +# + +# Driver for security groups firewall in the L2 agent (string value) +#firewall_driver = + +# Controls whether the neutron security group API is enabled in the server. It +# should be false when using no security groups or using the nova security +# group API. (boolean value) +#enable_security_group = true + +# Use ipset to speed-up the iptables based security groups. Enabling ipset +# support requires that ipset is installed on L2 agent node. (boolean value) +#enable_ipset = true diff --git a/doc/config-ref-rst/source/samples/neutron/ml2_conf_sriov.ini.sample b/doc/config-ref-rst/source/samples/neutron/ml2_conf_sriov.ini.sample new file mode 100644 index 0000000000..376c00d781 --- /dev/null +++ b/doc/config-ref-rst/source/samples/neutron/ml2_conf_sriov.ini.sample @@ -0,0 +1,120 @@ +[DEFAULT] + +# +# From oslo.log +# + +# Print debugging output (set logging level to DEBUG instead of default INFO +# level). (boolean value) +#debug = false + +# If set to false, will disable INFO logging level, making WARNING the default. +# (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#verbose = true + +# 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. Note that when logging +# configuration files are used then all logging configuration is set in the +# configuration file and other logging configuration options are ignored (for +# example, log_format). (string value) +# Deprecated group/name - [DEFAULT]/log_config +#log_config_append = + +# DEPRECATED. A logging.Formatter log message format string which may use any +# of the available logging.LogRecord attributes. This option is deprecated. +# Please use logging_context_format_string and logging_default_format_string +# instead. This option is ignored if log_config_append is set. (string value) +#log_format = + +# Format string for %%(asctime)s in log records. Default: %(default)s . This +# option is ignored if log_config_append is set. (string value) +#log_date_format = %Y-%m-%d %H:%M:%S + +# (Optional) Name of log file to output to. If no default is set, logging will +# go to stdout. This option is ignored if log_config_append is set. (string +# value) +# Deprecated group/name - [DEFAULT]/logfile +#log_file = + +# (Optional) The base directory used for relative --log-file paths. This option +# is ignored if log_config_append is set. (string value) +# Deprecated group/name - [DEFAULT]/logdir +#log_dir = + +# (Optional) Uses logging handler designed to watch file system. When log file +# is moved or removed this handler will open a new log file with specified path +# instantaneously. It makes sense only if log-file option is specified and +# Linux platform is used. This option is ignored if log_config_append is set. +# (boolean value) +#watch_log_file = false + +# Use syslog for logging. Existing syslog format is DEPRECATED and will be +# changed later to honor RFC5424. This option is ignored if log_config_append +# is set. (boolean value) +#use_syslog = false + +# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, +# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The +# format without the APP-NAME is deprecated in Kilo, and will be removed in +# Mitaka, along with this option. This option is ignored if log_config_append +# is set. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#use_syslog_rfc_format = true + +# Syslog facility to receive log lines. This option is ignored if +# log_config_append is set. (string value) +#syslog_log_facility = LOG_USER + +# Log output to standard error. This option is ignored if log_config_append is +# set. (boolean value) +#use_stderr = true + +# Format string to use for log messages with context. (string value) +#logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s + +# Format string to use for log messages without context. (string value) +#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s + +# Data to append to log format when level is DEBUG. (string value) +#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d + +# Prefix each line of exception output with this format. (string value) +#logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s + +# List of logger=LEVEL pairs. This option is ignored if log_config_append is +# set. (list value) +#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN + +# Enables or disables publication of error events. (boolean value) +#publish_errors = false + +# The format for an instance that is passed with the log message. (string +# value) +#instance_format = "[instance: %(uuid)s] " + +# The format for an instance UUID that is passed with the log message. (string +# value) +#instance_uuid_format = "[instance: %(uuid)s] " + +# Format string for user_identity field of the logging_context_format_string +# (string value) +#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s + +# Enables or disables fatal status of deprecations. (boolean value) +#fatal_deprecations = false + + +[ml2_sriov] + +# +# From neutron.ml2.sriov +# + +# Comma-separated list of supported PCI vendor devices, as defined by +# vendor_id:product_id according to the PCI ID Repository. Default enables +# support for Intel and Mellanox SR-IOV capable NICs. (list value) +#supported_pci_vendor_devs = 15b3:1004,8086:10ca diff --git a/doc/config-ref-rst/source/samples/neutron/neutron.conf.sample b/doc/config-ref-rst/source/samples/neutron/neutron.conf.sample new file mode 100644 index 0000000000..9de3409312 --- /dev/null +++ b/doc/config-ref-rst/source/samples/neutron/neutron.conf.sample @@ -0,0 +1,1323 @@ +[DEFAULT] + +# +# From neutron +# + +# Where to store Neutron state files. This directory must be writable by the +# agent. (string value) +#state_path = /var/lib/neutron + +# The host IP to bind to (string value) +#bind_host = 0.0.0.0 + +# The port to bind to (port value) +# Minimum value: 1 +# Maximum value: 65535 +#bind_port = 9696 + +# The path for API extensions. Note that this can be a colon-separated list of +# paths. For example: api_extensions_path = +# extensions:/path/to/more/exts:/even/more/exts. The __path__ of +# neutron.extensions is appended to this, so if your extensions are in there +# you don't need to specify them here. (string value) +#api_extensions_path = + +# The type of authentication to use (string value) +#auth_strategy = keystone + +# The core plugin Neutron will use (string value) +#core_plugin = + +# The service plugins Neutron will use (list value) +#service_plugins = + +# The base MAC address Neutron will use for VIFs. The first 3 octets will +# remain unchanged. If the 4th octet is not 00, it will also be used. The +# others will be randomly generated. (string value) +#base_mac = fa:16:3e:00:00:00 + +# How many times Neutron will retry MAC generation (integer value) +#mac_generation_retries = 16 + +# Allow the usage of the bulk API (boolean value) +#allow_bulk = true + +# Allow the usage of the pagination (boolean value) +#allow_pagination = false + +# Allow the usage of the sorting (boolean value) +#allow_sorting = false + +# The maximum number of items returned in a single response, value was +# 'infinite' or negative integer means no limit (string value) +#pagination_max_limit = -1 + +# 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. (list value) +#default_availability_zones = + +# Maximum number of DNS nameservers per subnet (integer value) +#max_dns_nameservers = 5 + +# Maximum number of host routes per subnet (integer value) +#max_subnet_host_routes = 20 + +# Maximum number of fixed ips per port. This option is deprecated and will be +# removed in the N release. (integer value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#max_fixed_ips_per_port = 5 + +# Default IPv4 subnet pool to be used for automatic subnet CIDR allocation. +# Specifies by UUID the pool to be used in case where creation of a subnet is +# being called without a subnet pool ID. If not set then no pool will be used +# unless passed explicitly to the subnet create. If no pool is used, then a +# CIDR must be passed to create a subnet and that subnet will not be allocated +# from any pool; it will be considered part of the tenant's private address +# space. This option is deprecated for removal in the N release. (string value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#default_ipv4_subnet_pool = + +# Default IPv6 subnet pool to be used for automatic subnet CIDR allocation. +# Specifies by UUID the pool to be used in case where creation of a subnet is +# being called without a subnet pool ID. See the description for +# default_ipv4_subnet_pool for more information. This option is deprecated for +# removal in the N release. (string value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#default_ipv6_subnet_pool = + +# 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. (boolean value) +#ipv6_pd_enabled = false + +# DHCP lease duration (in seconds). Use -1 to tell dnsmasq to use infinite +# lease times. (integer value) +# Deprecated group/name - [DEFAULT]/dhcp_lease_time +#dhcp_lease_duration = 86400 + +# Domain to use for building the hostnames (string value) +#dns_domain = openstacklocal + +# Allow sending resource operation notification to DHCP agent (boolean value) +#dhcp_agent_notification = true + +# Allow overlapping IP support in Neutron. Attention: the following parameter +# MUST be set to False if Neutron is being used in conjunction with Nova +# security groups. (boolean value) +#allow_overlapping_ips = false + +# Hostname to be used by the Neutron server, agents and services running on +# this machine. All the agents and services running on this machine must use +# the same host value. (string value) +#host = example.domain + +# Ensure that configured gateway is on subnet. For IPv6, validate only if +# gateway is not a link local address. (boolean value) +#force_gateway_on_subnet = true + +# Send notification to nova when port status changes (boolean value) +#notify_nova_on_port_status_changes = true + +# Send notification to nova when port data (fixed_ips/floatingip) changes so +# nova can update its cache. (boolean value) +#notify_nova_on_port_data_changes = true + +# Number of seconds between sending events to nova if there are any events to +# send. (integer value) +#send_events_interval = 2 + +# If True, effort is made to advertise MTU settings to VMs via network methods +# (DHCP and RA MTU options) when the network's preferred MTU is known. (boolean +# value) +#advertise_mtu = false + +# Neutron IPAM (IP address management) driver to use. If ipam_driver is not set +# (default behavior), no IPAM driver is used. In order to use the reference +# implementation of Neutron IPAM driver, use 'internal'. (string value) +#ipam_driver = + +# If True, then allow plugins that support it to create VLAN transparent +# networks. (boolean value) +#vlan_transparent = false + +# Number of backlog requests to configure the socket with (integer value) +#backlog = 4096 + +# Number of seconds to keep retrying to listen (integer value) +#retry_until_window = 30 + +# Enable SSL on the API server (boolean value) +#use_ssl = false + +# Seconds between running periodic tasks (integer value) +#periodic_interval = 40 + +# Number of separate API worker processes for service. If not specified, the +# default is equal to the number of CPUs available for best performance. +# (integer value) +#api_workers = + +# Number of RPC worker processes for service (integer value) +#rpc_workers = 1 + +# Number of RPC worker processes dedicated to state reports queue (integer +# value) +#rpc_state_report_workers = 1 + +# Range of seconds to randomly delay when starting the periodic task scheduler +# to reduce stampeding. (Disable by setting to 0) (integer value) +#periodic_fuzzy_delay = 5 + +# +# From neutron.agent +# + +# The driver used to manage the virtual interface. (string value) +#interface_driver = + +# Location for Metadata Proxy UNIX domain socket. (string value) +#metadata_proxy_socket = $state_path/metadata_proxy + +# User (uid or name) running metadata proxy after its initialization (if empty: +# agent effective user). (string value) +#metadata_proxy_user = + +# Group (gid or name) running metadata proxy after its initialization (if +# empty: agent effective group). (string value) +#metadata_proxy_group = + +# Enable/Disable log watch by metadata proxy. It should be disabled when +# metadata_proxy_user/group is not allowed to read/write its log file and +# copytruncate logrotate option must be used if logrotate is enabled on +# metadata proxy log files. Option default value is deduced from +# metadata_proxy_user: watch log is enabled if metadata_proxy_user is agent +# effective user id/name. (boolean value) +#metadata_proxy_watch_log = + +# +# From neutron.db +# + +# Seconds to regard the agent is down; should be at least twice +# report_interval, to be sure the agent is down for good. (integer value) +#agent_down_time = 75 + +# Representing the resource type whose load is being reported by the agent. +# This can be "networks", "subnets" or "ports". When specified (Default is +# networks), the server will extract particular load sent as part of its agent +# configuration object from the agent report state, which is the number of +# resources being consumed, at every report_interval.dhcp_load_type can be used +# in combination with network_scheduler_driver = +# neutron.scheduler.dhcp_agent_scheduler.WeightScheduler When the +# network_scheduler_driver is WeightScheduler, dhcp_load_type can be configured +# to represent the choice for the resource being balanced. Example: +# dhcp_load_type=networks (string value) +# Allowed values: networks, subnets, ports +#dhcp_load_type = networks + +# Agent starts with admin_state_up=False when enable_new_agents=False. In the +# case, user's resources will not be scheduled automatically to the agent until +# admin changes admin_state_up to True. (boolean value) +#enable_new_agents = true + +# Maximum number of routes per router (integer value) +#max_routes = 30 + +# Define the default value of enable_snat if not provided in +# external_gateway_info. (boolean value) +#enable_snat_by_default = true + +# Driver to use for scheduling network to DHCP agent (string value) +#network_scheduler_driver = neutron.scheduler.dhcp_agent_scheduler.WeightScheduler + +# Allow auto scheduling networks to DHCP agent. (boolean value) +#network_auto_schedule = true + +# Automatically remove networks from offline DHCP agents. (boolean value) +#allow_automatic_dhcp_failover = true + +# Number of DHCP agents scheduled to host a tenant network. If this number is +# greater than 1, the scheduler automatically assigns multiple DHCP agents for +# a given tenant network, providing high availability for DHCP service. +# (integer value) +#dhcp_agents_per_network = 1 + +# Enable services on an agent with admin_state_up False. If this option is +# False, when admin_state_up of an agent is turned False, services on it will +# be disabled. Agents with admin_state_up False are not selected for automatic +# scheduling regardless of this option. But manual scheduling to such agents is +# available if this option is True. (boolean value) +#enable_services_on_agents_with_admin_state_down = false + +# The base mac address used for unique DVR instances by Neutron. The first 3 +# octets will remain unchanged. If the 4th octet is not 00, it will also be +# used. The others will be randomly generated. The 'dvr_base_mac' *must* be +# different from 'base_mac' to avoid mixing them up with MAC's allocated for +# tenant ports. A 4 octet example would be dvr_base_mac = fa:16:3f:4f:00:00. +# The default is 3 octet (string value) +#dvr_base_mac = fa:16:3f:00:00:00 + +# System-wide flag to determine the type of router that tenants can create. +# Only admin can override. (boolean value) +#router_distributed = false + +# Driver to use for scheduling router to a default L3 agent (string value) +#router_scheduler_driver = neutron.scheduler.l3_agent_scheduler.LeastRoutersScheduler + +# Allow auto scheduling of routers to L3 agent. (boolean value) +#router_auto_schedule = true + +# Automatically reschedule routers from offline L3 agents to online L3 agents. +# (boolean value) +#allow_automatic_l3agent_failover = false + +# Enable HA mode for virtual routers. (boolean value) +#l3_ha = false + +# Maximum number of L3 agents which a HA router will be scheduled on. If it is +# set to 0 then the router will be scheduled on every agent. (integer value) +#max_l3_agents_per_router = 3 + +# Minimum number of L3 agents which a HA router will be scheduled on. If it is +# set to 0 then the router will be scheduled on every agent. (integer value) +#min_l3_agents_per_router = 2 + +# Subnet used for the l3 HA admin network. (string value) +#l3_ha_net_cidr = 169.254.192.0/18 + +# The network type to use when creating the HA network for an HA router. By +# default or if empty, the first 'tenant_network_types' is used. This is +# helpful when the VRRP traffic should use a specific network which is not the +# default one. (string value) +#l3_ha_network_type = + +# The physical network name with which the HA network can be created. (string +# value) +#l3_ha_network_physical_name = + +# +# From neutron.extensions +# + +# Maximum number of allowed address pairs (integer value) +#max_allowed_address_pair = 10 + +# +# From neutron.qos +# + +# Drivers list to use to send the update notification (list value) +#notification_drivers = m,e,s,s,a,g,e,_,q,u,e,u,e + +# +# From oslo.log +# + +# Print debugging output (set logging level to DEBUG instead of default INFO +# level). (boolean value) +#debug = false + +# If set to false, will disable INFO logging level, making WARNING the default. +# (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#verbose = true + +# 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. Note that when logging +# configuration files are used then all logging configuration is set in the +# configuration file and other logging configuration options are ignored (for +# example, log_format). (string value) +# Deprecated group/name - [DEFAULT]/log_config +#log_config_append = + +# DEPRECATED. A logging.Formatter log message format string which may use any +# of the available logging.LogRecord attributes. This option is deprecated. +# Please use logging_context_format_string and logging_default_format_string +# instead. This option is ignored if log_config_append is set. (string value) +#log_format = + +# Format string for %%(asctime)s in log records. Default: %(default)s . This +# option is ignored if log_config_append is set. (string value) +#log_date_format = %Y-%m-%d %H:%M:%S + +# (Optional) Name of log file to output to. If no default is set, logging will +# go to stdout. This option is ignored if log_config_append is set. (string +# value) +# Deprecated group/name - [DEFAULT]/logfile +#log_file = + +# (Optional) The base directory used for relative --log-file paths. This option +# is ignored if log_config_append is set. (string value) +# Deprecated group/name - [DEFAULT]/logdir +#log_dir = + +# (Optional) Uses logging handler designed to watch file system. When log file +# is moved or removed this handler will open a new log file with specified path +# instantaneously. It makes sense only if log-file option is specified and +# Linux platform is used. This option is ignored if log_config_append is set. +# (boolean value) +#watch_log_file = false + +# Use syslog for logging. Existing syslog format is DEPRECATED and will be +# changed later to honor RFC5424. This option is ignored if log_config_append +# is set. (boolean value) +#use_syslog = false + +# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, +# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The +# format without the APP-NAME is deprecated in Kilo, and will be removed in +# Mitaka, along with this option. This option is ignored if log_config_append +# is set. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#use_syslog_rfc_format = true + +# Syslog facility to receive log lines. This option is ignored if +# log_config_append is set. (string value) +#syslog_log_facility = LOG_USER + +# Log output to standard error. This option is ignored if log_config_append is +# set. (boolean value) +#use_stderr = true + +# Format string to use for log messages with context. (string value) +#logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s + +# Format string to use for log messages without context. (string value) +#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s + +# Data to append to log format when level is DEBUG. (string value) +#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d + +# Prefix each line of exception output with this format. (string value) +#logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s + +# List of logger=LEVEL pairs. This option is ignored if log_config_append is +# set. (list value) +#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN + +# Enables or disables publication of error events. (boolean value) +#publish_errors = false + +# The format for an instance that is passed with the log message. (string +# value) +#instance_format = "[instance: %(uuid)s] " + +# The format for an instance UUID that is passed with the log message. (string +# value) +#instance_uuid_format = "[instance: %(uuid)s] " + +# Format string for user_identity field of the logging_context_format_string +# (string value) +#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s + +# Enables or disables fatal status of deprecations. (boolean value) +#fatal_deprecations = false + +# +# From oslo.messaging +# + +# Size of RPC connection pool. (integer value) +# Deprecated group/name - [DEFAULT]/rpc_conn_pool_size +#rpc_conn_pool_size = 30 + +# ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. +# The "host" option should point or resolve to this address. (string value) +#rpc_zmq_bind_address = * + +# MatchMaker driver. (string value) +#rpc_zmq_matchmaker = redis + +# Use REQ/REP pattern for all methods CALL/CAST/FANOUT. (boolean value) +#rpc_zmq_all_req_rep = true + +# Type of concurrency used. Either "native" or "eventlet" (string value) +#rpc_zmq_concurrency = eventlet + +# Number of ZeroMQ contexts, defaults to 1. (integer value) +#rpc_zmq_contexts = 1 + +# Maximum number of ingress messages to locally buffer per topic. Default is +# unlimited. (integer value) +#rpc_zmq_topic_backlog = + +# Directory for holding IPC sockets. (string value) +#rpc_zmq_ipc_dir = /var/run/openstack + +# Name of this node. Must be a valid hostname, FQDN, or IP address. Must match +# "host" option, if running Nova. (string value) +#rpc_zmq_host = localhost + +# Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. +# (integer value) +#rpc_cast_timeout = 30 + +# The default number of seconds that poll should wait. Poll raises timeout +# exception when timeout expired. (integer value) +#rpc_poll_timeout = 1 + +# Configures zmq-messaging to use broker or not. (boolean value) +#zmq_use_broker = false + +# Minimal port number for random ports range. (port value) +# Minimum value: 1 +# Maximum value: 65535 +#rpc_zmq_min_port = 49152 + +# Maximal port number for random ports range. (integer value) +# Minimum value: 1 +# Maximum value: 65536 +#rpc_zmq_max_port = 65536 + +# Number of retries to find free port number before fail with ZMQBindError. +# (integer value) +#rpc_zmq_bind_port_retries = 100 + +# Host to locate redis. (string value) +#host = 127.0.0.1 + +# Use this port to connect to redis host. (port value) +# Minimum value: 1 +# Maximum value: 65535 +#port = 6379 + +# Password for Redis server (optional). (string value) +#password = + +# Size of executor thread pool. (integer value) +# Deprecated group/name - [DEFAULT]/rpc_thread_pool_size +#executor_thread_pool_size = 64 + +# The Drivers(s) to handle sending notifications. Possible values are +# messaging, messagingv2, routing, log, test, noop (multi valued) +# Deprecated group/name - [DEFAULT]/notification_driver +#driver = + +# A URL representing the messaging driver to use for notifications. If not set, +# we fall back to the same configuration used for RPC. (string value) +# Deprecated group/name - [DEFAULT]/notification_transport_url +#transport_url = + +# AMQP topic used for OpenStack notifications. (list value) +# Deprecated group/name - [rpc_notifier2]/topics +# Deprecated group/name - [DEFAULT]/notification_topics +#topics = notifications + +# Seconds to wait for a response from a call. (integer value) +#rpc_response_timeout = 60 + +# A URL representing the messaging driver to use and its full configuration. If +# not set, we fall back to the rpc_backend option and driver specific +# configuration. (string value) +#transport_url = + +# The messaging driver to use, defaults to rabbit. Other drivers include amqp +# and zmq. (string value) +#rpc_backend = rabbit + +# The default exchange under which topics are scoped. May be overridden by an +# exchange name specified in the transport_url option. (string value) +#control_exchange = neutron + +# +# From oslo.service.wsgi +# + +# File name for the paste.deploy config for api service (string value) +#api_paste_config = api-paste.ini + +# 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. (string value) +#wsgi_log_format = %(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f + +# Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not +# supported on OS X. (integer value) +#tcp_keepidle = 600 + +# Size of the pool of greenthreads used by wsgi (integer value) +#wsgi_default_pool_size = 1000 + +# Maximum line size of message headers to be accepted. max_header_line may need +# to be increased when using large tokens (typically those generated by the +# Keystone v3 API with big service catalogs). (integer value) +#max_header_line = 16384 + +# If False, closes the client socket connection explicitly. (boolean value) +#wsgi_keep_alive = true + +# Timeout for client connections' socket operations. If an incoming connection +# is idle for this number of seconds it will be closed. A value of '0' means +# wait forever. (integer value) +#client_socket_timeout = 900 + + +[agent] + +# +# From neutron.agent +# + +# Root helper application. Use 'sudo neutron-rootwrap +# /etc/neutron/rootwrap.conf' to use the real root filter facility. Change to +# 'sudo' to skip the filtering and just run the command directly. (string +# value) +#root_helper = sudo + +# Use the root helper when listing the namespaces on a system. This may not be +# required depending on the security configuration. If the root helper is not +# required, set this to False for a performance improvement. (boolean value) +#use_helper_for_ns_read = true + +# Root helper daemon application to use when possible. (string value) +#root_helper_daemon = + +# Seconds between nodes reporting state to server; should be less than +# agent_down_time, best if it is half or less than agent_down_time. (floating +# point value) +#report_interval = 30 + +# Log agent heartbeats (boolean value) +#log_agent_heartbeats = false + +# Add comments to iptables rules. Set to false to disallow the addition of +# comments to generated iptables rules that describe each rule's purpose. +# System must support the iptables comments module for addition of comments. +# (boolean value) +#comment_iptables_rules = true + +# Action to be executed when a child process dies (string value) +# Allowed values: respawn, exit +#check_child_processes_action = respawn + +# Interval between checks of child process liveness (seconds), use 0 to disable +# (integer value) +#check_child_processes_interval = 60 + +# Availability zone of this node (string value) +#availability_zone = nova + + +[database] + +# +# From neutron.db +# + +# Database engine for which script will be generated when using offline +# migration. (string value) +#engine = + +# +# From oslo.db +# + +# The file name to use with SQLite. (string value) +# Deprecated group/name - [DEFAULT]/sqlite_db +#sqlite_db = oslo.sqlite + +# If True, SQLite uses synchronous mode. (boolean value) +# Deprecated group/name - [DEFAULT]/sqlite_synchronous +#sqlite_synchronous = true + +# The back end to use for the database. (string value) +# Deprecated group/name - [DEFAULT]/db_backend +#backend = sqlalchemy + +# The SQLAlchemy connection string to use to connect to the database. (string +# value) +# Deprecated group/name - [DEFAULT]/sql_connection +# Deprecated group/name - [DATABASE]/sql_connection +# Deprecated group/name - [sql]/connection +#connection = + +# The SQLAlchemy connection string to use to connect to the slave database. +# (string value) +#slave_connection = + +# 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= +# (string value) +#mysql_sql_mode = TRADITIONAL + +# Timeout before idle SQL connections are reaped. (integer value) +# Deprecated group/name - [DEFAULT]/sql_idle_timeout +# Deprecated group/name - [DATABASE]/sql_idle_timeout +# Deprecated group/name - [sql]/idle_timeout +#idle_timeout = 3600 + +# Minimum number of SQL connections to keep open in a pool. (integer value) +# Deprecated group/name - [DEFAULT]/sql_min_pool_size +# Deprecated group/name - [DATABASE]/sql_min_pool_size +#min_pool_size = 1 + +# Maximum number of SQL connections to keep open in a pool. (integer value) +# Deprecated group/name - [DEFAULT]/sql_max_pool_size +# Deprecated group/name - [DATABASE]/sql_max_pool_size +#max_pool_size = + +# Maximum number of database connection retries during startup. Set to -1 to +# specify an infinite retry count. (integer value) +# Deprecated group/name - [DEFAULT]/sql_max_retries +# Deprecated group/name - [DATABASE]/sql_max_retries +#max_retries = 10 + +# Interval between retries of opening a SQL connection. (integer value) +# Deprecated group/name - [DEFAULT]/sql_retry_interval +# Deprecated group/name - [DATABASE]/reconnect_interval +#retry_interval = 10 + +# If set, use this value for max_overflow with SQLAlchemy. (integer value) +# Deprecated group/name - [DEFAULT]/sql_max_overflow +# Deprecated group/name - [DATABASE]/sqlalchemy_max_overflow +#max_overflow = + +# Verbosity of SQL debugging information: 0=None, 100=Everything. (integer +# value) +# Deprecated group/name - [DEFAULT]/sql_connection_debug +#connection_debug = 0 + +# Add Python stack traces to SQL as comment strings. (boolean value) +# Deprecated group/name - [DEFAULT]/sql_connection_trace +#connection_trace = false + +# If set, use this value for pool_timeout with SQLAlchemy. (integer value) +# Deprecated group/name - [DATABASE]/sqlalchemy_pool_timeout +#pool_timeout = + +# Enable the experimental use of database reconnect on connection lost. +# (boolean value) +#use_db_reconnect = false + +# Seconds between retries of a database transaction. (integer value) +#db_retry_interval = 1 + +# If True, increases the interval between retries of a database operation up to +# db_max_retry_interval. (boolean value) +#db_inc_retry_interval = true + +# If db_inc_retry_interval is set, the maximum seconds between retries of a +# database operation. (integer value) +#db_max_retry_interval = 10 + +# Maximum retries in case of connection error or deadlock error before error is +# raised. Set to -1 to specify an infinite retry count. (integer value) +#db_max_retries = 20 + + +[keystone_authtoken] + +# +# From keystonemiddleware.auth_token +# + +# Complete public Identity API endpoint. (string value) +#auth_uri = + +# API version of the admin Identity API endpoint. (string value) +#auth_version = + +# Do not handle authorization requests within the middleware, but delegate the +# authorization decision to downstream WSGI components. (boolean value) +#delay_auth_decision = false + +# Request timeout value for communicating with Identity API server. (integer +# value) +#http_connect_timeout = + +# How many times are we trying to reconnect when communicating with Identity +# API Server. (integer value) +#http_request_max_retries = 3 + +# Env key for the swift cache. (string value) +#cache = + +# Required if identity server requires client certificate (string value) +#certfile = + +# Required if identity server requires client certificate (string value) +#keyfile = + +# A PEM encoded Certificate Authority to use when verifying HTTPs connections. +# Defaults to system CAs. (string value) +#cafile = + +# Verify HTTPS connections. (boolean value) +#insecure = false + +# The region in which the identity server can be found. (string value) +#region_name = + +# Directory used to cache files related to PKI tokens. (string value) +#signing_dir = + +# Optionally specify a list of memcached server(s) to use for caching. If left +# undefined, tokens will instead be cached in-process. (list value) +# Deprecated group/name - [DEFAULT]/memcache_servers +#memcached_servers = + +# In order to prevent excessive effort spent validating tokens, the middleware +# caches previously-seen tokens for a configurable duration (in seconds). Set +# to -1 to disable caching completely. (integer value) +#token_cache_time = 300 + +# Determines the frequency at which the list of revoked tokens is retrieved +# from the Identity service (in seconds). A high number of revocation events +# combined with a low cache duration may significantly reduce performance. +# (integer value) +#revocation_cache_time = 10 + +# (Optional) If defined, indicate whether token data should be authenticated or +# authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, +# token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data +# is encrypted and authenticated in the cache. If the value is not one of these +# options or empty, auth_token will raise an exception on initialization. +# (string value) +#memcache_security_strategy = + +# (Optional, mandatory if memcache_security_strategy is defined) This string is +# used for key derivation. (string value) +#memcache_secret_key = + +# (Optional) Number of seconds memcached server is considered dead before it is +# tried again. (integer value) +#memcache_pool_dead_retry = 300 + +# (Optional) Maximum total number of open connections to every memcached +# server. (integer value) +#memcache_pool_maxsize = 10 + +# (Optional) Socket timeout in seconds for communicating with a memcached +# server. (integer value) +#memcache_pool_socket_timeout = 3 + +# (Optional) Number of seconds a connection to memcached is held unused in the +# pool before it is closed. (integer value) +#memcache_pool_unused_timeout = 60 + +# (Optional) Number of seconds that an operation will wait to get a memcached +# client connection from the pool. (integer value) +#memcache_pool_conn_get_timeout = 10 + +# (Optional) Use the advanced (eventlet safe) memcached client pool. The +# advanced pool will only work under python 2.x. (boolean value) +#memcache_use_advanced_pool = false + +# (Optional) Indicate whether to set the X-Service-Catalog header. If False, +# middleware will not ask for service catalog on token validation and will not +# set the X-Service-Catalog header. (boolean value) +#include_service_catalog = true + +# Used to control the use and type of token binding. Can be set to: "disabled" +# to not check token binding. "permissive" (default) to validate binding +# information if the bind type is of a form known to the server and ignore it +# if not. "strict" like "permissive" but if the bind type is unknown the token +# will be rejected. "required" any form of token binding is needed to be +# allowed. Finally the name of a binding method that must be present in tokens. +# (string value) +#enforce_token_bind = permissive + +# If true, the revocation list will be checked for cached tokens. This requires +# that PKI tokens are configured on the identity server. (boolean value) +#check_revocations_for_cached = false + +# Hash algorithms to use for hashing PKI tokens. This may be a single algorithm +# or multiple. The algorithms are those supported by Python standard +# hashlib.new(). The hashes will be tried in the order given, so put the +# preferred one first for performance. The result of the first hash will be +# stored in the cache. This will typically be set to multiple values only while +# migrating from a less secure algorithm to a more secure one. Once all the old +# tokens are expired this option should be set to a single value for better +# performance. (list value) +#hash_algorithms = md5 + +# Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. +# (string value) +#auth_admin_prefix = + +# Host providing the admin Identity API endpoint. Deprecated, use identity_uri. +# (string value) +#auth_host = 127.0.0.1 + +# Port of the admin Identity API endpoint. Deprecated, use identity_uri. +# (integer value) +#auth_port = 35357 + +# Protocol of the admin Identity API endpoint (http or https). Deprecated, use +# identity_uri. (string value) +#auth_protocol = https + +# Complete admin Identity API endpoint. This should specify the unversioned +# root endpoint e.g. https://localhost:35357/ (string value) +#identity_uri = + +# This option is deprecated and may be removed in a future release. Single +# shared secret with the Keystone configuration used for bootstrapping a +# Keystone installation, or otherwise bypassing the normal authentication +# process. This option should not be used, use `admin_user` and +# `admin_password` instead. (string value) +#admin_token = + +# Service username. (string value) +#admin_user = + +# Service user password. (string value) +#admin_password = + +# Service tenant name. (string value) +#admin_tenant_name = admin + +# Authentication type to load (unknown value) +# Deprecated group/name - [DEFAULT]/auth_plugin +#auth_type = + +# Config Section from which to load plugin specific options (unknown value) +#auth_section = + + +[matchmaker_redis] + +# +# From oslo.messaging +# + +# Host to locate redis. (string value) +#host = 127.0.0.1 + +# Use this port to connect to redis host. (port value) +# Minimum value: 1 +# Maximum value: 65535 +#port = 6379 + +# Password for Redis server (optional). (string value) +#password = + + +[nova] + +# +# From neutron +# + +# Name of nova region to use. Useful if keystone manages more than one region. +# (string value) +#region_name = + +# +# From nova.auth +# + +# Authentication URL (unknown value) +#auth_url = + +# Authentication type to load (unknown value) +# Deprecated group/name - [DEFAULT]/auth_plugin +#auth_type = + +# PEM encoded Certificate Authority to use when verifying HTTPs connections. +# (string value) +#cafile = + +# PEM encoded client certificate cert file (string value) +#certfile = + +# Optional domain ID to use with v3 and v2 parameters. It will be used for both +# the user and project domain in v3 and ignored in v2 authentication. (unknown +# value) +#default_domain_id = + +# Optional domain name to use with v3 API and v2 parameters. It will be used +# for both the user and project domain in v3 and ignored in v2 authentication. +# (unknown value) +#default_domain_name = + +# Domain ID to scope to (unknown value) +#domain_id = + +# Domain name to scope to (unknown value) +#domain_name = + +# Verify HTTPS connections. (boolean value) +#insecure = false + +# PEM encoded client certificate key file (string value) +#keyfile = + +# User's password (unknown value) +#password = + +# Domain ID containing project (unknown value) +#project_domain_id = + +# Domain name containing project (unknown value) +#project_domain_name = + +# Project ID to scope to (unknown value) +# Deprecated group/name - [DEFAULT]/tenant-id +#project_id = + +# Project name to scope to (unknown value) +# Deprecated group/name - [DEFAULT]/tenant-name +#project_name = + +# Tenant ID (unknown value) +#tenant_id = + +# Tenant Name (unknown value) +#tenant_name = + +# Timeout value for http requests (integer value) +#timeout = + +# Trust ID (unknown value) +#trust_id = + +# User's domain id (unknown value) +#user_domain_id = + +# User's domain name (unknown value) +#user_domain_name = + +# User id (unknown value) +#user_id = + +# Username (unknown value) +# Deprecated group/name - [DEFAULT]/username +#username = + + +[oslo_concurrency] + +# +# From oslo.concurrency +# + +# Enables or disables inter-process locks. (boolean value) +# Deprecated group/name - [DEFAULT]/disable_process_locking +#disable_process_locking = false + +# 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. (string value) +# Deprecated group/name - [DEFAULT]/lock_path +#lock_path = + + +[oslo_messaging_amqp] + +# +# From oslo.messaging +# + +# address prefix used when sending to a specific server (string value) +# Deprecated group/name - [amqp1]/server_request_prefix +#server_request_prefix = exclusive + +# address prefix used when broadcasting to all servers (string value) +# Deprecated group/name - [amqp1]/broadcast_prefix +#broadcast_prefix = broadcast + +# address prefix when sending to any server in group (string value) +# Deprecated group/name - [amqp1]/group_request_prefix +#group_request_prefix = unicast + +# Name for the AMQP container (string value) +# Deprecated group/name - [amqp1]/container_name +#container_name = + +# Timeout for inactive connections (in seconds) (integer value) +# Deprecated group/name - [amqp1]/idle_timeout +#idle_timeout = 0 + +# Debug: dump AMQP frames to stdout (boolean value) +# Deprecated group/name - [amqp1]/trace +#trace = false + +# CA certificate PEM file to verify server certificate (string value) +# Deprecated group/name - [amqp1]/ssl_ca_file +#ssl_ca_file = + +# Identifying certificate PEM file to present to clients (string value) +# Deprecated group/name - [amqp1]/ssl_cert_file +#ssl_cert_file = + +# Private key PEM file used to sign cert_file certificate (string value) +# Deprecated group/name - [amqp1]/ssl_key_file +#ssl_key_file = + +# Password for decrypting ssl_key_file (if encrypted) (string value) +# Deprecated group/name - [amqp1]/ssl_key_password +#ssl_key_password = + +# Accept clients using either SSL or plain TCP (boolean value) +# Deprecated group/name - [amqp1]/allow_insecure_clients +#allow_insecure_clients = false + +# Space separated list of acceptable SASL mechanisms (string value) +# Deprecated group/name - [amqp1]/sasl_mechanisms +#sasl_mechanisms = + +# Path to directory that contains the SASL configuration (string value) +# Deprecated group/name - [amqp1]/sasl_config_dir +#sasl_config_dir = + +# Name of configuration file (without .conf suffix) (string value) +# Deprecated group/name - [amqp1]/sasl_config_name +#sasl_config_name = + +# User name for message broker authentication (string value) +# Deprecated group/name - [amqp1]/username +#username = + +# Password for message broker authentication (string value) +# Deprecated group/name - [amqp1]/password +#password = + + +[oslo_messaging_rabbit] + +# +# From oslo.messaging +# + +# Use durable queues in AMQP. (boolean value) +# Deprecated group/name - [DEFAULT]/amqp_durable_queues +# Deprecated group/name - [DEFAULT]/rabbit_durable_queues +#amqp_durable_queues = false + +# Auto-delete queues in AMQP. (boolean value) +# Deprecated group/name - [DEFAULT]/amqp_auto_delete +#amqp_auto_delete = false + +# 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. (boolean value) +#send_single_reply = false + +# 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. (string value) +# Deprecated group/name - [DEFAULT]/kombu_ssl_version +#kombu_ssl_version = + +# SSL key file (valid only if SSL enabled). (string value) +# Deprecated group/name - [DEFAULT]/kombu_ssl_keyfile +#kombu_ssl_keyfile = + +# SSL cert file (valid only if SSL enabled). (string value) +# Deprecated group/name - [DEFAULT]/kombu_ssl_certfile +#kombu_ssl_certfile = + +# SSL certification authority file (valid only if SSL enabled). (string value) +# Deprecated group/name - [DEFAULT]/kombu_ssl_ca_certs +#kombu_ssl_ca_certs = + +# How long to wait before reconnecting in response to an AMQP consumer cancel +# notification. (floating point value) +# Deprecated group/name - [DEFAULT]/kombu_reconnect_delay +#kombu_reconnect_delay = 1.0 + +# How long to wait a missing client beforce abandoning to send it its replies. +# This value should not be longer than rpc_response_timeout. (integer value) +# Deprecated group/name - [DEFAULT]/kombu_reconnect_timeout +#kombu_missing_consumer_retry_timeout = 5 + +# Determines how the next RabbitMQ node is chosen in case the one we are +# currently connected to becomes unavailable. Takes effect only if more than +# one RabbitMQ node is provided in config. (string value) +# Allowed values: round-robin, shuffle +#kombu_failover_strategy = round-robin + +# The RabbitMQ broker address where a single node is used. (string value) +# Deprecated group/name - [DEFAULT]/rabbit_host +#rabbit_host = localhost + +# The RabbitMQ broker port where a single node is used. (port value) +# Minimum value: 1 +# Maximum value: 65535 +# Deprecated group/name - [DEFAULT]/rabbit_port +#rabbit_port = 5672 + +# RabbitMQ HA cluster host:port pairs. (list value) +# Deprecated group/name - [DEFAULT]/rabbit_hosts +#rabbit_hosts = $rabbit_host:$rabbit_port + +# Connect over SSL for RabbitMQ. (boolean value) +# Deprecated group/name - [DEFAULT]/rabbit_use_ssl +#rabbit_use_ssl = false + +# The RabbitMQ userid. (string value) +# Deprecated group/name - [DEFAULT]/rabbit_userid +#rabbit_userid = guest + +# The RabbitMQ password. (string value) +# Deprecated group/name - [DEFAULT]/rabbit_password +#rabbit_password = guest + +# The RabbitMQ login method. (string value) +# Deprecated group/name - [DEFAULT]/rabbit_login_method +#rabbit_login_method = AMQPLAIN + +# The RabbitMQ virtual host. (string value) +# Deprecated group/name - [DEFAULT]/rabbit_virtual_host +#rabbit_virtual_host = / + +# How frequently to retry connecting with RabbitMQ. (integer value) +#rabbit_retry_interval = 1 + +# How long to backoff for between retries when connecting to RabbitMQ. (integer +# value) +# Deprecated group/name - [DEFAULT]/rabbit_retry_backoff +#rabbit_retry_backoff = 2 + +# Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry +# count). (integer value) +# Deprecated group/name - [DEFAULT]/rabbit_max_retries +#rabbit_max_retries = 0 + +# Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you +# must wipe the RabbitMQ database. (boolean value) +# Deprecated group/name - [DEFAULT]/rabbit_ha_queues +#rabbit_ha_queues = false + +# Number of seconds after which the Rabbit broker is considered down if +# heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL (integer +# value) +#heartbeat_timeout_threshold = 60 + +# How often times during the heartbeat_timeout_threshold we check the +# heartbeat. (integer value) +#heartbeat_rate = 2 + +# Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake (boolean value) +# Deprecated group/name - [DEFAULT]/fake_rabbit +#fake_rabbit = false + + +[oslo_policy] + +# +# From oslo.policy +# + +# The JSON file that defines policies. (string value) +# Deprecated group/name - [DEFAULT]/policy_file +#policy_file = policy.json + +# Default rule. Enforced when a requested rule is not found. (string value) +# Deprecated group/name - [DEFAULT]/policy_default_rule +#policy_default_rule = default + +# 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. (multi +# valued) +# Deprecated group/name - [DEFAULT]/policy_dirs +#policy_dirs = policy.d + + +[quotas] + +# +# From neutron +# + +# Resource name(s) that are supported in quota features. This option is now +# deprecated for removal. (list value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#quota_items = network,subnet,port + +# Default number of resource allowed per tenant. A negative value means +# unlimited. (integer value) +#default_quota = -1 + +# Number of networks allowed per tenant. A negative value means unlimited. +# (integer value) +#quota_network = 10 + +# Number of subnets allowed per tenant, A negative value means unlimited. +# (integer value) +#quota_subnet = 10 + +# Number of ports allowed per tenant. A negative value means unlimited. +# (integer value) +#quota_port = 50 + +# Default driver to use for quota checks (string value) +#quota_driver = neutron.db.quota.driver.DbQuotaDriver + +# Keep in track in the database of current resourcequota usage. Plugins which +# do not leverage the neutron database should set this flag to False (boolean +# value) +#track_quota_usage = true + +# +# From neutron.extensions +# + +# Number of routers allowed per tenant. A negative value means unlimited. +# (integer value) +#quota_router = 10 + +# Number of floating IPs allowed per tenant. A negative value means unlimited. +# (integer value) +#quota_floatingip = 50 + +# Number of security groups allowed per tenant. A negative value means +# unlimited. (integer value) +#quota_security_group = 10 + +# Number of security rules allowed per tenant. A negative value means +# unlimited. (integer value) +#quota_security_group_rule = 100 + + +[ssl] + +# +# From oslo.service.sslutils +# + +# CA certificate file to use to verify connecting clients. (string value) +# Deprecated group/name - [DEFAULT]/ssl_ca_file +#ca_file = + +# Certificate file to use when starting the server securely. (string value) +# Deprecated group/name - [DEFAULT]/ssl_cert_file +#cert_file = + +# Private key file to use when starting the server securely. (string value) +# Deprecated group/name - [DEFAULT]/ssl_key_file +#key_file = + +# 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. (string value) +#version = + +# Sets the list of available ciphers. value should be a string in the OpenSSL +# cipher list format. (string value) +#ciphers = diff --git a/doc/config-ref-rst/source/samples/neutron/openvswitch_agent.ini.sample b/doc/config-ref-rst/source/samples/neutron/openvswitch_agent.ini.sample new file mode 100644 index 0000000000..627f48892d --- /dev/null +++ b/doc/config-ref-rst/source/samples/neutron/openvswitch_agent.ini.sample @@ -0,0 +1,281 @@ +[DEFAULT] + +# +# From oslo.log +# + +# Print debugging output (set logging level to DEBUG instead of default INFO +# level). (boolean value) +#debug = false + +# If set to false, will disable INFO logging level, making WARNING the default. +# (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#verbose = true + +# 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. Note that when logging +# configuration files are used then all logging configuration is set in the +# configuration file and other logging configuration options are ignored (for +# example, log_format). (string value) +# Deprecated group/name - [DEFAULT]/log_config +#log_config_append = + +# DEPRECATED. A logging.Formatter log message format string which may use any +# of the available logging.LogRecord attributes. This option is deprecated. +# Please use logging_context_format_string and logging_default_format_string +# instead. This option is ignored if log_config_append is set. (string value) +#log_format = + +# Format string for %%(asctime)s in log records. Default: %(default)s . This +# option is ignored if log_config_append is set. (string value) +#log_date_format = %Y-%m-%d %H:%M:%S + +# (Optional) Name of log file to output to. If no default is set, logging will +# go to stdout. This option is ignored if log_config_append is set. (string +# value) +# Deprecated group/name - [DEFAULT]/logfile +#log_file = + +# (Optional) The base directory used for relative --log-file paths. This option +# is ignored if log_config_append is set. (string value) +# Deprecated group/name - [DEFAULT]/logdir +#log_dir = + +# (Optional) Uses logging handler designed to watch file system. When log file +# is moved or removed this handler will open a new log file with specified path +# instantaneously. It makes sense only if log-file option is specified and +# Linux platform is used. This option is ignored if log_config_append is set. +# (boolean value) +#watch_log_file = false + +# Use syslog for logging. Existing syslog format is DEPRECATED and will be +# changed later to honor RFC5424. This option is ignored if log_config_append +# is set. (boolean value) +#use_syslog = false + +# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, +# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The +# format without the APP-NAME is deprecated in Kilo, and will be removed in +# Mitaka, along with this option. This option is ignored if log_config_append +# is set. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#use_syslog_rfc_format = true + +# Syslog facility to receive log lines. This option is ignored if +# log_config_append is set. (string value) +#syslog_log_facility = LOG_USER + +# Log output to standard error. This option is ignored if log_config_append is +# set. (boolean value) +#use_stderr = true + +# Format string to use for log messages with context. (string value) +#logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s + +# Format string to use for log messages without context. (string value) +#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s + +# Data to append to log format when level is DEBUG. (string value) +#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d + +# Prefix each line of exception output with this format. (string value) +#logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s + +# List of logger=LEVEL pairs. This option is ignored if log_config_append is +# set. (list value) +#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN + +# Enables or disables publication of error events. (boolean value) +#publish_errors = false + +# The format for an instance that is passed with the log message. (string +# value) +#instance_format = "[instance: %(uuid)s] " + +# The format for an instance UUID that is passed with the log message. (string +# value) +#instance_uuid_format = "[instance: %(uuid)s] " + +# Format string for user_identity field of the logging_context_format_string +# (string value) +#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s + +# Enables or disables fatal status of deprecations. (boolean value) +#fatal_deprecations = false + + +[agent] + +# +# From neutron.ml2.ovs.agent +# + +# The number of seconds the agent will wait between polling for local device +# changes. (integer value) +#polling_interval = 2 + +# Minimize polling by monitoring ovsdb for interface changes. (boolean value) +#minimize_polling = true + +# The number of seconds to wait before respawning the ovsdb monitor after +# losing communication with it. (integer value) +#ovsdb_monitor_respawn_interval = 30 + +# Network types supported by the agent (gre and/or vxlan). (list value) +#tunnel_types = + +# The UDP port to use for VXLAN tunnels. (port value) +# Minimum value: 1 +# Maximum value: 65535 +#vxlan_udp_port = 4789 + +# MTU size of veth interfaces (integer value) +#veth_mtu = + +# Use ML2 l2population mechanism driver to learn remote MAC and IPs and improve +# tunnel scalability. (boolean value) +#l2_population = false + +# Enable local ARP responder if it is supported. Requires OVS 2.1 and ML2 +# l2population driver. Allows the switch (when supporting an overlay) to +# respond to an ARP request locally without performing a costly ARP broadcast +# into the overlay. (boolean value) +#arp_responder = false + +# Enable suppression of ARP responses that don't match an IP address that +# belongs to the port from which they originate. Note: This prevents the VMs +# attached to this agent from spoofing, it doesn't protect them from other +# devices which have the capability to spoof (e.g. bare metal or VMs attached +# to agents without this flag set to True). Spoofing rules will not be added to +# any ports that have port security disabled. For LinuxBridge, this requires +# ebtables. For OVS, it requires a version that supports matching ARP headers. +# (boolean value) +#prevent_arp_spoofing = true + +# Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying +# GRE/VXLAN tunnel. (boolean value) +#dont_fragment = true + +# Make the l2 agent run in DVR mode. (boolean value) +#enable_distributed_routing = false + +# Set new timeout in seconds for new rpc calls after agent receives SIGTERM. If +# value is set to 0, rpc timeout won't be changed (integer value) +#quitting_rpc_timeout = 10 + +# Reset flow table on start. Setting this to True will cause brief traffic +# interruption. (boolean value) +#drop_flows_on_start = false + +# Set or un-set the tunnel header checksum on outgoing IP packet carrying +# GRE/VXLAN tunnel. (boolean value) +#tunnel_csum = false + +# Selects the Agent Type reported (string value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#agent_type = Open vSwitch agent + + +[ovs] + +# +# From neutron.ml2.ovs.agent +# + +# Integration bridge to use. Do not change this parameter unless you have a +# good reason to. This is the name of the OVS integration bridge. There is one +# per hypervisor. The integration bridge acts as a virtual 'patch bay'. All VM +# VIFs are attached to this bridge and then 'patched' according to their +# network connectivity. (string value) +#integration_bridge = br-int + +# Tunnel bridge to use. (string value) +#tunnel_bridge = br-tun + +# Peer patch port in integration bridge for tunnel bridge. (string value) +#int_peer_patch_port = patch-tun + +# Peer patch port in tunnel bridge for integration bridge. (string value) +#tun_peer_patch_port = patch-int + +# Local IP address of tunnel endpoint. (ip address value) +#local_ip = + +# Comma-separated list of : tuples mapping physical +# network names to the agent's node-specific Open vSwitch bridge names to be +# used for flat and VLAN networks. The length of bridge names should be no more +# than 11. Each bridge must exist, and should have a physical network interface +# configured as a port. All physical networks configured on the server should +# have mappings to appropriate bridges on each agent. Note: If you remove a +# bridge from this mapping, make sure to disconnect it from the integration +# bridge as it won't be managed by the agent anymore. Deprecated for ofagent. +# (list value) +#bridge_mappings = + +# Use veths instead of patch ports to interconnect the integration bridge to +# physical networks. Support kernel without Open vSwitch patch port support so +# long as it is set to True. (boolean value) +#use_veth_interconnection = false + +# OpenFlow interface to use. (string value) +# Allowed values: ovs-ofctl, native +#of_interface = ovs-ofctl + +# OVS datapath to use. 'system' is the default value and corresponds to the +# kernel datapath. To enable the userspace datapath set this value to 'netdev'. +# (string value) +# Allowed values: system, netdev +#datapath_type = system + +# OVS vhost-user socket directory. (string value) +#vhostuser_socket_dir = /var/run/openvswitch + +# Address to listen on for OpenFlow connections. Used only for 'native' driver. +# (ip address value) +#of_listen_address = 127.0.0.1 + +# Port to listen on for OpenFlow connections. Used only for 'native' driver. +# (port value) +# Minimum value: 1 +# Maximum value: 65535 +#of_listen_port = 6633 + +# Timeout in seconds to wait for the local switch connecting the controller. +# Used only for 'native' driver. (integer value) +#of_connect_timeout = 30 + +# Timeout in seconds to wait for a single OpenFlow request. Used only for +# 'native' driver. (integer value) +#of_request_timeout = 10 + +# The interface for interacting with the OVSDB (string value) +# Allowed values: native, vsctl +#ovsdb_interface = vsctl + +# The connection string for the native OVSDB backend. Requires the native +# ovsdb_interface to be enabled. (string value) +#ovsdb_connection = tcp:127.0.0.1:6640 + + +[securitygroup] + +# +# From neutron.ml2.ovs.agent +# + +# Driver for security groups firewall in the L2 agent (string value) +#firewall_driver = + +# Controls whether the neutron security group API is enabled in the server. It +# should be false when using no security groups or using the nova security +# group API. (boolean value) +#enable_security_group = true + +# Use ipset to speed-up the iptables based security groups. Enabling ipset +# support requires that ipset is installed on L2 agent node. (boolean value) +#enable_ipset = true diff --git a/doc/config-ref-rst/source/samples/neutron/sriov_agent.ini.sample b/doc/config-ref-rst/source/samples/neutron/sriov_agent.ini.sample new file mode 100644 index 0000000000..5193b1a3ad --- /dev/null +++ b/doc/config-ref-rst/source/samples/neutron/sriov_agent.ini.sample @@ -0,0 +1,140 @@ +[DEFAULT] + +# +# From oslo.log +# + +# Print debugging output (set logging level to DEBUG instead of default INFO +# level). (boolean value) +#debug = false + +# If set to false, will disable INFO logging level, making WARNING the default. +# (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#verbose = true + +# 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. Note that when logging +# configuration files are used then all logging configuration is set in the +# configuration file and other logging configuration options are ignored (for +# example, log_format). (string value) +# Deprecated group/name - [DEFAULT]/log_config +#log_config_append = + +# DEPRECATED. A logging.Formatter log message format string which may use any +# of the available logging.LogRecord attributes. This option is deprecated. +# Please use logging_context_format_string and logging_default_format_string +# instead. This option is ignored if log_config_append is set. (string value) +#log_format = + +# Format string for %%(asctime)s in log records. Default: %(default)s . This +# option is ignored if log_config_append is set. (string value) +#log_date_format = %Y-%m-%d %H:%M:%S + +# (Optional) Name of log file to output to. If no default is set, logging will +# go to stdout. This option is ignored if log_config_append is set. (string +# value) +# Deprecated group/name - [DEFAULT]/logfile +#log_file = + +# (Optional) The base directory used for relative --log-file paths. This option +# is ignored if log_config_append is set. (string value) +# Deprecated group/name - [DEFAULT]/logdir +#log_dir = + +# (Optional) Uses logging handler designed to watch file system. When log file +# is moved or removed this handler will open a new log file with specified path +# instantaneously. It makes sense only if log-file option is specified and +# Linux platform is used. This option is ignored if log_config_append is set. +# (boolean value) +#watch_log_file = false + +# Use syslog for logging. Existing syslog format is DEPRECATED and will be +# changed later to honor RFC5424. This option is ignored if log_config_append +# is set. (boolean value) +#use_syslog = false + +# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, +# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The +# format without the APP-NAME is deprecated in Kilo, and will be removed in +# Mitaka, along with this option. This option is ignored if log_config_append +# is set. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#use_syslog_rfc_format = true + +# Syslog facility to receive log lines. This option is ignored if +# log_config_append is set. (string value) +#syslog_log_facility = LOG_USER + +# Log output to standard error. This option is ignored if log_config_append is +# set. (boolean value) +#use_stderr = true + +# Format string to use for log messages with context. (string value) +#logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s + +# Format string to use for log messages without context. (string value) +#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s + +# Data to append to log format when level is DEBUG. (string value) +#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d + +# Prefix each line of exception output with this format. (string value) +#logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s + +# List of logger=LEVEL pairs. This option is ignored if log_config_append is +# set. (list value) +#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN + +# Enables or disables publication of error events. (boolean value) +#publish_errors = false + +# The format for an instance that is passed with the log message. (string +# value) +#instance_format = "[instance: %(uuid)s] " + +# The format for an instance UUID that is passed with the log message. (string +# value) +#instance_uuid_format = "[instance: %(uuid)s] " + +# Format string for user_identity field of the logging_context_format_string +# (string value) +#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s + +# Enables or disables fatal status of deprecations. (boolean value) +#fatal_deprecations = false + + +[agent] + +# +# From neutron.ml2.sriov.agent +# + +# Extensions list to use (list value) +#extensions = + + +[ml2_sriov] + +# +# From neutron.ml2.sriov.agent +# + +# Comma-separated list of : tuples mapping +# physical network names to the agent's node-specific physical network device +# interfaces of SR-IOV physical function to be used for VLAN networks. All +# physical networks listed in network_vlan_ranges on the server should have +# mappings to appropriate interfaces on each agent. (list value) +#physical_device_mappings = + +# Comma-separated list of : tuples, mapping +# network_device to the agent's node-specific list of virtual functions that +# should not be used for virtual networking. vfs_to_exclude is a semicolon- +# separated list of virtual functions to exclude from network_device. The +# network_device in the mapping should appear in the physical_device_mappings +# list. (list value) +#exclude_devices =