openstack/openstack-manuals
Code Issues Proposed changes

[config-ref] Update neutron sample configuration files

Browse Source 
Change-Id: Ibd64b290b20e1e36f6fe06a9600e669fa25b0e75
This commit is contained in:
venkatamahesh 2016-09-03 14:14:09 +05:30
parent 44e31bf4f6
commit c66b1b78dc
13 changed files with 1077 additions and 533 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/config-reference/source/networking/samples/index.rst
View File

@ -47,5 +47,6 @@ architecture components:
openvswitch_agent.ini.rst openvswitch_agent.ini.rst
dhcp_agent.ini.rst dhcp_agent.ini.rst
l3_agent.ini.rst l3_agent.ini.rst
macvtap_agent.ini.rst
metadata_agent.ini.rst metadata_agent.ini.rst
metering_agent.ini.rst metering_agent.ini.rst

10
doc/config-reference/source/networking/samples/macvtap_agent.ini.rst Normal file
View File

@ -0,0 +1,10 @@
==================
macvtap_agent.ini
==================
The ``macvtap_agent.ini`` file contains configuration for the macvtap
agent.
.. literalinclude:: ../../samples/neutron/macvtap_agent.ini.sample
:language: ini

90
doc/config-reference/source/samples/neutron/dhcp_agent.ini.sample
View File

@ -12,9 +12,6 @@
# value) # value)
#ovs_use_veth = false #ovs_use_veth = false
# MTU setting for device. (integer value)
#network_device_mtu = <None>
# The driver used to manage the virtual interface. (string value) # The driver used to manage the virtual interface. (string value)
#interface_driver = <None> #interface_driver = <None>
@ -62,45 +59,52 @@
# pool size configured on server. (integer value) # pool size configured on server. (integer value)
#num_sync_threads = 4 #num_sync_threads = 4
# Location to store DHCP server config files (string value) # Location to store DHCP server config files. (string value)
#dhcp_confs = $state_path/dhcp #dhcp_confs = $state_path/dhcp
# Domain to use for building the hostnames.This option is deprecated. It has # DEPRECATED: Domain to use for building the hostnames. This option is
# been moved to neutron.conf as dns_domain. It will removed from here in a # deprecated. It has been moved to neutron.conf as dns_domain. It will be
# future release (string value) # removed in a future release. (string value)
# This option is deprecated for removal. # This option is deprecated for removal.
# Its value may be silently ignored in the future. # Its value may be silently ignored in the future.
#dhcp_domain = openstacklocal #dhcp_domain = openstacklocal
# Override the default dnsmasq settings with this file (string value) # Override the default dnsmasq settings with this file. (string value)
#dnsmasq_config_file = #dnsmasq_config_file =
# Comma-separated list of the DNS servers which will be used as forwarders. # Comma-separated list of the DNS servers which will be used as forwarders.
# (list value) # (list value)
# Deprecated group/name - [DEFAULT]/dnsmasq_dns_server #dnsmasq_dns_servers =
#dnsmasq_dns_servers = <None>
# Base log dir for dnsmasq logging. The log contains DHCP and DNS log # 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 # information and is useful for debugging issues with either DHCP or DNS. If
# this section is null, disable dnsmasq log. (string value) # this section is null, disable dnsmasq log. (string value)
#dnsmasq_base_log_dir = <None> #dnsmasq_base_log_dir = <None>
# Enables the dnsmasq service to provide name resolution for instances via DNS
# resolvers on the host running the DHCP agent. Effectively removes the '--no-
# resolv' option from the dnsmasq process arguments. Adding custom DNS
# resolvers to the 'dnsmasq_dns_servers' option disables this feature. (boolean
# value)
#dnsmasq_local_resolv = false
# Limit number of leases to prevent a denial-of-service. (integer value) # Limit number of leases to prevent a denial-of-service. (integer value)
#dnsmasq_lease_max = 16777216 #dnsmasq_lease_max = 16777216
# Use broadcast in DHCP replies (boolean value) # Use broadcast in DHCP replies. (boolean value)
#dhcp_broadcast_reply = false #dhcp_broadcast_reply = false
# #
# From oslo.log # From oslo.log
# #
# Print debugging output (set logging level to DEBUG instead of default INFO # If set to true, the logging level will be set to DEBUG instead of the default
# level). (boolean value) # INFO level. (boolean value)
# Note: This option can be changed without restarting.
#debug = false #debug = false
# If set to false, will disable INFO logging level, making WARNING the default. # DEPRECATED: If set to false, the logging level will be set to WARNING instead
# (boolean value) # of the default INFO level. (boolean value)
# This option is deprecated for removal. # This option is deprecated for removal.
# Its value may be silently ignored in the future. # Its value may be silently ignored in the future.
#verbose = true #verbose = true
@ -109,29 +113,31 @@
# existing logging configuration files. For details about logging configuration # existing logging configuration files. For details about logging configuration
# files, see the Python logging module documentation. Note that when logging # files, see the Python logging module documentation. Note that when logging
# configuration files are used then all logging configuration is set in the # configuration files are used then all logging configuration is set in the
# configuration file and other logging configuration options are ignored. # configuration file and other logging configuration options are ignored (for
# (string value) # example, logging_context_format_string). (string value)
# Note: This option can be changed without restarting.
# Deprecated group/name - [DEFAULT]/log_config # Deprecated group/name - [DEFAULT]/log_config
#log_config_append = <None> #log_config_append = <None>
# Format string for %%(asctime)s in log records. Default: %(default)s . This # Defines the format string for %%(asctime)s in log records. Default:
# option is ignored if log_config_append is set. (string value) # %(default)s . This option is ignored if log_config_append is set. (string
# value)
#log_date_format = %Y-%m-%d %H:%M:%S #log_date_format = %Y-%m-%d %H:%M:%S
# (Optional) Name of log file to output to. If no default is set, logging will # (Optional) Name of log file to send logging output to. If no default is set,
# go to stdout. This option is ignored if log_config_append is set. (string # logging will go to stderr as defined by use_stderr. This option is ignored if
# value) # log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logfile # Deprecated group/name - [DEFAULT]/logfile
#log_file = <None> #log_file = <None>
# (Optional) The base directory used for relative --log-file paths. This option # (Optional) The base directory used for relative log_file paths. This option
# is ignored if log_config_append is set. (string value) # is ignored if log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logdir # Deprecated group/name - [DEFAULT]/logdir
#log_dir = <None> #log_dir = <None>
# (Optional) Uses logging handler designed to watch file system. When log file # Uses logging handler designed to watch file system. When log file is moved or
# is moved or removed this handler will open a new log file with specified path # removed this handler will open a new log file with specified path
# instantaneously. It makes sense only if log-file option is specified and # 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. # Linux platform is used. This option is ignored if log_config_append is set.
# (boolean value) # (boolean value)
#watch_log_file = false #watch_log_file = false
@ -141,15 +147,6 @@
# is set. (boolean value) # is set. (boolean value)
#use_syslog = false #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 # Syslog facility to receive log lines. This option is ignored if
# log_config_append is set. (string value) # log_config_append is set. (string value)
#syslog_log_facility = LOG_USER #syslog_log_facility = LOG_USER
@ -161,18 +158,24 @@
# Format string to use for log messages with context. (string value) # 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 #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) # Format string to use for log messages when context is undefined. (string
# value)
#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s #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) # Additional data to append to log message when logging level for the message
# is DEBUG. (string value)
#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d #logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d
# Prefix each line of exception output with this format. (string value) # 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 #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 # Defines the format string for %(user_identity)s that is used in
# set. (list value) # logging_context_format_string. (string 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 #logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s
# List of package logging levels in 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,keystoneauth=WARN,oslo.cache=INFO,dogpile.core.dogpile=INFO
# Enables or disables publication of error events. (boolean value) # Enables or disables publication of error events. (boolean value)
#publish_errors = false #publish_errors = false
@ -185,10 +188,6 @@
# value) # value)
#instance_uuid_format = "[instance: %(uuid)s] " #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) # Enables or disables fatal status of deprecations. (boolean value)
#fatal_deprecations = false #fatal_deprecations = false
@ -206,3 +205,6 @@
# Log agent heartbeats (boolean value) # Log agent heartbeats (boolean value)
#log_agent_heartbeats = false #log_agent_heartbeats = false
# Availability zone of this node (string value)
#availability_zone = nova

