diff --git a/doc/config-reference/source/networking/samples/index.rst b/doc/config-reference/source/networking/samples/index.rst index 3cfdc6bfd2..a44fb3aca3 100644 --- a/doc/config-reference/source/networking/samples/index.rst +++ b/doc/config-reference/source/networking/samples/index.rst @@ -47,5 +47,6 @@ architecture components: openvswitch_agent.ini.rst dhcp_agent.ini.rst l3_agent.ini.rst + macvtap_agent.ini.rst metadata_agent.ini.rst metering_agent.ini.rst diff --git a/doc/config-reference/source/networking/samples/macvtap_agent.ini.rst b/doc/config-reference/source/networking/samples/macvtap_agent.ini.rst new file mode 100644 index 0000000000..04626c06f5 --- /dev/null +++ b/doc/config-reference/source/networking/samples/macvtap_agent.ini.rst @@ -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 + diff --git a/doc/config-reference/source/samples/neutron/dhcp_agent.ini.sample b/doc/config-reference/source/samples/neutron/dhcp_agent.ini.sample index cbb94f0684..5fff9ea00e 100644 --- a/doc/config-reference/source/samples/neutron/dhcp_agent.ini.sample +++ b/doc/config-reference/source/samples/neutron/dhcp_agent.ini.sample @@ -12,9 +12,6 @@ # value) #ovs_use_veth = false -# MTU setting for device. (integer value) -#network_device_mtu = - # The driver used to manage the virtual interface. (string value) #interface_driver = @@ -62,45 +59,52 @@ # pool size configured on server. (integer value) #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 -# Domain to use for building the hostnames.This option is deprecated. It has -# been moved to neutron.conf as dns_domain. It will removed from here in a -# future release (string value) +# DEPRECATED: Domain to use for building the hostnames. This option is +# deprecated. It has been moved to neutron.conf as dns_domain. It will be +# removed in a future release. (string value) # This option is deprecated for removal. # Its value may be silently ignored in the future. #dhcp_domain = openstacklocal -# Override the default dnsmasq settings with this file (string value) +# Override the default dnsmasq settings with this file. (string value) #dnsmasq_config_file = # Comma-separated list of the DNS servers which will be used as forwarders. # (list value) -# Deprecated group/name - [DEFAULT]/dnsmasq_dns_server -#dnsmasq_dns_servers = +#dnsmasq_dns_servers = # Base log dir for dnsmasq logging. The log contains DHCP and DNS log # information and is useful for debugging issues with either DHCP or DNS. If # this section is null, disable dnsmasq log. (string value) #dnsmasq_base_log_dir = +# 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) #dnsmasq_lease_max = 16777216 -# Use broadcast in DHCP replies (boolean value) +# Use broadcast in DHCP replies. (boolean value) #dhcp_broadcast_reply = false # # From oslo.log # -# Print debugging output (set logging level to DEBUG instead of default INFO -# level). (boolean value) +# 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 -# If set to false, will disable INFO logging level, making WARNING the default. -# (boolean value) +# 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 @@ -109,29 +113,31 @@ # 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. -# (string value) +# 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 = -# Format string for %%(asctime)s in log records. Default: %(default)s . This -# option is ignored if log_config_append is set. (string value) +# 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 output to. If no default is set, logging will -# go to stdout. This option is ignored if log_config_append is set. (string -# value) +# (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 = -# (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) # Deprecated group/name - [DEFAULT]/logdir #log_dir = -# (Optional) Uses logging handler designed to watch file system. When log file -# is moved or removed this handler will open a new log file with specified path -# instantaneously. It makes sense only if log-file option is specified and +# 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 @@ -141,15 +147,6 @@ # is set. (boolean value) #use_syslog = false -# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, -# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The -# format without the APP-NAME is deprecated in Kilo, and will be removed in -# Mitaka, along with this option. This option is ignored if log_config_append -# is set. (boolean value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#use_syslog_rfc_format = true - # Syslog facility to receive log lines. This option is ignored if # log_config_append is set. (string value) #syslog_log_facility = LOG_USER @@ -161,18 +158,24 @@ # Format string to use for log messages with context. (string value) #logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s -# Format string to use for log messages without context. (string value) +# 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 -# 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 # Prefix each line of exception output with this format. (string value) #logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s -# List of logger=LEVEL pairs. This option is ignored if log_config_append is -# set. (list value) -#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN +# 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 @@ -185,10 +188,6 @@ # value) #instance_uuid_format = "[instance: %(uuid)s] " -# Format string for user_identity field of the logging_context_format_string -# (string value) -#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s - # Enables or disables fatal status of deprecations. (boolean value) #fatal_deprecations = false @@ -206,3 +205,6 @@ # Log agent heartbeats (boolean value) #log_agent_heartbeats = false + +# Availability zone of this node (string value) +#availability_zone = nova diff --git a/doc/config-reference/source/samples/neutron/l3_agent.ini.sample b/doc/config-reference/source/samples/neutron/l3_agent.ini.sample index b204763153..0ba49511ac 100644 --- a/doc/config-reference/source/samples/neutron/l3_agent.ini.sample +++ b/doc/config-reference/source/samples/neutron/l3_agent.ini.sample @@ -12,9 +12,6 @@ # value) #ovs_use_veth = false -# MTU setting for device. (integer value) -#network_device_mtu = - # The driver used to manage the virtual interface. (string value) #interface_driver = @@ -38,7 +35,7 @@ #agent_mode = legacy # TCP Port used by Neutron metadata namespace proxy. (port value) -# Minimum value: 1 +# Minimum value: 0 # Maximum value: 65535 #metadata_port = 9697 @@ -90,15 +87,16 @@ # (string value) #external_ingress_mark = 0x2 -# Name of bridge used for external network traffic. This should be set to an -# empty value for the Linux Bridge. When this parameter is set, each L3 agent -# can be associated with no more than one external network. This option is -# deprecated and will be removed in the M release. (string value) +# DEPRECATED: Name of bridge used for external network traffic. When this +# parameter is set, the L3 agent will plug an interface directly into an +# external bridge which will not allow any wiring by the L2 agent. Using this +# will result in incorrect port statuses. This option is deprecated and will be +# removed in Ocata. (string value) # This option is deprecated for removal. # 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 # Number of separate API worker processes for service. If not specified, the @@ -106,10 +104,10 @@ # (integer value) #api_workers = -# Number of RPC worker processes for service (integer value) +# Number of RPC worker processes for service. (integer value) #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) #rpc_state_report_workers = 1 @@ -130,16 +128,29 @@ # The advertisement interval in seconds (integer value) #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 # -# Print debugging output (set logging level to DEBUG instead of default INFO -# level). (boolean value) +# 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 -# If set to false, will disable INFO logging level, making WARNING the default. -# (boolean value) +# 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 @@ -148,29 +159,31 @@ # 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. -# (string value) +# 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 = -# Format string for %%(asctime)s in log records. Default: %(default)s . This -# option is ignored if log_config_append is set. (string value) +# 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 output to. If no default is set, logging will -# go to stdout. This option is ignored if log_config_append is set. (string -# value) +# (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 = -# (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) # Deprecated group/name - [DEFAULT]/logdir #log_dir = -# (Optional) Uses logging handler designed to watch file system. When log file -# is moved or removed this handler will open a new log file with specified path -# instantaneously. It makes sense only if log-file option is specified and +# 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 @@ -180,15 +193,6 @@ # is set. (boolean value) #use_syslog = false -# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, -# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The -# format without the APP-NAME is deprecated in Kilo, and will be removed in -# Mitaka, along with this option. This option is ignored if log_config_append -# is set. (boolean value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#use_syslog_rfc_format = true - # Syslog facility to receive log lines. This option is ignored if # log_config_append is set. (string value) #syslog_log_facility = LOG_USER @@ -200,18 +204,24 @@ # Format string to use for log messages with context. (string value) #logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s -# Format string to use for log messages without context. (string value) +# 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 -# 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 # Prefix each line of exception output with this format. (string value) #logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s -# List of logger=LEVEL pairs. This option is ignored if log_config_append is -# set. (list value) -#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN +# 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 @@ -224,10 +234,6 @@ # value) #instance_uuid_format = "[instance: %(uuid)s] " -# Format string for user_identity field of the logging_context_format_string -# (string value) -#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s - # Enables or disables fatal status of deprecations. (boolean value) #fatal_deprecations = false @@ -245,3 +251,6 @@ # Log agent heartbeats (boolean value) #log_agent_heartbeats = false + +# Availability zone of this node (string value) +#availability_zone = nova diff --git a/doc/config-reference/source/samples/neutron/linuxbridge_agent.ini.sample b/doc/config-reference/source/samples/neutron/linuxbridge_agent.ini.sample index e689b118c4..ff5ea3638d 100644 --- a/doc/config-reference/source/samples/neutron/linuxbridge_agent.ini.sample +++ b/doc/config-reference/source/samples/neutron/linuxbridge_agent.ini.sample @@ -4,12 +4,13 @@ # From oslo.log # -# Print debugging output (set logging level to DEBUG instead of default INFO -# level). (boolean value) +# 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 -# If set to false, will disable INFO logging level, making WARNING the default. -# (boolean value) +# 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 @@ -18,29 +19,31 @@ # 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. -# (string value) +# 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 = -# Format string for %%(asctime)s in log records. Default: %(default)s . This -# option is ignored if log_config_append is set. (string value) +# 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 output to. If no default is set, logging will -# go to stdout. This option is ignored if log_config_append is set. (string -# value) +# (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 = -# (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) # Deprecated group/name - [DEFAULT]/logdir #log_dir = -# (Optional) Uses logging handler designed to watch file system. When log file -# is moved or removed this handler will open a new log file with specified path -# instantaneously. It makes sense only if log-file option is specified and +# 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 @@ -50,15 +53,6 @@ # is set. (boolean value) #use_syslog = false -# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, -# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The -# format without the APP-NAME is deprecated in Kilo, and will be removed in -# Mitaka, along with this option. This option is ignored if log_config_append -# is set. (boolean value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#use_syslog_rfc_format = true - # Syslog facility to receive log lines. This option is ignored if # log_config_append is set. (string value) #syslog_log_facility = LOG_USER @@ -70,18 +64,24 @@ # Format string to use for log messages with context. (string value) #logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s -# Format string to use for log messages without context. (string value) +# 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 -# 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 # Prefix each line of exception output with this format. (string value) #logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s -# List of logger=LEVEL pairs. This option is ignored if log_config_append is -# set. (list value) -#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN +# 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 @@ -94,10 +94,6 @@ # value) #instance_uuid_format = "[instance: %(uuid)s] " -# Format string for user_identity field of the logging_context_format_string -# (string value) -#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s - # Enables or disables fatal status of deprecations. (boolean value) #fatal_deprecations = false @@ -116,16 +112,22 @@ # value is set to 0, rpc timeout won't be changed (integer value) #quitting_rpc_timeout = 10 -# Enable suppression of ARP responses that don't match an IP address that -# belongs to the port from which they originate. Note: This prevents the VMs -# attached to this agent from spoofing, it doesn't protect them from other -# devices which have the capability to spoof (e.g. bare metal or VMs attached -# to agents without this flag set to True). Spoofing rules will not be added to -# any ports that have port security disabled. For LinuxBridge, this requires -# ebtables. For OVS, it requires a version that supports matching ARP headers. -# (boolean value) +# 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 +# Extensions list to use (list value) +#extensions = + [linux_bridge] @@ -187,9 +189,19 @@ # all the agents. (string value) #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 = # Extension to use alongside ml2 plugin's l2population mechanism driver. It # enables the plugin to populate VXLAN forwarding table. (boolean value) #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 diff --git a/doc/config-reference/source/samples/neutron/macvtap_agent.ini.sample b/doc/config-reference/source/samples/neutron/macvtap_agent.ini.sample new file mode 100644 index 0000000000..8d8720082d --- /dev/null +++ b/doc/config-reference/source/samples/neutron/macvtap_agent.ini.sample @@ -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 = + +# 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 = + +# (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 = + +# 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 : 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 = + +# Controls whether the neutron security group API is enabled in the server. It +# should be false when using no security groups or using the nova security +# group API. (boolean value) +#enable_security_group = true + +# Use ipset to speed-up the iptables based security groups. Enabling ipset +# support requires that ipset is installed on L2 agent node. (boolean value) +#enable_ipset = true diff --git a/doc/config-reference/source/samples/neutron/metadata_agent.ini.sample b/doc/config-reference/source/samples/neutron/metadata_agent.ini.sample index a5dafb4f79..96c8600d7c 100644 --- a/doc/config-reference/source/samples/neutron/metadata_agent.ini.sample +++ b/doc/config-reference/source/samples/neutron/metadata_agent.ini.sample @@ -22,7 +22,7 @@ #nova_metadata_ip = 127.0.0.1 # TCP Port used by Nova metadata server. (port value) -# Minimum value: 1 +# Minimum value: 0 # Maximum value: 65535 #nova_metadata_port = 8775 @@ -58,25 +58,31 @@ # Number of separate worker processes for metadata server (defaults to half of # the number of CPUs) (integer value) -#metadata_workers = 2 +#metadata_workers = 1 # Number of backlog requests to configure the metadata server socket with # (integer value) #metadata_backlog = 4096 -# URL to connect to the cache back end. (string value) -#cache_url = memory:// +# DEPRECATED: URL to connect to the cache back end. This option is deprecated +# 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 # -# Print debugging output (set logging level to DEBUG instead of default INFO -# level). (boolean value) +# 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 -# If set to false, will disable INFO logging level, making WARNING the default. -# (boolean value) +# 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 @@ -85,29 +91,31 @@ # 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. -# (string value) +# 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 = -# Format string for %%(asctime)s in log records. Default: %(default)s . This -# option is ignored if log_config_append is set. (string value) +# 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 output to. If no default is set, logging will -# go to stdout. This option is ignored if log_config_append is set. (string -# value) +# (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 = -# (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) # Deprecated group/name - [DEFAULT]/logdir #log_dir = -# (Optional) Uses logging handler designed to watch file system. When log file -# is moved or removed this handler will open a new log file with specified path -# instantaneously. It makes sense only if log-file option is specified and +# 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 @@ -117,15 +125,6 @@ # is set. (boolean value) #use_syslog = false -# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, -# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The -# format without the APP-NAME is deprecated in Kilo, and will be removed in -# Mitaka, along with this option. This option is ignored if log_config_append -# is set. (boolean value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#use_syslog_rfc_format = true - # Syslog facility to receive log lines. This option is ignored if # log_config_append is set. (string value) #syslog_log_facility = LOG_USER @@ -137,18 +136,24 @@ # Format string to use for log messages with context. (string value) #logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s -# Format string to use for log messages without context. (string value) +# 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 -# 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 # Prefix each line of exception output with this format. (string value) #logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s -# List of logger=LEVEL pairs. This option is ignored if log_config_append is -# set. (list value) -#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN +# 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 @@ -161,10 +166,6 @@ # value) #instance_uuid_format = "[instance: %(uuid)s] " -# Format string for user_identity field of the logging_context_format_string -# (string value) -#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s - # Enables or disables fatal status of deprecations. (boolean value) #fatal_deprecations = false @@ -182,3 +183,72 @@ # Log agent heartbeats (boolean value) #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: +# ":". (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 diff --git a/doc/config-reference/source/samples/neutron/metering_agent.ini.sample b/doc/config-reference/source/samples/neutron/metering_agent.ini.sample index 4fb82532b6..f85fe80a26 100644 --- a/doc/config-reference/source/samples/neutron/metering_agent.ini.sample +++ b/doc/config-reference/source/samples/neutron/metering_agent.ini.sample @@ -20,12 +20,13 @@ # From oslo.log # -# Print debugging output (set logging level to DEBUG instead of default INFO -# level). (boolean value) +# 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 -# If set to false, will disable INFO logging level, making WARNING the default. -# (boolean value) +# 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 @@ -34,29 +35,31 @@ # 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. -# (string value) +# 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 = -# Format string for %%(asctime)s in log records. Default: %(default)s . This -# option is ignored if log_config_append is set. (string value) +# 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 output to. If no default is set, logging will -# go to stdout. This option is ignored if log_config_append is set. (string -# value) +# (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 = -# (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) # Deprecated group/name - [DEFAULT]/logdir #log_dir = -# (Optional) Uses logging handler designed to watch file system. When log file -# is moved or removed this handler will open a new log file with specified path -# instantaneously. It makes sense only if log-file option is specified and +# 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 @@ -66,15 +69,6 @@ # is set. (boolean value) #use_syslog = false -# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, -# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The -# format without the APP-NAME is deprecated in Kilo, and will be removed in -# Mitaka, along with this option. This option is ignored if log_config_append -# is set. (boolean value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#use_syslog_rfc_format = true - # Syslog facility to receive log lines. This option is ignored if # log_config_append is set. (string value) #syslog_log_facility = LOG_USER @@ -86,18 +80,24 @@ # Format string to use for log messages with context. (string value) #logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s -# Format string to use for log messages without context. (string value) +# 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 -# 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 # Prefix each line of exception output with this format. (string value) #logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s -# List of logger=LEVEL pairs. This option is ignored if log_config_append is -# set. (list value) -#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN +# 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 @@ -110,9 +110,5 @@ # value) #instance_uuid_format = "[instance: %(uuid)s] " -# Format string for user_identity field of the logging_context_format_string -# (string value) -#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s - # Enables or disables fatal status of deprecations. (boolean value) #fatal_deprecations = false diff --git a/doc/config-reference/source/samples/neutron/ml2_conf.ini.sample b/doc/config-reference/source/samples/neutron/ml2_conf.ini.sample index 4b42d224c0..6f44498a3b 100644 --- a/doc/config-reference/source/samples/neutron/ml2_conf.ini.sample +++ b/doc/config-reference/source/samples/neutron/ml2_conf.ini.sample @@ -4,12 +4,13 @@ # From oslo.log # -# Print debugging output (set logging level to DEBUG instead of default INFO -# level). (boolean value) +# 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 -# If set to false, will disable INFO logging level, making WARNING the default. -# (boolean value) +# 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 @@ -18,29 +19,31 @@ # 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. -# (string value) +# 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 = -# Format string for %%(asctime)s in log records. Default: %(default)s . This -# option is ignored if log_config_append is set. (string value) +# 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 output to. If no default is set, logging will -# go to stdout. This option is ignored if log_config_append is set. (string -# value) +# (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 = -# (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) # Deprecated group/name - [DEFAULT]/logdir #log_dir = -# (Optional) Uses logging handler designed to watch file system. When log file -# is moved or removed this handler will open a new log file with specified path -# instantaneously. It makes sense only if log-file option is specified and +# 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 @@ -50,15 +53,6 @@ # is set. (boolean value) #use_syslog = false -# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, -# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The -# format without the APP-NAME is deprecated in Kilo, and will be removed in -# Mitaka, along with this option. This option is ignored if log_config_append -# is set. (boolean value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#use_syslog_rfc_format = true - # Syslog facility to receive log lines. This option is ignored if # log_config_append is set. (string value) #syslog_log_facility = LOG_USER @@ -70,18 +64,24 @@ # Format string to use for log messages with context. (string value) #logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s -# Format string to use for log messages without context. (string value) +# 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 -# 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 # Prefix each line of exception output with this format. (string value) #logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s -# List of logger=LEVEL pairs. This option is ignored if log_config_append is -# set. (list value) -#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN +# 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 @@ -94,10 +94,6 @@ # value) #instance_uuid_format = "[instance: %(uuid)s] " -# Format string for user_identity field of the logging_context_format_string -# (string value) -#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s - # Enables or disables fatal status of deprecations. (boolean value) #fatal_deprecations = false @@ -126,22 +122,16 @@ # port_security,qos (list value) #extension_drivers = -# The maximum permissible size of an unfragmented packet travelling from and to -# addresses where encapsulated Neutron traffic is sent. Drivers calculate -# maximum viable MTU for validating tenant requests based on this value -# (typically, path_mtu - maxmum encapsulation header size). If <= 0, the path -# MTU is indeterminate and no calculation takes place. (integer value) +# Maximum size of an IP packet (MTU) that can traverse the underlying physical +# network infrastructure without fragmentation when using an overlay/tunnel +# protocol. This option allows specifying a physical network MTU value that +# differs from the default global_physnet_mtu value. (integer value) #path_mtu = 0 -# The maximum permissible size of an unfragmented packet travelling a L2 -# network segment. If <= 0, the segment MTU is indeterminate and no -# calculation takes place. (integer value) -#segment_mtu = 0 - # A list of mappings of physical networks to MTU values. The format of the # mapping is :. This mapping allows specifying a physical -# network MTU value that differs from the default segment_mtu value. (list -# value) +# network MTU value that differs from the default global_physnet_mtu value. +# (list value) #physical_network_mtus = # Default network type for external networks when no provider attributes are @@ -152,6 +142,10 @@ # option. (string value) #external_network_type = +# 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] @@ -180,7 +174,7 @@ # + IP + UDP + GENEVE header sizes. The default size for this field is 50, # which is the size of the Geneve header without any additional option headers. # (integer value) -#max_header_size = 50 +#max_header_size = 30 [ml2_type_gre] diff --git a/doc/config-reference/source/samples/neutron/ml2_conf_sriov.ini.sample b/doc/config-reference/source/samples/neutron/ml2_conf_sriov.ini.sample index bfe018c493..a4d541bb49 100644 --- a/doc/config-reference/source/samples/neutron/ml2_conf_sriov.ini.sample +++ b/doc/config-reference/source/samples/neutron/ml2_conf_sriov.ini.sample @@ -4,12 +4,13 @@ # From oslo.log # -# Print debugging output (set logging level to DEBUG instead of default INFO -# level). (boolean value) +# 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 -# If set to false, will disable INFO logging level, making WARNING the default. -# (boolean value) +# 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 @@ -18,29 +19,31 @@ # 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. -# (string value) +# 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 = -# Format string for %%(asctime)s in log records. Default: %(default)s . This -# option is ignored if log_config_append is set. (string value) +# 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 output to. If no default is set, logging will -# go to stdout. This option is ignored if log_config_append is set. (string -# value) +# (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 = -# (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) # Deprecated group/name - [DEFAULT]/logdir #log_dir = -# (Optional) Uses logging handler designed to watch file system. When log file -# is moved or removed this handler will open a new log file with specified path -# instantaneously. It makes sense only if log-file option is specified and +# 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 @@ -50,15 +53,6 @@ # is set. (boolean value) #use_syslog = false -# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, -# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The -# format without the APP-NAME is deprecated in Kilo, and will be removed in -# Mitaka, along with this option. This option is ignored if log_config_append -# is set. (boolean value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#use_syslog_rfc_format = true - # Syslog facility to receive log lines. This option is ignored if # log_config_append is set. (string value) #syslog_log_facility = LOG_USER @@ -70,18 +64,24 @@ # Format string to use for log messages with context. (string value) #logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s -# Format string to use for log messages without context. (string value) +# 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 -# 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 # Prefix each line of exception output with this format. (string value) #logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s -# List of logger=LEVEL pairs. This option is ignored if log_config_append is -# set. (list value) -#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN +# 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 @@ -94,10 +94,6 @@ # value) #instance_uuid_format = "[instance: %(uuid)s] " -# Format string for user_identity field of the logging_context_format_string -# (string value) -#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s - # Enables or disables fatal status of deprecations. (boolean value) #fatal_deprecations = false @@ -108,7 +104,11 @@ # From neutron.ml2.sriov # -# Comma-separated list of supported PCI vendor devices, as defined by -# vendor_id:product_id according to the PCI ID Repository. Default enables -# support for Intel and Mellanox SR-IOV capable NICs. (list value) -#supported_pci_vendor_devs = 15b3:1004,8086:10ca +# DEPRECATED: Comma-separated list of supported PCI vendor devices, as defined +# by vendor_id:product_id according to the PCI ID Repository. Default None +# accept all PCI vendor devicesDEPRECATED: This option is deprecated in the +# 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 = diff --git a/doc/config-reference/source/samples/neutron/neutron.conf.sample b/doc/config-reference/source/samples/neutron/neutron.conf.sample index 0692c6536a..855d28b9b8 100644 --- a/doc/config-reference/source/samples/neutron/neutron.conf.sample +++ b/doc/config-reference/source/samples/neutron/neutron.conf.sample @@ -37,17 +37,27 @@ # others will be randomly generated. (string value) #base_mac = fa:16:3e:00:00:00 -# How many times Neutron will retry MAC generation (integer value) +# DEPRECATED: How many times Neutron will retry MAC generation. This option is +# now obsolete and so is deprecated to be removed in the Ocata release. +# (integer value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. #mac_generation_retries = 16 # Allow the usage of the bulk API (boolean value) #allow_bulk = true -# Allow the usage of the pagination (boolean value) -#allow_pagination = false +# DEPRECATED: Allow the usage of the pagination. This option has been +# deprecated and will now be enabled unconditionally. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#allow_pagination = true -# Allow the usage of the sorting (boolean value) -#allow_sorting = false +# DEPRECATED: Allow the usage of the sorting. This option has been deprecated +# and will now be enabled unconditionally. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#allow_sorting = true # The maximum number of items returned in a single response, value was # 'infinite' or negative integer means no limit (string value) @@ -67,32 +77,12 @@ # Maximum number of host routes per subnet (integer value) #max_subnet_host_routes = 20 -# Maximum number of fixed ips per port. This option is deprecated and will be -# removed in the N release. (integer value) +# DEPRECATED: Maximum number of fixed ips per port. This option is deprecated +# and will be removed in the N release. (integer value) # This option is deprecated for removal. # Its value may be silently ignored in the future. #max_fixed_ips_per_port = 5 -# Default IPv4 subnet pool to be used for automatic subnet CIDR allocation. -# Specifies by UUID the pool to be used in case where creation of a subnet is -# being called without a subnet pool ID. If not set then no pool will be used -# unless passed explicitly to the subnet create. If no pool is used, then a -# CIDR must be passed to create a subnet and that subnet will not be allocated -# from any pool; it will be considered part of the tenant's private address -# space. This option is deprecated for removal in the N release. (string value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#default_ipv4_subnet_pool = - -# Default IPv6 subnet pool to be used for automatic subnet CIDR allocation. -# Specifies by UUID the pool to be used in case where creation of a subnet is -# being called without a subnet pool ID. See the description for -# default_ipv4_subnet_pool for more information. This option is deprecated for -# removal in the N release. (string value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#default_ipv6_subnet_pool = - # Enables IPv6 Prefix Delegation for automatic subnet CIDR allocation. Set to # True to enable IPv6 Prefix Delegation for subnet allocation in a PD-capable # environment. Users making subnet creation requests for IPv6 subnets without @@ -125,14 +115,6 @@ # the same host value. (string value) #host = example.domain -# Ensure that configured gateway is on subnet. For IPv6, validate only if -# gateway is not a link local address. Deprecated, to be removed during the -# Newton release, at which point the gateway will not be forced on to subnet. -# (boolean value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#force_gateway_on_subnet = true - # Send notification to nova when port status changes (boolean value) #notify_nova_on_port_status_changes = true @@ -144,24 +126,34 @@ # send. (integer value) #send_events_interval = 2 -# If True, advertise network MTU values if core plugin calculates them. MTU is -# advertised to running instances via DHCP and RA MTU options. (boolean value) +# DEPRECATED: If True, advertise network MTU values if core plugin calculates +# them. MTU is advertised to running instances via DHCP and RA MTU options. +# (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. #advertise_mtu = true -# Neutron IPAM (IP address management) driver to use. If ipam_driver is not set -# (default behavior), no IPAM driver is used. In order to use the reference -# implementation of Neutron IPAM driver, use 'internal'. (string value) -#ipam_driver = +# Neutron IPAM (IP address management) driver to use. By default, the reference +# implementation of the Neutron IPAM driver is used. (string value) +#ipam_driver = internal # If True, then allow plugins that support it to create VLAN transparent # networks. (boolean value) #vlan_transparent = false # This will choose the web framework in which to run the Neutron API server. -# 'pecan' is a new experiemental rewrite of the API server. (string value) +# 'pecan' is a new experimental rewrite of the API server. (string value) # Allowed values: legacy, pecan #web_framework = legacy +# MTU of the underlying physical network. Neutron uses this value to calculate +# MTU for all virtual network components. For flat and VLAN networks, neutron +# uses this value without modification. For overlay networks such as VXLAN, +# neutron automatically subtracts the overlay protocol overhead from this +# value. Defaults to 1500, the standard value for Ethernet. (integer value) +# Deprecated group/name - [ml2]/segment_mtu +#global_physnet_mtu = 1500 + # Number of backlog requests to configure the socket with (integer value) #backlog = 4096 @@ -171,7 +163,7 @@ # Enable SSL on the API server (boolean value) #use_ssl = false -# Seconds between running periodic tasks (integer value) +# Seconds between running periodic tasks. (integer value) #periodic_interval = 40 # Number of separate API worker processes for service. If not specified, the @@ -179,10 +171,10 @@ # (integer value) #api_workers = -# Number of RPC worker processes for service (integer value) +# Number of RPC worker processes for service. (integer value) #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) #rpc_state_report_workers = 1 @@ -300,8 +292,12 @@ # set to 0 then the router will be scheduled on every agent. (integer value) #max_l3_agents_per_router = 3 -# Minimum number of L3 agents which a HA router will be scheduled on. If it is -# set to 0 then the router will be scheduled on every agent. (integer value) +# DEPRECATED: Minimum number of L3 agents that have to be available in order to +# allow a new HA router to be scheduled. This option is deprecated in the +# Newton release and will be removed for the Ocata release where the scheduling +# of new HA routers will always be allowed. (integer value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. #min_l3_agents_per_router = 2 # Subnet used for the l3 HA admin network. (string value) @@ -324,23 +320,17 @@ # Maximum number of allowed address pairs (integer value) #max_allowed_address_pair = 10 -# -# From neutron.qos -# - -# Drivers list to use to send the update notification (list value) -#notification_drivers = m,e,s,s,a,g,e,_,q,u,e,u,e - # # From oslo.log # # 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 -# If set to false, the logging level will be set to WARNING instead of the -# default INFO level. (boolean value) +# 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 @@ -351,6 +341,7 @@ # 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 = @@ -434,63 +425,100 @@ # Deprecated group/name - [DEFAULT]/rpc_conn_pool_size #rpc_conn_pool_size = 30 +# The pool size limit for connections expiration policy (integer value) +#conn_pool_min_size = 2 + +# The time-to-live in sec of idle connections in the pool (integer value) +#conn_pool_ttl = 1200 + # ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. # The "host" option should point or resolve to this address. (string value) +# Deprecated group/name - [DEFAULT]/rpc_zmq_bind_address #rpc_zmq_bind_address = * # MatchMaker driver. (string value) # Allowed values: redis, dummy +# Deprecated group/name - [DEFAULT]/rpc_zmq_matchmaker #rpc_zmq_matchmaker = redis -# Type of concurrency used. Either "native" or "eventlet" (string value) -#rpc_zmq_concurrency = eventlet - # Number of ZeroMQ contexts, defaults to 1. (integer value) +# Deprecated group/name - [DEFAULT]/rpc_zmq_contexts #rpc_zmq_contexts = 1 # Maximum number of ingress messages to locally buffer per topic. Default is # unlimited. (integer value) +# Deprecated group/name - [DEFAULT]/rpc_zmq_topic_backlog #rpc_zmq_topic_backlog = # Directory for holding IPC sockets. (string value) +# Deprecated group/name - [DEFAULT]/rpc_zmq_ipc_dir #rpc_zmq_ipc_dir = /var/run/openstack # Name of this node. Must be a valid hostname, FQDN, or IP address. Must match # "host" option, if running Nova. (string value) +# Deprecated group/name - [DEFAULT]/rpc_zmq_host #rpc_zmq_host = localhost # Seconds to wait before a cast expires (TTL). The default value of -1 # specifies an infinite linger period. The value of 0 specifies no linger # period. Pending messages shall be discarded immediately when the socket is # closed. Only supported by impl_zmq. (integer value) +# Deprecated group/name - [DEFAULT]/rpc_cast_timeout #rpc_cast_timeout = -1 # The default number of seconds that poll should wait. Poll raises timeout # exception when timeout expired. (integer value) +# Deprecated group/name - [DEFAULT]/rpc_poll_timeout #rpc_poll_timeout = 1 # Expiration timeout in seconds of a name service record about existing target # ( < 0 means no timeout). (integer value) -#zmq_target_expire = 120 +# Deprecated group/name - [DEFAULT]/zmq_target_expire +#zmq_target_expire = 300 + +# Update period in seconds of a name service record about existing target. +# (integer value) +# Deprecated group/name - [DEFAULT]/zmq_target_update +#zmq_target_update = 180 # Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. (boolean # value) +# Deprecated group/name - [DEFAULT]/use_pub_sub #use_pub_sub = true +# Use ROUTER remote proxy. (boolean value) +# Deprecated group/name - [DEFAULT]/use_router_proxy +#use_router_proxy = true + # Minimal port number for random ports range. (port value) # Minimum value: 0 # Maximum value: 65535 -#rpc_zmq_min_port = 49152 +# Deprecated group/name - [DEFAULT]/rpc_zmq_min_port +#rpc_zmq_min_port = 49153 # Maximal port number for random ports range. (integer value) # Minimum value: 1 # Maximum value: 65536 +# Deprecated group/name - [DEFAULT]/rpc_zmq_max_port #rpc_zmq_max_port = 65536 # Number of retries to find free port number before fail with ZMQBindError. # (integer value) +# Deprecated group/name - [DEFAULT]/rpc_zmq_bind_port_retries #rpc_zmq_bind_port_retries = 100 +# Default serialization mechanism for serializing/deserializing +# outgoing/incoming messages (string value) +# Allowed values: json, msgpack +# Deprecated group/name - [DEFAULT]/rpc_zmq_serialization +#rpc_zmq_serialization = json + +# This option configures round-robin mode in zmq socket. True means not keeping +# a queue when server side disconnects. False means to keep queue and messages +# even if server is disconnected, when the server appears we send all +# accumulated messages to it. (boolean value) +#zmq_immediate = false + # Size of executor thread pool. (integer value) # Deprecated group/name - [DEFAULT]/rpc_thread_pool_size #executor_thread_pool_size = 64 @@ -498,13 +526,15 @@ # Seconds to wait for a response from a call. (integer value) #rpc_response_timeout = 60 -# A URL representing the messaging driver to use and its full configuration. If -# not set, we fall back to the rpc_backend option and driver specific -# configuration. (string value) +# A URL representing the messaging driver to use and its full configuration. +# (string value) #transport_url = -# The messaging driver to use, defaults to rabbit. Other drivers include amqp -# and zmq. (string value) +# DEPRECATED: The messaging driver to use, defaults to rabbit. Other drivers +# include amqp and zmq. (string value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Replaced by [DEFAULT]/transport_url #rpc_backend = rabbit # The default exchange under which topics are scoped. May be overridden by an @@ -579,6 +609,12 @@ # (boolean value) #comment_iptables_rules = true +# Duplicate every iptables difference calculation to ensure the format being +# generated matches the format of iptables-save. This option should not be +# turned on for production systems because it imposes a performance penalty. +# (boolean value) +#debug_iptables_rules = false + # Action to be executed when a child process dies (string value) # Allowed values: respawn, exit #check_child_processes_action = respawn @@ -598,7 +634,8 @@ # # Indicate whether this resource may be shared with the domain received in the -# requests "origin" header. (list value) +# requests "origin" header. Format: "://[:]", no trailing +# slash. Example: https://horizon.example.com (list value) #allowed_origin = # Indicate that the actual request can include user credentials (boolean value) @@ -606,17 +643,17 @@ # Indicate which headers are safe to expose to the API. Defaults to HTTP Simple # Headers. (list value) -#expose_headers = Content-Type,Cache-Control,Content-Language,Expires,Last-Modified,Pragma +#expose_headers = X-Auth-Token,X-Subject-Token,X-Service-Token,X-OpenStack-Request-ID,OpenStack-Volume-microversion # Maximum cache age of CORS preflight requests. (integer value) #max_age = 3600 # Indicate which methods can be used during the actual request. (list value) -#allow_methods = GET,POST,PUT,DELETE,OPTIONS +#allow_methods = GET,PUT,POST,DELETE,PATCH # Indicate which header field names may be used during the actual request. # (list value) -#allow_headers = Content-Type,Cache-Control,Content-Language,Expires,Last-Modified,Pragma +#allow_headers = X-Auth-Token,X-Identity-Status,X-Roles,X-Service-Catalog,X-User-Id,X-Tenant-Id,X-OpenStack-Request-ID [cors.subdomain] @@ -626,7 +663,8 @@ # # Indicate whether this resource may be shared with the domain received in the -# requests "origin" header. (list value) +# requests "origin" header. Format: "://[:]", no trailing +# slash. Example: https://horizon.example.com (list value) #allowed_origin = # Indicate that the actual request can include user credentials (boolean value) @@ -634,17 +672,17 @@ # Indicate which headers are safe to expose to the API. Defaults to HTTP Simple # Headers. (list value) -#expose_headers = Content-Type,Cache-Control,Content-Language,Expires,Last-Modified,Pragma +#expose_headers = X-Auth-Token,X-Subject-Token,X-Service-Token,X-OpenStack-Request-ID,OpenStack-Volume-microversion # Maximum cache age of CORS preflight requests. (integer value) #max_age = 3600 # Indicate which methods can be used during the actual request. (list value) -#allow_methods = GET,POST,PUT,DELETE,OPTIONS +#allow_methods = GET,PUT,POST,DELETE,PATCH # Indicate which header field names may be used during the actual request. # (list value) -#allow_headers = Content-Type,Cache-Control,Content-Language,Expires,Last-Modified,Pragma +#allow_headers = X-Auth-Token,X-Identity-Status,X-Roles,X-Service-Catalog,X-User-Id,X-Tenant-Id,X-OpenStack-Request-ID [database] @@ -661,8 +699,12 @@ # From oslo.db # -# The file name to use with SQLite. (string value) +# DEPRECATED: The file name to use with SQLite. (string value) # Deprecated group/name - [DEFAULT]/sqlite_db +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Should use config option connection or slave_connection to connect +# the database. #sqlite_db = oslo.sqlite # If True, SQLite uses synchronous mode. (boolean value) @@ -701,10 +743,11 @@ # Deprecated group/name - [DATABASE]/sql_min_pool_size #min_pool_size = 1 -# Maximum number of SQL connections to keep open in a pool. (integer value) +# Maximum number of SQL connections to keep open in a pool. Setting a value of +# 0 indicates no limit. (integer value) # Deprecated group/name - [DEFAULT]/sql_max_pool_size # Deprecated group/name - [DATABASE]/sql_max_pool_size -#max_pool_size = +#max_pool_size = 5 # Maximum number of database connection retries during startup. Set to -1 to # specify an infinite retry count. (integer value) @@ -724,6 +767,8 @@ # Verbosity of SQL debugging information: 0=None, 100=Everything. (integer # value) +# Minimum value: 0 +# Maximum value: 100 # Deprecated group/name - [DEFAULT]/sql_connection_debug #connection_debug = 0 @@ -761,7 +806,14 @@ # From keystonemiddleware.auth_token # -# Complete public Identity API endpoint. (string value) +# Complete "public" Identity API endpoint. This endpoint should not be an +# "admin" endpoint, as it should be accessible by all end users. +# Unauthenticated clients are redirected to this endpoint to authenticate. +# Although this endpoint should ideally be unversioned, client support in the +# wild varies. If you're using a versioned v2 endpoint here, then this should +# *not* be the same endpoint the service user utilizes for validating tokens, +# because normal end users may not be able to reach that endpoint. (string +# value) #auth_uri = # API version of the admin Identity API endpoint. (string value) @@ -779,7 +831,10 @@ # API Server. (integer value) #http_request_max_retries = 3 -# Env key for the swift cache. (string value) +# Request environment key where the Swift cache object is stored. When +# auth_token middleware is deployed with a Swift cache, use this option to have +# the middleware share a caching backend with swift. Otherwise, use the +# ``memcached_servers`` option instead. (string value) #cache = # Required if identity server requires client certificate (string value) @@ -803,7 +858,7 @@ # Optionally specify a list of memcached server(s) to use for caching. If left # undefined, tokens will instead be cached in-process. (list value) -# Deprecated group/name - [DEFAULT]/memcache_servers +# Deprecated group/name - [keystone_authtoken]/memcache_servers #memcached_servers = # In order to prevent excessive effort spent validating tokens, the middleware @@ -813,8 +868,8 @@ # Determines the frequency at which the list of revoked tokens is retrieved # from the Identity service (in seconds). A high number of revocation events -# combined with a low cache duration may significantly reduce performance. -# (integer value) +# combined with a low cache duration may significantly reduce performance. Only +# valid for PKI tokens. (integer value) #revocation_cache_time = 10 # (Optional) If defined, indicate whether token data should be authenticated or @@ -881,11 +936,11 @@ # performance. (list value) #hash_algorithms = md5 -# Authentication type to load (unknown value) -# Deprecated group/name - [DEFAULT]/auth_plugin +# Authentication type to load (string value) +# Deprecated group/name - [keystone_authtoken]/auth_plugin #auth_type = -# Config Section from which to load plugin specific options (unknown value) +# Config Section from which to load plugin specific options (string value) #auth_section = @@ -895,32 +950,44 @@ # From oslo.messaging # -# Host to locate redis. (string value) +# DEPRECATED: Host to locate redis. (string value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Replaced by [DEFAULT]/transport_url #host = 127.0.0.1 -# Use this port to connect to redis host. (port value) +# DEPRECATED: Use this port to connect to redis host. (port value) # Minimum value: 0 # Maximum value: 65535 +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Replaced by [DEFAULT]/transport_url #port = 6379 -# Password for Redis server (optional). (string value) +# DEPRECATED: Password for Redis server (optional). (string value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Replaced by [DEFAULT]/transport_url #password = -# List of Redis Sentinel hosts (fault tolerance mode) e.g. +# DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode) e.g. # [host:port, host1:port ... ] (list value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Replaced by [DEFAULT]/transport_url #sentinel_hosts = # Redis replica set name. (string value) #sentinel_group_name = oslo-messaging-zeromq # Time in ms to wait between connection attempts. (integer value) -#wait_timeout = 500 +#wait_timeout = 2000 # Time in ms to wait before the transaction is killed. (integer value) #check_timeout = 20000 # Timeout in ms on blocking socket operations (integer value) -#socket_timeout = 1000 +#socket_timeout = 10000 [nova] @@ -943,11 +1010,11 @@ # From nova.auth # -# Warning: Failed to format sample for auth_url -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# Authentication URL (string value) +#auth_url = -# Authentication type to load (unknown value) -# Deprecated group/name - [DEFAULT]/auth_plugin +# Authentication type to load (string value) +# Deprecated group/name - [nova]/auth_plugin #auth_type = # PEM encoded Certificate Authority to use when verifying HTTPs connections. @@ -957,17 +1024,21 @@ # PEM encoded client certificate cert file (string value) #certfile = -# Warning: Failed to format sample for default_domain_id -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# Optional domain ID to use with v3 and v2 parameters. It will be used for both +# the user and project domain in v3 and ignored in v2 authentication. (string +# value) +#default_domain_id = -# Warning: Failed to format sample for default_domain_name -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# Optional domain name to use with v3 API and v2 parameters. It will be used +# for both the user and project domain in v3 and ignored in v2 authentication. +# (string value) +#default_domain_name = -# Warning: Failed to format sample for domain_id -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# Domain ID to scope to (string value) +#domain_id = -# Warning: Failed to format sample for domain_name -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# Domain name to scope to (string value) +#domain_name = # Verify HTTPS connections. (boolean value) #insecure = false @@ -975,44 +1046,47 @@ # PEM encoded client certificate key file (string value) #keyfile = -# Warning: Failed to format sample for password -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# User's password (string value) +#password = -# Warning: Failed to format sample for project_domain_id -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# Domain ID containing project (string value) +#project_domain_id = -# Warning: Failed to format sample for project_domain_name -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# Domain name containing project (string value) +#project_domain_name = -# Warning: Failed to format sample for project_id -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# Project ID to scope to (string value) +# Deprecated group/name - [nova]/tenant-id +#project_id = -# Warning: Failed to format sample for project_name -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# Project name to scope to (string value) +# Deprecated group/name - [nova]/tenant-name +#project_name = -# Warning: Failed to format sample for tenant_id -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# Tenant ID (string value) +#tenant_id = -# Warning: Failed to format sample for tenant_name -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# Tenant Name (string value) +#tenant_name = # Timeout value for http requests (integer value) #timeout = -# Warning: Failed to format sample for trust_id -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# Trust ID (string value) +#trust_id = -# Warning: Failed to format sample for user_domain_id -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# User's domain id (string value) +#user_domain_id = -# Warning: Failed to format sample for user_domain_name -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# User's domain name (string value) +#user_domain_name = -# Warning: Failed to format sample for user_id -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# User id (string value) +#user_id = -# Warning: Failed to format sample for username -# isinstance() arg 2 must be a class, type, or tuple of classes and types +# Username (string value) +# Deprecated group/name - [nova]/user-name +#username = [oslo_concurrency] @@ -1039,19 +1113,8 @@ # From oslo.messaging # -# address prefix used when sending to a specific server (string value) -# Deprecated group/name - [amqp1]/server_request_prefix -#server_request_prefix = exclusive - -# address prefix used when broadcasting to all servers (string value) -# Deprecated group/name - [amqp1]/broadcast_prefix -#broadcast_prefix = broadcast - -# address prefix when sending to any server in group (string value) -# Deprecated group/name - [amqp1]/group_request_prefix -#group_request_prefix = unicast - -# Name for the AMQP container (string value) +# Name for the AMQP container. must be globally unique. Defaults to a generated +# UUID (string value) # Deprecated group/name - [amqp1]/container_name #container_name = @@ -1103,6 +1166,108 @@ # Deprecated group/name - [amqp1]/password #password = +# Seconds to pause before attempting to re-connect. (integer value) +# Minimum value: 1 +#connection_retry_interval = 1 + +# Increase the connection_retry_interval by this many seconds after each +# unsuccessful failover attempt. (integer value) +# Minimum value: 0 +#connection_retry_backoff = 2 + +# Maximum limit for connection_retry_interval + connection_retry_backoff +# (integer value) +# Minimum value: 1 +#connection_retry_interval_max = 30 + +# Time to pause between re-connecting an AMQP 1.0 link that failed due to a +# recoverable error. (integer value) +# Minimum value: 1 +#link_retry_delay = 10 + +# The deadline for an rpc reply message delivery. Only used when caller does +# not provide a timeout expiry. (integer value) +# Minimum value: 5 +#default_reply_timeout = 30 + +# The deadline for an rpc cast or call message delivery. Only used when caller +# does not provide a timeout expiry. (integer value) +# Minimum value: 5 +#default_send_timeout = 30 + +# The deadline for a sent notification message delivery. Only used when caller +# does not provide a timeout expiry. (integer value) +# Minimum value: 5 +#default_notify_timeout = 30 + +# Indicates the addressing mode used by the driver. +# Permitted values: +# 'legacy' - use legacy non-routable addressing +# 'routable' - use routable addresses +# 'dynamic' - use legacy addresses if the message bus does not support routing +# otherwise use routable addressing (string value) +#addressing_mode = dynamic + +# address prefix used when sending to a specific server (string value) +# Deprecated group/name - [amqp1]/server_request_prefix +#server_request_prefix = exclusive + +# address prefix used when broadcasting to all servers (string value) +# Deprecated group/name - [amqp1]/broadcast_prefix +#broadcast_prefix = broadcast + +# address prefix when sending to any server in group (string value) +# Deprecated group/name - [amqp1]/group_request_prefix +#group_request_prefix = unicast + +# Address prefix for all generated RPC addresses (string value) +#rpc_address_prefix = openstack.org/om/rpc + +# Address prefix for all generated Notification addresses (string value) +#notify_address_prefix = openstack.org/om/notify + +# Appended to the address prefix when sending a fanout message. Used by the +# message bus to identify fanout messages. (string value) +#multicast_address = multicast + +# Appended to the address prefix when sending to a particular RPC/Notification +# server. Used by the message bus to identify messages sent to a single +# destination. (string value) +#unicast_address = unicast + +# Appended to the address prefix when sending to a group of consumers. Used by +# the message bus to identify messages that should be delivered in a round- +# robin fashion across consumers. (string value) +#anycast_address = anycast + +# Exchange name used in notification addresses. +# Exchange name resolution precedence: +# Target.exchange if set +# else default_notification_exchange if set +# else control_exchange if set +# else 'notify' (string value) +#default_notification_exchange = + +# Exchange name used in RPC addresses. +# Exchange name resolution precedence: +# Target.exchange if set +# else default_rpc_exchange if set +# else control_exchange if set +# else 'rpc' (string value) +#default_rpc_exchange = + +# Window size for incoming RPC Reply messages. (integer value) +# Minimum value: 1 +#reply_link_credit = 200 + +# Window size for incoming RPC Request messages (integer value) +# Minimum value: 1 +#rpc_server_credit = 100 + +# Window size for incoming Notification messages (integer value) +# Minimum value: 1 +#notify_server_credit = 100 + [oslo_messaging_notifications] @@ -1165,12 +1330,12 @@ #kombu_reconnect_delay = 1.0 # EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not -# be used. This option may notbe available in future versions. (string value) +# be used. This option may not be available in future versions. (string value) #kombu_compression = -# How long to wait a missing client beforce abandoning to send it its replies. +# How long to wait a missing client before abandoning to send it its replies. # This value should not be longer than rpc_response_timeout. (integer value) -# Deprecated group/name - [DEFAULT]/kombu_reconnect_timeout +# Deprecated group/name - [oslo_messaging_rabbit]/kombu_reconnect_timeout #kombu_missing_consumer_retry_timeout = 60 # Determines how the next RabbitMQ node is chosen in case the one we are @@ -1179,38 +1344,58 @@ # Allowed values: round-robin, shuffle #kombu_failover_strategy = round-robin -# The RabbitMQ broker address where a single node is used. (string value) +# DEPRECATED: The RabbitMQ broker address where a single node is used. (string +# value) # Deprecated group/name - [DEFAULT]/rabbit_host +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Replaced by [DEFAULT]/transport_url #rabbit_host = localhost -# The RabbitMQ broker port where a single node is used. (port value) +# DEPRECATED: The RabbitMQ broker port where a single node is used. (port +# value) # Minimum value: 0 # Maximum value: 65535 # Deprecated group/name - [DEFAULT]/rabbit_port +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Replaced by [DEFAULT]/transport_url #rabbit_port = 5672 -# RabbitMQ HA cluster host:port pairs. (list value) +# DEPRECATED: RabbitMQ HA cluster host:port pairs. (list value) # Deprecated group/name - [DEFAULT]/rabbit_hosts +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Replaced by [DEFAULT]/transport_url #rabbit_hosts = $rabbit_host:$rabbit_port # Connect over SSL for RabbitMQ. (boolean value) # Deprecated group/name - [DEFAULT]/rabbit_use_ssl #rabbit_use_ssl = false -# The RabbitMQ userid. (string value) +# DEPRECATED: The RabbitMQ userid. (string value) # Deprecated group/name - [DEFAULT]/rabbit_userid +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Replaced by [DEFAULT]/transport_url #rabbit_userid = guest -# The RabbitMQ password. (string value) +# DEPRECATED: The RabbitMQ password. (string value) # Deprecated group/name - [DEFAULT]/rabbit_password +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Replaced by [DEFAULT]/transport_url #rabbit_password = guest # The RabbitMQ login method. (string value) # Deprecated group/name - [DEFAULT]/rabbit_login_method #rabbit_login_method = AMQPLAIN -# The RabbitMQ virtual host. (string value) +# DEPRECATED: The RabbitMQ virtual host. (string value) # Deprecated group/name - [DEFAULT]/rabbit_virtual_host +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Replaced by [DEFAULT]/transport_url #rabbit_virtual_host = / # How frequently to retry connecting with RabbitMQ. (integer value) @@ -1225,9 +1410,11 @@ # (integer value) #rabbit_interval_max = 30 -# Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry -# count). (integer value) +# DEPRECATED: Maximum number of RabbitMQ connection retries. Default is 0 +# (infinite retry count). (integer value) # Deprecated group/name - [DEFAULT]/rabbit_max_retries +# This option is deprecated for removal. +# Its value may be silently ignored in the future. #rabbit_max_retries = 0 # Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this @@ -1243,7 +1430,7 @@ # Queues which are unused for the duration of the TTL are automatically # deleted. The parameter affects only reply and fanout queues. (integer value) # Minimum value: 1 -#rabbit_transient_queues_ttl = 600 +#rabbit_transient_queues_ttl = 1800 # Specifies the number of messages to prefetch. Setting to zero allows # unlimited messages. (integer value) @@ -1269,7 +1456,7 @@ #frame_max = # How often to send heartbeats for consumer's connections (integer value) -#heartbeat_interval = 1 +#heartbeat_interval = 3 # Enable SSL (boolean value) #ssl = @@ -1288,8 +1475,12 @@ # point value) #host_connection_reconnect_delay = 0.25 +# Connection factory implementation (string value) +# Allowed values: new, single, read_write +#connection_factory = single + # Maximum number of connections to keep queued. (integer value) -#pool_max_size = 10 +#pool_max_size = 30 # Maximum number of connections to create above `pool_max_size`. (integer # value) @@ -1311,7 +1502,7 @@ # Persist notification messages. (boolean value) #notification_persistence = false -# Exchange name for for sending notifications (string value) +# Exchange name for sending notifications (string value) #default_notification_exchange = ${control_exchange}_notification # Max number of not acknowledged message which RabbitMQ can send to @@ -1361,6 +1552,101 @@ #rpc_retry_delay = 0.25 +[oslo_messaging_zmq] + +# +# From oslo.messaging +# + +# ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. +# The "host" option should point or resolve to this address. (string value) +# Deprecated group/name - [DEFAULT]/rpc_zmq_bind_address +#rpc_zmq_bind_address = * + +# MatchMaker driver. (string value) +# Allowed values: redis, dummy +# Deprecated group/name - [DEFAULT]/rpc_zmq_matchmaker +#rpc_zmq_matchmaker = redis + +# Number of ZeroMQ contexts, defaults to 1. (integer value) +# Deprecated group/name - [DEFAULT]/rpc_zmq_contexts +#rpc_zmq_contexts = 1 + +# Maximum number of ingress messages to locally buffer per topic. Default is +# unlimited. (integer value) +# Deprecated group/name - [DEFAULT]/rpc_zmq_topic_backlog +#rpc_zmq_topic_backlog = + +# Directory for holding IPC sockets. (string value) +# Deprecated group/name - [DEFAULT]/rpc_zmq_ipc_dir +#rpc_zmq_ipc_dir = /var/run/openstack + +# Name of this node. Must be a valid hostname, FQDN, or IP address. Must match +# "host" option, if running Nova. (string value) +# Deprecated group/name - [DEFAULT]/rpc_zmq_host +#rpc_zmq_host = localhost + +# Seconds to wait before a cast expires (TTL). The default value of -1 +# specifies an infinite linger period. The value of 0 specifies no linger +# period. Pending messages shall be discarded immediately when the socket is +# closed. Only supported by impl_zmq. (integer value) +# Deprecated group/name - [DEFAULT]/rpc_cast_timeout +#rpc_cast_timeout = -1 + +# The default number of seconds that poll should wait. Poll raises timeout +# exception when timeout expired. (integer value) +# Deprecated group/name - [DEFAULT]/rpc_poll_timeout +#rpc_poll_timeout = 1 + +# Expiration timeout in seconds of a name service record about existing target +# ( < 0 means no timeout). (integer value) +# Deprecated group/name - [DEFAULT]/zmq_target_expire +#zmq_target_expire = 300 + +# Update period in seconds of a name service record about existing target. +# (integer value) +# Deprecated group/name - [DEFAULT]/zmq_target_update +#zmq_target_update = 180 + +# Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. (boolean +# value) +# Deprecated group/name - [DEFAULT]/use_pub_sub +#use_pub_sub = true + +# Use ROUTER remote proxy. (boolean value) +# Deprecated group/name - [DEFAULT]/use_router_proxy +#use_router_proxy = true + +# Minimal port number for random ports range. (port value) +# Minimum value: 0 +# Maximum value: 65535 +# Deprecated group/name - [DEFAULT]/rpc_zmq_min_port +#rpc_zmq_min_port = 49153 + +# Maximal port number for random ports range. (integer value) +# Minimum value: 1 +# Maximum value: 65536 +# Deprecated group/name - [DEFAULT]/rpc_zmq_max_port +#rpc_zmq_max_port = 65536 + +# Number of retries to find free port number before fail with ZMQBindError. +# (integer value) +# Deprecated group/name - [DEFAULT]/rpc_zmq_bind_port_retries +#rpc_zmq_bind_port_retries = 100 + +# Default serialization mechanism for serializing/deserializing +# outgoing/incoming messages (string value) +# Allowed values: json, msgpack +# Deprecated group/name - [DEFAULT]/rpc_zmq_serialization +#rpc_zmq_serialization = json + +# This option configures round-robin mode in zmq socket. True means not keeping +# a queue when server side disconnects. False means to keep queue and messages +# even if server is disconnected, when the server appears we send all +# accumulated messages to it. (boolean value) +#zmq_immediate = false + + [oslo_policy] # @@ -1384,18 +1670,22 @@ #policy_dirs = policy.d +[qos] + +# +# From neutron.qos +# + +# Drivers list to use to send the update notification (list value) +#notification_drivers = message_queue + + [quotas] # # From neutron # -# Resource name(s) that are supported in quota features. This option is now -# deprecated for removal. (list value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#quota_items = network,subnet,port - # Default number of resource allowed per tenant. A negative value means # unlimited. (integer value) #default_quota = -1 @@ -1412,11 +1702,11 @@ # (integer value) #quota_port = 50 -# Default driver to use for quota checks (string value) +# Default driver to use for quota checks. (string value) #quota_driver = neutron.db.quota.driver.DbQuotaDriver -# Keep in track in the database of current resourcequota usage. Plugins which -# do not leverage the neutron database should set this flag to False (boolean +# Keep in track in the database of current resource quota usage. Plugins which +# do not leverage the neutron database should set this flag to False. (boolean # value) #track_quota_usage = true diff --git a/doc/config-reference/source/samples/neutron/openvswitch_agent.ini.sample b/doc/config-reference/source/samples/neutron/openvswitch_agent.ini.sample index 6192d69abb..442a62b793 100644 --- a/doc/config-reference/source/samples/neutron/openvswitch_agent.ini.sample +++ b/doc/config-reference/source/samples/neutron/openvswitch_agent.ini.sample @@ -4,12 +4,13 @@ # From oslo.log # -# Print debugging output (set logging level to DEBUG instead of default INFO -# level). (boolean value) +# 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 -# If set to false, will disable INFO logging level, making WARNING the default. -# (boolean value) +# 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 @@ -18,29 +19,31 @@ # 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. -# (string value) +# 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 = -# Format string for %%(asctime)s in log records. Default: %(default)s . This -# option is ignored if log_config_append is set. (string value) +# 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 output to. If no default is set, logging will -# go to stdout. This option is ignored if log_config_append is set. (string -# value) +# (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 = -# (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) # Deprecated group/name - [DEFAULT]/logdir #log_dir = -# (Optional) Uses logging handler designed to watch file system. When log file -# is moved or removed this handler will open a new log file with specified path -# instantaneously. It makes sense only if log-file option is specified and +# 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 @@ -50,15 +53,6 @@ # is set. (boolean value) #use_syslog = false -# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, -# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The -# format without the APP-NAME is deprecated in Kilo, and will be removed in -# Mitaka, along with this option. This option is ignored if log_config_append -# is set. (boolean value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#use_syslog_rfc_format = true - # Syslog facility to receive log lines. This option is ignored if # log_config_append is set. (string value) #syslog_log_facility = LOG_USER @@ -70,18 +64,24 @@ # Format string to use for log messages with context. (string value) #logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s -# Format string to use for log messages without context. (string value) +# 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 -# 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 # Prefix each line of exception output with this format. (string value) #logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s -# List of logger=LEVEL pairs. This option is ignored if log_config_append is -# set. (list value) -#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN +# 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 @@ -94,10 +94,6 @@ # value) #instance_uuid_format = "[instance: %(uuid)s] " -# Format string for user_identity field of the logging_context_format_string -# (string value) -#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s - # Enables or disables fatal status of deprecations. (boolean value) #fatal_deprecations = false @@ -123,12 +119,12 @@ #tunnel_types = # The UDP port to use for VXLAN tunnels. (port value) -# Minimum value: 1 +# Minimum value: 0 # Maximum value: 65535 #vxlan_udp_port = 4789 # MTU size of veth interfaces (integer value) -#veth_mtu = +#veth_mtu = 9000 # Use ML2 l2population mechanism driver to learn remote MAC and IPs and improve # tunnel scalability. (boolean value) @@ -140,14 +136,17 @@ # into the overlay. (boolean value) #arp_responder = false -# Enable suppression of ARP responses that don't match an IP address that -# belongs to the port from which they originate. Note: This prevents the VMs -# attached to this agent from spoofing, it doesn't protect them from other -# devices which have the capability to spoof (e.g. bare metal or VMs attached -# to agents without this flag set to True). Spoofing rules will not be added to -# any ports that have port security disabled. For LinuxBridge, this requires -# ebtables. For OVS, it requires a version that supports matching ARP headers. -# (boolean value) +# 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 # Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying @@ -169,11 +168,14 @@ # GRE/VXLAN tunnel. (boolean value) #tunnel_csum = false -# Selects the Agent Type reported (string value) +# DEPRECATED: Selects the Agent Type reported (string value) # This option is deprecated for removal. # Its value may be silently ignored in the future. #agent_type = Open vSwitch agent +# Extensions list to use (list value) +#extensions = + [ovs] @@ -197,7 +199,11 @@ # Peer patch port in tunnel bridge for integration bridge. (string value) #tun_peer_patch_port = patch-int -# Local IP address of tunnel endpoint. (ip address value) +# 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 = # Comma-separated list of : tuples mapping physical @@ -207,8 +213,7 @@ # configured as a port. All physical networks configured on the server should # have mappings to appropriate bridges on each agent. Note: If you remove a # bridge from this mapping, make sure to disconnect it from the integration -# bridge as it won't be managed by the agent anymore. -# (list value) +# bridge as it won't be managed by the agent anymore. (list value) #bridge_mappings = # Use veths instead of patch ports to interconnect the integration bridge to @@ -218,7 +223,7 @@ # OpenFlow interface to use. (string value) # 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 # kernel datapath. To enable the userspace datapath set this value to 'netdev'. @@ -230,12 +235,12 @@ #vhostuser_socket_dir = /var/run/openvswitch # 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 # Port to listen on for OpenFlow connections. Used only for 'native' driver. # (port value) -# Minimum value: 1 +# Minimum value: 0 # Maximum value: 65535 #of_listen_port = 6633 @@ -249,7 +254,7 @@ # The interface for interacting with the OVSDB (string value) # Allowed values: native, vsctl -#ovsdb_interface = vsctl +#ovsdb_interface = native # The connection string for the native OVSDB backend. Requires the native # ovsdb_interface to be enabled. (string value) diff --git a/doc/config-reference/source/samples/neutron/sriov_agent.ini.sample b/doc/config-reference/source/samples/neutron/sriov_agent.ini.sample index 82fc2b9cd9..c2c66f43cd 100644 --- a/doc/config-reference/source/samples/neutron/sriov_agent.ini.sample +++ b/doc/config-reference/source/samples/neutron/sriov_agent.ini.sample @@ -4,12 +4,13 @@ # From oslo.log # -# Print debugging output (set logging level to DEBUG instead of default INFO -# level). (boolean value) +# 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 -# If set to false, will disable INFO logging level, making WARNING the default. -# (boolean value) +# 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 @@ -18,29 +19,31 @@ # 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. -# (string value) +# 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 = -# Format string for %%(asctime)s in log records. Default: %(default)s . This -# option is ignored if log_config_append is set. (string value) +# 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 output to. If no default is set, logging will -# go to stdout. This option is ignored if log_config_append is set. (string -# value) +# (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 = -# (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) # Deprecated group/name - [DEFAULT]/logdir #log_dir = -# (Optional) Uses logging handler designed to watch file system. When log file -# is moved or removed this handler will open a new log file with specified path -# instantaneously. It makes sense only if log-file option is specified and +# 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 @@ -50,15 +53,6 @@ # is set. (boolean value) #use_syslog = false -# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, -# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The -# format without the APP-NAME is deprecated in Kilo, and will be removed in -# Mitaka, along with this option. This option is ignored if log_config_append -# is set. (boolean value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#use_syslog_rfc_format = true - # Syslog facility to receive log lines. This option is ignored if # log_config_append is set. (string value) #syslog_log_facility = LOG_USER @@ -70,18 +64,24 @@ # Format string to use for log messages with context. (string value) #logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s -# Format string to use for log messages without context. (string value) +# 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 -# 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 # Prefix each line of exception output with this format. (string value) #logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s -# List of logger=LEVEL pairs. This option is ignored if log_config_append is -# set. (list value) -#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN +# 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 @@ -94,10 +94,6 @@ # value) #instance_uuid_format = "[instance: %(uuid)s] " -# Format string for user_identity field of the logging_context_format_string -# (string value) -#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s - # Enables or disables fatal status of deprecations. (boolean value) #fatal_deprecations = false @@ -112,7 +108,7 @@ #extensions = -[ml2_sriov] +[sriov_nic] # # From neutron.ml2.sriov.agent