99
doc/config-reference/source/samples/neutron/l3_agent.ini.sample
View File

@ -12,9 +12,6 @@
# value) # value)
#ovs_use_veth = false #ovs_use_veth = false
# MTU setting for device. (integer value)
#network_device_mtu = <None>
# The driver used to manage the virtual interface. (string value) # The driver used to manage the virtual interface. (string value)
#interface_driver = <None> #interface_driver = <None>
@ -38,7 +35,7 @@
#agent_mode = legacy #agent_mode = legacy
# TCP Port used by Neutron metadata namespace proxy. (port value) # TCP Port used by Neutron metadata namespace proxy. (port value)
# Minimum value: 1 # Minimum value: 0
# Maximum value: 65535 # Maximum value: 65535
#metadata_port = 9697 #metadata_port = 9697
@ -90,15 +87,16 @@
# (string value) # (string value)
#external_ingress_mark = 0x2 #external_ingress_mark = 0x2
# Name of bridge used for external network traffic. This should be set to an # DEPRECATED: Name of bridge used for external network traffic. When this
# empty value for the Linux Bridge. When this parameter is set, each L3 agent # parameter is set, the L3 agent will plug an interface directly into an
# can be associated with no more than one external network. This option is # external bridge which will not allow any wiring by the L2 agent. Using this
# deprecated and will be removed in the M release. (string value) # will result in incorrect port statuses. This option is deprecated and will be
# removed in Ocata. (string value)
# This option is deprecated for removal. # This option is deprecated for removal.
# Its value may be silently ignored in the future. # Its value may be silently ignored in the future.
#external_network_bridge = br-ex #external_network_bridge =
# Seconds between running periodic tasks (integer value) # Seconds between running periodic tasks. (integer value)
#periodic_interval = 40 #periodic_interval = 40
# Number of separate API worker processes for service. If not specified, the # Number of separate API worker processes for service. If not specified, the
@ -106,10 +104,10 @@
# (integer value) # (integer value)
#api_workers = <None> #api_workers = <None>
# Number of RPC worker processes for service (integer value) # Number of RPC worker processes for service. (integer value)
#rpc_workers = 1 #rpc_workers = 1
# Number of RPC worker processes dedicated to state reports queue (integer # Number of RPC worker processes dedicated to state reports queue. (integer
# value) # value)
#rpc_state_report_workers = 1 #rpc_state_report_workers = 1
@ -130,16 +128,29 @@
# The advertisement interval in seconds (integer value) # The advertisement interval in seconds (integer value)
#ha_vrrp_advert_int = 2 #ha_vrrp_advert_int = 2
# Service to handle DHCPv6 Prefix delegation. (string value)
#pd_dhcp_driver = dibbler
# Location to store IPv6 RA config files (string value)
#ra_confs = $state_path/ra
# MinRtrAdvInterval setting for radvd.conf (integer value)
#min_rtr_adv_interval = 30
# MaxRtrAdvInterval setting for radvd.conf (integer value)
#max_rtr_adv_interval = 100
# #
# From oslo.log # From oslo.log
# #
# Print debugging output (set logging level to DEBUG instead of default INFO # If set to true, the logging level will be set to DEBUG instead of the default
# level). (boolean value) # INFO level. (boolean value)
# Note: This option can be changed without restarting.
#debug = false #debug = false
# If set to false, will disable INFO logging level, making WARNING the default. # DEPRECATED: If set to false, the logging level will be set to WARNING instead
# (boolean value) # of the default INFO level. (boolean value)
# This option is deprecated for removal. # This option is deprecated for removal.
# Its value may be silently ignored in the future. # Its value may be silently ignored in the future.
#verbose = true #verbose = true
@ -148,29 +159,31 @@
# existing logging configuration files. For details about logging configuration # existing logging configuration files. For details about logging configuration
# files, see the Python logging module documentation. Note that when logging # files, see the Python logging module documentation. Note that when logging
# configuration files are used then all logging configuration is set in the # configuration files are used then all logging configuration is set in the
# configuration file and other logging configuration options are ignored. # configuration file and other logging configuration options are ignored (for
# (string value) # example, logging_context_format_string). (string value)
# Note: This option can be changed without restarting.
# Deprecated group/name - [DEFAULT]/log_config # Deprecated group/name - [DEFAULT]/log_config
#log_config_append = <None> #log_config_append = <None>
# Format string for %%(asctime)s in log records. Default: %(default)s . This # Defines the format string for %%(asctime)s in log records. Default:
# option is ignored if log_config_append is set. (string value) # %(default)s . This option is ignored if log_config_append is set. (string
# value)
#log_date_format = %Y-%m-%d %H:%M:%S #log_date_format = %Y-%m-%d %H:%M:%S
# (Optional) Name of log file to output to. If no default is set, logging will # (Optional) Name of log file to send logging output to. If no default is set,
# go to stdout. This option is ignored if log_config_append is set. (string # logging will go to stderr as defined by use_stderr. This option is ignored if
# value) # log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logfile # Deprecated group/name - [DEFAULT]/logfile
#log_file = <None> #log_file = <None>
# (Optional) The base directory used for relative --log-file paths. This option # (Optional) The base directory used for relative log_file paths. This option
# is ignored if log_config_append is set. (string value) # is ignored if log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logdir # Deprecated group/name - [DEFAULT]/logdir
#log_dir = <None> #log_dir = <None>
# (Optional) Uses logging handler designed to watch file system. When log file # Uses logging handler designed to watch file system. When log file is moved or
# is moved or removed this handler will open a new log file with specified path # removed this handler will open a new log file with specified path
# instantaneously. It makes sense only if log-file option is specified and # 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. # Linux platform is used. This option is ignored if log_config_append is set.
# (boolean value) # (boolean value)
#watch_log_file = false #watch_log_file = false
@ -180,15 +193,6 @@
# is set. (boolean value) # is set. (boolean value)
#use_syslog = false #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 # Syslog facility to receive log lines. This option is ignored if
# log_config_append is set. (string value) # log_config_append is set. (string value)
#syslog_log_facility = LOG_USER #syslog_log_facility = LOG_USER
@ -200,18 +204,24 @@
# Format string to use for log messages with context. (string value) # 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 #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) # Format string to use for log messages when context is undefined. (string
# value)
#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s #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) # Additional data to append to log message when logging level for the message
# is DEBUG. (string value)
#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d #logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d
# Prefix each line of exception output with this format. (string value) # 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 #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 # Defines the format string for %(user_identity)s that is used in
# set. (list value) # logging_context_format_string. (string 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 #logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s
# List of package logging levels in 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,keystoneauth=WARN,oslo.cache=INFO,dogpile.core.dogpile=INFO
# Enables or disables publication of error events. (boolean value) # Enables or disables publication of error events. (boolean value)
#publish_errors = false #publish_errors = false
@ -224,10 +234,6 @@
# value) # value)
#instance_uuid_format = "[instance: %(uuid)s] " #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) # Enables or disables fatal status of deprecations. (boolean value)
#fatal_deprecations = false #fatal_deprecations = false
@ -245,3 +251,6 @@
# Log agent heartbeats (boolean value) # Log agent heartbeats (boolean value)
#log_agent_heartbeats = false #log_agent_heartbeats = false
# Availability zone of this node (string value)
#availability_zone = nova

96
doc/config-reference/source/samples/neutron/linuxbridge_agent.ini.sample
View File

@ -4,12 +4,13 @@
# From oslo.log # From oslo.log
# #
# Print debugging output (set logging level to DEBUG instead of default INFO # If set to true, the logging level will be set to DEBUG instead of the default
# level). (boolean value) # INFO level. (boolean value)
# Note: This option can be changed without restarting.
#debug = false #debug = false
# If set to false, will disable INFO logging level, making WARNING the default. # DEPRECATED: If set to false, the logging level will be set to WARNING instead
# (boolean value) # of the default INFO level. (boolean value)
# This option is deprecated for removal. # This option is deprecated for removal.
# Its value may be silently ignored in the future. # Its value may be silently ignored in the future.
#verbose = true #verbose = true
@ -18,29 +19,31 @@
# existing logging configuration files. For details about logging configuration # existing logging configuration files. For details about logging configuration
# files, see the Python logging module documentation. Note that when logging # files, see the Python logging module documentation. Note that when logging
# configuration files are used then all logging configuration is set in the # configuration files are used then all logging configuration is set in the
# configuration file and other logging configuration options are ignored. # configuration file and other logging configuration options are ignored (for
# (string value) # example, logging_context_format_string). (string value)
# Note: This option can be changed without restarting.
# Deprecated group/name - [DEFAULT]/log_config # Deprecated group/name - [DEFAULT]/log_config
#log_config_append = <None> #log_config_append = <None>
# Format string for %%(asctime)s in log records. Default: %(default)s . This # Defines the format string for %%(asctime)s in log records. Default:
# option is ignored if log_config_append is set. (string value) # %(default)s . This option is ignored if log_config_append is set. (string
# value)
#log_date_format = %Y-%m-%d %H:%M:%S #log_date_format = %Y-%m-%d %H:%M:%S
# (Optional) Name of log file to output to. If no default is set, logging will # (Optional) Name of log file to send logging output to. If no default is set,
# go to stdout. This option is ignored if log_config_append is set. (string # logging will go to stderr as defined by use_stderr. This option is ignored if
# value) # log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logfile # Deprecated group/name - [DEFAULT]/logfile
#log_file = <None> #log_file = <None>
# (Optional) The base directory used for relative --log-file paths. This option # (Optional) The base directory used for relative log_file paths. This option
# is ignored if log_config_append is set. (string value) # is ignored if log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logdir # Deprecated group/name - [DEFAULT]/logdir
#log_dir = <None> #log_dir = <None>
# (Optional) Uses logging handler designed to watch file system. When log file # Uses logging handler designed to watch file system. When log file is moved or
# is moved or removed this handler will open a new log file with specified path # removed this handler will open a new log file with specified path
# instantaneously. It makes sense only if log-file option is specified and # 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. # Linux platform is used. This option is ignored if log_config_append is set.
# (boolean value) # (boolean value)
#watch_log_file = false #watch_log_file = false
@ -50,15 +53,6 @@
# is set. (boolean value) # is set. (boolean value)
#use_syslog = false #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 # Syslog facility to receive log lines. This option is ignored if
# log_config_append is set. (string value) # log_config_append is set. (string value)
#syslog_log_facility = LOG_USER #syslog_log_facility = LOG_USER
@ -70,18 +64,24 @@
# Format string to use for log messages with context. (string value) # 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 #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) # Format string to use for log messages when context is undefined. (string
# value)
#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s #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) # Additional data to append to log message when logging level for the message
# is DEBUG. (string value)
#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d #logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d
# Prefix each line of exception output with this format. (string value) # 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 #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 # Defines the format string for %(user_identity)s that is used in
# set. (list value) # logging_context_format_string. (string 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 #logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s
# List of package logging levels in 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,keystoneauth=WARN,oslo.cache=INFO,dogpile.core.dogpile=INFO
# Enables or disables publication of error events. (boolean value) # Enables or disables publication of error events. (boolean value)
#publish_errors = false #publish_errors = false
@ -94,10 +94,6 @@
# value) # value)
#instance_uuid_format = "[instance: %(uuid)s] " #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) # Enables or disables fatal status of deprecations. (boolean value)
#fatal_deprecations = false #fatal_deprecations = false
@ -116,16 +112,22 @@
# value is set to 0, rpc timeout won't be changed (integer value) # value is set to 0, rpc timeout won't be changed (integer value)
#quitting_rpc_timeout = 10 #quitting_rpc_timeout = 10
# Enable suppression of ARP responses that don't match an IP address that # DEPRECATED: Enable suppression of ARP responses that don't match an IP
# belongs to the port from which they originate. Note: This prevents the VMs # address that belongs to the port from which they originate. Note: This
# attached to this agent from spoofing, it doesn't protect them from other # prevents the VMs attached to this agent from spoofing, it doesn't protect
# devices which have the capability to spoof (e.g. bare metal or VMs attached # them from other devices which have the capability to spoof (e.g. bare metal
# to agents without this flag set to True). Spoofing rules will not be added to # or VMs attached to agents without this flag set to True). Spoofing rules will
# any ports that have port security disabled. For LinuxBridge, this requires # not be added to any ports that have port security disabled. For LinuxBridge,
# ebtables. For OVS, it requires a version that supports matching ARP headers. # this requires ebtables. For OVS, it requires a version that supports matching
# (boolean value) # ARP headers. This option will be removed in Ocata so the only way to disable
# protection will be via the port security extension. (boolean value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
#prevent_arp_spoofing = true #prevent_arp_spoofing = true
# Extensions list to use (list value)
#extensions =
[linux_bridge] [linux_bridge]
@ -187,9 +189,19 @@
# all the agents. (string value) # all the agents. (string value)
#vxlan_group = 224.0.0.1 #vxlan_group = 224.0.0.1
# Local IP address of the VXLAN endpoints. (ip address value) # IP address of local overlay (tunnel) network endpoint. Use either an IPv4 or
# IPv6 address that resides on one of the host network interfaces. The IP
# version of this value must match the value of the 'overlay_ip_version' option
# in the ML2 plug-in configuration file on the neutron server node(s). (IP
# address value)
#local_ip = <None> #local_ip = <None>
# Extension to use alongside ml2 plugin's l2population mechanism driver. It # Extension to use alongside ml2 plugin's l2population mechanism driver. It
# enables the plugin to populate VXLAN forwarding table. (boolean value) # enables the plugin to populate VXLAN forwarding table. (boolean value)
#l2_population = false #l2_population = false
# Enable local ARP responder which provides local responses instead of
# performing ARP broadcast into the overlay. Enabling local ARP responder is
# not fully compatible with the allowed-address-pairs extension. (boolean
# value)
#arp_responder = false

159
doc/config-reference/source/samples/neutron/macvtap_agent.ini.sample Normal file
View File

@ -0,0 +1,159 @@
[DEFAULT]
#
# From oslo.log
#
# If set to true, the logging level will be set to DEBUG instead of the default
# INFO level. (boolean value)
# Note: This option can be changed without restarting.
#debug = false
# DEPRECATED: If set to false, the logging level will be set to WARNING instead
# of the default INFO level. (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, logging_context_format_string). (string value)
# Note: This option can be changed without restarting.
# Deprecated group/name - [DEFAULT]/log_config
#log_config_append = <None>
# Defines the 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 send logging output to. If no default is set,
# logging will go to stderr as defined by use_stderr. This option is ignored if
# log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logfile
#log_file = <None>
# (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 = <None>
# 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
# 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 when context is undefined. (string
# value)
#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s
# Additional data to append to log message when logging level for the message
# 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
# Defines the format string for %(user_identity)s that is used in
# logging_context_format_string. (string value)
#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s
# List of package logging levels in 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,keystoneauth=WARN,oslo.cache=INFO,dogpile.core.dogpile=INFO
# 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] "
# Enables or disables fatal status of deprecations. (boolean value)
#fatal_deprecations = false
[agent]
#
# From neutron.ml2.macvtap.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
# DEPRECATED: 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. This option will be removed in Ocata so the only way to disable
# protection will be via the port security extension. (boolean value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
#prevent_arp_spoofing = true
[macvtap]
#
# From neutron.ml2.macvtap.agent
#
# Comma-separated list of <physical_network>:<physical_interface> tuples
# mapping physical network names to the agent's node-specific physical network
# interfaces to be used for flat and VLAN networks. All physical networks
# listed in network_vlan_ranges on the server should have mappings to
# appropriate interfaces on each agent. (list value)
#physical_interface_mappings =
[securitygroup]
#
# From neutron.ml2.macvtap.agent
#
# Driver for security groups firewall in the L2 agent (string value)
#firewall_driver = <None>
# 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

144
doc/config-reference/source/samples/neutron/metadata_agent.ini.sample
View File

@ -22,7 +22,7 @@
#nova_metadata_ip = 127.0.0.1 #nova_metadata_ip = 127.0.0.1
# TCP Port used by Nova metadata server. (port value) # TCP Port used by Nova metadata server. (port value)
# Minimum value: 1 # Minimum value: 0
# Maximum value: 65535 # Maximum value: 65535
#nova_metadata_port = 8775 #nova_metadata_port = 8775
@ -58,25 +58,31 @@
# Number of separate worker processes for metadata server (defaults to half of # Number of separate worker processes for metadata server (defaults to half of
# the number of CPUs) (integer value) # the number of CPUs) (integer value)
#metadata_workers = 2 #metadata_workers = 1
# Number of backlog requests to configure the metadata server socket with # Number of backlog requests to configure the metadata server socket with
# (integer value) # (integer value)
#metadata_backlog = 4096 #metadata_backlog = 4096
# URL to connect to the cache back end. (string value) # DEPRECATED: URL to connect to the cache back end. This option is deprecated
#cache_url = memory:// # in the Newton release and will be removed. Please add a [cache] group for
# oslo.cache in your neutron.conf and add "enable" and "backend" options in
# this section. (string value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
#cache_url =
# #
# From oslo.log # From oslo.log
# #
# Print debugging output (set logging level to DEBUG instead of default INFO # If set to true, the logging level will be set to DEBUG instead of the default
# level). (boolean value) # INFO level. (boolean value)
# Note: This option can be changed without restarting.
#debug = false #debug = false
# If set to false, will disable INFO logging level, making WARNING the default. # DEPRECATED: If set to false, the logging level will be set to WARNING instead
# (boolean value) # of the default INFO level. (boolean value)
# This option is deprecated for removal. # This option is deprecated for removal.
# Its value may be silently ignored in the future. # Its value may be silently ignored in the future.
#verbose = true #verbose = true
@ -85,29 +91,31 @@
# existing logging configuration files. For details about logging configuration # existing logging configuration files. For details about logging configuration
# files, see the Python logging module documentation. Note that when logging # files, see the Python logging module documentation. Note that when logging
# configuration files are used then all logging configuration is set in the # configuration files are used then all logging configuration is set in the
# configuration file and other logging configuration options are ignored. # configuration file and other logging configuration options are ignored (for
# (string value) # example, logging_context_format_string). (string value)
# Note: This option can be changed without restarting.
# Deprecated group/name - [DEFAULT]/log_config # Deprecated group/name - [DEFAULT]/log_config
#log_config_append = <None> #log_config_append = <None>
# Format string for %%(asctime)s in log records. Default: %(default)s . This # Defines the format string for %%(asctime)s in log records. Default:
# option is ignored if log_config_append is set. (string value) # %(default)s . This option is ignored if log_config_append is set. (string
# value)
#log_date_format = %Y-%m-%d %H:%M:%S #log_date_format = %Y-%m-%d %H:%M:%S
# (Optional) Name of log file to output to. If no default is set, logging will # (Optional) Name of log file to send logging output to. If no default is set,
# go to stdout. This option is ignored if log_config_append is set. (string # logging will go to stderr as defined by use_stderr. This option is ignored if
# value) # log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logfile # Deprecated group/name - [DEFAULT]/logfile
#log_file = <None> #log_file = <None>
# (Optional) The base directory used for relative --log-file paths. This option # (Optional) The base directory used for relative log_file paths. This option
# is ignored if log_config_append is set. (string value) # is ignored if log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logdir # Deprecated group/name - [DEFAULT]/logdir
#log_dir = <None> #log_dir = <None>
# (Optional) Uses logging handler designed to watch file system. When log file # Uses logging handler designed to watch file system. When log file is moved or
# is moved or removed this handler will open a new log file with specified path # removed this handler will open a new log file with specified path
# instantaneously. It makes sense only if log-file option is specified and # 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. # Linux platform is used. This option is ignored if log_config_append is set.
# (boolean value) # (boolean value)
#watch_log_file = false #watch_log_file = false
@ -117,15 +125,6 @@
# is set. (boolean value) # is set. (boolean value)
#use_syslog = false #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 # Syslog facility to receive log lines. This option is ignored if
# log_config_append is set. (string value) # log_config_append is set. (string value)
#syslog_log_facility = LOG_USER #syslog_log_facility = LOG_USER
@ -137,18 +136,24 @@
# Format string to use for log messages with context. (string value) # 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 #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) # Format string to use for log messages when context is undefined. (string
# value)
#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s #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) # Additional data to append to log message when logging level for the message
# is DEBUG. (string value)
#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d #logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d
# Prefix each line of exception output with this format. (string value) # 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 #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 # Defines the format string for %(user_identity)s that is used in
# set. (list value) # logging_context_format_string. (string 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 #logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s
# List of package logging levels in 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,keystoneauth=WARN,oslo.cache=INFO,dogpile.core.dogpile=INFO
# Enables or disables publication of error events. (boolean value) # Enables or disables publication of error events. (boolean value)
#publish_errors = false #publish_errors = false
@ -161,10 +166,6 @@
# value) # value)
#instance_uuid_format = "[instance: %(uuid)s] " #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) # Enables or disables fatal status of deprecations. (boolean value)
#fatal_deprecations = false #fatal_deprecations = false
@ -182,3 +183,72 @@
# Log agent heartbeats (boolean value) # Log agent heartbeats (boolean value)
#log_agent_heartbeats = false #log_agent_heartbeats = false
[cache]
#
# From oslo.cache
#
# Prefix for building the configuration dictionary for the cache region. This
# should not need to be changed unless there is another dogpile.cache region
# with the same configuration name. (string value)
#config_prefix = cache.oslo
# Default TTL, in seconds, for any cached item in the dogpile.cache region.
# This applies to any cached method that doesn't have an explicit cache
# expiration time defined for it. (integer value)
#expiration_time = 600
# Dogpile.cache backend module. It is recommended that Memcache or Redis
# (dogpile.cache.redis) be used in production deployments. For eventlet-based
# or highly threaded servers, Memcache with pooling (oslo_cache.memcache_pool)
# is recommended. For low thread servers, dogpile.cache.memcached is
# recommended. Test environments with a single instance of the server can use
# the dogpile.cache.memory backend. (string value)
#backend = dogpile.cache.null
# Arguments supplied to the backend module. Specify this option once per
# argument to be passed to the dogpile.cache backend. Example format:
# "<argname>:<value>". (multi valued)
#backend_argument =
# Proxy classes to import that will affect the way the dogpile.cache backend
# functions. See the dogpile.cache documentation on changing-backend-behavior.
# (list value)
#proxies =
# Global toggle for caching. (boolean value)
#enabled = false
# Extra debugging from the cache backend (cache keys, get/set/delete/etc
# calls). This is only really useful if you need to see the specific cache-
# backend get/set/delete calls with the keys/values. Typically this should be
# left set to false. (boolean value)
#debug_cache_backend = false
# Memcache servers in the format of "host:port". (dogpile.cache.memcache and
# oslo_cache.memcache_pool backends only). (list value)
#memcache_servers = localhost:11211
# Number of seconds memcached server is considered dead before it is tried
# again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).
# (integer value)
#memcache_dead_retry = 300
# Timeout in seconds for every call to a server. (dogpile.cache.memcache and
# oslo_cache.memcache_pool backends only). (integer value)
#memcache_socket_timeout = 3
# Max total number of open connections to every memcached server.
# (oslo_cache.memcache_pool backend only). (integer value)
#memcache_pool_maxsize = 10
# Number of seconds a connection to memcached is held unused in the pool before
# it is closed. (oslo_cache.memcache_pool backend only). (integer value)
#memcache_pool_unused_timeout = 60
# Number of seconds that an operation will wait to get a memcache client
# connection. (integer value)
#memcache_pool_connection_get_timeout = 10

62
doc/config-reference/source/samples/neutron/metering_agent.ini.sample
View File

@ -20,12 +20,13 @@
# From oslo.log # From oslo.log
# #
# Print debugging output (set logging level to DEBUG instead of default INFO # If set to true, the logging level will be set to DEBUG instead of the default
# level). (boolean value) # INFO level. (boolean value)
# Note: This option can be changed without restarting.
#debug = false #debug = false
# If set to false, will disable INFO logging level, making WARNING the default. # DEPRECATED: If set to false, the logging level will be set to WARNING instead
# (boolean value) # of the default INFO level. (boolean value)
# This option is deprecated for removal. # This option is deprecated for removal.
# Its value may be silently ignored in the future. # Its value may be silently ignored in the future.
#verbose = true #verbose = true
@ -34,29 +35,31 @@
# existing logging configuration files. For details about logging configuration # existing logging configuration files. For details about logging configuration
# files, see the Python logging module documentation. Note that when logging # files, see the Python logging module documentation. Note that when logging
# configuration files are used then all logging configuration is set in the # configuration files are used then all logging configuration is set in the
# configuration file and other logging configuration options are ignored. # configuration file and other logging configuration options are ignored (for
# (string value) # example, logging_context_format_string). (string value)
# Note: This option can be changed without restarting.
# Deprecated group/name - [DEFAULT]/log_config # Deprecated group/name - [DEFAULT]/log_config
#log_config_append = <None> #log_config_append = <None>
# Format string for %%(asctime)s in log records. Default: %(default)s . This # Defines the format string for %%(asctime)s in log records. Default:
# option is ignored if log_config_append is set. (string value) # %(default)s . This option is ignored if log_config_append is set. (string
# value)
#log_date_format = %Y-%m-%d %H:%M:%S #log_date_format = %Y-%m-%d %H:%M:%S
# (Optional) Name of log file to output to. If no default is set, logging will # (Optional) Name of log file to send logging output to. If no default is set,
# go to stdout. This option is ignored if log_config_append is set. (string # logging will go to stderr as defined by use_stderr. This option is ignored if
# value) # log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logfile # Deprecated group/name - [DEFAULT]/logfile
#log_file = <None> #log_file = <None>
# (Optional) The base directory used for relative --log-file paths. This option # (Optional) The base directory used for relative log_file paths. This option
# is ignored if log_config_append is set. (string value) # is ignored if log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logdir # Deprecated group/name - [DEFAULT]/logdir
#log_dir = <None> #log_dir = <None>
# (Optional) Uses logging handler designed to watch file system. When log file # Uses logging handler designed to watch file system. When log file is moved or
# is moved or removed this handler will open a new log file with specified path # removed this handler will open a new log file with specified path
# instantaneously. It makes sense only if log-file option is specified and # 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. # Linux platform is used. This option is ignored if log_config_append is set.
# (boolean value) # (boolean value)
#watch_log_file = false #watch_log_file = false
@ -66,15 +69,6 @@
# is set. (boolean value) # is set. (boolean value)
#use_syslog = false #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 # Syslog facility to receive log lines. This option is ignored if
# log_config_append is set. (string value) # log_config_append is set. (string value)
#syslog_log_facility = LOG_USER #syslog_log_facility = LOG_USER
@ -86,18 +80,24 @@
# Format string to use for log messages with context. (string value) # 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 #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) # Format string to use for log messages when context is undefined. (string
# value)
#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s #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) # Additional data to append to log message when logging level for the message
# is DEBUG. (string value)
#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d #logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d
# Prefix each line of exception output with this format. (string value) # 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 #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 # Defines the format string for %(user_identity)s that is used in
# set. (list value) # logging_context_format_string. (string 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 #logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s
# List of package logging levels in 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,keystoneauth=WARN,oslo.cache=INFO,dogpile.core.dogpile=INFO
# Enables or disables publication of error events. (boolean value) # Enables or disables publication of error events. (boolean value)
#publish_errors = false #publish_errors = false
@ -110,9 +110,5 @@
# value) # value)
#instance_uuid_format = "[instance: %(uuid)s] " #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) # Enables or disables fatal status of deprecations. (boolean value)
#fatal_deprecations = false #fatal_deprecations = false

86
doc/config-reference/source/samples/neutron/ml2_conf.ini.sample
View File

@ -4,12 +4,13 @@
# From oslo.log # From oslo.log
# #
# Print debugging output (set logging level to DEBUG instead of default INFO # If set to true, the logging level will be set to DEBUG instead of the default
# level). (boolean value) # INFO level. (boolean value)
# Note: This option can be changed without restarting.
#debug = false #debug = false
# If set to false, will disable INFO logging level, making WARNING the default. # DEPRECATED: If set to false, the logging level will be set to WARNING instead
# (boolean value) # of the default INFO level. (boolean value)
# This option is deprecated for removal. # This option is deprecated for removal.
# Its value may be silently ignored in the future. # Its value may be silently ignored in the future.
#verbose = true #verbose = true
@ -18,29 +19,31 @@
# existing logging configuration files. For details about logging configuration # existing logging configuration files. For details about logging configuration
# files, see the Python logging module documentation. Note that when logging # files, see the Python logging module documentation. Note that when logging
# configuration files are used then all logging configuration is set in the # configuration files are used then all logging configuration is set in the
# configuration file and other logging configuration options are ignored. # configuration file and other logging configuration options are ignored (for
# (string value) # example, logging_context_format_string). (string value)
# Note: This option can be changed without restarting.
# Deprecated group/name - [DEFAULT]/log_config # Deprecated group/name - [DEFAULT]/log_config
#log_config_append = <None> #log_config_append = <None>
# Format string for %%(asctime)s in log records. Default: %(default)s . This # Defines the format string for %%(asctime)s in log records. Default:
# option is ignored if log_config_append is set. (string value) # %(default)s . This option is ignored if log_config_append is set. (string
# value)
#log_date_format = %Y-%m-%d %H:%M:%S #log_date_format = %Y-%m-%d %H:%M:%S
# (Optional) Name of log file to output to. If no default is set, logging will # (Optional) Name of log file to send logging output to. If no default is set,
# go to stdout. This option is ignored if log_config_append is set. (string # logging will go to stderr as defined by use_stderr. This option is ignored if
# value) # log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logfile # Deprecated group/name - [DEFAULT]/logfile
#log_file = <None> #log_file = <None>
# (Optional) The base directory used for relative --log-file paths. This option # (Optional) The base directory used for relative log_file paths. This option
# is ignored if log_config_append is set. (string value) # is ignored if log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logdir # Deprecated group/name - [DEFAULT]/logdir
#log_dir = <None> #log_dir = <None>
# (Optional) Uses logging handler designed to watch file system. When log file # Uses logging handler designed to watch file system. When log file is moved or
# is moved or removed this handler will open a new log file with specified path # removed this handler will open a new log file with specified path
# instantaneously. It makes sense only if log-file option is specified and # 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. # Linux platform is used. This option is ignored if log_config_append is set.
# (boolean value) # (boolean value)
#watch_log_file = false #watch_log_file = false
@ -50,15 +53,6 @@
# is set. (boolean value) # is set. (boolean value)
#use_syslog = false #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 # Syslog facility to receive log lines. This option is ignored if
# log_config_append is set. (string value) # log_config_append is set. (string value)
#syslog_log_facility = LOG_USER #syslog_log_facility = LOG_USER
@ -70,18 +64,24 @@
# Format string to use for log messages with context. (string value) # 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 #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) # Format string to use for log messages when context is undefined. (string
# value)
#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s #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) # Additional data to append to log message when logging level for the message
# is DEBUG. (string value)
#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d #logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d
# Prefix each line of exception output with this format. (string value) # 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 #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 # Defines the format string for %(user_identity)s that is used in
# set. (list value) # logging_context_format_string. (string 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 #logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s
# List of package logging levels in 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,keystoneauth=WARN,oslo.cache=INFO,dogpile.core.dogpile=INFO
# Enables or disables publication of error events. (boolean value) # Enables or disables publication of error events. (boolean value)
#publish_errors = false #publish_errors = false
@ -94,10 +94,6 @@
# value) # value)
#instance_uuid_format = "[instance: %(uuid)s] " #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) # Enables or disables fatal status of deprecations. (boolean value)
#fatal_deprecations = false #fatal_deprecations = false
@ -126,22 +122,16 @@
# port_security,qos (list value) # port_security,qos (list value)
#extension_drivers = #extension_drivers =
# The maximum permissible size of an unfragmented packet travelling from and to # Maximum size of an IP packet (MTU) that can traverse the underlying physical
# addresses where encapsulated Neutron traffic is sent. Drivers calculate # network infrastructure without fragmentation when using an overlay/tunnel
# maximum viable MTU for validating tenant requests based on this value # protocol. This option allows specifying a physical network MTU value that
# (typically, path_mtu - maxmum encapsulation header size). If <= 0, the path # differs from the default global_physnet_mtu value. (integer value)
# MTU is indeterminate and no calculation takes place. (integer value)
#path_mtu = 0 #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 # A list of mappings of physical networks to MTU values. The format of the
# mapping is <physnet>:<mtu val>. This mapping allows specifying a physical # mapping is <physnet>:<mtu val>. This mapping allows specifying a physical
# network MTU value that differs from the default segment_mtu value. (list # network MTU value that differs from the default global_physnet_mtu value.
# value) # (list value)
#physical_network_mtus = #physical_network_mtus =
# Default network type for external networks when no provider attributes are # Default network type for external networks when no provider attributes are
@ -152,6 +142,10 @@
# option. (string value) # option. (string value)
#external_network_type = <None> #external_network_type = <None>
# IP version of all overlay (tunnel) network endpoints. Use a value of 4 for
# IPv4 or 6 for IPv6. (integer value)
#overlay_ip_version = 4
[ml2_type_flat] [ml2_type_flat]
@ -180,7 +174,7 @@
# + IP + UDP + GENEVE header sizes. The default size for this field is 50, # + 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. # which is the size of the Geneve header without any additional option headers.
# (integer value) # (integer value)
#max_header_size = 50 #max_header_size = 30
[ml2_type_gre] [ml2_type_gre]

74
doc/config-reference/source/samples/neutron/ml2_conf_sriov.ini.sample
View File

@ -4,12 +4,13 @@
# From oslo.log # From oslo.log
# #
# Print debugging output (set logging level to DEBUG instead of default INFO # If set to true, the logging level will be set to DEBUG instead of the default
# level). (boolean value) # INFO level. (boolean value)
# Note: This option can be changed without restarting.
#debug = false #debug = false
# If set to false, will disable INFO logging level, making WARNING the default. # DEPRECATED: If set to false, the logging level will be set to WARNING instead
# (boolean value) # of the default INFO level. (boolean value)
# This option is deprecated for removal. # This option is deprecated for removal.
# Its value may be silently ignored in the future. # Its value may be silently ignored in the future.
#verbose = true #verbose = true
@ -18,29 +19,31 @@
# existing logging configuration files. For details about logging configuration # existing logging configuration files. For details about logging configuration
# files, see the Python logging module documentation. Note that when logging # files, see the Python logging module documentation. Note that when logging
# configuration files are used then all logging configuration is set in the # configuration files are used then all logging configuration is set in the
# configuration file and other logging configuration options are ignored. # configuration file and other logging configuration options are ignored (for
# (string value) # example, logging_context_format_string). (string value)
# Note: This option can be changed without restarting.
# Deprecated group/name - [DEFAULT]/log_config # Deprecated group/name - [DEFAULT]/log_config
#log_config_append = <None> #log_config_append = <None>
# Format string for %%(asctime)s in log records. Default: %(default)s . This # Defines the format string for %%(asctime)s in log records. Default:
# option is ignored if log_config_append is set. (string value) # %(default)s . This option is ignored if log_config_append is set. (string
# value)
#log_date_format = %Y-%m-%d %H:%M:%S #log_date_format = %Y-%m-%d %H:%M:%S
# (Optional) Name of log file to output to. If no default is set, logging will # (Optional) Name of log file to send logging output to. If no default is set,
# go to stdout. This option is ignored if log_config_append is set. (string # logging will go to stderr as defined by use_stderr. This option is ignored if
# value) # log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logfile # Deprecated group/name - [DEFAULT]/logfile
#log_file = <None> #log_file = <None>
# (Optional) The base directory used for relative --log-file paths. This option # (Optional) The base directory used for relative log_file paths. This option
# is ignored if log_config_append is set. (string value) # is ignored if log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logdir # Deprecated group/name - [DEFAULT]/logdir
#log_dir = <None> #log_dir = <None>
# (Optional) Uses logging handler designed to watch file system. When log file # Uses logging handler designed to watch file system. When log file is moved or
# is moved or removed this handler will open a new log file with specified path # removed this handler will open a new log file with specified path
# instantaneously. It makes sense only if log-file option is specified and # 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. # Linux platform is used. This option is ignored if log_config_append is set.
# (boolean value) # (boolean value)
#watch_log_file = false #watch_log_file = false
@ -50,15 +53,6 @@
# is set. (boolean value) # is set. (boolean value)
#use_syslog = false #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 # Syslog facility to receive log lines. This option is ignored if
# log_config_append is set. (string value) # log_config_append is set. (string value)
#syslog_log_facility = LOG_USER #syslog_log_facility = LOG_USER
@ -70,18 +64,24 @@
# Format string to use for log messages with context. (string value) # 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 #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) # Format string to use for log messages when context is undefined. (string
# value)
#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s #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) # Additional data to append to log message when logging level for the message
# is DEBUG. (string value)
#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d #logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d
# Prefix each line of exception output with this format. (string value) # 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 #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 # Defines the format string for %(user_identity)s that is used in
# set. (list value) # logging_context_format_string. (string 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 #logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s
# List of package logging levels in 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,keystoneauth=WARN,oslo.cache=INFO,dogpile.core.dogpile=INFO
# Enables or disables publication of error events. (boolean value) # Enables or disables publication of error events. (boolean value)
#publish_errors = false #publish_errors = false
@ -94,10 +94,6 @@
# value) # value)
#instance_uuid_format = "[instance: %(uuid)s] " #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) # Enables or disables fatal status of deprecations. (boolean value)
#fatal_deprecations = false #fatal_deprecations = false
@ -108,7 +104,11 @@
# From neutron.ml2.sriov # From neutron.ml2.sriov
# #
# Comma-separated list of supported PCI vendor devices, as defined by # DEPRECATED: Comma-separated list of supported PCI vendor devices, as defined
# vendor_id:product_id according to the PCI ID Repository. Default enables # by vendor_id:product_id according to the PCI ID Repository. Default None
# support for Intel and Mellanox SR-IOV capable NICs. (list value) # accept all PCI vendor devicesDEPRECATED: This option is deprecated in the
#supported_pci_vendor_devs = 15b3:1004,8086:10ca # Newton release and will be removed in the Ocata release. Starting from Ocata
# the mechanism driver will accept all PCI vendor devices. (list value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
#supported_pci_vendor_devs = <None>

618
doc/config-reference/source/samples/neutron/neutron.conf.sample
View File

File diff suppressed because it is too large Load Diff

107
doc/config-reference/source/samples/neutron/openvswitch_agent.ini.sample
View File

@ -4,12 +4,13 @@
# From oslo.log # From oslo.log
# #
# Print debugging output (set logging level to DEBUG instead of default INFO # If set to true, the logging level will be set to DEBUG instead of the default
# level). (boolean value) # INFO level. (boolean value)
# Note: This option can be changed without restarting.
#debug = false #debug = false
# If set to false, will disable INFO logging level, making WARNING the default. # DEPRECATED: If set to false, the logging level will be set to WARNING instead
# (boolean value) # of the default INFO level. (boolean value)
# This option is deprecated for removal. # This option is deprecated for removal.
# Its value may be silently ignored in the future. # Its value may be silently ignored in the future.
#verbose = true #verbose = true
@ -18,29 +19,31 @@
# existing logging configuration files. For details about logging configuration # existing logging configuration files. For details about logging configuration
# files, see the Python logging module documentation. Note that when logging # files, see the Python logging module documentation. Note that when logging
# configuration files are used then all logging configuration is set in the # configuration files are used then all logging configuration is set in the
# configuration file and other logging configuration options are ignored. # configuration file and other logging configuration options are ignored (for
# (string value) # example, logging_context_format_string). (string value)
# Note: This option can be changed without restarting.
# Deprecated group/name - [DEFAULT]/log_config # Deprecated group/name - [DEFAULT]/log_config
#log_config_append = <None> #log_config_append = <None>
# Format string for %%(asctime)s in log records. Default: %(default)s . This # Defines the format string for %%(asctime)s in log records. Default:
# option is ignored if log_config_append is set. (string value) # %(default)s . This option is ignored if log_config_append is set. (string
# value)
#log_date_format = %Y-%m-%d %H:%M:%S #log_date_format = %Y-%m-%d %H:%M:%S
# (Optional) Name of log file to output to. If no default is set, logging will # (Optional) Name of log file to send logging output to. If no default is set,
# go to stdout. This option is ignored if log_config_append is set. (string # logging will go to stderr as defined by use_stderr. This option is ignored if
# value) # log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logfile # Deprecated group/name - [DEFAULT]/logfile
#log_file = <None> #log_file = <None>
# (Optional) The base directory used for relative --log-file paths. This option # (Optional) The base directory used for relative log_file paths. This option
# is ignored if log_config_append is set. (string value) # is ignored if log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logdir # Deprecated group/name - [DEFAULT]/logdir
#log_dir = <None> #log_dir = <None>
# (Optional) Uses logging handler designed to watch file system. When log file # Uses logging handler designed to watch file system. When log file is moved or
# is moved or removed this handler will open a new log file with specified path # removed this handler will open a new log file with specified path
# instantaneously. It makes sense only if log-file option is specified and # 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. # Linux platform is used. This option is ignored if log_config_append is set.
# (boolean value) # (boolean value)
#watch_log_file = false #watch_log_file = false
@ -50,15 +53,6 @@
# is set. (boolean value) # is set. (boolean value)
#use_syslog = false #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 # Syslog facility to receive log lines. This option is ignored if
# log_config_append is set. (string value) # log_config_append is set. (string value)
#syslog_log_facility = LOG_USER #syslog_log_facility = LOG_USER
@ -70,18 +64,24 @@
# Format string to use for log messages with context. (string value) # 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 #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) # Format string to use for log messages when context is undefined. (string
# value)
#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s #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) # Additional data to append to log message when logging level for the message
# is DEBUG. (string value)
#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d #logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d
# Prefix each line of exception output with this format. (string value) # 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 #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 # Defines the format string for %(user_identity)s that is used in
# set. (list value) # logging_context_format_string. (string 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 #logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s
# List of package logging levels in 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,keystoneauth=WARN,oslo.cache=INFO,dogpile.core.dogpile=INFO
# Enables or disables publication of error events. (boolean value) # Enables or disables publication of error events. (boolean value)
#publish_errors = false #publish_errors = false
@ -94,10 +94,6 @@
# value) # value)
#instance_uuid_format = "[instance: %(uuid)s] " #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) # Enables or disables fatal status of deprecations. (boolean value)
#fatal_deprecations = false #fatal_deprecations = false
@ -123,12 +119,12 @@
#tunnel_types = #tunnel_types =
# The UDP port to use for VXLAN tunnels. (port value) # The UDP port to use for VXLAN tunnels. (port value)
# Minimum value: 1 # Minimum value: 0
# Maximum value: 65535 # Maximum value: 65535
#vxlan_udp_port = 4789 #vxlan_udp_port = 4789
# MTU size of veth interfaces (integer value) # MTU size of veth interfaces (integer value)
#veth_mtu = <None> #veth_mtu = 9000
# Use ML2 l2population mechanism driver to learn remote MAC and IPs and improve # Use ML2 l2population mechanism driver to learn remote MAC and IPs and improve
# tunnel scalability. (boolean value) # tunnel scalability. (boolean value)
@ -140,14 +136,17 @@
# into the overlay. (boolean value) # into the overlay. (boolean value)
#arp_responder = false #arp_responder = false
# Enable suppression of ARP responses that don't match an IP address that # DEPRECATED: Enable suppression of ARP responses that don't match an IP
# belongs to the port from which they originate. Note: This prevents the VMs # address that belongs to the port from which they originate. Note: This
# attached to this agent from spoofing, it doesn't protect them from other # prevents the VMs attached to this agent from spoofing, it doesn't protect
# devices which have the capability to spoof (e.g. bare metal or VMs attached # them from other devices which have the capability to spoof (e.g. bare metal
# to agents without this flag set to True). Spoofing rules will not be added to # or VMs attached to agents without this flag set to True). Spoofing rules will
# any ports that have port security disabled. For LinuxBridge, this requires # not be added to any ports that have port security disabled. For LinuxBridge,
# ebtables. For OVS, it requires a version that supports matching ARP headers. # this requires ebtables. For OVS, it requires a version that supports matching
# (boolean value) # ARP headers. This option will be removed in Ocata so the only way to disable
# protection will be via the port security extension. (boolean value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
#prevent_arp_spoofing = true #prevent_arp_spoofing = true
# Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying # Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying
@ -169,11 +168,14 @@
# GRE/VXLAN tunnel. (boolean value) # GRE/VXLAN tunnel. (boolean value)
#tunnel_csum = false #tunnel_csum = false
# Selects the Agent Type reported (string value) # DEPRECATED: Selects the Agent Type reported (string value)
# This option is deprecated for removal. # This option is deprecated for removal.
# Its value may be silently ignored in the future. # Its value may be silently ignored in the future.
#agent_type = Open vSwitch agent #agent_type = Open vSwitch agent
# Extensions list to use (list value)
#extensions =
[ovs] [ovs]
@ -197,7 +199,11 @@
# Peer patch port in tunnel bridge for integration bridge. (string value) # Peer patch port in tunnel bridge for integration bridge. (string value)
#tun_peer_patch_port = patch-int #tun_peer_patch_port = patch-int
# Local IP address of tunnel endpoint. (ip address value) # IP address of local overlay (tunnel) network endpoint. Use either an IPv4 or
# IPv6 address that resides on one of the host network interfaces. The IP
# version of this value must match the value of the 'overlay_ip_version' option
# in the ML2 plug-in configuration file on the neutron server node(s). (IP
# address value)
#local_ip = <None> #local_ip = <None>
# Comma-separated list of <physical_network>:<bridge> tuples mapping physical # Comma-separated list of <physical_network>:<bridge> tuples mapping physical
@ -207,8 +213,7 @@
# configured as a port. All physical networks configured on the server should # 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 # 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 from this mapping, make sure to disconnect it from the integration
# bridge as it won't be managed by the agent anymore. # bridge as it won't be managed by the agent anymore. (list value)
# (list value)
#bridge_mappings = #bridge_mappings =
# Use veths instead of patch ports to interconnect the integration bridge to # Use veths instead of patch ports to interconnect the integration bridge to
@ -218,7 +223,7 @@
# OpenFlow interface to use. (string value) # OpenFlow interface to use. (string value)
# Allowed values: ovs-ofctl, native # Allowed values: ovs-ofctl, native
#of_interface = ovs-ofctl #of_interface = native
# OVS datapath to use. 'system' is the default value and corresponds to the # 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'. # kernel datapath. To enable the userspace datapath set this value to 'netdev'.
@ -230,12 +235,12 @@
#vhostuser_socket_dir = /var/run/openvswitch #vhostuser_socket_dir = /var/run/openvswitch
# Address to listen on for OpenFlow connections. Used only for 'native' driver. # Address to listen on for OpenFlow connections. Used only for 'native' driver.
# (ip address value) # (IP address value)
#of_listen_address = 127.0.0.1 #of_listen_address = 127.0.0.1
# Port to listen on for OpenFlow connections. Used only for 'native' driver. # Port to listen on for OpenFlow connections. Used only for 'native' driver.
# (port value) # (port value)
# Minimum value: 1 # Minimum value: 0
# Maximum value: 65535 # Maximum value: 65535
#of_listen_port = 6633 #of_listen_port = 6633
@ -249,7 +254,7 @@
# The interface for interacting with the OVSDB (string value) # The interface for interacting with the OVSDB (string value)
# Allowed values: native, vsctl # Allowed values: native, vsctl
#ovsdb_interface = vsctl #ovsdb_interface = native
# The connection string for the native OVSDB backend. Requires the native # The connection string for the native OVSDB backend. Requires the native
# ovsdb_interface to be enabled. (string value) # ovsdb_interface to be enabled. (string value)

64
doc/config-reference/source/samples/neutron/sriov_agent.ini.sample
View File

@ -4,12 +4,13 @@
# From oslo.log # From oslo.log
# #
# Print debugging output (set logging level to DEBUG instead of default INFO # If set to true, the logging level will be set to DEBUG instead of the default
# level). (boolean value) # INFO level. (boolean value)
# Note: This option can be changed without restarting.
#debug = false #debug = false
# If set to false, will disable INFO logging level, making WARNING the default. # DEPRECATED: If set to false, the logging level will be set to WARNING instead
# (boolean value) # of the default INFO level. (boolean value)
# This option is deprecated for removal. # This option is deprecated for removal.
# Its value may be silently ignored in the future. # Its value may be silently ignored in the future.
#verbose = true #verbose = true
@ -18,29 +19,31 @@
# existing logging configuration files. For details about logging configuration # existing logging configuration files. For details about logging configuration
# files, see the Python logging module documentation. Note that when logging # files, see the Python logging module documentation. Note that when logging
# configuration files are used then all logging configuration is set in the # configuration files are used then all logging configuration is set in the
# configuration file and other logging configuration options are ignored. # configuration file and other logging configuration options are ignored (for
# (string value) # example, logging_context_format_string). (string value)
# Note: This option can be changed without restarting.
# Deprecated group/name - [DEFAULT]/log_config # Deprecated group/name - [DEFAULT]/log_config
#log_config_append = <None> #log_config_append = <None>
# Format string for %%(asctime)s in log records. Default: %(default)s . This # Defines the format string for %%(asctime)s in log records. Default:
# option is ignored if log_config_append is set. (string value) # %(default)s . This option is ignored if log_config_append is set. (string
# value)
#log_date_format = %Y-%m-%d %H:%M:%S #log_date_format = %Y-%m-%d %H:%M:%S
# (Optional) Name of log file to output to. If no default is set, logging will # (Optional) Name of log file to send logging output to. If no default is set,
# go to stdout. This option is ignored if log_config_append is set. (string # logging will go to stderr as defined by use_stderr. This option is ignored if
# value) # log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logfile # Deprecated group/name - [DEFAULT]/logfile
#log_file = <None> #log_file = <None>
# (Optional) The base directory used for relative --log-file paths. This option # (Optional) The base directory used for relative log_file paths. This option
# is ignored if log_config_append is set. (string value) # is ignored if log_config_append is set. (string value)
# Deprecated group/name - [DEFAULT]/logdir # Deprecated group/name - [DEFAULT]/logdir
#log_dir = <None> #log_dir = <None>
# (Optional) Uses logging handler designed to watch file system. When log file # Uses logging handler designed to watch file system. When log file is moved or
# is moved or removed this handler will open a new log file with specified path # removed this handler will open a new log file with specified path
# instantaneously. It makes sense only if log-file option is specified and # 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. # Linux platform is used. This option is ignored if log_config_append is set.
# (boolean value) # (boolean value)
#watch_log_file = false #watch_log_file = false
@ -50,15 +53,6 @@
# is set. (boolean value) # is set. (boolean value)
#use_syslog = false #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 # Syslog facility to receive log lines. This option is ignored if
# log_config_append is set. (string value) # log_config_append is set. (string value)
#syslog_log_facility = LOG_USER #syslog_log_facility = LOG_USER
@ -70,18 +64,24 @@
# Format string to use for log messages with context. (string value) # 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 #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) # Format string to use for log messages when context is undefined. (string
# value)
#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s #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) # Additional data to append to log message when logging level for the message
# is DEBUG. (string value)
#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d #logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d
# Prefix each line of exception output with this format. (string value) # 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 #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 # Defines the format string for %(user_identity)s that is used in
# set. (list value) # logging_context_format_string. (string 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 #logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s
# List of package logging levels in 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,keystoneauth=WARN,oslo.cache=INFO,dogpile.core.dogpile=INFO
# Enables or disables publication of error events. (boolean value) # Enables or disables publication of error events. (boolean value)
#publish_errors = false #publish_errors = false
@ -94,10 +94,6 @@
# value) # value)
#instance_uuid_format = "[instance: %(uuid)s] " #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) # Enables or disables fatal status of deprecations. (boolean value)
#fatal_deprecations = false #fatal_deprecations = false
@ -112,7 +108,7 @@
#extensions = #extensions =
[ml2_sriov] [sriov_nic]
# #
# From neutron.ml2.sriov.agent # From neutron.ml2.sriov.agent